> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agicto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 排序模型

> POST /v1/rerank

## Endpoint

```http theme={null}
POST /v1/rerank
```

**分组**: 模型调用 / 排序模型

## Headers

* `Authorization`: 必填 示例: `Bearer $API_KEY`
* `Content-Type`: 必填 示例: `application/json`

## Request example

```json theme={null}
{
  "model": "rerank-v3.5",
  "query": "排序模型是什么",
  "top_n": 3,
  "documents": [
    "文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序",
    "量子计算是计算科学的一个前沿领域",
    "预训练语言模型的发展给文本排序模型带来了新的进展"
  ]
}
```

## Responses

* `200`: 成功

## OpenAPI specification

```yaml theme={null}
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/rerank:
    post:
      summary: 排序模型
      deprecated: false
      description: ''
      tags:
        - 模型调用/排序模型
      parameters:
        - name: Authorization
          in: header
          description: ''
          required: true
          example: Bearer $API_KEY
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                model:
                  type: string
                  description: 模型
                query:
                  type: string
                  description: 需匹配内容
                top_n:
                  type: integer
                  description: >-
                    排序返回的top文档数量，未指定时默认返回全部候选文档，如果指定的top_n值大于输入的候选document数量，返回全部候选文档
                documents:
                  type: array
                  items:
                    type: string
                  description: 待排序的候选document列表
              required:
                - model
                - query
                - top_n
                - documents
              x-apifox-orders:
                - model
                - query
                - top_n
                - documents
            example:
              model: rerank-v3.5
              query: 排序模型是什么
              top_n: 3
              documents:
                - 文本排序模型广泛用于搜索引擎和推荐系统中，它们根据文本相关性对候选文本进行排序
                - 量子计算是计算科学的一个前沿领域
                - 预训练语言模型的发展给文本排序模型带来了新的进展
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                          description: 本结构中的算法结果对应的document在输入候选documents数组中的位置索引值
                        relevance_score:
                          type: number
                          description: 相似度分数取值0.0-1.0之间（浮点型）
                      required:
                        - index
                        - relevance_score
                      x-apifox-orders:
                        - index
                        - relevance_score
                    description: 请求的算法输出内容，是一个结构化的数组。每一个数组中包含一个对应的输入text的算法输出内容
                  usage:
                    type: object
                    properties:
                      total_tokens:
                        type: integer
                    required:
                      - total_tokens
                    x-apifox-orders:
                      - total_tokens
                required:
                  - results
                  - usage
                x-apifox-orders:
                  - results
                  - usage
              example:
                results:
                  - index: 0
                    relevance_score: 0.72042775
                  - index: 1
                    relevance_score: 0.60077465
                usage:
                  total_tokens: 0
          headers: {}
          x-apifox-name: 成功
      security: []
      x-apifox-folder: 模型调用/排序模型
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/5443699/apis/api-282831591-run
components:
  schemas: {}
  securitySchemes: {}
servers: []
security: []
```