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

Recurso: AssistAnswer

Recurso AssistAnswer, 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. Identificador. Nombre de recurso de 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 1024 caracteres.
state

enum (State)

Estado de la generación de la respuesta.
replies[]

object (Reply)

Respuestas del asistente.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motivos por los que no se ha respondido a la llamada de asistencia.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Opcional. Este campo contiene información sobre los resultados de las distintas comprobaciones de políticas, como las frases prohibidas o las comprobaciones de Model Armor. Este campo solo se rellena si se ha omitido la llamada de asistencia debido a una infracción de las políticas.

Estado

Estado de la generación de la respuesta.

Enumeraciones
STATE_UNSPECIFIED Desconocido.
IN_PROGRESS La operación de asistencia está en curso.
FAILED No se ha podido realizar la operación de asistencia.
SUCCEEDED La operación de asistencia se ha realizado correctamente.
SKIPPED Se ha omitido la operación de asistencia.

Responder

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. Alternativas para la respuesta del asistente. reply solo puede ser una de estas dos opciones:
groundedContent

object (AssistantGroundedContent)

Texto o contenido multimedia de respuesta posiblemente fundamentado del asistente.

AssistantGroundedContent

Un contenido y, posiblemente, su información de base.

No todo el contenido necesita una base. No es necesario fundamentar frases como "Por supuesto, lo buscaré con gusto".

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)

El contenido.
citationMetadata

object (CitationMetadata)

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. Metadatos del contenido. Actualmente solo se usa para las respuestas de los asistentes de investigación.
Campo de unión metadata. Metadatos de base para varias ventanas modales. Por ahora, solo admite texto. metadata solo puede ser una de estas dos opciones:
textGroundingMetadata

object (TextGroundingMetadata)

Metadatos para fundamentar la información a partir de fuentes de texto.

TextGroundingMetadata

Detalles de la fundamentación de las fuentes de texto.

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

object (Segment)

Información de base de partes del texto.
references[]

object (Reference)

Referencias del texto fundamentado.

Segmento

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 de base 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 superior a uno).
endIndex

string (int64 format)

Fin del segmento, exclusivo.
referenceIndices[]

integer

Referencias del segmento.
groundingScore

number

Puntuación del segmento.
text

string

El segmento de texto en sí.

Referencia

Contenido referenciado y metadatos de documentos relacionados.

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

string

Contenido de texto de referencia.
documentMetadata

object (DocumentMetadata)

Metadatos del documento.

DocumentMetadata

Metadatos del documento.

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

string

Nombre de recurso del documento.
uri

string

URI del documento. Puede contener una URL que redirija al sitio web real.
title

string

Título.
pageIdentifier

string

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 redirija al sitio web real, en cuyo caso contendrá el nombre de dominio del sitio de destino.
mimeType

string

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

El productor del contenido. Puede ser "model" o "user".
thought

boolean

Opcional. Indica si el modelo ha pensado en la parte.
Campo de unión data. Datos incluidos. data solo puede ser una de estas dos opciones:
text

string

Texto insertado.
inlineData

object (Blob)

Datos binarios insertados.
file

object (File)

Un archivo, por ejemplo, un resumen de audio.
executableCode

object (ExecutableCode)

código generado por el modelo que se va a ejecutar.
codeExecutionResult

object (CodeExecutionResult)

Resultado de la ejecución de un ExecutableCode.

Blob

Blob insertado.

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

string

Obligatorio. El tipo de contenido (tipo MIME) de los datos generados.
data

string (bytes format)

Obligatorio. Bytes sin procesar.

Cadena codificada en base64.

Archivo

Un archivo, por ejemplo, un resumen de audio.

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

string

Obligatorio. El tipo de medio (tipo MIME) del archivo.
fileId

string

Obligatorio. El ID del archivo.

ExecutableCode

Código generado por el modelo que debe ejecutar el modelo.

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

string

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

CodeExecutionResult

Resultado de la ejecución de ExecutableCode.

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

enum (Outcome)

