Format de reclassement de Jina AI

📝Présentation

Jina AI Rerank est un puissant modèle de reclassement de texte qui peut trier les listes de documents par pertinence en fonction des requêtes. Le modèle prend en charge plusieurs langues et peut traiter le contenu textuel dans différentes langues, en attribuant des scores de pertinence à chaque document.

💡 Exemples de requêtes

Demande de reclassement de base ✅

curl https://88api.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "jina-reranker-v2-base-multilingual",
    "query": "Organic skincare products for sensitive skin",
    "top_n": 3,
    "documents": [
      "Organic skincare for sensitive skin with aloe vera and chamomile...",
      "New makeup trends focus on bold colors and innovative techniques...",
      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
    ]
  }'

Response Example:

{
  "results": [
    {
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.7624675869941711
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

📮 Demande

Point de terminaison

POST /v1/rerank

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 du corps de la requête

model

• Type : Chaîne
• Obligatoire: Non
• Par défaut: jina-reranker-v2-base-multilingual
• Description : Le modèle de reranking à utiliser

query

• Type : Chaîne
• Obligatoire : Oui
• Description: Texte de requête utilisé pour trier les documents par pertinence

top_n

• Type : Entier
• Obligatoire: Non
• Par défaut : Aucune limite
• Description: Renvoie les N premiers documents après le tri

documents

• Type : Tableau de chaînes
• Obligatoire : Oui
• Description : Liste des documents à reclasser
• Limite: la longueur de chaque document ne doit pas dépasser la limite maximale de jetons du modèle

📥 Réponse

Réponse réussie

results

• Type : Tableau
• Description : Liste des documents reclassés
• Propriétés:
• document: Objet contenant le texte du document
• index : Index du document dans la liste d'origine
• relevance_score : Score de pertinence (entre 0-1)

usage

• Type : Objet
• Description: statistiques d'utilisation des jetons
• Propriétés:
• prompt_tokens: Nombre de jetons utilisés pour l'invite
• completion_tokens: Nombre de jetons utilisés pour la réalisation
• total_tokens : Nombre total de jetons
• prompt_tokens_details: informations détaillées sur le jeton d'invite
• cached_tokens : Nombre de tokens mis en cache
• audio_tokens : Nombre de jetons audio
• completion_tokens_details: informations détaillées sur le jeton d'achèvement
• reasoning_tokens : Nombre de jetons raisonnement
• audio_tokens : Nombre de jetons audio
• accepted_prediction_tokens: Nombre de jetons de prédiction acceptés
• rejected_prediction_tokens: Nombre de jetons de prédiction rejetés

Réponse d'erreur

En cas de problèmes avec la requête, l'API renvoie une réponse d'erreur:

• 400 Bad Request: Paramètres de requête invalides
• 401 Unauthorized: Clé API invalide ou manquante
• 429 Too Many Requests: Limite de fréquence de requête dépassée
• 500 Internal Server Error: Erreur interne du serveur

💡 Bonnes pratiques

Suggestions d'optimisation des requêtes

1. Utilisez un texte de requête clair et spécifique
2. Évitez les requêtes trop larges ou vagues
3. Assurez-vous que la requête utilise le même style de langage que les documents

Suggestions de traitement des documents

1. Gardez la longueur du document modérée, ne dépassez pas les limites du modèle
2. Assurez-vous que le contenu du document est complet et significatif
3. Peut inclure des documents multilingues, le modèle prend en charge la correspondance multilingue

Optimisation des performances

1. Définissez raisonnablement le paramètre top_n pour réduire les calculs inutiles
2. Pour un grand nombre de documents, pensez au traitement par lots
3. Peut mettre en cache les résultats des requêtes courantes

Prise en charge multilingue

Ce modèle prend en charge le reclassement des documents dans plusieurs langues, notamment:

• Anglais
• Chinois
• Allemand
• Espagnol
• Japonais
• Français

Pas besoin de spécifier de paramètres de langue, le modèle identifiera et traitera automatiquement le contenu dans différentes langues.