Cohere Rerank

Переранжируйте документы-кандидаты с помощью структуры запросов Rerank в стиле Cohere.

Интерфейс Cohere Rerank ранжирует документы-кандидаты по релевантности тексту запроса. Основные поля запроса в целом совпадают с Jina Rerank; дополнительно поддерживаются X-Client-Name и max_tokens_per_doc. Ответ содержит исходные индексы документов, оценки релевантности, идентификатор запроса, версию API и метаданные тарификации.

POST/v1/rerank

Вычислите релевантность документов-кандидатов тексту запроса и получите результаты в порядке убывания релевантности. Основные поля запроса в целом совпадают с Jina Rerank; дополнительно поддерживаются X-Client-Name и max_tokens_per_doc. Успешный ответ содержит индексы результатов, оценки релевантности, идентификатор запроса, версию API и метаданные тарификации.

Для более стабильного ранжирования формулируйте запросы ясно и конкретно, а документы — кратко и с сохранением целостного смысла. Длинные документы обрезаются по max_tokens_per_doc; рекомендуется передавать не более 1,000 документов в одном запросе, а структурированные данные преобразовывать в строки YAML.

Аутентификация

bearerAuth

АутентификацияBearer <token>

Используйте Bearer your-api-key в Header Authorization.

Расположение: header

Параметры Header

X-Client-Name?string

Название проекта, выполняющего запрос.

Тело запроса

application/json

Параметры запроса переранжирования документов в стиле Cohere.

Определения типов TypeScript

Используйте тип request body в TypeScript.

model*string

ID используемой модели переранжирования. Укажите модель, видимую текущему ключу API и поддерживающую формат Cohere Rerank.

Длина1 <= length

query*string

Текст запроса для сравнения с документами-кандидатами. Рекомендуются ясные и конкретные запросы без слишком расплывчатых или широких формулировок.

Длина1 <= length

documents*array<string>

Список текстов для сравнения с запросом. Рекомендуется передавать не более 1,000 документов за раз; длинные документы обрезаются по max_tokens_per_doc, а структурированные данные рекомендуется преобразовывать в строки YAML.

Элементы1 <= items

top_n?integer

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

max_tokens_per_doc?integer

Максимальное число Tokens одного документа, участвующих в переранжировании; содержимое сверх этого числа обрезается.

По умолчанию4096

Тело ответа

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "Какой город является столицей США?",    "documents": [      "Столица штата Невада — Карсон-Сити.",      "Северные Марианские Острова — группа островов в Тихом океане; их столица — Сайпан.",      "Вашингтон, округ Колумбия (также называемый Вашингтоном или округом; официальное название — округ Колумбия), является столицей США.",      "В английской грамматике использование заглавных букв означает написание заглавной буквы в начале слова. Правила их употребления в английском отличаются от других языков.",      "Смертная казнь существовала в США ещё до образования государства. По состоянию на 2017 год она была законна в 30 из 50 штатов."    ],    "top_n": 3  }'

{
  "results": [
    {
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf",
  "meta": {
    "api_version": {
      "version": "2",
      "is_experimental": false
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

Аутентификация

Параметры Header

Тело запроса

Тело ответа

200application/json

400

401

403

404

422

429

500

503

`application/json`