A API Gemini oferece suporte à geração de conteúdo com imagens, áudio, código, ferramentas e muito mais. Para saber mais sobre cada um desses recursos, leia o código de exemplo focado em tarefas ou os guias completos.
- Geração de texto
- Vision
- Áudio
- Contexto longo
- Execução de código
- Modo JSON
- Chamadas de função
- Instruções do sistema
Método: models.generateContent
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Gera uma resposta de modelo com base em uma entrada GenerateContentRequest
. Consulte o guia de geração de texto para informações detalhadas sobre o uso. Os recursos de entrada são diferentes entre os modelos, incluindo os modelos sintonizados. Consulte o guia do modelo e o guia de ajuste para mais detalhes.
Endpoint
post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContentParâmetros de caminho
model
string
Obrigatório. O nome do Model
a ser usado para gerar a conclusão.
Formato: name=models/{model}
. Ele tem o formato models/{model}
.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
tools[]
object (Tool
)
Opcional. Uma lista de Tools
que a Model
pode usar para gerar a próxima resposta.
Um Tool
é um trecho de código que permite ao sistema interagir com sistemas externos para realizar uma ação, ou conjunto de ações, fora do conhecimento e do escopo da Model
. Os Tool
s aceitos são Function
e codeExecution
. Consulte os guias Chamada de função e Execução de código para saber mais.
toolConfig
object (ToolConfig
)
Opcional. Configuração da ferramenta para qualquer Tool
especificado na solicitação. Consulte o guia de chamada de função para conferir um exemplo de uso.
safetySettings[]
object (SafetySetting
)
Opcional. Uma lista de instâncias SafetySetting
exclusivas para bloquear conteúdo não seguro.
Isso será aplicado em GenerateContentRequest.contents
e GenerateContentResponse.candidates
. Não pode haver mais de uma configuração para cada tipo de SafetyCategory
. A API vai bloquear qualquer conteúdo e resposta que não atenda aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory
especificado nas safetySettings. Se não houver SafetySetting
para um determinado SafetyCategory
fornecido na lista, a API vai usar a configuração de segurança padrão para essa categoria. As categorias de dano HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT são compatíveis. Consulte o guia para informações detalhadas sobre as configurações de segurança disponíveis. Consulte também as orientações de segurança para saber como incorporar considerações de segurança nos seus aplicativos de IA.
systemInstruction
object (Content
)
Opcional. Instruções do sistema definidas pelo desenvolvedor. No momento, apenas texto.
generationConfig
object (GenerationConfig
)
Opcional. Opções de configuração para geração e saídas de modelos.
cachedContent
string
Opcional. O nome do conteúdo armazenado em cache a ser usado como contexto para exibir a previsão. Formato: cachedContents/{cachedContent}
Exemplo de solicitação
Texto
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Imagem
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Áudio
Python
Node.js
Concha
Vídeo
Python
Node.js
Go
Concha
Python
Concha
Chat
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Cache
Python
Node.js
Modelo ajustado
Python
Modo JSON
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Execução de código
Python
Kotlin
Java
chamada de função
Python
Node.js
Concha
Kotlin
Swift
Dart
Java
Configuração de geração
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Configurações de segurança
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Instrução do sistema
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de GenerateContentResponse
.
Método: models.streamGenerateContent
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Gera uma resposta em streaming a partir do modelo que recebe um GenerateContentRequest
de entrada.
Endpoint
post https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContentParâmetros de caminho
model
string
Obrigatório. O nome do Model
a ser usado para gerar a conclusão.
Formato: name=models/{model}
. Ele tem o formato models/{model}
.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
tools[]
object (Tool
)
Opcional. Uma lista de Tools
que a Model
pode usar para gerar a próxima resposta.
Um Tool
é um código que permite ao sistema interagir com sistemas externos para realizar uma ação ou conjunto de ações fora do conhecimento e do escopo do Model
. Os Tool
s aceitos são Function
e codeExecution
. Consulte os guias Chamada de função e Execução de código para saber mais.
toolConfig
object (ToolConfig
)
Opcional. Configuração de ferramenta para qualquer Tool
especificado na solicitação. Consulte o guia sobre chamadas de função para conferir um exemplo de uso.
safetySettings[]
object (SafetySetting
)
Opcional. Uma lista de instâncias SafetySetting
exclusivas para bloquear conteúdo não seguro.
Isso será aplicado em GenerateContentRequest.contents
e GenerateContentResponse.candidates
. Não pode haver mais de uma configuração para cada tipo de SafetyCategory
. A API vai bloquear qualquer conteúdo e resposta que não atenda aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory
especificada em safetySettings. Se não houver SafetySetting
para um determinado SafetyCategory
fornecido na lista, a API vai usar a configuração de segurança padrão para essa categoria. As categorias de dano HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT são compatíveis. Consulte o guia para informações detalhadas sobre as configurações de segurança disponíveis. Consulte também as orientações de segurança para saber como incorporar considerações de segurança nos seus aplicativos de IA.
systemInstruction
object (Content
)
Opcional. O desenvolvedor definiu instruções do sistema. No momento, apenas texto.
generationConfig
object (GenerationConfig
)
Opcional. Opções de configuração para geração e saídas de modelos.
cachedContent
string
Opcional. O nome do conteúdo armazenado em cache a ser usado como contexto para exibir a previsão. Formato: cachedContents/{cachedContent}
Exemplo de solicitação
Texto
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Imagem
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Áudio
Python
Concha
Vídeo
Python
Node.js
Go
Concha
Python
Concha
Chat
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá um fluxo de instâncias de GenerateContentResponse
.
GenerateContentResponse
Resposta do modelo que oferece várias respostas candidatas.
As classificações de segurança e a filtragem de conteúdo são informadas para a instrução em GenerateContentResponse.prompt_feedback
e para cada candidato em finishReason
e safetyRatings
. A API: - Retorna todos os candidatos solicitados ou nenhum deles - Não retorna candidatos apenas se houver algo errado com a solicitação (confira promptFeedback
) - Informa o feedback sobre cada candidato em finishReason
e safetyRatings
.
candidates[]
object (Candidate
)
Respostas candidatas 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 do token das solicitações de geração.
Representação JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
Um conjunto de metadados de feedback que a solicitação especifica em GenerateContentRequest.content
.
blockReason
enum (BlockReason
)
Opcional. Se definido, o comando foi bloqueado e nenhum candidato é retornado. Reformule a solicitação.
safetyRatings[]
object (SafetyRating
)
Classificações de segurança da solicitação. Existe no máximo uma classificação por categoria.
Representação JSON |
---|
{ "blockReason": enum ( |
BlockReason
Especifica o motivo pelo qual a solicitação foi bloqueada.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
SAFETY |
O comando foi bloqueado por motivos de segurança. Inspecione safetyRatings para entender qual categoria de segurança bloqueou o conteúdo. |
OTHER |
O comando foi bloqueado por motivos desconhecidos. |
BLOCKLIST |
O comando foi bloqueado devido aos termos incluídos na lista de bloqueio de terminologia. |
PROHIBITED_CONTENT |
A solicitação foi bloqueada devido ao conteúdo proibido. |
UsageMetadata
Metadados sobre o uso do token da solicitação de geração.
promptTokenCount
integer
Número de tokens no comando. Quando cachedContent
é definido, ele ainda é o tamanho total do comando efetivo, o que significa que inclui o número de tokens no conteúdo armazenado em cache.
cachedContentTokenCount
integer
Número de tokens na parte armazenada em cache do comando (o conteúdo armazenado em cache)
candidatesTokenCount
integer
Número total de tokens em todos os candidatos de resposta gerados.
totalTokenCount
integer
Contagem total de tokens para a solicitação de geração (comando + candidatos de resposta).
Representação JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
Candidato
- Representação JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- Segmento
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidato
Um candidato a resposta gerado pelo modelo.
content
object (Content
)
Apenas saída. Conteúdo gerado retornado pelo 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 tokens.
safetyRatings[]
object (SafetyRating
)
Lista de classificações para a segurança de um candidato a resposta.
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 para qualquer texto incluído no content
. São passagens "recitadas" de material protegido por direitos autorais nos dados de treinamento do LLM básico.
tokenCount
integer
Apenas saída. Contagem de tokens para esse candidato.
groundingAttributions[]
object (GroundingAttribution
)
Apenas saída. Informações de atribuição das fontes que contribuíram para uma resposta fundamentada.
Esse campo é preenchido para chamadas GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
Apenas saída. Metadados de fundamentação para o candidato.
Esse campo é preenchido para chamadas GenerateContent
.
avgLogprobs
number
Apenas saída.
logprobsResult
object (LogprobsResult
)
Apenas saída. Pontuações de probabilidade logarítmica para os tokens de resposta e os principais tokens
index
integer
Apenas saída. Índice do candidato na lista de candidatos de resposta.
Representação JSON |
---|
{ "content": { object ( |
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 paradas fornecida. |
MAX_TOKENS |
O número máximo de tokens especificado na solicitação foi atingido. |
SAFETY |
O conteúdo do candidato a resposta foi sinalizado por motivos de segurança. |
RECITATION |
O conteúdo do candidato de resposta foi sinalizado por motivos de recitação. |
LANGUAGE |
O conteúdo do candidato à resposta foi sinalizado por usar um idioma sem suporte. |
OTHER |
Motivo desconhecido. |
BLOCKLIST |
A geração de tokens foi interrompida porque o conteúdo contém termos proibidos. |
PROHIBITED_CONTENT |
A geração de tokens foi interrompida por conter conteúdo proibido. |
SPII |
A geração de tokens foi interrompida porque o conteúdo pode conter informações sensíveis de identificação pessoal (SPII). |
MALFORMED_FUNCTION_CALL |
A chamada de função gerada pelo modelo é inválida. |
GroundingAttribution
Atribuição de uma fonte que contribuiu para uma resposta.
sourceId
object (AttributionSourceId
)
Apenas saída. Identificador da fonte que contribui para esta atribuição.
content
object (Content
)
Conteúdo de origem que compõe essa atribuição.
Representação JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
Identificador da origem que contribui para essa atribuição.
Campo de união source
.
source
pode ser apenas de um dos tipos a seguir:
groundingPassage
object (GroundingPassageId
)
Identificador de um trecho inline.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
Identificador de um Chunk
buscado pelo Semantic Retriever.
Representação JSON |
---|
{ // Union field |
GroundingPassageId
Identificador de uma parte em um GroundingPassage
.
passageId
string
Apenas saída. ID da passagem que corresponde ao GroundingPassage.id
do GenerateAnswerRequest
.
partIndex
integer
Apenas saída. Índice da parte no GroundingPassage.content
do GenerateAnswerRequest
.
Representação JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Identificador de um Chunk
recuperado pelo recuperador semântico especificado no GenerateAnswerRequest
usando SemanticRetrieverConfig
.
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
Representação JSON |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
Metadados retornados ao cliente quando a conexão à terra está ativada.
groundingChunks[]
object (GroundingChunk
)
Lista de referências de apoio extraídas da fonte de fundamentação especificada.
groundingSupports[]
object (GroundingSupport
)
Lista de suporte de aterramento.
webSearchQueries[]
string
Consultas de pesquisa na Web para a pesquisa seguinte.
searchEntryPoint
object (SearchEntryPoint
)
Opcional. Entrada da Pesquisa Google para as pesquisas na Web seguintes.
retrievalMetadata
object (RetrievalMetadata
)
Metadados relacionados à recuperação no fluxo de embasamento.
Representação JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Ponto de entrada da Pesquisa Google.
renderedContent
string
Opcional. Snippet de conteúdo da Web que pode ser incorporado a uma página da Web ou a uma WebView de app.
sdkBlob
string (bytes format)
Opcional. JSON codificado em base64 que representa uma matriz de tupla <termo de pesquisa, URL de pesquisa>.
Uma string codificada em base64.
Representação JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Bloco de embasamento.
chunk_type
. Tipo de bloco. chunk_type
pode ser apenas de um dos tipos a seguir:
web
object (Web
)
Chunk de aterramento da Web.
Representação JSON |
---|
{ // Union field |
Web
Parte da Web.
uri
string
Referência do URI do bloco.
title
string
Título do bloco.
Representação JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
Suporte de embasamento.
groundingChunkIndices[]
integer
Uma lista de índices (em "grounding_chunk") que especifica as citações associadas à reivindicação. Por exemplo, [1,3,4] significa que grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] são o conteúdo recuperado atribuído à declaração.
confidenceScores[]
number
Pontuação de confiança das referências de suporte. Varia de 0 a 1. 1 é o mais confiante. Essa lista precisa ter o mesmo tamanho que o groundingChunkIndices.
segment
object (Segment
)
Segmento do conteúdo a que o suporte pertence.
Representação JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Segmento
Segmento do conteúdo.
partIndex
integer
Apenas saída. O índice de um objeto "Part" dentro do objeto pai "Content".
startIndex
integer
Apenas saída. Comece o índice na parte especificada, medido em bytes. Deslocamento a partir do início da parte, inclusive, começando em zero.
endIndex
integer
Apenas saída. Índice final na parte especificada, medido em bytes. Deslocamento do início da parte, exclusivo, começando em zero.
text
string
Apenas saída. O texto correspondente ao segmento da resposta.
Representação JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
Metadados relacionados à recuperação no fluxo de embasamento.
googleSearchDynamicRetrievalScore
number
Opcional. Pontuação que indica como as informações prováveis da Pesquisa Google poderiam ajudar a responder à pergunta. A pontuação está no intervalo [0, 1], em que 0 é o menos provável e 1 é o mais provável. Essa pontuação só é preenchida quando a base e a recuperação dinâmica da Pesquisa Google estão ativadas. Ele será comparado com o limite para determinar se a Pesquisa Google será acionada.
Representação JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Resultado de Logprobs
topCandidates[]
object (TopCandidates
)
Comprimento = número total de etapas de decodificação.
chosenCandidates[]
object (Candidate
)
Comprimento = número total de etapas de decodificação. Os candidatos escolhidos podem ou não estar em topCandidates.
Representação JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
Candidatos com as maiores probabilidades de registro em cada etapa de decodificação.
candidates[]
object (Candidate
)
Classificados por probabilidade logarítmica em ordem decrescente.
Representação JSON |
---|
{
"candidates": [
{
object ( |
Candidato
Candidato para o token e a pontuação do logprobs.
token
string
O valor da string do token do candidato.
tokenId
integer
O valor do ID do token do candidato.
logProbability
number
A probabilidade de registro do candidato.
Representação JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
CitationMetadata
Uma coleção de atribuições de fonte para um conteúdo.
citationSources[]
object (CitationSource
)
Citações de fontes para uma resposta específica.
Representação JSON |
---|
{
"citationSources": [
{
object ( |
CitationSource
Uma citação de uma fonte para uma parte de uma resposta específica.
startIndex
integer
Opcional. Início do segmento da resposta atribuída a essa origem.
O índice indica o início do segmento, medido em bytes.
endIndex
integer
Opcional. Fim do segmento atribuído, exclusivo.
uri
string
Opcional. URI atribuído como uma origem para uma parte do texto.
license
string
Opcional. Licença do projeto do GitHub atribuído como origem do segmento.
As informações da licença são necessárias para citações de código.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
Opções de configuração para geração de modelos e saídas. Nem todos os parâmetros podem ser configurados para todos os modelos.
stopSequences[]
string
Opcional. O conjunto de sequências de caracteres (até 5) que vai interromper a geração de saída. Se especificado, a API vai parar na primeira aparição de um stop_sequence
. A sequência de parada não será incluída como parte da resposta.
responseMimeType
string
Opcional. Tipo MIME do texto candidato gerado. Os tipos MIME com suporte são: text/plain
(padrão): saída de texto. application/json
: resposta JSON nos candidatos de resposta. text/x.enum
: ENUM como uma resposta de string nos candidatos de resposta. Consulte os documentos para conferir uma lista de todos os tipos MIME de texto aceitos.
responseSchema
object (Schema
)
Opcional. Esquema de saída do texto candidato gerado. Os esquemas precisam ser um subconjunto do esquema OpenAPI e podem ser objetos, primitivos ou matrizes.
Se definido, um responseMimeType
compatível também precisa ser definido. Tipos MIME compatíveis: application/json
: esquema para a resposta JSON. Consulte o guia de geração de texto JSON para mais detalhes.
candidateCount
integer
Opcional. Número de respostas geradas a serem retornadas.
Atualmente, esse valor só pode ser definido como 1. Se não for definido, o padrão será 1.
maxOutputTokens
integer
Opcional. O número máximo de tokens a serem incluídos em uma resposta candidata.
Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.output_token_limit
do Model
retornado pela função getModel
.
temperature
number
Opcional. Controla a aleatoriedade da saída.
Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.temperature
do Model
retornado da função getModel
.
Os valores podem variar de [0,0 a 2,0].
topP
number
Opcional. A probabilidade cumulativa máxima de tokens a serem considerados na amostragem.
O modelo usa a amostragem top-k e top-p (núcleo) combinada.
Os tokens são classificados com base nas probabilidades atribuídas, de modo que apenas os tokens mais prováveis sejam considerados. A amostragem top-k limita diretamente o número máximo de tokens a serem considerados, enquanto a amostragem Nucleus limita o número de tokens com base na probabilidade cumulativa.
Observação: o valor padrão varia por Model
e é especificado pelo atributo Model.top_p
retornado da função getModel
. Um atributo topK
vazio indica que o modelo não aplica a amostragem top-k e não permite a configuração de topK
nas solicitações.
topK
integer
Opcional. O número máximo de tokens a considerar na amostragem.
Os modelos do Gemini usam a amostragem de Top-p (núcleo) ou uma combinação de amostragem de Top-k e núcleo. A amostragem Top-k considera o conjunto de tokens topK
mais prováveis. Os modelos executados com a amostragem de núcleo não permitem a configuração de topK.
Observação: o valor padrão varia de acordo com Model
e é especificado pelo atributo Model.top_p
retornado pela função getModel
. Um atributo topK
vazio indica que o modelo não aplica a amostragem top-k e não permite a configuração de topK
nas solicitações.
presencePenalty
number
Opcional. Penalidade de presença aplicada aos logprobs do próximo token se o token já tiver sido visto na resposta.
Essa penalidade é binária (ativada/desativada) e não depende do número de vezes que o token é usado (após o primeiro). Use frequencyPenalty
para uma penalidade que aumenta a cada uso.
Uma penalidade positiva desencoraja o uso de tokens que já foram usados na resposta, aumentando o vocabulário.
Uma penalidade negativa incentiva o uso de tokens que já foram usados na resposta, diminuindo o vocabulário.
frequencyPenalty
number
Opcional. Penalidade de frequência aplicada aos logprobs do próximo token, multiplicada pelo número de vezes que cada token foi visto na resposta até o momento.
Uma penalidade positiva vai desencorajar o uso de tokens que já foram usados, proporcional ao número de vezes que o token foi usado: quanto mais um token é usado, mais difícil é para o modelo usar esse token novamente, aumentando o vocabulário das respostas.
Cuidado: uma penalidade negativa incentiva o modelo a reutilizar tokens de forma proporcional ao número de vezes que o token foi usado. Valores negativos pequenos reduzem o vocabulário da resposta. Valores negativos maiores farão com que o modelo comece a repetir um token comum até atingir o limite de maxOutputTokens
: "...o o o o o...".
responseLogprobs
boolean
Opcional. Se verdadeiro, exporte os resultados de logprobs em resposta.
logprobs
integer
Opcional. Válido apenas se for responseLogprobs=True
. Isso define o número de logprobs principais a serem retornados em cada etapa de decodificação no Candidate.logprobs_result
.
Representação JSON |
---|
{
"stopSequences": [
string
],
"responseMimeType": string,
"responseSchema": {
object ( |
HarmCategory
A categoria de uma nota.
Essas categorias abrangem vários tipos de danos que os desenvolvedores podem querer ajustar.
Enums | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
A categoria não foi especificada. |
HARM_CATEGORY_DEROGATORY |
PaLM: comentários negativos ou nocivos voltados à identidade e/ou atributo protegido. |
HARM_CATEGORY_TOXICITY |
PaLM: conteúdo grosseiro, desrespeitoso ou obsceno. |
HARM_CATEGORY_VIOLENCE |
PaLM: descreve cenários que retratam violência contra um indivíduo ou grupo ou descrições gerais de sangue em excesso. |
HARM_CATEGORY_SEXUAL |
PaLM: contém referências a atos sexuais ou outro conteúdo obsceno. |
HARM_CATEGORY_MEDICAL |
PaLM: promove orientações médicas não verificadas. |
HARM_CATEGORY_DANGEROUS |
PaLM: conteúdo perigoso que promove, facilita ou incentiva atos nocivos. |
HARM_CATEGORY_HARASSMENT |
Gemini: conteúdo de assédio. |
HARM_CATEGORY_HATE_SPEECH |
Gemini: discurso e conteúdo de ódio. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini: conteúdo sexualmente explícito. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini: conteúdo perigoso. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini: conteúdo que pode ser usado para prejudicar a integridade cívica. |
SafetyRating
Classificação de segurança de um conteúdo.
A classificação de segurança contém a categoria de dano e o nível de probabilidade de dano nessa categoria para um conteúdo. O conteúdo é classificado para segurança em várias categorias de dano, e a probabilidade da classificação de dano é incluída aqui.
category
enum (HarmCategory
)
Obrigatório. A categoria desta classificação.
probability
enum (HarmProbability
)
Obrigatório. A probabilidade de danos desse conteúdo.
blocked
boolean
Esse conteúdo foi bloqueado por causa dessa classificação?
Representação JSON |
---|
{ "category": enum ( |
HarmProbability
A probabilidade de um conteúdo ser nocivo.
O sistema de classificação indica a probabilidade de o conteúdo não ser seguro. Isso não indica a gravidade do dano de 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 chance alta de não ser seguro. |
SafetySetting
Configuração de segurança, que afeta o comportamento de bloqueio de segurança.
Transmitir uma configuração de segurança para uma categoria altera a probabilidade permitida de que o conteúdo seja bloqueado.
category
enum (HarmCategory
)
Obrigatório. A categoria dessa configuração.
threshold
enum (HarmBlockThreshold
)
Obrigatório. Controla o limite de probabilidade em que o dano é bloqueado.
Representação JSON |
---|
{ "category": enum ( |
HarmBlockThreshold
Bloquear em uma probabilidade de dano especificada ou maior.
Enums | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
O limite não foi especificado. |
BLOCK_LOW_AND_ABOVE |
Conteúdo com NEGLIGIBLE será permitido. |
BLOCK_MEDIUM_AND_ABOVE |
Conteúdo com NEGLIGIBLE e LOW será permitido. |
BLOCK_ONLY_HIGH |
Conteúdo com NEGLIGIBLE, LOW e MEDIUM será permitido. |
BLOCK_NONE |
Todo o conteúdo será permitido. |
OFF |
Desative o filtro de segurança. |