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

Recurso: respuesta

Define una respuesta.

Representación JSON 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "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 completo projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

El estado de la generación de la respuesta.
answerText

string

La respuesta textual.
citations[]

object (Citation)

Citas.
groundingSupports[]

object (GroundingSupport)

Opcional. Se admiten las bases.
references[]

object (Reference)

Referencias.
relatedQuestions[]

string

Preguntas relacionadas sugeridas.
steps[]

object (Step)

Pasos para generar respuestas.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Información sobre la comprensión de las consultas.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Motivos adicionales por los que se ha saltado la respuesta. Proporciona el motivo de los casos ignorados. Si no se omite nada, este campo no se define.
createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de creación de la respuesta.

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".
completeTime

string (Timestamp format)

Solo de salida. Marca de tiempo de la respuesta completada.

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".
safetyRatings[]

object (SafetyRating)

Opcional. Puntuaciones de seguridad.
groundingScore

number

Puntuación en el intervalo [0, 1] que describe el grado de fundamentación de la respuesta en los fragmentos de referencia.

Estado

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

Enumeraciones
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS Se está generando la respuesta.
FAILED No se ha podido generar la respuesta.
SUCCEEDED La generación de respuestas se ha completado correctamente.
STREAMING Se está generando la respuesta.

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

string (int64 format)

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

object (CitationSource)

Fuentes de citas del segmento atribuido.

CitationSource

Fuente de la cita.

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

string

ID de la fuente de la cita.

GroundingSupport

Basa tu ayuda en la evidencia recogida 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 de la reclamación, medido en bytes (Unicode UTF-8).
endIndex

string (int64 format)

Obligatorio. Fin de la reclamación (no incluido).
sources[]

object (CitationSource)

Opcional. Fuentes de cita de la reclamación.
groundingScore

number

Puntuación entre 0 y 1 que describe el grado de fundamentación de una afirmación específica en las referencias. Cuanto mayor sea el valor, más respaldada estará la afirmación por los fragmentos de referencia.
groundingCheckRequired

boolean

Indica que esta reclamación ha requerido una comprobación de la fundamentación. Si el sistema ha determinado que esta reclamación no requiere una comprobación de atribución o de fundamento, este campo se define como "false". En ese caso, no se ha realizado ninguna comprobación de la base de la afirmación y, por lo tanto, no se devuelve groundingScore, sources.

Referencia

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 de los resultados de búsqueda. content solo puede ser una de estas dos opciones:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Información de documentos no estructurada.
chunkInfo

object (ChunkInfo)

Información de los fragmentos.
structuredDocumentInfo

object (StructuredDocumentInfo)

Información estructurada del documento.

UnstructuredDocumentInfo

Información de documentos no estructurada.

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

string

Nombre de recurso del documento.
uri

string

URI del documento.
title

string

Título.
chunkContents[]

object (ChunkContent)

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

object (Struct format)

Los metadatos JSON estructurados del documento. Se rellena con los datos estructurados del fragmento del resultado de búsqueda.

ChunkContent

Contenido de fragmento.

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

string

Divide el contenido textual en fragmentos.
pageIdentifier

string

Identificador de la página.
relevanceScore

number

La relevancia del fragmento para una consulta determinada. Los valores van de 0,0 (totalmente irrelevante) a 1,0 (totalmente relevante). Este valor tiene un carácter meramente informativo. Puede cambiar en cualquier momento para la misma consulta y el mismo fragmento debido a un reentrenamiento del modelo o a un cambio en la implementación.

ChunkInfo

Información de los fragmentos.

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

string

Nombre de recurso del fragmento.
content

string

Divide el contenido textual en fragmentos.
documentMetadata

object (DocumentMetadata)

Metadatos del documento.
relevanceScore

number

La relevancia del fragmento para una consulta determinada. Los valores van de 0,0 (totalmente irrelevante) a 1,0 (totalmente relevante). Este valor tiene un carácter meramente informativo. Puede cambiar en cualquier momento para la misma consulta y el mismo fragmento debido a un reentrenamiento del modelo o a un cambio en la implementación.

DocumentMetadata

Metadatos del documento.

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

string

Nombre de recurso del documento.
uri

string

URI del documento.
title

string

Título.
pageIdentifier

string

Identificador de la página.
structData

object (Struct format)

Los metadatos JSON estructurados del documento. Se rellena con los datos estructurados del fragmento del resultado de búsqueda.

StructuredDocumentInfo

Información de búsqueda estructurada.

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

string

Nombre de recurso del documento.
structData

object (Struct format)

Datos de búsqueda estructurados.
title

string

Solo de salida. El título del documento.
uri

string

Solo de salida. El URI del documento.

Paso

Información sobre el paso.

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

enum (State)

El estado del paso.
description

string

La descripción del paso.
thought

string

La idea del paso.
actions[]

object (Action)

Acciones.

Estado

Enumeración del estado del paso.

Enumeraciones
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS El paso está en curso.
FAILED El paso ha fallado.
SUCCEEDED El paso se ha completado 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. La acción. action solo puede ser una de estas dos opciones:
searchAction

object (SearchAction)

Acción de búsqueda.

SearchAction

Acción de búsqueda.

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

string

Consulta de búsqueda.

Observación

Observación.

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

object (SearchResult)

Resultados de búsqueda observados por la acción de búsqueda. Pueden ser información de fragmentos o de bloques, según el tipo de cita que haya definido el usuario.

SearchResult

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

string

Nombre de recurso del documento.
uri

string

