bge-reranker-v2-m3
クエリに対して候補の文章を順位付けする、BAAIの多言語クロスエンコーダーです。各クエリと文章の組を一緒に読み、関連度スコアを返して検索候補を絞り込みます。回答の生成や文書埋め込みの作成は行いません。
モデルについて
この説明はモデルの機能を紹介するものです。Ailootで利用できる入力、出力、オプションは、選択したメソッドごとに以下に記載されています。
BGE Reranker v2 M3 は、BGE-M3 を基に構築された多言語の関連度モデルです。クエリと候補の文章を一緒に受け取り、その関係を表すスコアを返します。BAAI はこのエディションを、中国語や英語の検索を含む効率的な多言語リランカーとして位置付けています。検索アプリケーションで、既存の候補一覧を絞り込む場合に使います。
クエリと文章のペアから関連度を求める
クロスエンコーダーは両方のテキストを共同で処理し、内容を相互に作用させてから関連度スコアを生成します。各テキストを独立して符号化し、再利用可能なベクトル比較を行う埋め込みモデルとは異なります。リランカーの出力は、特定のペアに対するスカラーのスコアであり、文書ベクトルや文章による回答ではありません。
最初の検索で適切そうな文章が選ばれた後に使います。質問を各候補と組み合わせ、得られたスコアで候補を並べ替えます。これにより、大規模なコレクション内のすべての文章をクロスエンコーダーに調べさせる代わりに、管理可能な候補の短い一覧へ詳細な比較を集中できます。
v2 M3 エディション
メーカーは、BGE-M3 をベースモデルとして示し、多言語対応を主要な特長として挙げています。v2 リランカーファミリーの中で、M3 は効率的な多言語向けの選択肢です。Gemma ベースのモデルやレイヤー選択型のバリアントは、実装上の選択が異なる別モデルです。ここでの M3 という名前は、元の埋め込みモデルが持つ密、疎、マルチベクトルの埋め込みを、このリランカーが返すという意味ではありません。
この違いは、アプリケーションで必要な結果を選ぶ際に重要です。文書コレクションを表現して検索するには埋め込みモデルを選びます。すでに候補の文章があり、現在のクエリに最も関連する文章を判断するには、このリランカーを選びます。
有用に順位付けできる候補を用意する
実際の質問と、解釈に必要な候補の全文を提供します。文章の意味を決める見出しや近くの定義は保持してください。公開されている Transformers の例では、クエリと文章を一緒にトークン化し、切り詰めと max_length=512 を使っています。これは例の設定であり、モデル全体の上限ではありません。質問と必要な根拠を、選んだペアの枠内に収め、切り詰めで何が削除されるか確認します。クエリと同じ製品に言及する結果でも、別の操作や条件を扱っていれば無関係なことがあります。検索品質を評価するときは、これらを区別できる例を用意してください。
文書アシスタントでは、候補の識別子を文章と一緒に保持し、質問と文章のペアを採点して、選んだ原文を回答工程に渡します。回答モデルには、出典のない関連度スコアではなく、根拠そのものが渡されます。これは検索ワークフローの例です。リランカー自体は、外部コレクションの検索も、回答の執筆も行いません。
スコアの読み方と正規化
メーカーは、生の関連度スコアを返します。値が高いほど一致度が高いことを示します。文書化された任意の正規化では、シグモイド関数を適用し、スコアを 0〜1 に収めます。正規化されたスコアは扱いやすい範囲になりますが、この変換だけで、候補が正しいという較正済みの確率になるわけではありません。
順位付けやフィルタリングの閾値は、実際のワークロードを代表するクエリと文章のペアを使って選びます。同じキーワードを含みながら別の質問に答える文章と、異なる表現で関連する文章の両方を含めてください。これにより、選んだ閾値が検索対象のコレクションにとって意味を持ちます。
Ailoot API のプロジェクトでは、最終コンテキストに含めるべき内容と、効率的に調べられる候補数を定義します。有用な結果は、次のアプリケーション工程に向けて、より良い順序に並んだ根拠の集合です。このエディションの関連度出力を、文書埋め込み、生成文章、他のリランカーに文書化されたレイヤー選択の制御機能と区別して扱います。
Ailoot Ultra · 再ランキング POST /v1/rerank bge-reranker-v2-m3
bge-reranker-v2-m3はじめに
クエリに対して候補の文章を順位付けする、BAAIの多言語クロスエンコーダーです。各クエリと文章の組を一緒に読み、関連度スコアを返して検索候補を絞り込みます。回答の生成や文書埋め込みの作成は行いません。
- 対応する入力
- テキスト
- 結果
- 順位付きの結果
Ailootで利用可能 · 入力とメソッド
Ailoot Ultra · 再ランキング POST /v1/rerank
- 入力の種類
text- 出力の種類
rerank
| フィールド | 種類 | 要件 | 値と制限 | デフォルト |
|---|---|---|---|---|
フィールドmodel | 種類string | 要件必須 | 値と制限 bge-reranker-v2-m3 | デフォルト— |
フィールドquery | 種類string | 要件任意 | 値と制限 | デフォルト— |
フィールドdocuments | 種類array | 要件必須 | 値と制限 | デフォルト— |
メソッドのパラメータとライフサイクル
| パラメータ | 仕様 |
|---|---|
パラメータcontent_type | 仕様application/json |
パラメータrequired | 仕様model, documents |
パラメータmaterial_types | 仕様text |
パラメータmaterial_conditions | 仕様実際のクエリと、元のテキスト文書を格納した空でない配列を指定してください。結果のインデックスは、その元の配列を参照します。 |
ライフサイクル: synchronous_result_then_owned_library
GET /v1/media/assets/{asset_id}/content
GET /v1/media/assets
GET /v1/media/assets/{asset_id}
料金
料金情報はリクエストの機能を追加しません。対応するパラメーターは選択したメソッドに記載されています。
- 高速モード
- 未指定 高速モードが選択されている場合
- Flex モード
- 未指定 flex モードが選択されている場合
- 最大推論量
- 未指定 推論量が最大で、調整に既定値(default)を使用する場合
Ailootの料金
設定別の価格
各料金を表示された条件と照合してください。選択肢となる設定の各組には、いずれか1つの料金を適用します。
| 設定 | 料金表 | 課金単位 | 料金 |
|---|---|---|---|
| 設定基本トークン料金 | 料金表基本料金 | 課金単位— | 料金 入力 · 入力トークン — / 1K トークン 出力 · 出力トークン — / 1K トークン 入力 · キャッシュ読み取り — / 1K トークン 入力 · キャッシュ書き込み — / 1K トークン 入力 · キャッシュ書き込み、1時間 — / 1K トークン |
| 設定合計トークン | 料金表— | 課金単位/ 1K トークン | 料金 入力 · 合計トークン $0.00004 / 1K トークン |
Ailootはリクエスト前に見積額を確保します。結果の取得後、実測使用量に基づいて最終料金を精算します。ストリーミング時の精算には最終の使用量記録を使用します。金額の確保と精算の仕組み →
リクエスト例
Ailoot Ultra · 再ランキング
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
: "${AILOOT_QUERY:?Set the actual documented input value}"
export AILOOT_QUERY
: "${AILOOT_DOCUMENTS_JSON:?Set the actual documented input value}"
export AILOOT_DOCUMENTS_JSON
python3 - <<'PY_REQUEST'
import json,os
from pathlib import Path
request={'model': 'bge-reranker-v2-m3', 'query': '${ACTUAL_QUERY}', 'documents': '${ACTUAL_DOCUMENTS}'}
request['query']=os.environ['AILOOT_QUERY']
request['documents']=json.loads(os.environ['AILOOT_DOCUMENTS_JSON'])
Path('request.json').write_text(json.dumps(request,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 response.bin
# Retain the complete response and headers, every actual output, original returned identifiers and all usage fields. Recover the original operation without submitting creation again.
結果を受け取って保存
Ailoot Ultra · 再ランキング
設定されたレスポンスモデル、元の文書インデックス、関連度スコア、文書文字列、ネイティブのトークン使用量を含む、元のネイティブJSON結果全体。実際のすべての結果フィールドと使用量フィールドを保持してください。
GET /v1/media/assets/{asset_id}/contentGET /v1/media/assetsGET /v1/media/assets/{asset_id}
完了した結果をすべて保存
返された完全なレスポンス、ファイル、コンテンツ部分をすべて保存してください。
レスポンスとヘッダーの全体、実際の出力すべて、最初に返された識別子、使用量フィールドすべてを保存してください。作成リクエストを再送せずに、元の操作を復旧してください。
元のレスポンスを確認する場合
実際のX-Client-Request-IDと完全なレスポンスを保持してください。元の所有アセットと、その正確な署名付きコンテンツURLを読み取ってください。結果が不確かな作成リクエストは、決して再送信しないでください。
レスポンスのフィールド
| フィールド | 種類 | 意味 |
|---|---|---|
フィールドmodel | 種類string | 意味設定済みのソースコンシューマーが必要とする正確なレスポンスモデル。 |
フィールドresults[].index | 種類integer | 意味元の入力文書に対応する一意のインデックス。 |
フィールドresults[].relevance_score | 種類number | 意味有限値の関連度スコア。 |
フィールドresults[].document | 種類string | 意味この設定済みレスポンスコンシューマーが必要とする元のテキスト文書。 |
フィールドusage.total_tokens | 種類integer | 意味現在の受諾済み料金体系で必要とされる、有限かつ非負のネイティブトークン数。 |
エラーと次の手順
| レスポンス | 条件 | 次の手順 |
|---|---|---|
レスポンス400 · invalid_request_error | 条件JSON本文、または明示された正規モデルIDが無効です。 | 次の手順レスポンスを保持し、指摘されたリクエストフィールドを修正してください。 |
レスポンス401 · authentication_error | 条件Ailoot APIキーが無効です。 | 次の手順利用権限のあるAiloot APIキーを使用してください。 |
レスポンス403 · permission_error | 条件このキーのグループでは、このメソッドの利用が許可されていません。 | 次の手順返されたエラーの詳細を保持してください。 |
レスポンス404 · not_found_error | 条件選択したメソッドには、利用が許可されたルートがありません。 | 次の手順返されたエラーの詳細を保持してください。 |
レスポンス422 · price_unavailable | 条件受諾済みの料金体系に必要な入力量、またはその上限を取得できません。 | 次の手順レスポンスを保持し、受諾済みの料金体系で必要とされる入力表現を使用してください。 |
レスポンス503 · | 条件必要な保存領域、ルート、メソッド料金、または料金の仮押さえを利用できません。 | 次の手順元のレスポンス全体を保持してください。料金の仮押さえ状態が不明でも、再送信が認められるわけではありません。 |
レスポンス502 · billing_requires_check | 条件元の結果、使用量、または精算を確認する必要があります。 | 次の手順実際のリクエストIDと元のレスポンスを保持してください。既存の所有レコードを読み取ってください。作成リクエストを再送信しないでください。 |
エイリアス
モデルのエイリアス
Ailoot Ultra bge-reranker-v2-m3
メソッドパスのエイリアス
上記に表示されたメソッドパスを使用してください。
関連する呼び出し用ID
FAQ · bge-reranker-v2-m3
- 利用できる入力と結果は何ですか?
POST /v1/rerank·bge-reranker-v2-m3:text→rerank- リクエストはどの項目を使用しますか?
POST /v1/rerank·bge-reranker-v2-m3:model,query,documents