A API Gemini é compatível com a geração de conteúdo com imagens, áudio, código, ferramentas e muito mais. Para detalhes sobre cada um desses recursos, leia e confira o exemplo de código focado em tarefas ou os guias abrangentes.
- Geração de texto
- Visão
- Áudio
- Embeddings
- 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 do modelo com base em uma entrada GenerateContentRequest
. Consulte o guia de geração de texto para informações detalhadas sobre o uso. As capacidades de entrada variam entre os modelos, incluindo os ajustados. Consulte o guia de modelos e o guia de ajuste para mais detalhes.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
Parâmetros de caminho
model
string
Obrigatório. O nome do Model
a ser usado para gerar a conclusão.
Formato: 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 o Model
pode usar para gerar a próxima resposta.
Uma Tool
é uma parte do 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 da ferramenta para qualquer Tool
especificado na solicitação. Consulte o guia de chamada de função para ver 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 no GenerateContentRequest.contents
e no 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 atender aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory
especificado em "safetySettings". Se não houver um 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, HARM_CATEGORY_HARASSMENT e HARM_CATEGORY_CIVIC_INTEGRITY 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 aos 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 em cache a ser usado como contexto para disponibilizar 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
Go
Concha
Vídeo
Python
Node.js
Go
Concha
Python
Go
Concha
Chat
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Cache
Python
Node.js
Go
Modelo ajustado
Python
Modo JSON
Python
Node.js
Go
Concha
Kotlin
Swift
Dart
Java
Execução de código
Python
Go
Kotlin
Java
Chamada de função
Python
Go
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 transmitida do modelo com base em uma entrada GenerateContentRequest
.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Parâmetros de caminho
model
string
Obrigatório. O nome do Model
a ser usado para gerar a conclusão.
Formato: 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 o Model
pode usar para gerar a próxima resposta.
Uma Tool
é uma parte do 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 da ferramenta para qualquer Tool
especificado na solicitação. Consulte o guia de chamada de função para ver 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 no GenerateContentRequest.contents
e no 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 atender aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory
especificado em "safetySettings". Se não houver um 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, HARM_CATEGORY_HARASSMENT e HARM_CATEGORY_CIVIC_INTEGRITY 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 aos 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 em cache a ser usado como contexto para disponibilizar 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
Go
Concha
Vídeo
Python
Node.js
Go
Concha
Python
Go
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 vai conter um fluxo de instâncias de GenerateContentResponse
.
GenerateContentResponse
Resposta do modelo que oferece suporte a várias respostas candidatas.
As classificações de segurança e a filtragem de conteúdo são informadas para os dois comandos 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 nenhum candidato apenas se houver algo errado com o comando (verifique promptFeedback
) - Informa o feedback sobre cada candidato em finishReason
e safetyRatings
.
candidates[]
object (Candidate
)
Respostas candidatas do modelo.
promptFeedback
object (PromptFeedback
)
Retorna o feedback da solicitação relacionado aos filtros de conteúdo.
usageMetadata
object (UsageMetadata
)
Apenas saída. Metadados sobre o uso de tokens das solicitações de geração.
modelVersion
string
Apenas saída. A versão do modelo usada para gerar a resposta.
responseId
string
Somente saída. O responseId é usado para identificar cada resposta.
Representação JSON |
---|
{ "candidates": [ { object ( |
PromptFeedback
Um conjunto dos metadados de feedback especificados pelo comando em GenerateContentRequest.content
.
blockReason
enum (BlockReason
)
Opcional. Se definido, o comando foi bloqueado e nenhum candidato foi retornado. Reformule o comando.
safetyRatings[]
object (SafetyRating
)
Classificações de segurança do comando. Há no máximo uma classificação por categoria.
Representação JSON |
---|
{ "blockReason": enum ( |
BlockReason
Especifica o motivo do bloqueio do comando.
Enums | |
---|---|
BLOCK_REASON_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
SAFETY |
O comando foi bloqueado por motivos de segurança. Analise safetyRatings para entender qual categoria de segurança fez o bloqueio. |
OTHER |
O comando foi bloqueado por motivos desconhecidos. |
BLOCKLIST |
A solicitação foi bloqueada devido aos termos incluídos na lista de bloqueio de terminologia. |
PROHIBITED_CONTENT |
A solicitação foi bloqueada devido a conteúdo proibido. |
IMAGE_SAFETY |
Candidatos bloqueados devido a conteúdo não seguro de geração de imagens. |
UsageMetadata
Metadados sobre o uso de tokens da solicitação de geração.
promptTokenCount
integer
Número de tokens no comando. Quando cachedContent
é definido, esse ainda é o tamanho total efetivo do comando, 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 em cache)
candidatesTokenCount
integer
Número total de tokens em todos os candidatos de resposta gerados.
toolUsePromptTokenCount
integer
Apenas saída. Número de tokens presentes nos comandos de uso da ferramenta.
thoughtsTokenCount
integer
Apenas saída. Número de tokens de ideias para modelos de pensamento.
totalTokenCount
integer
Contagem total de tokens para a solicitação de geração (comando + candidatos de resposta).
promptTokensDetails[]
object (ModalityTokenCount
)
Apenas saída. Lista de modalidades processadas na entrada da solicitação.
cacheTokensDetails[]
object (ModalityTokenCount
)
Apenas saída. Lista de modalidades do conteúdo em cache na entrada da solicitação.
candidatesTokensDetails[]
object (ModalityTokenCount
)
Apenas saída. Lista de modalidades retornadas na resposta.
toolUsePromptTokensDetails[]
object (ModalityTokenCount
)
Apenas saída. Lista de modalidades processadas para entradas de solicitação de uso de ferramentas.
Representação JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
Candidato
- Representação JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- Segmento
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidato
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Um candidato a resposta gerado pelo modelo.
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 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 para o candidato gerado pelo modelo.
Esse campo pode ser preenchido com informações de recitação para qualquer texto incluído no content
. São trechos "recitados" de material protegido por direitos autorais nos dados de treinamento do LLM de base.
tokenCount
integer
Apenas saída. Contagem de tokens para este candidato.
groundingAttributions[]
object (GroundingAttribution
)
Apenas saída. Informações de atribuição para fontes que contribuíram para uma resposta embasada.
Esse campo é preenchido para chamadas GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
Apenas saída. Metadados de embasamento para o candidato.
Esse campo é preenchido para chamadas GenerateContent
.
avgLogprobs
number
Apenas saída. Pontuação média de probabilidade de registro do candidato.
logprobsResult
object (LogprobsResult
)
Apenas saída. Pontuações de verossimilhança de registro para os tokens de resposta e os principais tokens
urlContextMetadata
object (UrlContextMetadata
)
Apenas saída. Metadados relacionados à ferramenta de recuperação de contexto de URL.
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 candidato à resposta foi sinalizado por motivos de recitação. |
LANGUAGE |
O conteúdo da resposta candidata foi sinalizado por usar um idioma não aceito. |
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. |
IMAGE_SAFETY |
A geração de tokens foi interrompida porque as imagens geradas contêm violações de segurança. |
UNEXPECTED_TOOL_CALL |
O modelo gerou uma chamada de ferramenta, mas nenhuma ferramenta foi ativada na solicitação. |
GroundingAttribution
Atribuição de uma fonte que contribuiu para uma resposta.
sourceId
object (AttributionSourceId
)
Apenas saída. Identificador da origem que contribui para essa atribuição.
content
object (Content
)
Conteúdo da fonte de embasamento que compõe essa atribuição.
Representação JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
Identificador da origem que contribui para essa atribuição.
source
Union type
source
pode ser apenas de um dos tipos a seguir:groundingPassage
object (GroundingPassageId
)
Identificador de uma passagem inline.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
Identificador de um Chunk
buscado pelo Semantic Retriever.
Representação JSON |
---|
{ // source "groundingPassage": { object ( |
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 Semantic Retriever 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 o embasamento está ativado.
groundingChunks[]
object (GroundingChunk
)
Lista de referências de apoio recuperadas da fonte de embasamento especificada.
groundingSupports[]
object (GroundingSupport
)
Lista de suporte de embasamento.
webSearchQueries[]
string
Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.
searchEntryPoint
object (SearchEntryPoint
)
Opcional. Entrada da Pesquisa Google para as pesquisas na Web de acompanhamento.
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 a matriz da tupla <termo de pesquisa, URL de pesquisa>.
Uma string codificada em base64.
Representação JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
Trecho de embasamento.
chunk_type
Union type
chunk_type
pode ser apenas de um dos tipos a seguir:web
object (Web
)
Trecho de embasamento da Web.
Representação JSON |
---|
{
// chunk_type
"web": {
object ( |
Web
Trecho da Web.
uri
string
Referência de URI do bloco.
title
string
Título da parte.
Representação JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
Suporte de embasamento.
groundingChunkIndices[]
integer
Uma lista de índices (em "grounding_chunk") que especificam as citações associadas à declaraçã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 "groundingChunkIndices".
segment
object (Segment
)
Segmento do conteúdo a que este 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" no objeto "Content" principal.
startIndex
integer
Apenas saída. Índice inicial na parte especificada, medido em bytes. Deslocamento do início da parte, inclusivo, 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 a probabilidade de as informações da Pesquisa Google ajudarem a responder ao comando. 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 o embasamento da Pesquisa Google e a recuperação dinâmica estão ativados. Ele será comparado ao 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 principais 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 ao token e à pontuação de 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 } |
UrlContextMetadata
Metadados relacionados à ferramenta de recuperação de contexto de URL.
urlMetadata[]
object (UrlMetadata
)
Lista de contexto de URL.
Representação JSON |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Contexto de uma única recuperação de URL.
retrievedUrl
string
URL recuperado pela ferramenta.
urlRetrievalStatus
enum (UrlRetrievalStatus
)
Status da recuperação do URL.
Representação JSON |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Status da recuperação do URL.
Enums | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
URL_RETRIEVAL_STATUS_SUCCESS |
A recuperação do URL foi concluída. |
URL_RETRIEVAL_STATUS_ERROR |
A recuperação do URL falhou devido a um erro. |
CitationMetadata
Uma coleção de atribuições de origem 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ído a esta fonte.
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 fonte de uma parte do texto.
license
string
Opcional. Licença do projeto do GitHub atribuído como uma fonte para o segmento.
As informações de licença são necessárias para citações de código.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- Representação JSON
- Modalidade
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
Opções de configuração para geração e saídas de modelos. 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 vão interromper a geração de saída. Se especificado, a API vai parar na primeira aparição de um stop_sequence
. Ela não será incluída como parte da resposta.
responseMimeType
string
Opcional. Tipo MIME do texto candidato gerado. Os tipos MIME compatíveis 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 ver uma lista de todos os tipos MIME de texto compatíveis.
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 resposta JSON. Consulte o guia de geração de texto JSON para mais detalhes.
responseJsonSchema
value (Value
format)
Opcional. Esquema de saída da resposta gerada. Essa é uma alternativa a responseSchema
que aceita esquema JSON.
Se definido, responseSchema
precisa ser omitido, mas responseMimeType
é obrigatório.
Embora o esquema JSON completo possa ser enviado, nem todos os recursos são compatíveis. Especificamente, apenas as seguintes propriedades são compatíveis:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(para strings e números)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(interpretado da mesma forma queanyOf
)properties
additionalProperties
required
A propriedade não padrão propertyOrdering
também pode ser definida.
As referências cíclicas são abertas até um certo ponto e, portanto, só podem ser usadas em propriedades não obrigatórias. (Propriedades anuláveis não são suficientes.) Se $ref
estiver definido em um subesquema, nenhuma outra propriedade, exceto aquelas que começam como $
, poderá ser definida.
responseModalities[]
enum (Modality
)
Opcional. As modalidades solicitadas da resposta. Representa o conjunto de modalidades que o modelo pode retornar e que devem ser esperadas na resposta. Essa é uma correspondência exata com as modalidades da resposta.
Um modelo pode ter várias combinações de modalidades compatíveis. Se as modalidades solicitadas não corresponderem a nenhuma das combinações compatíveis, um erro será retornado.
Uma lista vazia equivale a solicitar apenas texto.
candidateCount
integer
Opcional. Número de respostas geradas a serem retornadas. Se não for definido, o padrão será 1. Isso não funciona com modelos de geração anterior (família Gemini 1.0).
maxOutputTokens
integer
Opcional. O número máximo de tokens a serem incluídos em um candidato a resposta.
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 pela função getModel
.
Os valores podem variar de [0,0, 2,0].
topP
number
Opcional. A probabilidade cumulativa máxima de tokens a serem considerados ao fazer a amostragem.
O modelo usa amostragem combinada Top-k e Top-p (nucleus).
Os tokens são classificados com base nas probabilidades atribuídas para que apenas os mais prováveis sejam considerados. A amostragem Top-k limita diretamente o número máximo de tokens a serem considerados, enquanto a amostragem de núcleo limita o número de tokens com base na probabilidade cumulativa.
Observação: o valor padrão varia de acordo com o 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 definir topK
em solicitações.
topK
integer
Opcional. O número máximo de tokens a serem considerados ao fazer a amostragem.
Os modelos do Gemini usam a amostragem Top-p (de núcleo) ou uma combinação de Top-k e amostragem de núcleo. A amostragem Top-K considera o conjunto dos topK
tokens mais prováveis. Os modelos executados com amostragem de núcleo não permitem a configuração de topK.
Observação: o valor padrão varia de acordo com o 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 definir topK
em solicitações.
seed
integer
Opcional. Seed usada na decodificação. Se não for definido, a solicitação usará uma seed gerada aleatoriamente.
presencePenalty
number
Opcional. Penalidade de presença aplicada às logprobs do próximo token se ele 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 a primeira). 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 às probabilidades logarítmicas do próximo token, multiplicada pelo número de vezes que cada token foi visto na resposta até agora.
Uma penalidade positiva desencoraja o uso de tokens que já foram usados, proporcionalmente ao número de vezes que o token foi usado: quanto mais um token é usado, mais difícil é para o modelo usá-lo novamente, aumentando o vocabulário das respostas.
Atenção: uma penalidade negativa incentiva o modelo a reutilizar tokens proporcionalmente ao número de vezes que o token foi usado. Valores negativos pequenos reduzem o vocabulário de uma resposta. Valores negativos maiores fazem com que o modelo comece a repetir um token comum até atingir o limite de maxOutputTokens
.
responseLogprobs
boolean
Opcional. Se for verdadeiro, exporte os resultados de logprobs na resposta.
logprobs
integer
Opcional. Válido apenas se responseLogprobs=True
. Isso define o número de principais logprobs a serem retornados em cada etapa de decodificação no Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
Opcional. Ativa respostas cívicas aprimoradas. Ela pode não estar disponível para todos os modelos.
speechConfig
object (SpeechConfig
)
Opcional. A configuração de geração de fala.
thinkingConfig
object (ThinkingConfig
)
Opcional. Configuração para recursos de pensamento. Um erro será retornado se esse campo for definido para modelos que não oferecem suporte ao pensamento.
mediaResolution
enum (MediaResolution
)
Opcional. Se especificado, a resolução de mídia especificada será usada.
Representação JSON |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Modalidade
Modalidades compatíveis da resposta.
Enums | |
---|---|
MODALITY_UNSPECIFIED |
Valor padrão. |
TEXT |
Indica que o modelo precisa retornar texto. |
IMAGE |
Indica que o modelo precisa retornar imagens. |
AUDIO |
Indica que o modelo precisa retornar áudio. |
SpeechConfig
A configuração de geração de fala.
voiceConfig
object (VoiceConfig
)
A configuração em caso de saída de voz única.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
Opcional. A configuração para a configuração de vários alto-falantes. É mutuamente exclusivo com o campo "voiceConfig".
languageCode
string
Opcional. Código do idioma (no formato BCP 47, por exemplo, "en-US") para síntese de voz.
Os valores válidos são: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU e th-TH.
Representação JSON |
---|
{ "voiceConfig": { object ( |
VoiceConfig
A configuração da voz a ser usada.
voice_config
Union type
voice_config
pode ser apenas de um dos tipos a seguir:prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
A configuração da voz pré-criada a ser usada.
Representação JSON |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
A configuração do alto-falante pré-criado a ser usado.
voiceName
string
O nome da voz predefinida a ser usada.
Representação JSON |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
A configuração para a configuração de vários alto-falantes.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
Obrigatório. Todas as vozes de alto-falante ativadas.
Representação JSON |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
A configuração de um único alto-falante em uma configuração com vários alto-falantes.
speaker
string
Obrigatório. O nome do alto-falante a ser usado. Precisa ser igual ao do comando.
voiceConfig
object (VoiceConfig
)
Obrigatório. A configuração da voz a ser usada.
Representação JSON |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Configuração para recursos de pensamento.
includeThoughts
boolean
Indica se os pensamentos devem ser incluídos na resposta. Se for "true", as ideias serão retornadas apenas quando estiverem disponíveis.
thinkingBudget
integer
O número de tokens de ideias que o modelo deve gerar.
Representação JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
Resolução da mídia de entrada.
Enums | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
A resolução da mídia não foi definida. |
MEDIA_RESOLUTION_LOW |
Resolução de mídia definida como baixa (64 tokens). |
MEDIA_RESOLUTION_MEDIUM |
Resolução de mídia definida como média (256 tokens). |
MEDIA_RESOLUTION_HIGH |
Resolução de mídia definida como alta (reenquadramento com zoom e 256 tokens). |
HarmCategory
A categoria de uma classificação.
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 atributos protegidos. |
HARM_CATEGORY_TOXICITY |
PaLM: conteúdo grosseiro, desrespeitoso ou com linguagem obscena. |
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 de ódio e conteúdo. |
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. |
ModalityTokenCount
Representa informações de contagem de tokens para uma única modalidade.
modality
enum (Modality
)
A modalidade associada a essa contagem de tokens.
tokenCount
integer
Número de tokens.
Representação JSON |
---|
{
"modality": enum ( |
Modalidade
Modalidade de parte do conteúdo
Enums | |
---|---|
MODALITY_UNSPECIFIED |
Modalidade não especificada. |
TEXT |
Texto simples. |
IMAGE |
Imagem. |
VIDEO |
Vídeo. |
AUDIO |
Áudio. |
DOCUMENT |
Documento, por exemplo, PDF. |
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 danos, e a probabilidade da classificação de dano está incluída aqui.
category
enum (HarmCategory
)
Obrigatório. A categoria desta classificação.
probability
enum (HarmProbability
)
Obrigatório. A probabilidade de danos para esse conteúdo.
blocked
boolean
O 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 informa a probabilidade de o conteúdo não ser seguro. Isso não indica a gravidade do dano para 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 baixa probabilidade de não ser seguro. |
MEDIUM |
O conteúdo tem uma chance média de não ser seguro. |
HIGH |
O conteúdo tem alta probabilidade de não ser seguro. |
SafetySetting
Configuração de segurança que afeta o comportamento de bloqueio de segurança.
Ao transmitir uma configuração de segurança para uma categoria, a probabilidade permitida de bloqueio do conteúdo muda.
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 e além de uma probabilidade de dano especificada.
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 níveis NEGLIGIBLE, LOW e MEDIUM será permitido. |
BLOCK_NONE |
Todo o conteúdo será permitido. |
OFF |
Desative o filtro de segurança. |