Method: models.countTokens

入力コンテンツに対してモデルのトークナイザを実行し、トークン数を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
model

string

必須。モデルのリソース名。これは、モデルが使用する ID として機能します。

この名前は、models.list メソッドから返されるモデル名と一致する必要があります。

形式: models/{model}

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "generateContentRequest": {
    object (GenerateContentRequest)
  }
}
フィールド
contents[]

object (Content)

省略可。モデルにプロンプトとして与えられた入力。generateContentRequest が設定されている場合、このフィールドは無視されます。
generateContentRequest

object (GenerateContentRequest)

省略可。モデルに与えられる全体的な入力。モデル.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)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}
フィールド
model

string

必須。コンプリーションの生成に使用する Model の名前。

形式: name=models/{model}
contents[]

object (Content)

必須。モデルとの現在の会話の内容。

シングルターンのクエリの場合、これは単一のインスタンスです。マルチターン クエリの場合、これは会話履歴と最新のリクエストを含む繰り返しフィールドです。
tools[]

object (Tool)

省略可。モデルが次のレスポンスを生成するために使用できる Tools のリスト。

Tool は、システムが外部システムとやり取りして、モデルの知識や範囲外のアクションまたは一連のアクションを実行できるようにするコードです。現在サポートされているツールは Function のみです。
toolConfig

object (ToolConfig)

省略可。リクエストで指定された任意の Tool のツール構成。
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 をサポートしています。
systemInstruction

object (Content)

省略可。デベロッパーが設定するシステム指示。現在はテキストのみです。
generationConfig

object (GenerationConfig)

省略可。モデルの生成と出力の構成オプション。
cachedContent

string

省略可。予測を提供するコンテキストとして使用される、キャッシュに保存されたコンテンツの名前。注: 明示的キャッシュでのみ使用します。明示的キャッシュでは、ユーザーがキャッシュを制御（キャッシュするコンテンツなど）でき、確実な費用削減を実現できます。形式: cachedContents/{cachedContent}