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 precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
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ítica, como frases proibidas ou verificações do Model Armor. Esse campo só é preenchido se a chamada de assistência foi ignorada devido a uma violação da política.

Estado

Estado da geração de respostas.

Tipos enumerados
STATE_UNSPECIFIED Desconhecido.
IN_PROGRESS Uma operação de assistência está em andamento.
FAILED A operação de assistência falhou.
SUCCEEDED A operação de assistência foi concluída.
SKIPPED A operação de assistência foi ignorada.

Responder

Uma parte da resposta multipart 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 pode ser apenas de um dos tipos a seguir:
groundedContent

object (AssistantGroundedContent)

Possível texto ou mídia fundamentada da resposta do assistente.

AssistantGroundedContent

Um conteúdo e possivelmente as informações de embasamento dele.

Nem todo conteúdo precisa de embasamento. Frases como "Claro, vou pesquisar para você" não precisam de embasamento.

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 fonte 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. No momento, usado apenas para respostas de assistentes de pesquisa.
Campo de união metadata. Metadados de embasamento para vários modais. No momento, ele só aceita texto. metadata pode ser apenas de um dos tipos a seguir:
textGroundingMetadata

object (TextGroundingMetadata)

Metadados para embasamento com base em fontes de texto.

TextGroundingMetadata

Detalhes de embasamento para fontes de texto.

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

object (Segment)

Informações de embasamento para partes do texto.
references[]

object (Reference)

Referências para o texto embasado.

Segmento

Informações de embasamento para um segmento do texto.

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

string (int64 format)

Índice de base zero que indica o início do segmento, medido em bytes de uma string UTF-8. Ou seja, caracteres codificados em vários bytes têm um comprimento maior que 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. Ele pode conter um URL que redireciona para o site real.
title

string

Título.
pageIdentifier

string

Identificador da página.
domain

string

Nome de domínio do URI do documento. O campo uri pode conter um URL que redireciona para o site real. Nesse caso, ele vai conter o nome de 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 pode ser apenas de um dos tipos a seguir:
text

string

Texto inline.
inlineData

object (Blob)

Dados binários inline.
file

object (File)

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

object (ExecutableCode)

código gerado pelo modelo que deve 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 mídia (tipo MIME) dos dados gerados.
data

string (bytes format)

Obrigatório. Bytes brutos.

Uma string codificada em base64.

Arquivo

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

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

string

Obrigatório. O tipo de mídia (tipo MIME) do arquivo.
fileId

string

Obrigatório. O ID do arquivo.

ExecutableCode

código gerado pelo modelo para ser executado por ele.

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

string

Obrigatório. O conteúdo do código. No momento, só há suporte para 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.

Resultado

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

Tipos enumerados
OUTCOME_UNSPECIFIED Status não especificado. Esse valor não deve ser usado.
OUTCOME_OK A execução do código foi concluída.
OUTCOME_FAILED A execução do código foi concluída, mas com uma falha. stderr precisa conter o motivo.
OUTCOME_DEADLINE_EXCEEDED A execução do código durou muito tempo e foi cancelada. Pode haver ou não uma saída parcial.

CitationMetadata

Uma coleção de atribuições de origem 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 origem 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 inicial do conteúdo.
endIndex

integer

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

string

Somente saída. Referência de 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 do conteúdo. Mostra a qual parte da resposta do assistente de pesquisa esse conteúdo pertence.
contentId

string

ID do conteúdo. Ele é usado para conectar perguntas de pesquisa com as respostas. Por exemplo, as partes da resposta a uma pergunta de pesquisa terão o mesmo contentId da pergunta.

ContentKind

Possíveis tipos de conteúdo. No momento, usado apenas para diferenciar seções na resposta completa de um assistente de pesquisa.

Tipos enumerados
CONTENT_KIND_UNSPECIFIED Desconhecido.
RESEARCH_PLAN Plano de pesquisa.
RESEARCH_QUESTION Pergunta da pesquisa.
RESEARCH_ANSWER Resposta da pesquisa.
RESEARCH_REPORT Research report.
RESEARCH_AUDIO_SUMMARY Resumo da pesquisa em áudio.

AssistSkippedReason

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

Tipos enumerados
ASSIST_SKIPPED_REASON_UNSPECIFIED Valor padrão. O motivo para pular não foi especificado.
NON_ASSIST_SEEKING_QUERY_IGNORED O Google Assistente ignorou a consulta porque ela não parecia estar buscando uma resposta.
CUSTOMER_POLICY_VIOLATION O assistente ignorou a consulta ou se recusou a responder devido a uma violação da política do cliente (por exemplo, a consulta ou a resposta continha uma frase proibida).

CustomerPolicyEnforcementResult

Resultados da aplicação da política do cliente. Contém os resultados das várias verificações de política, como as frases 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 do cliente. Se apenas uma política bloquear o processamento, o veredito será BLOCK.
policyResults[]

object (PolicyEnforcementResult)

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

Veredito

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

Tipos enumerados
UNSPECIFIED Valor desconhecido.
ALLOW Não houve violação da 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 restrição da política. enforcement_result pode ser apenas de um dos tipos a seguir:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

O resultado da aplicação da política de frases proibidas.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

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

BannedPhraseEnforcementResult

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

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

string

As frases proibidas encontradas na consulta ou na resposta.

ModelArmorEnforcementResult

Resultado da aplicação da política do cliente para a política do 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 do Model Armor. result pode ser apenas de um dos tipos a seguir:
modelArmorViolation

string

A violação do Model Armor encontrada.
error

object (Status)

O erro retornado pelo Model Armor se a aplicação da política falhar por algum motivo.

Métodos

get

 Recebe um AssistAnswer.