チャット補完 API ドキュメント (Chat Completions)

このエンドポイントは、指定されたプロンプト（Prompt）に対して、モデルが1つ以上の予測された補完結果を返します。会話履歴に基づいてテキストを生成し、生成プロセスのランダム性、長さ、フォーマットを制御できます。

• インターフェース名：モデル一覧 / チャット補完 (List Models / Chat Completions)
• リクエストメソッド：GET (注：提供されたデータ定義に基づく)
• リクエストURL：https://api.codingplanx.ai/v1/models
• ステータス：リリース済み (Released)

---

1. リクエストパラメータ

1.1 ヘッダーパラメータ

1.2 ボディパラメータ

元の定義は GET ですが、ビジネスロジックに基づき、以下のパラメータは通常 JSON ボディを通じて渡されます。

---

2. レスポンスパラメータ

---

3. リクエスト例

成功したリクエストの例

curl --location --request GET 'https://api.codingplanx.ai/v1/models' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data '{
  "model": "gpt-3.5-turbo",
  "messages": [
    {
      "role": "user",
      "content": "Hello there, how may I assist you today?"
    }
  ],
  "temperature": 1,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "user": "user-1234"
}'

成功したレスポンスの例

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

---

4. FAQ (よくある質問)

Q: ドキュメントには GET メソッドと記載されていますが、POST リクエストのように見えます。なぜですか？ A: 標準的な OpenAI の仕様では、補完の作成には通常 POST メソッドが使用されます。ただし、ご提供いただいたメタデータによると、このエンドポイントは GET として定義されています。呼び出しの際は、サーバー側の実際の構成を必ず確認してください。もし GET が機能しない場合は、POST を試してみてください。

Q: temperature と top_p はどのように設定すべきですか？ A: どちらか一方のみを調整することをお勧めします。より正確で決定論的な回答が必要な場合は、temperature を下げてください（例: 0.2）。より多様で創造的な回答が必要な場合は、値を上げることができます。

Q: JSON モードを有効にするにはどうすればよいですか？ A: response_format で { "type": "json_object" } を設定し、さらに messages の中（System または User メッセージ）で、モデルに対して JSON フォーマットを出力するよう明示的に指示する必要があります。そうしないと、モデルが解析エラーを起こしたり、無限に空白を生成したりする可能性があります。

Q: presence_penalty と frequency_penalty とは何ですか？ A:

• presence_penalty（存在ペナルティ）: すでに出現したトピックに対するペナルティを重視し、モデルが新しい話題について話すことを促します。
• frequency_penalty（頻度ペナルティ）: 繰り返し出現する語彙に対するペナルティを重視し、モデルが短時間で同じ文を繰り返すのを防ぎます。

Q: ストリーミング出力 (stream: true) はどのように機能しますか？ A: ストリーミングを有効にすると、API は Server-Sent Events (SSE) を通じてデータを1文字ずつ返します。各データブロックは data: で始まる JSON 文字列であり、最後に data: [DONE] で終了します。これは長文生成時のリアルタイム表示に非常に役立ちます。