88API88API
Руководство пользователяAI-приложенияAPIПомощь и поддержка
Чат (Chat)

Формат разговора OpenAI (завершение чата)

Официальная документация

📝 Введение

Учитывая список сообщений, содержащих разговор, модель возвращает ответ. Соответствующие руководства можно найти на официальном сайте OpenAI: Завершение чата

💡 Пример запроса

Базовый текстовый разговор ✅

curl https://api.88api.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {
        "role": "developer",
        "content": "你是一个有帮助的助手。"
      },
      {
        "role": "user",
        "content": "你好!"
      }
    ]
  }'

Пример ответа:

{
  "id": "chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "gpt-5.5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好!我能为你提供什么帮助?",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  },
  "service_tier": "default"
}

Диалог анализа изображения ✅

curl https://api.88api.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": "这张图片里有什么?"
          },
          {
            "type": "image_url",
            "image_url": {
              "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
            }
          }
        ]
      }
    ],
    "max_tokens": 300
  }'

Пример ответа:

{
  "id": "chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG",
  "object": "chat.completion",
  "created": 1741570283,
  "model": "gpt-5.5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "图片展示了一条穿过茂密绿色草地或草甸的木制栈道。天空湛蓝,点缀着几朵散落的云彩,给整个场景营造出宁静祥和的氛围。背景中可以看到树木和灌木丛。",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1117,
    "completion_tokens": 46,
    "total_tokens": 1163,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  },
  "service_tier": "default",
  "system_fingerprint": "fp_fc9f1d7035"
}

Ответ в потоковом режиме ✅

curl https://api.88api.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {
        "role": "developer",
        "content": "你是一个有帮助的助手。"
      },
      {
        "role": "user",
        "content": "你好!"
      }
    ],
    "stream": true
  }'

Пример ответа потоковой передачи:

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.5", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]}

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.5", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Привет"},"logprobs":null,"finish_reason":null}]}

// ... Больше блоков данных ...

{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.5", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}

Вызов функции ✅

curl https://api.88api.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {
        "role": "user",
        "content": "波士顿今天的天气怎么样?"
      }
    ],
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Получить текущую погоду для указанного места",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "城市和州,例如 San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": ["celsius", "fahrenheit"]
              }
            },
            "required": ["location"]
          }
        }
      }
    ],
    "tool_choice": "auto"
  }'

Пример ответа:

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1699896916,
  "model": "gpt-5.5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "function",
            "function": {
              "name": "get_current_weather",
              "arguments": "{\n\"location\": \"Boston, MA\"\n}"
            }
          }
        ]
      },
      "logprobs": null,
      "finish_reason": "tool_calls"
    }
  ],
  "usage": {
    "prompt_tokens": 82,
    "completion_tokens": 17,
    "total_tokens": 99,
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

Запрос Logprobs ✅

curl https://api.88api.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {
        "role": "user",
        "content": "你好!"
      }
    ],
    "logprobs": true,
    "top_logprobs": 2
  }'

