Xinference Rerank

Xinference Rerank classe les documents candidats par pertinence avec le format compatible Jina AI. Sélectionnez un modèle Xinference Rerank actuellement disponible ; les autres champs de requête et la structure de réponse sont identiques à ceux de Jina Rerank. AGTCloud convertit systématiquement les réponses au format Jina AI.

Configuration du fournisseur dans Dify et les clients similaires

Dans les clients comme Dify qui demandent de choisir un type de fournisseur Rerank, sélectionnez Jina AI et indiquez l’ID d’un modèle Xinference Rerank actuellement disponible.

POST/v1/rerank

Appelle les modèles de reclassement Xinference avec le format compatible Jina AI. AGTCloud convertit systématiquement les réponses au format Jina AI ; les modalités d’appel, champs de requête et structures de réponse sont identiques à ceux de Jina Rerank.

Choisissez un modèle Xinference Rerank visible pour la clé API actuelle. La requête doit être claire et précise, et les documents candidats sémantiquement complets sans dépasser la limite de tokens du modèle sélectionné. Traitez les volumes importants par lots et contrôlez le nombre de résultats avec top_n.

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 avec Xinference.

Définitions TypeScript

Utilisez le type request body en TypeScript.

model*string

ID d’un modèle Xinference Rerank visible pour la clé API actuelle.

Longueur1 <= length

query*string

Texte de requête utilisé pour classer les documents candidats par pertinence. Privilégiez une formulation claire et précise, sans requête trop générale ou vague.

Longueur1 <= length

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.

Éléments1 <= items

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.

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": [
    {
      "document": {
        "text": "Washington, D.C. (aussi appelée Washington ou D.C., officiellement le district de Columbia) est la capitale des États-Unis."
      },
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "document": {
        "text": "La capitale du Nevada est Carson City."
      },
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "document": {
        "text": "Les îles Mariannes du Nord sont un archipel du Pacifique dont la capitale est Saipan."
      },
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

Authentification

Corps de requête

Corps de réponse

200application/json

400

401

429

500

`application/json`