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

# 文档重排序

> 按与查询的相关性对文档排序（Jina 风格 / OpenAI 兼容 rerank）。



## OpenAPI

````yaml zh-CN/openapi/xgapi-public.yaml POST /v1/rerank
openapi: 3.0.3
info:
  title: Omniall AI 公开 API
  description: >-
    Omniall AI 公开 API。网站：https://omniall.ai — API 主机：https://api.omniall.ai —
    模型广场：https://omniall.ai/pricing
  version: 1.1.0
servers:
  - url: https://api.omniall.ai
    description: 生产环境
security:
  - bearerAuth: []
tags:
  - name: Models
    description: 列出当前 API Key 可用的模型。
  - name: ChatGPT Chat Completions
    x-group: ChatGPT
    description: OpenAI Chat Completions 对话接口（`POST /v1/chat/completions`）。
  - name: Responses
    description: OpenAI Responses 接口（`POST /v1/responses`）。
  - name: Claude
    description: Anthropic Messages 消息接口（`POST /v1/messages`）。
  - name: Gemini
    description: Google Gemini 原生 generateContent / streamGenerateContent。
  - name: Images
    description: 图像生成（OpenAI Images）、各厂商说明与 Midjourney 代理接口。
  - name: Video
    description: 异步视频任务。
  - name: Audio
    description: 语音合成及相关音频接口。
  - name: Rerank
    description: 文档重排序。
paths:
  /v1/rerank:
    post:
      tags:
        - Rerank
      summary: 文档重排序
      description: 按与查询的相关性对文档排序（Jina 风格 / OpenAI 兼容 rerank）。
      operationId: createRerank
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerankRequest'
            example:
              model: rerank-english-v2.0
              query: What is Omniall AI?
              documents:
                - Omniall is an AI API gateway.
                - Cats are animals.
                - Rerank scores relevance.
              top_n: 2
              return_documents: true
      responses:
        '200':
          description: 重排序结果
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerankResponse'
              example:
                id: rerank-...
                results:
                  - index: 0
                    relevance_score: 0.91
                    document:
                      text: Omniall is an AI API gateway.
                  - index: 2
                    relevance_score: 0.72
                    document:
                      text: Rerank scores relevance.
        '401':
          description: 未授权
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
components:
  schemas:
    RerankRequest:
      type: object
      required:
        - model
        - query
        - documents
      properties:
        model:
          type: string
          example: rerank-english-v2.0
          description: 重排序模型 ID。
        query:
          type: string
          description: 用于给文档打分的查询文本。
        documents:
          type: array
          description: 待排序文档。每项可为纯字符串或对象，视模型而定。
          items:
            oneOf:
              - type: string
              - type: object
                additionalProperties: true
        top_n:
          type: integer
          description: 仅返回 Top N 结果（可选）。
        return_documents:
          type: boolean
          default: false
          description: 为 true 时在结果中包含文档文本/对象。
      description: 文档重排序
    RerankResponse:
      type: object
      properties:
        id:
          type: string
          description: 请求/结果 id。
        results:
          type: array
          items:
            type: object
            properties:
              index:
                type: integer
                description: 文档在原始 `documents` 数组中的索引。
              relevance_score:
                type: number
                description: 越高表示与 `query` 越相关。
              document:
                type: object
                additionalProperties: true
                description: return_documents 为 true 时的文档载荷。
            description: 单个排序文档。
          description: 排序后的命中结果。
        meta:
          type: object
          additionalProperties: true
          description: 可选厂商元数据。
      description: 重排序结果
    OpenAIErrorResponse:
      type: object
      description: 鉴权或请求失败时返回的 OpenAI 风格错误包络。
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              description: 人类可读错误信息。网关可能附加 request id 便于排查。
            type:
              type: string
              description: 错误类型，常见为 `new_api_error`。
              example: new_api_error
            code:
              type: string
              description: 可选机器可读错误码（如 `access_denied`），可能为空字符串。
          description: 错误对象。
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: '使用来自 https://omniall.ai/dashboard 的 Authorization: Bearer sk-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.