Пример ответа:

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1702685778,
  "model": "gpt-5.5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好!我能为你提供什么帮助?"
      },
      "logprobs": {
        "content": [
          {
            "token": "Hello",
            "logprob": -0.31725305,
            "bytes": [72, 101, 108, 108, 111],
            "top_logprobs": [
              {
                "token": "Hello",
                "logprob": -0.31725305,
                "bytes": [72, 101, 108, 108, 111]
              },
              {
                "token": "Hi",
                "logprob": -1.3190403,
                "bytes": [72, 105]
              }
            ]
          },
          {
            "token": "!",
            "logprob": -0.02380986,
            "bytes": [33],
            "top_logprobs": [
              {
                "token": "!",
                "logprob": -0.02380986,
                "bytes": [33]
              },
              {
                "token": " there",
                "logprob": -3.787621,
                "bytes": [32, 116, 104, 101, 114, 101]
              }
            ]
          },
          {
            "token": " How",
            "logprob": -0.000054669687,
            "bytes": [32, 72, 111, 119],
            "top_logprobs": [
              {
                "token": " How",
                "logprob": -0.000054669687,
                "bytes": [32, 72, 111, 119]
              },
              {
                "token": "`<|end|>`",
                "logprob": -10.953937,
                "bytes": null
              }
            ]
          },
          {
            "token": " can",
            "logprob": -0.015801601,
            "bytes": [32, 99, 97, 110],
            "top_logprobs": [
              {
                "token": " can",
                "logprob": -0.015801601,
                "bytes": [32, 99, 97, 110]
              },
              {
                "token": " may",
                "logprob": -4.161023,
                "bytes": [32, 109, 97, 121]
              }
            ]
          },
          {
            "token": " I",
            "logprob": -3.7697225e-6,
            "bytes": [32, 73],
            "top_logprobs": [
              {
                "token": " I",
                "logprob": -3.7697225e-6,
                "bytes": [32, 73]
              },
              {
                "token": " assist",
                "logprob": -13.596657,
                "bytes": [32, 97, 115, 115, 105, 115, 116]
              }
            ]
          },
          {
            "token": " assist",
            "logprob": -0.04571125,
            "bytes": [32, 97, 115, 115, 105, 115, 116],
            "top_logprobs": [
              {
                "token": " assist",
                "logprob": -0.04571125,
                "bytes": [32, 97, 115, 115, 105, 115, 116]
              },
              {
                "token": " help",
                "logprob": -3.1089056,
                "bytes": [32, 104, 101, 108, 112]
              }
            ]
          },
          {
            "token": " you",
            "logprob": -5.4385737e-6,
            "bytes": [32, 121, 111, 117],
            "top_logprobs": [
              {
                "token": " you",
                "logprob": -5.4385737e-6,
                "bytes": [32, 121, 111, 117]
              },
              {
                "token": " today",
                "logprob": -12.807695,
                "bytes": [32, 116, 111, 100, 97, 121]
              }
            ]
          },
          {
            "token": " today",
            "logprob": -0.0040071653,
            "bytes": [32, 116, 111, 100, 97, 121],
            "top_logprobs": [
              {
                "token": " today",
                "logprob": -0.0040071653,
                "bytes": [32, 116, 111, 100, 97, 121]
              },
              {
                "token": "?",
                "logprob": -5.5247097,
                "bytes": [63]
              }
            ]
          },
          {
            "token": "?",
            "logprob": -0.0008108172,
            "bytes": [63],
            "top_logprobs": [
              {
                "token": "?",
                "logprob": -0.0008108172,
                "bytes": [63]
              },
              {
                "token": "?\n",
                "logprob": -7.184561,
                "bytes": [63, 10]
              }
            ]
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 9,
    "total_tokens": 18,
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  },
  "system_fingerprint": null
}

📮 Запрос

Конечная точка

POST /v1/chat/completions

Создает модель ответа для данного разговора в чате. Более подробную информацию см. в разделе «Генерация текста, визуальные эффекты и аудиогиды».

Метод аутентификации

Включите в заголовок запроса для аутентификации ключа API следующее:

Authorization: Bearer $API_KEY

Где $API_KEY — ваш токен 88API, который можно создать на странице токенов в консоли 88API.

Параметры тела запроса

messages

  • Тип: массив
  • Обязательно: Да

Список сообщений, содержащих беседу на данный момент. В зависимости от используемой модели поддерживаются различные типы (формы) сообщений, такие как текст, изображения и аудио.

Тип сообщенияОписание
Developer messageПредоставленные разработчиком инструкции, которым должна следовать модель независимо от того, какое сообщение отправляет пользователь. В новых моделях рассуждения сообщения разработчика заменяют предыдущие системные сообщения.
System messageПредоставленные разработчиком инструкции, которым должна следовать модель независимо от того, какое сообщение отправляет пользователь. В новых моделях рассуждения вместо этого используйте сообщения разработчика.
User messageСообщение, отправленное конечным пользователем и содержащее подсказки или дополнительную контекстную информацию.
Assistant messageСообщение, отправленное моделью в ответ на сообщение пользователя.
Tool messageСодержимое сообщения инструмента.
Function messageУстарело.

Атрибут сообщения разработчика:

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь developer.
contentСтрока или массивДаСодержание сообщения разработчика. Может быть текстовым содержимым (строкой) или массивом частей содержимого.
nameСтрокаНетНеобязательное имя участника. Предоставьте информацию модели, чтобы различать актеров в одной и той же роли.

Атрибут системного сообщения:

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь system.
contentСтрока или массивДаСодержимое системного сообщения. Может быть текстовым содержимым (строкой) или массивом частей содержимого.
nameСтрокаНетНеобязательное имя участника. Предоставьте информацию модели, чтобы различать актеров в одной и той же роли.

Атрибут сообщения пользователя:

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь user.
contentСтрока или массивДаСодержание сообщения пользователя. Может быть текстовым содержимым (строкой) или массивом частей содержимого.
nameСтрокаНетНеобязательное имя участника. Предоставьте информацию модели, чтобы различать актеров в одной и той же роли.

Тип раздела контента:

Тип части контентаОписаниеДоступно для
Часть текстового содержимогоТекстовый ввод.Все типы сообщений
Раздел изображенияВвод изображения.Сообщения пользователей
Раздел аудиоконтентаАудиовход.Сообщения пользователей
Часть содержимого файлаВвод файла, используемый для генерации текста.Сообщения пользователей
Раздел отклоненных материаловСообщение об отказе, созданное моделью.Сообщение помощника

Атрибуты части текстового контента:

СвойствоТипОбязательноОписание
textСтрокаДаТекстовый контент.
typeСтрокаДаТип содержательной части.

Атрибуты части содержимого изображения:

СвойствоТипОбязательноОписание
image_urlОбъектДаСодержит URL-адрес изображения или данные изображения в кодировке Base64.
typeСтрокаДаТип содержательной части.

Свойства объекта URL-адреса изображения:

СвойствоТипОбязательноОписание
urlСтрокаДаURL-адрес изображения или данные изображения в кодировке Base64.
detailСтрокаНетУказывает уровень детализации изображения. По умолчанию — auto.

Свойства части аудиоконтента:

СвойствоТипОбязательноОписание
input_audioОбъектЕстьобъект, содержащий аудиоданные.
typeСтрокаДаТип содержательной части. Всегда input_audio.

Свойства объекта аудиовхода:

СвойствоТипОбязательноОписание
dataСтрокаДаАудиоданные в кодировке Base64.
formatСтрокаДаФормат кодированных аудиоданных. В настоящее время поддерживаются форматы wav и mp3.

Атрибуты части содержимого файла:

СвойствоТипОбязательноОписание
fileОбъектЕстьобъект, содержащий данные файла.
typeСтрокаДаТип содержательной части. Всегда file.

Свойства объекта «Файл»:

СвойствоТипОбязательноОписание
file_dataСтрокаНетДанные файла в кодировке Base64 для передачи файла в модель в виде строки.
file_idСтрокаНетИдентификатор загруженного файла, используемый в качестве входных данных.
filenameСтрокаНетИмя файла, используемое для передачи файла в модель в виде строки.

Атрибут сообщения Ассистента:

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь assistant.
contentСтрока или массивНетСодержимое вспомогательного сообщения. Требуется, если не указаны tool_calls или function_call.
nameСтрокаНетНеобязательное имя участника. Предоставьте информацию модели, чтобы различать актеров в одной и той же роли.
audioОбъект или nullНетДанные о предыдущих аудиоответах модели.
function_callОбъект или nullНетУстарело, заменено на tool_calls. Имя и аргументы функции, которую следует вызвать, генерируемые моделью.
tool_callsМассивНетВызовы инструментов, генерируемые моделью, например вызовы функций.
refusalСтрока или nullНетСообщение об отказе ассистента.

Атрибут сообщения инструмента:

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь tool.
contentСтрока или массивДаСодержимое сообщения инструмента.
tool_call_idСтрокаДаВызов инструмента, на который отвечает это сообщение.

Атрибут функционального сообщения: (устарело)

СвойствоТипОбязательноОписание
roleСтрокаДаРоль автора сообщения, здесь function.
contentСтрока или nullДаСодержимое функционального сообщения.
nameСтрокаДаИмя функции, которую нужно вызвать.

model

  • Тип: строка
  • Обязательно: Да

Идентификатор модели, который нужно использовать. Дополнительные сведения о том, какие модели доступны для Chat API, см. в матрице совместимости конечных точек модели.

store

  • Тип: логический или нулевой.
  • Обязательно: Нет
  • Значение по умолчанию: false

Сохранять ли выходные данные этого запроса на завершение чата для использования в продуктах OpenAI для дистилляции или оценки модели.

reasoning_effort

  • тип: строка или null
  • Обязательно: Нет
  • Значение по умолчанию: medium
  • Доступно только для моделей серии o.

Модели ограниченного вывода работают на умозаключении. На данный момент поддерживаются значения low, medium и high. Сокращение работы по выводу приводит к более быстрым ответам и уменьшению количества токенов, используемых для вывода в ответе.

metadata

  • Тип: карта
  • Обязательно: Нет

Коллекция из 16 пар ключ-значение, которые можно прикрепить к объекту. Это полезно для хранения дополнительной информации об объекте в структурированном формате, а также для запроса объекта через API или панель мониторинга.

Ключи представляют собой строки длиной не более 64 символов. Значение представляет собой строку максимальной длиной 512 символов.

modalities

  • Тип: массив или null.
  • Обязательно: Нет Тип вывода, который должна выдавать модель для этого запроса. Большинство моделей могут генерировать текст, это настройка по умолчанию: ["текст"]

Модель также можно использовать для генерации звука. Чтобы запросить, чтобы эта модель генерировала как текстовые, так и звуковые ответы, вы можете использовать: ["текст", "аудио"]

prediction

  • Тип: Объект
  • Обязательно: Нет

Конфигурация прогнозных выходных данных, когда большая часть ответа модели известна заранее, может значительно сократить время ответа. Чаще всего это происходит, когда вы вносите в файл лишь незначительные изменения.

Возможные типы:

ТипОписание
СТАТИЧЕСКИЙ СОДЕРЖИМОЕВыходное содержимое статического прогнозирования, например содержимое текстового файла, которое восстанавливается с небольшими изменениями.

Атрибуты статического контента:

СвойствоТипОбязательноОписание
contentСтрока или массивДаЧто должно быть сопоставлено при генерации ответа модели. Если сгенерированная разметка соответствует этому содержимому, весь ответ модели можно будет вернуть быстрее.
typeСтрокаДаТип предоставляемого прогнозируемого контента. Текущим типом всегда является content.

Возможные типы контента:

  1. Текстовое содержимое (строка) – содержимое, используемое для прогнозирования вывода. Обычно это текст восстанавливаемого файла с небольшими изменениями.

  2. ContentPartsArray(Array) — массив частей содержимого определенного типа. Поддерживаемые параметры различаются в зависимости от модели, используемой для генерации ответа. Может содержать текстовый ввод.

Свойства массива частей контента:

СвойствоТипОбязательноОписание
textСтрокаДаТекстовый контент.
typeСтрокаДаТип содержательной части.

audio

  • тип: объект или null
  • Обязательно: Нет

Параметры аудиовыхода. Требуется при запросе вывода звука с помощью modalities: ["audio"].

СвойствоТипОбязательноОписание
formatСтрокаДаОпределяет выходной аудиоформат. Должно быть одно из следующих: wav, mp3, flac, opus или pcm16.
voiceСтрокаДаЗвук, на который модель реагирует. Поддерживаемые звуки: сплав, ясень, баллада, коралл, эхо, басня, новая звезда, оникс, шалфей и мерцание.

temperature

  • тип: число или null
  • Обязательно: Нет
  • Значение по умолчанию: 1

Используемая температура выборки от 0 до 2. Более высокие значения (например, 0,8) делают выходные данные более случайными, а более низкие значения (например, 0,2) делают их более целенаправленными и детерминированными. Обычно мы рекомендуем изменить это значение или top_p, но не оба одновременно.

top_p

  • тип: число или null
  • Обязательно: Нет
  • Значение по умолчанию: 1

Альтернатива температуре отбора проб называется выборкой ядра, где модель учитывает помеченные результаты с массой вероятности top_p. Следовательно, 0,1 означает, что учитываются только токены, содержащие верхнюю 10%-ную массу вероятности.

Обычно мы рекомендуем изменить это значение или temperature, но не оба одновременно.

n

  • Тип: целое число или null.
  • Обязательно: Нет
  • Значение по умолчанию: 1

Сколько вариантов завершения чата генерируется для каждого входного сообщения. Обратите внимание, что с вас будет взиматься плата в зависимости от количества тегов, созданных для всех выбранных вариантов. Оставьте n равным 1, чтобы минимизировать затраты.

stop

  • Тип: строка/массив/null.
  • Обязательно: Нет
  • Значение по умолчанию: null
  • Некоторые модели рассуждения не поддерживают этот параметр.

API прекратит генерировать последовательности, содержащие еще до 4 тегов. Возвращенный текст не будет содержать стоп-последовательности.

max_tokens

  • Тип: целое число или null.
  • Обязательно: Нет Максимальное количество токенов, которое может быть сгенерировано при завершении чата. Это значение можно использовать для управления стоимостью текста, генерируемого через API.

Это значение теперь устарело в пользу max_completion_tokens и несовместимо с моделями рассуждения.

max_completion_tokens

  • Тип: целое число или null.
  • Обязательно: Нет

Верхний предел количества токенов, которые могут быть сгенерированы при завершении, включая видимые выходные токены и токены вывода.

presence_penalty

  • тип: число или null
  • Обязательно: Нет
  • Значение по умолчанию: 0

Число от -2,0 до 2,0. Положительные значения наказывают новые токены в зависимости от их появления в тексте, тем самым увеличивая вероятность того, что модель обсуждает новые темы.

frequency_penalty

  • тип: число или null
  • Обязательно: Нет
  • Значение по умолчанию: 0

Число от -2,0 до 2,0. Положительные значения наказывают новые токены на основе их существующей частоты в тексте, что снижает вероятность того, что модель будет дословно повторять одну и ту же строку.

logit_bias

  • Тип: карта
  • Обязательно: Нет
  • Значение по умолчанию: null

Изменяет вероятность того, что указанный тег появится в завершенном виде.

Принимает объект JSON, который сопоставляет токены (указанные идентификаторами токенов в токенизаторе) со связанными значениями смещения от -100 до 100. Математически смещение добавляется к логарифму, сгенерированному моделью перед выборкой. Точный эффект будет варьироваться от модели к модели, но значения от -1 до 1 должны уменьшить или увеличить вероятность выбора; значения типа -100 или 100 должны привести к подавлению или исключительному выбору соответствующей отметки.

logprobs

  • Тип: логический или нулевой.
  • Обязательно: Нет
  • Значение по умолчанию: false

Возвращать ли логарифм вероятности выходного токена. Если true, возвращает логарифм вероятности каждого выходного токена в message.content.

user

  • Тип: строка
  • Обязательно: Нет

Представляет уникальный идентификатор конечного пользователя, который помогает OpenAI отслеживать и обнаруживать злоупотребления. Подробнее.

service_tier

  • тип: строка или null
  • Обязательно: Нет
  • По умолчанию: auto

Указывает уровень задержки, используемый для обработки запросов. Этот параметр актуален для клиентов, подписанных на услугу уровня масштабирования:

  • Если установлено значение «авто», и в проекте включен уровень масштабирования, система будет использовать кредиты уровня масштабирования до тех пор, пока они не будут исчерпаны.
  • Если установлено значение «авто», а в проекте не включен уровень масштабирования, запросы будут обрабатываться с использованием уровня обслуживания по умолчанию, с меньшим временем безотказной работы и без гарантий задержки.
  • Если установлено значение «по умолчанию», запросы будут обрабатываться с использованием уровня обслуживания по умолчанию, с меньшим временем безотказной работы и без гарантий задержки.
  • Если установлено значение «flex», запросы будут обрабатываться с использованием иерархии служб обработки Flex. Подробности смотрите в документации.
  • Если не установлено, поведение по умолчанию — «авто».
  • Если этот параметр установлен, тело ответа будет содержать используемый уровень службы.

stream_options

  • тип: объект или null
  • Обязательно: Нет
  • Значение по умолчанию: null

Варианты потоковой передачи ответов. Используется только при настройке stream: true.

Возможные атрибуты:

СвойствоТипОбязательноОписание
include_usageЛогическоеНетЕсли установлено, дополнительный фрагмент будет передаваться перед сообщением data: [DONE]. Поле использования в блоке показывает статистику использования токена для всего запроса, а поле выбора всегда представляет собой пустой массив. Все остальные блоки также будут содержать поле использования, но с нулевым значением. Примечание. Если поток прерывается, вы можете не получить окончательный блок использования, содержащий общее количество использованных токенов для запроса.

response_format

  • Тип: Объект
  • Обязательно: Нет

Указывает формат, в котором должна быть выведена модель.

  • Установите значение { "type": "json_schema", "json_schema": {...} }, чтобы включить структурированный вывод и гарантировать, что модель будет соответствовать предоставленной вами схеме JSON.
  • Установите значение { "type": "json_object" }, чтобы включить режим JSON и гарантировать, что сообщения, генерируемые моделью, являются допустимыми JSON.

Важно: при использовании схемы JSON вы также должны указать модели генерировать JSON самостоятельно с помощью системного или пользовательского сообщения. В противном случае модель может генерировать бесконечные пробелы, пока генерация не достигнет предела токенов.

Возможные типы:

ТипОписание
textФормат ответа по умолчанию. Используется для генерации текстовых ответов.
json_schemaФормат ответа схемы JSON. Используется для генерации структурированных ответов JSON. Узнайте больше о структурированном выводе.
json_objectФормат ответа объекта JSON. Старый способ генерации ответов JSON. Для поддерживаемых моделей рекомендуется использовать json_schema.

текстовый атрибут:

СвойствоТипОбязательноОписание
typeСтрокаДаОпределяемый тип формата ответа. Всегда text.

атрибут json_schema:

СвойствоТипОбязательноОписание
json_schemaОбъектДаПараметры конфигурации структурированного вывода, включая схему JSON.
typeСтрокаДаОпределяемый тип формата ответа. Всегда json_schema.

атрибут json_schema.json_schema:

СвойствоТипОбязательноОписание
nameСтрокаДаИмя формата ответа. Должны быть от A до Z, от A до Z, от 0 до 9 или содержать символы подчеркивания и тире. Максимальная длина — 64.
descriptionСтрокаНетОписание назначения формата ответа, которое используется моделью для определения того, как отвечать в этом формате.
schemaОбъектНетСхема формата ответа, описанная как объект схемы JSON.
strictЛогическое или нулевое значениеНетВключить ли строгое соответствие схемы при создании выходных данных. Если установлено значение true, модель всегда будет следовать точной схеме, определенной в поле схемы. Если для параметра strict установлено значение true, поддерживается только подмножество схемы JSON.

атрибут json_object:

СвойствоТипОбязательноОписание
typeСтрокаДаОпределяемый тип формата ответа. Всегда json_object.

seed

  • Тип: целое число или null.
  • Обязательно: Нет Бета-функции. Если указано, система будет выполнять детерминированную выборку с максимальной эффективностью, чтобы повторные запросы с одним и тем же начальным числом и параметрами должны возвращать одни и те же результаты. Детерминизм не гарантируется, и вам следует обратиться к system_fingerprint параметров ответа, чтобы отслеживать изменения на серверной части.

tools

  • Тип: массив
  • Обязательно: Нет

Список инструментов, которые может вызывать модель. В настоящее время в качестве инструментов поддерживаются только функции. Используйте этот параметр, чтобы предоставить список функций, для которых модель может генерировать входные данные JSON. Поддерживается до 128 функций.

Свойства:

СвойствоТипОбязательноОписание
functionОбъектДаИнформация о функции для вызова
typeСтрокаДаТип инструмента. В настоящее время поддерживаются только функции.

атрибут функции:

СвойствоТипОбязательноОписание
nameСтрокаДаИмя вызываемой функции. Должны быть от A до Z, от A до Z, от 0 до 9 или содержать символы подчеркивания и тире. Максимальная длина — 64.
descriptionСтрокаНетОписание того, что делает функция, которое используется моделью для выбора, когда и как вызывать функцию.
parametersОбъектНетПараметры, принимаемые функцией, описываемые как объекты схемы JSON. Примеры см. в руководстве, а документацию по формату — в справочнике по схеме JSON. Отсутствие параметров определяет функцию с пустым списком параметров.
strictЛогическое или нулевое значениеНетПо умолчанию: ложь. Включить ли строгое соответствие архитектуре при генерации вызовов функций. Если установлено значение true, модель будет следовать точной схеме, определенной в поле параметров. Если для параметра strict установлено значение true, поддерживается только подмножество схемы JSON. Подробности см. в разделе «Структурированный вывод» Руководства по вызову функций.

functions

  • Тип: массив
  • Обязательно: Нет
  • Примечание. Устарело, рекомендуется использовать tools.

Модель может генерировать список функций в качестве входных данных JSON.

СвойствоТипОбязательноОписание
nameСтрокаДаИмя вызываемой функции. Должно быть от A до Z, от A до Z, от 0 до 9 или содержать символы подчеркивания и тире. Максимальная длина — 64.
descriptionСтрокаНетОписание того, что делает функция, которое используется моделью для выбора, когда и как вызывать функцию.
parametersОбъектНетПараметры, принимаемые функцией, описываемые как объекты схемы JSON. Отсутствие параметров определяет функцию с пустым списком параметров.

tool_choice

  • Тип: строка или объект.
  • Обязательно: Нет

Укажите, какой инструмент (если есть) вызывает модель:

  • none: Модель не вызывает никаких инструментов, но генерирует сообщения
  • auto: модель может выбирать между генерацией сообщения или вызовом одного или нескольких инструментов.
  • required: модель должна вызывать один или несколько инструментов.
  • {"type": "function", "function": {"name": "my_function"}}: заставить модель вызывать определенный инструмент.

По умолчанию используется none, когда инструмент отсутствует, и auto, когда инструмент есть.

Возможные типы:

ТипОписание
Строкаnone означает, что модель не будет вызывать какие-либо инструменты, а вместо этого будет генерировать сообщения. auto означает, что модель может выбирать между генерацией сообщения или вызовом одного или нескольких инструментов. требуется указывает, что модель должна вызвать один или несколько инструментов.
ОбъектУказывает инструмент, который должна использовать модель. Используется, чтобы заставить модель вызвать определенную функцию.

Свойства объекта:

СвойствоТипОбязательноОписание
functionОбъектДаОбъект, содержащий информацию о функции
typeСтрокаДаТип инструмента. В настоящее время поддерживаются только функции.

атрибут функции:

СвойствоТипОбязательноОписание
nameСтрокаДаИмя функции, которую нужно вызвать.

function_call

  • Тип: строка или объект.
  • Обязательно: Нет
  • Значение по умолчанию: none, когда функция отсутствует, auto, когда функция есть.
  • Примечание. Устарело, рекомендуется использовать tool_choice.

Укажите, какую функцию (если есть) вызывает модель:

  • none: модель не вызывает функцию, а генерирует сообщение.
  • auto: модель может выбирать между генерацией сообщений или вызовом функций.
  • {"name": "my_function"}: заставить модель вызывать определенную функцию.

Свойства типа объекта:

СвойствоТипОбязательноОписание
nameСтрокаДаИмя функции, которую нужно вызвать.

parallel_tool_calls

  • Тип: Логический
  • Обязательно: Нет
  • Значение по умолчанию: true

Включить ли параллельные вызовы функций во время использования инструмента.

stream

  • Тип: логический или нулевой.
  • Обязательно: Нет
  • Значение по умолчанию: false

Если установлено значение true, данные ответа модели будут передаваться клиенту через события, отправленные сервером, при создании. Дополнительные сведения см. в разделе «Потоковые ответы» ниже, а также в руководстве «Потоковые ответы», чтобы узнать, как обрабатывать события потоковой передачи.

top_logprobs

  • Тип: целое число или null.
  • Обязательно: Нет

Целое число от 0 до 20, определяющее количество наиболее вероятных тегов, возвращаемых в каждой позиции тега, причем каждый тег имеет связанную с ним логарифмическую вероятность. Если этот параметр используется, для logprobs должно быть установлено значение true.

web_search_options

  • Тип: Объект
  • Обязательно: Нет

Этот инструмент ищет в Интернете соответствующие результаты ответов. Узнайте больше об инструментах веб-поиска.

Возможные атрибуты:

СвойствоТипОбязательноОписание
search_context_sizeСтрокаНетПо умолчанию: средний. Общее руководство по объему контекстного окна, используемому для поиска. Необязательные значения: низкий, средний или высокий. средний — значение по умолчанию.
user_locationОбъект или nullНетПараметр приблизительного положения для поиска.

атрибут user_location:

СвойствоТипОбязательноОписание
approximateОбъектЕстьприблизительный параметр положения для поиска.

приблизительный атрибут:

СвойствоТипОбязательноОписание
cityСтрокаНетПроизвольный ввод текста для города пользователя, например Сан-Франциско.
countryСтрокаНетДвухбуквенный код страны пользователя по стандарту ISO, например США.
regionСтрокаНетПроизвольный ввод текста для локали пользователя, например Калифорнии.
timezoneСтрокаНетЧасовой пояс пользователя в соответствии с IANA, например America/Los_Angeles.
typeСтрокаДаТип близости позиции. Всегда приблизительно.

📥 Ответ

Объект завершения чата

Возвращает объект завершения чата или, если запрос передается в потоковом режиме, потоковую последовательность объектов блока завершения чата.

id

  • Тип: строка
  • Описание: Уникальный идентификатор ответа.

object

  • Тип: строка
  • Описание: тип объекта, значение «chat.completion».

created

  • Тип: целое число
  • Описание: временная метка создания ответа.

model

  • Тип: строка
  • Описание: используемое название модели.

system_fingerprint

  • Тип: строка
  • Описание: системный идентификатор отпечатка пальца, указывающий серверную конфигурацию работающей модели. Может использоваться с параметром начального запроса, чтобы понять, когда были внесены изменения в серверную часть, которые могут повлиять на детерминизм.

choices

  • Тип: массив
  • Описание: содержит список сгенерированных вариантов ответа. Если n больше 1, вариантов может быть несколько.
  • Свойства:
    • index: индекс опции в списке опций.
    • message: сообщение о завершении чата, созданное моделью.
      • role: роль автора сообщения.
      • content: содержимое сообщения может быть нулевым.
      • refusal: сообщение об отклонении, созданное моделью, может быть нулевым.
      • annotations: комментарии к сообщению, предоставляемые, когда это применимо, например, при использовании инструмента веб-поиска.
        • type: тип аннотации, всегда «url_citation», если он цитируется по URL.
        • url_citation: ссылка на URL-адрес при использовании веб-поиска.
          • start_index: индекс первого символа URL-адреса в сообщении.
          • end_index: индекс последнего символа URL-адреса в сообщении.
          • url: URL-адрес сетевого ресурса.
          • title: заголовок сетевого ресурса.
      • audio: если запрашивается модальное окно вывода звука, этот объект содержит данные из звукового ответа модели.
        • data: аудиобайты в кодировке Base64, генерируемые моделью, формат указан в запросе.
        • id: уникальный идентификатор этого звукового ответа.
        • transcript: транскрипция звука, генерируемого моделью.
        • expires_at: временная метка Unix (в секундах), когда этот звуковой ответ был доступен на сервере для нескольких раундов разговора.
      • function_call: (УСТАРЕЛО) Имя и аргументы вызываемой функции, генерируемые моделью. Заменен на tool_calls.
        • name: имя вызываемой функции.
        • arguments: параметры, используемые для вызова функции, генерируемые моделью в формате JSON.
      • tool_calls: вызовы инструментов для создания модели, например вызовы функций.
  • id: идентификатор вызова инструмента.
    • type: Тип инструмента. В настоящее время поддерживаются только функции.
    • function: функция, вызываемая моделью.
      • name: имя вызываемой функции.
      • arguments: параметры, используемые для вызова функции, генерируемые моделью в формате JSON. Обратите внимание, что модель не всегда создает действительный JSON и может создавать параметры, которые не определены в вашей схеме функции. Прежде чем вызывать функцию, проверьте параметры в своем коде.
    • logprobs: записать информацию о вероятности.
      • content: список тегов содержимого сообщения с информацией о вероятности регистрации.
        • token: отметка.
        • logprob: запишите вероятность появления этого токена, если он входит в число 20 наиболее вероятных токенов. В противном случае использование значения -9999,0 указывает на то, что этот тег маловероятен.
        • bytes: список целых чисел, представляющих байтовое представление тега в формате UTF-8. Полезно в ситуациях, когда символ представлен несколькими токенами, и их байтовые представления необходимо объединить для создания правильного текстового представления. Может быть нулевым, если тег не имеет байтового представления.
        • top_logprobs: список наиболее вероятных маркеров в этой позиции маркера и их логарифмические вероятности. В редких случаях количество возвращаемых top_logprobs может быть меньше запрошенного.
      • refusal: список маркеров отклонения сообщений с информацией о вероятности регистрации.
    • finish_reason: причина, по которой модель перестала генерировать маркеры. «stop», если модель достигает естественной точки остановки или предоставленной последовательности остановки, «length», если достигнуто максимальное количество токенов, указанное в запросе, «content_filter», если контент опущен из-за токена фильтра содержимого, «tool_calls», если модель вызывает инструмент, или «function_call» (устарело), ​​если модель вызывает функцию.

usage

  • Тип: Объект
  • Описание: Статистика использования запросов на выполнение.
  • Свойства:
    • prompt_tokens: количество токенов в приглашении.
    • completion_tokens: количество токенов в сгенерированном завершении.
    • total_tokens: общее количество токенов, использованных в запросе (подсказка + завершение).
    • prompt_tokens_details: разбивка тегов, используемых в приглашении.
      • cached_tokens: тег кэша присутствует в командной строке.
      • audio_tokens: тег аудиовхода присутствует в подсказке.
    • completion_tokens_details: разбивка токенов, использованных при завершении.
      • reasoning_tokens: токен вывода, созданный моделью.
  • audio_tokens: аудиоразметка, созданная моделью.
    • accepted_prediction_tokens: количество токенов, которые, по прогнозам, появятся в завершении при использовании вывода прогноза.
    • rejected_prediction_tokens: при использовании вывода прогноза количество токенов в прогнозе, которые не появляются в завершении. Однако, как и токены вывода, эти токены по-прежнему учитываются в качестве токенов общего завершения для ограничений окон выставления счетов, вывода и контекста.

service_tier

  • тип: строка или null
  • Описание: указывает уровень задержки, используемый для обработки запросов. Этот параметр актуален для клиентов, подписанных на услугу уровня масштабирования:
    • Если установлено значение «авто», и в проекте включен уровень масштабирования, система будет использовать кредиты уровня масштабирования до тех пор, пока они не будут исчерпаны.
    • Если установлено значение «авто», а в проекте не включен уровень масштабирования, запросы будут обрабатываться с использованием уровня обслуживания по умолчанию, с меньшим временем безотказной работы и без гарантий задержки.
    • Если установлено значение «по умолчанию», запросы будут обрабатываться с использованием уровня обслуживания по умолчанию, с меньшим временем безотказной работы и без гарантий задержки.
    • Если установлено значение «flex», запросы будут обрабатываться с использованием иерархии служб Flex Processing.
    • Если не установлено, поведение по умолчанию — «авто».
    • Если этот параметр установлен, тело ответа будет содержать используемый уровень службы.

Пример ответа объекта завершения чата

{
  "id": "chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG",
  "object": "chat.completion",
  "created": 1741570283,
  "model": "gpt-5.5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "图片展示了一条穿过茂密绿色草地或草甸的木制栈道。天空湛蓝,点缀着几朵散落的云彩,给整个场景营造出宁静祥和的氛围。背景中可以看到树木和灌木丛。",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1117,
    "completion_tokens": 46,
    "total_tokens": 1163,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  },
  "service_tier": "default",
  "system_fingerprint": "fp_fc9f1d7035"
}

