ShareAI Platform Docs

文書を再ランク付け

クエリと1~1000件のドキュメントを提供してください。.

Markdownとして表示
このページについて
POST https://api.shareai.now/api/v1/rerank

文書を再ランク付け

ベースURL
https://api.shareai.now
認証
Bearer APIキーまたは承認済みOAuthアクセストークン
必須スコープ
inference or monetization_gateway

クエリと1~1000件のドキュメントを提供してください。各ドキュメントはテキスト、 {"text":"..."} オブジェクト、またはモデル対応の {"image":"https://..."} オブジェクトです。. top_n 少なくとも1以上、ドキュメント数以下である必要があります。結果を元のドキュメントインデックスに一致させます。.

始める前に#

サーバーにSHAREAI_API_KEYを設定し、モデルプレースホルダーを現在有効なモデルに置き換えてください。APIキーをブラウザコードで公開しないでください。モデル、アカウント、資格情報、プロバイダーはすべてこの操作を許可する必要があります。以下のオプション設定はモデルのサポートが必要です。APIの安全範囲は、すべてのモデルがすべての値をサポートすることを保証するものではありません。.

リクエストを送信#

cURL

curl --fail-with-body --request POST "https://api.shareai.now/api/v1/rerank" \
  -H "Authorization: Bearer $SHAREAI_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "model": "YOUR_ENABLED_RERANK_MODEL",
  "query": "A cat",
  "documents": [
    {
      "text": "A cat on a windowsill."
    },
    {
      "text": "A map of Berlin."
    }
  ],
  "top_n": 1
}'

リクエストフィールド#

フィールドタイプ意味と制限
model 必須文字列有効な公開モデル識別子を正確に指定してください。この操作を宣言し、資格情報で許可されている必要があります。.
query 必須文字列空でない関連性クエリ。.
documents 必須配列1~1000件の空でないテキスト文字列または単一キーのテキスト/画像オブジェクト。画像値はHTTPS URLまたはモデルが対応する画像データURLである必要があります。.
top_n整数ドキュメント数までのオプションの結果数。返されるインデックスは元のドキュメント配列を参照します。.
return_documentsブール値オプションでプロバイダー対応の元ドキュメントを結果に含めることができます。.
providerオブジェクトオプションのプロバイダールーティング設定。プロバイダータグを受け入れる場合はprovider.onlyを使用してください。モデルIDのプレフィックスとして使用しないでください。アカウントと資格情報の制限は依然として適用されます。.

結果を読む#

成功時はHTTP 200とJSONを返します。クエリと1~1000件のドキュメントを提供してください。各ドキュメントはテキスト、 {"text":"..."} オブジェクト、またはモデル対応の {"image":"https://..."} オブジェクトです。. top_n 少なくとも1以上、ドキュメント数以下である必要があります。結果を元のドキュメントインデックスに一致させます。.

請求単位#

再ランク付け率は入力トークン、スコア付けされたドキュメント、リクエスト、またはプロバイダーが報告する検索量を使用できます。トークンへの検索変換の普遍的な仮定はありません。価格次元を報告できないプロバイダーはその料金プランでは利用できません。.

Consoleから正確な有効モデル識別子を選択してください。その宣言された操作と入出力機能がこのエンドポイントに一致する必要があります。テキストチャットモデルを別の操作に代用することはできません。資格情報、プロバイダー、アカウントの制限は依然として適用されます。.

料金と使用状況#

料金は選択されたモデル、プロバイダー、単位、バリアントに対してEUR AIクレジットで公開されます。そのアクティブな料金の次元のみが請求されます。見積もりは実行前にクレジットを予約します。最終的な請求は測定された使用量を使用します。料金は解像度、出力形式、または使用帯域によって異なる場合があります。最終的なShareAIのデビットはConsole Usageで確認してください。上流のコストフィールドやメディアバイトは、発明されたトークン数に変換されません。.

アクセスとエラー#

使用する inference 承認されたネットワークコスト推論または monetization_gateway 承認されたBuilderのマークアップおよび受け入れられた請求条件に基づきます。アイデンティティのみのアクセスでは支出は許可されません。検証、モデル認証、不足クレジット、レート制限、実行失敗は構造化された error. タイムアウトや送信の不確実性が発生した場合、別の有料リクエストを作成する前にUsageまたはビデオジョブを確認してください。.

最終更新日 2026年11月3日

ShareAIプラットフォームドキュメント
すべてのドキュメント

タイトルまたは内容で検索してください。

このページについて質問する

このページを探索するためのアシスタントを選択してください。または、ページをコピーして会話に貼り付けることもできます。

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI