REST Resource: projects.locations.apps.conversations

Ressource: Unterhaltung

Eine Unterhaltung stellt eine Interaktion zwischen einem Endnutzer und der CES-App dar.

JSON-Darstellung
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Conversation.Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (Conversation.ChannelType),
  "source": enum (Conversation.Source),
  "inputTypes": [
    enum (Conversation.InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
Felder
name

string

ID. Die eindeutige Kennung der Unterhaltung. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

startTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung der Unterhaltung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für den Abschluss der Unterhaltung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

turns[]

object (Conversation.Turn)

Erforderlich. Die Sprecherwechsel in der Unterhaltung.

turnCount

integer

Nur Ausgabe. Die Anzahl der Züge in der Unterhaltung.

channelType
(deprecated)

enum (Conversation.ChannelType)

VERWORFEN. Verwenden Sie stattdessen inputTypes.

source

enum (Conversation.Source)

Nur Ausgabe. Geben Sie die Quelle der Unterhaltung an.

inputTypes[]

enum (Conversation.InputType)

Nur Ausgabe. Die Eingabetypen der Unterhaltung.

entryAgent

string

Nur Ausgabe. Der Agent, der die Unterhaltung ursprünglich bearbeitet. Wenn nichts angegeben ist, wird die Unterhaltung vom Stamm-Agent bearbeitet. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

Nur Ausgabe. Die Bereitstellung der App, die zum Verarbeiten der Unterhaltung verwendet wird. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

appVersion

string

Nur Ausgabe. Die Version der App, die zum Verarbeiten der Unterhaltung verwendet wurde. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

languageCode

string

Nur Ausgabe. Der Sprachcode der Unterhaltung.

messages[]
(deprecated)

object (Message)

Verworfen Verwenden Sie stattdessen Züge.

Conversation.Turn

Alle Informationen zu einem einzelnen Zug in der Unterhaltung.

JSON-Darstellung
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
Felder
messages[]

object (Message)

Optional. Liste der Nachrichten in der Unterhaltungsrunde, einschließlich Nutzereingaben, Agentenantworten und Zwischenereignissen während der Verarbeitung.

rootSpan

object (Span)

Optional. Der Stamm-Span der Aktionsverarbeitung.

userIntendedText

string

Optional. Der beabsichtigte Ground-Truth-Text des simulierten Anrufers (Polysynth). Wird nur ausgefüllt, wenn Messwerte für die Wortfehlerrate aktiviert sind.

Span

Ein Span ist eine Arbeitseinheit oder ein einzelner Vorgang während der Anfrageverarbeitung.

JSON-Darstellung
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
Felder
name

string

Nur Ausgabe. Der Name des Zeitraums.

startTime

string (Timestamp format)

Nur Ausgabe. Die Startzeit des Zeitraums.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

Nur Ausgabe. Die Endzeit des Spans.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

duration

string (Duration format)

Nur Ausgabe. Die Dauer des Zeitraums.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

attributes

object (Struct format)

Nur Ausgabe. Schlüssel/Wert-Attribute, die dem Bereich zugeordnet sind.

childSpans[]

object (Span)

Nur Ausgabe. Die untergeordneten Spannen, die unter dieser Spanne verschachtelt sind.

Conversation.ChannelType

Der Kanaltyp der Unterhaltung.

Enums
CHANNEL_TYPE_UNSPECIFIED Nicht angegebener Channneltyp.
TEXT Die Unterhaltung enthält nur Textnachrichten zwischen dem Endnutzer und dem Agent.
AUDIO Die Unterhaltung enthält Audio-Nachrichten zwischen dem Endnutzer und dem Agent.
MULTIMODAL Die multimodalen Nachrichten (z.B. Bilder) in der Unterhaltung zwischen dem Endnutzer und dem Agenten.

Conversation.Source

Die Quelle der Unterhaltung.

Enums
SOURCE_UNSPECIFIED Nicht angegebene Quelle.
LIVE Die Unterhaltung stammt vom Endnutzer.
SIMULATOR Die Unterhaltung stammt aus dem Simulator.
EVAL Die Unterhaltung stammt aus der Bewertung.
AGENT_TOOL Die Unterhaltung stammt von einem Agent-Tool. Mit dem Agent-Tool wird der Agent in einer separaten Sitzung ausgeführt, die zu Test- und Debugging-Zwecken beibehalten wird.

Conversation.InputType

Typ der Eingabenachricht.

Enums
INPUT_TYPE_UNSPECIFIED Nicht angegebener Eingabetyp.
INPUT_TYPE_TEXT Texteingabe.
INPUT_TYPE_EVENT Eingabe von Ereignissen
INPUT_TYPE_AUDIO Audioeingabe
INPUT_TYPE_IMAGE Bildeingabe
INPUT_TYPE_BLOB Blob-Eingabe.
INPUT_TYPE_TOOL_RESPONSE Eingabe für die Antwort des Client-Funktionstools.
INPUT_TYPE_VARIABLES Variablen eingeben.

Methoden

batchDelete

Löscht die angegebenen Unterhaltungen im Batch.

delete

Löscht die angegebene Unterhaltung.

get

Ruft Details zur angegebenen Unterhaltung ab.

list

Listet Unterhaltungen in der angegebenen App auf.