技術資料

OpenAI の Chat Completions API では、レスポンスの形式を JSON に固定することができます。

APIへのリクエストで、response_format パラメータを指定することで、レスポンスを JSON形式 に設定できます。

PHP での実装例

以下は、PHP で OpenAI の Chat Completions API を使って、レスポンスを JSON形式 に固定するコードの例です。

$openai_key = 'sk-proj--1234567890abcdefg';

$data = array(
	'model' => 'gpt-4o-mini',
	'messages' => $prompts,
	'temperature' => 1.0,
	'response_format' => ['type' => 'json_object'],
);
$json_data = json_encode($data);
$url = 'https://api.openai.com/v1/chat/completions';
$headers = array(
	'Content-Type: application/json',
	"Authorization: Bearer ".$openai_key
);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 300);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 300);
$response = curl_exec($ch);
if($response === false){
	echo 'Curl error: ' . curl_error($ch);
	exit;
}
curl_close($ch);
$apiresult = json_decode($response);
return json_decode($apiresult->choices[0]->message->content);

このコードでは、response_format パラメータに ['type' => 'json_object'] を指定しています。これにより、APIのレスポンスが JSON形式 に固定されます。

そもそものAPIのレスポンス全体がJSON形式で返ってくる上に、その中のAIによる生成結果も二重でJSON形式で返ってくるので、json_decode を二回使って、最終的な結果を取得しています。

プロンプトの例

API に投げるプロンプトの一例。

日本のレコード会社の商品情報データベースの表示確認のために、架空の商品情報のテストデータを作成してください。

# 出力形式
JSON形式で以下のデータを出力してください。
- `title`: 商品タイトル
- `artist`: アーティスト名
- `release_date`: リリース日（YYYY-MM-DD形式）
- `genre`: ジャンル
- `price`: 価格（整数）
- `label`: レーベル名
- `description`: 商品説明

# 出力例
```json
{
    "title": "夏の光線",
    "artist": "青空アンサンブル",
    "release_date": "2025-07-15",
    "genre": "J-POP",
    "price": 3300,
    "label": "サンシャインミュージック",
    "description": "注目の新人バンド・青空アンサンブルの待望のデビューアルバム。夏をテーマにした爽やかなメロディと心に響く歌詞が特徴の全12曲を収録。"
}
```

こんな感じで、システムの表示確認のために「それっぽい」テストデータを量産したい時とかに重宝します。

注意点

今回は response_format パラメータに ['type' => 'json_object'] を指定する方法を紹介しましたが、新しめのモデルでは、['type' => 'json_schema'] を指定することもできます。これにより、より厳密な JSON スキーマに基づいたレスポンスが得られます。

詳しくはStructured Outputs - OpenAI API を参照。