Skip to content

構造化出力の作成

POST
/v1/chat/completions
  • response_format で JSON Schema を指定し、モデル出力構造を制約
  • json_schema モードと strict: true で schema に厳密に従う
  • 非ストリーミングで、schema に準拠した補完を一度に取得
  • 公式ドキュメント:Structured Outputs

Authorizations

bearer
Type
HTTP (bearer)

Request Body

application/json
object

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

object[]
Required

これまでの会話に含まれるメッセージのリスト。

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

Nucleus sampling alternative to temperature. The model considers tokens with top_p probability mass (e.g. 0.1 = top 10%). We generally recommend changing this or temperature, but not both.

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

Default false. For structured outputs, omit or set false to receive the full schema-compliant completion in one response.

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

Default inf. Maximum tokens to generate in the completion.

Total length of input + output tokens is limited by the model context length.

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

デフォルト 0。-2.0〜2.0 の数値。テキスト内の出現頻度に基づき新トークンをペナルティし、繰り返しを減らします。

Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object mapping token IDs to bias values from -100 to 100. Applied to logits before sampling; effect varies by model.

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

出力形式を指定するオブジェクト。{ "type": "json_object" } で JSON モードを有効化。JSON モード使用時はシステムまたはユーザーメッセージで JSON 生成を指示する必要があります。json_schema で schema と strict: true により Structured Outputs を利用できます。

ベータ機能。指定すると同一シード・パラメータで繰り返しリクエストした際にできるだけ決定的にサンプリングします。system_fingerprint でバックエンド変更を監視してください。

モデルが呼び出せるツールのリスト。現在は関数のみツールとしてサポートされています。

呼び出す関数を制御。none = 関数呼び出しなし、auto = モデルが選択、{"type": "function", "function": {"name": "my_function"}} で強制。関数がない場合は none、ある場合は auto がデフォルト。

Responses

application/json
object
object[]
Required
object
Required

Playground

Authorization
Body

Samples