Документация API: Создание вызова функции чата

Описание интерфейса

По заданному промпту (подсказке) модель возвращает один или несколько предсказанных вариантов ответа, а также может возвращать вероятности альтернативных токенов для каждой позиции. Данный API специально поддерживает функцию вызова функций (Function Calling), позволяя модели осуществлять интеллектуальный выбор между генерацией текстового сообщения и вызовом указанной функции.

• Официальная документация: Function Calling Guide

Основная информация

• Метод запроса: POST
• URL-адрес запроса: 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)

В1: Как заставить модель вызвать конкретную функцию, которую я указал? О: Вы можете сделать это, настроив параметр tool_choice. Например, если ваша функция называется get_weather, вы можете установить tool_choice следующим образом: {"type": "function", "function": {"name": "get_weather"}}. Таким образом, модель проигнорирует обычный текстовый ответ и принудительно выведет аргументы для этой функции.

В2: Почему мой ответ был обрезан (усечен)? О: Проверьте значение choices[0].finish_reason в объекте ответа. Если оно равно "length", это означает, что сгенерированный текст превысил ограничение параметра max_tokens, которое вы установили, или достиг максимальной длины контекста модели. Вы можете попробовать увеличить значение max_tokens.

В3: И temperature, и top_p контролируют случайность. Как мне их использовать? О: Оба этих параметра действительно регулируют разнообразие вывода модели. Более высокие значения делают вывод более креативным, а более низкие — более строгим и детерминированным. В официальной документации рекомендуется изменять только один из этих параметров, оставляя другой по умолчанию. Не изменяйте оба параметра одновременно, чтобы избежать непредсказуемых результатов.

В4: Какой формат данных возвращает API при включении stream: true? О: При включении потоковой передачи API больше не возвращает единый JSON-объект. Вместо этого он возвращает поток данных Server-Sent Events (SSE). Данные будут отправляться по частям (дельты) в формате data: {"id": "...", "choices": [{"delta": {"content": "..."}}]} . По завершении передачи последним сообщением будет data: [DONE].

В5: На что следует обратить внимание при включении режима JSON в response_format? О: Когда вы устанавливаете response_format в { "type": "json_object" }, вы должны явно проинструктировать модель генерировать данные в формате JSON в массиве messages (в системном или пользовательском промпте). Если этого не сделать, модель может застрять в бесконечном цикле, генерируя пробельные символы, что приведет к тайм-ауту запроса или достижению лимита токенов.