VoyageAI by MongoDB: rerank-3
Voyage rerank-3 — редакция Rerank 3 с приоритетом качества для оценки релевантности пары «запрос — документ». Она переупорядочивает найденные текстовые кандидаты, поддерживает инструкции о релевантности на естественном языке и пары до 32 000 токенов для поиска по длинным документам, коду и базам знаний.
О модели
Описание раскрывает возможности модели. Доступные в Ailoot входные данные, результаты и параметры выбранного метода перечислены ниже.
Voyage rerank-3 — текстовый реранкер, предназначенный для повышения качества найденных доказательных материалов. Получив запрос и список документов-кандидатов, он совместно рассматривает каждую пару и возвращает кандидатов в порядке релевантности. Эмбеддинги и ключевой поиск сначала могут сузить большую коллекцию до обозримого списка; затем rerank-3 более подробно оценивает его релевантность. На выходе приложение получает поисковые материалы с оценками, которые можно показать или передать отдельному этапу генерации ответа.
Rerank 3 с приоритетом качества Разработчик позиционирует rerank-3 как редакцию с приоритетом точности, а rerank-3-lite — как редакцию для поиска, чувствительного к задержке. Третье поколение обновляет базовую архитектуру и состав обучающих данных, особенно улучшая поиск по длинным документам и исходному коду по сравнению с соответствующими предшественниками 2.5. Разработчик оценивает модель на технической документации, коде, многоязычных материалах и других типах документов. Эти результаты подтверждают её поисковую роль; выбирайте редакцию на вопросах и документах-кандидатах, значимых для вашей коллекции.
Длинные документы с достаточным контекстом Длинный кандидат может содержать полезный контекст далеко за первым абзацем. Предоставьте связный раздел или документ с названием и важными окружающими материалами, чтобы модель могла оценить связь фактического вопроса с содержанием. Для поиска по правилам продукта сохраните заголовки и исключения вокруг нужного фрагмента. Если несколько найденных разделов относятся к одному источнику, сохраните идентификаторы документа и разделов; тогда приложение сможет показать происхождение выбранных доказательств.
Окно контекста делят запрос и каждый кандидат. Текущее руководство разработчика указывает 32 000 токенов для такой пары, включая запрос не длиннее 8000 токенов. Поэтому запрос на 3000 токенов оставляет каждому документу максимум 29 000 токенов. Подготавливайте ввод так, чтобы существенное содержание помещалось, особенно если длинное вступление или повторяющийся шаблонный текст иначе займут окно. Документированная опция усечения включена по умолчанию и может сокращать слишком длинный запрос или документ до оценки. Проверяйте сохранённый текст, когда важно расположение фрагмента.
Поиск кода и технических материалов На поисковом этапе помощника по программированию кандидаты могут содержать реализации функций, документацию API или технические объяснения в текстовом виде. Включите символы, сигнатуры и контекст, необходимые для различения похожих кандидатов. Запрос вроде «Найди функцию, которая нормализует пути, сохраняя завершающий разделитель» задаёт конкретное поведение для сопоставления. Добавьте значимые ограничения языка, платформы или версии. После ранжирования изучите выбранный код и его зависимости до использования в качестве контекста: оценка релевантности не доказывает соблюдение реализацией каждого заявленного требования.
Инструкции определяют релевантность Модель сохраняет возможность ранжирования по инструкциям, введённую в Rerank 2.5. Добавьте краткую инструкцию до или после запроса, если намерение пользователя требует уточнения. Для поиска по исследовательским документам объясните, что важнее: название, конкретный метод или область применения. Для внутреннего каталога укажите, касается ли запрос установки, устранения неполадок или совместимости. Согласуйте инструкцию с вопросом: дополнительные предпочтения, противоречащие основному запросу, могут изменить цель оптимизации ранжирования.
Подготовка документов-кандидатов и бюджетов На вход подаётся список текстовых строк. Извлеките пригодный текст из исходных документов, сохраните осмысленные границы разделов и упорядоченную карту записей рядом со списком. Разработчик допускает до 1000 документов в одном запросе. Он также устанавливает суммарный потолок ввода в 600 000 токенов: число токенов запроса, умноженное на число документов, плюс сумма всех токенов документов. Это отличается от ограничения контекста отдельной пары. Сокращение избыточного текста запроса сохраняет и ёмкость пары, и общий бюджет запроса.
Подсчитывайте токены для соответствующей модели, не предполагая, что число слов или символов равно числу токенов. Для больших кандидатов выбирайте связные фрагменты или делите материал по полезным заголовкам, сохраняя сведения о родительском источнике. Повторное ранжирование полезнее всего, когда первый поиск уже нашёл правдоподобных кандидатов: оно не может ранжировать отсутствующий источник, не попавший в список.
Ранжированные результаты и дальнейшее использование Результат содержит оценки релевантности и индексы исходных входных документов, отсортированные по убыванию релевантности. Опция top_k ограничивает число возвращаемых ранжированных результатов; иначе возвращаются все входные кандидаты. REST-интерфейс разработчика также позволяет включить текст документа. Используйте исходный индекс для восстановления названия, идентификатора источника и метаданных, нужных приложению, затем покажите выбранные элементы или поместите нужный текст в контекст доказательств для ответа.
Сверяйте первые результаты с вопросом и сохраняйте видимую идентичность источника. Высокое относительное место не проверяет фактическую точность документа, а список из одних слабых кандидатов всё равно имеет первый элемент. Разделяйте отбор по релевантности и решение о достаточности выбранных доказательств для ответа пользователю.
Переход между редакциями Разработчик описывает rerank-3 как прямую замену rerank-2.5 с той же семантикой API и оценками, откалиброванными под распределение соответствующего предшественника. Такая совместимость позволяет сохранить существующий этап поиска и соответствие записей. Прежде чем полагаться на переход, сравните значимые порядки результатов и пороги оценок на текущем корпусе. Сохраняйте rerank-3 и rerank-3-lite как разные варианты: общие ограничения и следование инструкциям не делают их приоритеты качества и задержки одинаковыми.
Ailoot Ultra · Переранжирование POST /v1/rerank voyageai/rerank-3
voyageai/rerank-3Начало
Voyage rerank-3 — редакция Rerank 3 с приоритетом качества для оценки релевантности пары «запрос — документ». Она переупорядочивает найденные текстовые кандидаты, поддерживает инструкции о релевантности на естественном языке и пары до 32 000 токенов для поиска по длинным документам, коду и базам знаний.
- Допустимые входные данные
- Текст
- Результаты
- Ранжированные результаты
Доступно в Ailoot · входные данные и методы
Ailoot Ultra · Переранжирование POST /v1/rerank
- Входные данные
text- Результат
rerank- Выходной формат
- json
| Поле | Тип | Требование | Значения и ограничения | По умолчанию |
|---|---|---|---|---|
Полеdocuments | Типarray | ТребованиеОбязательно | Значения и ограничения | По умолчанию— |
Полеmodel | Типstring | ТребованиеОбязательно | Значения и ограничения voyageai/rerank-3 | По умолчанию— |
Полеprovider | Типschema | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Полеquery | Типstring | ТребованиеОбязательно | Значения и ограничения | По умолчанию— |
Полеsession_id | Типstring | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Полеtop_n | Типinteger | ТребованиеНеобязательно | Значения и ограничения Минимум: 1 | По умолчанию— |
Полеtrace | Типschema | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Полеuser | Типstring | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Полеdocuments[].text | Типstring | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Полеdocuments[].image | Типstring | ТребованиеНеобязательно | Значения и ограничения | По умолчанию— |
Сочетания входных материалов
text_rerank · Обязательно: query, documents array with minItems1
Параметры и жизненный цикл метода
| Параметр | Контракт |
|---|---|
Параметрcontent_type | Контрактapplication/json |
Параметрrequired | Контрактmodel, query, documents |
Параметрmaterial_types | Контрактtext |
Параметрoptional_controls | Контрактprovider, session_id, top_n, trace, user |
Параметрmultimodal_input_binding | Контрактnull |
Жизненный цикл: synchronous
Передайте точный ID модели и сохраните полный нативный ответ.
Тарифы
Тарифная справка не добавляет режимы запроса. Поддерживаемые параметры указаны для выбранного метода.
- Быстрый режим
- Не указано При выборе быстрого режима
- Режим flex
- Не указано При выборе режима flex
- Максимальная интенсивность рассуждений
- Не указано При максимальной интенсивности рассуждений с корректировкой по умолчанию (default)
Ставки Ailoot
Цены по конфигурациям
Сопоставьте каждую плату с указанными условиями. Для каждого набора альтернативных конфигураций используйте одну ставку.
| Конфигурация | Шкала ставок | Расчётная единица | Плата |
|---|---|---|---|
| КонфигурацияБазовые тарифы на токены | Шкала ставокБазовая ставка | Расчётная единица— | Плата Вход · Входные токены — / 1K токенов Выход · Выходные токены — / 1K токенов Вход · Чтение кэша — / 1K токенов Вход · Запись в кэш — / 1K токенов Вход · Запись в кэш, 1 час — / 1K токенов |
| КонфигурацияUltra | Шкала ставок— | Расчётная единица/ 1K токенов | Плата Вход $0.0001 / 1K токенов |
Ailoot резервирует расчётную сумму перед запросом. После получения результата списывает итоговую плату по измеренному расходу. Для окончательного списания за потоковый ответ используется итоговая запись расхода. Как работают резервирование и расчёт →
Примеры запросов
Ailoot Ultra · Переранжирование
{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "voyageai/rerank-3",
"query": "What is the capital of France?",
"top_n": 3
}set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
: "${AILOOT_REQUEST_FILE:?Set your actual JSON request file}"
export AILOOT_REQUEST_FILE
python3 - <<'PY_REQUEST'
import json,os
from pathlib import Path
p=json.loads(Path(os.environ['AILOOT_REQUEST_FILE']).read_text(encoding='utf-8'))
if not isinstance(p,dict): raise SystemExit('Request must be a JSON object')
p['model']='voyageai/rerank-3'
Path('request.json').write_text(json.dumps(p,ensure_ascii=False),encoding='utf-8')
PY_REQUEST
curl --fail-with-body --silent --show-error https://api.ailoot.ai/v1/rerank \
-H "Authorization: Bearer $AILOOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @request.json -D response-headers.txt -o result.json
python3 - <<'PY_RESULT'
import json
from pathlib import Path
print(json.dumps(json.loads(Path('result.json').read_text()),ensure_ascii=False,indent=2))
PY_RESULT
Получить и сохранить результаты
Ailoot Ultra · Переранжирование
json
Сохраняйте все готовые результаты
Сохраняйте каждый полностью полученный ответ, файл и элемент содержимого.
Сохраняются каждый фактический индекс результата, конечное значение relevance_score и исходный объект документа. Индексы связаны с исходным массивом документов. Весь исходный JSON сохраняется и возвращается только после окончательного расчёта.
Если нужно проверить исходный ответ
Сохраните исходную операцию и полный либо частичный ответ; не повторяйте POST.
Поля ответа
| Поле | Тип |
|---|---|
Полеmodel | Типstring |
Полеid | Типstring |
Полеprovider | Типstring |
Полеresults[].index | Типinteger |
Полеresults[].relevance_score | Типnumber |
Полеresults[].document.text | Типstring |
Полеresults[].document.image | Типstring |
Полеusage.search_units | Типinteger |
Полеusage.total_tokens | Типinteger |
Полеusage.cost | Типnumber |
Ошибки и дальнейшие шаги
| Ответ | Условие | Следующий шаг |
|---|---|---|
Ответ400 · invalid_request_error | УсловиеНедопустимое обязательное поле, представление или значение | Следующий шагИсправьте указанное поле запроса. |
Псевдонимы
Псевдонимы моделей
Ailoot Ultra voyageai/rerank-3
Псевдонимы путей метода
Используйте пути методов, указанные выше.
Связанные ID для вызова
FAQ · VoyageAI by MongoDB: rerank-3
- Какие входные данные и результаты доступны?
POST /v1/rerank·voyageai/rerank-3:text→rerank- Какие поля использует запрос?
POST /v1/rerank·voyageai/rerank-3:documents,model,provider,query,session_id,top_n,trace,user- Какие ограничения действуют?
POST /v1/rerank·voyageai/rerank-3:top_n.minimum:1