チャット画像認識の作成（ストリーミング対応）Base64

エンドポイント概要： プロンプトを指定すると、モデルは1つまたは複数の予測されるコンプリーション（生成テキスト）を返します。また、各位置における代替トークンの確率を返すことも可能です。このエンドポイントは主に、画像認識（Base64ベース）とテキストプロンプトを含む対話生成の作成に使用されます。

公式リファレンス：OpenAI API ドキュメント

---

エンドポイント詳細

• リクエストメソッド：POST
• リクエストURL：https://api.codingplanx.ai/v1/chat/completions
• データ形式：application/json

---

リクエストヘッダー (Request Headers)

---

リクエストパラメータ (Request Body)

---

リクエスト例

{
  "model": "gpt-4o-mini",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "この画像には何が写っていますか？詳細に説明してください。"
        },
        {
          "type": "image_url",
          "image_url": {
            "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAiEAAAIhCAYAAACYF2qHAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAgAElEQVR4nOy9ebxtWVXf+x1zrrX2Pud2VRQUjUVf0glIYvOJLdJ8iCagIor... (ここは長すぎるため省略されたBase64文字列)"
          }
        }
      ]
    }
  ]
}

---

レスポンスパラメータ (Response Body)

---

レスポンス例 (成功 200 OK)

{
    "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
    }
}

---

よくある質問 (FAQ)

Q1: ストリーミング出力（Streaming）を有効にするには？ A: リクエストボディの stream パラメータを true に設定します。有効にすると、APIは回答全体の生成を待たずに、サーバー送信イベント（Server-Sent Events, SSE）を通じて data: {...} 形式のデータチャンクを逐次返し、data: [DONE] のフラグを受信した時点で生成を終了します。

Q2: 画像認識時のBase64エンコードにおける要件は？ A: 画像のBase64文字列には、data:image/png;base64, や data:image/jpeg;base64, のような正しいMIMEタイプのプレフィックスを含める必要があります。ネットワーク遅延と prompt_tokens の消費を抑えるため（サイズが大きすぎる画像は大量のトークンを消費し、コンテキスト制限を超える可能性があります）、Base64に変換する前に適切なサイズに画像を圧縮することを推奨します。

Q3: モデルの回答が途中で途切れてしまうのはなぜですか？ A: レスポンスボディ内の choices[0].finish_reason の値を確認してください。length の場合、生成されたテキストが設定した max_tokens の上限に達したか、対話全体がモデルの最大コンテキストウィンドウ制限を超過したことを意味します。max_tokens の値を大きくすることで解決できる場合があります。

Q4: モデルにJSON形式でデータを出力させるには？ A: まず、リクエストボディで "response_format": { "type": "json_object" } を設定する必要があります。【重要】：このパラメータの設定に加えて、messages のシステムプロンプト (system prompt) またはユーザープロンプト内で、自然言語を用いてJSONを出力するようモデルに明示的に指示する必要があります（例：「結果をJSON形式で出力してください」）。これを行わないと、モデルはトークンを使い果たすまで無限に空白を生成し続ける可能性があります。

Q5: 401 Unauthorized エラーが発生した場合はどうすればよいですか？ A: リクエストヘッダーの Authorization パラメータにAPIキーが正しく設定されているか確認してください。形式は厳密に Bearer あなたのAPI_KEY である必要があります（Bearer とAPIキーの間には半角スペースが1つ必要です）。