Первый запрос. Без лишних шагов.

Embeddings API: векторные представления текста

Метод POST /v1/embeddings принимает текст и возвращает числовые векторы. В локальном PostgreSQL-режиме ответы тестовые: они подходят для проверки интеграции и учёта расходов, но не для оценки качества поиска.

Передайте API-ключ в заголовке Authorization: Bearer и уникальный Idempotency-Key длиной 8–128 символов. Повтор с тем же ключом и телом возвращает сохранённый результат без второго списания.

{
  "model": "openai/text-embedding-3-small",
  "input": [
    "Текст для поиска",
    "Текст документа"
  ],
  "dimensions": 8,
  "encoding_format": "float"
}

Допускаются одна строка или пакет до 128 непустых строк, тело до 256 КиБ. Формат результата — float или base64. Размерность от 1 до 65 536, суммарно до 262 144 компонентов в пакете. Слишком большой пакет нужно разбить на несколько запросов.

Ответ содержит data с векторами и индексами строк, usage с расходом токенов и cost_microrubles со списанием. Признак sandbox: true означает тестовый ответ. Доступность метода проверяется в GET /v1/models, поле capabilities.embeddings.

Посмотреть модели embeddings →

Rerank API: ранжирование документов

POST /v1/rerank упорядочивает документы по соответствию поисковому запросу. Передайте query и массив documents, а в top_n — число результатов. В локальном режиме алгоритм сравнивает слова; это тест интеграции, а не оценка качества модели.

{
  "model": "cohere/rerank-v3.5",
  "query": "аренда сервера",
  "documents": [
    "Аренда сервера для приложения",
    "Настройка почты"
  ],
  "top_n": 1,
  "return_documents": true
}

Обязательны заголовки Authorization: Bearer и Idempotency-Key длиной 8–128 символов. Лимит — 128 непустых текстовых документов и 256 КиБ на запрос. top_n не может превышать число документов.

В results возвращаются index исходного документа и relevance_score. При return_documents: true добавляется исходный текст. Повтор с тем же ключом и телом возвращает сохранённый результат.

Розничная стоимость ранжирования рассчитывается по usage.search_units и опубликованной цене за поисковую единицу. Тестовый режим помечается sandbox: true и использует отдельный mock-тариф. Нулевая токенная ставка не означает бесплатное ранжирование.

Модели ранжирования →

Отдельный ключ для интеграции

Создайте ключ в кабинете и задайте ему бюджет. Храните секрет на сервере или в защищённых учётных данных инструмента автоматизации.

Повтор запроса

При повторе передавайте тот же Idempotency-Key и неизменное тело запроса. Если результат требует сверки, не запускайте новую генерацию автоматически.