Reordonează documente
Oferă o interogare și 1–1000 documente.
Pe această pagină
https://api.shareai.now/api/v1/rerankReordonează documente
- URL de bază
https://api.shareai.now- Autentificare
- Cheie API Bearer sau token de acces OAuth aprobat
- Scop necesar
inferenceormonetization_gateway
Oferă o interogare și 1–1000 documente. Fiecare document este text, un {"text":"..."} obiect sau un model-suportat {"image":"https://..."} obiect. top_n trebuie să fie cel puțin 1 și nu mai mare decât numărul de documente. Potrivește rezultatele cu indicii documentelor originale.
Înainte de a începe#
Setează SHAREAI_API_KEY pe serverul tău și înlocuiește placeholder-ul modelului cu un model activat în prezent. Nu expune niciodată cheia API în codul browserului. Modelul, contul, acreditivul și providerul trebuie să permită această operațiune. Setările opționale de mai jos necesită suportul modelului; limitele de siguranță ale API-ului nu garantează că fiecare model suportă fiecare valoare.
Trimite o cerere#
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);Câmpuri cerere#
| Câmp | Tip | Semnificație și limite |
|---|---|---|
model necesar | șir | Identificatorul exact al modelului public activat. Trebuie să declare această operațiune și să fie permis de acreditivul tău. |
query necesar | șir | Interogare de relevanță nenulă. |
documents necesar | array | 1–1000 șiruri de text nenule sau obiecte text/imagine cu o singură cheie. Valorile imaginii trebuie să fie URL-uri HTTPS sau URL-uri de date imagine suportate, cu suport de intrare imagine pentru model. |
top_n | întreg | Număr opțional de rezultate de la 1 până la numărul de documente. Indicii returnați se referă la array-ul original de documente. |
return_documents | boolean | Includerea opțională, suportată de provider, a documentelor originale în rezultat. |
provider | obiect | Preferințe opționale de rutare ale providerului. Utilizează provider.only pentru tag-uri de provider acceptate, nu un prefix în ID-ul modelului. Restricțiile contului și acreditivului se aplică în continuare. |
Citește rezultatul#
Succesul returnează HTTP 200 cu JSON. Oferă o interogare și 1–1000 documente. Fiecare document este text, un {"text":"..."} obiect sau un model-suportat {"image":"https://..."} obiect. top_n trebuie să fie cel puțin 1 și nu mai mare decât numărul de documente. Potrivește rezultatele cu indicii documentelor originale.
Unități de facturare#
Ratele de rerank pot utiliza tokenurile de intrare, documentele evaluate, cererile sau o cantitate de căutare raportată de provider. Nu se presupune o conversie universală de căutare-la-token. Un provider care nu poate raporta o dimensiune tarifată este indisponibil pentru acel tarif.
Alege identificatorul exact al modelului activat din Console. Operațiunea declarată și capacitățile de intrare/ieșire trebuie să se potrivească cu acest endpoint; un model de chat text nu poate fi substituit pentru o altă operațiune. Restricțiile acreditivului, providerului și contului tău se aplică în continuare.
Prețuri și utilizare#
Tarifele sunt publicate în credite AI EUR pentru modelul, providerul, unitățile și variantele selectate. Sunt taxate doar dimensiunile din tariful său activ. O estimare rezervă credite înainte de execuție; taxele finale utilizează utilizarea măsurată. Prețurile pot depinde de rezoluție, formatul de ieșire sau un interval de utilizare. Verifică Console Usage pentru debitul final ShareAI. Câmpurile de cost upstream și byte-urile media nu sunt convertite în număr de token inventat.
Acces și erori#
Utilizează inference pentru inferență aprobată cu costuri de rețea sau monetization_gateway pentru un adaos aprobat de Builder și termeni de facturare acceptați. Accesul doar pe bază de identitate nu autorizează cheltuieli. Validarea, autorizarea modelului, creditele insuficiente, limitele de rată și eșecurile de execuție returnează un error. După un timeout sau o trimitere incertă, inspectează Usage sau job-ul video înainte de a crea o altă cerere potențial plătită.
Ultima actualizare noiembrie 3, 2026