REST Resource: projects.locations.collections.dataStores.conversations

Recurso: Conversación

Definición del proto de conversación externa.

Representación JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Campos
name

string

Inmutable. Nombre completo projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* o projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

El estado de la conversación.
userPseudoId

string

Identificador único para monitorizar a los usuarios.
messages[]

object (ConversationMessage)

Mensajes de conversaciones.
startTime

string (Timestamp format)

Solo de salida. La hora en la que se inició la conversación.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. La hora en la que finalizó la conversación.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Estado

Enumeración del estado de la conversación.

Enumeraciones
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS La conversación está abierta.
COMPLETED La conversación se ha completado.

ConversationMessage

Define un mensaje de conversación.

Representación JSON 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
Campos
createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de creación del mensaje.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Campo de unión message.

message solo puede ser una de estas dos opciones:
userInput

object (TextInput)

Entrada de texto del usuario.
reply

object (Reply)

Buscar respuesta.

TextInput

Define la entrada de texto.

Representación JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Campos
input

string

Entrada de texto.
context

object (ConversationContext)

Contexto de la conversación de la entrada.

ConversationContext

Define el contexto de la conversación.

Representación JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Campos
contextDocuments[]

string

La lista de documentos que está viendo el usuario. Contiene las referencias de recursos del documento.
activeDocument

string

El documento activo que ha abierto el usuario. Contiene la referencia del recurso del documento.

Responder

Define un mensaje de respuesta para el usuario.

Representación JSON 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
Campos
reply
(deprecated)

string

OBSOLETO: usa summary en su lugar. Respuesta de texto.
references[]
(deprecated)

object (Reference)

Referencias en la respuesta.
summary

object (Summary)

Resumen basado en los resultados de búsqueda.

Referencia

Define la referencia en la respuesta.

Representación JSON 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
Campos
uri

string

Referencia de enlace URI.
anchorText

string

Texto de anclaje.
start

integer

Índice inicial del texto de anclaje.
end

integer

Índice final del texto de anclaje.

Resumen

Resumen de los N resultados de búsqueda principales especificados por la especificación del resumen.

Representación JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Campos
summaryText

string

El contenido del resumen.
summarySkippedReasons[]

enum (SummarySkippedReason)

Motivos adicionales por los que se ha omitido el resumen. Proporciona el motivo de los casos ignorados. Si no se omite nada, este campo no se define.
safetyAttributes

object (SafetyAttributes)

Colección de categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.
summaryWithMetadata

object (SummaryWithMetadata)

Resumen con información de metadatos.

SummarySkippedReason

Enumeración de los motivos por los que se ha omitido el resumen.

Enumeraciones
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se ha especificado el motivo por el que se ha omitido el resumen.
ADVERSARIAL_QUERY_IGNORED

La consulta adversarial no distingue entre mayúsculas y minúsculas.

Solo se usa cuando SummarySpec.ignore_adversarial_query se define como true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

La consulta que no busca resúmenes no ha distinguido entre mayúsculas y minúsculas.

Google omite el resumen si la consulta es una conversación informal. Solo se usa cuando SummarySpec.ignore_non_summary_seeking_query se define como true.
OUT_OF_DOMAIN_QUERY_IGNORED

La consulta fuera del dominio no distingue entre mayúsculas y minúsculas.

Google omite el resumen si no hay resultados de búsqueda de alta relevancia. Por ejemplo, el almacén de datos contiene información sobre la empresa A, pero la consulta del usuario hace preguntas sobre la empresa B.
POTENTIAL_POLICY_VIOLATION

El caso de posible infracción de las políticas.

Google omite el resumen si detecta una posible infracción de las políticas. Esto incluye contenido que puede ser violento o tóxico.
LLM_ADDON_NOT_ENABLED

El complemento LLM no está habilitado.

Google omite el resumen si el complemento LLM no está habilitado.
NO_RELEVANT_CONTENT

El caso de que no haya contenido relevante.

Google omite el resumen si no hay contenido relevante en los resultados de búsqueda obtenidos.
JAIL_BREAKING_QUERY_IGNORED

