Skip to content

関数呼び出しの作成(ストリーミング)

POST
/v1/messages
  • Anthropic Messages API の ツール利用(Tool Use)ストリーミングエンドポイント(ネイティブ形式)
  • tools で呼び出し可能なツール定義(namedescriptioninput_schema)を宣言
  • リクエストボディで stream: true を設定し、ツール呼び出しとモデル応答を SSE でストリーミング返却
  • 公式ドキュメント: Tool use

Authorizations

bearer
Type
HTTP (bearer)

Request Body

application/json
object

使用するモデルの ID。チャット API で利用可能なモデルはモデルエンドポイント互換性表を参照してください。

object[]
Required

これまでの会話を構成するメッセージのリスト。Python コード例。

0 から 2 の間のサンプリング温度。高い値(例: 0.8)は出力をよりランダムに、低い値(例: 0.2)はより集中的で決定的にします。通常は top_p またはこちらのどちらか一方のみ変更することを推奨します。

温度に代わる核サンプリング。モデルは top_p の確率質量内のトークンを考慮します。0.1 は上位 10% の確率質量のみを意味します。通常は temperature またはこちらのどちらか一方のみ変更することを推奨します。

デフォルト 1
各入力メッセージに対して生成するチャット補完の選択肢数。

ツール呼び出しストリーミング API では true を設定。SSE で部分メッセージの差分を送信し、data: [DONE] でストリームを終了します。

デフォルト null。API がこれ以上トークンを生成しない最大 4 シーケンス。

デフォルト inf
チャット補完で生成する最大トークン数。

入力トークンと生成トークンの合計長はモデルのコンテキスト長に制限されます。トークン数を数える Python コード例。

-2.0 から 2.0 の数値。正の値はこれまでのテキストに出現したかどうかに基づいて新しいトークンをペナルティし、新しいトピックについて話す可能性を高めます。頻度・存在ペナルティの詳細

デフォルト 0。-2.0 から 2.0 の数値。正の値はテキスト内の出現頻度に基づいて新しいトークンをペナルティし、同じ行の繰り返しを減らします。頻度・存在ペナルティの詳細。

補完に特定のトークンが出現する可能性を変更します。

トークナイザーで指定されたトークン ID を関連するバイアス値(-100 から 100)にマッピングする JSON オブジェクトを受け付けます。バイアスはサンプリング前に logit に加算されます。効果はモデルにより異なります。

エンドユーザーを表す一意の識別子。OpenAI の監視・不正利用検出に役立ちます。詳細

モデルが出力しなければならない形式を指定するオブジェクト。{ "type": "json_object" } を設定すると JSON モードが有効になり、モデルメッセージが有効な JSON になります。JSON モード使用時はシステムまたはユーザーメッセージで JSON 生成を指示してください。

ベータ機能。指定すると、同じシードとパラメータの繰り返しリクエストが同じ結果を返すよう決定的サンプリングを試みます。決定性は保証されません。system_fingerprint レスポンスパラメータでバックエンドの変更を監視してください。

モデルが呼び出せるツールのリスト。現在は関数のみツールとしてサポート。モデルが JSON 入力を生成できる関数を提供します。

モデルが呼び出す関数(あれば)を制御。none は関数を呼ばずメッセージのみ生成。auto はメッセージと関数の選択を許可。{"type": "function", "function": {"name": "my_function"}} で関数を強制。関数がない場合は none、ある場合は auto がデフォルト。

Responses

application/json
object
object[]
Required
object
Required

Playground

Authorization
Body

Samples