REST Resource: projects.locations.collections.dataStores.sessions.answers

Recurso: Answer

Define una respuesta.

Representación JSON 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
Campos
name

string

Inmutable. Nombre completamente calificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

Es el estado de la generación de respuestas.
answerText

string

Es la respuesta textual.
citations[]

object (Citation)

Citas.
groundingSupports[]

object (GroundingSupport)

Opcional. Compatibilidad con la fundamentación.
references[]

object (Reference)

Referencias
blobAttachments[]

object (BlobAttachment)

Es la lista de archivos adjuntos de BLOB en la respuesta.
relatedQuestions[]

string

Preguntas relacionadas sugeridas
steps[]

object (Step)

Pasos de generación de respuestas.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Es información sobre la comprensión de la búsqueda.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Se agregaron motivos adicionales por los que se omitió la respuesta. Esto proporciona el motivo por el que se ignoraron los casos. Si no se omite nada, este campo no se establece.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de creación de la respuesta.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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".
completeTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la respuesta completada.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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".
safetyRatings[]

object (SafetyRating)

Opcional. Calificaciones de seguridad
groundingScore

number

Es una puntuación en el rango de [0, 1] que describe qué tan fundamentada está la respuesta en los fragmentos de referencia.

Estado

Enumeración del estado de la generación de respuestas.

Enums
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS En este momento, se está generando la respuesta.
FAILED Actualmente, no se pudo generar la respuesta.
SUCCEEDED Se generó la respuesta correctamente.
STREAMING En este momento, se está generando la respuesta.

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 (Unicode UTF-8). Si hay caracteres multibyte,como caracteres no ASCII, la medición del índice es mayor que la longitud de la cadena.
endIndex

string (int64 format)

Es el final del segmento atribuido, exclusivo. Se mide en bytes (Unicode UTF-8). Si hay caracteres multibyte,como caracteres no ASCII, la medición del índice es mayor que la longitud de la cadena.
sources[]

object (CitationSource)

Son las fuentes de citas del segmento atribuido.

CitationSource

Es la fuente de la cita.

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

string

Es el ID de la fuente de la cita.

GroundingSupport

Es la fundamentación de una afirmación en answerText.

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

string (int64 format)

Obligatorio. El índice indica el inicio del reclamo, medido en bytes (Unicode UTF-8).
endIndex

string (int64 format)

Obligatorio. Es el final del reclamo, sin incluirlo.
sources[]

object (CitationSource)

Opcional. Son las fuentes de la cita de la afirmación.
groundingScore

number

Es una puntuación en el rango de [0, 1] que describe qué tan fundamentada está una afirmación específica en las referencias. Un valor más alto significa que la referencia respalda mejor el reclamo.
groundingCheckRequired

boolean

Indica que esta afirmación requirió una verificación de fundamentación. Cuando el sistema decidió que esta afirmación no requería una verificación de atribución o fundamentación, este campo se establece como falso. En ese caso, no se realizó ninguna verificación de fundamentación para la afirmación y, por lo tanto, no se devolvieron groundingScore ni sources.

Reference

Referencia.

Representación JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Campos
Campo de unión content. Contenido del resultado de la búsqueda. content puede ser solo uno de los siguientes:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Es información de documentos no estructurados.
chunkInfo

object (ChunkInfo)

Es información sobre el fragmento.
structuredDocumentInfo

object (StructuredDocumentInfo)

Es información estructurada del documento.

UnstructuredDocumentInfo

Es información de documentos no estructurados.

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

string

Nombre del recurso del documento.
uri

string

Es el URI del documento.
title

string

y "title".
chunkContents[]

object (ChunkContent)

Es la lista de contenido de fragmentos citados que se deriva del contenido del documento.
structData

object (Struct format)

Son los metadatos JSON estructurados del documento. Se completa con los datos de struct del fragmento en el resultado de la búsqueda.

ChunkContent

Divide el contenido en fragmentos.

Representación JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
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 blobattachments vinculados a este fragmento.
relevanceScore

number

Es la relevancia del fragmento para una búsqueda determinada. Los valores varían de 0.0 (completamente irrelevante) a 1.0 (completamente relevante). Este valor es solo para fines informativos. Puede cambiar para la misma búsqueda y fragmento en cualquier momento debido a un nuevo entrenamiento del modelo o a un cambio en la implementación.

ChunkInfo

Es información sobre el fragmento.

Representación JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Campos
chunk

string

Nombre del recurso de fragmento.
content

string

Fragmenta el contenido textual.
documentMetadata

object (DocumentMetadata)

Son los metadatos del documento.
blobAttachmentIndexes[]

string (int64 format)

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

number

