VoyageAI by MongoDB: rerank-2.5
rerank-2.5 は、渡されたテキスト候補群を、クエリと任意の自然言語の指示に対する関連性で並べ替えます。32,000 トークンのクエリ・文書コンテキストと、元の候補インデックスに結び付いた順位付きスコアを持つ、多言語対応の品質重視リランカーです。
モデルについて
この説明はモデルの機能を紹介するものです。Ailootで利用できる入力、出力、オプションは、選択したメソッドごとに以下に記載されています。
rerank-2.5 は、検索候補群を調整するために設計された Voyage AI の指示追従型リランカーです。クロスエンコーダーとしてクエリと各文書を一緒に調べ、関連性の順序を返します。開発元のリリースは、何を関連ありとするかの自然言語による制御、多言語検索、前の rerank-2 版より長いクエリ・文書コンテキストを重視しています。
比較する候補をモデルに渡す
入力は、クエリと候補テキスト文書の一覧です。埋め込み検索や語彙による第 1 段階の検索で選んだ文章を使えます。リランカーは資料群の埋め込みを作るのではなく、提供されたテキストを評価するため、実用上の役割は、最初の検索ですでに見つかった候補の調整です。
一覧の準備では、元の候補順序と出典識別子を保ってください。返されるインデックスは、それらの入力位置を指します。RAG の作業では、解釈に必要なタイトルや条件を含め、回答段階で実際に使い得る文章を渡します。送信した候補群にない関連文書が、再順位付けで新たに見つかった結果として現れることはありません。
意図する関連性の意味を指定する
指示はクエリの前後に追加できます。リリースは、文書の特定部分を強調する、出典の種類を優先する、アプリケーションの文脈でクエリのあいまいさを解消する、という 3 つの有用な役割を説明しています。これらは、モデルに提示する関連性判断の作業を変えます。
技術検索の指示例は、「失敗と復旧の挙動を説明する文章を優先してください。導入的な概要は二次的なものとします」です。調査資料群では、タイトル、手法、結果のどれが最も重要かを指定してください。あいまいな用語では、検索の対象分野を示します。一方が広い話題を求め、他方が知らないうちに作業を変えないよう、質問と指示を整合させてください。
これらの希望は、関連性の採点を導きます。アプリケーションに、出典のバージョン、日付、アクセス範囲など厳密な適格要件がある場合は、適格な候補群を別途用意してください。モデルへの関連性の指示と、決定論的な条件による候補集合の絞り込みは、異なる目的を持ちます。
順位付き出力と後での結果利用
結果は関連性の高い順に並び、浮動小数点の関連性スコアと、候補の元の入力インデックスを含みます。top-k オプションは返す上位結果数を選び、指定しなければ開発元の仕様では、送信した全候補の結果を返します。任意の return-documents 設定を使うと対応する元のテキストを含み、それ以外の応答はインデックスとスコアです。
その順序を使い、出典の識別情報を保ったまま、表示や後の回答段階に使う文章を選んでください。順位を評価する際は、実際の文章を確認します。スコアは、送信したクエリへの関連性の尺度であり、生成した回答や、文書の主張が正しいことの検証ではありません。このため、順位付けを専門分野の結論に変えることなく、技術、法律、金融、医療、会話、多言語の検索資料の調整に役立ちます。
コンテキスト、総トークン予算、切り詰め
文書化されたクエリ上限は、クエリ内に置いた指示を含めて 8,000 トークンです。クエリと 1 件の候補文書の合計は 32,000 トークン以内に収める必要があり、文書一覧は最大 1,000 件です。総枠は 600,000 トークンで、クエリのトークン数に文書数を掛け、すべての文書のトークン数を加えて数えます。したがって、長い指示は候補の組ごとに繰り返し数えられます。
出力の top-k 件数は、この入力トークン計算の候補数を変えません。デフォルトの切り詰めは、長すぎるクエリや文書をコンテキスト上限に合わせて短縮し、無効にすると長すぎるクエリや組でエラーが返ります。答えを含む文章を意識して用意し、モデルが見るテキストの中に関連する条件を残してください。代表的な質問と指示で調整後の順序を評価し、選んだ元の文章を次の段階に渡します。
Ailoot Ultra · 再ランキング POST /v1/rerank voyageai/rerank-2.5
voyageai/rerank-2.5はじめに
rerank-2.5 は、渡されたテキスト候補群を、クエリと任意の自然言語の指示に対する関連性で並べ替えます。32,000 トークンのクエリ・文書コンテキストと、元の候補インデックスに結び付いた順位付きスコアを持つ、多言語対応の品質重視リランカーです。
- 対応する入力
- テキスト
- 結果
- 順位付きの結果
Ailootで利用可能 · 入力とメソッド
Ailoot Ultra · 再ランキング POST /v1/rerank
- 入力の種類
text- 出力の種類
rerank- 出力形式
- json
| フィールド | 種類 | 要件 | 値と制限 | デフォルト |
|---|---|---|---|---|
フィールドdocuments | 種類array | 要件必須 | 値と制限 | デフォルト— |
フィールドmodel | 種類string | 要件必須 | 値と制限 voyageai/rerank-2.5 | デフォルト— |
フィールド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の料金
設定別の価格
各料金を表示された条件と照合してください。選択肢となる設定の各組には、いずれか1つの料金を適用します。
| 設定 | 料金表 | 課金単位 | 料金 |
|---|---|---|---|
| 設定基本トークン料金 | 料金表基本料金 | 課金単位— | 料金 入力 · 入力トークン — / 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-2.5",
"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-2.5'
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-2.5
メソッドパスのエイリアス
上記に表示されたメソッドパスを使用してください。
関連する呼び出し用ID
FAQ · VoyageAI by MongoDB: rerank-2.5
- 利用できる入力と結果は何ですか?
POST /v1/rerank·voyageai/rerank-2.5:text→rerank- リクエストはどの項目を使用しますか?
POST /v1/rerank·voyageai/rerank-2.5:documents,model,provider,query,session_id,top_n,trace,user- どの制限が適用されますか?
POST /v1/rerank·voyageai/rerank-2.5:top_n.minimum:1