Zum Hauptinhalt springen
Ordnen Sie Dokumente mithilfe von semantischen Ähnlichkeitsmodellen neu. Nützlich zur Verbesserung von Suchergebnissen und RAG-Anwendungen.

Anfragekörper

Timeout für synchrone Anfragen: Dieser Nicht-Chat-Endpunkt wartet, bis das geroutete Modell fertig ist. Große Eingaben, lange Audiodateien oder große Batches können übliche 30s-Client-Defaults überschreiten; setzen Sie das Timeout Ihres HTTP-Clients daher auf mindestens 120s.
model
string
erforderlich
ID des zu verwendenden Reranker-Modells (z. B. qwen3-vl-rerank).
query
string
erforderlich
Die Suchanfrage, gegen die die Dokumente bewertet werden sollen. Maximale Länge: 32,000 Zeichen.
documents
array
erforderlich
Liste der neu zu ordnenden Dokumente (Strings). Limits: bis zu 1,000 Dokumente, jedes Dokument bis zu 100,000 Zeichen und höchstens 2,000,000 Dokumentzeichen insgesamt.
top_n
integer
Anzahl der Top-Ergebnisse, die zurückgegeben werden. Standardmäßig werden alle documents zurückgegeben. Der Wert muss mindestens 1 sein und darf documents.length nicht überschreiten. Wenn ein Provider später ein strengeres öffentliches Limit veröffentlicht, dokumentiert und erzwingt TokenLab es hier.
return_documents
boolean
Standard:"false"
Gibt an, ob der ursprüngliche Dokumenttext in der Antwort enthalten sein soll.

Antwort

results
array
Rangliste der Dokumente mit Scores.Jedes Ergebnis enthält:
  • index (integer): Ursprünglicher Dokument-Index
  • relevance_score (number): Relevanz-Score (0-1)
  • document (string): Ursprünglicher Text (wenn return_documents=true)
model
string
Das für das Reranking verwendete Modell.
usage
object
Statistiken zur Token-Nutzung.
curl -X POST "https://api.tokenlab.sh/v1/rerank" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen3-vl-rerank",
    "query": "What is machine learning?",
    "documents": [
      "Machine learning is a subset of AI",
      "The weather is nice today",
      "Deep learning uses neural networks"
    ],
    "top_n": 2,
    "return_documents": true
  }'
import requests

response = requests.post(
    "https://api.tokenlab.sh/v1/rerank",
    headers={"Authorization": "Bearer sk-your-api-key"},
    json={
        "model": "qwen3-vl-rerank",
        "query": "What is machine learning?",
        "documents": [
            "Machine learning is a subset of AI",
            "The weather is nice today",
            "Deep learning uses neural networks"
        ],
        "top_n": 2
    }
)

print(response.json())
const response = await fetch('https://api.tokenlab.sh/v1/rerank', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'qwen3-vl-rerank',
    query: 'What is machine learning?',
    documents: [
      'Machine learning is a subset of AI',
      'The weather is nice today',
      'Deep learning uses neural networks'
    ],
    top_n: 2
  })
});

const data = await response.json();
console.log(data.results);
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    payload := map[string]interface{}{
        "model": "qwen3-vl-rerank",
        "query": "What is machine learning?",
        "documents": []string{
            "Machine learning is a subset of AI",
            "The weather is nice today",
            "Deep learning uses neural networks",
        },
        "top_n": 2,
    }
    body, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", "https://api.tokenlab.sh/v1/rerank", bytes.NewBuffer(body))
    req.Header.Set("Authorization", "Bearer sk-your-api-key")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println(result["results"])
}
<?php
$ch = curl_init('https://api.tokenlab.sh/v1/rerank');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer sk-your-api-key'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'model' => 'qwen3-vl-rerank',
        'query' => 'What is machine learning?',
        'documents' => [
            'Machine learning is a subset of AI',
            'The weather is nice today',
            'Deep learning uses neural networks'
        ],
        'top_n' => 2
    ])
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['results']);
{
  "results": [
    {
      "index": 0,
      "relevance_score": 0.95,
      "document": "Machine learning is a subset of AI"
    },
    {
      "index": 2,
      "relevance_score": 0.82,
      "document": "Deep learning uses neural networks"
    }
  ],
  "model": "qwen3-vl-rerank",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}