Format de reclassement Cohere

Remarque importante

Le format d'interface du modèle Rerank de Cohere est le même que celui de [Jina's Rerank interface du modèle] (jinaai-rerank.md).

Documentation officielle

Cohere Rerank

📝Présentation

Étant donné une requête et une liste de textes, l'API Rerank triera les textes en fonction de leur pertinence par rapport à la requête. Chaque texte se voit attribuer un score de pertinence, ce qui donne lieu à un tableau ordonné de résultats. Cette fonctionnalité est particulièrement utile pour les applications de recherche et de récupération, optimisant le classement des documents et aidant les utilisateurs à trouver plus rapidement des informations pertinentes.

💡 Exemples de requêtes

Demande de reclassement de base ✅

curl https://88api.ai/v1/rerank \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-v3.5",
    "query": "What is the capital of the United States?",
    "documents": [
      "The capital of Nevada is Carson City.",
      "The Northern Mariana Islands are a group of islands in the Pacific, with Saipan as the capital.",
      "Washington, D.C. (also known as Washington or D.C., officially the District of Columbia) is the capital of the United States.",
      "Capitalization in English grammar is the use of uppercase letters at the beginning of words. English usage differs from other languages in capitalization.",
      "The death penalty existed in the United States before it became a country. As of 2017, 30 out of 50 states have the death penalty legalized."
    ],
    "top_n": 3
  }'

Response Example:

{
  "results": [
    {
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf",
  "meta": {
    "api_version": {
      "version": "2",
      "is_experimental": false
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

Utiliser des données structurées ✅

curl https://88api.ai/v1/rerank \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-v3.5",
    "query": "Looking for a cost-effective DSLR camera for beginners",
    "documents": [
      "Model: Canon EOS 800D\nPrice: 4299 yuan\nFeatures: 24.1MP, optical viewfinder, Wi-Fi\nSuitable for: Beginners, enthusiasts",
      "Model: Nikon D3500\nPrice: 3099 yuan\nFeatures: 24.16MP, optical viewfinder, battery life up to 1550 shots\nSuitable for: Newbies, students",
      "Model: Sony A7III\nPrice: 12999 yuan\nFeatures: 24.2MP, full-frame, 4K video\nSuitable for: Professional photographers, video creators"
    ],
    "max_tokens_per_doc": 512
  }'

Response Example:

{
  "results": [
    {
      "index": 1,
      "relevance_score": 0.918472
    },
    {
      "index": 0,
      "relevance_score": 0.854321
    },
    {
      "index": 2,
      "relevance_score": 0.423156
    }
  ],
  "id": "8f734bd2-2473-4f07-94e1-0d9f0e68ebfa",
  "meta": {
    "api_version": {
      "version": "2"
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

📮 Demande

Point de terminaison

POST /v1/rerank

Triez une liste de textes en fonction de leur pertinence par rapport à la requête.

Méthode d'authentification

Incluez les éléments suivants dans l'en-tête de la demande pour l'authentification par clé API:

Authorization: Bearer $API_KEY

Où $API_KEY est votre clé API.

Paramètres d'en-tête de requête

`X-Client-Name`

Type : Chaîne
Obligatoire: Non
Description : Nom du projet à l'origine de la demande.

Paramètres du corps de la requête

`model`

Type : Chaîne
Obligatoire : Oui
Description: identifiant du modèle à utiliser, par exemple, rerank-v3.5.

`query`

Type : Chaîne
Obligatoire : Oui
Description: Texte de la requête de recherche. Il s'agit de la question ou du contenu de la requête de l'utilisateur.

`documents`

Type : Tableau de chaînes
Obligatoire : Oui
Description : Liste des textes à comparer avec la requête. Pour de meilleures performances, n’envoyez pas plus de 1 000 documents en une seule demande.
Remarques:
Les documents longs seront automatiquement tronqués à la valeur spécifiée par max_tokens_per_doc
Les données structurées doivent être formatées sous forme de chaînes YAML pour de meilleures performances

`top_n`

Type : Entier
Obligatoire: Non
Description: Limiter le nombre de résultats reclassés renvoyés. S’il n’est pas spécifié, tous les résultats reclassés seront renvoyés.

`max_tokens_per_doc`

Type : Entier
Obligatoire: Non
Par défaut : 4096
Description: Les documents longs seront automatiquement tronqués au nombre de jetons spécifié.

Type : Tableau d'objets
Description : Liste des documents triés, par ordre décroissant de pertinence
Propriétés:
index : Entier, l'index du document dans la liste d'origine
relevance_score : Float, score de pertinence compris dans l'intervalle [0, 1]. Un score proche de 1 indique une pertinence élevée, un score proche de 0 indique une pertinence faible

`id`

Type : Chaîne
Description : Identifiant unique de la demande

`meta`

Type : Objet
Description: contient des métadonnées sur la demande
Propriétés:
api_version: Objet, contient les informations sur la version de l'API
version: String, numéro de version de l'API
is_deprecated: booléen, s'il est obsolète
is_experimental : Booléen, qu'il soit expérimental
billed_units: Objet, contient les informations de facturation
search_units : Float, nombre d'unités de recherche facturées
tokens: Objet, contient les statistiques d'utilisation des jetons
input_tokens: Float, nombre de jetons comme entrée du modèle
output_tokens : Float, nombre de tokens générés par le modèle

`warnings`

Type : Tableau de chaînes
Obligatoire: Non
Description: Messages d'avertissement renvoyés par l'API

Réponse d'erreur

Lorsqu'une requête rencontre un problème, l'API peut renvoyer les codes d'état HTTP suivants et les erreurs correspondantes:

400 Bad Request : Format de requête ou erreur de paramètre
401 Unauthorized: aucune clé API valide fournie
403 Forbidden: Aucune autorisation pour accéder à cette ressource
404 Not Found: La ressource demandée n'existe pas
422 Unprocessable Entity: La requête est bien formée mais contient des erreurs sémantiques
429 Too Many Requests: Le taux de requêtes dépasse la limite
500 Internal Server Error: Erreur interne du serveur
503 Service Unavailable: Service temporairement indisponible

🌟 Bonnes pratiques

Conseils pour la préparation des documents

Longueur du document: Gardez chaque document concis et clair, évitez d'être trop long. Les documents longs seront automatiquement tronqués.
Données structurées: formatez les données structurées sous forme de chaînes YAML pour de meilleures performances. Par exemple:
```
title: Product Name
price: 9999 yuan
features:
  - Feature 1
  - Feature 2
```
Nombre de documents: Ne dépassez pas 1 000 documents par demande pour de meilleures performances.

Optimisation des requêtes

Soyez précis: formulez des requêtes claires et spécifiques pour des résultats de classement plus précis.
Évitez les requêtes vagues: évitez les requêtes trop vagues ou génériques, car cela pourrait entraîner des scores de pertinence moins distincts.

Comprendre les scores de pertinence

Les scores de pertinence sont normalisés dans la plage [0, 1]:

Des scores proches de 1 indiquent une grande pertinence par rapport à la requête
Des scores proches de 0 indiquent une faible pertinence