Method: models.countTokens

Executa o tokenizador de um modelo no conteúdo de entrada e retorna a contagem de tokens.

Solicitação HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTokens

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
model

string

Obrigatório. O nome do recurso do modelo. Isso serve como um ID a ser usado pelo modelo.

Esse nome precisa corresponder ao nome de um modelo retornado pelo método models.list.

Formato: models/{model}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "generateContentRequest": {
    object (GenerateContentRequest)
  }
}
Campos
contents[]

object (Content)

Opcional. A entrada dada ao modelo como comando. Este campo é ignorado quando generateContentRequest é definido.

generateContentRequest

object (GenerateContentRequest)

Opcional. A entrada geral fornecida ao modelo. models.countTokens contará o comando, a chamada de função etc.

Corpo da resposta

Uma resposta de models.countTokens.

Ele retorna o tokenCount do modelo para o prompt.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "totalTokens": integer
}
Campos
totalTokens

integer

O número de tokens em que o model tokeniza o prompt.

Sempre não negativo.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Para saber mais, consulte a Visão geral da autenticação.

GenerateContentRequest

Solicitação para gerar uma conclusão do modelo.

Representação JSON
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  }
}
Campos
model

string

Obrigatório. O nome do Model a ser usado para gerar a conclusão.

Formato: name=models/{model}.

contents[]

object (Content)

Obrigatório. O conteúdo da conversa atual com o modelo.

Para consultas de turno único, esta é uma instância única. Para consultas com várias interações, esse é um campo repetido que contém o histórico da conversa e a solicitação mais recente.

tools[]

object (Tool)

Opcional. Uma lista de Tools que o modelo pode usar para gerar a próxima resposta.

Um Tool é um trecho de código que permite que o sistema interaja com sistemas externos para realizar uma ação ou conjunto de ações fora do conhecimento e do escopo do modelo. No momento, a única ferramenta com suporte é Function.

toolConfig

object (ToolConfig)

Opcional. Configuração de ferramenta para qualquer Tool especificado na solicitação.

safetySettings[]

object (SafetySetting)

Opcional. Uma lista de instâncias SafetySetting exclusivas para bloquear conteúdo não seguro.

Isso será aplicado ao GenerateContentRequest.contents e ao GenerateContentResponse.candidates. Não deve haver mais de uma configuração para cada tipo de SafetyCategory. A API bloqueará qualquer conteúdo e respostas que não atendam aos limites definidos por essas configurações. Essa lista substitui as configurações padrão de cada SafetyCategory especificada nas SafetySettings. Se não houver uma SafetySetting para uma determinada SafetyCategory na lista, a API vai usar a configuração de segurança padrão para essa categoria. As categorias de danos HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT e HARM_CATEGORY_HARASSMENT são aceitas.

systemInstruction

object (Content)

Opcional. Instrução do sistema do conjunto do desenvolvedor. No momento, somente texto.

generationConfig

object (GenerationConfig)

Opcional. Opções de configuração para geração e saídas de modelos.