Teks

Rerank Dokumen

Memeringkat ulang dokumen berdasarkan relevansi terhadap kueri

POST
/v1/rerank

Gunakan GET /v1/models?recommended_for=rerank untuk melihat daftar model rerank saat ini. Gunakan model yang detailnya mencantumkan operasi rerank.

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

Body Permintaan

Endpoint ini memberikan respons setelah proses pemeringkatan selesai. Untuk kumpulan dokumen yang besar, atur batas waktu (timeout) HTTP client Anda setidaknya ke 120s.

modelstringwajib

ID model reranker yang akan digunakan (misalnya, qwen3-vl-rerank).

querystringwajib

Kueri yang digunakan untuk memeringkat dokumen. Panjang maksimum: 32,000 karakter.

documentsarraywajib

Daftar dokumen (string) yang akan diperingkat ulang. Batasan: hingga 1,000 dokumen, setiap dokumen hingga 100,000 karakter, dan total karakter dokumen paling banyak 2,000,000.

top_ninteger

Jumlah hasil teratas yang akan dikembalikan, dari 1 hingga documents.length. Jika diabaikan, model yang dipilih akan menentukan jumlah hasil.

return_documentsbooleanbawaan: false

Menentukan apakah teks dokumen asli disertakan dalam setiap hasil. Kirimkan hanya jika detail model mencantumkan return_documents.

Respons

resultsarray

Daftar dokumen yang telah diperingkat beserta skornya.

Setiap hasil berisi:

  • index (integer): Indeks dokumen asli
  • relevance_score (number): Skor relevansi. Rentangnya bergantung pada model yang dipilih.
  • document (string): Teks asli (jika return_documents=true)
modelstring

Model yang digunakan untuk reranking. Jika tersedia.

usageobject

Penggunaan yang dilaporkan untuk permintaan tersebut, jika tersedia: total_tokens, atau search_units untuk model yang ditagih per pencarian.

Permintaan

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
  }'

Respons

Response
{
  "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": {
    "total_tokens": 45
  }
}

Errors

StatusCodePenyebab
400invalid_requestAda field yang hilang, kosong, atau melebihi batas di atas. param menyebutkannya
400unsupported_endpointModel tidak dipublikasikan untuk endpoint ini

Tangani status lainnya seperti pada Menangani error API.

Otorisasi

BearerAuth
AuthorizationBearer <token>

Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.

Lokasi: header

Header

X-TokenLab-Delivery-Policy?string

Kebijakan Pengiriman per-permintaan. Menggantikan default API key dan Workspace. Secara otomatis mencoba TokenLab Verified terlebih dahulu dan dapat beralih satu kali ke Official saja sebelum output, penerimaan permintaan, atau pembuatan sumber daya persisten.

Nilai yang tersedia

  • "auto"
  • "verified"
  • "official"

Body permintaan

application/json

Respons

application/json

application/json

application/json

application/json

application/json

application/json

application/json