Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt

Use this file to discover all available pages before exploring further.

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. BAAI/bge-reranker-v2-m3, qwen3-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 zurückzugebenden Top-Ergebnisse. Standardmäßig werden alle Dokumente zurückgegeben. Muss mindestens 1 sein und darf documents.length nicht überschreiten. TokenLab hat derzeit keinen verwalteten, anbieterspezifischen niedrigeren Hard-Cap; falls ein Anbieter später einen veröffentlicht, muss diese Wahrheit zuerst in die rerank request-shape truth aufgenommen werden, bevor sie dokumentiert oder erzwungen wird.
​
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": "BAAI/bge-reranker-v2-m3",
    "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
  }'

{
  "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": "BAAI/bge-reranker-v2-m3",
  "usage": {
    "prompt_tokens": 45,
    "total_tokens": 45
  }
}