Langsung ke konten utama

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.

Urutkan ulang dokumen menggunakan model kesamaan semantik. Berguna untuk meningkatkan hasil pencarian dan aplikasi RAG.

​
Isi Permintaan

Timeout permintaan sinkron: endpoint non-chat ini menunggu model yang dirutekan selesai. Input besar, audio panjang, atau batch besar dapat melebihi default client umum 30s, jadi atur timeout HTTP client Anda minimal 120s.
​
model
string
wajib
ID model reranker yang akan digunakan (misalnya, BAAI/bge-reranker-v2-m3, qwen3-rerank).
​
query
string
wajib
Kueri untuk membandingkan peringkat dokumen. Panjang maksimum: 32,000 karakter.
​
documents
array
wajib
Daftar dokumen (string) untuk diurutkan ulang. Batas: hingga 1,000 dokumen, setiap dokumen hingga 100,000 karakter, dan total karakter dokumen paling banyak 2,000,000.
​
top_n
integer
Jumlah hasil teratas yang akan dikembalikan. Default ke semua dokumen. Nilainya harus minimal 1 dan tidak boleh lebih besar dari documents.length. Saat ini TokenLab tidak memiliki hard cap lebih rendah khusus provider yang sudah dikelola; jika provider menerbitkannya nanti, nilai tersebut harus ditambahkan dulu ke truth request-shape rerank sebelum didokumentasikan atau diberlakukan.
​
return_documents
boolean
default:"false"
Apakah akan menyertakan teks dokumen asli dalam respons.

​
Respons

​
results
array
Daftar dokumen yang telah diurutkan beserta skornya.Setiap hasil berisi:
  • index (integer): Indeks dokumen asli
  • relevance_score (number): Skor relevansi (0-1)
  • document (string): Teks asli (jika return_documents=true)
​
model
string
Model yang digunakan untuk reranking.
​
usage
object
Statistik penggunaan token.
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
  }
}