Chuyển đến nội dung chính

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.

Xếp hạng lại các tài liệu bằng cách sử dụng các mô hình tương đồng ngữ nghĩa. Hữu ích cho việc cải thiện kết quả tìm kiếm và các ứng dụng RAG.

​
Nội dung yêu cầu

Timeout cho yêu cầu đồng bộ: endpoint không phải chat này chờ model được định tuyến hoàn tất. Input lớn, audio dài, hoặc batch lớn có thể vượt quá mặc định 30s phổ biến của client, vì vậy hãy đặt timeout của HTTP client ít nhất là 120s.
​
model
string
bắt buộc
ID của mô hình reranker cần sử dụng (ví dụ: BAAI/bge-reranker-v2-m3, qwen3-rerank).
​
query
string
bắt buộc
Truy vấn để xếp hạng các tài liệu dựa trên đó. Độ dài tối đa: 32,000 ký tự.
​
documents
array
bắt buộc
Danh sách các tài liệu (chuỗi) cần xếp hạng lại. Giới hạn: tối đa 1,000 tài liệu, mỗi tài liệu tối đa 100,000 ký tự, và tổng số ký tự tài liệu tối đa 2,000,000.
​
top_n
integer
Số lượng kết quả hàng đầu cần trả về. Mặc định là tất cả tài liệu. Phải tối thiểu là 1 và không được lớn hơn documents.length. Hiện TokenLab chưa có hard cap thấp hơn theo từng provider đã được quản trị; nếu provider công bố giới hạn đó sau này, giới hạn phải được thêm vào truth request-shape của rerank trước khi được tài liệu hóa hoặc áp dụng.
​
return_documents
boolean
mặc định:"false"
Có bao gồm văn bản tài liệu gốc trong phản hồi hay không.

​
Phản hồi

​
results
array
Danh sách các tài liệu đã được xếp hạng kèm theo điểm số.Mỗi kết quả bao gồm:
  • index (integer): Chỉ mục tài liệu gốc
  • relevance_score (number): Điểm số liên quan (0-1)
  • document (string): Văn bản gốc (nếu return_documents=true)
​
model
string
Mô hình được sử dụng để xếp hạng lại.
​
usage
object
Thống kê mức sử dụng 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
  }
}