Cohere Rerank

Xếp hạng lại tài liệu ứng viên bằng cấu trúc yêu cầu Rerank theo định dạng Cohere.

API Cohere Rerank xếp hạng tài liệu ứng viên theo mức độ liên quan đến văn bản truy vấn. Các trường yêu cầu chính về cơ bản giống Jina Rerank, đồng thời hỗ trợ thêm X-Client-Name và max_tokens_per_doc; phản hồi gồm chỉ số tài liệu gốc, điểm liên quan, mã định danh yêu cầu, phiên bản API và siêu dữ liệu tính phí.

POST/v1/rerank

Tính điểm liên quan của tài liệu ứng viên với văn bản truy vấn và trả về kết quả theo mức độ liên quan giảm dần. Các trường yêu cầu chính về cơ bản giống Jina Rerank, đồng thời hỗ trợ thêm X-Client-Name và max_tokens_per_doc. Phản hồi thành công bao gồm chỉ số kết quả, điểm liên quan, mã định danh yêu cầu, phiên bản API và siêu dữ liệu tính phí.

Để kết quả ổn định hơn, truy vấn nên rõ ràng, cụ thể và tài liệu nên ngắn gọn nhưng đầy đủ ý nghĩa. Tài liệu dài sẽ bị cắt theo max_tokens_per_doc. Nên gửi không quá 1,000 tài liệu trong một yêu cầu và chuyển dữ liệu có cấu trúc thành chuỗi YAML.

Xác thực

bearerAuth

Xác thựcBearer <token>

Sử dụng Bearer your-api-key trong Header Authorization.

Vị trí truyền: header

Tham số Header

X-Client-Name?string

Tên dự án gửi yêu cầu.

Nội dung yêu cầu

application/json

Tham số yêu cầu xếp hạng lại tài liệu theo định dạng Cohere.

Định nghĩa kiểu TypeScript

Sử dụng kiểu request body trong TypeScript.

model*string

ID mô hình xếp hạng lại cần sử dụng. Điền mô hình khả dụng với API Key hiện tại và hỗ trợ định dạng Cohere Rerank.

Độ dài1 <= length

query*string

Văn bản truy vấn để so sánh với tài liệu ứng viên. Nên dùng truy vấn rõ ràng, cụ thể, tránh cách diễn đạt quá mơ hồ hoặc rộng.

Độ dài1 <= length

documents*array<string>

Danh sách văn bản để so sánh với truy vấn. Nên gửi không quá 1,000 tài liệu mỗi yêu cầu. Tài liệu dài bị cắt theo max_tokens_per_doc; nên chuyển dữ liệu có cấu trúc thành chuỗi YAML.

Số phần tử1 <= items

top_n?integer

Giới hạn số kết quả xếp hạng lại trả về. Nếu không cung cấp, trả về tất cả kết quả. Có thể đặt trường này khi chỉ cần ít kết quả để giảm xử lý tiếp theo.

max_tokens_per_doc?integer

Số Token tối đa của mỗi tài liệu tham gia xếp hạng lại; nội dung vượt quá giới hạn này sẽ bị cắt.

Giá trị mặc định4096

Nội dung phản hồi

`application/json`

curl -X POST "https://example.com/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "query": "Thủ đô của Hoa Kỳ là gì?",    "documents": [      "Thủ phủ của bang Nevada là Carson City.",      "Quần đảo Bắc Mariana là một nhóm đảo ở Thái Bình Dương, có thủ phủ là Saipan.",      "Washington, D.C. (còn được gọi là Washington hoặc D.C., tên chính thức là Đặc khu Columbia) là thủ đô của Hoa Kỳ.",      "Viết hoa trong ngữ pháp tiếng Anh là dùng chữ cái in hoa ở đầu từ. Cách viết hoa trong tiếng Anh khác với các ngôn ngữ khác.",      "Án tử hình đã tồn tại tại Hoa Kỳ từ trước khi nước này được thành lập. Tính đến năm 2017, án tử hình hợp pháp tại 30 trong số 50 bang."    ],    "top_n": 3  }'

{
  "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
    }
  }
}

Xác thực

Tham số Header

Nội dung yêu cầu

Nội dung phản hồi

200application/json

400

401

403

404

422

429

500

503

`application/json`