Method: models.countTokens

对输入内容运行模型的标记生成器，并返回词元计数。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
model

string

必需。模型的资源名称。这充当要使用的模型的 ID。

此名称应与 models.list 方法返回的模型名称一致。

格式：models/{model}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "generateContentRequest": {
    object (GenerateContentRequest)
  }
}
字段
contents[]

object (Content)

可选。作为提示提供给模型的输入。如果设置了 generateContentRequest，系统会忽略此字段。
generateContentRequest

object (GenerateContentRequest)

可选。提供给模型的总体输入。models.countTokens 可统计提示、函数调用等。

响应正文

来自 models.countTokens 的回复。

它会针对 prompt 返回模型的 tokenCount。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "totalTokens": integer
}
字段
totalTokens

integer

model 将 prompt 标记化为的词元数量。

始终为非负数。设置 cacheContent 后，这仍是总有效提示大小。也就是说，这包括缓存内容中的令牌数量。

授权范围

需要以下 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

如需了解详情，请参阅身份验证概览。

GenerateContentRequest

请求根据模型生成补全。

JSON 表示法 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "generationConfig": {
    object (GenerationConfig)
  }
}
字段
model

string

必需。用于生成补全的 Model 的名称。

格式：name=models/{model}。
contents[]

object (Content)

必需。当前与模型对话的内容。

对于单轮查询，这是指单个实例。对于多轮查询，此字段是重复字段，包含对话记录和最新请求。
safetySettings[]

object (SafetySetting)

可选。用于屏蔽不安全内容的唯一 SafetySetting 实例的列表。

这将在 GenerateContentRequest.contents和 GenerateContentResponse.candidates上强制执行。每种 SafetyCategory 类型只能有一项设置。此 API 将屏蔽任何未达到这些设置所设阈值的内容和响应。此列表会替换 safetySettings 中指定的每个 SafetyCategory 的默认设置。如果列表中提供的给定 SafetyCategory 没有 SafetySetting，该 API 将使用该类别的默认安全设置。支持危害类别 HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT。
generationConfig

object (GenerationConfig)

可选。用于模型生成和输出的配置选项。