88API88API
User GuideAI ApplicationsAPI ReferenceHelp & Support
Rerank

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

Lưu ý quan trọng

Định dạng giao diện của mô hình Rerank của Cohere giống với Jina's Rerank giao diện mô hình.

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

Cohere Rerank

📝 Giới thiệu

Đưa ra một truy vấn và danh sách các văn bản, API sắp xếp lại sẽ sắp xếp các văn bản dựa trên mức độ liên quan của chúng với truy vấn. Mỗi văn bản được gán một điểm phù hợp, dẫn đến một chuỗi kết quả được sắp xếp theo thứ tự. Tính năng này đặc biệt hữu ích cho các ứng dụng tìm kiếm và truy xuất, tối ưu hóa thứ hạng tài liệu và giúp người dùng tìm thấy thông tin liên quan nhanh hơn.

💡 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 "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-v3.5",
    "query": "What is the capital of the United States?",
    "documents": [
      "The capital of Nevada is Carson City.",
      "The Northern Mariana Islands are a group of islands in the Pacific, with Saipan as the capital.",
      "Washington, D.C. (also known as Washington or D.C., officially the District of Columbia) is the capital of the United States.",
      "Capitalization in English grammar is the use of uppercase letters at the beginning of words. English usage differs from other languages in capitalization.",
      "The death penalty existed in the United States before it became a country. As of 2017, 30 out of 50 states have the death penalty legalized."
    ],
    "top_n": 3
  }'

Response Example:

