AI Search Open Platform を使用すると、API 経由でドキュメント関連性スコアリング サービスを呼び出すことができます。 このサービスをビジネス ワークフローに統合して、検索パフォーマンスを向上させることができます。
サービス名 | サービス ID | サービスの説明 | API 呼び出しの QPS 制限（Alibaba Cloud アカウントおよび RAM ユーザー） |
BGE 再ランクモデル | ops-bge-reranker-larger | BGE モデルに基づくドキュメント スコアリング サービスを提供します。 クエリとドキュメントの内容の関連性に基づいて、スコアの高い順にドキュメントをランク付けし、対応するスコアリング結果を出力できます。 このモデルは中国語と英語の両方をサポートし、最大入力トークン長は 512（クエリ + ドキュメント）です。 | 20 説明 より高い QPS を申請するには、チケットを送信してください。 |
OpenSearch テキスト再ランクモデル 001 | ops-text-reranker-001 | 複数の業界データセットからのトレーニングを統合した OpenSearch によって開発された再ランクモデルであり、高品質の再ランクサービスを提供します。 クエリとドキュメントのセマンティックな関連性に基づいて、スコアの高い順にドキュメントをランク付けできます。 このモデルは中国語と英語の両方をサポートし、最大入力トークン長は 512（クエリ + ドキュメント）です。 | |
Qwen3 ランクサービス 0.6B | ops-qwen3-reranker-0.6b | Qwen3 シリーズ ドキュメント再ランクサービス。100 以上の言語をサポートし、最大入力トークン長は 32k（クエリ + ドキュメント）、パラメーターは 0.6B です。 |
前提条件
認証情報が取得されている。
API を使用して AI Search Open Platform サービスを呼び出す場合は、呼び出し元の ID を認証する必要があります。
サービス アクセス アドレスが取得されている。
インターネットまたは VPC（Virtual Private Cloud）経由でサービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。
リクエストの説明
概要
リクエスト本文は 8 MB を超えてはなりません。
リクエストメソッド
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/ranker/{service_id} パラメーターの説明:
host: サービス エンドポイント。 インターネット経由または VPC 経由で API サービスを呼び出すことができます。 詳細については、「サービス登録アドレスを取得する」をご参照ください。
workspace_name: ワークスペースの名前（例: default）。
service_id: ビルトイン サービス ID（例: ops-bge-reranker-larger）。
リクエスト パラメーター
ヘッダー パラメーター
API-KEY 認証
パラメーター | タイプ | 必須 | 説明 | 値の例 |
Content-Type | String | はい | リクエスト タイプ: application/json | application/json |
Authorization | String | はい | API-Key | Bearer OS-d1**2a |
本文パラメーター
パラメーター | タイプ | 必須 | 説明 | 値の例 |
query | String | はい | クエリの内容。 | What are the fun places in Shanghai? |
docs | List<String> | はい | ドキュメントの内容（リスト）。 | ["There are many fun places in Shanghai", "There are many fun places in Beijing"] |
レスポンス パラメーター
パラメーター | タイプ | 説明 | 値の例 |
request_id | String | リクエスト ID。 | A5B25952-4406-45BF-99EC-E8020246**** |
latency | Float/Int | リクエストのレイテンシ。 単位: ミリ秒。 | 10 |
usage.doc_count | Int | このリクエストにおける入力ドキュメントの数。 | 2 |
result.scores | List<score> | スコアの最も高いものから最も低いものの順にランク付けされたドキュメントの結果。 | [ { "index":1, "score":0.99 }, { "index":2, "score":0.05 } ] |
result.scores[].index | Int | 入力候補ドキュメント配列におけるこのドキュメントの位置インデックス値。 | 1 |
result.scores[].score | Float | スコアリング結果。 値が高いほど、関連性が高いことを示します。 | 0.99 |
Curl リクエスト例
curl -XPOST -H"Content-Type: application/json"
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/ranker/ops-bge-reranker-larger"
-H "Authorization: Bearer your API-KEY"
-d "{
\"query\":\"opensearch documentation\",
\"docs\":[
\"what is opensearch\",
\"what is LLM-based conversational search edition\",
\"What is the advantage of LLM-based conversational search edition\"
]
}"レスポンス例
正常なレスポンス例
{
"request_id":"24B004E0-ADEF-****-879B-F28359BFAD1D",
"latency":19,
"usage":{
"doc_count":3
},
"result":{
"scores":[
{
"index":0,"score":0.45026873385713345
},
{
"index":1,"score":1.1412238544346029E-4
},
{
"index":2,"score":8.029784284533197E-5
}
]
}
}異常なレスポンス例
アクセス リクエスト中にエラーが発生した場合、出力では code および message によってエラーの理由が指定されます。
{
"request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Unexpected character ..."
}ステータス コード
詳細については、「ステータス コード」をご参照ください。