Xinference Rerank

Вызывайте модель Xinference Rerank в совместимом с Jina AI формате.

Xinference Rerank ранжирует документы-кандидаты по релевантности в совместимом с Jina AI формате. Выберите доступную модель Xinference Rerank; остальные поля запроса и структура ответа совпадают с Jina Rerank. AGTCloud преобразует ответ в единый стиль Jina AI.

Настройка поставщика в Dify и подобных клиентах

В клиентах, требующих выбрать тип поставщика Rerank, например Dify, выберите Jina AI и укажите ID доступной модели Xinference Rerank.

POST/v1/rerank

Вызовите модель переранжирования Xinference в совместимом с Jina AI формате. AGTCloud преобразует ответ в единый стиль Jina AI; способ вызова, поля запроса и структура ответа совпадают с Jina Rerank.

Выберите модель Xinference Rerank, видимую текущему ключу API. Запросы должны быть ясными и конкретными, а документы-кандидаты — целостными по смыслу и не превышать предел Tokens выбранной модели. Большие объёмы рекомендуется обрабатывать пакетами, ограничивая число результатов с помощью top_n.

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

bearerAuth

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

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

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

Тело запроса

application/json

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

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

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

model*string

ID модели Xinference Rerank, видимой текущему ключу API.

Длина1 <= length

query*string

Текст запроса для ранжирования документов-кандидатов по релевантности. Используйте ясные и конкретные формулировки, избегая слишком широких или расплывчатых запросов.

Длина1 <= length

documents*array<string>

Список документов для переранжирования. Каждый документ должен быть целостным, однозначным по смыслу и не превышать максимальное число Tokens выбранной модели; большие объёмы рекомендуется обрабатывать пакетами.

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

top_n?integer

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

Тело ответа

`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": [
    {
      "document": {
        "text": "Вашингтон, округ Колумбия (также называемый Вашингтоном или округом; официальное название — округ Колумбия), является столицей США."
      },
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "document": {
        "text": "Столица штата Невада — Карсон-Сити."
      },
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "document": {
        "text": "Северные Марианские Острова — группа островов в Тихом океане; их столица — Сайпан."
      },
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

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

Тело запроса

Тело ответа

200application/json

400

401

429

500

`application/json`