Es la relevancia del fragmento para una búsqueda determinada. Los valores varían de 0.0 (completamente irrelevante) a 1.0 (completamente relevante). Este valor es solo para fines informativos. Puede cambiar para la misma búsqueda y fragmento en cualquier momento debido a un nuevo entrenamiento del modelo o a un cambio en la implementación.

DocumentMetadata

Son los metadatos del documento.

Representación JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Campos
document

string

Nombre del recurso del documento.
uri

string

Es el URI del documento.
title

string

y "title".
pageIdentifier

string

Es el identificador de la página.
structData

object (Struct format)

Son los metadatos JSON estructurados del documento. Se completa con los datos de struct del fragmento en el resultado de la búsqueda.

StructuredDocumentInfo

Es información de búsqueda estructurada.

Representación JSON 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Campos
document

string

Nombre del recurso del documento.
structData

object (Struct format)

Datos de búsqueda estructurados.
title

string

Solo salida. Es el título del documento.
uri

string

Solo salida. Es el URI del documento.

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 el tipo de MIME y los datos del BLOB.
attributionType

enum (AttributionType)

Solo salida. Es el tipo de atribución del BLOB.

BLOB

Es el tipo de medio y los datos del BLOB.

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

string

Solo salida. Tipo de medio (tipo de MIME) de los datos recuperados o generados.
data

string (bytes format)

Solo salida. Bytes sin procesar.

Es una cadena codificada en base64.

AttributionType

Es la fuente del blob.

Enums
ATTRIBUTION_TYPE_UNSPECIFIED 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.

Paso

Es la información del paso.

Representación JSON 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Campos
state

enum (State)

Es el estado del paso.
description

string

Es la descripción del paso.
thought

string

Es la idea del paso.
actions[]

object (Action)

Acciones.

Estado

Es una enumeración del estado del paso.

Enums
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS El paso está en curso.
FAILED El paso falló.
SUCCEEDED El paso se completó correctamente.

Acción

Acción.

Representación JSON 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
Campos
observation

object (Observation)

Observación.
Campo de unión action. Es la acción. action puede ser solo uno de los siguientes:
searchAction

object (SearchAction)

Acción de búsqueda.

SearchAction

Acción de búsqueda.

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

string

Es la búsqueda.

Observación

Observación.

Representación JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campos
searchResults[]

object (SearchResult)

Son los resultados de la búsqueda que se observan en la acción de búsqueda. Pueden ser información de fragmentos o información de fragmentos, según el tipo de cita que establezca el usuario.

SearchResult

Representación JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Campos
document

string

Nombre del recurso del documento.
uri

string

Es el URI del documento.
title

string

y "title".
snippetInfo[]

object (SnippetInfo)

Si citation_type es DOCUMENT_LEVEL_CITATION, completa los resúmenes a nivel del documento.
chunkInfo[]

object (ChunkInfo)

Si citation_type es CHUNK_LEVEL_CITATION y el modo de fragmentos está activado, se debe propagar la información del fragmento.
structData

object (Struct format)

Representación de datos Son los datos estructurados en formato JSON del documento. Se completa con los datos de struct del documento o del fragmento en el resultado de la búsqueda.

SnippetInfo

Es la información del fragmento.

Representación JSON 
{
  "snippet": string,
  "snippetStatus": string
}
Campos
snippet

string

Contenido del fragmento.
snippetStatus

string

Es el estado del fragmento definido por el equipo de Búsqueda.

ChunkInfo

Es información sobre el fragmento.

Representación JSON 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Campos
chunk

string

Nombre del recurso de fragmento.
content

string

Fragmenta el contenido textual.
relevanceScore

number

Es la relevancia del fragmento para una búsqueda determinada. Los valores varían de 0.0 (completamente irrelevante) a 1.0 (completamente relevante). Este valor es solo para fines informativos. Puede cambiar para la misma búsqueda y fragmento en cualquier momento debido a un nuevo entrenamiento del modelo o a un cambio en la implementación.

QueryUnderstandingInfo

Es información sobre la comprensión de la búsqueda.

Representación JSON 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Campos
queryClassificationInfo[]

object (QueryClassificationInfo)

Es información de clasificación de la búsqueda.

QueryClassificationInfo

Es información de clasificación de la búsqueda.

Representación JSON 
{
  "type": enum (Type),
  "positive": boolean
}
Campos
type

enum (Type)

Es el tipo de clasificación de la búsqueda.
positive

boolean

Es el resultado de la clasificación.

Tipo

Son los tipos de clasificación de búsquedas.

