Candidate

Um candidato de resposta gerado pelo modelo.

Representação JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "index": integer
}
Campos
content

object (Content)

Apenas saída. Conteúdo gerado retornado do modelo.
finishReason

enum (FinishReason)

Opcional. Apenas saída. É o motivo pelo qual o modelo parou de gerar tokens.

Se estiver vazio, o modelo não parou de gerar os tokens.
safetyRatings[]

object (SafetyRating)

Lista de classificações de segurança de um candidato.

Há no máximo uma classificação por categoria.
citationMetadata

object (CitationMetadata)

Apenas saída. Informações de citação do candidato gerado pelo modelo.

Esse campo pode ser preenchido com informações de recitação de qualquer texto incluído em content. Esses trechos são "recitados" de materiais protegidos por direitos autorais nos dados de treinamento do LLM de base.
tokenCount

integer

Apenas saída. Contagem de tokens desse candidato.
groundingAttributions[]

object (GroundingAttribution)

Apenas saída. Informações de atribuição para as fontes que contribuíram para uma resposta fundamentada.

Este campo é preenchido para chamadas GenerateAnswer.
index

integer

Apenas saída. Índice do candidato na lista de candidatos.

FinishReason

Define o motivo pelo qual o modelo parou de gerar tokens.

Enums
FINISH_REASON_UNSPECIFIED Valor padrão. Esse valor não é usado.
STOP Ponto de parada natural do modelo ou sequência de parada fornecida.
MAX_TOKENS O número máximo de tokens especificado na solicitação foi atingido.
SAFETY O conteúdo do candidato foi sinalizado por motivos de segurança.
RECITATION O conteúdo do candidato foi sinalizado por motivos de recitação.
OTHER Motivo desconhecido.

GroundingAttribution

Atribuição para uma fonte que contribuiu para uma resposta.

Representação JSON 
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}
Campos
sourceId

object (AttributionSourceId)

Apenas saída. Identificador da fonte que contribui para essa atribuição.
content

object (Content)

O conteúdo de fonte embasamento que compõe essa atribuição.

AttributionSourceId

Identificador da fonte que contribui para essa atribuição.

Representação JSON 
{

  // Union field source can be only one of the following:
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // End of list of possible types for union field source.
}
Campos

Campo de união source.

source pode ser apenas de um dos tipos a seguir:
groundingPassage

object (GroundingPassageId)

Identificador de uma passagem in-line.
semanticRetrieverChunk

object (SemanticRetrieverChunk)

Identificador para um Chunk buscado pelo Semantic Retriever.

GroundingPassageId

Identificador de uma parte dentro de um GroundingPassage.

Representação JSON 
{
  "passageId": string,
  "partIndex": integer
}
Campos
passageId

string

Apenas saída. ID do trecho que corresponde ao GroundingPassage.id de GenerateAnswerRequest.
partIndex

integer

Apenas saída. Índice da parte no GroundingPassage.content do GenerateAnswerRequest.

SemanticRetrieverChunk

Identificador para um Chunk extraído pelo Semantic Retriever especificado no GenerateAnswerRequest usando SemanticRetrieverConfig.

Representação JSON 
{
  "source": string,
  "chunk": string
}
Campos
source

string

Apenas saída. Nome da origem que corresponde ao SemanticRetrieverConfig.source da solicitação. Exemplo: corpora/123 ou corpora/123/documents/abc
chunk

string

Apenas saída. Nome do Chunk que contém o texto atribuído. Exemplo: corpora/123/documents/abc/chunks/xyz