Объект списка завершения чата

Когда возвращается несколько завершений чата, API может вернуть объект списка завершения чата.

object

  • Тип: строка
  • Описание: Тип объекта, всегда «список».

data

  • Тип: массив
  • Описание: Массив объектов завершения чата.

first_id

  • Тип: строка
  • Описание: идентификатор первого завершения чата в массиве данных.

last_id

  • Тип: строка
  • Описание: идентификатор последнего завершения чата в массиве данных.

has_more

  • Тип: Логический
  • Описание: указывает, доступны ли дополнительные завершения чата.

Пример ответа на список завершения чата

{
  "object": "list",
  "data": [
    {
      "object": "chat.completion",
      "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2",
      "model": "gpt-5.5",
      "created": 1738960610,
      "request_id": "req_ded8ab984ec4bf840f37566c1011c417",
      "tool_choice": null,
      "usage": {
        "total_tokens": 31,
        "completion_tokens": 18,
        "prompt_tokens": 13
      },
      "seed": 4944116822809979520,
      "top_p": 1.0,
      "temperature": 1.0,
      "presence_penalty": 0.0,
      "frequency_penalty": 0.0,
      "system_fingerprint": "fp_50cad350e4",
      "input_user": null,
      "service_tier": "default",
      "tools": null,
      "metadata": {},
      "choices": [
        {
          "index": 0,
          "message": {
            "content": "电路之心低吟,\n在寂静中学习模式—\n未来的宁静火花。",
            "role": "assistant",
            "tool_calls": null,
            "function_call": null
          },
          "finish_reason": "stop",
          "logprobs": null
        }
      ],
      "response_format": null
    }
  ],
  "first_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2",
  "last_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2",
  "has_more": false
}

