GenerateContentResponse

Resposta do modelo que dá suporte a vários candidatos.

Observação sobre classificações de segurança e filtragem de conteúdo. Eles são informados para o comando em GenerateContentResponse.prompt_feedback e para cada candidato em finishReason e em safetyRatings. O contrato da API é o seguinte: - ou todos os candidatos solicitados são retornados ou nenhum candidato - nenhum candidato é retornado apenas se houve algo errado com a solicitação (consulte promptFeedback) - o feedback sobre cada candidato é relatado em finishReason e safetyRatings.

Representação JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
Campos
candidates[]

object (Candidate)

Respostas candidatos do modelo.
promptFeedback

object (PromptFeedback)

Retorna o feedback do comando relacionado aos filtros de conteúdo.
usageMetadata

object (UsageMetadata)

Apenas saída. Metadados sobre o uso de tokens das solicitações de geração.

Candidato

Uma candidata de resposta gerada do modelo.

Representação JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "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 à resposta.

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

object (CitationMetadata)

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

Este campo pode ser preenchido com informações de recitação de qualquer texto incluído no content. São trechos que 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.
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.

SafetyRating

É a classificação de segurança de um conteúdo.

A classificação de segurança inclui a categoria do dano e o nível de probabilidade de danos nessa categoria para um conteúdo. O conteúdo é classificado para segurança em várias categorias de danos, e a probabilidade de classificação de danos está incluída aqui.

Representação JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
Campos
category

enum (HarmCategory)

Obrigatório. A categoria desta classificação.
probability

enum (HarmProbability)

Obrigatório. A probabilidade de danos ao conteúdo.
blocked

boolean

O conteúdo foi bloqueado devido a essa classificação?

HarmProbability

A probabilidade de um conteúdo ser nocivo.

O sistema de classificação indica a probabilidade do conteúdo não ser seguro. Isso não indica a gravidade dos danos a um conteúdo.

Enums
HARM_PROBABILITY_UNSPECIFIED A probabilidade não foi especificada.
NEGLIGIBLE O conteúdo tem uma chance mínima de não ser seguro.
LOW O conteúdo tem uma chance baixa de não ser seguro.
MEDIUM O conteúdo tem uma chance média de não ser seguro.
HIGH O conteúdo tem uma grande chance de não ser seguro.

CitationMetadata

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

Representação JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
Campos
citationSources[]

object (CitationSource)

Citações de fontes para uma resposta específica.

CitationSource

Uma citação de uma fonte para uma parte de uma resposta específica.

Representação JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
Campos
startIndex

integer

Opcional. Início do segmento da resposta atribuída a essa origem.

Índice indica o início do segmento, medido em bytes.
endIndex

integer

Opcional. Fim do segmento atribuído, exclusivo.
uri

string

Opcional. URI que é atribuído como a origem de uma parte do texto.
license

string

Opcional. Licença para o projeto do GitHub que é atribuído como uma origem do segmento.

As informações de licença são necessárias para citações de código.

PromptFeedback

Um conjunto dos metadados de feedback que a solicitação especificou em GenerateContentRequest.content.

Representação JSON 
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
Campos
blockReason

enum (BlockReason)

Opcional. Se definido, a solicitação será bloqueada e nenhum candidato será retornado. Reformule seu comando.
safetyRatings[]

object (SafetyRating)

Classificações de segurança da solicitação. Há no máximo uma classificação por categoria.

BlockReason

Especifica o motivo do bloqueio do prompt.

Enums
BLOCK_REASON_UNSPECIFIED Valor padrão. Esse valor não é usado.
SAFETY A solicitação foi bloqueada por motivos de segurança. Você pode inspecionar safetyRatings para entender qual categoria de segurança a bloqueou.
OTHER A solicitação foi bloqueada devido a motivos desconhecidos.

UsageMetadata

Metadados sobre o uso do token da solicitação de geração.

Representação JSON 
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
Campos
promptTokenCount

integer

Número de tokens no comando.
candidatesTokenCount

integer

Número total de tokens nos candidatos gerados.
totalTokenCount

integer

Contagem total de tokens para a solicitação de geração (comando + candidatos).