Sắp xếp lại thứ tự tài liệu
Cung cấp một truy vấn và 1–1000 tài liệu.
Trên trang này
https://api.shareai.now/api/v1/rerankSắp xếp lại thứ tự tài liệu
- URL cơ sở
https://api.shareai.now- Xác thực
- Khóa API Bearer hoặc token truy cập OAuth đã được phê duyệt
- Phạm vi yêu cầu
inferenceormonetization_gateway
Cung cấp một truy vấn và 1–1000 tài liệu. Mỗi tài liệu là văn bản, một {"text":"..."} đối tượng hoặc một đối tượng được hỗ trợ bởi mô hình. {"image":"https://..."} đối tượng. top_n phải ít nhất là 1 và không lớn hơn số lượng tài liệu. Kết quả khớp với chỉ số tài liệu gốc.
Trước khi bạn bắt đầu#
Đặt SHAREAI_API_KEY trên máy chủ của bạn và thay thế placeholder model bằng một model hiện đang được kích hoạt. Không bao giờ để lộ khóa API trong mã trình duyệt. Model, tài khoản, thông tin xác thực và nhà cung cấp phải cho phép thực hiện thao tác này. Các cài đặt tùy chọn dưới đây yêu cầu hỗ trợ từ model; giới hạn an toàn của API không đảm bảo rằng mọi model đều hỗ trợ mọi giá trị.
Gửi một yêu cầu#
cURL
curl --fail-with-body --request POST "https://api.shareai.now/api/v1/rerank" \
-H "Authorization: Bearer $SHAREAI_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"model": "YOUR_ENABLED_RERANK_MODEL",
"query": "A cat",
"documents": [
{
"text": "A cat on a windowsill."
},
{
"text": "A map of Berlin."
}
],
"top_n": 1
}'Python
import json
import os
import urllib.request
payload = {'model': 'YOUR_ENABLED_RERANK_MODEL',
'query': 'A cat',
'documents': [{'text': 'A cat on a windowsill.'},
{'text': 'A map of Berlin.'}],
'top_n': 1}
headers = {'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["SHAREAI_API_KEY"]
request = urllib.request.Request('https://api.shareai.now/api/v1/rerank', data=json.dumps(payload).encode(), headers=headers, method="POST")
with urllib.request.urlopen(request, timeout=180) as response:
result = json.load(response)
print(result)TypeScript
const response = await fetch("https://api.shareai.now/api/v1/rerank", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SHAREAI_API_KEY}`, ...{"Content-Type": "application/json"} },
body: JSON.stringify({
"model": "YOUR_ENABLED_RERANK_MODEL",
"query": "A cat",
"documents": [
{
"text": "A cat on a windowsill."
},
{
"text": "A map of Berlin."
}
],
"top_n": 1
}),
});
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
console.log(result);Các trường yêu cầu#
| Trường | Loại | Ý nghĩa và giới hạn |
|---|---|---|
model bắt buộc | chuỗi | Định danh mô hình công khai chính xác đã được kích hoạt. Phải khai báo thao tác này và được thông qua bởi thông tin xác thực của bạn. |
query bắt buộc | chuỗi | Truy vấn liên quan không được để trống. |
documents bắt buộc | mảng | 1–1000 chuỗi văn bản không trống hoặc các đối tượng văn bản/hình ảnh có một khóa duy nhất. Giá trị hình ảnh phải là URL HTTPS hoặc URL dữ liệu hình ảnh được hỗ trợ, với hỗ trợ đầu vào hình ảnh của mô hình. |
top_n | số nguyên | Số lượng kết quả tùy chọn từ 1 đến số lượng tài liệu. Các chỉ số trả về tham chiếu đến mảng tài liệu gốc. |
return_documents | boolean | Tùy chọn bao gồm tài liệu gốc được hỗ trợ bởi nhà cung cấp trong kết quả. |
provider | đối tượng | Tùy chọn ưu tiên định tuyến nhà cung cấp. Sử dụng provider.only cho các thẻ nhà cung cấp được chấp nhận, không phải tiền tố trong ID mô hình. Các hạn chế về tài khoản và thông tin xác thực vẫn được áp dụng. |
Đọc kết quả#
Thành công trả về HTTP 200 với JSON. Cung cấp một truy vấn và 1–1000 tài liệu. Mỗi tài liệu là văn bản, một {"text":"..."} đối tượng hoặc một đối tượng được hỗ trợ bởi mô hình. {"image":"https://..."} đối tượng. top_n phải ít nhất là 1 và không lớn hơn số lượng tài liệu. Kết quả khớp với chỉ số tài liệu gốc.
Đơn vị thanh toán#
Tỷ lệ sắp xếp lại có thể sử dụng các token đầu vào, tài liệu được chấm điểm, yêu cầu hoặc một số lượng tìm kiếm được báo cáo bởi nhà cung cấp. Không giả định chuyển đổi tìm kiếm sang token phổ quát. Một nhà cung cấp không thể báo cáo một đơn vị tính giá sẽ không khả dụng cho biểu giá đó.
Chọn mã định danh model đã kích hoạt chính xác từ Console. Hoạt động được công bố và khả năng đầu vào/đầu ra của nó phải phù hợp với endpoint này; một model trò chuyện văn bản không thể thay thế cho một hoạt động khác. Các hạn chế về thông tin xác thực, nhà cung cấp và tài khoản của bạn vẫn được áp dụng.
Giá cả và sử dụng#
Mức giá được công bố bằng tín dụng AI EUR cho model, nhà cung cấp, đơn vị và biến thể đã chọn. Chỉ các yếu tố trong biểu giá đang hoạt động của nó mới bị tính phí. Một ước tính sẽ giữ trước tín dụng trước khi thực thi; phí cuối cùng sử dụng mức sử dụng được đo lường. Giá có thể phụ thuộc vào độ phân giải, định dạng đầu ra hoặc một dải sử dụng. Kiểm tra Console Usage để biết khoản ghi nợ ShareAI cuối cùng. Các trường chi phí thượng nguồn và byte phương tiện không được chuyển đổi thành số lượng token được tạo ra.
Truy cập và lỗi#
Sử dụng inference cho suy luận chi phí mạng được phê duyệt hoặc monetization_gateway cho một mức tăng giá của Builder được phê duyệt và các điều khoản thanh toán được chấp nhận. Quyền truy cập chỉ danh tính không cho phép chi tiêu. Xác thực, ủy quyền model, tín dụng không đủ, giới hạn tốc độ và lỗi thực thi trả về một cấu trúc error. Sau khi hết thời gian chờ hoặc gửi không chắc chắn, kiểm tra Usage hoặc công việc video trước khi tạo một yêu cầu khác có thể phải trả phí.
Cập nhật lần cuối Tháng 11 3, 2026