Passer au contenu principal
POST
/
openai
/
v1
/
rerank
Créer un réordonnancement
curl --request POST \
  --url https://api.highwayapi.ai/openai/v1/rerank \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "model": "<string>",
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "top_n": 123
}
'
{
  "id": "<string>",
  "results": [
    {
      "document": {
        "text": "<string>"
      },
      "index": 123,
      "relevance_score": 123
    }
  ],
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}
Créer un réordonnancement

En-têtes de requête

Content-Type
string
requis
Valeurs énumérées : application/json
Authorization
string
requis
Format d’authentification Bearer : Bearer {{API Key}}.

Corps de la requête

model
string
requis
Nom du modèle à utiliser.
query
string
requis
Requête de recherche.
documents
string[]
requis
Liste des documents.
top_n
integer
Nombre de documents ou d’index les plus pertinents à renvoyer.

Informations de réponse

id
string
requis
ID
results
object[]
requis
usage
object
Statistiques d’utilisation des tokens.