A API Gemini é compatível com a geração de conteúdo com imagens, áudio, código, ferramentas e muito mais. Para saber mais sobre cada um desses recursos, continue lendo e confira o exemplo de código focado em tarefas ou leia os guias completos.
- 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 de modelo com base em uma entrada GenerateContentRequest. Consulte o guia de geração de texto para ver informações detalhadas de uso. Os recursos 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 Tools 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 de chamada de função para ver um exemplo de uso.
safetySettings[]
object (SafetySetting)
Opcional. Uma lista de instâncias exclusivas de SafetySetting 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 atenda 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, HARM_CATEGORY_CIVIC_INTEGRITY e HARM_CATEGORY_JAILBREAK são aceitas. Consulte o guia para mais informações 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.
continuationToken
string (bytes format)
Opcional. Um token de continuação opaco usado para retomar a geração de uma resposta anterior de models.generateContent ou models.streamGenerateContent que foi interrompida com finishReason definido como CONTINUATION. O contents é obrigatório e precisa replicar de forma idêntica o comando e o histórico de conversas da solicitação inicial quando o token de continuação é fornecido em uma solicitação.
Uma string codificada em base64.
labels
map (key: string, value: string)
Opcional. Rótulos com metadados definidos pelo usuário para a solicitação.
Opcional. Os rótulos precisam seguir os requisitos padrão unificados do Cloud: - As chaves de rótulo precisam começar com uma letra. - As chaves e os valores de rótulo não podem ter mais de 63 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. - Caracteres internacionais são permitidos.
Uso: identificadores de segurança de agregadores: use a chave safety_identifier (por exemplo, {"safety_identifier": "user_session_123"})
Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemInstruction
object (Content)
Opcional. O desenvolvedor define as 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 para usar como contexto para disponibilizar a previsão. Formato: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Opcional. O nível de serviço da solicitação.
store
boolean
Opcional. Configura o comportamento de geração de registros para uma determinada solicitação. Se definida, ela terá precedência sobre a configuração de geração de registros para envolvidos no projeto.
Exemplo de solicitação
Texto
Python
Node.js
Go
Shell
Java
Imagem
Python
Node.js
Go
Shell
Java
Áudio
Python
Node.js
Go
Shell
Vídeo
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
Java
Cache
Python
Node.js
Go
Modelo ajustado
Python
Modo JSON
Python
Node.js
Go
Shell
Java
Execução de código
Python
Go
Java
Chamadas de função
Python
Go
Node.js
Shell
Java
Configuração de geração
Python
Node.js
Go
Shell
Java
Configurações de segurança
Python
Node.js
Go
Shell
Java
Instrução do sistema
Python
Node.js
Go
Shell
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 de streaming 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 Tools 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 de chamada de função para ver um exemplo de uso.
safetySettings[]
object (SafetySetting)
Opcional. Uma lista de instâncias exclusivas de SafetySetting 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 atenda 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, HARM_CATEGORY_CIVIC_INTEGRITY e HARM_CATEGORY_JAILBREAK são aceitas. Consulte o guia para mais informações 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.
continuationToken
string (bytes format)
Opcional. Um token de continuação opaco usado para retomar a geração de uma resposta anterior de models.generateContent ou models.streamGenerateContent que foi interrompida com finishReason definido como CONTINUATION. O contents é obrigatório e precisa replicar de forma idêntica o comando e o histórico de conversas da solicitação inicial quando o token de continuação é fornecido em uma solicitação.
Uma string codificada em base64.
labels
map (key: string, value: string)
Opcional. Rótulos com metadados definidos pelo usuário para a solicitação.
Opcional. Os rótulos precisam seguir os requisitos padrão unificados do Cloud: - As chaves de rótulo precisam começar com uma letra. - As chaves e os valores de rótulo não podem ter mais de 63 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. - Caracteres internacionais são permitidos.
Uso: identificadores de segurança de agregadores: use a chave safety_identifier (por exemplo, {"safety_identifier": "user_session_123"})
Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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 para usar como contexto para disponibilizar a previsão. Formato: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
Opcional. O nível de serviço da solicitação.
store
boolean
Opcional. Configura o comportamento de geração de registros para uma determinada solicitação. Se definida, ela terá precedência sobre a configuração de geração de registros para envolvidos no projeto.
Exemplo de solicitação
Texto
Python
Node.js
Go
Shell
Java
Imagem
Python
Node.js
Go
Shell
Java
Áudio
Python
Go
Shell
Vídeo
Python
Node.js
Go
Shell
Python
Go
Shell
Chat
Python
Node.js
Go
Shell
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 aceita várias respostas candidatas.
As classificações de segurança e a filtragem de conteúdo são informadas para o comando em GenerateContentResponse.prompt_feedback e para cada candidato em finishReason e em 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 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 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. responseId é usado para identificar cada resposta.
modelStatus
object (ModelStatus)
Apenas saída. O status atual do modelo.
| Representação JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
Um conjunto de metadados de feedback especificados pelo comando em GenerateContentRequest.content.
blockReason
enum (BlockReason)
Opcional. Se definido, o comando foi bloqueado e nenhum candidato é 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 pelo qual o comando foi bloqueado.
| Tipos enumerados | |
|---|---|
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 o bloqueou. |
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 |
O comando foi bloqueado devido a conteúdo proibido. |
IMAGE_SAFETY |
Candidatos bloqueados devido a conteúdo não seguro na 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 ele inclui o número de tokens no conteúdo armazenado em cache.
cachedContentTokenCount
integer
Número de tokens na parte em cache do comando (o conteúdo em cache)
candidatesTokenCount
integer
Número total de tokens em todas as respostas candidatas geradas.
toolUsePromptTokenCount
integer
Apenas saída. Número de tokens presentes nos comandos de uso de ferramentas.
thoughtsTokenCount
integer
Apenas saída. Número de tokens de pensamentos para modelos de pensamento crítico.
totalTokenCount
integer
Contagem total de tokens para a solicitação de geração (comando + comando de uso de ferramenta + pensamentos + candidatos de resposta).
promptTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades que foram processadas na entrada da solicitação.
cacheTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades do conteúdo armazenado 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 que foram processadas para entradas de solicitação de uso de ferramentas.
serviceTier
enum (ServiceTier)
Apenas saída. Nível de serviço da solicitação.
| Representação JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
O status do modelo subjacente. Isso é usado para indicar o estágio do modelo subjacente e o tempo de desativação, se aplicável.
modelStage
enum (ModelStage)
O estágio do modelo subjacente.
retirementTime
string (Timestamp format)
O horário em que o modelo será desativado.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
message
string
Uma mensagem explicando o status do modelo.
| Representação JSON |
|---|
{
"modelStage": enum ( |
ModelStage
Define o estágio do modelo.
| Tipos enumerados | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
Estágio do modelo não especificado. |
UNSTABLE_EXPERIMENTAL |
O modelo subjacente está sujeito a muitos ajustes. |
EXPERIMENTAL |
Os modelos nesse estágio são apenas para fins experimentais. |
PREVIEW |
Os modelos nesse estágio são mais maduros do que os experimentais. |
STABLE |
Os modelos nesse estágio são considerados estáveis e prontos para uso em produção. |
LEGACY |
Se o modelo estiver nesse estágio, significa que ele será descontinuado em breve. Somente clientes atuais podem usar esse modelo. |
DEPRECATED |
Os modelos nesse estágio foram descontinuados. Não é possível usar esses modelos. |
RETIRED |
Os modelos nessa fase são desativados. Não é possível usar esses modelos. |
Candidato
- Representação JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- Imagem
- RetrievedContext
- CustomMetadata
- StringList
- Maps
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- Segmento
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- Candidato
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
Uma resposta candidata gerada 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 de 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 log-likelihood 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.
continuationToken
string (bytes format)
Um token de continuação opaco opcional retornado quando finishReason é CONTINUATION. Os clientes podem transmitir esse token em um GenerateContentRequest subsequente para continuar a geração.
Uma string codificada em base64.
index
integer
Apenas saída. Índice do candidato na lista de candidatos de resposta.
finishMessage
string
Opcional. Apenas saída. Detalha o motivo pelo qual o modelo parou de gerar tokens. Isso é preenchido apenas quando finishReason está definido.
| Representação JSON |
|---|
{ "content": { object ( |
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 paradas fornecida. |
MAX_TOKENS |
O número máximo de tokens especificado na solicitação foi atingido. |
SAFETY |
O conteúdo da resposta candidata foi sinalizado por motivos de segurança. |
RECITATION |
O conteúdo candidato da resposta foi sinalizado por motivos de recitação. |
LANGUAGE |
O conteúdo da resposta candidata foi sinalizado por usar um idioma sem suporte. |
OTHER |
Motivo desconhecido. |
BLOCKLIST |
A geração de tokens foi interrompida porque o conteúdo tem termos proibidos. |
PROHIBITED_CONTENT |
A geração de tokens foi interrompida por possivelmente 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. |
IMAGE_PROHIBITED_CONTENT |
A geração de imagens foi interrompida porque as imagens geradas têm outro conteúdo proibido. |
IMAGE_OTHER |
A geração de imagens foi interrompida devido a outro problema. |
NO_IMAGE |
O modelo deveria gerar uma imagem, mas nenhuma foi gerada. |
IMAGE_RECITATION |
A geração de imagens foi interrompida devido à recitação. |
UNEXPECTED_TOOL_CALL |
O modelo gerou uma chamada de ferramenta, mas nenhuma ferramenta foi ativada na solicitação. |
TOO_MANY_TOOL_CALLS |
O modelo chamou muitas ferramentas consecutivamente, então o sistema encerrou a execução. |
MISSING_THOUGHT_SIGNATURE |
A solicitação não tem pelo menos uma assinatura de pensamento. |
MALFORMED_RESPONSE |
Finalizado devido a uma resposta malformada. |
ESCALATION |
A solicitação foi filtrada por uma regra de encaminhamento. |
PUP_LIMITED_DISABLED |
Indica que a geração de tokens foi interrompida porque a conta de usuário está limitada ou desativada devido a violações da Política de Uso Proibido (PUP). |
CONTINUATION |
A geração de tokens foi interrompida porque a resposta atingiu o limite de tokens por solicitação, mas a geração ainda não foi concluída. A resposta do modelo pode ser continuada por uma solicitação subsequente usando o continuationToken retornado. O maxOutputTokens é cumulativo em saltos de continuação e precisa ser aumentado monotonicamente ou omitido. |
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
groundingPassage
object (GroundingPassageId)
Identificador de um trecho inline.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
Identificador de um Chunk buscado pelo Recuperador Semântico.
| Representação JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Identificador de uma parte em um GroundingPassage.
passageId
string
Apenas saída. ID do trecho 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 o embasamento está ativado.
groundingChunks[]
object (GroundingChunk)
Lista de referências de apoio recuperadas da fonte de embasamento especificada. Ao fazer streaming, isso contém apenas os fragmentos de embasamento que não foram incluídos nos metadados de embasamento das respostas anteriores.
groundingSupports[]
object (GroundingSupport)
Lista de suporte de embasamento.
webSearchQueries[]
string
Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.
imageSearchQueries[]
string
Consultas de pesquisa de imagens usadas para embasamento.
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.
googleMapsWidgetContextToken
string
Opcional. Nome do recurso do token de contexto do widget do Google Maps que pode ser usado com o widget PlacesContextElement para renderizar dados de contexto. Preenchido apenas se o embasamento com o Google Maps estiver ativado.
| 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
Um GroundingChunk representa um segmento de evidências que embasam a resposta do modelo. Pode ser um trecho da Web, um contexto recuperado de um arquivo ou informações do Google Maps.
chunk_type
Union type
web
object (Web)
Fragmento de embasamento da Web.
image
object (Image)
Opcional. Fragmento de embasamento da pesquisa de imagens.
retrievedContext
object (RetrievedContext)
Opcional. Fragmento de embasamento do contexto recuperado pela ferramenta de pesquisa de arquivos.
maps
object (Maps)
Opcional. Fragmento de embasamento do Google Maps.
| Representação JSON |
|---|
{ // chunk_type "web": { object ( |
Web
Trecho da Web.
uri
string
Apenas saída. Referência de URI do fragmento.
title
string
Apenas saída. Título do bloco.
| Representação JSON |
|---|
{ "uri": string, "title": string } |
Imagem
Fragmento da pesquisa de imagens.
sourceUri
string
O URI da página da Web para atribuição.
imageUri
string
O URL do recurso de imagem.
title
string
O título da página da Web de onde a imagem foi retirada.
domain
string
O domínio raiz da página da Web de onde a imagem é, por exemplo, "example.com".
| Representação JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
Bloco do contexto recuperado pela ferramenta de pesquisa de arquivos.
customMetadata[]
object (CustomMetadata)
Opcional. Metadados fornecidos pelo usuário sobre o contexto recuperado.
uri
string
Opcional. Referência de URI do documento de recuperação semântica.
title
string
Opcional. Título do documento.
text
string
Opcional. Texto do fragmento.
fileSearchStore
string
Opcional. Nome do FileSearchStore que contém o documento. Exemplo: fileSearchStores/123
pageNumber
integer
Opcional. Número da página do contexto recuperado, se aplicável.
mediaId
string
Opcional. O nome do recurso de blob de mídia para resultados de pesquisa de arquivos multimodais. Formato: fileSearchStores/{file_search_store_id}/media/{blobId}
| Representação JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
Metadados fornecidos pelo usuário sobre o GroundingFact.
key
string
A chave dos metadados.
value
Union type
stringValue
string
Opcional. O valor da string dos metadados.
stringListValue
object (StringList)
Opcional. Uma lista de valores de string para os metadados.
numericValue
number
Opcional. O valor numérico dos metadados. O intervalo esperado para esse valor depende do key específico usado.
| Representação JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
Uma lista de valores de string.
values[]
string
Os valores de string da lista.
| Representação JSON |
|---|
{ "values": [ string ] } |
Maps
Um trecho de embasamento do Google Maps. Um bloco do Maps corresponde a um único lugar.
uri
string
Referência de URI do lugar.
title
string
Título do lugar.
text
string
Descrição em texto da resposta do lugar.
placeId
string
O ID do lugar, no formato places/{placeId}. Um usuário pode usar esse ID para procurar o lugar.
placeAnswerSources
object (PlaceAnswerSources)
Fontes que fornecem respostas sobre os recursos de um determinado lugar no Google Maps.
| Representação JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
Conjunto de fontes que fornecem respostas sobre as características de um determinado lugar no Google Maps. Cada mensagem PlaceAnswerSources corresponde a um lugar específico no Google Maps. A ferramenta do Google Maps usou essas fontes para responder a perguntas sobre os recursos do lugar (por exemplo, "o Bar Foo tem Wi-Fi?" ou "o Foo Bar é acessível para pessoas em cadeira de rodas?"). No momento, só aceitamos snippets de avaliação como fontes.
reviewSnippets[]
object (ReviewSnippet)
Trechos de avaliações usados para gerar respostas sobre as características de um determinado lugar no Google Maps.
| Representação JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
Encapsula um snippet de uma avaliação de usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.
reviewId
string
O ID do snippet de avaliação.
googleMapsUri
string
Um link que corresponde à avaliação do usuário no Google Maps.
title
string
Título da avaliação.
| Representação JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
Suporte ao embasamento.
groundingChunkIndices[]
integer
Opcional. Uma lista de índices (em "grounding_chunk" em response.candidate.grounding_metadata) que especifica as citações associadas à declaração. Por exemplo, [1,3,4] significa que grounding_chunk[1], grounding_chunk[3] e grounding_chunk[4] são o conteúdo recuperado atribuído à declaração. Se a resposta for de streaming, os groundingChunkIndices se referem aos índices em todas as respostas. É responsabilidade do cliente acumular os fragmentos de embasamento de todas as respostas (mantendo a mesma ordem).
confidenceScores[]
number
Opcional. 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.
renderedParts[]
integer
Apenas saída. Índices no campo parts do conteúdo do candidato. Esses índices especificam quais partes renderizadas estão associadas a essa fonte de suporte.
segment
object (Segment)
Segmento do conteúdo ao qual esse suporte pertence.
| Representação JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
Segmento
Segmento do conteúdo.
partIndex
integer
O índice de um objeto Part no objeto Content pai.
startIndex
integer
Índice inicial na parte fornecida, medido em bytes. Deslocamento do início da parte, inclusive, começando em zero.
endIndex
integer
Índice final na parte especificada, medido em bytes. Deslocamento do início da parte, exclusivo, começando em zero.
text
string
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. Ela será comparada 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.
logProbabilitySum
number
Soma das probabilidades de registro de todos os tokens.
| Representação JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
Candidatos com as maiores probabilidades de registro em cada etapa de decodificação.
candidates[]
object (Candidate)
Classificada por probabilidade de registro em ordem decrescente.
| Representação JSON |
|---|
{
"candidates": [
{
object ( |
Candidato
Candidato para o token e a pontuação de logprobs.
token
string
O valor da string do token do candidato.
tokenId
integer
O valor do ID de 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 contextos de URL.
| Representação JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Contexto da recuperação de um único 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.
| Tipos enumerados | |
|---|---|
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 |
Falha na recuperação do URL devido a um erro. |
URL_RETRIEVAL_STATUS_PAYWALL |
Falha na recuperação do URL porque o conteúdo está protegido por um paywall. |
URL_RETRIEVAL_STATUS_UNSAFE |
A recuperação do URL falhou porque o conteúdo não é seguro. |
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 essa 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 fonte do segmento.
As informações da licença são obrigatórias para citações de código.
| Representação JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
HarmCategory
A categoria de uma classificação.
Essas categorias abrangem vários tipos de danos que os desenvolvedores podem querer ajustar.
| Tipos enumerados | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
A categoria não foi especificada. |
HARM_CATEGORY_DEROGATORY |
PaLM: comentários negativos ou nocivos voltados à identidade e/ou atributos protegidos. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
HARM_CATEGORY_TOXICITY |
PaLM: conteúdo grosseiro, desrespeitoso ou linguagem obscena. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
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. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
HARM_CATEGORY_SEXUAL |
PaLM: contém referências a atos sexuais ou outro conteúdo obsceno. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
HARM_CATEGORY_MEDICAL |
PaLM: promove orientações médicas não verificadas. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
HARM_CATEGORY_DANGEROUS |
PaLM: conteúdo perigoso que promove, facilita ou incentiva atos nocivos. DESCONTINUADO: categoria exclusiva do PaLM, não compatível com os modelos do Gemini. |
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 civil. DESCONTINUADO: use enableEnhancedCivicAnswers. |
HARM_CATEGORY_JAILBREAK |
Gemini: comandos que tentam burlar ou subverter as diretrizes de segurança do modelo (tentativas de jailbreak). |
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
| Tipos enumerados | |
|---|---|
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 danos é incluída aqui.
category
enum (HarmCategory)
Obrigatório. A categoria da classificação.
probability
enum (HarmProbability)
Obrigatório. A probabilidade de danos para esse conteúdo.
blocked
boolean
Este 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.
| Tipos enumerados | |
|---|---|
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 alta probabilidade 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 muda a probabilidade permitida de bloqueio do conteúdo.
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 a partir de uma probabilidade de dano especificada.
| Tipos enumerados | |
|---|---|
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 |
O conteúdo com NEGLIGIBLE, LOW e MEDIUM será permitido. |
BLOCK_NONE |
Todo o conteúdo será permitido. |
OFF |
Desative o filtro de segurança. |
ServiceTier
Nível de serviço da solicitação.
| Tipos enumerados | |
|---|---|
unspecified |
Nível de serviço padrão, que é o Standard. |
standard |
Nível de serviço padrão. |
flex |
Nível de serviço Flex. |
priority |
Nível de serviço prioritário. |
Conteúdo
- Representação JSON
- Parte
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- Agendamento
- FileData
- ExecutableCode
- Idioma
- CodeExecutionResult
- Resultado
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- Nível
- MediaProcessing
- AudioTranscription
- WordInfo
- SpeechMetadata
O tipo de dados estruturados de base que contém várias partes de uma mensagem.
Um Content inclui um campo role que designa o produtor do Content e um campo parts que contém dados de várias partes com o conteúdo da vez da mensagem.
parts[]
object (Part)
Parts ordenados que constituem uma única mensagem. As partes podem ter diferentes tipos MIME.
role
string
Opcional. O produtor do conteúdo. Precisa ser "user" ou "model".
Útil para definir conversas com vários turnos. Caso contrário, pode ser deixado em branco ou sem definição.
| Representação JSON |
|---|
{
"parts": [
{
object ( |
Parte
Um tipo de dados que contém mídia que faz parte de uma mensagem Content de várias partes.
Um Part consiste em dados que têm um tipo de dados associado. Um Part só pode conter um dos tipos aceitos em Part.data.
Um Part precisa ter um tipo MIME IANA fixo que identifique o tipo e o subtipo da mídia se o campo inlineData estiver preenchido com bytes brutos.
thought
boolean
Opcional. Indica se a parte é um pensamento do modelo.
thoughtSignature
string (bytes format)
Opcional. Uma assinatura opaca para o pensamento, para que ele possa ser reutilizado em solicitações subsequentes.
Uma string codificada em base64.
partMetadata
object (Struct format)
Metadados personalizados associados à parte. Os agentes que usam genai.Part como representação de conteúdo podem precisar acompanhar as informações adicionais. Por exemplo, pode ser o nome de um arquivo/fonte de onde a parte se origina ou uma maneira de multiplexar vários streams de partes.
mediaResolution
object (MediaResolution)
Opcional. Resolução da mídia de entrada.
mediaProcessing
enum (MediaProcessing)
Opcional. Como o modelo processa a mídia desta parte para compreensão. Só é relevante para partes de vídeo (inlineData ou fileData com MIME de vídeo). As partes que não são de vídeo ignoram esse campo.
audioTranscription
object (AudioTranscription)
Opcional. Transcrição de áudio (entrada ou saída). Isso só é definido quando a parte contém dados de áudio.
speechMetadata
object (SpeechMetadata)
Opcional. Metadados aplicados a partes do texto para personalizar como elas devem ser faladas ou sintetizadas, como especificar a identidade do locutor ou o estilo de fala.
data
Union type
text
string
Texto inline.
inlineData
object (Blob)
Bytes de mídia inline.
functionCall
object (FunctionCall)
Um FunctionCall previsto retornado do modelo que contém uma string que representa o FunctionDeclaration.name com os argumentos e os valores deles.
functionResponse
object (FunctionResponse)
A saída resultante de uma FunctionCall que contém uma string que representa o FunctionDeclaration.name e um objeto JSON estruturado com qualquer saída da função é usada como contexto para o modelo.
fileData
object (FileData)
Dados baseados em URI.
executableCode
object (ExecutableCode)
Código gerado pelo modelo que deve ser executado.
codeExecutionResult
object (CodeExecutionResult)
Resultado da execução do ExecutableCode.
toolCall
object (ToolCall)
Chamada de ferramenta do lado do servidor. Esse campo é preenchido quando o modelo prevê uma invocação de ferramenta que deve ser executada no servidor. O cliente precisa repetir essa mensagem para a API.
toolResponse
object (ToolResponse)
A saída de uma execução de ToolCall do lado do servidor. Esse campo é preenchido pelo cliente com os resultados da execução do ToolCall correspondente.
metadata
Union type
inline_data ou file_data estiver presente para configurar o pré-processamento de mídia estática por parte. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:videoMetadata
object (VideoMetadata)
Opcional. Metadados do vídeo. Os metadados só devem ser especificados enquanto os dados do vídeo estiverem apresentados em inlineData ou fileData.
| Representação JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
Blob
Bytes de mídia brutos.
O texto não deve ser enviado como bytes brutos. Use o campo "text".
mimeType
string
O tipo MIME padrão da IANA dos dados de origem. Exemplos de tipos aceitos: - Imagens: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif - Áudio: audio/*, video/audio/s16le, video/audio/wav - Vídeo: video/* - Texto: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp - Aplicativos: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf Para mais contexto, consulte Formatos de arquivo aceitos. //
data
string (bytes format)
Bytes brutos para formatos de mídia.
Uma string codificada em base64.
displayName
string
Opcional. Especifica o nome usado para se referir a esse blob no modelo (por exemplo, "my_blob.png"). Usado como o identificador de referência do blob quando verbalizationMode é definido como REFERENCE_ONLY.
| Representação JSON |
|---|
{ "mimeType": string, "data": string, "displayName": string } |
FunctionCall
Um FunctionCall previsto retornado do modelo que contém uma string que representa o FunctionDeclaration.name com os argumentos e os valores deles.
id
string
Opcional. Identificador exclusivo da chamada de função. Se preenchido, o cliente vai executar o functionCall e retornar a resposta com o id correspondente.
name
string
Obrigatório. O nome da função a ser chamada. Precisa ser az, AZ, 0-9 ou conter sublinhados e traços, com um tamanho máximo de 128.
args
object (Struct format)
Opcional. Os parâmetros e valores da função no formato de objeto JSON.
| Representação JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
A saída resultante de uma FunctionCall que contém uma string que representa o FunctionDeclaration.name e um objeto JSON estruturado com qualquer saída da função é usada como contexto para o modelo. Ela precisa conter o resultado de uma FunctionCall feita com base na previsão do modelo.
id
string
Opcional. O identificador da chamada de função a que essa resposta se refere. Preenchido pelo cliente para corresponder à chamada de função id correspondente.
name
string
Obrigatório. O nome da função a ser chamada. Precisa ser az, AZ, 0-9 ou conter sublinhados e traços, com um tamanho máximo de 128.
response
object (Struct format)
Obrigatório. A resposta da função no formato de objeto JSON. Os autores da chamada podem usar qualquer chave que se ajuste à sintaxe da função para retornar a saída, por exemplo, "output", "result" etc. Em particular, se a chamada de função não for executada, a resposta poderá ter uma chave "error" para retornar detalhes do erro ao modelo.
É possível incluir multimídia usando um subobjeto que contém uma única chave "$ref" com o valor inlineData.display_name de um FunctionResponsePart que contém a multimídia. Consulte https://ai.google.dev/gemini-api/docs/function-calling#multimodal.
parts[]
object (FunctionResponsePart)
Opcional. Parts ordenados que constituem uma resposta de função. As partes podem ter diferentes tipos MIME da IANA.
willContinue
boolean
Opcional. Sinaliza que a chamada de função continua e que mais respostas serão retornadas, transformando a chamada de função em um gerador. Só é aplicável a chamadas de função NON_BLOCKING. Caso contrário, é ignorado. Se for definido como falso, as respostas futuras não serão consideradas. É permitido retornar response vazio com willContinue=False para sinalizar que a chamada de função foi concluída. Isso ainda pode acionar a geração do modelo. Para evitar acionar a geração e concluir a chamada de função, defina também scheduling como SILENT.
scheduling
enum (Scheduling)
Opcional. Especifica como a resposta deve ser programada na conversa. Aplicável apenas a chamadas de função NON_BLOCKING. Caso contrário, será ignorado. O padrão é WHEN_IDLE.
| Representação JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
Um tipo de dados que contém mídia que faz parte de uma mensagem FunctionResponse.
Um FunctionResponsePart consiste em dados que têm um tipo de dados associado. Um FunctionResponsePart só pode conter um dos tipos aceitos em FunctionResponsePart.data.
Um FunctionResponsePart precisa ter um tipo MIME IANA fixo que identifique o tipo e o subtipo da mídia se o campo inlineData estiver preenchido com bytes brutos.
data
Union type
inlineData
object (FunctionResponseBlob)
Bytes de mídia inline.
| Representação JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
Bytes de mídia brutos para resposta de função.
O texto não deve ser enviado como bytes brutos. Use o campo "FunctionResponse.response".
mimeType
string
O tipo MIME padrão da IANA dos dados de origem. Exemplos: - image/png - image/jpeg Se um tipo MIME não compatível for fornecido, um erro será retornado. Para ver uma lista completa dos tipos compatíveis, consulte Formatos de arquivo compatíveis.
data
string (bytes format)
Bytes brutos para formatos de mídia.
Uma string codificada em base64.
| Representação JSON |
|---|
{ "mimeType": string, "data": string } |
Programação
Especifica como a resposta deve ser programada na conversa.
| Tipos enumerados | |
|---|---|
SCHEDULING_UNSPECIFIED |
Esse valor não é usado. |
SILENT |
Apenas adicione o resultado ao contexto da conversa, não interrompa nem acione a geração. |
WHEN_IDLE |
Adicione o resultado ao contexto da conversa e peça para gerar a saída sem interromper a geração em andamento. |
INTERRUPT |
Adicione o resultado ao contexto da conversa, interrompa a geração em andamento e peça para gerar a saída. |
FileData
Dados baseados em URI.
mimeType
string
Opcional. O tipo MIME padrão da IANA dos dados de origem.
fileUri
string
Obrigatório. URI.
displayName
string
Opcional. Especifica o nome usado para se referir a esse arquivo no modelo (por exemplo, "my_file.pdf"). Usado como o identificador de referência de arquivo quando verbalizationMode é definido como REFERENCE_ONLY.
| Representação JSON |
|---|
{ "mimeType": string, "fileUri": string, "displayName": string } |
ExecutableCode
Código gerado pelo modelo que deve ser executado e o resultado retornado ao modelo.
Gerado apenas ao usar a ferramenta CodeExecution, em que o código é executado automaticamente, e um CodeExecutionResult correspondente também é gerado.
id
string
Opcional. Identificador exclusivo da parte ExecutableCode. O servidor retorna o CodeExecutionResult com o id correspondente.
language
enum (Language)
Obrigatório. Linguagem de programação do code.
code
string
Obrigatório. O código a ser executado.
| Representação JSON |
|---|
{
"id": string,
"language": enum ( |
Idioma
Linguagens de programação compatíveis com o código gerado.
| Tipos enumerados | |
|---|---|
LANGUAGE_UNSPECIFIED |
Idioma não especificado. Este valor não deve ser usado. |
PYTHON |
Python >= 3.10, com numpy e simpy disponíveis. Python é a linguagem padrão. |
CodeExecutionResult
Resultado da execução do ExecutableCode.
Gerado apenas quando a ferramenta CodeExecution é usada.
id
string
Opcional. O identificador da parte ExecutableCode a que este resultado se refere. Preenchido apenas se o ExecutableCode correspondente tiver um ID.
outcome
enum (Outcome)
Obrigatório. Resultado da execução de código.
output
string
Opcional. Contém stdout quando a execução de código é bem-sucedida, stderr ou outra descrição, caso contrário.
| Representação JSON |
|---|
{
"id": string,
"outcome": enum ( |
Resultado
Enumeração de possíveis resultados da execução de código.
| Tipos enumerados | |
|---|---|
OUTCOME_UNSPECIFIED |
Status não especificado. Este valor não deve ser usado. |
OUTCOME_OK |
A execução de código foi concluída com sucesso. output contém o stdout, se houver. |
OUTCOME_FAILED |
Falha na execução do código. output contém stderr e stdout, se houver. |
OUTCOME_DEADLINE_EXCEEDED |
A execução de código levou muito tempo e foi cancelada. Pode haver ou não um output parcial. |
ToolCall
Um ToolCall previsto do lado do servidor retornado pelo modelo. Essa mensagem contém informações sobre uma ferramenta que o modelo quer invocar. O cliente NÃO deve executar esse ToolCall. Em vez disso, o cliente precisa transmitir esse ToolCall de volta à API em uma rodada subsequente em uma mensagem Content, junto com o ToolResponse correspondente.
id
string
Opcional. Identificador exclusivo da chamada de ferramenta. O servidor retorna a resposta da ferramenta com o id correspondente.
toolName
string
Opcional. O nome da ferramenta que foi chamada.
toolType
enum (ToolType)
Obrigatório. O tipo de ferramenta que foi chamada.
args
object (Struct format)
Opcional. Os argumentos da chamada de ferramenta. Exemplo: {"arg1" : "value1", "arg2" : "value2" , ...}
| Representação JSON |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
O tipo de ferramenta na chamada de função.
| Tipos enumerados | |
|---|---|
TOOL_TYPE_UNSPECIFIED |
Tipo de ferramenta não especificado. |
GOOGLE_SEARCH_WEB |
Ferramenta Pesquisa Google, mapeia para Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
Ferramenta de pesquisa de imagens, mapeia para Tool.google_search.search_types.image_search. |
URL_CONTEXT |
Ferramenta de contexto de URL, mapeia para Tool.url_context. |
GOOGLE_MAPS |
Ferramenta do Google Maps, mapeia para Tool.google_maps. |
FILE_SEARCH |
Ferramenta de pesquisa de arquivos, mapeada para Tool.file_search. |
ToolResponse
A saída de uma execução de ToolCall do lado do servidor. Essa mensagem contém os resultados de uma invocação de ferramenta iniciada por um ToolCall do modelo. O cliente precisa transmitir esse ToolResponse de volta para a API em uma rodada subsequente em uma mensagem Content, junto com o ToolCall correspondente.
id
string
Opcional. O identificador da chamada de ferramenta a que essa resposta se refere.
toolType
enum (ToolType)
Obrigatório. O tipo de ferramenta que foi chamada, correspondente ao toolType no ToolCall correspondente.
response
object (Struct format)
Opcional. A resposta da ferramenta.
| Representação JSON |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
Metadados que descrevem o conteúdo do vídeo de entrada. Defina isso em Part.video_metadata ou FunctionResponsePart.video_metadata quando inlineData ou fileData tiver um vídeo para configurar o pré-processamento de vídeo estático (como corte de tempo, frame rate, contagem máxima de frames ou camadas de conteúdo extraídas).
startOffset
string (Duration format)
Opcional. O deslocamento inicial do vídeo.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
endOffset
string (Duration format)
Opcional. O deslocamento final do vídeo.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
fps
number
Opcional. O frame rate do vídeo enviado ao modelo. Se não for especificado, o valor padrão será 1.0. O intervalo de QPS é (0,0, 24,0].
| Representação JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
Resolução de mídia para tokenização.
value
Union type
level
enum (Level)
A qualidade da tokenização usada para uma determinada mídia.
| Representação JSON |
|---|
{
// value
"level": enum ( |
Nível
O nível de resolução de mídia.
| Tipos enumerados | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
A resolução de mídia não foi definida. |
MEDIA_RESOLUTION_LOW |
A resolução de mídia foi definida como baixa. |
MEDIA_RESOLUTION_MEDIUM |
A resolução de mídia foi definida como média. |
MEDIA_RESOLUTION_HIGH |
A resolução de mídia foi definida como alta. |
MEDIA_RESOLUTION_ULTRA_HIGH |
A resolução de mídia foi definida como ultra-alta. |
MediaProcessing
Como o modelo processa a mídia de entrada para entender o conteúdo.
| Tipos enumerados | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
O padrão é o processamento específico do modelo. |
STATIC |
Extração de frames com taxa fixa. Todos os frames colocados em contexto. |
AGENTIC |
Navegação dinâmica orientada por modelo. Recomendado para a maioria dos casos de uso. |
AudioTranscription
A transcrição de uma parte do áudio. Para áudio com vários locutores, cada segmento de locutor é uma parte separada com a própria AudioTranscription que carrega o speakerLabel.
text
string
Obrigatório. O texto da transcrição desse segmento de áudio.
speakerLabel
string
Opcional. Um rótulo que identifica o locutor desse segmento de áudio (por exemplo, "spk_1", "spk_2"). Presente quando a diarização está definida.
words[]
object (WordInfo)
Opcional. Transcrições detalhadas no nível da palavra e detalhes de tempo. Presente quando wordTimestamp está definido.
| Representação JSON |
|---|
{
"text": string,
"speakerLabel": string,
"words": [
{
object ( |
WordInfo
Informações sobre uma única palavra reconhecida.
word
string
Obrigatório. Transcrição da palavra.
startOffset
string (Duration format)
Opcional. Deslocamento inicial no tempo da palavra em relação ao início do áudio.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
endOffset
string (Duration format)
Opcional. Deslocamento final no tempo da palavra em relação ao início do áudio.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
| Representação JSON |
|---|
{ "word": string, "startOffset": string, "endOffset": string } |
SpeechMetadata
Metadados de fala para partes de text.
speaker
string
Opcional. Nome opcional do locutor para síntese de vários locutores.
style
string
Opcional. Instrução de estilo opcional para a síntese de voz.
| Representação JSON |
|---|
{ "speaker": string, "style": string } |
Ambiente
Um ambiente de execução para um agente.
id
string
Obrigatório. Apenas saída. O ID do ambiente.
sources[]
object (Source)
Fontes a serem montadas no ambiente.
created
string
Apenas saída. O horário em que o ambiente foi criado no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).
updated
string
Apenas saída. A hora em que o ambiente foi atualizado pela última vez no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).
lastAccessed
string
Apenas saída. O horário em que o ambiente foi acessado pela última vez no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).
status
enum (Status)
Apenas saída. O status do contêiner do ambiente.
fileCount
string (int64 format)
Apenas saída. O número de arquivos no ambiente, somente saída.
sizeBytes
string (int64 format)
Apenas saída. O tamanho total dos arquivos do ambiente em bytes, somente saída.
network
Union type
networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
Permitir apenas domínios específicos.
networkMode
enum (NetworkMode)
Modo de saída de rede.
| Representação JSON |
|---|
{ "id": string, "sources": [ { object ( |
Status
Status do ambiente.
| Tipos enumerados | |
|---|---|
STATUS_UNSPECIFIED |
|
ACTIVE |
|
EXPIRED |
|
NetworkMode
Modo de saída de rede para configurações que não estão na lista de permissões.
| Tipos enumerados | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
Valor padrão. Não utilizado. |
DISABLED |
Toda a saída de rede é bloqueada. |
Esquema
O objeto Schema permite a definição de tipos de dados de entrada e saída. Esses tipos podem ser objetos, mas também primitivos e matrizes. Representa um subconjunto selecionado de um objeto de esquema da OpenAPI 3.0.
type
enum (Type)
Obrigatório. Tipo de dados.
format
string
Opcional. O formato dos dados. Qualquer valor é permitido, mas a maioria não aciona nenhuma funcionalidade especial.
title
string
Opcional. O título do esquema.
description
string
Opcional. Uma breve descrição do parâmetro. Isso pode conter exemplos de uso. A descrição do parâmetro pode ser formatada como Markdown.
nullable
boolean
Opcional. Indica se o valor pode ser nulo.
enum[]
string
Opcional. Valores possíveis do elemento de Type.STRING com formato de tipo enumerado. Por exemplo, podemos definir uma direção de tipo enumerado como : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
Opcional. Número máximo de elementos para Type.ARRAY.
minItems
string (int64 format)
Opcional. Número mínimo de elementos para Type.ARRAY.
properties
map (key: string, value: object (Schema))
Opcional. Propriedades de Type.OBJECT.
Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]
string
Opcional. Propriedades obrigatórias de Type.OBJECT.
minProperties
string (int64 format)
Opcional. Número mínimo de propriedades para Type.OBJECT.
maxProperties
string (int64 format)
Opcional. Número máximo de propriedades para Type.OBJECT.
minLength
string (int64 format)
Opcional. CAMPOS DE ESQUEMA PARA O TIPO STRING Comprimento mínimo do Type.STRING
maxLength
string (int64 format)
Opcional. Comprimento máximo do Type.STRING
pattern
string
Opcional. Padrão do Type.STRING para restringir uma string a uma expressão regular.
example
value (Value format)
Opcional. Exemplo do objeto. Será preenchido apenas quando o objeto for a raiz.
anyOf[]
object (Schema)
Opcional. O valor precisa ser validado em relação a qualquer um (ou mais) dos subesquemas na lista.
propertyOrdering[]
string
Opcional. A ordem das propriedades. Não é um campo padrão na especificação da API aberta. Usado para determinar a ordem das propriedades na resposta.
default
value (Value format)
Opcional. Valor padrão do campo. De acordo com o esquema JSON, esse campo é destinado a geradores de documentação e não afeta a validação. Por isso, ele é incluído aqui e ignorado para que os desenvolvedores que enviam esquemas com um campo default não recebam erros de campo desconhecido.
items
object (Schema)
Opcional. Esquema dos elementos de Type.ARRAY.
minimum
number
Opcional. CAMPOS DE ESQUEMA PARA OS TIPOS INTEGER e NUMBER Valor mínimo de Type.INTEGER e Type.NUMBER
maximum
number
Opcional. Valor máximo de Type.INTEGER e Type.NUMBER
| Representação JSON |
|---|
{ "type": enum ( |
Tipo
O tipo contém a lista de tipos de dados da OpenAPI, conforme definido por https://spec.openapis.org/oas/v3.0.3#data-types
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Não especificado, não deve ser usado. |
STRING |
Tipo string. |
NUMBER |
Tipo de número. |
INTEGER |
Tipo inteiro. |
BOOLEAN |
Tipo booleano. |
ARRAY |
Tipo de matriz. |
OBJECT |
Tipo de objeto. |
NULL |
Tipo nulo. |
Ferramenta
- Representação JSON
- FunctionDeclaration
- Comportamento
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Moda
- CodeExecution
- GoogleSearch
- Interval
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- Ambiente
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
Detalhes da ferramenta que o modelo pode usar para gerar uma 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 modelo.
functionDeclarations[]
object (FunctionDeclaration)
Opcional. Uma lista de FunctionDeclarations disponíveis para o modelo que podem ser usados para chamada de função.
O modelo ou sistema não executa a função. Em vez disso, a função definida pode ser retornada como um FunctionCall com argumentos para o lado do cliente para execução. O modelo pode decidir chamar um subconjunto dessas funções preenchendo FunctionCall na resposta. A próxima conversa pode conter um FunctionResponse com o contexto de geração de "função" Content.role para a próxima vez que o modelo for usado.
googleSearchRetrieval
object (GoogleSearchRetrieval)
Opcional. Ferramenta de recuperação com tecnologia da Pesquisa Google.
codeExecution
object (CodeExecution)
Opcional. Permite que o modelo execute código como parte da geração.
googleSearch
object (GoogleSearch)
Opcional. Tipo de ferramenta GoogleSearch. Ferramenta para oferecer suporte à Pesquisa Google no modelo. Com tecnologia do Google.
computerUse
object (ComputerUse)
Opcional. Ferramenta para que o modelo interaja diretamente com o computador. Se ativado, ele preenche automaticamente as declarações de função específicas para o uso do computador.
urlContext
object (UrlContext)
Opcional. Ferramenta para recuperar o contexto de URL.
fileSearch
object (FileSearch)
Opcional. Tipo de ferramenta FileSearch. Ferramenta para recuperar conhecimento de corpora de recuperação semântica.
mcpServers[]
object (McpServer)
Opcional. Servidores MCP para conexão.
googleMaps
object (GoogleMaps)
Opcional. Ferramenta que permite embasar a resposta do modelo com contexto geoespacial relacionado à consulta do usuário.
| Representação JSON |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
Representação estruturada de uma declaração de função, conforme definido pela especificação OpenAPI 3.03. Nessa declaração, estão incluídos o nome e os parâmetros da função. Essa FunctionDeclaration é uma representação de um bloco de código que pode ser usado como um Tool pelo modelo e executado pelo cliente.
name
string
Obrigatório. O nome da função. Precisa ser az, AZ, 0-9 ou conter sublinhados, dois-pontos, pontos e traços, com um tamanho máximo de 128.
description
string
Obrigatório. Uma breve descrição da função.
behavior
enum (Behavior)
Opcional. Especifica o comportamento da função. No momento, só há suporte para o método BidiGenerateContent.
parameters
object (Schema)
Opcional. Descreve os parâmetros dessa função. Reflete a chave de string do objeto de parâmetro da Open API 3.03: o nome do parâmetro. Os nomes de parâmetros diferenciam maiúsculas de minúsculas. Valor do esquema: o esquema que define o tipo usado para o parâmetro.
parametersJsonSchema
value (Value format)
Opcional. Descreve os parâmetros da função no formato de esquema JSON. O esquema precisa descrever um objeto em que as propriedades são os parâmetros da função. Exemplo:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Esse campo é mutuamente exclusivo com parameters.
response
object (Schema)
Opcional. Descreve a saída dessa função no formato de esquema JSON. Reflete o objeto de resposta da Open API 3.03. O esquema define o tipo usado para o valor de resposta da função.
responseJsonSchema
value (Value format)
Opcional. Descreve a saída dessa função no formato de esquema JSON. O valor especificado pelo esquema é o valor de resposta da função.
Esse campo é mutuamente exclusivo com response.
Comportamento
Define o comportamento da função. O valor padrão é BLOCKING.
| Tipos enumerados | |
|---|---|
UNSPECIFIED |
Esse valor não é usado. |
BLOCKING |
Se definido, o sistema vai esperar receber a resposta da função antes de continuar a conversa. |
NON_BLOCKING |
Se definido, o sistema não vai esperar para receber a resposta da função. Em vez disso, ele vai tentar processar as respostas de função conforme elas forem disponibilizadas, mantendo a conversa entre o usuário e o modelo. |
GoogleSearchRetrieval
Ferramenta para recuperar dados públicos da Web para embasamento, com tecnologia do Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
Especifica a configuração de recuperação dinâmica para a fonte fornecida.
| Representação JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Descreve as opções para personalizar a recuperação dinâmica.
mode
enum (Mode)
O modo do preditor a ser usado na recuperação dinâmica.
dynamicThreshold
number
O limite a ser usado na recuperação dinâmica. Se não for definido, um valor padrão do sistema será usado.
| Representação JSON |
|---|
{
"mode": enum ( |
Modo
O modo do preditor a ser usado na recuperação dinâmica.
| Tipos enumerados | |
|---|---|
MODE_UNSPECIFIED |
Sempre acionar a recuperação. |
MODE_DYNAMIC |
Executar a recuperação somente quando o sistema decidir que é necessário. |
CodeExecution
Esse tipo não tem campos.
Ferramenta que executa o código gerado pelo modelo e retorna automaticamente o resultado para o modelo.
Consulte também ExecutableCode e CodeExecutionResult, que são gerados apenas ao usar essa ferramenta.
GoogleSearch
Tipo de ferramenta GoogleSearch. Ferramenta para oferecer suporte à Pesquisa Google no modelo. Com tecnologia do Google.
timeRangeFilter
object (Interval)
Opcional. Filtrar os resultados da pesquisa para um período específico. Se os clientes definirem um horário de início, eles também precisarão definir um horário de término (e vice-versa).
searchTypes
object (SearchTypes)
Opcional. O conjunto de tipos de pesquisa a serem ativados. Se não for definida, a pesquisa na web será ativada por padrão.
| Representação JSON |
|---|
{ "timeRangeFilter": { object ( |
Intervalo
Representa um intervalo de tempo, codificado como um início de carimbo de data/hora (incluído) e um fim de carimbo de data/hora (não incluído).
O início precisa ser menor ou igual ao fim. Quando o início é igual ao fim, o intervalo fica vazio (não corresponde a nenhum horário). Quando o início e o fim não são especificados, o intervalo corresponde a qualquer momento.
startTime
string (Timestamp format)
Opcional. Início inclusivo do intervalo.
Se especificado, um carimbo de data/hora correspondente a esse intervalo precisará ser igual ou posterior ao início.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime
string (Timestamp format)
Opcional. Fim exclusivo do intervalo.
Se especificado, um carimbo de data/hora correspondente a esse intervalo precisará ser anterior ao fim.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
| Representação JSON |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
Diferentes tipos de pesquisa que podem ser ativados na ferramenta GoogleSearch.
webSearch
object (WebSearch)
Opcional. Ativa a pesquisa na Web. Somente resultados de texto são retornados.
imageSearch
object (ImageSearch)
Opcional. Ativa a pesquisa por imagens. Os bytes de imagem são retornados.
| Representação JSON |
|---|
{ "webSearch": { object ( |
WebSearch
Esse tipo não tem campos.
Pesquisa Google na Web para embasamento e configurações relacionadas.
ImageSearch
Esse tipo não tem campos.
Pesquisa de imagens para embasamento e configurações relacionadas.
ComputerUse
Tipo de ferramenta de uso do computador.
environment
enum (Environment)
Obrigatório. O ambiente que está sendo operado.
excludedPredefinedFunctions[]
string
Opcional. Por padrão, as funções predefinidas são incluídas na chamada final do modelo. Alguns deles podem ser explicitamente excluídos da inclusão automática. Isso tem duas finalidades: 1. Usar um espaço de ação mais restrito / diferente. 2. Melhoria das definições / instruções de funções predefinidas.
enablePromptInjectionDetection
boolean
Opcional. Define se a verificação de detecção de injeção de comandos deve ser ativada na solicitação de uso do computador.
disabledSafetyPolicies[]
enum (SafetyPolicy)
Opcional. Políticas de segurança desativadas para o uso do computador.
| Representação JSON |
|---|
{ "environment": enum ( |
Ambiente
Representa o ambiente em operação, como um navegador da Web.
| Tipos enumerados | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
O padrão é browser. |
ENVIRONMENT_BROWSER |
Funciona em um navegador da Web. |
ENVIRONMENT_MOBILE |
Opera em um ambiente móvel. |
ENVIRONMENT_DESKTOP |
Opera em um ambiente de computador. |
SafetyPolicy
Políticas de segurança predefinidas para o uso de computadores.
| Tipos enumerados | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
Política de segurança não especificada. |
FINANCIAL_TRANSACTIONS |
Política de segurança para transações financeiras. |
SENSITIVE_DATA_MODIFICATION |
Política de segurança para modificação de dados sensíveis. |
COMMUNICATION_TOOL |
Política de segurança para ferramentas de comunicação (por exemplo, Gmail, Chat, Meet). |
ACCOUNT_CREATION |
Política de segurança para criação de contas. |
DATA_MODIFICATION |
Política de segurança para modificação de dados. |
USER_CONSENT_MANAGEMENT |
Política de segurança para gerenciamento de consentimento do usuário. |
LEGAL_TERMS_AND_AGREEMENTS |
Política de segurança para termos e contratos legais. |
UrlContext
Esse tipo não tem campos.
Ferramenta para recuperar o contexto de URL.
FileSearch
A ferramenta FileSearch, que recupera conhecimento de corpora de recuperação semântica. Os arquivos são importados para os corpora de recuperação semântica usando a API ImportFile.
fileSearchStoreNames[]
string
Obrigatório. Os nomes dos fileSearchStores de onde recuperar. Exemplo: fileSearchStores/my-file-search-store-123
metadataFilter
string
Opcional. Filtro de metadados a ser aplicado aos documentos e blocos de recuperação semântica.
topK
integer
Opcional. O número de blocos de recuperação semântica a serem recuperados.
| Representação JSON |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
Um MCPServer é um servidor que pode ser chamado pelo modelo para realizar ações. É um servidor que implementa o protocolo MCP.
name
string
O nome do MCPServer.
transport
Union type
streamableHttpTransport
object (StreamableHttpTransport)
Um transporte que pode transmitir solicitações e respostas HTTP.
| Representação JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
Um transporte que pode transmitir solicitações e respostas HTTP.
url
string
O URL completo do endpoint do MCPServer. Exemplo: "https://api.example.com/mcp"
headers
map (key: string, value: string)
Opcional: campos para cabeçalhos de autenticação, tempos limite etc., se necessário.
Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
timeout
string (Duration format)
Tempo limite de HTTP para operações normais.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
sseReadTimeout
string (Duration format)
Tempo limite para operações de leitura de SSE.
Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
terminateOnClose
boolean
Se a sessão do cliente deve ser encerrada quando o transporte for fechado.
| Representação JSON |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
A ferramenta do Google Maps que fornece contexto geoespacial para a consulta do usuário.
enableWidget
boolean
Opcional. Se um token de contexto de widget deve ser retornado no GroundingMetadata da resposta. Os desenvolvedores podem usar o token de contexto do widget para renderizar um widget do Google Maps com contexto geoespacial relacionado aos lugares que o modelo menciona na resposta.
| Representação JSON |
|---|
{ "enableWidget": boolean } |
Recurso REST: auth_tokens
- Recurso: AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- Modalidade
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
- ResponseFormatConfig
- TextResponseFormat
- MimeType
- AudioResponseFormat
- MimeType
- Entrega
- ImageResponseFormat
- MimeType
- Entrega
- AspectRatio
- ImageSize
- TranslationConfig
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- Moda
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- HistoryConfig
- Métodos
Recurso: AuthToken
Uma solicitação para criar um token de autenticação temporário.
name
string
Apenas saída. Identificador. O próprio token.
expireTime
string (Timestamp format)
Opcional. Somente entrada. Imutável. Um horário opcional após o qual, ao usar o token resultante, as mensagens nas sessões BidiGenerateContent serão rejeitadas. O Gemini pode encerrar a sessão de forma preventiva após esse período.
Se não for definido, o padrão será 30 minutos no futuro. Se definido, esse valor precisa ser inferior a 20 horas no futuro.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
Opcional. Somente entrada. Imutável. O horário após o qual as novas sessões da API Live que usam o token resultante dessa solicitação serão rejeitadas.
Se não for definido, o padrão será 60 segundos no futuro. Se definido, esse valor precisa ser inferior a 20 horas no futuro.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
Opcional. Somente entrada. Imutável. Se fieldMask estiver vazio e bidiGenerateContentSetup não estiver presente, a mensagem BidiGenerateContentSetup efetiva será extraída da conexão da API Live.
Se fieldMask estiver vazio e bidiGenerateContentSetup estiver presente, a mensagem BidiGenerateContentSetup efetiva será retirada inteiramente de bidiGenerateContentSetup nesta solicitação. A mensagem de configuração da conexão da API Live é ignorada.
Se fieldMask não estiver vazio, os campos correspondentes de bidiGenerateContentSetup vão substituir os campos da mensagem de configuração na conexão da API Live.
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Opcional. Somente entrada. Imutável. Configuração específica para BidiGenerateContent.
uses
integer
Opcional. Somente entrada. Imutável. O número de vezes que o token pode ser usado. Se esse valor for zero, nenhum limite será aplicado. Retomar uma sessão da API Live não conta como uso. Se não for especificado, o padrão será 1.
| Representação JSON |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
Mensagem a ser enviada no primeiro (e apenas no primeiro) BidiGenerateContentClientMessage. Contém a configuração que será aplicada durante a RPC de streaming.
Os clientes precisam esperar uma mensagem de BidiGenerateContentSetupComplete antes de enviar outras.
model
string
Obrigatório. O nome do recurso do modelo. Isso serve como um ID para o modelo usar.
Formato: models/{model}
generationConfig
object (GenerationConfig)
Opcional. Configuração de geração.
Os seguintes campos não são aceitos:
responseLogprobsresponseMimeTypelogprobsresponseSchemaresponseJsonSchemastop_sequenceskipResponseCacherouting_configaudio_timestamp
systemInstruction
object (Content)
Opcional. O usuário forneceu instruções do sistema para o modelo.
Observação: use apenas texto em partes, e o conteúdo de cada parte ficará em um parágrafo separado.
tools[]
object (Tool)
Opcional. Uma lista de Tools que o modelo 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 modelo.
realtimeInputConfig
object (RealtimeInputConfig)
Opcional. Configura o processamento de entradas em tempo real.
sessionResumption
object (SessionResumptionConfig)
Opcional. Configura o mecanismo de retomada de sessão.
Se incluído, o servidor vai enviar mensagens SessionResumptionUpdate.
contextWindowCompression
object (ContextWindowCompressionConfig)
Opcional. Configura um mecanismo de compactação de janela de contexto.
Se incluído, o servidor vai reduzir automaticamente o tamanho do contexto quando ele exceder o tamanho configurado.
inputAudioTranscription
object (AudioTranscriptionConfig)
Opcional. Se definida, ativa a transcrição da entrada de voz. A transcrição se alinha ao idioma do áudio de entrada, se configurado.
outputAudioTranscription
object (AudioTranscriptionConfig)
Opcional. Se definido, ativa a transcrição da saída de áudio do modelo. A transcrição se alinha ao código de idioma especificado para o áudio de saída, se configurado.
historyConfig
object (HistoryConfig)
Opcional. Configura a troca de histórico entre o cliente e o servidor.
labels
map (key: string, value: string)
Opcional. Rótulos com metadados definidos pelo usuário para a solicitação.
Opcional. Os rótulos precisam seguir os requisitos padrão unificados do Cloud: - As chaves de rótulo precisam começar com uma letra. - As chaves e os valores de rótulo não podem ter mais de 63 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. - Caracteres internacionais são permitidos.
Uso: identificadores de segurança de agregadores: use a chave safety_identifier (por exemplo, {"safety_identifier": "user_session_123"})
Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| Representação JSON |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
Opções de configuração para geração e saídas de modelos. Nem todos os parâmetros são configuráveis para todos os modelos.
stopSequences[]
string
Opcional. O conjunto de sequências de caracteres (até cinco) que interrompe 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 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 a documentação para ver uma lista de todos os tipos MIME de texto compatíveis.
responseSchema
(deprecated)
object (Schema)
Opcional. Esquema de saída do texto candidato gerado. Os esquemas precisam ser um subconjunto do esquema da 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.
Obsoleto. Use responseFormat.
_responseJsonSchema
(deprecated)
value (Value format)
Opcional. Esquema de saída da resposta gerada. Essa é uma alternativa a responseSchema que aceita o 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$anchortypeformattitledescriptionenum(para strings e números)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(interpretado da mesma forma queanyOf)propertiesadditionalPropertiesrequired
A propriedade não padrão propertyOrdering também pode ser definida.
As referências cíclicas são desenroladas até certo ponto e, por isso, 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 poderá ser definida, exceto aquelas que começam como $.
Obsoleto. Use responseFormat.
responseJsonSchema
value (Value format)
Opcional. Um detalhe interno. Use responseJsonSchema em vez deste campo.
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 aceitas, 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 para modelos de gerações anteriores (família Gemini 1.0).
maxOutputTokens
integer
Opcional. O número máximo de tokens a serem incluídos em um candidato de 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].
Esse campo não é mais aceito e é ignorado silenciosamente no Gemini 3.6 Flash e em modelos mais recentes.
topP
number
Opcional. A probabilidade cumulativa máxima de tokens a serem considerados na amostragem.
O modelo usa uma combinação de amostragem Top-K e Top-P (núcleo).
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 pela função getModel. Um atributo topK vazio indica que o modelo não aplica a amostragem top-k e não permite definir topK nas solicitações.
Esse campo não é mais aceito e é ignorado silenciosamente no Gemini 3.6 Flash e em modelos mais recentes.
topK
integer
Opcional. O número máximo de tokens a serem considerados na amostragem.
Os modelos do Gemini usam a amostragem Top-P (núcleo) ou uma combinação de amostragem Top-K e de núcleo. A amostragem top-k considera o conjunto de topK tokens mais prováveis. Os modelos que usam a amostragem de núcleo não permitem a configuração topK.
Observação: o valor padrão varia de acordo com o 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 definir topK nas solicitações.
Esse campo não é mais aceito e é ignorado silenciosamente no Gemini 3.6 Flash e em modelos mais recentes.
seed
integer
Opcional. Seed usada na decodificação. Se não for definida, a solicitação vai usar uma semente gerada aleatoriamente.
presencePenalty
number
Opcional. Penalidade de presença aplicada aos 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 vai desencorajar 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, 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 de respostas.
Atenção: uma penalidade negativa vai incentivar 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 farão com que o modelo comece a repetir um token comum até atingir o limite de maxOutputTokens.
responseLogprobs
boolean
Opcional. Se verdadeiro, exporta os resultados de logprobs na resposta.
logprobs
integer
Opcional. Válido apenas se responseLogprobs=True. Define o número de logprobs principais, incluindo o candidato escolhido, que serão retornados em cada etapa de decodificação no Candidate.logprobs_result. O número precisa estar no intervalo de [0, 20].
enableEnhancedCivicAnswers
boolean
Opcional. Ativa respostas cívicas aprimoradas. Talvez ele não esteja 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.
imageConfig
object (ImageConfig)
Opcional. Configuração para geração de imagens. Um erro será retornado se esse campo for definido para modelos que não são compatíveis com essas opções de configuração.
mediaResolution
enum (MediaResolution)
Opcional. Se especificada, a resolução de mídia especificada será usada.
enableAffectiveDialog
boolean
Opcional. Se ativado, o modelo vai detectar emoções e adaptar as respostas de acordo.
responseFormat
object (ResponseFormatConfig)
Opcional. Configuração para o formato de saída da resposta. Permite especificar a configuração de saída por modalidade (texto, áudio, imagem) em uma estrutura simples.
translationConfig
object (TranslationConfig)
Opcional. Configuração para tradução.
audioTranscriptionConfig
object (AudioTranscriptionConfig)
Opcional. Configuração para transcrição de áudio (reconhecimento de fala).
| Representação JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
Modalidade
Modalidades compatíveis da resposta.
| Tipos enumerados | |
|---|---|
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
Configuração para geração e transcriçã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 vários locutores. Ele é mutuamente exclusivo com o campo voiceConfig.
languageCode
string
Opcional. O código de idioma IETF BCP-47 que o usuário configurou para o app. Usado para reconhecimento e síntese de fala.
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
prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
A configuração da voz predefinida a ser usada.
voice
string
Opcional. O identificador do locutor para síntese. Formatos compatíveis:
- Nome do locutor para vozes predefinidas (por exemplo,
OrusouKore). - ID de voz para vozes armazenadas (por exemplo,
voice_xxx). - Chave de replicação de voz (por exemplo,
voicekey_xxx).
| Representação JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
A configuração do locutor predefinido a ser usada.
voiceName
string
Opcional. O nome da voz predefinida que será usada.
| Representação JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
A configuração para vários locutores.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
Obrigatório. Todas as vozes de locutor ativadas.
| Representação JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
A configuração de um único locutor em uma configuração com vários locutores.
speaker
string
Obrigatório. O nome do alto-falante que será usado. Deve ser igual ao 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 verdadeiro, os pensamentos serão retornados apenas quando estiverem disponíveis.
thinkingBudget
integer
O número de tokens de pensamento que o modelo deve gerar.
thinkingLevel
enum (ThinkingLevel)
Opcional. Controla a profundidade máxima do processo de raciocínio interno do modelo antes de produzir uma resposta. O valor padrão depende do modelo. Consulte o guia de níveis de raciocínio para mais detalhes. Recomendado para modelos do Gemini 3 ou mais recentes. O uso com modelos anteriores resulta em um erro.
| Representação JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
Permitir que o usuário especifique quanto pensar usando um tipo enumerado em vez de um orçamento inteiro.
| Tipos enumerados | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
Valor padrão. |
MINIMAL |
Pouco ou nenhum pensamento. |
LOW |
Nível de raciocínio baixo. |
MEDIUM |
Nível de raciocínio médio. |
HIGH |
Nível de raciocínio alto. |
ImageConfig
Configuração para recursos de geração de imagens.
aspectRatio
string
Opcional. A proporção da imagem a ser gerada. Proporções aceitas: 1:1, 1:4, 4:1, 1:8, 8:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 ou 21:9.
Se não for especificada, o modelo vai escolher uma proporção padrão com base nas imagens de referência fornecidas.
imageSize
string
Opcional. Especifica o tamanho das imagens geradas. Os valores compatíveis são 512, 1K, 2K e 4K. Se não for especificado, o modelo vai usar o valor padrão 1K.
| Representação JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
Resolução da mídia de entrada.
| Tipos enumerados | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
A resolução de 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 (enquadramento com zoom e 256 tokens). |
ResponseFormatConfig
Configuração para o formato de saída da resposta. Esse é um objeto simples em que cada subcampo opcional configura uma modalidade de saída específica.
text
object (TextResponseFormat)
Opcional. Configuração do formato de saída de texto.
audio
object (AudioResponseFormat)
Opcional. Configuração do formato de saída de áudio.
image
object (ImageResponseFormat)
Opcional. Configuração do formato de saída de imagem.
| Representação JSON |
|---|
{ "text": { object ( |
TextResponseFormat
Configuração para o formato de saída de texto.
mimeType
enum (MimeType)
Opcional. O tipo MIME da saída de texto.
schema
value (Value format)
Opcional. O esquema JSON que a saída precisa seguir. Aplicável somente quando mimeType é APPLICATION_JSON.
| Representação JSON |
|---|
{
"mimeType": enum ( |
MimeType
Tipos MIME compatíveis para saída de texto.
| Tipos enumerados | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
APPLICATION_JSON |
Formato de saída JSON. |
TEXT_PLAIN |
Formato de saída de texto simples. |
AudioResponseFormat
Configuração do formato de saída de áudio.
mimeType
enum (MimeType)
Opcional. O tipo MIME da saída de áudio.
delivery
enum (Delivery)
Opcional. O modo de entrega da saída de áudio.
sampleRate
integer
Opcional. Taxa de amostragem em Hz.
bitRate
integer
Opcional. Taxa de bits em bits por segundo (bps). Aplicável apenas a formatos compactados (MP3, Opus).
MimeType
Tipos MIME compatíveis para saída de áudio.
| Tipos enumerados | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
AUDIO_MP3 |
Formato de áudio MP3. |
AUDIO_OGG_OPUS |
Formato de áudio OGG Opus. |
AUDIO_L16 |
Formato de áudio PCM bruto (L16). |
AUDIO_WAV |
Formato de áudio WAV. |
AUDIO_ALAW |
Formato de áudio A-law. |
AUDIO_MULAW |
Formato de áudio Mu-law. |
Entrega
Modo de entrega para saída de áudio.
| Tipos enumerados | |
|---|---|
DELIVERY_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
INLINE |
Os dados de áudio são retornados inline na resposta. |
URI |
Os dados de áudio são retornados como um URI. |
ImageResponseFormat
Configuração do formato de saída da imagem.
mimeType
enum (MimeType)
Opcional. O tipo MIME da saída de imagem.
delivery
enum (Delivery)
Opcional. O modo de entrega da saída de imagem.
aspectRatio
enum (AspectRatio)
Opcional. É a proporção da imagem de saída.
imageSize
enum (ImageSize)
Opcional. O tamanho da saída da imagem.
| Representação JSON |
|---|
{ "mimeType": enum ( |
MimeType
Tipos MIME compatíveis com a saída de imagem.
| Tipos enumerados | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
IMAGE_JPEG |
Formato da imagem JPEG. |
Entrega
Modo de entrega para saída de imagem.
| Tipos enumerados | |
|---|---|
DELIVERY_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
INLINE |
Os dados da imagem são retornados inline na resposta. |
URI |
Os dados de imagem são retornados como um URI. |
AspectRatio
Proporções compatíveis para saída de imagem.
| Tipos enumerados | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
ASPECT_RATIO_ONE_BY_ONE |
Proporção 1:1. |
ASPECT_RATIO_TWO_BY_THREE |
Proporção 2:3. |
ASPECT_RATIO_THREE_BY_TWO |
Proporção 3:2. |
ASPECT_RATIO_THREE_BY_FOUR |
Proporção 3:4. |
ASPECT_RATIO_FOUR_BY_THREE |
Proporção 4:3. |
ASPECT_RATIO_FOUR_BY_FIVE |
Proporção 4:5. |
ASPECT_RATIO_FIVE_BY_FOUR |
Proporção 5:4. |
ASPECT_RATIO_NINE_BY_SIXTEEN |
Proporção de 9:16. |
ASPECT_RATIO_SIXTEEN_BY_NINE |
Proporção de 16:9. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
Proporção de 21:9. |
ASPECT_RATIO_ONE_BY_EIGHT |
Proporção de 1:8. |
ASPECT_RATIO_EIGHT_BY_ONE |
Proporção de 8:1. |
ASPECT_RATIO_ONE_BY_FOUR |
Proporção de 1:4. |
ASPECT_RATIO_FOUR_BY_ONE |
Proporção 4:1. |
ImageSize
Tamanhos de imagem compatíveis para saída de imagem.
| Tipos enumerados | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
IMAGE_SIZE_FIVE_TWELVE |
Tamanho da imagem de 512 px. |
IMAGE_SIZE_ONE_K |
Tamanho de imagem de 1K. |
IMAGE_SIZE_TWO_K |
Tamanho de imagem 2K. |
IMAGE_SIZE_FOUR_K |
Tamanho de imagem 4K. |
TranslationConfig
Configuração para recursos de tradução.
targetLanguageCode
string
Obrigatório. O idioma-alvo da tradução. Os valores compatíveis são códigos de idioma BCP-47 (por exemplo, "en", "es", "fr").
echoTargetLanguage
boolean
Opcional. Se for verdadeiro, o modelo vai gerar áudio quando o idioma-alvo for falado, ou seja, ele vai repetir a entrada. Se for falso, não vamos produzir áudio para o idioma-alvo.
| Representação JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
A configuração da transcrição de áudio.
languageCodes[]
string
Opcional. Códigos de idioma BCP-47 que fornecem dicas sobre os idiomas presentes no áudio. Se omitido ou vazio, o padrão será a detecção automática de idioma.
adaptationPhrases[]
(deprecated)
string
Opcional. Uma lista de frases usadas para adaptação de fala, que polariza o modelo de ASR para melhorar o reconhecimento desses termos específicos.
customVocabulary[]
string
Opcional. Uma lista de frases de vocabulário personalizado para influenciar o modelo de reconhecimento de fala a reconhecer termos específicos (nomes de produtos, substantivos próprios, jargões).
wordTimestamp
boolean
Opcional. Configura a geração de carimbos de data/hora no nível da palavra.
diarization
boolean
Opcional. Configura a diarização de locutores.
mode
enum (Mode)
Opcional. Configura o modo de transcrição. Valores aceitos: VERBATIM, SMART. Se não for especificado, o padrão será a transcrição VERBATIM. No modo SMART, o modelo realiza a remoção de disfluência (eliminando palavras desnecessárias, repetições e começos falsos), limpeza gramatical leve, formatação automática (parágrafos, marcadores, listas numeradas) e pequenas edições do usuário (autocorreções inline). Os carimbos de data/hora e a diarização são incompatíveis com o modo SMART.
language_config
Union type
language_codes de nível superior. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:languageAuto
(deprecated)
object (LanguageAuto)
Opcional. O modelo vai detectar o idioma automaticamente.
languageHints
(deprecated)
object (LanguageHints)
Opcional. Especifica um ou mais idiomas no áudio.
| Representação JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, "mode": enum ( |
LanguageAuto
Esse tipo não tem campos.
Indica que o idioma do áudio deve ser detectado automaticamente.
LanguageHints
Fornece dicas ao modelo sobre possíveis idiomas presentes no áudio.
languageCodes[]
(deprecated)
string
Obrigatório. Códigos de idioma BCP-47.
| Representação JSON |
|---|
{ "languageCodes": [ string ] } |
Modo
Modo de transcrição.
| Tipos enumerados | |
|---|---|
MODE_UNSPECIFIED |
Modo de transcrição não especificado. |
VERBATIM |
Modo de transcrição literal. |
SMART |
Modo de transcrição inteligente. |
RealtimeInputConfig
Configura o comportamento de entrada em tempo real em BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
Opcional. Se não for definida, a detecção automática de atividade será ativada por padrão. Se a detecção automática de voz estiver desativada, o cliente precisará enviar sinais de atividade.
activityHandling
enum (ActivityHandling)
Opcional. Define o efeito da atividade.
turnCoverage
enum (TurnCoverage)
Opcional. Define qual entrada é incluída na vez do usuário.
interimTranscriptTimestampEnabled
boolean
Opcional. Configura os carimbos de data/hora da transcrição provisória.
| Representação JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
Configura a detecção automática de atividades.
disabled
boolean
Opcional. Se ativada (como é o padrão), a entrada de voz e texto detectada conta como atividade. Se desativado, o cliente precisa enviar indicadores de atividade.
startOfSpeechSensitivity
enum (StartSensitivity)
Opcional. Determina a probabilidade de detecção de fala.
prefixPaddingMs
integer
Opcional. A duração necessária da fala detectada antes que o início da fala seja confirmado. Quanto menor esse valor, mais sensível é a detecção de início de fala, e falas mais curtas podem ser reconhecidas. No entanto, isso também aumenta a probabilidade de falsos positivos.
endOfSpeechSensitivity
enum (EndSensitivity)
Opcional. Determina a probabilidade de a fala detectada ter terminado.
silenceDurationMs
integer
Opcional. A duração necessária de não fala detectada (por exemplo, silêncio) antes que o fim da fala seja confirmado. Quanto maior esse valor, mais longas podem ser as pausas na fala sem interromper a atividade do usuário, mas isso aumenta a latência do modelo.
| Representação JSON |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
Determina como o início da fala é detectado.
| Tipos enumerados | |
|---|---|
START_SENSITIVITY_UNSPECIFIED |
O padrão é START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH |
A detecção automática vai detectar o início da fala com mais frequência. |
START_SENSITIVITY_LOW |
A detecção automática vai identificar o início da fala com menos frequência. |
EndSensitivity
Determina como o fim da fala é detectado.
| Tipos enumerados | |
|---|---|
END_SENSITIVITY_UNSPECIFIED |
O padrão é END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH |
A detecção automática encerra a fala com mais frequência. |
END_SENSITIVITY_LOW |
A detecção automática encerra a fala com menos frequência. |
ActivityHandling
As diferentes maneiras de lidar com a atividade do usuário.
| Tipos enumerados | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED |
Se não for especificado, o comportamento padrão será START_OF_ACTIVITY_INTERRUPTS. |
START_OF_ACTIVITY_INTERRUPTS |
Se for verdadeiro, o início da atividade vai interromper a resposta do modelo (também chamada de "interrupção"). A resposta atual do modelo será interrompida no momento da interrupção. Esse é o comportamento padrão. |
NO_INTERRUPTION |
A resposta do modelo não será interrompida. |
TurnCoverage
Opções sobre qual entrada é incluída na vez do usuário.
| Tipos enumerados | |
|---|---|
TURN_COVERAGE_UNSPECIFIED |
Se não for especificado, um comportamento padrão será selecionado com base no modelo. Por exemplo, para o Gemini 2.5, o padrão é TURN_INCLUDES_ONLY_ACTIVITY, enquanto para o Gemini 3.1 e versões mais recentes, é TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO. |
TURN_INCLUDES_ONLY_ACTIVITY |
Inclui a atividade desde a última vez, excluindo a inatividade (por exemplo, silêncio no stream de áudio). |
TURN_INCLUDES_ALL_INPUT |
Inclui todas as entradas em tempo real desde a última vez, incluindo inatividade (por exemplo, silêncio no stream de áudio). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO |
Inclui a atividade de áudio e todos os vídeos desde a última vez que você falou. Com a detecção automática de atividade, a atividade de áudio significa fala e exclui o silêncio. |
SessionResumptionConfig
Configuração de retomada da sessão.
Essa mensagem é incluída na configuração da sessão como BidiGenerateContentSetup.session_resumption. Se configurado, o servidor vai enviar mensagens SessionResumptionUpdate.
handle
string
O identificador de uma sessão anterior. Se não estiver presente, uma nova sessão será criada.
Os identificadores de sessão vêm de valores SessionResumptionUpdate.token em conexões anteriores.
| Representação JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
Ativa a compactação da janela de contexto, um mecanismo para gerenciar a janela de contexto do modelo para que ela não exceda um determinado tamanho.
compression_mechanism
Union type
slidingWindow
object (SlidingWindow)
Um mecanismo de janela deslizante.
triggerTokens
string (int64 format)
O número de tokens (antes de executar um turno) necessários para acionar uma compactação da janela de contexto.
Isso pode ser usado para equilibrar a qualidade e a latência, já que janelas de contexto mais curtas podem resultar em respostas mais rápidas do modelo. No entanto, qualquer operação de compactação causa um aumento temporário na latência. Por isso, elas não devem ser acionadas com frequência.
Se não for definido, o padrão será 80% do limite da janela de contexto do modelo. Isso deixa 20% para a próxima solicitação do usuário/resposta do modelo.
| Representação JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
O método SlidingWindow descarta o conteúdo no início da janela de contexto. O contexto resultante sempre vai começar no início de uma vez de fala da função USER. As instruções do sistema e qualquer BidiGenerateContentSetup.prefix_turns sempre vão permanecer no início do resultado.
targetTokens
string (int64 format)
O número desejado de tokens a serem mantidos. O valor padrão é triggerTokens/2.
O descarte de partes da janela de contexto causa um aumento temporário na latência. Por isso, esse valor precisa ser calibrado para evitar operações de compactação frequentes.
| Representação JSON |
|---|
{ "targetTokens": string } |
HistoryConfig
Configuração do histórico.
Essa mensagem é incluída na configuração da sessão como BidiGenerateContentSetup.history_config. Configura a troca de mensagens do histórico.
initialHistoryInClientContent
boolean
Opcional. Se for verdadeiro, depois de enviar setupComplete, o servidor vai esperar e processar as mensagens clientContent até que turnComplete seja true. Esse histórico inicial não aciona uma chamada de modelo e pode terminar com o papel MODEL. Depois que turnComplete for true, o cliente poderá iniciar a conversa em tempo real usando realtimeInput.
| Representação JSON |
|---|
{ "initialHistoryInClientContent": boolean } |
Método: auth_tokens.create
Cria um token que pode ser usado para restringir o comportamento de uma sessão BidiGenerateContent.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokens
Corpo da solicitação
O corpo da solicitação contém uma instância de AuthToken.
expireTime
string (Timestamp format)
Opcional. Somente entrada. Imutável. Um horário opcional após o qual, ao usar o token resultante, as mensagens nas sessões BidiGenerateContent serão rejeitadas. O Gemini pode encerrar a sessão de forma preventiva após esse período.
Se não for definido, o padrão será 30 minutos no futuro. Se definido, esse valor precisa ser inferior a 20 horas no futuro.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
newSessionExpireTime
string (Timestamp format)
Opcional. Somente entrada. Imutável. O horário após o qual as novas sessões da API Live que usam o token resultante dessa solicitação serão rejeitadas.
Se não for definido, o padrão será 60 segundos no futuro. Se definido, esse valor precisa ser inferior a 20 horas no futuro.
Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
fieldMask
string (FieldMask format)
Opcional. Somente entrada. Imutável. Se fieldMask estiver vazio e bidiGenerateContentSetup não estiver presente, a mensagem BidiGenerateContentSetup efetiva será extraída da conexão da API Live.
Se fieldMask estiver vazio e bidiGenerateContentSetup estiver presente, a mensagem BidiGenerateContentSetup efetiva será retirada inteiramente de bidiGenerateContentSetup nesta solicitação. A mensagem de configuração da conexão da API Live é ignorada.
Se fieldMask não estiver vazio, os campos correspondentes de bidiGenerateContentSetup vão substituir os campos da mensagem de configuração na conexão da API Live.
É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
Opcional. Somente entrada. Imutável. Configuração específica para BidiGenerateContent.
uses
integer
Opcional. Somente entrada. Imutável. O número de vezes que o token pode ser usado. Se esse valor for zero, nenhum limite será aplicado. Retomar uma sessão da API Live não conta como uso. Se não for especificado, o padrão será 1.
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de AuthToken.