Chat Completions

Обзор

Эндпоинт Chat Completions — самый широко используемый API для взаимодействия с большими языковыми моделями. Он принимает разговор, состоящий из нескольких сообщений, и возвращает ответ модели. CometAPI маршрутизирует этот эндпоинт к нескольким провайдерам — включая OpenAI, Anthropic Claude (через слой совместимости), Google Gemini и других — через единый унифицированный интерфейс. Вы можете переключаться между моделями, просто изменяя параметр model.

Этот эндпоинт следует формату OpenAI Chat Completions. Большинство OpenAI-совместимых SDK и инструментов работают с CometAPI, если изменить base_url на https://api.cometapi.com/v1.

Важные примечания

Поведение, зависящее от модели — Разные модели могут поддерживать разные подмножества параметров и возвращать немного отличающиеся поля ответа. Например, reasoning_effort применяется только к reasoning-моделям (o-series, GPT-5.1+), а некоторые модели могут не поддерживать logprobs или n > 1.

Сквозная передача ответа — CometAPI передаёт ответы модели без изменений (за исключением нормализации формата при маршрутизации между провайдерами), гарантируя, что вы получите вывод, соответствующий оригинальному API.

Модели OpenAI Pro — Для моделей серии OpenAI Pro (например, o1-pro) вместо этого используйте эндпоинт responses.

Роли сообщений

Role	Description
`system`	Задаёт поведение и стиль assistant. Размещается в начале разговора.
`developer`	Заменяет `system` для более новых моделей (o1+). Содержит инструкции, которым модель должна следовать независимо от пользовательского ввода.
`user`	Сообщения от конечного пользователя.
`assistant`	Предыдущие ответы модели, используемые для сохранения истории разговора.
`tool`	Результаты вызовов tool/function. Должны включать `tool_call_id`, соответствующий исходному вызову tool.

Для более новых моделей (GPT-4.1, серия GPT-5, o-series) для сообщений с инструкциями предпочтительнее использовать developer, а не system. Оба варианта работают, но developer обеспечивает более строгое следование инструкциям.

Multimodal Input

Многие модели поддерживают изображения и аудио наряду с текстом. Используйте формат массива для content, чтобы отправлять multimodal-сообщения:

{
  "role": "user",
  "content": [
    {"type": "text", "text": "Describe this image"},
    {
      "type": "image_url",
      "image_url": {
        "url": "https://example.com/image.png",
        "detail": "high"
      }
    }
  ]
}

Параметр detail управляет глубиной анализа изображения:

low — быстрее, использует меньше tokens (фиксированная стоимость)
high — подробный анализ, расходуется больше tokens
auto — модель решает сама (по умолчанию)

Streaming

Когда stream установлен в true, ответ передается как Server-Sent Events (SSE). Каждое событие содержит объект chat.completion.chunk с инкрементальным содержимым:

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hello"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

Чтобы включить статистику использования token в Streaming-ответы, установите stream_options.include_usage в true. Данные usage появятся в финальном chunk перед [DONE].

Structured Outputs

Принудительно заставьте model возвращать корректный JSON, соответствующий определенной схеме, с помощью response_format:

{
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "result",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "answer": {"type": "string"},
          "confidence": {"type": "number"}
        },
        "required": ["answer", "confidence"],
        "additionalProperties": false
      }
    }
  }
}

Режим JSON Schema (json_schema) гарантирует, что вывод будет в точности соответствовать вашей схеме. Режим JSON Object (json_object) гарантирует только корректный JSON — структура при этом не проверяется.

Tool / Function Calling

Разрешите model вызывать внешние функции, передав определения инструментов:

{
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "Get current weather for a city",
        "parameters": {
          "type": "object",
          "properties": {
            "location": {"type": "string", "description": "City name"}
          },
          "required": ["location"]
        }
      }
    }
  ],
  "tool_choice": "auto"
}

Когда model решает вызвать инструмент, ответ будет содержать finish_reason: "tool_calls", а массив message.tool_calls будет включать имя функции и аргументы. Затем вы выполняете функцию и отправляете результат обратно как сообщение tool с соответствующим tool_call_id.

Response Fields

