重排序

本页收录重排序接口及其兼容性说明。

Apifox 覆盖范围补充

标准重排序（Rerank）
Jina AI 重排序格式
Cohere 重排序格式
Xinference 重排序格式

模型接口/重排序 (Rerank)

POST Xinference 重排序格式

POST /rerank

重要提示：Xinference的rerank响应结构将被格式化为Jina的rerank响应结构，使用方式和Jina的rerank相同。对于Dify等客户端用户：在配置时请选择 Jina AI 作为供应商类型，而不是Xinference，并使用Xinference支持的模型名称。

简介：Xinference的重排序API与Jina AI的重排序API完全兼容。请参考Jina AI 重排序格式（Rerank）文档了解详细的使用方法、请求参数和响应格式。

使用方法：使用Xinference重排序API时，只需将model参数设置为Xinference支持的重排序模型即可，其余参数和使用方式与Jina AI重排序API相同。

Body 请求参数

{
    "model": "jina-reranker-m0",
    "query": "什么是美国的首都？",
    "documents": [
        "内华达州的首府是卡森城。",
        "北马里亚纳群岛是太平洋上的一组岛屿，其首都是塞班岛。",
        "华盛顿特区（也称为华盛顿或特区，正式名称为哥伦比亚特区）是美国的首都。",
        "英语语法中的大写是在单词开头使用大写字母。英语用法与其他语言的大写不同。",
        "自美国成为一个国家之前，美国就存在死刑。截至2017年，在50个州中有30个州死刑合法。"
    ],
    "top_n": 3
}

请求参数

名称	位置	类型	必选	说明
Content-Type	header	string	是	none
Accept	header	string	是	none
Authorization	header	string	否	none
body	body	object	否	none
» model	body	string	是	要使用的模型的 ID。有关哪些模型适用于聊天 API 的详细信息，请参阅模型端点兼容性表。
» messages	body	[object]	是	以聊天格式生成聊天完成的消息。
»» role	body	string	否	none
»» content	body	string	否	none
» temperature	body	integer	否	使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使输出更加集中和确定。我们通常建议改变这个或`top_p`但不是两者。
» top_p	body	integer	否	一种替代温度采样的方法，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议改变这个或`temperature`但不是两者。
» n	body	integer	否	为每个输入消息生成多少个聊天完成选项。
» stream	body	boolean	否	如果设置，将发送部分消息增量，就像在 ChatGPT 中一样。当令牌可用时，令牌将作为纯数据服务器发送事件`data: [DONE]`发送，流由消息终止。有关示例代码，请参阅 OpenAI Cookbook 。
» stop	body	string	否	API 将停止生成更多令牌的最多 4 个序列。
» max_tokens	body	integer	否	聊天完成时生成的最大令牌数。输入标记和生成标记的总长度受模型上下文长度的限制。
» presence_penalty	body	number	否	-2.0 和 2.0 之间的数字。正值会根据到目前为止是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。查看有关频率和存在惩罚的更多信息。
» frequency_penalty	body	number	否	-2.0 和 2.0 之间的数字。正值会根据新标记在文本中的现有频率对其进行惩罚，从而降低模型逐字重复同一行的可能性。查看有关频率和存在惩罚的更多信息。
» logit_bias	body	null	否	修改指定标记出现在完成中的可能性。接受一个 json 对象，该对象将标记（由标记器中的标记 ID 指定）映射到从 -100 到 100 的关联偏差值。从数学上讲，偏差会在采样之前添加到模型生成的 logits 中。确切的效果因模型而异，但 -1 和 1 之间的值应该会减少或增加选择的可能性；像 -100 或 100 这样的值应该导致相关令牌的禁止或独占选择。
» user	body	string	否	代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多。

返回示例

200 Response

{
  "id": "string",
  "object": "string",
  "created": 0,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "string",
        "content": "string"
      },
      "finish_reason": "string"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» id	string	true	none	none
» object	string	true	none	none
» created	integer	true	none	none
» choices	[object]	true	none	none
»» index	integer	false	none	none
»» message	object	false	none	none
»»» role	string	true	none	none
»»» content	string	true	none	none
»» finish_reason	string	false	none	none
» usage	object	true	none	none
»» prompt_tokens	integer	true	none	none
»» completion_tokens	integer	true	none	none
»» total_tokens	integer	true	none	none

Apifox 覆盖范围补充​

模型接口/重排序 (Rerank)​

POST Xinference 重排序格式​

请求参数​

返回结果​

返回数据结构​