重新排序文档
提供一个查询和1–1000个文档。.
本页面内容
https://api.shareai.now/api/v1/rerank重新排序文档
- 基础 URL
https://api.shareai.now- 身份验证
- Bearer API 密钥或已批准的 OAuth 访问令牌
- 必需范围
inferenceormonetization_gateway
提供一个查询和1–1000个文档。每个文档可以是文本、 {"text":"..."} 对象或模型支持的 {"image":"https://..."} 对象。. top_n 必须至少为1且不能超过文档数量。将结果与原始文档索引匹配。.
开始之前#
在您的服务器上设置 SHAREAI_API_KEY,并将模型占位符替换为当前启用的模型。切勿在浏览器代码中暴露 API 密钥。模型、账户、凭证和提供者必须全部允许此操作。以下可选设置需要模型支持;API 安全范围并不保证每个模型支持所有值。.
发送请求#
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);请求字段#
| 字段 | 类型 | 含义与限制 |
|---|---|---|
model 必需 | 字符串 | 精确启用的公共模型标识符。必须声明此操作并由您的凭证允许。. |
query 必需 | 字符串 | 非空相关性查询。. |
documents 必需 | 数组 | 1–1000个非空文本字符串或单键文本/图像对象。图像值必须是HTTPS URL或支持的图像数据URL,并且模型支持图像输入。. |
top_n | 整数 | 可选结果数量从1到文档数量。返回的索引指向原始文档数组。. |
return_documents | 布尔值 | 可选的提供者支持的原始文档包含在结果中。. |
provider | 对象 | 可选的提供者路由偏好。使用 provider.only 接受的提供者标签,而不是模型 ID 的前缀。账户和凭证限制仍然适用。. |
阅读结果#
成功返回HTTP 200和JSON。提供一个查询和1–1000个文档。每个文档可以是文本、 {"text":"..."} 对象或模型支持的 {"image":"https://..."} 对象。. top_n 必须至少为1且不能超过文档数量。将结果与原始文档索引匹配。.
计费单位#
重排序率可以使用输入令牌、评分文档、请求或提供者报告的搜索数量。不假设通用的搜索到令牌转换。无法报告定价维度的提供者将无法使用该收费标准。.
从控制台选择精确启用的模型标识符。其声明的操作和输入/输出能力必须与此端点匹配;文本聊天模型不能替代其他操作。您的凭证、提供者和账户限制仍然适用。.
定价与使用#
费率以选定模型、提供者、单位和变体的 EUR AI 积分发布。仅收费于其活动费率中的维度。估算会在执行前保留积分;最终费用使用测量的使用量。价格可能取决于分辨率、输出格式或使用范围。请检查控制台使用情况以获取最终的 ShareAI 扣款。上游成本字段和媒体字节不会转换为虚构的令牌计数。.
访问与错误#
使用 inference 用于批准的网络成本推理或 monetization_gateway 用于批准的 Builder 加价和接受的计费条款。仅身份访问不授权支出。验证、模型授权、积分不足、费率限制和执行失败会返回结构化 error. 在超时或提交不确定后,请检查使用情况或视频任务,然后再创建另一个可能付费的请求。.
最近更新日期:2026年11月3日