Поле	Описание
`id`	Уникальный идентификатор completion (например, `chatcmpl-abc123`).
`object`	Всегда `chat.completion`.
`model`	Model, сгенерировавшая ответ (может включать суффикс версии).
`choices`	Массив вариантов completion (обычно 1, если только `n` > 1).
`choices[].message`	Сообщение ответа assistant с `role`, `content` и, при необходимости, `tool_calls`.
`choices[].finish_reason`	Почему model остановилась: `stop`, `length`, `tool_calls` или `content_filter`.
`usage`	Детализация потребления token: `prompt_tokens`, `completion_tokens`, `total_tokens` и подробные подсчеты по категориям.
`system_fingerprint`	Отпечаток конфигурации backend для отладки воспроизводимости.

Примечания по разным провайдерам

Поддержка параметров у разных провайдеров

Parameter	OpenAI GPT	Claude (via compat)	Gemini (via compat)
`temperature`	0–2	0–1	0–2
`top_p`	0–1	0–1	0–1
`n`	1–128	Только 1	1–8
`stop`	До 4	До 4	До 5
`tools`	✅	✅	✅
`response_format`	✅	✅ (json_schema)	✅
`logprobs`	✅	❌	❌
`reasoning_effort`	o-series, GPT-5.1+	❌	❌ (используйте `thinking` для нативного Gemini)

max_tokens vs max_completion_tokens

max_tokens — Устаревший параметр. Работает с большинством моделей, но не рекомендуется для новых моделей OpenAI.
max_completion_tokens — Рекомендуемый параметр для GPT-4.1, серии GPT-5 и моделей o-series. Обязателен для reasoning-моделей, так как включает и output tokens, и reasoning tokens.

CometAPI автоматически сопоставляет параметры при маршрутизации к разным провайдерам.

role system vs developer

system — Традиционная роль для инструкций. Работает со всеми моделями.
developer — Появилась в моделях o1. Обеспечивает более точное следование инструкциям в новых моделях. В старых моделях ведет себя как system.

Используйте developer в новых проектах, ориентированных на GPT-4.1+ или модели o-series.

FAQ

Как обрабатывать ограничения по частоте запросов?

При возникновении 429 Too Many Requests реализуйте exponential backoff:

import time
import random
from openai import OpenAI, RateLimitError

client = OpenAI(
    base_url="https://api.cometapi.com/v1",
    api_key="<COMETAPI_KEY>",
)

def chat_with_retry(messages, max_retries=3):
    for i in range(max_retries):
        try:
            return client.chat.completions.create(
                model="gpt-5.4",
                messages=messages,
            )
        except RateLimitError:
            if i < max_retries - 1:
                wait_time = (2 ** i) + random.random()
                time.sleep(wait_time)
            else:
                raise

Как сохранять контекст диалога?

Включайте полную историю разговора в массив messages:

messages = [
    {"role": "developer", "content": "You are a helpful assistant."},
    {"role": "user", "content": "What is Python?"},
    {"role": "assistant", "content": "Python is a high-level programming language..."},
    {"role": "user", "content": "What are its main advantages?"},
]

Что означает `finish_reason`?

Value	Meaning
`stop`	Естественное завершение или срабатывание stop-последовательности.
`length`	Достигнут предел `max_tokens` или `max_completion_tokens`.
`tool_calls`	Модель вызвала один или несколько вызовов инструмента/функции.
`content_filter`	Вывод был отфильтрован в соответствии с политикой контента.

Как контролировать расходы?

Используйте max_completion_tokens, чтобы ограничить длину вывода.
Выбирайте экономичные модели (например, gpt-5.4-mini или gpt-5.4-nano для более простых задач).
Делайте Prompt краткими — избегайте избыточного контекста.
Отслеживайте использование токенов в поле usage ответа.

Авторизации

Authorization

string

header

обязательно

Bearer token authentication. Use your CometAPI key.

Тело

application/json

model

string

по умолчанию:gpt-5.4

обязательно

Model ID to use for this request. See the Models page for current options.

Пример:

"gpt-4.1"

messages

object[]

обязательно

A list of messages forming the conversation. Each message has a role (system, user, assistant, or developer) and content (text string or multimodal content array).

Show child attributes

stream

boolean

If true, partial response tokens are delivered incrementally via server-sent events (SSE). The stream ends with a data: [DONE] message.

temperature

number

по умолчанию:1

Sampling temperature between 0 and 2. Higher values (e.g., 0.8) produce more random output; lower values (e.g., 0.2) make output more focused and deterministic. Recommended to adjust this or top_p, but not both.

Требуемый диапазон: 0 <= x <= 2

top_p

number

по умолчанию:1

