REST Resource: projects.locations.collections.engines.sessions.assistAnswers

Recurso: AssistAnswer

Es el recurso de AssistAnswer, que es la parte principal de AssistResponse.

Representación JSON 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Campos
name

string

Inmutable. Es el identificador. Es el nombre del recurso AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
state

enum (State)

Es el estado de la generación de respuestas.
replies[]

object (Reply)

Son las respuestas del asistente.
assistSkippedReasons[]

enum (AssistSkippedReason)

Son los motivos por los que no se responde la llamada de asistencia.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Opcional. El campo contiene información sobre los resultados de las distintas verificaciones de políticas, como las frases prohibidas o las verificaciones de Model Armor. Este campo solo se completa si se omitió la llamada de asistencia debido a un incumplimiento de política.

Estado

Es el estado de la generación de respuestas.

Enums
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS La operación de asistencia está en curso.
FAILED No se pudo realizar la operación de asistencia.
SUCCEEDED La operación de asistencia se realizó correctamente.
SKIPPED Se omitió la operación de asistencia.

Responder

Es una parte de la respuesta de varias partes de la llamada de asistencia.

Representación JSON 
{

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Campos
Campo de unión reply. Son las alternativas para la respuesta del asistente. reply puede ser solo uno de los siguientes:
groundedContent

object (AssistantGroundedContent)

Es posible que se trate de texto o contenido multimedia fundamentado de la respuesta del asistente.

AssistantGroundedContent

Es un fragmento de contenido y, posiblemente, su información de fundamentación.

No todo el contenido necesita fundamentación. Las frases como "Por supuesto, con gusto lo buscaré por ti" no necesitan fundamentación.

Representación JSON 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
Campos
content

object (AssistantContent)

Es el contenido.
citationMetadata

object (CitationMetadata)

Es la atribución de la fuente del contenido generado. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

Opcional. Son los metadatos del contenido. Actualmente, solo se usa para las respuestas de los asistentes de investigación.
Campo de unión metadata. Son los metadatos de fundamentación para varios cuadros de diálogo. Por el momento, solo admite texto. metadata puede ser solo uno de los siguientes:
textGroundingMetadata

object (TextGroundingMetadata)

Son los metadatos para la fundamentación basados en fuentes de texto.

TextGroundingMetadata

Son los detalles de fundamentación para las fuentes de texto.

Representación JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
Campos
segments[]

object (Segment)

Es la información de fundamentación para partes del texto.
references[]

object (Reference)

Referencias para el texto fundamentado.

Segmento

Es la información de fundamentación de un segmento del texto.

Representación JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Campos
startIndex

string (int64 format)

Índice basado en cero que indica el inicio del segmento, medido en bytes de una cadena UTF-8 (es decir, los caracteres codificados en varios bytes tienen una longitud de más de uno).
endIndex

string (int64 format)

Es el final del segmento, exclusivo.
referenceIndices[]

integer

Son las referencias del segmento.
groundingScore

number

Es la puntuación del segmento.
text

string

Es el segmento de texto en sí.

Reference

Contenido al que se hace referencia y metadatos del documento relacionado

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

string

Contenido de texto al que se hace referencia.
documentMetadata

object (DocumentMetadata)

Son los metadatos del documento.

DocumentMetadata

Son los metadatos del documento.

Representación JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Campos
document

string

Nombre del recurso del documento.
uri

string

Es el URI del documento. Puede contener una URL que redirecciona al sitio web real.
title

string

y "title".
pageIdentifier

string

Es el identificador de la página.
domain

string

Nombre de dominio del URI del documento. Ten en cuenta que el campo uri puede contener una URL que redirecciona al sitio web real, en cuyo caso contendrá el nombre de dominio del sitio de destino.
mimeType

string

Es el tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

AssistantContent

Contenido multimodal

Representación JSON 
{
  "role": string,
  "thought": boolean,

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
Campos
role

string

Es el productor del contenido. Puede ser "model" o "user".
thought

boolean

Opcional. Indica si el modelo generó la parte.
Campo de unión data. Datos contenidos data puede ser solo uno de los siguientes:
text

string

Texto intercalado.
inlineData

object (Blob)

Son datos binarios intercalados.
file

object (File)

Es un archivo, p.ej., un resumen de audio.
executableCode

object (ExecutableCode)

Es el código que genera el modelo y que se debe ejecutar.
codeExecutionResult

object (CodeExecutionResult)

Es el resultado de ejecutar un ExecutableCode.

BLOB

Es un BLOB intercalado.

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

string

Obligatorio. Es el tipo de medio (tipo de MIME) de los datos generados.
data

string (bytes format)

Obligatorio. Bytes sin procesar.

Es una cadena codificada en base64.

Archivo

Es un archivo, p.ej., un resumen de audio.

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

string

Obligatorio. Es el tipo de medio (tipo de MIME) del archivo.
fileId

string

Obligatorio. Es el ID del archivo.

ExecutableCode

Código generado por el modelo que está destinado a ser ejecutado por el modelo.

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

string

Obligatorio. Es el contenido del código. Actualmente, solo admite Python.

CodeExecutionResult

Es el resultado de ejecutar ExecutableCode.

Representación JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
Campos
outcome

enum (Outcome)

Obligatorio. Es el resultado de la ejecución del código.
output

string

Opcional. Contiene stdout cuando la ejecución del código es exitosa; de lo contrario, contiene stderr o alguna otra descripción.

Resultado

Es la enumeración de los posibles resultados de la ejecución del código.

Enums
OUTCOME_UNSPECIFIED Indica que no se especificó el estado. No se debe usar este valor.
OUTCOME_OK La ejecución del código se completó correctamente.
OUTCOME_FAILED La ejecución del código finalizó, pero con un error. stderr debe contener el motivo.
OUTCOME_DEADLINE_EXCEEDED La ejecución del código se realizó durante demasiado tiempo y se canceló. Puede haber o no un resultado parcial presente.

CitationMetadata

Es una colección de atribuciones de fuentes para un fragmento de contenido.

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

object (Citation)

Solo salida. Lista de citas.

Cita

Son las atribuciones de la fuente del contenido.

Representación JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Campos
startIndex

integer

Solo salida. Índice de inicio en el contenido.
endIndex

integer

Solo salida. Índice final del contenido.
uri

string

Solo salida. Es la referencia de URL de la atribución.
title

string

Solo salida. Es el título de la atribución.
license

string

Solo salida. Es la licencia de la atribución.
publicationDate

object (Date)

Solo salida. Fecha de publicación de la atribución.

ContentMetadata

Son los metadatos del contenido.

Representación JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Campos
contentKind

enum (ContentKind)

Tipo de contenido. Muestra a qué parte de la respuesta del asistente de investigación pertenece este contenido.
contentId

string

Es el ID del contenido. Se usa para conectar las preguntas de investigación con sus respuestas. Por ejemplo, las partes de la respuesta a una pregunta de investigación tendrán el mismo contentId que la pregunta.

ContentKind

Son los tipos de contenido posibles. Actualmente, solo se usa para diferenciar secciones en la respuesta completa de un asistente de investigación.

Enums
CONTENT_KIND_UNSPECIFIED Desconocido.
RESEARCH_PLAN Plan de investigación
RESEARCH_QUESTION Pregunta de investigación.
RESEARCH_ANSWER Respuesta de investigación.
RESEARCH_REPORT Research report.
RESEARCH_AUDIO_SUMMARY Resumen de audio de la investigación.

AssistSkippedReason

Posibles motivos por los que no se responde una llamada de asistencia.

Enums
ASSIST_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se especificó el motivo de omisión.
NON_ASSIST_SEEKING_QUERY_IGNORED El asistente ignoró la búsqueda porque no parecía que se buscara una respuesta.
CUSTOMER_POLICY_VIOLATION El asistente ignoró la búsqueda o se negó a responder debido a un incumplimiento de la política del cliente (p.ej., la búsqueda o la respuesta contenían una frase prohibida).

CustomerPolicyEnforcementResult

Son los resultados de la aplicación de políticas para el cliente. Contiene los resultados de las distintas verificaciones de políticas, como las frases prohibidas o las verificaciones de Model Armor.

Representación JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
Campos
verdict

enum (Verdict)

Es el veredicto final sobre la aplicación de la política para el cliente. Si solo una política bloqueó el procesamiento, el veredicto es BLOCK.
policyResults[]

object (PolicyEnforcementResult)

Son los resultados de la aplicación de políticas para el cliente. Se propaga solo si se omitió la llamada de asistencia debido a un incumplimiento de política. Contiene los resultados de los filtros que bloquearon el procesamiento de la búsqueda.

Veredicto

Es el veredicto de la aplicación de la política para clientes.

Enums
UNSPECIFIED Valor desconocido.
ALLOW No hubo incumplimiento de política.
BLOCK La política del cliente bloqueó el procesamiento.

PolicyEnforcementResult

Es el resultado de la aplicación de la política del cliente para un solo tipo de política.

Representación JSON 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
Campos
Campo de unión enforcement_result. Es el resultado específico del tipo de política. Puede ser un error o información detallada sobre el resultado de la aplicación de políticas. enforcement_result puede ser solo uno de los siguientes:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Es el resultado de la aplicación de la política sobre frases prohibidas.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Es el resultado de la aplicación de la política de Model Armor.

BannedPhraseEnforcementResult

Es el resultado de la aplicación de la política para clientes sobre la política de frases prohibidas.

Representación JSON 
{
  "bannedPhrases": [
    string
  ]
}
Campos
bannedPhrases[]

string

Son las frases prohibidas que se encontraron en la búsqueda o la respuesta.

ModelArmorEnforcementResult

Es el resultado de la aplicación de la política para el cliente en relación con la política de Model Armor.

Representación JSON 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Campos
Campo de unión result. Es el resultado de la política de Model Armor. result puede ser solo uno de los siguientes:
modelArmorViolation

string

Es el incumplimiento de Model Armor que se encontró.
error

object (Status)

Es el error que devuelve Model Armor si la aplicación de la política falló por algún motivo.

Métodos

get

 Obtiene un AssistAnswer.