I-rerank ang mga dokumento
Magbigay ng query at 1–1000 na mga dokumento.
Sa pahinang ito
https://api.shareai.now/api/v1/rerankI-rerank ang mga dokumento
- Base URL
https://api.shareai.now- Pagpapatunay
- Bearer API key o aprubadong OAuth access token
- Kinakailangang scope
inferenceormonetization_gateway
Magbigay ng query at 1–1000 na dokumento. Ang bawat dokumento ay teksto, isang {"text":"..."} object o isang model-supported {"image":"https://..."} bagay. top_n dapat ay hindi bababa sa 1 at hindi hihigit sa bilang ng dokumento. Itugma ang mga resulta sa mga orihinal na indeks ng dokumento.
Bago ka magsimula#
Itakda ang SHAREAI_API_KEY sa iyong server at palitan ang placeholder ng modelo ng kasalukuyang pinapaganang modelo. Huwag kailanman ilantad ang API key sa browser code. Ang modelo, account, kredensyal, at provider ay dapat lahat pahintulutan ang operasyong ito. Ang mga opsyonal na setting sa ibaba ay nangangailangan ng suporta ng modelo; ang mga hangganan ng kaligtasan ng API ay hindi pangako na ang bawat modelo ay sumusuporta sa bawat halaga.
Magpadala ng kahilingan#
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
}'Python
import json
import os
import urllib.request
payload = {'model': 'YOUR_ENABLED_RERANK_MODEL',
'query': 'A cat',
'documents': [{'text': 'A cat on a windowsill.'},
{'text': 'A map of Berlin.'}],
'top_n': 1}
headers = {'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["SHAREAI_API_KEY"]
request = urllib.request.Request('https://api.shareai.now/api/v1/rerank', data=json.dumps(payload).encode(), headers=headers, method="POST")
with urllib.request.urlopen(request, timeout=180) as response:
result = json.load(response)
print(result)TypeScript
const response = await fetch("https://api.shareai.now/api/v1/rerank", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`, ...{"Content-Type": "application/json"} },
body: JSON.stringify({
"model": "YOUR_ENABLED_RERANK_MODEL",
"query": "A cat",
"documents": [
{
"text": "A cat on a windowsill."
},
{
"text": "A map of Berlin."
}
],
"top_n": 1
}),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
console.log(result);Mga field ng kahilingan#
| Patlang | Uri | Kahulugan at mga limitasyon |
|---|---|---|
model kinakailangan | string | Eksaktong pinapaganang pampublikong identifier ng modelo. Dapat ideklara ang operasyong ito at pahintulutan ng iyong kredensyal. |
query kinakailangan | string | Hindi walang laman na query sa kaugnayan. |
documents kinakailangan | array | 1–1000 na hindi walang laman na mga string ng teksto o mga object na may isang key na teksto/larawan. Ang mga halaga ng larawan ay dapat HTTPS URLs o suportadong mga data URL ng larawan, na may suporta ng modelo para sa input ng larawan. |
top_n | integer | Opsyonal na bilang ng resulta mula 1 hanggang sa bilang ng mga dokumento. Ang mga ibinalik na indeks ay tumutukoy sa orihinal na array ng dokumento. |
return_documents | boolean | Opsyonal na provider-supported na pagsasama ng mga orihinal na dokumento sa resulta. |
provider | bagay | Opsyonal na mga kagustuhan sa pag-route ng provider. Gamitin ang provider.only para sa mga tinatanggap na tag ng provider, hindi isang prefix sa model ID. Ang mga paghihigpit sa account at kredensyal ay nalalapat pa rin. |
Basahin ang resulta#
Ang tagumpay ay nagbabalik ng HTTP 200 na may JSON. Magbigay ng query at 1–1000 na dokumento. Ang bawat dokumento ay teksto, isang {"text":"..."} object o isang model-supported {"image":"https://..."} bagay. top_n dapat ay hindi bababa sa 1 at hindi hihigit sa bilang ng dokumento. Itugma ang mga resulta sa mga orihinal na indeks ng dokumento.
Mga yunit ng pagsingil#
Ang mga rate ng rerank ay maaaring gumamit ng input tokens, mga dokumentong na-score, mga kahilingan o isang iniulat na dami ng paghahanap ng provider. Walang ipinapalagay na unibersal na conversion ng paghahanap-sa-token. Ang isang provider na hindi makapag-ulat ng isang priced dimension ay hindi magagamit para sa taripa na iyon.
Piliin ang eksaktong pinapaganang identifier ng modelo mula sa Console. Ang idineklarang operasyon nito at mga kakayahan sa input/output ay dapat tumugma sa endpoint na ito; ang isang text chat model ay hindi maaaring palitan para sa ibang operasyon. Ang iyong kredensyal, provider, at mga paghihigpit sa account ay nalalapat pa rin.
Pagpepresyo at paggamit#
Ang mga rate ay inilathala sa EUR AI credits para sa napiling modelo, provider, mga yunit, at mga variant. Ang mga sukat lamang sa aktibong taripa nito ang sinisingil. Ang isang pagtatantya ay nagrereserba ng mga kredito bago ang pagpapatupad; ang mga huling singil ay gumagamit ng nasukat na paggamit. Ang mga presyo ay maaaring depende sa resolusyon, format ng output, o isang banda ng paggamit. Suriin ang Console Usage para sa huling ShareAI debit. Ang mga field ng gastos sa upstream at media bytes ay hindi iko-convert sa mga imbentong bilang ng token.
Pag-access at mga error#
Gamitin inference para sa aprubadong inference ng network-cost o monetization_gateway para sa isang aprubadong markup ng Builder at tinatanggap na mga tuntunin sa pagsingil. Ang access na identity-only ay hindi nagbibigay ng awtorisasyon sa paggastos. Ang validation, awtorisasyon ng modelo, hindi sapat na kredito, mga limitasyon sa rate, at mga pagkabigo sa pagpapatupad ay nagbabalik ng structured error. Pagkatapos ng timeout o hindi tiyak na pagsusumite, suriin ang Usage o ang video job bago lumikha ng isa pang posibleng bayad na kahilingan.
Huling na-update Nobyembre 3, 2026