Jina Rerank

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

Jina Rerank classe les documents candidats selon leur pertinence par rapport au texte de la requête et renvoie les documents originaux, les index, les scores de pertinence et les statistiques d’utilisation des tokens. Les requêtes et réponses utilisent une structure de champs au format Jina AI.

POST/v1/rerank

Calcule les scores de pertinence des documents candidats par rapport au texte de la requête et renvoie les résultats classés par pertinence. AGTCloud renvoie les résultats au format Jina AI ; certaines interfaces compatibles sont également converties vers cette structure.

Les requêtes et documents peuvent être multilingues. Pour obtenir un classement plus stable, utilisez des requêtes claires et précises, conservez des documents complets et évitez de dépasser la limite de tokens du modèle sélectionné pour un document. Traitez les volumes importants par lots ; les résultats des requêtes stables et répétées peuvent être mis en cache côté application.

Authentification

bearerAuth

AuthentificationBearer <token>

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

Emplacement: header

Corps de requête

application/json

Paramètres de requête pour le reclassement des documents.

Définitions TypeScript

Utilisez le type request body en TypeScript.

model?string

ID du modèle de reclassement à utiliser, par exemple jina-reranker-v2-base-multilingual. Utilisez un modèle disponible pour le compte actuel.

query*string

Texte de requête utilisé pour classer les documents candidats par pertinence. Privilégiez une requête claire et précise ; des formulations linguistiques proches entre la requête et les documents favorisent généralement des résultats stables.

top_n?integer

Renvoie les N documents les plus pertinents. En l’absence de valeur, le nombre de résultats n’est pas limité ; un réglage adapté réduit les transferts et traitements inutiles.

documents*array<string>

Liste des documents à reclasser. Chaque document doit être complet, sémantiquement clair et ne pas dépasser la limite de tokens du modèle sélectionné. Traitez les volumes importants par lots ; la liste peut contenir des textes multilingues.

Corps de réponse

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "Produits de soins biologiques pour les peaux sensibles",    "top_n": 3,    "documents": [      "Soins biologiques pour les peaux sensibles à l’aloe vera et à la camomille...",      "Les nouvelles tendances du maquillage privilégient les couleurs vives et les techniques innovantes...",      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."    ]  }'

{
  "results": [
    {
      "document": {
        "text": "Soins biologiques pour les peaux sensibles à l’aloe vera et à la camomille..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.762467586994171
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

Authentification

Corps de requête

Corps de réponse

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`