Mengurutkan ulang dokumen
Sediakan kueri dan 1–1000 dokumen.
Di halaman ini
https://api.shareai.now/api/v1/rerankMengurutkan ulang dokumen
- URL Dasar
https://api.shareai.now- Otentikasi
- Kunci API Bearer atau token akses OAuth yang disetujui
- Cakupan yang diperlukan
inferenceormonetization_gateway
Berikan sebuah kueri dan 1–1000 dokumen. Setiap dokumen berupa teks, sebuah {"text":"..."} objek atau objek yang didukung model. {"image":"https://..."} objek. top_n harus minimal 1 dan tidak lebih dari jumlah dokumen. Cocokkan hasil dengan indeks dokumen asli.
Sebelum Anda memulai#
Atur SHAREAI_API_KEY di server Anda dan ganti placeholder model dengan model yang saat ini diaktifkan. Jangan pernah mengekspos kunci API dalam kode browser. Model, akun, kredensial, dan penyedia semuanya harus mengizinkan operasi ini. Pengaturan opsional di bawah ini memerlukan dukungan model; batas keamanan API bukanlah janji bahwa setiap model mendukung setiap nilai.
Kirim permintaan#
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);Bidang permintaan#
| Bidang | Tipe | Makna dan batasan |
|---|---|---|
model diperlukan | string | Pengidentifikasi model publik yang diaktifkan secara tepat. Harus mendeklarasikan operasi ini dan diizinkan oleh kredensial Anda. |
query diperlukan | string | Kueri relevansi tidak boleh kosong. |
documents diperlukan | array | 1–1000 string teks tidak kosong atau objek teks/gambar dengan satu kunci. Nilai gambar harus berupa URL HTTPS atau URL data gambar yang didukung, dengan dukungan input gambar model. |
top_n | bilangan bulat | Jumlah hasil opsional dari 1 hingga jumlah dokumen. Indeks yang dikembalikan merujuk pada array dokumen asli. |
return_documents | boolean | Penyertaan dokumen asli dalam hasil yang didukung penyedia bersifat opsional. |
provider | objek | Preferensi routing penyedia opsional. Gunakan provider.only untuk tag penyedia yang diterima, bukan awalan dalam ID model. Pembatasan akun dan kredensial tetap berlaku. |
Baca hasilnya#
Keberhasilan mengembalikan HTTP 200 dengan JSON. Berikan sebuah kueri dan 1–1000 dokumen. Setiap dokumen berupa teks, sebuah {"text":"..."} objek atau objek yang didukung model. {"image":"https://..."} objek. top_n harus minimal 1 dan tidak lebih dari jumlah dokumen. Cocokkan hasil dengan indeks dokumen asli.
Unit penagihan#
Tarif rerank dapat menggunakan token input, dokumen yang diberi skor, permintaan, atau jumlah pencarian yang dilaporkan penyedia. Tidak ada konversi universal dari pencarian ke token yang diasumsikan. Penyedia yang tidak dapat melaporkan dimensi yang diberi harga tidak tersedia untuk tarif tersebut.
Pilih pengidentifikasi model yang diaktifkan secara tepat dari Console. Operasi yang dideklarasikan dan kemampuan input/output-nya harus sesuai dengan endpoint ini; model chat teks tidak dapat diganti untuk operasi lain. Pembatasan kredensial, penyedia, dan akun Anda tetap berlaku.
Harga dan penggunaan#
Tarif diterbitkan dalam kredit AI EUR untuk model, penyedia, unit, dan varian yang dipilih. Hanya dimensi dalam tarif aktifnya yang dikenakan biaya. Perkiraan akan memesan kredit sebelum eksekusi; biaya akhir menggunakan penggunaan yang terukur. Harga dapat bergantung pada resolusi, format output, atau rentang penggunaan. Periksa Penggunaan di Console untuk debit ShareAI akhir. Bidang biaya hulu dan byte media tidak diubah menjadi jumlah token yang diciptakan.
Akses dan kesalahan#
Gunakan inference untuk inferensi biaya jaringan yang disetujui atau monetization_gateway untuk markup Builder yang disetujui dan ketentuan penagihan yang diterima. Akses hanya identitas tidak mengizinkan pengeluaran. Validasi, otorisasi model, kredit yang tidak mencukupi, batasan tarif, dan kegagalan eksekusi mengembalikan struktur error. Setelah batas waktu atau pengiriman yang tidak pasti, periksa Penggunaan atau pekerjaan video sebelum membuat permintaan lain yang mungkin berbayar.
Terakhir diperbarui 3 November 2026