Rerangking dokumen
Sediakan query lan 1–1000 dokumen.
Ing kaca iki
https://api.shareai.now/api/v1/rerankRerangking dokumen
- URL Dasar
https://api.shareai.now- Otentikasi
- Bearer API key utawa token akses OAuth sing disetujui
- Lingkup sing dibutuhake
inferenceormonetization_gateway
Nyedhiyakake query lan 1–1000 dokumen. Saben dokumen iku teks, {"text":"..."} obyek utawa model-dhukung {"image":"https://..."} obyek. top_n kudu paling ora 1 lan ora luwih saka jumlah dokumen. Cocogake asil karo indeks dokumen asli.
Sadurunge sampeyan miwiti#
Set SHAREAI_API_KEY ing server sampeyan lan ganti placeholder model karo model sing saiki diaktifake. Aja tau mbukak API key ing kode browser. Model, akun, kredensial lan panyedhiya kudu kabeh ngidini operasi iki. Setelan opsional ing ngisor iki mbutuhake dhukungan model; watesan safety API ora janji yen saben model ndhukung saben nilai.
Kirim panjalukan#
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);Lapangan panjalukan#
| Lapangan | Tipe | Makna lan watesan |
|---|---|---|
model dibutuhake | string | Identifikasi model publik sing diaktifake kanthi tepat. Kudu nyatakake operasi iki lan diidini dening kredensial sampeyan. |
query dibutuhake | string | Query relevansi sing ora kosong. |
documents dibutuhake | array | 1–1000 string teks sing ora kosong utawa obyek teks/gambar kunci tunggal. Nilai gambar kudu URL HTTPS utawa URL data gambar sing didhukung, kanthi dhukungan input gambar model. |
top_n | integer | Jumlah asil opsional saka 1 nganti jumlah dokumen. Indeks sing dikembalikan nuduhake array dokumen asli. |
return_documents | boolean | Kalebu dokumen asli sing didhukung panyedhiya ing asil minangka pilihan. |
provider | obyek | Preferensi routing panyedhiya opsional. Gunakake provider.only kanggo tag panyedhiya sing ditampa, dudu prefiks ing ID model. Watesan akun lan kredensial isih ditrapake. |
Maca asil#
Sukses ngasilake HTTP 200 kanthi JSON. Nyedhiyakake query lan 1–1000 dokumen. Saben dokumen iku teks, {"text":"..."} obyek utawa model-dhukung {"image":"https://..."} obyek. top_n kudu paling ora 1 lan ora luwih saka jumlah dokumen. Cocogake asil karo indeks dokumen asli.
Unit tagihan#
Tingkat rerank bisa nggunakake token input, dokumen sing di-score, panjalukan utawa jumlah telusuran sing dilaporake panyedhiya. Ora ana konversi universal saka telusuran menyang token sing dianggep. Panyedhiya sing ora bisa nglaporake dimensi sing dikenani biaya ora kasedhiya kanggo tarif kasebut.
Pilih identifier model sing diaktifake kanthi tepat saka Console. Operasi sing diumumake lan kemampuan input/output kudu cocog karo endpoint iki; model obrolan teks ora bisa diganti kanggo operasi liyane. Watesan kredensial, panyedhiya lan akun sampeyan isih ditrapake.
Harga lan panggunaan#
Tarif diterbitake ing kredit AI EUR kanggo model sing dipilih, panyedhiya, unit lan varian. Mung dimensi ing tarif aktif sing dikenani biaya. Perkiraan nyimpen kredit sadurunge eksekusi; biaya pungkasan nggunakake panggunaan sing diukur. Harga bisa gumantung saka resolusi, format output utawa pita panggunaan. Priksa Console Usage kanggo debit ShareAI pungkasan. Lapangan biaya hulu lan byte media ora dikonversi dadi jumlah token sing diada-adakan.
Akses lan kesalahan#
Gunakake inference kanggo inferensi biaya jaringan sing disetujui utawa monetization_gateway kanggo markup Builder sing disetujui lan syarat tagihan sing ditampa. Akses identitas mung ora ngidini pengeluaran. Validasi, otorisasi model, kredit sing ora cukup, watesan tarif lan kegagalan eksekusi ngasilake error. Sawise timeout utawa kiriman sing ora pasti, priksa Usage utawa tugas video sadurunge nggawe panjalukan liyane sing bisa dikenani biaya.
Pungkasan dianyari 3 Novèmber 2026