URI del documento.
title

string

Título.
snippetInfo[]

object (SnippetInfo)

Si citation_type es DOCUMENT_LEVEL_CITATION, rellena los fragmentos a nivel de documento.
chunkInfo[]

object (ChunkInfo)

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

object (Struct format)

Representación de datos. Los datos JSON estructurados del documento. Se rellena con los datos estructurados del documento o del fragmento del resultado de búsqueda.

SnippetInfo

Información del fragmento.

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

string

Contenido del fragmento.
snippetStatus

string

Estado del fragmento definido por el equipo de búsqueda.

ChunkInfo

Información de los fragmentos.

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

string

Nombre de recurso del fragmento.
content

string

Divide el contenido textual en fragmentos.
relevanceScore

number

La relevancia del fragmento para una consulta determinada. Los valores van de 0,0 (totalmente irrelevante) a 1,0 (totalmente relevante). Este valor tiene un carácter meramente informativo. Puede cambiar en cualquier momento para la misma consulta y el mismo fragmento debido a un reentrenamiento del modelo o a un cambio en la implementación.

QueryUnderstandingInfo

Información sobre la comprensión de las consultas.

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

object (QueryClassificationInfo)

Consultar información de clasificación.

QueryClassificationInfo

Consultar información de clasificación.

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

enum (Type)

Tipo de clasificación de la consulta.
positive

boolean

Salida de clasificación.

Tipo

Tipos de clasificación de consultas.

Enumeraciones
TYPE_UNSPECIFIED Tipo de clasificación de consulta no especificado.
ADVERSARIAL_QUERY Tipo de clasificación de consultas adversarias.
NON_ANSWER_SEEKING_QUERY Tipo de clasificación de consultas que no buscan respuestas, para conversaciones informales.
JAIL_BREAKING_QUERY Tipo de clasificación de consultas de jailbreak.
NON_ANSWER_SEEKING_QUERY_V2 Tipo de clasificación de consultas que no buscan respuestas, sin una intención clara.
USER_DEFINED_CLASSIFICATION_QUERY Tipo de clasificación de consultas definido por el usuario.

AnswerSkippedReason

Enumeración de los motivos por los que se ha saltado una respuesta.

Enumeraciones
ANSWER_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se ha especificado el motivo por el que se ha saltado la respuesta.
ADVERSARIAL_QUERY_IGNORED La consulta adversarial no distingue entre mayúsculas y minúsculas.
NON_ANSWER_SEEKING_QUERY_IGNORED

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

Google omite la respuesta si la consulta es una conversación informal.
OUT_OF_DOMAIN_QUERY_IGNORED

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

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

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

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

El caso de que no haya contenido relevante.

Google omite la respuesta 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". Google omite la respuesta si la consulta se clasifica como una consulta de jailbreak.
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_ANSWER_SEEKING_QUERY_IGNORED_V2

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

Google omite la respuesta si la consulta no tiene una intención clara.
LOW_GROUNDED_ANSWER

La respuesta realista.

Google omite la respuesta si no se ha podido generar una respuesta bien fundamentada.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

Clasificación de consultas definida por el usuario que no distingue entre mayúsculas y minúsculas.

Google omite la respuesta si la consulta se clasifica como una consulta definida por el usuario.
UNHELPFUL_ANSWER

El caso de la respuesta poco útil.

Google se salta la respuesta si no es útil. Esto puede deberse a varios factores, como que no se pueda responder a la consulta, que la respuesta no sea pertinente o que no esté bien formateada.

SafetyRating

Valoració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 de salida. Categoría de daño.
probability

enum (HarmProbability)

Solo de salida. Niveles de probabilidad de daño en el contenido.
probabilityScore

number

Solo de salida. Puntuación de probabilidad de daño.
severity

enum (HarmSeverity)

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

number

Solo de salida. Puntuación de gravedad de los daños.
blocked

boolean

Solo de salida. Indica si el contenido se ha excluido debido a esta clasificación.

HarmCategory

Categorías de daño que bloquearán el contenido.

Enumeraciones
HARM_CATEGORY_UNSPECIFIED La categoría de daño no se ha especificado.
HARM_CATEGORY_HATE_SPEECH La categoría de contenido dañino es incitación al odio.
HARM_CATEGORY_DANGEROUS_CONTENT La categoría de daño es contenido peligroso.
HARM_CATEGORY_HARASSMENT La categoría de daño es acoso.
HARM_CATEGORY_SEXUALLY_EXPLICIT La categoría de daño es contenido sexual explícito.
HARM_CATEGORY_CIVIC_INTEGRITY La categoría de daño es integridad cívica.

HarmProbability

Niveles de probabilidad de daño en el contenido.

Enumeraciones
HARM_PROBABILITY_UNSPECIFIED No se ha especificado la probabilidad de daño.
NEGLIGIBLE Nivel de daño insignificante.
LOW Nivel de daño bajo.
MEDIUM Nivel de daño medio.
HIGH Alto nivel de daño.

HarmSeverity

Niveles de gravedad del daño.

Enumeraciones
HARM_SEVERITY_UNSPECIFIED Gravedad del daño sin especificar.
HARM_SEVERITY_NEGLIGIBLE Nivel de gravedad de los daños insignificante.
HARM_SEVERITY_LOW Nivel de gravedad de los daños bajo.
HARM_SEVERITY_MEDIUM Nivel de gravedad medio.
HARM_SEVERITY_HIGH Nivel de gravedad de los daños alto.

Métodos

get

 Obtiene una respuesta.