Rerank À venir

Classe une liste de documents selon leur pertinence par rapport à une requête.

POST https://api.cloudzir.com/v1/rerank

Authentification#

Authorization: Bearer zir_ai_<48 caractères hexadécimaux>
Content-Type: application/json

Paramètres#

ChampTypeDescription
query requisstringTexte non vide à comparer.
documents requisarray de stringsListe non vide de textes non vides.
modelstringmina-rerank, valeur par défaut.
top_nintegerNombre de résultats, de 1 au nombre de documents. Par défaut, tous les documents.

Requête#

curl https://api.cloudzir.com/v1/rerank \
  -H "Authorization: Bearer $CLOUDZIR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"énergie solaire","documents":["charbon","photovoltaïque"],"top_n":1}'

Réponse attendue quand la capacité est activée#

ChampDescription
results[]Index d'origine, score de pertinence de 0 à 1 et texte du document.
usageTokens de la requête et des documents renvoyés par le moteur.
À venir

Aucun moteur de reclassement n'est enregistré dans cette version. Après validation de la clé et du corps, le routeur répond 501 jusqu'au branchement d'un moteur. Aucun tarif ni délai de disponibilité n'est publié ici.

Erreurs et limites#

400, 401, 402, 403, 404, 413, 429, 500, 501, 503. Le nombre de documents, les tokens de chaque texte et le total sont plafonnés par la configuration côté serveur. Voir les codes d'erreur et les modèles et prix.

Paramètres

Réponse API