Объект списка сообщений завершения чата

Объект списка сообщений завершения чата представляет список сообщений чата.

object

  • Тип: строка
  • Описание: Тип объекта, всегда «список».

data

  • Тип: массив
  • Описание: Массив объектов сообщения о завершении чата. Каждый объект сообщения содержит следующие свойства:
    • id: идентификатор сообщения чата.
    • role: роль автора сообщения.
    • content: содержимое сообщения может быть нулевым.
    • name: имя отправителя сообщения, может быть нулевым.
    • refusal: сообщение об отказе, созданное моделью, может быть нулевым.
    • annotations: комментарии к сообщению, предоставляемые, когда это применимо, например, при использовании инструмента веб-поиска.
      • type: тип аннотации, всегда «url_citation», если цитируется по URL.
      • url_citation: ссылка на URL-адрес при использовании веб-поиска.
        • start_index: индекс первого символа URL-адреса в сообщении.
        • end_index: индекс последнего символа URL-адреса в сообщении.
        • url: URL-адрес сетевого ресурса.
        • title: Название сетевого ресурса.
    • audio: если запрашивается модальное окно вывода звука, этот объект содержит данные из звукового ответа модели.
      • data: аудиобайты в кодировке Base64, генерируемые моделью, формат указан в запросе.
      • id: уникальный идентификатор этого звукового ответа.
      • transcript: транскрипция звука, генерируемого моделью.
      • expires_at: временная метка Unix (в секундах), когда этот звуковой ответ был доступен на сервере для нескольких раундов разговора.
    • function_call: (УСТАРЕЛО) Имя и аргументы вызываемой функции, генерируемые моделью. Заменен на tool_calls.
      • name: имя вызываемой функции.
      • arguments: параметры, используемые для вызова функции, сгенерированные моделью в формате JSON.
    • tool_calls: вызовы инструментов для создания модели, например вызовы функций.
      • id: идентификатор вызова инструмента.
      • type: Тип инструмента. На данный момент поддерживаются только функции
      • function: функция, вызываемая моделью.
        • name: имя вызываемой функции.
        • arguments: параметры, используемые для вызова функции, сгенерированные моделью в формате JSON.

first_id

  • Тип: строка
  • Описание: идентификатор первого сообщения чата в массиве данных.

last_id

  • Тип: строка
  • Описание: идентификатор последнего сообщения чата в массиве данных.

has_more

  • Тип: Логический
  • Описание: указывает, доступны ли дополнительные сообщения чата.

Пример ответа на список сообщений о завершении чата

{
  "object": "list",
  "data": [
    {
      "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0",
      "role": "user",
      "content": "Напишите хайку об искусственном интеллекте",
      "name": null,
      "content_parts": null
    }
  ],
  "first_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0",
  "last_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0",
  "has_more": false
}