Формат ререйтинга Jina AI (Rerank)

📝 Введение

Jina AI Rerank — это мощная модель реранжирования текста, которая может ранжировать списки документов по релевантности на основе запросов. Модель поддерживает несколько языков, может обрабатывать текстовый контент на разных языках и присваивать оценку релевантности каждому документу.

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

Базовый запрос на повторный заказ ✅

curl https://88api.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "jina-reranker-v2-base-multilingual",
    "query": "Organic skincare products for sensitive skin",
    "top_n": 3,
    "documents": [
      "Organic skincare for sensitive skin with aloe vera and chamomile...",
      "New makeup trends focus on bold colors and innovative techniques...",
      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
    ]
  }'

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

{
  "results": [
    {
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.7624675869941711
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

📮 Запрос

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

POST /v1/rerank

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

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

Authorization: Bearer $API_KEY

Где $API_KEY — ваш ключ API.

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

$API_KEY

• Тип: строка
• Требуется: Нет -По умолчанию: jina-reranker-v2-base-multilingual.
• Описание: используемая модель переупорядочения.

$API_KEY

• Тип: строка
• Требуется: Да
• Описание: текст запроса, используемый для ранжирования документов по релевантности.

$API_KEY

• Тип: целое число
• Требуется: Нет -По умолчанию: без ограничений
• Описание: вернуть первые N документов после сортировки.

$API_KEY

• Тип: массив строк.
• Требуется: Да
• Описание: Список документов, подлежащих переупорядочению.
• Ограничение: длина каждого документа не должна превышать максимальный лимит токенов модели.

📥 Ответ

Успешный ответ

$API_KEY

• Тип: массив
• Описание: Переупорядоченный список документов.
• Свойства:
  • $API_KEY: объект, содержащий текст документа.
  • $API_KEY: индекс документа в исходном списке.
  • $API_KEY: оценка релевантности (от 0 до 1).

$API_KEY

• Тип: Объект
• Описание: статистика использования токенов.
• Свойства:
  • $API_KEY: Подскажите количество используемых токенов.
  • $API_KEY: количество жетонов, использованных для завершения.
  • $API_KEY: общее количество токенов
  • $API_KEY: запрос сведений о токене.
    • $API_KEY: количество кэшированных токенов.
    • $API_KEY: количество аудиотокенов.
  • $API_KEY: Полная информация о токене.
    • $API_KEY: количество жетонов рассуждений.
    • $API_KEY: количество аудиотокенов.
    • $API_KEY: количество принятых токенов прогнозирования.
    • $API_KEY: количество отклоненных токенов прогноза.

Ошибка ответа

Если с запросом что-то пойдет не так, API вернет ответ об ошибке:

• $API_KEY: неверные параметры запроса.
• $API_KEY: ключ API недействителен или не предоставлен.
• $API_KEY: частота запросов превышает предел.
• $API_KEY: внутренняя ошибка сервера.

💡 Лучшие практики

Рекомендации по оптимизации запросов

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

Рекомендации по обработке документов

1. Сохраняйте умеренную длину документа и не превышайте ограничения модели.
2. Убедитесь, что содержание документа является полным и содержательным.
3. Может содержать многоязычные документы, модель поддерживает межъязыковое сопоставление.

Оптимизация производительности

1. Установите параметр top_n соответствующим образом, чтобы уменьшить количество ненужных вычислений.
2. Для больших объемов документов рассмотрите возможность пакетной обработки.
3. Может кэшировать результаты часто используемых запросов.

Многоязычная поддержка

Модель поддерживает изменение порядка документов на нескольких языках, включая, помимо прочего:

• английский
• Китайский
• немецкий
• Испанский
• японский
• французский

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