Skip to content

ウェブ検索

POST
/v1/messages
  • Anthropic Messages API の ウェブ検索(Web Search)インターフェース(ネイティブ形式)
  • toolsweb_search ツールを設定すると、モデルがネット上の情報を検索して質問に回答できます
  • modelmessages は必須。max_tokens の設定を推奨します
  • 公式ドキュメント: Web search tool

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。
各入力メッセージに対して生成するチャット補完の選択肢数。

デフォルトは false。設定すると ChatGPT のように部分メッセージの差分が送信されます。トークンは data: [DONE] で終了するサーバー送信イベントとして送信されます。Python コード例を参照。

デフォルトは 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 でバックエンド変更を監視してください。

モデルが呼び出せるツールのリスト。ウェブ検索には web_search タイプのツールが必要です。

モデルが呼び出す関数(あれば)を制御します。none は関数を呼ばずメッセージを生成、auto は選択、{"type": "function", "function": {"name": "my_function"}} で特定関数を強制。関数がなければデフォルト none、あれば auto

Responses

application/json
object
object[]
Required
object
Required

Playground

Authorization
Body

Samples