Batch Mode

A API Gemini é compatível com o modo em lote, que permite processar várias solicitações em uma única chamada. Para mais detalhes, consulte o guia do modo em lote.

Candidato

Um candidato a resposta gerado pelo modelo.

Campos
content object (Content)

Apenas saída. Conteúdo gerado retornado do modelo.

finishReason enum (FinishReason)

Opcional. Apenas saída. É o motivo pelo qual o modelo parou de gerar tokens.

Se estiver vazio, o modelo não parou de gerar tokens.

safetyRatings[] object (SafetyRating)

Lista de classificações para a segurança de um candidato a resposta.

Há no máximo uma classificação por categoria.

citationMetadata object (CitationMetadata)

Apenas saída. Informações de citação para o candidato gerado pelo modelo.

Esse campo pode ser preenchido com informações de recitação para qualquer texto incluído no content. São trechos "recitados" de material protegido por direitos autorais nos dados de treinamento do LLM de base.

tokenCount integer

Apenas saída. Contagem de tokens para este candidato.

groundingAttributions[] object (GroundingAttribution)

Apenas saída. Informações de atribuição para fontes que contribuíram para uma resposta embasada.

Esse campo é preenchido para chamadas GenerateAnswer.

groundingMetadata object (GroundingMetadata)

Apenas saída. Metadados de embasamento para o candidato.

Esse campo é preenchido para chamadas GenerateContent.

avgLogprobs number

Apenas saída. Pontuação média de probabilidade de registro do candidato.

logprobsResult object (LogprobsResult)

Apenas saída. Pontuações de verossimilhança de registro para os tokens de resposta e os principais tokens

urlContextMetadata object (UrlContextMetadata)

Apenas saída. Metadados relacionados à ferramenta de recuperação de contexto de URL.

index integer

Apenas saída. Índice do candidato na lista de candidatos de resposta.

Representação JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

FinishReason

Define o motivo pelo qual o modelo parou de gerar tokens.

Enums
FINISH_REASON_UNSPECIFIED Valor padrão. Esse valor não é usado.
STOP Ponto de parada natural do modelo ou sequência de paradas fornecida.
MAX_TOKENS O número máximo de tokens especificado na solicitação foi atingido.
SAFETY O conteúdo do candidato a resposta foi sinalizado por motivos de segurança.
RECITATION O conteúdo candidato à resposta foi sinalizado por motivos de recitação.
LANGUAGE O conteúdo da resposta candidata foi sinalizado por usar um idioma não aceito.
OTHER Motivo desconhecido.
BLOCKLIST A geração de tokens foi interrompida porque o conteúdo contém termos proibidos.
PROHIBITED_CONTENT A geração de tokens foi interrompida por conter conteúdo proibido.
SPII A geração de tokens foi interrompida porque o conteúdo pode conter informações sensíveis de identificação pessoal (SPII).
MALFORMED_FUNCTION_CALL A chamada de função gerada pelo modelo é inválida.
IMAGE_SAFETY A geração de tokens foi interrompida porque as imagens geradas contêm violações de segurança.
UNEXPECTED_TOOL_CALL O modelo gerou uma chamada de ferramenta, mas nenhuma ferramenta estava ativada na solicitação.

GroundingAttribution

Atribuição de uma fonte que contribuiu para uma resposta.

Campos
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)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

Identificador da origem que contribui para essa atribuição.

Campos
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)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

Identificador de uma parte em um GroundingPassage.

Campos
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.

Campos
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.

Campos
groundingChunks[] object (GroundingChunk)

Lista de referências de apoio recuperadas da fonte de embasamento especificada.

groundingSupports[] object (GroundingSupport)

Lista de suporte de embasamento.

webSearchQueries[] string

Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.

searchEntryPoint object (SearchEntryPoint)

Opcional. Entrada da Pesquisa Google para as pesquisas na Web de acompanhamento.

retrievalMetadata object (RetrievalMetadata)

Metadados relacionados à recuperação no fluxo de embasamento.

