Rerank - OpenSearch - Centre de documentation Alibaba Cloud

Attribue un score et classe une liste de documents candidats en fonction de leur pertinence par rapport à une requête. Utilisez cette API pour améliorer la qualité de la récupération dans les pipelines de recherche en réorganisant les résultats avant de les afficher aux utilisateurs.

Modèles disponibles

Nom du service	ID du service	Description	Limite QPS
Modèle de reranking BGE	`ops-bge-reranker-larger`	Classe les documents selon la pertinence requête-document à l'aide du modèle BGE. Prend en charge le chinois et l'anglais. Entrée maximale : 512 jetons (requête et document combinés).	20 (compte Alibaba Cloud et utilisateurs RAM combinés). Pour demander une limite supérieure, soumettez un ticket.
Modèle de reranking de texte OpenSearch-001	`ops-text-reranker-001`	Classe les documents selon la pertinence sémantique, entraîné sur plusieurs jeux de données sectoriels. Prend en charge le chinois et l'anglais. Entrée maximale : 512 jetons (requête et document combinés).	—
Service de classement Qwen3-0.6B	`ops-qwen3-reranker-0.6b`	Modèle de reranking de la série Qwen3 avec 0,6 milliard de paramètres. Prend en charge plus de 100 langues. Entrée maximale : 32k jetons (requête et document combinés).	—

Prérequis

Avant de commencer, assurez-vous d'avoir :

Une clé API pour l'authentification. Pour savoir comment en obtenir une, reportez-vous à la documentation d'authentification de la plateforme ouverte AI Search.
Un endpoint de service (Internet ou VPC). Consultez Obtenir l'adresse d'enregistrement du service.

Syntaxe de la requête

POST {host}/v3/openapi/workspaces/{workspace_name}/ranker/{service_id}

Paramètres de chemin :

Paramètre	Description
`host`	L'endpoint du service. Prend en charge l'accès Internet et VPC. Consultez Obtenir l'adresse d'appel du service.
`workspace_name`	Le nom de l'espace de travail. Exemple : `default`.
`service_id`	L'ID du modèle de reranking à utiliser. Exemple : `ops-bge-reranker-larger`.

Limites :

Taille maximale du corps de la requête : 8 Mo.

Paramètres de la requête

Paramètres d'en-tête

Paramètre	Type	Requis	Description	Exemple
`Content-Type`	String	Oui	Le type de contenu de la requête. Définissez-le sur `application/json`.	`application/json`
`Authorization`	String	Oui	La clé API utilisée pour l'authentification. Format : `Bearer <your-api-key>`.	`Bearer OS-d1**2a`

Paramètres du corps

Paramètre	Type	Requis	Description	Exemple
`query`	String	Oui	La requête de recherche utilisée pour évaluer les documents.	`What are the fun places in Shanghai?`
`docs`	List	Oui	La liste des documents candidats à reclasser.	`["There are many fun places in Shanghai", "There are many fun places in Beijing"]`

Paramètres de la réponse

Paramètre	Type	Description	Exemple
`request_id`	String	L'ID de la requête.	`A5B25952-4406-45BF-99EC-E8020246****`
`latency`	Float/Int	Le temps de traitement de la requête, en millisecondes.	`10`
`usage.doc_count`	Int	Le nombre de documents évalués dans cette requête.	`2`
`result.scores`	List	Les documents reclassés, ordonnés du score de pertinence le plus élevé au plus faible.	`[{"index":1,"score":0.99},{"index":2,"score":0.05}]`
`result.scores[].index`	Int	La position (indice de base zéro) du document dans le tableau `docs` d'entrée.	`1`
`result.scores[].score`	Float	Le score de pertinence. Des valeurs plus élevées indiquent une plus grande pertinence par rapport à la requête.	`0.99`

Exemples

Requête

curl -X POST \
  "http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/ranker/ops-bge-reranker-larger" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-key>" \
  -d '{
    "query": "opensearch documentation",
    "docs": [
      "what is opensearch",
      "what is LLM-based conversational search edition",
      "What is the advantage of LLM-based conversational search edition"
    ]
  }'

Réponse

Succès :

{
  "request_id": "24B004E0-ADEF-****-879B-F28359BFAD1D",
  "latency": 19,
  "usage": {
    "doc_count": 3
  },
  "result": {
    "scores": [
      { "index": 0, "score": 0.45026873385713345 },
      { "index": 1, "score": 1.1412238544346029E-4 },
      { "index": 2, "score": 8.029784284533197E-5 }
    ]
  }
}

Erreur :

Lorsqu'une requête échoue, la réponse inclut les champs code et message qui décrivent l'erreur.

{
  "request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
  "latency": 0,
  "code": "InvalidParameter",
  "message": "JSON parse error: Unexpected character ..."
}

Étapes suivantes

Codes d'état