- Representação JSON
- Candidato
- FinishReason
- SafetyRating
- HarmProbability
- CitationMetadata
- CitationSource (link em inglês)
- PromptFeedback
- BlockReason
- UsageMetadata
Resposta do modelo que oferece suporte a vários candidatos.
Observação sobre as classificações de segurança e a 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 determina que: todos os candidatos solicitados são devolvidos ou nenhum candidato é retornado; nenhum candidato é retornado apenas se houver algo de errado com a solicitação (consulte promptFeedback
); o feedback sobre cada candidato é informado em finishReason
e safetyRatings
.
Representação JSON |
---|
{ "candidates": [ { object ( |
Campos | |
---|---|
candidates[] |
Respostas dos candidatos do modelo. |
promptFeedback |
Retorna o feedback do comando relacionado aos filtros de conteúdo. |
usageMetadata |
Apenas saída. Metadados sobre o uso do token das solicitações de geração. |
Candidato
Um candidato de resposta gerado a partir do modelo.
Representação JSON |
---|
{ "content": { object ( |
Campos | |
---|---|
content |
Apenas saída. Conteúdo gerado retornado do modelo. |
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[] |
Lista de classificações para a segurança de um candidato de resposta. Existe no máximo uma classificação por categoria. |
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 |
tokenCount |
Apenas saída. Contagem de tokens para este candidato. |
index |
Apenas saída. Índice do candidato na lista. |
FinishReason
Define o motivo pelo qual o modelo parou de gerar tokens.
Tipos enumerados | |
---|---|
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 para um conteúdo.
A classificação de segurança contém a categoria do dano e o nível de probabilidade de danos dessa categoria para um conteúdo. O conteúdo é classificado em relação à segurança em várias categorias de danos, e a probabilidade da classificação está incluída aqui.
Representação JSON |
---|
{ "category": enum ( |
Campos | |
---|---|
category |
Obrigatório. A categoria dessa classificação. |
probability |
Obrigatório. A probabilidade de dano para o conteúdo. |
blocked |
O conteúdo foi bloqueado por causa da classificação? |
HarmProbability
A probabilidade de um conteúdo ser nocivo.
O sistema de classificação informa a probabilidade de o conteúdo não ser seguro. Isso não indica a gravidade dos danos a um conteúdo.
Tipos enumerados | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
A probabilidade não foi especificada. |
NEGLIGIBLE |
O conteúdo tem uma chance insignificante 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 chance alta de não ser seguro. |
CitationMetadata
Uma coleção de atribuições de fonte para um conteúdo.
Representação JSON |
---|
{
"citationSources": [
{
object ( |
Campos | |
---|---|
citationSources[] |
Citações de fontes para uma resposta específica. |
CitationSource
Uma citação de uma fonte para parte de uma resposta específica.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
Campos | |
---|---|
startIndex |
Opcional. Início do trecho da resposta atribuído a essa origem. Índice indica o início do segmento, medido em bytes. |
endIndex |
Opcional. Fim do segmento atribuído, exclusivo. |
uri |
Opcional. URI atribuído como uma origem para uma parte do texto. |
license |
Opcional. Licença para o projeto do GitHub que é atribuída como uma origem para o segmento. As informações da licença são necessárias para citações de código. |
PromptFeedback
Um conjunto de metadados de feedback do comando especificado em GenerateContentRequest.content
.
Representação JSON |
---|
{ "blockReason": enum ( |
Campos | |
---|---|
blockReason |
Opcional. Se definido, a solicitação será bloqueada e nenhum candidato será retornado. Reformule seu comando. |
safetyRatings[] |
Classificações para segurança do comando. Existe no máximo uma classificação por categoria. |
BlockReason
Especifica o motivo do bloqueio da solicitação.
Tipos enumerados | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
SAFETY |
O comando foi bloqueado por motivos de segurança. Inspecione o safetyRatings para entender qual categoria de segurança o bloqueou. |
OTHER |
A solicitação foi bloqueada por 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 |
Número de tokens no comando. Quando cacheContent é definido, esse ainda é o tamanho total efetivo da solicitação. Ou seja, isso inclui o número de tokens no conteúdo armazenado em cache. |
candidatesTokenCount |
Número total de tokens nos candidatos gerados. |
totalTokenCount |
Contagem total de tokens para a solicitação de geração (comando + candidatos). |