APIドキュメント：チャット補完の作成（Function Calling）

エンドポイントの説明

プロンプトが提供されると、モデルは1つまたは複数の予測される補完結果を返します。また、各位置の代替トークンの確率を返すこともできます。このエンドポイントは特に**関数呼び出し（Function Calling）**機能をサポートしており、モデルがメッセージの生成と指定された関数の呼び出しをインテリジェントに選択できるようにします。

• 公式リファレンス：Function Calling Guide

基本情報

• リクエストメソッド：POST
• エンドポイント：https://api.codingplanx.ai/v1/chat/completions
• データフォーマット：application/json

---

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

---

リクエストボディ (Body)

リクエストボディのサンプル

{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful customer support assistant. Use the supplied tools to assist the user."
        },
        {
            "role": "user",
            "content": "Hi, can you tell me the delivery date for my order?"
        },
        {"role": "assistant", "content": "Hi there! I can help with that. Can you please provide your order ID?"},
        {"role": "user", "content": "i think it is order_12345"}
    ],
    "tools": [
        {
            "type": "function",
            "function": {
                "name": "get_delivery_date",
                "description": "Get the delivery date for a customer's order. Call this whenever you need to know the delivery date, for example when a customer asks 'Where is my package'",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "order_id": {
                            "type": "string",
                            "description": "The customer's order ID."
                        }
                    },
                    "required": [
                        "order_id"
                    ],
                    "additionalProperties": false
                }
            }
        }
    ]
}

---

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

レスポンスのサンプル (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: 特定の関数を強制的に呼び出すにはどうすればよいですか？ A: tool_choice パラメータを設定することで実現できます。例えば、関数名が get_weather の場合、tool_choice を {"type": "function", "function": {"name": "get_weather"}} に設定します。これにより、モデルは通常の応答を無視し、強制的に該当する関数のパラメータを出力します。

Q2: 応答内容が途中で途切れてしまうのはなぜですか？ A: レスポンス内の choices[0].finish_reason の値を確認してください。"length" の場合、生成されたテキストが設定した max_tokens パラメータの制限を超えたか、モデルのコンテキストの最大長に達したことを示しています。max_tokens の値を大きくして試してみてください。

Q3: temperature と top_p はどちらもランダム性を制御しますが、どのように使い分ければよいですか？ A: これら2つのパラメータは、どちらもモデル出力の多様性を調整します。高い値はより創造的な出力を生成し、低い値はより厳密で決定的な出力を生成します。公式には、どちらか一方のパラメータのみを調整し、もう一方はデフォルト値のままにすることが推奨されています。予期せぬ結果を防ぐため、両方を同時に変更しないでください。

Q4: stream: true を有効にした場合、エンドポイントが返すデータフォーマットはどのようになりますか？ A: ストリーミング転送を有効にすると、エンドポイントは単一のJSONオブジェクトを返すのではなく、Server-Sent Events (SSE) のデータストリームを返します。データは data: {"id": "...", "choices": [{"delta": {"content": "..."}}]} の形式でチャンクごとに送信されます。転送が完了すると、最後のメッセージとして data: [DONE] が送信されます。

Q5: response_format で JSON モードを有効にする際の注意点は何ですか？ A: response_format を { "type": "json_object" } に設定する場合、messages（システムプロンプトまたはユーザープロンプト）内で、JSON形式のデータを生成するようにモデルへ明確に指示する必要があります。そうしないと、モデルが空白文字を生成する無限ループに陥り、リクエストがタイムアウトしたり、トークン上限に達したりする可能性があります。