REST Resource: projects.locations.apps.conversations

Recurso: Conversation

Una conversación representa una interacción entre un usuario final y la app de CES.

Representación JSON
{
  "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)
    }
  ]
}
Campos
name

string

Es el identificador. Es el identificador único de la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

startTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de cuando se creó la conversación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se completó la conversación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

turns[]

object (Conversation.Turn)

Obligatorio. Son los turnos de la conversación.

turnCount

integer

Solo salida. Es la cantidad de turnos en la conversación.

channelType
(deprecated)

enum (Conversation.ChannelType)

OBSOLETO. En su lugar, usa inputTypes.

source

enum (Conversation.Source)

Solo salida. Indica la fuente de la conversación.

inputTypes[]

enum (Conversation.InputType)

Solo salida. Son los tipos de entrada de la conversación.

entryAgent

string

Solo salida. Es el agente que inicialmente maneja la conversación. Si no se especifica, la conversación la controla el agente raíz. Formato: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

Solo salida. Es la implementación de la app que se usa para procesar la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

appVersion

string

Solo salida. Es la versión de la app que se usa para procesar la conversación. Formato: projects/{project}/locations/{location}/apps/{app}/versions/{version}

languageCode

string

Solo salida. Es el código de idioma de la conversación.

messages[]
(deprecated)

object (Message)

Obsoleto. En su lugar, usa turnos.

Conversation.Turn

Toda la información sobre un solo turno en la conversación.

Representación JSON
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
Campos
messages[]

object (Message)

Es opcional. Lista de mensajes en el turno de conversación, incluidas las entradas del usuario, las respuestas del agente y los eventos intermedios durante el procesamiento.

rootSpan

object (Span)

Es opcional. Es el intervalo raíz del procesamiento de la acción.

userIntendedText

string

Es opcional. Texto de verdad fundamental previsto del llamador simulado (Polysynth). Solo se propaga cuando se habilitan las métricas de la tasa de error de palabras.

Intervalo

Un tramo es una unidad de trabajo o una sola operación durante el procesamiento de la solicitud.

Representación JSON
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
Campos
name

string

Solo salida. Es el nombre del intervalo.

startTime

string (Timestamp format)

Solo salida. Es la hora de inicio del período.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Solo salida. Es la hora de finalización del período.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

duration

string (Duration format)

Solo salida. Es la duración del intervalo.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

attributes

object (Struct format)

Solo salida. Son los atributos clave-valor asociados con el intervalo.

childSpans[]

object (Span)

Solo salida. Son los intervalos secundarios anidados en este intervalo.

Conversation.ChannelType

Es el tipo de canal de la conversación.

Enums
CHANNEL_TYPE_UNSPECIFIED Es un tipo de canal sin especificar.
TEXT La conversación solo contiene mensajes de texto entre el usuario final y el agente.
AUDIO La conversación contiene mensajes de audio entre el usuario final y el agente.
MULTIMODAL Son los mensajes multimodales de la conversación (p.ej., imágenes) entre el usuario final y el agente.

Conversation.Source

Es la fuente de la conversación.

Enums
SOURCE_UNSPECIFIED Fuente no especificada.
LIVE La conversación es del usuario final en vivo.
SIMULATOR La conversación es del simulador.
EVAL La conversación es de la evaluación.
AGENT_TOOL La conversación proviene de una herramienta del agente. La herramienta del agente ejecuta el agente en una sesión separada, que se conserva para fines de prueba y depuración.

Conversation.InputType

Es el tipo de mensaje de entrada.

Enums
INPUT_TYPE_UNSPECIFIED Tipo de entrada sin especificar.
INPUT_TYPE_TEXT Es una entrada de texto.
INPUT_TYPE_EVENT Es la entrada del evento.
INPUT_TYPE_AUDIO Entrada de audio.
INPUT_TYPE_IMAGE Es la entrada de imagen.
INPUT_TYPE_BLOB Es la entrada del BLOB.
INPUT_TYPE_TOOL_RESPONSE Es la entrada de respuesta de la herramienta de función del cliente.
INPUT_TYPE_VARIABLES Son las variables de entrada.

Métodos

batchDelete

Borra de forma masiva las conversaciones especificadas.

delete

Borra la conversación especificada.

get

Obtiene detalles de la conversación especificada.

list

Enumera las conversaciones en la app determinada.