機能の概要
リランキングAPIは、テキストおよびマルチモーダルなリクエストに対応しています。このAPIは、クエリとドキュメントのセットを受け取り、クエリとドキュメントの関連性に基づいてドキュメントを再ランキングし、ソート後の結果を返します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/rerank
リクエストヘッダー
プロパティ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
このAPIにはPathパラメータはありません。
Queryパラメータ
このAPIにはQueryパラメータはありません。
Bodyパラメータ
プロパティ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | bge-reranker-v2-m3 | リランキングに使用するモデル名 |
| query | string | はい | 何が人工知能か？ | クエリテキスト |
| documents | array | はい | ["ドキュメント1の内容", "ドキュメント2の内容"] | ソート対象のドキュメントリスト |
| input | object | いいえ | - | 入力オブジェクト（マルチモーダルリクエスト時に使用） |
| top_n | integer | いいえ | 5 | 最も関連性の高い上位n件の結果を返します。デフォルトでは全件返します |
| return_documents | boolean | いいえ | false | 結果に元のドキュメントの内容を含めるかどうか |
| parameters | object | いいえ | - | モデル固有のパラメータ設定 |
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | 業務データ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| results | array | 並べ替え後の結果リスト。各要素にはドキュメントインデックスや関連性スコアなどの情報が含まれます |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/rerank' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "bge-reranker-v2-m3",
"query": "何が人工知能ですか？",
"documents": ["人工知能とは、人間の知能を模倣し、拡張するための理論、方法、技術、および応用システムを研究・開発する新しい技術科学です。", "機械学習は人工知能の一分野であり、明示的にプログラムすることなくコンピュータが学習できるようにします。"],
"top_n": 2,
"return_documents": false
}'
実行例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"results": [
{
"index": 0,
"relevance_score": 0.95
},
{
"index": 1,
"relevance_score": 0.82
}
]
}
}