機能の概要
このAPIは、入力されたドキュメントリストを再ソートし、クエリに最も関連するドキュメントの順序を返します。これは /api/v1/rerank API のエイリアスであり、動作は完全に一致します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/reranks
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
このAPIにはPathパラメータはありません。
Queryパラメータ
このAPIにはQueryパラメータはありません。
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | rerank-model-v1 | 再ソートに使用するモデル識別子 |
| query | string | はい | 何が機械学習か？ | クエリテキスト |
| documents | array | はい | ["ドキュメントAの内容", "ドキュメントBの内容"] | ソート対象のドキュメントリスト |
| input | object | いいえ | {} | 入力パラメータオブジェクト |
| top_n | integer | いいえ | 5 | 最も関連性の高い上位N件のドキュメントを返します。デフォルトでは全件返します |
| return_documents | boolean | いいえ | false | 結果にドキュメントの内容を含めるかどうか |
| parameters | object | いいえ | {} | モデル固有のパラメータ |
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
返されるデータの具体的な構造はモデルとパラメータによって異なり、通常はソート後のドキュメントインデックスやスコアなどの情報が含まれます。
リクエスト例
curl --request POST '{BASE_URL}/api/v1/reranks' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "rerank-model-v1",
"query": "何が機械学習ですか？",
"documents": ["機械学習は人工知能の一分野です...", "深層学習は機械学習の一種です..."],
"top_n": 3
}'
実行結果例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"results": [
{
"index": 0,
"relevance_score": 0.95
},
{
"index": 1,
"relevance_score": 0.82
}
]
}
}