チャット補完の作成（ストリーミング）

公式ドキュメント参考: OpenAI Chat Create

エンドポイントの概要

プロンプト（Prompt）を指定すると、モデルは1つまたは複数の予測される補完された会話コンテンツを返します。このエンドポイントは、標準のレスポンスとストリーミング（SSE）レスポンスの両方をサポートしており、さらに各位置の代替トークンの確率を返すこともできます。

リクエスト仕様

• HTTPメソッド: POST
• エンドポイントURL: https://api.codingplanx.ai/v1/chat/completions

ヘッダー (Headers)

リクエストボディ (Request Body)

リクエスト例

{
  "model": "gpt-5-mini",
  "max_tokens": 1000,
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "你好"
    }
  ],
  "temperature": 1.0,
  "stream": true,
  "stream_options": {
    "include_usage": true
  }
}

---

レスポンス仕様

• Content-Type: application/json （非ストリーミング） または text/event-stream （ストリーミング stream: true の場合）

レスポンスパラメータ (非ストリーミング構造)

レスポンス例 (非ストリーミング / 集約されたストリーミング結果)

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\r
\r
Hello there, how may I assist you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}

（注：リクエストで stream: true が指定された場合、レスポンスボディは改行で区切られたSSEイベントストリームとなり、各行は data: {...} で始まり、最後に data: [DONE] で終了します。）

---

FAQs（よくある質問）

Q1: stream: true を有効にしたストリーミングレスポンスをどのように解析しますか？ A: stream: true を有効にすると、APIはServer-Sent Events（SSE）プロトコルを通じてデータを返します。クライアントはレスポンスストリームを1行ずつ読み取り、data: プレフィックスで始まる文字列を探してJSONとして解析する必要があります。データストリームの最後のメッセージは常に data: [DONE] であり、ストリームの終了を示します。解析時にこの終了マーカーを除外するようにしてください。

Q2: response_format をJSONに設定した後、リクエストがフリーズしたり、無限に空白がストリーミングされたりするのはなぜですか？ A: { "type": "json_object" } を使用してJSONモードを有効にする場合、渡される messages（通常はシステムプロンプト）内で「JSON形式で出力してください」とモデルに明示的に指示する必要があります。関連するテキストプロンプトがない場合、モデルは混乱し、max_tokens 制限に達するまで無限に空白文字を生成し続ける可能性があります。

Q3: temperature と top_p パラメータは同時に調整できますか？ A: 公式ドキュメントでは、この2つのパラメータを同時に調整しないことを強く推奨しています。どちらもモデルの出力のランダム性を制御するためのメカニズムです。出力をより安定させ、予測可能にしたい場合は temperature を下げるか、top_p を小さくします。より創造的な回答を得たい場合は、どちらか一方を高くします。両方を同時に変更すると、結果が予測困難になります。

Q4: パラメータの extra_body.enable_thinking の役割は何ですか？ A: これは本エンドポイントの特別な拡張パラメータです。{"enable_thinking": true} を渡した際、バックエンドで現在使用されているモデルが「思考モード（Thinking Mode / CoT）」（推論強化型の大規模モデルなど）をサポートしている場合、モデルは深い思考プロセスを開始します。モデルがサポートしていない場合、このパラメータは通常無視されます。

Q5: レスポンスの finish_reason が stop ではなく length になるのはなぜですか？ A: finish_reason が length を返す場合、モデルが完全な返答を生成する前に強制的に切り捨てられたことを示します。これは通常、max_tokens パラメータの設定値が小さすぎるか、入力と生成されたトークンの合計数が現在のモデルで許可されている最大コンテキストウィンドウの制限を超えたことが原因です。max_tokens の値を増やしてみてください。