Rerank

​

Pré-requisitos

​

Reordenar documentos

​

Reranking de texto (qwen3-rerank)

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),
  base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-api/v1",
)

results = client.post(
  "/reranks",
  body={
    "model": "qwen3-rerank",
    "query": "What is a reranking model?",
    "documents": [
      "Reranking models are widely used in search engines and recommendation systems to sort candidate texts by relevance.",
      "Quantum computing is a cutting-edge field in computer science.",
      "The development of pretrained language models has led to new advancements in reranking models."
    ],
    "top_n": 2
  },
  cast_to=object
)

print(results)

import dashscope
from http import HTTPStatus

dashscope.base_http_api_url = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1'

resp = dashscope.TextReRank.call(
  model="qwen3-rerank",
  query="What is a reranking model?",
  documents=[
    "Reranking models are widely used in search engines and recommendation systems to sort candidate texts by relevance.",
    "Quantum computing is a cutting-edge field in computer science.",
    "The development of pretrained language models has led to new advancements in reranking models."
  ],
  top_n=2,
  return_documents=True
)

if resp.status_code == HTTPStatus.OK:
  print(resp)

​

Reranking multimodal (qwen3-vl-rerank)

import dashscope
from http import HTTPStatus
import json

# China (Beijing) region. Replace {WorkspaceId} with your actual workspace ID. The configuration varies by region.
dashscope.base_http_api_url = 'https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1'

resp = dashscope.TextReRank.call(
  model="qwen3-vl-rerank",
  query={"text": "What is a text reranking model"},
  documents=[
    {"text": "Text reranking models are widely used in search engines and recommender systems."},
    {"image": "https://img.alicdn.com/imgextra/i3/O1CN01rdstgY1uiZWt8gqSL_!!6000000006071-0-tps-1970-356.jpg"},
    {"video": "https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250107/lbcemt/new+video.mp4"}
  ],
  top_n=2,
  return_documents=True
)

if resp.status_code == HTTPStatus.OK:
  print(json.dumps(resp, default=str, ensure_ascii=False, indent=4))

​

Recursos principais

​

Reranking com instruções (instruct)

• Recuperação para perguntas e respostas (padrão): "Given a web search query, retrieve relevant passages that answer the query." Foca em encontrar respostas diretas. Para a consulta "How to prevent a cold?", o trecho "Washing hands frequently can prevent colds" recebe uma pontuação maior do que "A cold is a common illness", pois este último é topicalmente relevante, mas não responde à pergunta.
• Similaridade semântica: "Retrieve semantically similar text." Prioriza a equivalência de significado e é robusto a diferenças de redação. A pergunta "How do I change my password?" corresponde a "What if I forgot my password?", o que é útil para deduplicação de FAQs.

curl --request POST \
  --url https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-api/v1/reranks \
  --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "model": "qwen3-rerank",
    "query": "How do I change my password?",
    "documents": [
      "Go to Settings > Security > Change Password to update your credentials.",
      "What if I forgot my password?",
      "Our platform supports two-factor authentication."
    ],
    "instruct": "Retrieve semantically similar text."
}'

​

Retornar os N principais resultados (top_n)

​

Visão geral dos modelos

• Máximo de tokens por documento: Limite de tokens para uma única consulta ou documento. Se a entrada de uma única consulta ou documento exceder esse limite, a API retornará um erro HTTP 400 e não truncará a entrada.
• Máximo de documentos: Quantidade máxima de documentos por solicitação. No modelo qwen3-vl-rerank, esse limite varia conforme o tipo de documento (texto, imagem, vídeo ou misto).
• Máximo de tokens por solicitação: Calculado como Tokens da Consulta × Número de Documentos + Total de Tokens dos Documentos.

​

Referência da API

​

Códigos de erro

​

Limites de taxa