Obligatorio. Resultado de la ejecución del código.
output

string

Opcional. Contiene stdout cuando la ejecución del código se realiza correctamente; de lo contrario, contiene stderr u otra descripción.

Resultado

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

Enumeraciones
OUTCOME_UNSPECIFIED Estado no especificado. Este valor no se debe usar.
OUTCOME_OK La ejecución del código se ha completado correctamente.
OUTCOME_FAILED La ejecución del código ha finalizado, pero con un error. stderr debe contener el motivo.
OUTCOME_DEADLINE_EXCEEDED La ejecución del código ha tardado demasiado y se ha cancelado. Puede que haya o no una salida parcial.

CitationMetadata

Colección de atribuciones de origen de un contenido.

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

object (Citation)

Solo de salida. Lista de citas.

Referencia

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 de salida. Índice de inicio del contenido.
endIndex

integer

Solo de salida. Índice final del contenido.
uri

string

Solo de salida. Referencia de URL de la atribución.
title

string

Solo de salida. Título de la atribución.
license

string

Solo de salida. Licencia de la atribución.
publicationDate

object (Date)

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

ContentMetadata

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

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

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

Enumeraciones
CONTENT_KIND_UNSPECIFIED Desconocido.
RESEARCH_PLAN Plan de investigación.
RESEARCH_QUESTION Pregunta de investigación.
RESEARCH_ANSWER Respuesta de investigación.
RESEARCH_REPORT Informe de investigación.
RESEARCH_AUDIO_SUMMARY Resumen de audio de investigación.

AssistSkippedReason

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

Enumeraciones
ASSIST_SKIPPED_REASON_UNSPECIFIED Valor predeterminado. No se ha especificado el motivo para saltar el anuncio.
NON_ASSIST_SEEKING_QUERY_IGNORED El asistente ha ignorado la consulta porque no parecía que el usuario estuviera buscando una respuesta.
CUSTOMER_POLICY_VIOLATION El asistente ha ignorado la consulta o se ha negado a responder debido a una infracción de las políticas de clientes (por ejemplo, la consulta o la respuesta contenían una frase prohibida).

CustomerPolicyEnforcementResult

Resultados del cumplimiento de las políticas de clientes. Contiene los resultados de las distintas comprobaciones de las políticas, como las frases prohibidas o las comprobaciones de Model Armor.

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

enum (Verdict)

Veredicto final sobre el cumplimiento de la política de clientes. Si solo una política ha bloqueado el procesamiento, el veredicto es BLOQUEAR.
policyResults[]

object (PolicyEnforcementResult)

Resultados del cumplimiento de las políticas de clientes. Se rellena solo si se ha omitido la llamada de asistencia debido a una infracción de las políticas. Contiene los resultados de los filtros que han bloqueado el procesamiento de la consulta.

Veredicto

El veredicto de la medida por incumplimiento de la política de clientes.

Enumeraciones
UNSPECIFIED Valor desconocido.
ALLOW No se ha infringido ninguna política.
BLOCK El procesamiento se ha bloqueado por infringir la política de clientes.

PolicyEnforcementResult

Resultado de la aplicación de la política de 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. El resultado específico del tipo de política. Puede ser un error o información detallada sobre el resultado de la medida por incumplimiento de políticas. enforcement_result solo puede ser una de estas dos opciones:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

El resultado de la aplicación de la política de frases prohibidas.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Resultado de la aplicación de la política Model Armor.

BannedPhraseEnforcementResult

Resultado de la aplicación de la política de clientes para la política de frases prohibidas.

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

string

Las frases prohibidas que se han encontrado en la consulta o en la respuesta.

ModelArmorEnforcementResult

Resultado de la aplicación de la política de clientes de la política 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. El resultado de la política de Model Armor. result solo puede ser una de estas dos opciones:
modelArmorViolation

string

La infracción de Model Armor que se ha detectado.
error

object (Status)

Error devuelto por Model Armor si no se ha podido aplicar la política por algún motivo.

Métodos

get

 Obtiene un AssistAnswer.