メソッド: models.countTokens
- エンドポイント
- パスパラメータ
- リクエスト本文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- レスポンスの本文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- 認可スコープ
- リクエストの例 <ph type="x-smartling-placeholder">
- GenerateContentRequest
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
入力コンテンツに対してモデルのトークナイザを実行し、トークン数を返します。
エンドポイント
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTokens
パスパラメータ
model
string
必須。モデルのリソース名。これは、モデルが使用する ID として機能します。
この名前は、models.list
メソッドから返されるモデル名と一致する必要があります。
形式: models/{model}
。models/{model}
の形式になります。
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
<ph type="x-smartling-placeholder">contents[]
object (Content
)
省略可。モデルにプロンプトとして与えられた入力。generateContentRequest
が設定されている場合、このフィールドは無視されます。
generateContentRequest
object (GenerateContentRequest
)
省略可。モデルに与えられた全体的な入力。models.countTokens は、プロンプトや関数の呼び出しなどをカウントします。
リクエスト例
テキスト
Python
Node.js
Shell
Kotlin
Swift
Dart
Java
チャット
Python
Node.js
Shell
Kotlin
Swift
Dart
Java
インライン メディア
Python
Node.js
Kotlin
Swift
Dart
Java
ファイル
Python
Node.js
キャッシュ
Python
Node.js
システム命令
Python
Node.js
Kotlin
Swift
Dart
Java
ツール
Python
Node.js
Kotlin
Swift
Dart
Java
レスポンスの本文
models.countTokens
からのレスポンス。
prompt
に対するモデルの tokenCount
を返します。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
totalTokens
integer
model
が prompt
をトークン化するトークンの数。
常に負数ではありません。cacheContent が設定されている場合でも、これは有効なプロンプトの合計サイズです。例:これには、キャッシュに保存されたコンテンツ内のトークンの数も含まれます。
JSON 表現 |
---|
{ "totalTokens": integer } |
GenerateContentRequest
モデルから補完を生成するリクエスト。
JSON 表現 |
---|
{ "model": string, "contents": [ { object ( |
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}