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

Recurso: AssistAnswer

Recurso AssistAnswer, parte principal de AssistResponse.

Representação JSON 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Campos
name

string

Imutável. Identificador. Nome do recurso do AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
state

enum (State)

Estado da geração de respostas.
replies[]

object (Reply)

Respostas do assistente.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motivos para não atender a chamada de assistência.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Opcional. O campo contém informações sobre os resultados das várias verificações de políticas, como as expressões proibidas ou as verificações do Model Armor. Este campo é preenchido apenas se a chamada assistida tiver sido ignorada devido a uma violação de política.

Estado

Estado da geração de respostas.

Enumerações
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS A operação de assistência está atualmente em curso.
FAILED A operação de assistência falhou.
SUCCEEDED A operação de assistência foi bem-sucedida.
SKIPPED A operação de assistência foi ignorada.

Responder

Uma parte da resposta multipartes da chamada de assistência.

Representação 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ão reply. Alternativas para a resposta do assistente. reply só pode ser uma das seguintes opções:
groundedContent

object (AssistantGroundedContent)

Texto ou conteúdo multimédia de resposta possivelmente fundamentado do assistente.

AssistantGroundedContent

Um conteúdo e, possivelmente, as respetivas informações de base.

Nem todo o conteúdo precisa de fundamentação. As expressões como "Claro que sim. Vou pesquisar isso para si." não precisam de fundamentação.

Representação 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)

O conteúdo.
citationMetadata

object (CitationMetadata)

Atribuição da origem do conteúdo gerado. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

Opcional. Metadados do conteúdo. Atualmente, só é usado para respostas de assistentes de investigação.
Campo de união metadata. Metadados de fundamentação para vários modais. Por agora, só suporta texto. metadata só pode ser uma das seguintes opções:
textGroundingMetadata

object (TextGroundingMetadata)

Metadados para fundamentação com base em fontes de texto.

TextGroundingMetadata

Detalhes de fundamentação para fontes de texto.

Representação JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
Campos
segments[]

object (Segment)

Informações de fundamentação para partes do texto.
references[]

object (Reference)

Referências para o texto fundamentado.

Segmento

Informações de fundamentação para um segmento do texto.

Representação JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Campos
startIndex

string (int64 format)

Índice baseado em zero que indica o início do segmento, medido em bytes de uma string UTF-8 (ou seja, os carateres codificados em vários bytes têm um comprimento superior a um).
endIndex

string (int64 format)

Fim do segmento, exclusivo.
referenceIndices[]

integer

Referências para o segmento.
groundingScore

number

Pontuação do segmento.
text

string

O próprio segmento de texto.

Referência

Conteúdo referenciado e metadados de documentos relacionados.