La consulta para saltarse las restricciones no distinguía entre mayúsculas y minúsculas.

Por ejemplo, "Responde con el tono del CEO de una empresa de la competencia". Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] se define en true.
CUSTOMER_POLICY_VIOLATION

El caso de infracción de la política de clientes.

Google omite el resumen si se detecta una infracción de la política para clientes. La política la define el cliente.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

La consulta que no busca una respuesta no distingue entre mayúsculas y minúsculas.

Google omite el resumen si la consulta no tiene una intención clara. Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] se define como true.
TIME_OUT

El caso de tiempo de espera.

Google omite el resumen si se agota el tiempo.

SafetyAttributes

Categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.

Representación JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Campos
categories[]

string

Los nombres visibles de las categorías de atributos de seguridad asociadas al contenido generado. El orden coincide con las puntuaciones.
scores[]

number

Las puntuaciones de confianza de cada categoría. Un valor más alto significa una mayor confianza. El orden coincide con el de las categorías.

SummaryWithMetadata

Resumen con información de metadatos.

Representación JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
Campos
summary

string

Texto de resumen sin información de la cita.
citationMetadata

object (CitationMetadata)

Metadatos de la cita del resumen proporcionado.
references[]

object (Reference)

Referencias del documento.
blobAttachments[]

object (BlobAttachment)

Solo de salida. Almacena datos multimodales para mejorar las respuestas.

CitationMetadata

Metadatos de citas.

Representación JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Campos
citations[]

object (Citation)

Citas de segmentos.

Referencia

Información de la cita de un segmento.

Representación JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campos
startIndex

string (int64 format)

El índice indica el inicio del segmento, medido en bytes o Unicode.
endIndex

string (int64 format)

Fin del segmento atribuido (exclusivo).
sources[]

object (CitationSource)

Fuentes de citas del segmento atribuido.

CitationSource

Fuente de la cita.

Representación JSON 
{
  "referenceIndex": string
}
Campos
referenceIndex

string (int64 format)

Índice de referencia del documento de SummaryWithMetadata.references. Tiene un índice que empieza por 0 y el valor será cero si no se define explícitamente el referenceIndex.

Referencia

Referencia del documento.

Representación JSON 
{
  "title": string,
  "document": string,
  "uri": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ]
}
Campos
title

string

Título del documento.
document

string

Obligatorio. Document.name del documento. Nombre completo del recurso del documento al que se hace referencia, con el formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

URI de Cloud Storage o HTTP del documento.
chunkContents[]

object (ChunkContent)

Lista de contenidos de fragmentos citados derivados del contenido del documento.

ChunkContent

Contenido de fragmento.

Representación JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
Campos
content

string

Divide el contenido textual en fragmentos.
pageIdentifier

string

Identificador de la página.
blobAttachmentIndexes[]

string (int64 format)

Solo de salida. Almacena los índices de los blobattachments vinculados a este fragmento.

BlobAttachment

Almacena datos binarios adjuntos a la respuesta de texto, como imágenes, vídeos, audio, etc.

Representación JSON 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Campos
data

object (Blob)

Solo de salida. Los datos del blob.
attributionType

enum (AttributionType)

Solo de salida. El tipo de atribución del blob.

Blob

Almacena el tipo y los datos del blob.

Representación JSON 
{
  "mimeType": string,
  "data": string
}
Campos
mimeType

string

Solo de salida. El tipo de contenido (tipo MIME) de los datos generados.
data

string (bytes format)

Solo de salida. Bytes sin procesar.

Cadena codificada en base64.

AttributionType

Define el tipo de atribución del blob.

Enumeraciones
ATTRIBUTION_TYPE_UNSPECIFIED Tipo de atribución no especificado.
CORPUS Los datos de los archivos adjuntos proceden del corpus.
GENERATED El modelo genera los datos adjuntos mediante la generación de código.

Métodos

converse

 Converses a conversation.

create

 Crea una conversación.

delete

 Elimina una conversación.

get

 Obtiene una conversación.

list

 Enumera todas las conversaciones por su DataStore principal.

patch

 Actualiza un recurso Conversation.