Réorganiser les documents
Fournissez une requête et 1 à 1000 documents.
Sur cette page
https://api.shareai.now/api/v1/rerankRéorganiser les documents
- URL de base
https://api.shareai.now- Authentification
- Clé API Bearer ou jeton d'accès OAuth approuvé
- Portée requise
inferenceormonetization_gateway
Fournissez une requête et 1 à 1000 documents. Chaque document est un texte, un {"text":"..."} objet ou un objet pris en charge par le modèle. {"image":"https://..."} objet. top_n doit être au moins égal à 1 et ne pas dépasser le nombre de documents. Faites correspondre les résultats aux indices des documents d'origine.
Avant de commencer#
Configurez SHAREAI_API_KEY sur votre serveur et remplacez l'espace réservé du modèle par un modèle actuellement activé. Ne jamais exposer la clé API dans le code du navigateur. Le modèle, le compte, les identifiants et le fournisseur doivent tous autoriser cette opération. Les paramètres optionnels ci-dessous nécessitent la prise en charge du modèle ; les limites de sécurité de l'API ne garantissent pas que chaque modèle prend en charge chaque valeur.
Envoyez une requête#
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);Champs de la requête#
| Champ | Type | Signification et limites |
|---|---|---|
model requis | chaîne | Identifiant exact du modèle public activé. Doit déclarer cette opération et être autorisé par vos identifiants. |
query requis | chaîne | Requête de pertinence non vide. |
documents requis | tableau | 1 à 1000 chaînes de texte non vides ou objets texte/image à clé unique. Les valeurs d'image doivent être des URL HTTPS ou des URL de données d'image prises en charge, avec compatibilité d'entrée image du modèle. |
top_n | entier | Nombre de résultats optionnel, de 1 au nombre de documents. Les indices retournés se réfèrent au tableau de documents d'origine. |
return_documents | booléen | Inclusion optionnelle des documents originaux dans le résultat, si prise en charge par le fournisseur. |
provider | objet | Préférences d'acheminement des fournisseurs facultatives. Utilisez provider.only pour les balises de fournisseurs acceptées, pas un préfixe dans l'ID du modèle. Les restrictions de compte et d'identifiants s'appliquent toujours. |
Lire le résultat#
Succès renvoie HTTP 200 avec JSON. Fournissez une requête et 1 à 1000 documents. Chaque document est un texte, un {"text":"..."} objet ou un objet pris en charge par le modèle. {"image":"https://..."} objet. top_n doit être au moins égal à 1 et ne pas dépasser le nombre de documents. Faites correspondre les résultats aux indices des documents d'origine.
Unités de facturation#
Les taux de rerank peuvent utiliser des tokens d'entrée, des documents notés, des requêtes ou une quantité de recherche rapportée par un fournisseur. Aucune conversion universelle de recherche en token n'est supposée. Un fournisseur incapable de signaler une dimension tarifée n'est pas disponible pour ce tarif.
Choisissez l'identifiant exact du modèle activé depuis la Console. Son opération déclarée et ses capacités d'entrée/sortie doivent correspondre à ce point de terminaison ; un modèle de chat texte ne peut pas être substitué pour une autre opération. Vos restrictions d'identifiants, de fournisseur et de compte s'appliquent toujours.
Tarification et utilisation#
Les tarifs sont publiés en crédits IA EUR pour le modèle, le fournisseur, les unités et les variantes sélectionnés. Seules les dimensions de son tarif actif sont facturées. Une estimation réserve des crédits avant l'exécution ; les frais finaux sont basés sur l'utilisation mesurée. Les prix peuvent dépendre de la résolution, du format de sortie ou d'une tranche d'utilisation. Consultez l'onglet Utilisation dans la Console pour vérifier le débit final de ShareAI. Les champs de coûts en amont et les octets multimédias ne sont pas convertis en nombres de jetons inventés.
Accès et erreurs#
Utiliser inference pour une inférence approuvée avec coût réseau ou monetization_gateway pour une majoration approuvée par le Builder et des conditions de facturation acceptées. Un accès basé uniquement sur l'identité n'autorise pas les dépenses. La validation, l'autorisation du modèle, les crédits insuffisants, les limites de taux et les échecs d'exécution renvoient une structure error. Après un délai d'attente ou une soumission incertaine, vérifiez l'onglet Utilisation ou le travail vidéo avant de créer une autre demande potentiellement payante.
Dernière mise à jour le 3 novembre 2026