88API88API
User GuideAI ApplicationsAPI ReferenceHelp & Support
Rerank

Định dạng xếp hạng lại Jina AI

Tài liệu chính thức

Định dạng chuẩn

Trong 88API, định dạng xếp hạng lại của Jina AI được sử dụng làm định dạng chuẩn. Tất cả phản hồi xếp hạng lại của các nhà cung cấp khác (chẳng hạn như Xinference, Cohere, v.v.) sẽ được được định dạng theo định dạng của Jina AI để cung cấp trải nghiệm phát triển thống nhất.

📝 Giới thiệu

Jina AI Rerank là một mô hình sắp xếp lại văn bản mạnh mẽ có thể sắp xếp danh sách tài liệu theo mức độ liên quan dựa trên các truy vấn. Mô hình hỗ trợ nhiều ngôn ngữ và có thể xử lý nội dung văn bản bằng các ngôn ngữ khác nhau, gán điểm phù hợp cho từng tài liệu.

💡 Yêu cầu Ví dụ

Yêu cầu xếp hạng lại cơ bản ✅

curl https://88api.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "jina-reranker-v2-base-multilingual",
    "query": "Organic skincare products for sensitive skin",
    "top_n": 3,
    "documents": [
      "Organic skincare for sensitive skin with aloe vera and chamomile...",
      "New makeup trends focus on bold colors and innovative techniques...",
      "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
    ]
  }'

Response Example:

{
  "results": [
    {
      "document": {
        "text": "Organic skincare for sensitive skin with aloe vera and chamomile..."
      },
      "index": 0,
      "relevance_score": 0.8783142566680908
    },
    {
      "document": {
        "text": "Bio-Hautpflege für empfindliche Haut mit Aloe Vera und Kamille..."
      },
      "index": 2,
      "relevance_score": 0.7624675869941711
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

📮 Yêu cầu

Điểm cuối

POST /v1/rerank

Phương thức xác thực

Bao gồm nội dung sau trong tiêu đề yêu cầu để xác thực khóa API:

Authorization: Bearer $API_KEY

Trong đó $API_KEY là khóa API của bạn.

Thông số nội dung yêu cầu

model

  • Loại: Chuỗi
  • Bắt buộc: Không
  • Mặc định: jina-reranker-v2-base-multilingual
  • Mô tả: Mô hình sắp xếp lại sử dụng

query

  • Loại: Chuỗi
  • Bắt buộc: Có
  • Mô tả: Văn bản truy vấn dùng để sắp xếp tài liệu theo mức độ liên quan

top_n

  • Kiểu: Số nguyên
  • Bắt buộc: Không
  • Mặc định: Không giới hạn
  • Mô tả: Trả về N tài liệu top đầu sau khi sắp xếp

documents

  • Kiểu: Mảng chuỗi
  • Bắt buộc: Có
  • Mô tả: Danh sách các văn bản cần sắp xếp lại
  • Giới hạn: Độ dài mỗi tài liệu không được vượt quá giới hạn mã thông báo tối đa của mô hình

📥 Phản hồi

###Phản hồi thành công

results

  • Kiểu: Mảng
  • Mô tả: Danh sách tài liệu được sắp xếp lại
  • Của cải:
  • document: Đối tượng chứa văn bản tài liệu
  • index: Chỉ mục của tài liệu trong danh sách gốc
  • relevance_score: Điểm liên quan (trong khoảng 0-1)

usage

  • Loại: Đối tượng
  • Mô tả: Thống kê sử dụng Token
  • Của cải:
  • prompt_tokens: Số lượng token dùng cho lời nhắc
  • completion_tokens: Số lượng token được sử dụng để hoàn thành
  • total_tokens: Tổng số token
  • prompt_tokens_details: Thông tin nhắc nhở chi tiết về token
  • cached_tokens: Số lượng token được lưu vào bộ nhớ đệm
  • audio_tokens: Số lượng token âm thanh
  • completion_tokens_details: Thông tin chi tiết về token hoàn thành
  • reasoning_tokens: Số lượng thẻ suy luận
  • audio_tokens: Số lượng token âm thanh
  • accepted_prediction_tokens: Số lượng token dự đoán được chấp nhận
  • rejected_prediction_tokens: Số lượng token dự đoán bị từ chối

Phản hồi lỗi

Khi có vấn đề với yêu cầu, API sẽ trả về phản hồi lỗi:

  • 400 Bad Request: Tham số yêu cầu không hợp lệ
  • 401 Unauthorized: Key API không hợp lệ hoặc bị thiếu
  • 429 Too Many Requests: Vượt quá giới hạn tần suất yêu cầu
  • 500 Internal Server Error: Lỗi máy chủ nội bộ

💡 Các phương pháp hay nhất

Đề xuất tối ưu hóa truy vấn

  1. Sử dụng văn bản truy vấn rõ ràng và cụ thể
  2. Tránh truy vấn quá rộng hoặc mơ hồ
  3. Đảm bảo truy vấn sử dụng cùng kiểu ngôn ngữ với tài liệu

Đề xuất xử lý tài liệu

  1. Giữ độ dài tài liệu vừa phải, không vượt quá giới hạn mô hình
  2. Đảm bảo nội dung tài liệu đầy đủ và có ý nghĩa
  3. Có thể bao gồm các tài liệu đa ngôn ngữ, mô hình hỗ trợ kết hợp đa ngôn ngữ

Tối ưu hóa hiệu suất

  1. Đặt tham số top_n hợp lý để giảm bớt những tính toán không cần thiết
  2. Đối với số lượng lớn tài liệu, hãy xem xét xử lý hàng loạt
  3. Có thể lưu trữ kết quả cho các truy vấn phổ biến

Hỗ trợ đa ngôn ngữ

Mô hình này hỗ trợ sắp xếp lại tài liệu bằng nhiều ngôn ngữ, bao gồm nhưng không giới hạn ở:

  • Tiếng Anh
  • Tiếng Trung
  • tiếng Đức
  • tiếng Tây Ban Nha
  • Tiếng Nhật
  • Tiếng Pháp

Không cần chỉ định tham số ngôn ngữ, mô hình sẽ tự động nhận dạng và xử lý nội dung bằng các ngôn ngữ khác nhau.