Rerank - AnalyticDB - Centre de documentation Alibaba Cloud

L'opération Rerank permet de résoudre le problème de classement imprécis des résultats de recherche vectorielle et en texte intégral. Elle recalcule le score et reclasse les données récupérées grâce à la compréhension sémantique afin d'améliorer considérablement la pertinence et la précision des résultats. AnalyticDB for PostgreSQL vous permet de reclasser les résultats de recherche en utilisant des modèles Rerank, mais ne fournit pas de modèles.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

gpdb:Rerank

list

*DBInstance

acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Remarque Vous pouvez appeler l'API DescribeDBInstances pour consulter les détails de toutes les instances AnalyticDB for PostgreSQL dans la région cible, y compris l'identifiant de l'instance.	gp-xxxxxxxxx
RegionId	string	Oui	L'identifiant de la région où se trouve l'instance.	cn-hangzhou
Query	string	Non	L'instruction de requête pour Rerank.	Qu'est-ce qu'ADBPG ?
Documents	array	Non	La liste des documents à réordonner.	ADBPG is an Alibaba Cloud OLAP database.
	string	Non	Le contenu d'un document unique.	ADBPG est la base de données OLAP d'Alibaba Cloud
Model	string	Non	Le modèle Rerank. Il prend actuellement en charge : bge-reranker-v2-m3 : (par défaut), meilleures performances, prend en charge 8192 jetons par inférence. En cas de dépassement, le texte sera divisé, ce qui peut réduire l'efficacité. bge-reranker-v2-minicpm-layerwise : meilleures performances que v2-m3, prend en charge 2048 jetons par inférence. En cas de dépassement, le texte sera divisé, ce qui peut réduire l'efficacité.	bge-reranker-v2-m3
Instruct	string	Non	Le nombre de documents les plus pertinents à renvoyer.	3
TopK	integer	Non	Si la valeur est false, le texte des documents n'est pas renvoyé, mais uniquement l'index de l'ordre du document et le score de reclassement.	false
ReturnDocuments	boolean	Non	Le nombre maximal de fragments autorisés lorsque le texte dépasse la fenêtre du modèle : bge-reranker-v2-m3 : la valeur par défaut est 10. bge-reranker-v2-minicpm-layerwise : la valeur par défaut est 5 : Remarque Exemple de fractionnement Si vous utilisez le modèle bge-reranker-v2-minicpm-layerwise, la fenêtre d'inférence unique maximale est de 2048 jetons. Si la requête contient 48 jetons et que le contenu d'un document unique est de 9000 jetons, il sera divisé comme suit : 1-2000 pour le premier, 2001-4000 pour le deuxième, et ainsi de suite. Si le nombre de fragments dépasse MaxChunksPerDoc, les segments restants seront ignorés.	10
MaxChunksPerDoc	integer	Non	Maximum number of chunks allowed when the text exceeds the model window: bge-reranker-v2-m3: default value is 10. bge-reranker-v2-minicpm-layerwise: default value is 5: Remarque Example of splitting If using the bge-reranker-v2-minicpm-layerwise model, the maximum single inference window is 2048 tokens. If the query is 48 tokens and the content of a single document parameter is 9000 tokens, it will be divided as follows: 1-2000 for the first, 2001-4000 for the second, and so on. If the number of splits exceeds MaxChunksPerDoc, the remaining sentences will be discarded.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	Les informations détaillées renvoyées par l'API.	success
Status	string	L'état d'exécution de l'API. Valeurs valides : success : Exécution réussie. fail : Échec de l'exécution.	success
Tokens	integer	Le nombre de jetons consommés.	100
Results	object
Results	array<object>	Les résultats du reclassement.
	object	Les détails des résultats.
Document	string	Re-ordered document information.	ADBPG is an Alibaba Cloud OLAP database.
Index	integer	Index of this document in the request parameter Documents, starting from 0.	1
RelevanceScore	number	Rerank similarity score.	2.31412

Exemples

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Tokens": 100,
  "Results": {
    "Results": [
      {
        "Document": "ADBPG is an Alibaba Cloud OLAP database.",
        "Index": 1,
        "RelevanceScore": 2.31412
      }
    ]
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.