Nucleus sampling parameter. The model considers only the tokens whose cumulative probability reaches top_p. For example, 0.1 means only the top 10% probability tokens are considered. Recommended to adjust this or temperature, but not both.

Требуемый диапазон: 0 <= x <= 1

integer

по умолчанию:1

Number of completion choices to generate for each input message. Defaults to 1.

stop

string

Up to 4 sequences where the API will stop generating further tokens. Can be a string or an array of strings.

max_tokens

integer

Maximum number of tokens to generate in the completion. The total of input + output tokens is capped by the model's context length.

presence_penalty

number

по умолчанию:0

Number between -2.0 and 2.0. Positive values penalize tokens based on whether they have already appeared, encouraging the model to explore new topics.

Требуемый диапазон: -2 <= x <= 2

frequency_penalty

number

по умолчанию:0

Number between -2.0 and 2.0. Positive values penalize tokens proportionally to how often they have appeared, reducing verbatim repetition.

Требуемый диапазон: -2 <= x <= 2

logit_bias

object

A JSON object mapping token IDs to bias values from -100 to 100. The bias is added to the model's logits before sampling. Values between -1 and 1 subtly adjust likelihood; -100 or 100 effectively ban or force selection of a token.

user

string

A unique identifier for your end-user. Helps with abuse detection and monitoring.

max_completion_tokens

integer

An upper bound for the number of tokens to generate, including visible output tokens and reasoning tokens. Use this instead of max_tokens for GPT-4.1+, GPT-5 series, and o-series models.

response_format

object

Specifies the output format. Use {"type": "json_object"} for JSON mode, or {"type": "json_schema", "json_schema": {...}} for strict structured output.

Show child attributes

tools

object[]

A list of tools the model may call. Currently supports function type tools.

Show child attributes

tool_choice

по умолчанию:auto

Controls how the model selects tools. auto (default): model decides. none: no tools. required: must call a tool.

logprobs

boolean

по умолчанию:false

Whether to return log probabilities of the output tokens.

top_logprobs

integer

Number of most likely tokens to return at each position (0-20). Requires logprobs to be true.

Требуемый диапазон: 0 <= x <= 20

reasoning_effort

enum<string>

Controls the reasoning effort for o-series and GPT-5.1+ models.

Доступные опции:

low,

medium,

high

stream_options

object

Options for streaming. Only valid when stream is true.

Show child attributes

service_tier

enum<string>

Specifies the processing tier.

Доступные опции:

auto,

default,

flex,

priority

Ответ

200 - application/json

Successful chat completion response.

string

Unique completion identifier.

Пример:

"chatcmpl-abc123"

object

enum<string>

Доступные опции:

chat.completion

Пример:

"chat.completion"

created

integer

Unix timestamp of creation.

Пример:

1774412483

model

string

The model used (may include version suffix).

Пример:

"gpt-5.4-2025-07-16"

choices

object[]

Array of completion choices.

Show child attributes

usage

object

Show child attributes

service_tier

string

Пример:

"default"

system_fingerprint

string | null

Пример:

"fp_490a4ad033"

Обзор

Справочник API

Руководства по интеграции

Ошибки

Цены и оплата

Поддержка

Обзор

Важные примечания

Роли сообщений

Multimodal Input

Streaming

Structured Outputs

Tool / Function Calling

Response Fields

Примечания по разным провайдерам

FAQ

Как обрабатывать ограничения по частоте запросов?

Как сохранять контекст диалога?

Что означает `finish_reason`?

Как контролировать расходы?

Авторизации

Тело

Ответ

Обзор

Справочник API

Руководства по интеграции

Ошибки

Цены и оплата

Поддержка

​Обзор

​Важные примечания

​Роли сообщений

​Multimodal Input

​Streaming

​Structured Outputs

​Tool / Function Calling

​Response Fields

​Примечания по разным провайдерам

​FAQ

​Как обрабатывать ограничения по частоте запросов?

​Как сохранять контекст диалога?

​Что означает finish_reason?

​Как контролировать расходы?

Авторизации

Тело

Ответ

Обзор

Важные примечания

Роли сообщений

Multimodal Input

Streaming

Structured Outputs

Tool / Function Calling

Response Fields

Примечания по разным провайдерам

FAQ

Как обрабатывать ограничения по частоте запросов?

Как сохранять контекст диалога?

Что означает `finish_reason`?

Как контролировать расходы?