{
  "results": [
    {
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf",
  "meta": {
    "api_version": {
      "version": "2",
      "is_experimental": false
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

Sử dụng dữ liệu có cấu trúc ✅

curl https://88api.ai/v1/rerank \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "rerank-v3.5",
    "query": "Looking for a cost-effective DSLR camera for beginners",
    "documents": [
      "Model: Canon EOS 800D\nPrice: 4299 yuan\nFeatures: 24.1MP, optical viewfinder, Wi-Fi\nSuitable for: Beginners, enthusiasts",
      "Model: Nikon D3500\nPrice: 3099 yuan\nFeatures: 24.16MP, optical viewfinder, battery life up to 1550 shots\nSuitable for: Newbies, students",
      "Model: Sony A7III\nPrice: 12999 yuan\nFeatures: 24.2MP, full-frame, 4K video\nSuitable for: Professional photographers, video creators"
    ],
    "max_tokens_per_doc": 512
  }'

Response Example:

{
  "results": [
    {
      "index": 1,
      "relevance_score": 0.918472
    },
    {
      "index": 0,
      "relevance_score": 0.854321
    },
    {
      "index": 2,
      "relevance_score": 0.423156
    }
  ],
  "id": "8f734bd2-2473-4f07-94e1-0d9f0e68ebfa",
  "meta": {
    "api_version": {
      "version": "2"
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

📮 Yêu cầu

Điểm cuối

POST /v1/rerank

Sắp xếp danh sách văn bản dựa trên mức độ liên quan của chúng với truy vấn.

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.

Tham số tiêu đề yêu cầu

X-Client-Name

  • Loại: Chuỗi
  • Bắt buộc: Không
  • Mô tả: Tên dự án khởi tạo yêu cầu.

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

model

  • Loại: Chuỗi
  • Bắt buộc: Có
  • Mô tả: Mã định danh mô hình sẽ sử dụng, ví dụ: rerank-v3.5.

query

  • Loại: Chuỗi
  • Bắt buộc: Có
  • Mô tả: Tìm kiếm văn bản truy vấn. Đây là nội dung câu hỏi hoặc truy vấn của người dùng.

documents

  • Kiểu: Mảng chuỗi
  • Bắt buộc: Có
  • Mô tả: Danh sách văn bản so sánh với câu truy vấn. Để có hiệu suất tốt nhất, không gửi quá 1.000 tài liệu trong một yêu cầu.
  • Ghi chú:
  • Các văn bản dài sẽ được tự động cắt bớt theo giá trị được chỉ định bởi max_tokens_per_doc
  • Dữ liệu có cấu trúc nên được định dạng dưới dạng chuỗi YAML để có hiệu suất tốt nhất

top_n

  • Kiểu: Số nguyên
  • Bắt buộc: Không
  • Mô tả: Giới hạn số kết quả xếp hạng lại trả về. Nếu không được chỉ định, tất cả các kết quả được sắp xếp lại sẽ được trả về.

max_tokens_per_doc

  • Kiểu: Số nguyên
  • Bắt buộc: Không
  • Mặc định: 4096
  • Mô tả: Các văn bản dài sẽ được tự động cắt bớt theo số lượng token được chỉ định.

📥 Phản hồi

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

Trả về một đối tượng chứa danh sách tài liệu đã được sắp xếp.

results

  • Kiểu: Mảng đối tượng
  • Mô tả: Danh sách các tài liệu được sắp xếp theo mức độ liên quan giảm dần
  • Của cải:
  • index: Số nguyên, chỉ số của tài liệu trong danh sách gốc
  • relevance_score: Float, điểm phù hợp trong khoảng [0, 1]. Điểm gần 1 biểu thị mức độ liên quan cao, gần 0 biểu thị mức độ liên quan thấp

id

  • Loại: Chuỗi
  • Mô tả: Mã định danh duy nhất cho yêu cầu

meta

  • Loại: Đối tượng
  • Mô tả: Chứa siêu dữ liệu về yêu cầu
  • Của cải:
  • api_version: Đối tượng, chứa thông tin phiên bản API
  • version: Chuỗi, số phiên bản API
  • is_deprecated: Boolean, dù không được dùng nữa
  • is_experimental: Boolean, dù là thực nghiệm
  • billed_units: Đối tượng, chứa thông tin thanh toán
  • search_units: Float, số lượng đơn vị tìm kiếm được tính phí
  • tokens: Đối tượng, chứa số liệu thống kê sử dụng token
  • input_tokens: Float, số lượng token làm đầu vào mô hình
  • output_tokens: Float, số lượng token do mô hình tạo ra

warnings

  • Kiểu: Mảng chuỗi
  • Bắt buộc: Không
  • Mô tả: Thông báo cảnh báo được API trả về

Phản hồi lỗi

Khi yêu cầu gặp sự cố, API có thể trả về các mã trạng thái HTTP sau và các lỗi tương ứng:

  • 400 Bad Request: Lỗi định dạng yêu cầu hoặc tham số
  • 401 Unauthorized: Không cung cấp khóa API hợp lệ
  • 403 Forbidden: Không có quyền truy cập vào tài nguyên này
  • 404 Not Found: Tài nguyên được yêu cầu không tồn tại
  • 422 Unprocessable Entity: Yêu cầu đúng định dạng nhưng có lỗi ngữ nghĩa
  • 429 Too Many Requests: Tỷ lệ yêu cầu vượt quá giới hạn
  • 500 Internal Server Error: Lỗi nội bộ của máy chủ
  • 503 Service Unavailable: Dịch vụ tạm thời không khả dụng

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

Mẹo chuẩn bị tài liệu

  1. Độ dài tài liệu: Giữ cho mỗi tài liệu ngắn gọn và rõ ràng, tránh quá dài. Các tài liệu dài sẽ được tự động cắt bớt.

  2. Dữ liệu có cấu trúc: Định dạng dữ liệu có cấu trúc dưới dạng chuỗi YAML để có hiệu suất tốt nhất. Ví dụ:

    title: Product Name
price: 9999 yuan
features:
  - Feature 1
  - Feature 2

  3. Số lượng tài liệu: Không vượt quá 1.000 tài liệu cho mỗi yêu cầu để có hiệu suất tốt nhất.

Tối ưu hóa truy vấn

  1. Cụ thể: Xây dựng các truy vấn rõ ràng và cụ thể để có kết quả xếp hạng chính xác hơn.

  2. Tránh truy vấn mơ hồ: Tránh truy vấn quá mơ hồ hoặc chung chung vì điều này có thể dẫn đến điểm liên quan ít rõ ràng hơn.

Hiểu Điểm Liên quan

Điểm liên quan được chuẩn hóa thành phạm vi [0, 1]:

  • Điểm gần bằng 1 cho thấy mức độ liên quan cao với truy vấn
  • Điểm gần bằng 0 cho thấy mức độ liên quan thấp

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

Trang trước

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

Trang tiếp theo

Mục lục

📝 Giới thiệu
💡 Yêu cầu Ví dụ
Yêu cầu xếp hạng lại cơ bản ✅
Sử dụng dữ liệu có cấu trúc ✅
📮 Yêu cầu
Điểm cuối
Phương thức xác thực
Tham số tiêu đề yêu cầu
X-Client-Name
Thông số nội dung yêu cầu
model
query
documents
top_n
max_tokens_per_doc
📥 Phản hồi
results
id
meta
warnings
Phản hồi lỗi
🌟 Các phương pháp hay nhất
Mẹo chuẩn bị tài liệu
Tối ưu hóa truy vấn
Hiểu Điểm Liên quan