Enums
TYPE_UNSPECIFIED Es el tipo de clasificación de la búsqueda sin especificar.
ADVERSARIAL_QUERY Es el tipo de clasificación de consultas adversariales.
NON_ANSWER_SEEKING_QUERY Es el tipo de clasificación de búsqueda que no busca respuestas, sino que es de conversación.
JAIL_BREAKING_QUERY Es el tipo de clasificación de consultas para evitar la restricción.
NON_ANSWER_SEEKING_QUERY_V2 Tipo de clasificación de búsqueda que no busca respuestas, para cuando no hay una intención clara.
USER_DEFINED_CLASSIFICATION_QUERY Es el tipo de clasificación de la búsqueda definido por el usuario.

AnswerSkippedReason

Es una enumeración de los motivos por los que se omitió la respuesta.

Enums
ANSWER_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se especificó el motivo por el que se omitió la respuesta.
ADVERSARIAL_QUERY_IGNORED Es la consulta adversaria que se ignoró.
NON_ANSWER_SEEKING_QUERY_IGNORED

La búsqueda que no busca respuestas (ignorar mayúsculas y minúsculas)

Google omite la respuesta si la búsqueda es una conversación trivial.
OUT_OF_DOMAIN_QUERY_IGNORED

Es la búsqueda fuera del dominio que ignoró las mayúsculas y minúsculas.

Google omite la respuesta si no hay resultados de la búsqueda de alta relevancia.
POTENTIAL_POLICY_VIOLATION

Es el caso de posible incumplimiento de política.

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

Es el caso en el que no hay contenido relevante.

Google omite la respuesta 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". Google omite la respuesta si la búsqueda se clasifica como una búsqueda de evasión.
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_ANSWER_SEEKING_QUERY_IGNORED_V2

Es la búsqueda que no busca respuestas y que ignora las mayúsculas y minúsculas.

Google omite la respuesta si la búsqueda no tiene una intención clara.
LOW_GROUNDED_ANSWER

Es el caso de respuesta con base baja.

Google omite la respuesta si no se pudo generar una respuesta fundamentada.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

Es la clasificación de la búsqueda definida por el usuario que ignora las mayúsculas y minúsculas.

Google omite la respuesta si la búsqueda se clasifica como una clasificación de búsqueda definida por el usuario.
UNHELPFUL_ANSWER

Es el caso de respuesta no útil.

Google omite la respuesta si no es útil. Esto puede deberse a varios factores, incluidos, sin limitaciones, los siguientes: la búsqueda no tiene respuesta, la respuesta no es pertinente para la búsqueda o la respuesta no está bien formateada.

SafetyRating

Es la calificación de seguridad correspondiente al contenido generado.

Representación JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Campos
category

enum (HarmCategory)

Solo salida. Es la categoría de daño.
probability

enum (HarmProbability)

Solo salida. Son los niveles de probabilidad de daños en el contenido.
probabilityScore

number

Solo salida. Es la puntuación de probabilidad de daño.
severity

enum (HarmSeverity)

Solo salida. Son los niveles de gravedad de los daños en el contenido.
severityScore

number

Solo salida. Es la puntuación de gravedad del daño.
blocked

boolean

Solo salida. Indica si se filtró el contenido debido a esta clasificación.

HarmCategory

Son las categorías de daño que bloquearán el contenido.

Enums
HARM_CATEGORY_UNSPECIFIED No se especifica la categoría de daño.
HARM_CATEGORY_HATE_SPEECH La categoría de daño es la incitación al odio o a la violencia.
HARM_CATEGORY_DANGEROUS_CONTENT La categoría de daño es el contenido peligroso.
HARM_CATEGORY_HARASSMENT La categoría de daño es el hostigamiento.
HARM_CATEGORY_SEXUALLY_EXPLICIT La categoría de daño es el contenido sexual explícito.
HARM_CATEGORY_CIVIC_INTEGRITY La categoría de daño es la integridad cívica.

HarmProbability

Son los niveles de probabilidad de daños en el contenido.

Enums
HARM_PROBABILITY_UNSPECIFIED No se especifica la probabilidad de daño.
NEGLIGIBLE Nivel de daño insignificante.
LOW Nivel de daño bajo
MEDIUM Nivel de daño medio
HIGH Nivel de daño alto

HarmSeverity

Niveles de gravedad de daños.

Enums
HARM_SEVERITY_UNSPECIFIED No se especifica la gravedad del daño.
HARM_SEVERITY_NEGLIGIBLE Nivel de gravedad del daño insignificante.
HARM_SEVERITY_LOW Nivel de gravedad de daño bajo.
HARM_SEVERITY_MEDIUM Nivel medio de gravedad del daño.
HARM_SEVERITY_HIGH Nivel de gravedad del daño alto

Métodos

get

 Obtiene una respuesta.