Representação JSON 
{
  "groundingChunks": [
    {
      object (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

Ponto de entrada da Pesquisa Google.

Campos
renderedContent string

Opcional. Snippet de conteúdo da Web que pode ser incorporado a uma página da Web ou a uma WebView de app.

sdkBlob string (bytes format)

Opcional. JSON codificado em Base64 que representa a matriz da tupla <termo de pesquisa, URL de pesquisa>.

Uma string codificada em base64.

Representação JSON 
{
  "renderedContent": string,
  "sdkBlob": string
}

GroundingChunk

Trecho de embasamento.

Campos
chunk_type Union type
Tipo de pedaço. chunk_type pode ser apenas de um dos tipos a seguir:
web object (Web)

Trecho de embasamento da Web.

Representação JSON 
{

  // chunk_type
  "web": {
    object (Web)
  }
  // Union type
}

Web

Trecho da Web.

Campos
uri string

Referência de URI do bloco.

title string

Título da parte.

Representação JSON 
{
  "uri": string,
  "title": string
}

GroundingSupport

Suporte de embasamento.

Campos
groundingChunkIndices[] integer

Uma lista de índices (em "grounding_chunk") que especificam as citações associadas à declaração. Por exemplo, [1,3,4] significa que grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] são o conteúdo recuperado atribuído à declaração.

confidenceScores[] number

Pontuação de confiança das referências de suporte. Varia de 0 a 1. 1 é o mais confiante. Essa lista precisa ter o mesmo tamanho que "groundingChunkIndices".

segment object (Segment)

Segmento do conteúdo a que este suporte pertence.

Representação JSON 
{
  "groundingChunkIndices": [
    integer
  ],
  "confidenceScores": [
    number
  ],
  "segment": {
    object (Segment)
  }
}

Segmento

Segmento do conteúdo.

Campos
partIndex integer

Apenas saída. O índice de um objeto "Part" no objeto "Content" principal.

startIndex integer

Apenas saída. Índice inicial na parte especificada, medido em bytes. Deslocamento do início da parte, inclusivo, começando em zero.

endIndex integer

Apenas saída. Índice final na parte especificada, medido em bytes. Deslocamento do início da parte, exclusivo, começando em zero.

text string

Apenas saída. O texto correspondente ao segmento da resposta.

Representação JSON 
{
  "partIndex": integer,
  "startIndex": integer,
  "endIndex": integer,
  "text": string
}

RetrievalMetadata

Metadados relacionados à recuperação no fluxo de embasamento.

Campos
googleSearchDynamicRetrievalScore number

Opcional. Pontuação que indica a probabilidade de as informações da Pesquisa Google ajudarem a responder ao comando. A pontuação está no intervalo [0, 1], em que 0 é o menos provável e 1 é o mais provável. Essa pontuação só é preenchida quando o embasamento da Pesquisa Google e a recuperação dinâmica estão ativados. Ele será comparado ao limite para determinar se a Pesquisa Google será acionada.

Representação JSON 
{
  "googleSearchDynamicRetrievalScore": number
}

LogprobsResult

Resultado de Logprobs

Campos
topCandidates[] object (TopCandidates)

Comprimento = número total de etapas de decodificação.

chosenCandidates[] object (Candidate)

Comprimento = número total de etapas de decodificação. Os candidatos escolhidos podem ou não estar em "topCandidates".

Representação JSON 
{
  "topCandidates": [
    {
      object (TopCandidates)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

TopCandidates

Candidatos com as principais probabilidades de registro em cada etapa de decodificação.

Campos
candidates[] object (Candidate)

Classificados por probabilidade logarítmica em ordem decrescente.

Representação JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ]
}

Candidato

Candidato ao token e à pontuação de logprobs.

Campos
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.

Campos
urlMetadata[] object (UrlMetadata)

Lista de contexto de URL.

Representação JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

Contexto de uma única recuperação de URL.

Campos
retrievedUrl string

URL recuperado pela ferramenta.

urlRetrievalStatus enum (UrlRetrievalStatus)

Status da recuperação do URL.

Representação JSON 
{
  "retrievedUrl": string,
  "urlRetrievalStatus": enum (UrlRetrievalStatus)
}

UrlRetrievalStatus

Status da recuperação do URL.

Enums
URL_RETRIEVAL_STATUS_UNSPECIFIED Valor padrão. Esse valor não é usado.
URL_RETRIEVAL_STATUS_SUCCESS A recuperação do URL foi concluída.
URL_RETRIEVAL_STATUS_ERROR A recuperação do URL falhou devido a um erro.

CitationMetadata

Uma coleção de atribuições de origem para um conteúdo.

Campos
citationSources[] object (CitationSource)

Citações de fontes para uma resposta específica.

Representação JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}

CitationSource

Uma citação de uma fonte para uma parte de uma resposta específica.

Campos
startIndex integer

Opcional. Início do segmento da resposta atribuído a esta fonte.

O índice indica o início do segmento, medido em bytes.

endIndex integer

Opcional. Fim do segmento atribuído, exclusivo.

uri string

Opcional. URI atribuído como fonte de uma parte do texto.

license string

Opcional. Licença do projeto do GitHub atribuído como uma fonte para o segmento.

As informações de licença são necessárias para citações de código.

Representação JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}

Recurso REST: lotes

Recurso: operação

Este recurso representa uma operação de longa duração resultante de uma chamada à API de rede.

Campos
name string

O nome atribuído pelo servidor, que é exclusivo somente no mesmo serviço que o retorna originalmente. Se você usar o mapeamento padrão de HTTP, name precisa ser um nome de recurso que termine com operations/{unique_id}.

metadata object

Metadados específicos do serviço associados à operação. Eles geralmente contêm informações sobre o progresso e metadados comuns, como a hora da criação. Em alguns serviços, esses metadados talvez não sejam fornecidos. Em qualquer método que retorna uma operação de longa duração, o tipo de metadados, se houver, deve ser documentado.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Se o valor for false, significa que a operação ainda está em andamento. Se for true, a operação será concluída e error ou response estarão disponíveis.

result Union type
O resultado da operação, que pode ser um error ou uma response válida. Se done == false, nem error ou response estão definidos. Se done == true, será possível definir exatamente um entre error ou response. Alguns serviços podem não fornecer o resultado. result pode ser apenas um dos seguintes:
error object (Status)

Resultado do erro da operação em caso de falha ou cancelamento.

response object

A resposta normal e bem-sucedida da operação. Se o método original não retornar dados em caso de êxito, como Delete, a resposta será google.protobuf.Empty. Se o método original for Get/Create/Update padrão, a resposta será o recurso. Para outros métodos, a resposta precisa ser do tipo XxxResponse, em que Xxx é o nome do método original. Por exemplo, se o nome do método original for TakeSnapshot(), o tipo inferido de resposta será TakeSnapshotResponse.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Representação JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Método: batches.get

Recebe o estado mais recente de uma operação de longa duração. Os clientes usam este método para pesquisar o resultado da operação em intervalos, conforme recomendado pelo serviço da API.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Parâmetros de caminho

name string

O nome do recurso de operação. Ele tem o formato batches/{batches}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Método: batches.list

Lista as operações correspondentes ao filtro especificado na solicitação. Se o servidor não for compatível com esse método, ele retornará UNIMPLEMENTED.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

Parâmetros de caminho

name string

O nome do recurso pai da operação. Ele tem o formato batches.

Parâmetros de consulta

filter string

O filtro de lista padrão.

pageSize integer

O tamanho de página de lista padrão.

pageToken string

O token de página de lista padrão.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListOperationsResponse.

Método: batches.cancel

Inicia o cancelamento assíncrono de uma operação de longa duração. São feitas várias tentativas para cancelar a operação no servidor, mas o sucesso não é garantido. Se o servidor não for compatível com esse método, ele retornará google.rpc.Code.UNIMPLEMENTED. Os clientes podem usar Operations.GetOperation ou outros métodos para verificar se o cancelamento ocorreu ou se a operação foi concluída mesmo com o cancelamento. Caso o cancelamento ocorra, a operação não será excluída. Em vez disso, ela se tornará uma operação com um valor Operation.error que tem um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

Parâmetros de caminho

name string

O nome do recurso de operação a ser cancelado. Ele tem o formato batches/{batches}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta será um objeto JSON vazio.

Método: batches.delete

Exclui uma operação de longa duração. Este método indica que o cliente não está mais interessado no resultado da operação. Ele não cancela a operação. Se o servidor não for compatível com esse método, ele retornará google.rpc.Code.UNIMPLEMENTED.

Endpoint

delete https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Parâmetros de caminho

name string

O nome do recurso de operação que será excluído. Ele tem o formato batches/{batches}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta será um objeto JSON vazio.