Cohere Rerank

Reclassez les documents candidats avec une structure de requête Rerank au format Cohere.

Cohere Rerank classe les documents candidats selon leur pertinence par rapport au texte de la requête. Les principaux champs de requête sont essentiellement identiques à ceux de Jina Rerank, avec en plus X-Client-Name et max_tokens_per_doc ; la réponse contient les index des documents originaux, les scores de pertinence, l’identifiant de requête, la version API et les métadonnées de facturation.

POST/v1/rerank

Calcule les scores de pertinence des documents candidats par rapport au texte de la requête et renvoie les résultats par pertinence décroissante. Les principaux champs de requête sont essentiellement identiques à ceux de Jina Rerank, avec en plus X-Client-Name et max_tokens_per_doc. La réponse réussie contient les index des résultats, les scores de pertinence, l’identifiant de requête, la version API et les métadonnées de facturation.

Pour obtenir un classement plus stable, la requête doit être claire et précise, et les documents concis mais sémantiquement complets. Les documents longs sont tronqués selon max_tokens_per_doc. Il est recommandé de ne pas dépasser 1,000 documents par requête et de convertir les données structurées en chaînes YAML.

Authentification

bearerAuth

AuthentificationBearer <token>

Utilisez Bearer your-api-key dans le Header Authorization.

Emplacement: header

Paramètres Header

X-Client-Name?string

Nom du projet à l’origine de la requête.

Corps de requête

application/json

Paramètres de requête pour le reclassement au format Cohere.

Définitions TypeScript

Utilisez le type request body en TypeScript.

model*string

ID du modèle de reclassement à utiliser. Indiquez un modèle visible pour la clé API actuelle et compatible avec le format Cohere Rerank.

Longueur1 <= length

query*string

Texte de requête à comparer aux documents candidats. Privilégiez une requête claire et précise, sans formulation trop vague ou générale.

Longueur1 <= length

documents*array<string>

Liste de textes à comparer à la requête. Il est recommandé de ne pas dépasser 1,000 documents par requête. Les documents longs sont tronqués selon max_tokens_per_doc ; convertissez de préférence les données structurées en chaînes YAML.

Éléments1 <= items

top_n?integer

Limite le nombre de résultats de reclassement renvoyés. Sans valeur, tous les résultats sont renvoyés ; renseignez ce champ lorsque vous ne souhaitez que quelques résultats afin de réduire le traitement ultérieur.

max_tokens_per_doc?integer

Nombre maximal de tokens de chaque document participant au reclassement ; le contenu excédentaire est tronqué.

Valeur par défaut4096

Corps de réponse

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "Quelle est la capitale des États-Unis ?",    "documents": [      "La capitale du Nevada est Carson City.",      "Les îles Mariannes du Nord sont un archipel du Pacifique dont la capitale est Saipan.",      "Washington, D.C. (aussi appelée Washington ou D.C., officiellement le district de Columbia) est la capitale des États-Unis.",      "En grammaire anglaise, la capitalisation consiste à utiliser une majuscule au début d’un mot. Son usage en anglais diffère de celui des autres langues.",      "La peine de mort existait aux États-Unis avant même leur constitution en nation. En 2017, elle était légale dans 30 des 50 États."    ],    "top_n": 3  }'

{
  "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
    }
  }
}

Authentification

Paramètres Header

Corps de requête

Corps de réponse

200application/json

400

401

403

404

422

429

500

503

`application/json`