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 代碼化的符記數量。

永遠不得為負數。

授權範圍

需要下列其中一種 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)

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