AGTCloud API Docs
ガイドAPIリファレンス連携とリソース更新とヘルプ

Rerank

クエリと候補ドキュメントを使用して、関連性に基づく精密な並べ替えを行います。

概要

Rerankは1つのクエリと候補ドキュメントの集合を受け取り、関連性の順に結果を返します。通常はベクトル検索、キーワード検索、またはハイブリッド検索の後に配置し、限られた候補からより関連性の高いコンテンツを選択するために使用します。

API接続

Base URL

https://api.agtcloud.cn/v1

リランキングを実行する

次の例では、Jina形式のPOST /v1/rerankリクエストを使用します。

curl 'https://api.agtcloud.cn/v1/rerank' \
  -H 'Authorization: Bearer your-api-key' \
  -H 'Content-Type: application/json' \
  --data '{
    "model": "MODEL_ID",
    "query": "API Keyはどのように保存すればよいですか?",
    "documents": [
      "API Keyはサーバー側の環境変数またはシークレット管理サービスに保存します。",
      "モデルマーケットプレイスでは現在利用可能なモデルを確認できます。",
      "実際のAPI Keyをブラウザのフロントエンドや公開リポジトリに保存しないでください。"
    ],
    "top_n": 2
  }'
パラメータ必須説明
modelいいえRerankモデルID。省略できるかどうかは選択した形式によって異なります
queryはい関連性の判定に使用するクエリテキスト
documentsはい並べ替える候補ドキュメントの配列
top_nいいえ返す結果の数

結果を読み取る

結果は関連性の順に並びます。results[].indexを使用して元のdocumentsに対応付け、results[].relevance_scoreから関連性スコアを読み取ります。

リクエスト形式を選択する

形式リクエストパスAPI Reference
JinaPOST /v1/rerankJina Rerank
CoherePOST /v1/rerankCohere Rerank
XinferencePOST /v1/rerankXinference Rerank

関連性スコアを理解する

  • 関連性スコアは確率ではありません。
  • スコアは主に、同じリクエスト内の候補順序を比較するために使用します。
  • しきい値とtop_nは、実際の業務データを使って評価してください。

関連情報

このページの内容