A API Gemini é compatível com a geração de conteúdo com imagens, áudio, código, ferramentas e muito mais. Para detalhes sobre cada um desses recursos, leia este artigo e confira o exemplo de código focado em tarefas ou os guias abrangentes.
- Geração de texto
- Visão
- Áudio
- Embeddings
- Contexto longo
- Execução de código
- Modo JSON
- Chamadas de função
- Instruções do sistema
Método: models.generateContent
- Endpoint
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Exemplo de solicitação
Gera uma resposta do modelo com base em uma entrada GenerateContentRequest. Consulte o guia de geração de texto para informações detalhadas sobre o uso. As funcionalidades 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 da ferramenta para qualquer Tool especificado na solicitação. Consulte o guia de chamada de função para ver um exemplo de uso.
safetySettings[]
object (SafetySetting)
Opcional. Uma lista de instâncias SafetySetting exclusivas para bloquear conteúdo não seguro.
Isso será aplicado no GenerateContentRequest.contents e no GenerateContentResponse.candidates. Não pode haver mais de uma configuração para cada tipo de SafetyCategory. A API bloqueia conteúdos e respostas que não atendem 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 informações detalhadas sobre as configurações de segurança disponíveis. Consulte também as orientações de segurança para saber como incorporar considerações de segurança aos seus aplicativos de IA.
systemInstruction
object (Content)
Opcional. O desenvolvedor definiu instruções do sistema. No momento, apenas texto.
generationConfig
object (GenerationConfig)
Opcional. Opções de configuração para geração e saídas de modelos.
cachedContent
string
Opcional. O nome do conteúdo em cache a ser usado como contexto para disponibilizar a previsão. Formato: cachedContents/{cachedContent}
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 definido, ele terá precedência sobre a configuração de geração de registros no nível do 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 transmitida do modelo com base em uma entrada GenerateContentRequest.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
Parâmetros de caminho
model
string
Obrigatório. O nome do Model a ser usado para gerar a conclusão.
Formato: models/{model}. Ele tem o formato models/{model}.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
tools[]
object (Tool)
Opcional. Uma lista de Tools que o Model pode usar para gerar a próxima resposta.
Uma Tool é uma parte do código que permite ao sistema interagir com sistemas externos para realizar uma ação ou conjunto de ações fora do conhecimento e do escopo do Model. Os 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 da ferramenta para qualquer Tool especificado na solicitação. Consulte o guia de chamada de função para ver um exemplo de uso.
safetySettings[]
object (SafetySetting)
Opcional. Uma lista de instâncias SafetySetting exclusivas para bloquear conteúdo não seguro.
Isso será aplicado no GenerateContentRequest.contents e no GenerateContentResponse.candidates. Não pode haver mais de uma configuração para cada tipo de SafetyCategory. A API bloqueia conteúdos e respostas que não atendem 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 informações detalhadas sobre as configurações de segurança disponíveis. Consulte também as orientações de segurança para saber como incorporar considerações de segurança aos seus aplicativos de IA.
systemInstruction
object (Content)
Opcional. O desenvolvedor definiu instruções do sistema. No momento, apenas texto.
generationConfig
object (GenerationConfig)
Opcional. Opções de configuração para geração e saídas de modelos.
cachedContent
string
Opcional. O nome do conteúdo em cache a ser usado como contexto para disponibilizar a previsão. Formato: cachedContents/{cachedContent}
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 definido, ele terá precedência sobre a configuração de geração de registros no nível do 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 oferece suporte a várias respostas candidatas.
As classificações de segurança e a filtragem de conteúdo são informadas para os dois comandos em GenerateContentResponse.prompt_feedback e para cada candidato em finishReason e safetyRatings. A API: - Retorna todos os candidatos solicitados ou nenhum deles. - Não retorna nenhum candidato apenas se houver algo errado com o comando (verifique promptFeedback). - Informa o feedback sobre cada candidato em finishReason e safetyRatings.
candidates[]
object (Candidate)
Respostas candidatas do modelo.
promptFeedback
object (PromptFeedback)
Retorna o feedback 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. O 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 dos metadados de feedback especificados na solicitação em GenerateContentRequest.content.
blockReason
enum (BlockReason)
Opcional. Se definido, o comando foi bloqueado e nenhum candidato foi retornado. Reformule o comando.
safetyRatings[]
object (SafetyRating)
Classificações de segurança do comando. Há no máximo uma classificação por categoria.
| Representação JSON |
|---|
{ "blockReason": enum ( |
BlockReason
Especifica o motivo do bloqueio do comando.
| Tipos enumerados | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
SAFETY |
O comando foi bloqueado por motivos de segurança. Analise safetyRatings para entender qual categoria de segurança fez o bloqueio. |
OTHER |
O comando foi bloqueado por motivos desconhecidos. |
BLOCKLIST |
A solicitação foi bloqueada devido aos termos incluídos na lista de bloqueio de terminologia. |
PROHIBITED_CONTENT |
O comando foi bloqueado devido a conteúdo proibido. |
IMAGE_SAFETY |
Candidatos bloqueados devido a conteúdo não seguro de geração de imagens. |
UsageMetadata
Metadados sobre o uso de tokens da solicitação de geração.
promptTokenCount
integer
Número de tokens no comando. Quando cachedContent é definido, esse ainda é o tamanho total efetivo do comando, o que significa que inclui o número de tokens no conteúdo armazenado em cache.
cachedContentTokenCount
integer
Número de tokens na parte armazenada em cache do comando (o conteúdo em cache)
candidatesTokenCount
integer
Número total de tokens em todos os candidatos de resposta gerados.
toolUsePromptTokenCount
integer
Apenas saída. Número de tokens presentes nos comandos de uso da ferramenta.
thoughtsTokenCount
integer
Apenas saída. Número de tokens de ideias para modelos de raciocínio.
totalTokenCount
integer
Contagem total de tokens para a solicitação de geração (comando + ideias + candidatos a resposta).
promptTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades processadas na entrada da solicitação.
cacheTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades do conteúdo em cache na entrada da solicitação.
candidatesTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades retornadas na resposta.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
Apenas saída. Lista de modalidades processadas para entradas de solicitação de uso de ferramentas.
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. Usado para indicar a fase 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 a etapa do modelo subjacente.
| 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 nessa fase são apenas para fins experimentais. |
PREVIEW |
Os modelos nessa fase são mais maduros do que os experimentais. |
STABLE |
Os modelos nessa fase são considerados estáveis e prontos para uso em produção. |
LEGACY |
Se o modelo estiver nessa fase, significa que ele será descontinuado em breve. Apenas clientes atuais podem usar esse modelo. |
DEPRECATED |
Os modelos nessa fase são descontinuados. Esses modelos não podem ser usados. |
RETIRED |
Os modelos nessa fase são desativados. Esses modelos não podem ser usados. |
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
Um candidato de resposta gerado pelo modelo.
content
object (Content)
Apenas saída. Conteúdo gerado retornado pelo modelo.
finishReason
enum (FinishReason)
Opcional. Apenas saída. É o motivo pelo qual o modelo parou de gerar tokens.
Se estiver vazio, o modelo não parou de gerar tokens.
safetyRatings[]
object (SafetyRating)
Lista de classificações para a segurança de um candidato a resposta.
Há no máximo uma classificação por categoria.
citationMetadata
object (CitationMetadata)
Apenas saída. Informações de citação para o candidato gerado pelo modelo.
Esse campo pode ser preenchido com informações de recitação para qualquer texto incluído no content. São trechos "recitados" de material protegido por direitos autorais nos dados de treinamento do LLM de base.
tokenCount
integer
Apenas saída. Contagem de tokens para este candidato.
groundingAttributions[]
object (GroundingAttribution)
Apenas saída. Informações de atribuição para fontes que contribuíram para uma resposta embasada.
Esse campo é preenchido para chamadas GenerateAnswer.
groundingMetadata
object (GroundingMetadata)
Apenas saída. Metadados de embasamento para o candidato.
Esse campo é preenchido para chamadas GenerateContent.
avgLogprobs
number
Apenas saída. Pontuação média de probabilidade de registro do candidato.
logprobsResult
object (LogprobsResult)
Apenas saída. Pontuações de verossimilhança de registro para os tokens de resposta e os principais tokens
urlContextMetadata
object (UrlContextMetadata)
Apenas saída. Metadados relacionados à ferramenta de recuperação de contexto de URL.
index
integer
Apenas saída. Índice do candidato na lista de candidatos de resposta.
finishMessage
string
Opcional. Apenas saída. Detalha o motivo pelo qual o modelo parou de gerar tokens. Isso só será preenchido quando finishReason estiver 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 do candidato a resposta foi sinalizado por motivos de segurança. |
RECITATION |
O conteúdo candidato à resposta foi sinalizado por motivos de recitação. |
LANGUAGE |
O conteúdo da resposta foi sinalizado por usar um idioma sem suporte. |
OTHER |
Motivo desconhecido. |
BLOCKLIST |
A geração de tokens foi interrompida porque o conteúdo contém termos proibidos. |
PROHIBITED_CONTENT |
A geração de tokens foi interrompida por conter conteúdo proibido. |
SPII |
A geração de tokens foi interrompida porque o conteúdo pode conter informações sensíveis de identificação pessoal (SPII). |
MALFORMED_FUNCTION_CALL |
A chamada de função gerada pelo modelo é inválida. |
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 outros conteúdos proibidos. |
IMAGE_OTHER |
A geração de imagens foi interrompida devido a outro problema diverso. |
NO_IMAGE |
O modelo deveria ter gerado uma imagem, mas não gerou nenhuma. |
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 estava 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 |
Concluído devido a uma resposta incorreta. |
ESCALATION |
A solicitação foi filtrada por uma regra de encaminhamento. |
GroundingAttribution
Atribuição de uma fonte que contribuiu para uma resposta.
sourceId
object (AttributionSourceId)
Apenas saída. Identificador da origem que contribui para essa atribuição.
content
object (Content)
Conteúdo da fonte de embasamento que compõe essa atribuição.
| Representação JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
Identificador da origem que contribui para essa atribuição.
source
Union type
source pode ser apenas de um dos tipos a seguir:groundingPassage
object (GroundingPassageId)
Identificador de uma passagem inline.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
Identificador de um Chunk buscado pelo Semantic Retriever.
| Representação JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
Identificador de uma parte em um GroundingPassage.
passageId
string
Apenas saída. ID da passagem que corresponde ao GroundingPassage.id do GenerateAnswerRequest.
partIndex
integer
Apenas saída. Índice da parte no GroundingPassage.content do GenerateAnswerRequest.
| Representação JSON |
|---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
Identificador de um Chunk recuperado pelo Semantic Retriever especificado no GenerateAnswerRequest usando SemanticRetrieverConfig.
source
string
Apenas saída. Nome da origem que corresponde ao SemanticRetrieverConfig.source da solicitação. Exemplo: corpora/123 ou corpora/123/documents/abc
chunk
string
Apenas saída. Nome do Chunk que contém o texto atribuído. Exemplo: corpora/123/documents/abc/chunks/xyz
| Representação JSON |
|---|
{ "source": string, "chunk": string } |
GroundingMetadata
Metadados retornados ao cliente quando o embasamento está ativado.
groundingChunks[]
object (GroundingChunk)
Lista de referências de apoio recuperadas da fonte de embasamento especificada. Ao fazer streaming, isso contém apenas os trechos 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 por imagens usadas para embasamento.
searchEntryPoint
object (SearchEntryPoint)
Opcional. Entrada da Pesquisa Google para as pesquisas na Web de acompanhamento.
retrievalMetadata
object (RetrievalMetadata)
Metadados relacionados à recuperação no fluxo de embasamento.
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 contextuais. 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 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 fundamentam 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
chunk_type pode ser apenas de um dos tipos a seguir:web
object (Web)
Trecho de embasamento da Web.
image
object (Image)
Opcional. Trecho de embasamento da pesquisa por imagens.
retrievedContext
object (RetrievedContext)
Opcional. Trecho de embasamento do contexto recuperado pela ferramenta de pesquisa de arquivos.
maps
object (Maps)
Opcional. Trecho 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 trecho.
title
string
Apenas saída. Título do trecho.
| Representação JSON |
|---|
{ "uri": string, "title": string } |
Imagem
Bloco da pesquisa por 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 extraída.
domain
string
O domínio raiz da página da Web de onde a imagem foi extraída, por exemplo, "example.com".
| Representação JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
Trecho 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 trecho.
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 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
value pode ser apenas de um dos tipos a seguir: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 trecho 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 textual da resposta do lugar.
placeId
string
O ID do lugar, no formato places/{placeId}. Um usuário pode usar esse ID para pesquisar 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
Coleção de fontes que fornecem respostas sobre os recursos 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 recursos do lugar (por exemplo, "O Bar Foo tem Wi-Fi?" ou "O Foo Bar é acessível para cadeirantes?"). No momento, só aceitamos snippets de avaliações como fontes.
reviewSnippets[]
object (ReviewSnippet)
Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.
| Representação JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
Encapsula um trecho de uma avaliação do 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 para embasamento.
groundingChunkIndices[]
integer
Opcional. Uma lista de índices (em "grounding_chunk" em response.candidate.grounding_metadata) que especificam as citações associadas à declaração. Por exemplo, [1,3,4] significa que grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] são o conteúdo recuperado atribuído à declaração. Se a resposta estiver sendo transmitida, os groundingChunkIndices vão se referir aos índices em todas as respostas. É responsabilidade do cliente acumular os trechos 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 a que este 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 especificada, medido em bytes. Deslocamento do início da parte, inclusivo, 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 é a menor probabilidade e 1 é a maior. Essa pontuação só é preenchida quando o embasamento da Pesquisa Google e a recuperação dinâmica estão ativados. Ele será comparado ao limite para determinar se a Pesquisa Google será acionada.
| Representação JSON |
|---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Resultado de Logprobs
topCandidates[]
object (TopCandidates)
Comprimento = número total de etapas de decodificação.
chosenCandidates[]
object (Candidate)
Comprimento = número total de etapas de decodificação. Os candidatos escolhidos podem ou não estar em topCandidates.
logProbabilitySum
number
Soma das probabilidades de registro de todos os tokens.
| Representação JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
Candidatos com as principais probabilidades de registro em cada etapa de decodificação.
candidates[]
object (Candidate)
Classificados por probabilidade logarítmica em ordem decrescente.
| Representação JSON |
|---|
{
"candidates": [
{
object ( |
Candidato
Candidato ao token e à pontuação de logprobs.
token
string
O valor da string do token do candidato.
tokenId
integer
O valor do ID do token do candidato.
logProbability
number
A probabilidade de registro do candidato.
| Representação JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
Metadados relacionados à ferramenta de recuperação de contexto de URL.
urlMetadata[]
object (UrlMetadata)
Lista de contextos de URL.
| Representação JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
Contexto de uma única recuperação de URL.
retrievedUrl
string
URL recuperado pela ferramenta.
urlRetrievalStatus
enum (UrlRetrievalStatus)
Status da recuperação do URL.
| Representação JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
Status da recuperação do URL.
| 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 |
A recuperação do URL falhou devido a um erro. |
URL_RETRIEVAL_STATUS_PAYWALL |
A recuperação do URL falhou 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 esta fonte.
O índice indica o início do segmento, medido em bytes.
endIndex
integer
Opcional. Fim do segmento atribuído, exclusivo.
uri
string
Opcional. URI atribuído como fonte de uma parte do texto.
license
string
Opcional. Licença do projeto do GitHub atribuída como uma fonte para o segmento.
As informações de 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. |
HARM_CATEGORY_TOXICITY |
PaLM: conteúdo grosseiro, desrespeitoso ou com linguagem obscena. |
HARM_CATEGORY_VIOLENCE |
PaLM: descreve cenários que retratam violência contra um indivíduo ou grupo ou descrições gerais de sangue em excesso. |
HARM_CATEGORY_SEXUAL |
PaLM: contém referências a atos sexuais ou outro conteúdo obsceno. |
HARM_CATEGORY_MEDICAL |
PaLM: promove orientações médicas não verificadas. |
HARM_CATEGORY_DANGEROUS |
PaLM: conteúdo perigoso que promove, facilita ou incentiva atos nocivos. |
HARM_CATEGORY_HARASSMENT |
Gemini: conteúdo de assédio. |
HARM_CATEGORY_HATE_SPEECH |
Gemini: discurso de ódio e conteúdo. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini: conteúdo sexualmente explícito. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini: conteúdo perigoso. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini: conteúdo que pode ser usado para prejudicar a integridade cívica. OBSOLETO: 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 dano está incluída aqui.
category
enum (HarmCategory)
Obrigatório. A categoria desta classificação.
probability
enum (HarmProbability)
Obrigatório. A probabilidade de danos para esse conteúdo.
blocked
boolean
O conteúdo foi bloqueado por causa dessa classificação?
| Representação JSON |
|---|
{ "category": enum ( |
HarmProbability
A probabilidade de um conteúdo ser nocivo.
O sistema de classificação informa a probabilidade de o conteúdo não ser seguro. Isso não indica a gravidade do dano para um conteúdo.
| 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 baixa probabilidade de não ser seguro. |
MEDIUM |
O conteúdo tem uma chance média de não ser seguro. |
HIGH |
O conteúdo tem alta probabilidade de não ser seguro. |
SafetySetting
Configuração de segurança que afeta o comportamento de bloqueio de segurança.
Ao transmitir uma configuração de segurança para uma categoria, a probabilidade permitida de bloqueio de conteúdo muda.
category
enum (HarmCategory)
Obrigatório. A categoria dessa configuração.
threshold
enum (HarmBlockThreshold)
Obrigatório. Controla o limite de probabilidade em que o dano é bloqueado.
| Representação JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
Bloquear em e além de uma probabilidade de dano especificada.
| 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 níveis "NEGLIGIBLE" e "LOW" será permitido. |
BLOCK_ONLY_HIGH |
Conteúdo com gravidade NEGLIGENCIÁVEL, BAIXA e MÉDIA 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 é "padrão". |
standard |
Nível de serviço Standard. |
flex |
Nível de serviço flexível. |
priority |
Nível de serviço de prioridade. |
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
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 multiturno. Caso contrário, pode ser deixado em branco ou não definido.
| 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 for preenchido com bytes brutos.
thought
boolean
Opcional. Indica se a parte foi gerada pelo 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 fluxos 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.
data
Union type
data pode ser apenas de um dos tipos a seguir: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 para 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 precisa ser executada no servidor. O cliente deve 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
metadata pode ser apenas de um dos tipos a seguir: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 pode 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.
| Representação JSON |
|---|
{ "mimeType": string, "data": 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 umaFunctionCall feita com base na previsão do modelo.
id
string
Opcional. O identificador da chamada de função a que esta resposta se refere. Preenchido pelo cliente para corresponder à chamada de função id.
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 chamadores podem usar qualquer chave que se ajuste à sintaxe da função para retornar a saída dela, 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.
Para incluir multimídia, use um subobjeto que contenha uma única chave "$ref" cujo valor seja o inlineData.display_name de um FunctionResponsePart que contenha 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 IANA.
willContinue
boolean
Opcional. Sinaliza que a chamada de função continua e mais respostas serão retornadas, transformando a chamada de função em um gerador. É aplicável apenas a chamadas de função NON_BLOCKING. Caso contrário, é ignorado. Se for definido como "false", 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 o acionamento da geração e concluir a chamada de função, defina 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, é 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 for preenchido com bytes brutos.
data
Union type
data pode ser apenas de um dos tipos a seguir:inlineData
object (FunctionResponseBlob)
Bytes de mídia inline.
| Representação JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
Bytes de mídia brutos para resposta da 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 sem suporte for fornecido, um erro será retornado. Para uma lista completa de 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 |
Adicione apenas o resultado ao contexto da conversa, sem interromper ou acionar 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.
| Representação JSON |
|---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
Código gerado pelo modelo para 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. Esse valor não deve ser usado. |
PYTHON |
Python >= 3.10, com numpy e simpy disponíveis. O Python é o idioma padrão. |
CodeExecutionResult
Resultado da execução do ExecutableCode.
Gerado somente 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.
| Representação JSON |
|---|
{
"id": string,
"outcome": enum ( |
Resultado
Enumeração dos possíveis resultados da execução de código.
| Tipos enumerados | |
|---|---|
OUTCOME_UNSPECIFIED |
Status não especificado. Esse 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 durou muito tempo e foi cancelada. Pode ou não haver 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. Não é esperado que o cliente execute esse ToolCall. Em vez disso, o cliente precisa transmitir esse ToolCall de volta à API em uma próxima vez em uma mensagem Content, junto com o ToolResponse correspondente.
id
string
Opcional. Identificador exclusivo da chamada de função. 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 de pesquisa do Google, mapeada para Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
Ferramenta de pesquisa por imagens, mapeada para Tool.google_search.search_types.image_search. |
URL_CONTEXT |
Ferramenta de contexto de URL, mapeada para Tool.url_context. |
GOOGLE_MAPS |
Ferramenta do Google Maps, mapeada 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 próxima vez em uma mensagem Content, junto com o ToolCall correspondente.
id
string
Opcional. O identificador da chamada de função a que esta 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
Descontinuado: use GenerateContentRequest.processing_options. Os metadados descrevem o conteúdo do vídeo de entrada.
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. A taxa de frames do vídeo enviado ao modelo. Se não for especificado, o valor padrão será 1,0. O intervalo de fps é (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
value pode ser apenas de um dos tipos a seguir:level
enum (Level)
A qualidade da tokenização usada para determinada mídia.
| Representação JSON |
|---|
{
// value
"level": enum ( |
Nível
O nível de resolução da mídia.
| Tipos enumerados | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
A resolução da mídia não foi definida. |
MEDIA_RESOLUTION_LOW |
A resolução de mídia está definida como baixa. |
MEDIA_RESOLUTION_MEDIUM |
A resolução de mídia foi definida como média. |
MEDIA_RESOLUTION_HIGH |
A resolução da mídia está definida como alta. |
MEDIA_RESOLUTION_ULTRA_HIGH |
A resolução da mídia está definida como ultra alta. |
MediaProcessing
Como o modelo processa a mídia de entrada para entender.
| Tipos enumerados | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
Padrão. Usa o processamento específico do modelo (3.5 Pro+ -> AGENTIC, modelos mais antigos -> STATIC). |
STATIC |
Extração de quadros 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. |
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. A hora 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 de 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
network pode ser apenas de um dos tipos a seguir: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 enumeração. 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 de 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. Só será preenchido quando o objeto for a raiz.
anyOf[]
object (Schema)
Opcional. O valor precisa ser validado em relação a qualquer um (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 está 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 TIPO 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 em https://spec.openapis.org/oas/v3.0.3#data-types
| Tipos enumerados | |
|---|---|
TYPE_UNSPECIFIED |
Não especificado, não pode ser usado. |
STRING |
Tipo de 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.
Próximo ID: 17
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 vez que você falar pode conter um FunctionResponse com o contexto de geração Content.role "function" para a próxima vez que o modelo falar.
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. Tecnologia do Google.
computerUse
object (ComputerUse)
Opcional. Ferramenta para ajudar o modelo a interagir diretamente com o computador. Se ativado, ele preenche automaticamente as declarações de função específicas para uso do computador.
urlContext
object (UrlContext)
Opcional. Ferramenta para oferecer suporte à recuperação de 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 a serem conectados.
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. O nome e os parâmetros da função estão incluídos nessa declaração. Essa FunctionDeclaration é uma representação de um bloco de código que pode ser usado como uma 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 API aberta 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 API aberta 3.03. O esquema define o tipo usado para o valor da 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 da 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 à medida que elas ficarem disponíveis, mantendo a conversa entre o usuário e o modelo. |
GoogleSearchRetrieval
Ferramenta para recuperar dados públicos da Web para embasamento, desenvolvida pelo Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
Especifica a configuração de recuperação dinâmica para a origem especificada.
| 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 acione a recuperação. |
MODE_DYNAMIC |
Execute 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 ele.
Consulte também ExecutableCode e CodeExecutionResult, que só são gerados ao usar essa ferramenta.
GoogleSearch
Tipo de ferramenta GoogleSearch. Ferramenta para oferecer suporte à Pesquisa Google no modelo. Tecnologia do Google.
timeRangeFilter
object (Interval)
Opcional. Filtre 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 na Web padrão para embasamento e configurações relacionadas.
ImageSearch
Esse tipo não tem campos.
Pesquisa por imagens para embasamento e configurações relacionadas.
ComputerUse
Tipo de ferramenta "Uso do computador".
environment
enum (Environment)
Obrigatório. O ambiente em operação.
excludedPredefinedFunctions[]
string
Opcional. Por padrão, as funções predefinidas são incluídas na chamada do modelo final. Alguns deles podem ser excluídos explicitamente da inclusão automática. Isso pode ter duas finalidades: 1. Usar um espaço de ação mais restrito / diferente. 2. Melhorar as 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 em solicitações de uso do computador.
disabledSafetyPolicies[]
enum (SafetyPolicy)
Opcional. Políticas de segurança desativadas para uso do computador.
| Representação JSON |
|---|
{ "environment": enum ( |
Ambiente
Representa o ambiente em que a operação está sendo realizada, como um navegador da Web.
| Tipos enumerados | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
O padrão é "browser". |
ENVIRONMENT_BROWSER |
Funciona em um navegador da Web. |
ENVIRONMENT_MOBILE |
Operar em um ambiente móvel. |
ENVIRONMENT_DESKTOP |
Funciona em um ambiente de computador. |
SafetyPolicy
Políticas de segurança predefinidas para 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 gestão 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 oferecer suporte à recuperação de contexto de URL.
FileSearch
A ferramenta FileSearch que recupera conhecimento de corpora de recuperação semântica. Os arquivos são importados para os corpus de recuperação semântica usando a API ImportFile.
fileSearchStoreNames[]
string
Obrigatório. Os nomes dos fileSearchStores a serem recuperados. Exemplo: fileSearchStores/my-file-search-store-123
metadataFilter
string
Opcional. Filtro de metadados a ser aplicado aos documentos e partes da recuperação semântica.
topK
integer
Opcional. O número de partes da recuperação semântica a serem recuperadas.
| 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. Próximo código: 4
name
string
O nome do MCPServer.
transport
Union type
transport pode ser apenas de um dos tipos a seguir: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. Próximo código: 4
url
string
O URL completo do endpoint 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 HTTP para operações regulares.
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
Define se a sessão do cliente será fechada 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 referencia 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
- 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 em sessões BidiGenerateContent serão rejeitadas. O Gemini pode fechar a sessão antes desse período.
Se não for definido, o padrão será 30 minutos no futuro. Se definido, esse valor precisa ser menor que 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 período após o qual novas sessões da API Live usando o token resultante desta solicitação serão rejeitadas.
Se não for definido, o padrão será 60 segundos no futuro. Se definido, esse valor precisa ser menor que 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á extraída 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
config pode ser apenas de um dos tipos a seguir: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 um 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 aguardar uma mensagem BidiGenerateContentSetupComplete antes de enviar outras mensagens.
model
string
Obrigatório. O nome do recurso do modelo. Ele 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 compatíveis:
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 da 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 comprimento configurado.
inputAudioTranscription
object (AudioTranscriptionConfig)
Opcional. Se definido, permite a transcrição da entrada de texto por voz. A transcrição é alinhada 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 é alinhada 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.
| 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é 5) que vão interromper a geração de saída. Se especificado, a API vai parar na primeira aparição de um stop_sequence. A sequência de paradas não será incluída como parte da resposta.
responseMimeType
string
Opcional. Tipo MIME do texto candidato gerado. Os tipos MIME compatíveis são: text/plain: (padrão) saída de texto. application/json: resposta JSON nos candidatos de resposta. text/x.enum: ENUM como uma resposta de string nos candidatos de resposta. Consulte os documentos para ver uma lista de todos os tipos MIME de texto compatíveis.
responseSchema
(deprecated)
object (Schema)
Opcional. Esquema de saída do texto candidato gerado. Os esquemas precisam ser um subconjunto do esquema OpenAPI e podem ser objetos, primitivos ou matrizes.
Se definido, um responseMimeType compatível também precisa ser definido. Tipos MIME compatíveis: application/json: esquema para resposta JSON. Consulte o guia de geração de texto JSON para mais detalhes.
_responseJsonSchema
(deprecated)
value (Value format)
Opcional. Esquema de saída da resposta gerada. Essa é uma alternativa a responseSchema que aceita esquema JSON.
Se definido, responseSchema precisa ser omitido, mas responseMimeType é obrigatório.
Embora o esquema JSON completo possa ser enviado, nem todos os recursos são compatíveis. Especificamente, apenas as seguintes propriedades são compatíveis:
$id$defs$ref$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é um grau limitado e, portanto, só podem ser usadas em propriedades não obrigatórias. (Propriedades anuláveis não são suficientes.) Se $ref estiver definido em um subesquema, nenhuma outra propriedade, exceto aquelas que começam como $, poderá ser definida.
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 compatíveis, um erro será retornado.
Uma lista vazia equivale a solicitar apenas texto.
candidateCount
integer
Opcional. Número de respostas geradas a serem retornadas. Se não for definido, o padrão será 1. Observação: isso não funciona para modelos de geração anterior (família Gemini 1.0).
maxOutputTokens
integer
Opcional. O número máximo de tokens a serem incluídos em um candidato a resposta.
Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.output_token_limit do Model retornado pela função getModel.
temperature
number
Opcional. Controla a aleatoriedade da saída.
Observação: o valor padrão varia de acordo com o modelo. Consulte o atributo Model.temperature do Model retornado pela função getModel.
Os valores podem variar de [0,0, 2,0].
topP
number
Opcional. A probabilidade cumulativa máxima de tokens a serem considerados na amostragem.
O modelo usa amostragem combinada 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 da função getModel. Um atributo topK vazio indica que o modelo não aplica a amostragem top-k e não permite definir topK em solicitações.
topK
integer
Opcional. O número máximo de tokens a serem considerados ao fazer a amostragem.
Os modelos do Gemini usam amostragem Top-p (de núcleo) ou uma combinação de amostragem Top-k e de núcleo. A amostragem Top-k considera o conjunto dos topK tokens mais prováveis. Os modelos executados com amostragem de núcleo não permitem a configuração de topK.
Observação: o valor padrão varia de acordo com o Model e é especificado pelo atributo Model.top_p retornado da função getModel. Um atributo topK vazio indica que o modelo não aplica a amostragem top-k e não permite definir topK em solicitações.
seed
integer
Opcional. Seed usada na decodificação. Se não for definido, a solicitação usará uma seed gerada aleatoriamente.
presencePenalty
number
Opcional. Penalidade de presença aplicada às logprobs do próximo token se ele já tiver sido visto na resposta.
Essa penalidade é binária (ativada/desativada) e não depende do número de vezes que o token é usado (após a primeira). Use frequencyPenalty para uma penalidade que aumenta a cada uso.
Uma penalidade positiva desencoraja o uso de tokens que já foram usados na resposta, aumentando o vocabulário.
Uma penalidade negativa incentiva o uso de tokens que já foram usados na resposta, diminuindo o vocabulário.
frequencyPenalty
number
Opcional. Penalidade de frequência aplicada às logprobs do próximo token, multiplicada pelo número de vezes que cada token foi visto na resposta até agora.
Uma penalidade positiva desencoraja o uso de tokens que já foram usados, proporcionalmente ao número de vezes que o token foi usado: quanto mais um token é usado, mais difícil é para o modelo usar esse token novamente, aumentando o vocabulário das respostas.
Atenção: uma penalidade negativa incentiva o modelo a reutilizar tokens proporcionalmente ao número de vezes que o token foi usado. Valores negativos pequenos reduzem o vocabulário de uma resposta. Valores negativos maiores fazem com que o modelo comece a repetir um token comum até atingir o limite de maxOutputTokens.
responseLogprobs
boolean
Opcional. Se verdadeiro, exporte os resultados de logprobs na resposta.
logprobs
integer
Opcional. Válido apenas se responseLogprobs=True. Isso define o número de logprobs principais, incluindo o candidato escolhido, a serem retornados em cada etapa de decodificação no Candidate.logprobs_result. O número precisa estar no intervalo [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 oferecem suporte a essas opções de configuração.
mediaResolution
enum (MediaResolution)
Opcional. Se especificado, a resolução de mídia especificada será usada.
enableAffectiveDialog
boolean
Opcional. Se ativada, o modelo vai detectar emoções e adaptar as respostas de acordo com elas.
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 voz.
voiceConfig
object (VoiceConfig)
A configuração em caso de saída de voz única.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
Opcional. A configuração para a configuração de vários alto-falantes. É mutuamente exclusivo com o campo "voiceConfig".
languageCode
string
Opcional. O código de idioma BCP-47 do IETF que o usuário configurou para o app usar. 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
voice_config pode ser apenas de um dos tipos a seguir:prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
A configuração da voz pré-criada a ser usada.
| Representação JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
A configuração do alto-falante pré-criado a ser usado.
voiceName
string
O nome da voz predefinida a ser usada.
| Representação JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
A configuração para a configuração de vários alto-falantes.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
Obrigatório. Todas as vozes de alto-falante ativadas.
| Representação JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
A configuração de um único alto-falante em uma configuração com vários alto-falantes.
speaker
string
Obrigatório. O nome do alto-falante a ser usado. Precisa ser igual ao do comando.
voiceConfig
object (VoiceConfig)
Obrigatório. A configuração da voz a ser usada.
| Representação JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
Configuração para recursos de pensamento.
includeThoughts
boolean
Indica se os pensamentos devem ser incluídos na resposta. Se for "true", as ideias serão retornadas apenas quando estiverem disponíveis.
thinkingBudget
integer
O número de tokens de ideias que o modelo deve gerar.
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 pensamento 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 tempo pensar usando enum em vez de 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 |
Alto nível de raciocínio. |
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 especificado, 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 aceitos 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 da mídia não foi definida. |
MEDIA_RESOLUTION_LOW |
Resolução de mídia definida como baixa (64 tokens). |
MEDIA_RESOLUTION_MEDIUM |
Resolução de mídia definida como média (256 tokens). |
MEDIA_RESOLUTION_HIGH |
Resolução de mídia definida como alta (enquadramento com zoom e 256 tokens). |
ResponseFormatConfig
Configuração para o formato de saída da resposta. É 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 da 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 para o 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 transferência 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 transferência 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 para o 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 transferência da saída de imagem.
aspectRatio
enum (AspectRatio)
Opcional. É a proporção da saída de imagem.
imageSize
enum (ImageSize)
Opcional. O tamanho da saída da imagem.
| Representação JSON |
|---|
{ "mimeType": enum ( |
MimeType
Tipos MIME compatíveis para saída de imagem.
| Tipos enumerados | |
|---|---|
MIME_TYPE_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
IMAGE_JPEG |
Formato de imagem JPEG. |
Entrega
Modo de transferência para saída de imagem.
| Tipos enumerados | |
|---|---|
DELIVERY_UNSPECIFIED |
Valor padrão. Esse valor não é usado. |
INLINE |
Os dados de 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 9:16. |
ASPECT_RATIO_SIXTEEN_BY_NINE |
Proporção 16:9. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
Proporção 21:9. |
ASPECT_RATIO_ONE_BY_EIGHT |
Proporção 1:8. |
ASPECT_RATIO_EIGHT_BY_ONE |
Proporção 8:1. |
ASPECT_RATIO_ONE_BY_FOUR |
Proporção 1:4. |
ASPECT_RATIO_FOUR_BY_ONE |
Proporção 4:1. |
ImageSize
Tamanhos de imagem aceitos 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 da imagem de 1K. |
IMAGE_SIZE_TWO_K |
Tamanho da imagem em 2K. |
IMAGE_SIZE_FOUR_K |
Tamanho da imagem 4K. |
TranslationConfig
Configuração para recursos de tradução.
targetLanguageCode
string
Obrigatório. O idioma de destino da tradução. Os valores aceitos 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 de destino for falado, essencialmente repetindo a entrada. Se for "false", não vamos produzir áudio no idioma de destino.
| Representação JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
A configuração de transcrição de áudio.
languageCodes[]
string
Opcional. Códigos de idioma BCP-47 que fornecem dicas sobre os idiomas presentes no áudio. Se for omitido ou ficar em branco, 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 polarizar o modelo de reconhecimento de fala e 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 locutor.
language_config
Union type
language_codes de nível superior. language_config pode ser apenas de um dos tipos a seguir:languageAuto
(deprecated)
object (LanguageAuto)
Opcional. O modelo detecta 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, // language_config "languageAuto": { object ( |
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 ] } |
RealtimeInputConfig
Configura o comportamento de entrada em tempo real em BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
Opcional. Se não for definido, 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 indicadores 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.
| Representação JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
Configura a detecção automática de atividade.
disabled
boolean
Opcional. Se ativada (como é o padrão), a entrada de voz e texto detectada conta como atividade. Se estiver desativado, o cliente precisará enviar indicadores de atividade.
startOfSpeechSensitivity
enum (StartSensitivity)
Opcional. Determina a probabilidade de a fala ser detectada.
prefixPaddingMs
integer
Opcional. A duração necessária da fala detectada antes do início da fala ser confirmado. Quanto menor esse valor, mais sensível é a detecção do início da 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 do silêncio detectado antes do fim da fala. Quanto maior esse valor, mais longos podem ser os intervalos de 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 detectar 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 processar 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 está 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 atividade de áudio e todos os vídeos desde a última vez. 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 comprimento.
compression_mechanism
Union type
compression_mechanism pode ser apenas de um dos tipos a seguir: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 compressão causa um aumento temporário da latência e, portanto, não deve ser acionada 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 começa no início de uma vez do papel de USUÁRIO. As instruções do sistema e qualquer BidiGenerateContentSetup.prefix_turns sempre vão ficar no início do resultado.
targetTokens
string (int64 format)
O número de destino de tokens a serem mantidos. O valor padrão é triggerTokens/2.
Descartar partes da janela de contexto causa um aumento temporário na latência. Portanto, 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, a princípio, processar mensagens clientContent até que turnComplete seja true. Esse histórico inicial não vai acionar uma chamada de modelo e pode terminar com a função 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 em sessões BidiGenerateContent serão rejeitadas. O Gemini pode fechar a sessão antes desse período.
Se não for definido, o padrão será 30 minutos no futuro. Se definido, esse valor precisa ser menor que 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 período após o qual novas sessões da API Live usando o token resultante desta solicitação serão rejeitadas.
Se não for definido, o padrão será 60 segundos no futuro. Se definido, esse valor precisa ser menor que 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á extraída 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
config pode ser apenas de um dos tipos a seguir: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 um 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.