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)

選用設定。model.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)

選用設定。模型產生和輸出的設定選項。