Rerank - OpenSearch - Centro de documentación de Alibaba Cloud

Califica y ordena una lista de documentos candidatos según su relevancia respecto a una consulta. Use esta API para mejorar la calidad de recuperación en los pipelines de búsqueda al reordenar los resultados antes de mostrarlos a los usuarios.

Modelos disponibles

Nombre del servicio	ID del servicio	Descripción	Límite de QPS
Modelo de reranking BGE	`ops-bge-reranker-larger`	Ordena documentos según la relevancia entre la consulta y el documento mediante el modelo BGE. Admite chino e inglés. Entrada máxima: 512 tokens (consulta + documento combinados).	20 (cuenta de Alibaba Cloud y usuarios de RAM combinados). Para solicitar un límite mayor, envíe un ticket.
Modelo de reranking de texto OpenSearch-001	`ops-text-reranker-001`	Ordena documentos por relevancia semántica; entrenado con varios conjuntos de datos industriales. Admite chino e inglés. Entrada máxima: 512 tokens (consulta + documento combinados).	—
Servicio de ranking Qwen3-0.6B	`ops-qwen3-reranker-0.6b`	Modelo de reranking de la serie Qwen3 con 0.6B parámetros. Admite más de 100 idiomas. Entrada máxima: 32k tokens (consulta + documento combinados).	—

Requisitos previos

Antes de empezar, asegúrese de contar con lo siguiente:

Una clave de API para la autenticación. Para obtener detalles sobre cómo conseguirla, consulte la documentación de autenticación de AI Search Open Platform.
Un endpoint de servicio (Internet o Virtual Private Cloud (VPC)). Consulte Get service registration address.

Sintaxis de la solicitud

POST {host}/v3/openapi/workspaces/{workspace_name}/ranker/{service_id}

Parámetros de ruta:

Parámetro	Descripción
`host`	El endpoint del servicio. Admite acceso por Internet y VPC. Consulte Obtener la dirección de registro del servicio.
`workspace_name`	El nombre del workspace. Ejemplo: `default`.
`service_id`	El ID del modelo de reranking por usar. Ejemplo: `ops-bge-reranker-larger`.

Límites:

Tamaño máximo del cuerpo de la solicitud: 8 MB.

Parámetros de la solicitud

Parámetros de encabezado

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
`Content-Type`	String	Sí	El tipo de contenido de la solicitud. Establezca este valor en `application/json`.	`application/json`
`Authorization`	String	Sí	La clave de API usada para la autenticación. Formato: `Bearer <your-api-key>`.	`Bearer OS-d1**2a`

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
`query`	String	Sí	La consulta de búsqueda con la que se calificarán los documentos.	`What are the fun places in Shanghai?`
`docs`	List	Sí	La lista de documentos candidatos por reordenar.	`["There are many fun places in Shanghai", "There are many fun places in Beijing"]`

Parámetros de respuesta

Parámetro	Tipo	Descripción	Ejemplo
`request_id`	String	El ID de la solicitud.	`A5B25952-4406-45BF-99EC-E8020246****`
`latency`	Float/Int	El tiempo de procesamiento de la solicitud, en milisegundos.	`10`
`usage.doc_count`	Int	La cantidad de documentos calificados en esta solicitud.	`2`
`result.scores`	List	Los documentos reordenados, clasificados de mayor a menor puntuación de relevancia.	`[{"index":1,"score":0.99},{"index":2,"score":0.05}]`
`result.scores[].index`	Int	La posición basada en cero del documento dentro del arreglo de entrada `docs`.	`1`
`result.scores[].score`	Float	La puntuación de relevancia. Los valores más altos indican una mayor relevancia respecto a la consulta.	`0.99`

Ejemplos

Solicitud

curl -X POST \
  "http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/ranker/ops-bge-reranker-larger" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-key>" \
  -d '{
    "query": "opensearch documentation",
    "docs": [
      "what is opensearch",
      "what is LLM-based conversational search edition",
      "What is the advantage of LLM-based conversational search edition"
    ]
  }'

Respuesta

Éxito:

{
  "request_id": "24B004E0-ADEF-****-879B-F28359BFAD1D",
  "latency": 19,
  "usage": {
    "doc_count": 3
  },
  "result": {
    "scores": [
      { "index": 0, "score": 0.45026873385713345 },
      { "index": 1, "score": 1.1412238544346029E-4 },
      { "index": 2, "score": 8.029784284533197E-5 }
    ]
  }
}

Error:

Cuando una solicitud falla, la respuesta incluye los campos code y message que describen el error.

{
  "request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
  "latency": 0,
  "code": "InvalidParameter",
  "message": "JSON parse error: Unexpected character ..."
}

Pasos siguientes

Códigos de estado