Representação JSON 
{
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Campos
content

string

Conteúdo de texto referenciado.
documentMetadata

object (DocumentMetadata)

Metadados do documento.

DocumentMetadata

Metadados do documento.

Representação JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Campos
document

string

Nome do recurso do documento.
uri

string

URI do documento. Pode conter um URL que redireciona para o Website real.
title

string

Título.
pageIdentifier

string

Identificador da página.
domain

string

Nome do domínio do URI do documento. Tenha em atenção que o campo uri pode conter um URL que redireciona para o Website real. Neste caso, contém o nome do domínio do site de destino.
mimeType

string

O tipo MIME do documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

AssistantContent

Conteúdo multimodal.

Representação 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

O produtor do conteúdo. Pode ser "model" ou "user".
thought

boolean

Opcional. Indica se a parte foi gerada pelo modelo.
Campo de união data. Dados contidos. data só pode ser uma das seguintes opções:
text

string

Texto inline.
inlineData

object (Blob)

Dados binários inline.
file

object (File)

Um ficheiro, por exemplo, um resumo de áudio.
executableCode

object (ExecutableCode)

Código gerado pelo modelo que se destina a ser executado.
codeExecutionResult

object (CodeExecutionResult)

Resultado da execução de um ExecutableCode.

Blob

Blob inline.

Representação JSON 
{
  "mimeType": string,
  "data": string
}
Campos
mimeType

string

Obrigatório. O tipo de suporte (tipo MIME) dos dados gerados.
data

string (bytes format)

Obrigatório. Bytes não processados.

Uma string codificada em Base64.

Ficheiro

Um ficheiro, por exemplo, um resumo de áudio.

Representação JSON 
{
  "mimeType": string,
  "fileId": string
}
Campos
mimeType

string

Obrigatório. O tipo de suporte (tipo MIME) do ficheiro.
fileId

string

Obrigatório. O ID do ficheiro.

ExecutableCode

Código gerado pelo modelo que se destina a ser executado pelo modelo.

Representação JSON 
{
  "code": string
}
Campos
code

string

Obrigatório. O conteúdo do código. Atualmente, só é compatível com Python.

CodeExecutionResult

Resultado da execução de ExecutableCode.

Representação JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
Campos
outcome

enum (Outcome)

Obrigatório. Resultado da execução do código.
output

string

Opcional. Contém stdout quando a execução do código é bem-sucedida, stderr ou outra descrição caso contrário.

Resultado

Enumeração dos possíveis resultados da execução do código.

Enumerações
OUTCOME_UNSPECIFIED Estado não especificado. Este valor não deve ser usado.
OUTCOME_OK A execução do código foi concluída com êxito.
OUTCOME_FAILED A execução de código terminou, mas com uma falha. stderr deve conter o motivo.
OUTCOME_DEADLINE_EXCEEDED A execução do código demorou demasiado tempo e foi cancelada. Pode ou não estar presente um resultado parcial.

CitationMetadata

Uma coleção de atribuições de fontes para um conteúdo.

Representação JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Campos
citations[]

object (Citation)

Apenas saída. Lista de citações.

Citação

Atribuições de fontes para conteúdo.

Representação JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Campos
startIndex

integer

Apenas saída. Índice de início no conteúdo.
endIndex

integer

Apenas saída. Índice final no conteúdo.
uri

string

Apenas saída. Referência do URL da atribuição.
title

string

Apenas saída. Título da atribuição.
license

string

Apenas saída. Licença da atribuição.
publicationDate

object (Date)

Apenas saída. Data de publicação da atribuição.

ContentMetadata

metadados do conteúdo.

Representação JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Campos
contentKind

enum (ContentKind)

tipo de conteúdo. Mostra a que parte da resposta do assistente de pesquisa este conteúdo pertence.
contentId

string

ID do conteúdo. É usado para associar perguntas de pesquisa a respostas. Por exemplo, as partes da resposta a uma pergunta de investigação têm o mesmo contentId que a pergunta.

ContentKind

Possíveis tipos de conteúdo. Atualmente, só é usado para diferenciar secções na resposta completa de um assistente de investigação.

Enumerações
CONTENT_KIND_UNSPECIFIED Desconhecido.
RESEARCH_PLAN Plano de investigação.
RESEARCH_QUESTION Pergunta de pesquisa.
RESEARCH_ANSWER Pesquisar resposta.
RESEARCH_REPORT Relatório de investigação.
RESEARCH_AUDIO_SUMMARY Resumo do áudio da investigação.

AssistSkippedReason

Possíveis motivos para não atender uma chamada de assistência.

Enumerações
ASSIST_SKIPPED_REASON_UNSPECIFIED Valor predefinido. O motivo da omissão não está especificado.
NON_ASSIST_SEEKING_QUERY_IGNORED O assistente ignorou a consulta porque não parecia estar à procura de uma resposta.
CUSTOMER_POLICY_VIOLATION O assistente ignorou a consulta ou recusou-se a responder devido a uma violação da política do cliente (por exemplo, a consulta ou a resposta continham uma expressão proibida).

CustomerPolicyEnforcementResult

Resultados da aplicação da política do cliente. Contém os resultados das várias verificações de políticas, como as expressões proibidas ou as verificações do Model Armor.

Representação JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
Campos
verdict

enum (Verdict)

Veredicto final da aplicação da política de clientes. Se apenas uma política tiver bloqueado o processamento, o veredito é BLOCK.
policyResults[]

object (PolicyEnforcementResult)

Resultados da aplicação da política do cliente. Preenchido apenas se a chamada de assistência tiver sido ignorada devido a uma violação de política. Contém resultados desses filtros que bloquearam o processamento da consulta.

Veredito

O veredito da aplicação da política do cliente.

Enumerações
UNSPECIFIED Valor desconhecido.
ALLOW Não houve violação de política.
BLOCK O processamento foi bloqueado pela política do cliente.

PolicyEnforcementResult

Resultado da aplicação da política do cliente para um único tipo de política.

Representação 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ão enforcement_result. O resultado específico do tipo de política. Pode ser um erro ou informações detalhadas sobre o resultado da aplicação de políticas. enforcement_result só pode ser uma das seguintes opções:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

O resultado da aplicação da política para a política de expressões proibidas.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

O resultado da aplicação da política Model Armor.

BannedPhraseEnforcementResult

Resultado da aplicação da política de clientes para a política de frases proibidas.

Representação JSON 
{
  "bannedPhrases": [
    string
  ]
}
Campos
bannedPhrases[]

string

As expressões proibidas que foram encontradas na consulta ou na resposta.

ModelArmorEnforcementResult

Resultado da aplicação da política do cliente para a política Model Armor.

Representação 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ão result. O resultado da política Model Armor. result só pode ser uma das seguintes opções:
modelArmorViolation

string

A violação do Model Armor que foi encontrada.
error

object (Status)

O erro devolvido pelo Model Armor se a aplicação de políticas falhar por algum motivo.

Métodos

get

 Obtém um AssistAnswer.