ドキュメントの再ランク

POST /rerank

API キー認証

クエリへの関連性に基づいてドキュメントのリストを再ランク付けします。

このエンドポイントとなる接続されたデバイスはクエリとドキュメントのリストを受け入れ、関連性スコアの降順で並べ替えられたドキュメントを返します。

application/ JSON

body 必須

クエリ string 必須
stringとしての検索クエリ。

最大クエリ長：
- rerank-2.5 と rerank-2.5-lite の 8,000 トークン
- 4,000 tokens for rerank-2
- 2,000 tokens for rerank-2-lite
最小長は 1 です。
ドキュメント array[string] 必須
再ランク付けするドキュメントのリスト（string として提供）。

制約:
- ドキュメントの最大数: 1、000
- クエリ +ドキュメントペアあたりの最大トークン:
  - rerank-2.5 と rerank-2.5-lite では 32、000
  - の 16,000 rerank-2
  - の 8,000 rerank-2-lite
- トークンの最大合計数（クエリトークン x ドキュメント数 + すべてのドキュメントトークンの合計）:
  - rerank-2.5、rerank-2.5-lite、rerank-2、rerank-2-lite の 600K
少なくとも 1 を、1000 以下の要素を含めます。各の最小長は 1 です。
モデル string 必須

使用する再ランク付けモデル。推奨モデル: rerank-2.5、rerank-2.5-lite

値は、rerank-2.5、rerank-2.5-lite、rerank-2、または rerank-2-lite です。
top_k 整数 | null

返される最も関連性の高いドキュメントの数。指定しない場合、すべてのドキュメントが再ランク化スコアとともに返されます。

の最小値は 1 です。
return_documents ブール値
応答にドキュメントテキストを含めるかどうか。
- false （デフォルト）: 各ドキュメントに対して {"index", "relevance_score"} のみを返します
- true: 各ドキュメントに対して {"index", "document", "relevance_score"} を返します
デフォルト値はfalseです。
切り捨てブール値
コンテキストの長さ制限を超える入力を切り捨てるかどうか。
- true （デフォルト）: クエリとドキュメントは、コンテキストの長さ制限内に収まるように自動的に切り捨てられます。
- false: クエリまたはクエリとドキュメントのペアがコンテキストの長さ制限を超えると、エラーが返されます。
デフォルト値はtrueです。

応答

200 application/ JSON

成功
応答属性の非表示応答属性の表示オブジェクト
- オブジェクト string 必須
  
  Realm オブジェクトタイプ。常に「list」を返します。
  
  値は list です。
- データ array[オブジェクト] 必須
  
  関連性スコアの降順でソートされた、再ランク付けされた結果の配列。
  
  データ属性の非表示データ属性の表示オブジェクト
  
  index integer 必須
  
  元の入力リスト内のドキュメントのインデックス。
  
  関連性_score 数値必須
  
  クエリに対するドキュメントの関連性スコア。
  
  ドキュメント string
  
  ドキュメントのテキスト。return_documents が true に設定されている場合にのみ含まれます。
- モデル string 必須
  
  再ランク付けに使用されるモデルの名前。
- 使用法オブジェクト必須
  
  使用属性を非表示使用属性の表示オブジェクト
  
  total_tokens integer 必須
  
  リランク操作で処理されたトークンの合計数。
400 application/ JSON

Invalid Request
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  リクエストは無効です。このエラーは、無効なJSON、無効なパラメータ型、誤ったデータ型、バッチするサイズが大きすぎる、トークンの合計が制限を超える、または例内のトークンがコンテキストの長さを超えるために発生する可能性があります。
401 application/ JSON

許可されていない
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  認証が無効です。モデルAPIキーが Authorization ヘッダーに Bearer VOYAGE_API_KEY として正しく指定されていることを確認します。
403 application/ JSON

Forbidden
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  アクセスは禁止されています。リクエストのリクエスト元IPアドレスが許可されていない場合、この状況が発生することがあります。
429 application/ JSON

レート制限を超えました
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  レート制限を超えました。リクエスト頻度またはトークン使用量が高すぎます。リクエストレートを減らすか、再試行する前に待機します。
500 application/ JSON

内部サーバーエラー
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  サーバーで予期しないエラーが発生しました。短時間待機した後に、リクエストを再試行します。
502 application/ JSON

バードゲートウェイ
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  サーバーはアップストリームサーバーから無効な応答を受信しました。短時間待機した後に、リクエストを再試行します。
503 application/ JSON

サービスは利用できません
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  トラフィック量やメンテナンスが多いため、サービスは一時的に利用できなくなります。短時間待機した後に、リクエストを再試行します。
504 application/ JSON

ゲートウェイタイムアウト
応答属性を非表示応答属性の表示オブジェクト
- 詳細 string
  
  サーバーは上流サーバーから時間に応じた応答を受信しませんでした。短時間待機した後に、リクエストを再試行します。

POST /rerank

curl \
 --request POST 'https://ai.mongodb.com/v1/rerank' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"query":"string","documents":["string"],"model":"rerank-2.5","top_k":42,"return_documents":false,"truncation":true}'

リクエスト例

{
  "query": "string",
  "documents": [
    "string"
  ],
  "model": "rerank-2.5",
  "top_k": 42,
  "return_documents": false,
  "truncation": true
}

応答の例（200）

{
  "object": "list",
  "data": [
    {
      "index": 42,
      "relevance_score": 42.0,
      "document": "string"
    }
  ],
  "model": "string",
  "usage": {
    "total_tokens": 42
  }
}

応答の例（400）

{
  "detail": "string"
}

応答の例（401）

{
  "detail": "string"
}

応答の例（403）

{
  "detail": "string"
}

応答の例（429）

{
  "detail": "string"
}

応答の例（500）

{
  "detail": "string"
}

応答の例（502）

{
  "detail": "string"
}

応答の例（503）

{
  "detail": "string"
}

応答の例（504）

{
  "detail": "string"
}