- Recurso: Answer
- Representación JSON
- Estado
- Cita
- CitationSource
- GroundingSupport
- Referencia
- UnstructuredDocumentInfo
- ChunkContent
- ChunkInfo
- DocumentMetadata
- StructuredDocumentInfo
- BlobAttachment
- Blob
- AttributionType
- Step
- Estado
- Acción
- SearchAction
- Observación
- SearchResult
- SnippetInfo
- ChunkInfo
- QueryUnderstandingInfo
- QueryClassificationInfo
- Tipo
- AnswerSkippedReason
- SafetyRating
- HarmCategory
- HarmProbability
- HarmSeverity
- Métodos
Recurso: Answer
Define una respuesta.
| Representación JSON |
|---|
{ "name": string, "state": enum ( |
| Campos | |
|---|---|
name |
Inmutable. Nombre completamente calificado |
state |
Es el estado de la generación de respuestas. |
answerText |
Es la respuesta textual. |
citations[] |
Citas. |
groundingSupports[] |
Es opcional. Compatibilidad con la fundamentación. |
references[] |
Referencias |
blobAttachments[] |
Solo salida. Es la lista de archivos adjuntos de BLOB en la respuesta. |
relatedQuestions[] |
Preguntas relacionadas sugeridas |
steps[] |
Pasos de generación de respuestas. |
queryUnderstandingInfo |
Es información sobre la comprensión de la búsqueda. |
answerSkippedReasons[] |
Son motivos adicionales por los que se omitió la respuesta. Proporciona el motivo de los casos ignorados. Si no se omite nada, este campo no se establece. |
createTime |
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 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: |
completeTime |
Solo salida. Es la marca de tiempo de la respuesta completada. 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: |
safetyRatings[] |
Es opcional. Calificaciones de seguridad |
groundingScore |
Es una puntuación en el rango de [0, 1] que describe qué tan fundamentada está la respuesta en los fragmentos de referencia. |
Estado
Es la 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 ( |
| Campos | |
|---|---|
startIndex |
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 más larga que la longitud de la cadena. |
endIndex |
Es el final del segmento atribuido, sin incluir. Se mide en bytes (Unicode UTF-8). Si hay caracteres multibyte,como caracteres que no son ASCII, la medición del índice es más larga que la longitud de la cadena. |
sources[] |
Son las fuentes de citas del segmento atribuido. |
CitationSource
Es la fuente de la cita.
| Representación JSON |
|---|
{ "referenceId": string } |
| Campos | |
|---|---|
referenceId |
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 ( |
| Campos | |
|---|---|
startIndex |
Obligatorio. El índice indica el inicio del reclamo, medido en bytes (Unicode UTF-8). |
endIndex |
Obligatorio. Es el final del reclamo, sin incluirlo. |
sources[] |
Es opcional. Son las fuentes de citas de la afirmación. |
groundingScore |
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 afirmación está mejor respaldada por los fragmentos de referencia. |
groundingCheckRequired |
Indica que este reclamo requirió una verificación de fundamentación. Cuando el sistema decidió que este reclamo 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 el reclamo y, por lo tanto, no se devuelven |
Reference
Referencia.
| Representación JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de unión content. Contenido del resultado de la búsqueda. content puede ser solo uno de los parámetros siguientes: |
|
unstructuredDocumentInfo |
Es la información de documentos no estructurados. |
chunkInfo |
Es información sobre el fragmento. |
structuredDocumentInfo |
Es información estructurada del documento. |
UnstructuredDocumentInfo
Es la información de documentos no estructurados.
| Representación JSON |
|---|
{
"document": string,
"uri": string,
"title": string,
"chunkContents": [
{
object ( |
| Campos | |
|---|---|
document |
Es el nombre del recurso del documento. |
uri |
Es el URI del documento. |
title |
y "title". |
chunkContents[] |
Lista de contenido de fragmentos citados derivados del contenido del documento. |
structData |
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 |
Fragmenta el contenido textual. |
pageIdentifier |
Es el identificador de la página. |
blobAttachmentIndexes[] |
Solo salida. Almacena los índices de los blobattachments vinculados a este fragmento. |
relevanceScore |
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 solo tiene 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 ( |
| Campos | |
|---|---|
chunk |
Nombre del recurso de fragmento. |
content |
Fragmenta el contenido textual. |
documentMetadata |
Son los metadatos del documento. |
blobAttachmentIndexes[] |
Solo salida. Almacena los índices de los blobattachments vinculados a este fragmento. |
relevanceScore |
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 solo tiene 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 |
Es el nombre del recurso del documento. |
uri |
Es el URI del documento. |
title |
y "title". |
pageIdentifier |
Es el identificador de la página. |
structData |
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 |
Es el nombre del recurso del documento. |
structData |
Datos de búsqueda estructurados |
title |
Solo salida. Es el título del documento. |
uri |
Solo salida. Es el URI del documento. |
BlobAttachment
Almacena los datos binarios adjuntos a la respuesta de texto, p.ej., imagen, video, audio, etcétera.
| Representación JSON |
|---|
{ "data": { object ( |
| Campos | |
|---|---|
data |
Solo salida. Son el tipo de MIME y los datos del BLOB. |
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 |
Solo salida. Es el tipo de medio (tipo de MIME) de los datos generados o recuperados. |
data |
Solo salida. Bytes sin procesar. Es una cadena codificada en Base64. |
AttributionType
Es la fuente del blob.
| Enums | |
|---|---|
ATTRIBUTION_TYPE_UNSPECIFIED |
Es un tipo de atribución sin especificar. |
CORPUS |
Los datos del 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 ( |
| Campos | |
|---|---|
state |
Es el estado del paso. |
description |
Es la descripción del paso. |
thought |
Es la idea del paso. |
actions[] |
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 ( |
| Campos | |
|---|---|
observation |
Observación. |
Campo de unión action. Es la acción. action puede ser solo uno de los parámetros siguientes: |
|
searchAction |
Acción de búsqueda. |
SearchAction
Acción de búsqueda.
| Representación JSON |
|---|
{ "query": string } |
| Campos | |
|---|---|
query |
Es la búsqueda. |
Observación
Observación.
| Representación JSON |
|---|
{
"searchResults": [
{
object ( |
| Campos | |
|---|---|
searchResults[] |
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 ( |
| Campos | |
|---|---|
document |
Es el nombre del recurso del documento. |
uri |
Es el URI del documento. |
title |
y "title". |
snippetInfo[] |
Si citation_type es DOCUMENT_LEVEL_CITATION, completa los resúmenes a nivel del documento. |
chunkInfo[] |
Si citation_type es CHUNK_LEVEL_CITATION y el modo de fragmentos está activado, completa la información del fragmento. |
structData |
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 |
Contenido del fragmento. |
snippetStatus |
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 |
Nombre del recurso de fragmento. |
content |
Fragmenta el contenido textual. |
relevanceScore |
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 solo tiene 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 ( |
| Campos | |
|---|---|
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 ( |
| Campos | |
|---|---|
type |
Es el tipo de clasificación de la búsqueda. |
positive |
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 búsqueda sin especificar. |
ADVERSARIAL_QUERY |
Es el tipo de clasificación de consultas adversariales. |
NON_ANSWER_SEEKING_QUERY |
Tipo de clasificación de búsqueda que no busca respuestas, para charlas triviales. |
JAIL_BREAKING_QUERY |
Es el tipo de clasificación de consultas para evitar la evasión de restricciones. |
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 definida 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 especifica 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 ignora las 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ó el uso de mayúsculas y minúsculas. Google omite la respuesta si no hay resultados de 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 |
Es la consulta de jailbreak que ignora 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 para clientes. 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 el uso de 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 clasificación de seguridad correspondiente al contenido generado.
| Representación JSON |
|---|
{ "category": enum ( |
| Campos | |
|---|---|
category |
Solo salida. Es la categoría de daño. |
probability |
Solo salida. Son los niveles de probabilidad de daños en el contenido. |
probabilityScore |
Solo salida. Es la puntuación de probabilidad de daño. |
severity |
Solo salida. Son los niveles de gravedad de daños en el contenido. |
severityScore |
Solo salida. Es la puntuación de gravedad del daño. |
blocked |
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 del daño bajo. |
HARM_SEVERITY_MEDIUM |
Nivel medio de gravedad del daño. |
HARM_SEVERITY_HIGH |
Alto nivel de gravedad del daño. |
Métodos |
|
|---|---|
|
Obtiene una respuesta. |