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

Recurso: Conversation

Es la definición del arquetipo 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 completamente calificado projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* o projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

Es el estado de la conversación.
userPseudoId

string

Es un identificador único para hacer un seguimiento de los usuarios.
messages[]

object (ConversationMessage)

Mensajes de conversación
startTime

string (Timestamp format)

Solo salida. Fecha y hora en que se inició 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. Fecha y hora en que finalizó 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".

Estado

Es una enumeración del estado de la conversación.

Enums
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS La conversación está abierta.
COMPLETED Se completó la conversación.

ConversationMessage

Define un mensaje de conversación.

Representación JSON 
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of mutually exclusive fields.
}
Campos
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de creación del mensaje.

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".
A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
userInput

object (TextInput)

Es la entrada de texto del usuario.
reply

object (Reply)

Es la respuesta de la búsqueda.
Fin de los campos mutuamente exclusivos.

TextInput

Define la entrada de texto.

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

string

Es la entrada de texto.
context

object (ConversationContext)

Es el 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

Es la lista actual de documentos que ve el usuario. Contiene las referencias de recursos del documento.
activeDocument

string

Es el documento activo actual que abrió 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 la búsqueda.

Reference

Define la referencia en la respuesta.

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

string

Es la referencia del vínculo del URI.
anchorText

string

Texto de anclaje.
start

integer

Índice de inicio del texto de anclaje.
end

integer

Índice final del texto de anclaje.

Resumen

Es el resumen de los N resultados de la búsqueda principales especificados por el objeto SummarySpec.

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

string

Es el contenido del resumen.
summarySkippedReasons[]

enum (SummarySkippedReason)

Son motivos adicionales por los que se omitió el resumen. Proporciona el motivo por el que se ignoraron los casos. Si no se omite nada, este campo no se establece.
safetyAttributes

object (SafetyAttributes)

Es una colección de categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.
summaryWithMetadata

object (SummaryWithMetadata)

Es un resumen con información de metadatos.

SummarySkippedReason

Es una enumeración de los motivos por los que se omitió el resumen.

Enums
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se especificó el motivo por el que se omitió el resumen.
ADVERSARIAL_QUERY_IGNORED

Es la consulta adversaria que ignoró las mayúsculas y minúsculas.

Solo se usa cuando SummarySpec.ignore_adversarial_query se establece en true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

La búsqueda que no es de resumen ignoró el caso.

Google omite el resumen si la búsqueda es de charla informal. Solo se usa cuando SummarySpec.ignore_non_summary_seeking_query se establece en true.
OUT_OF_DOMAIN_QUERY_IGNORED

La búsqueda fuera del dominio ignoró las mayúsculas y minúsculas.

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

Es el caso de posible incumplimiento de política.

Google omite el resumen si se detecta un posible incumplimiento de política. Esto incluye contenido que puede ser violento o tóxico.
LLM_ADDON_NOT_ENABLED

Caso en el que no está habilitado el complemento de LLM.

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

Es el caso en el que no hay contenido relevante.

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

La búsqueda de jailbreak ignoró las mayúsculas y minúsculas.

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

Es el caso de incumplimiento de política del cliente.

Google omite el resumen si se detecta un incumplimiento de la política del cliente. El cliente define la política.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

La búsqueda que no busca respuestas ignoró las mayúsculas y minúsculas.

Google omite el resumen si la búsqueda no tiene una intención clara. Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] se establece en true.
TIME_OUT

Es el caso de tiempo de espera.

Google omite el resumen si se agota el tiempo de espera.

SafetyAttributes

Son las 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 asociados con el contenido generado. El orden coincide con las puntuaciones.
scores[]

number

Las puntuaciones de confianza de cada categoría, un valor más alto significa más confianza. El orden coincide con las categorías.

SummaryWithMetadata

Es un resumen con información de metadatos.

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

string

Es un texto de resumen sin información de citas.
citationMetadata

object (CitationMetadata)

Son los metadatos de citas del resumen determinado.
references[]

object (Reference)

Referencias de documentos.
blobAttachments[]

object (BlobAttachment)

Solo salida. Almacenar datos multimodales para mejorar las respuestas

CitationMetadata

Son los metadatos de la cita.

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

object (Citation)

Son las citas de los segmentos.

Cita

Es la 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)

Es el final del segmento atribuido, exclusivo.
sources[]

object (CitationSource)

Son las fuentes de citas del segmento atribuido.

CitationSource

Es la fuente de la cita.

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

string (int64 format)

Índice de referencia del documento de SummaryWithMetadata.references. Se indexa a partir de 0 y el valor será cero si no se establece referenceIndex de forma explícita.

Reference

Es la referencia del documento.

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

string

Es el 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

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

object (ChunkContent)

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

ChunkContent

Divide el contenido en fragmentos.

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

string

Fragmenta el contenido textual.
pageIdentifier

string

Es el identificador de la página.
blobAttachmentIndexes[]

string (int64 format)

Solo salida. Almacena los índices de los archivos adjuntos de BLOB vinculados a este fragmento.

BlobAttachment

Almacena datos binarios adjuntos a la respuesta de texto, p.ej., imágenes, videos, audio, etcétera.

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

object (Blob)

Solo salida. Son los datos del BLOB.
attributionType

enum (AttributionType)

Solo salida. Es 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 salida. Es el tipo de medio (tipo de MIME) de los datos generados.
data

string (bytes format)

Solo salida. Bytes sin procesar.

Es una cadena codificada en Base64.

AttributionType

Define el tipo de atribución del blob.

Enums
ATTRIBUTION_TYPE_UNSPECIFIED Es un tipo de atribución sin especificar.
CORPUS Los datos del archivo adjunto provienen del corpus.
GENERATED El modelo genera los datos adjuntos a través de la generación de código.

Métodos

converse

 Inicia una conversación.

create

 Crea una conversación.

delete

 Borra una conversación.

get

 Obtiene una conversación.

list

 Enumera todas las conversaciones por su DataStore principal.

patch

 Actualiza una conversación.