Reclasificar documentos

publicación /rerank

Vuelve a clasificar una lista de documentos en función de su relevancia para una query.

Este endpoint acepta una query y una lista de documentos, luego devuelve los documentos ordenados por puntuación de relevancia en orden descendente.

application/json

Cuerpo Requerido

Consulta string Requerido
La consulta de búsqueda como string.

Longitud máxima de la query:
- 8,000 tokens para rerank-2.5 y rerank-2.5-lite
- 4,000 tokens for rerank-2
- 2,000 tokens for rerank-2-lite
La longitud mínima es 1.
Documentos array[string] Requerido
Una lista de documentos a reordenar, proporcionada como cadenas.

Restricciones:
- Número máximo de documentos: 1,000
- Máximo de tokens por par de query + documento:
  - 32,000 para rerank-2.5 y rerank-2.5-lite
  - 16,000 para rerank-2
  - 8,000 para rerank-2-lite
- Tokens totales máximos (tokens de query × número de documentos + suma de todos los tokens de los documentos):
  - 600K por rerank-2.5, rerank-2.5-lite, rerank-2 y rerank-2-lite
Al menos 1 pero no más que 1000 elementos. La longitud mínima de cada uno es 1.
Modelo string Requerido

El modelo de reclasificación a usar. Modelos recomendados: rerank-2.5, rerank-2.5-lite.

Los valores son rerank-2.5, rerank-2.5-lite, rerank-2 o rerank-2-lite.
top_k entero | nulo

El número de documentos más relevantes a devolver. Si no se especifica, se devuelven todos los documentos con sus puntuaciones de reordenamiento.

El valor mínimo es 1.
return_documents booleano
Si se debe incluir el texto del documento en la respuesta.
- false (por defecto): Devuelve únicamente {"index", "relevance_score"} para cada documento
- true: Devuelve {"index", "document", "relevance_score"} por cada documento
El valor por defecto es false.
Truncamiento booleano
Si truncar las entradas que superen el límite de longitud del contexto.
- true (por defecto): La query y los documentos se truncan automáticamente para ajustarse al límite de longitud de contexto.
- false: Se devuelve un error si la query o cualquier par query-documento supera el límite de longitud de contexto.
El valor por defecto es true.

Respuestas

200 application/json

éxito
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Objeto string Requerido
  
  El tipo de objeto Realm. Siempre devuelve "list".
  
  El valor es list.
- Datos arreglo[objeto] Requerido
  
  Un arreglo de resultados de reordenamiento, ordenados por puntuación de relevancia en orden descendente.
  
  Hide data attributes Show data attributes Objeto
  
  index entero Requerido
  
  El índice del documento en la lista de entrada original.
  
  relevance_score Número Requerido
  
  La puntuación de relevancia del documento con respecto a la query.
  
  Documento string
  
  El texto del documento. Solo se incluye cuando return_documents está configurado en true.
- Modelo string Requerido
  
  El nombre del modelo utilizado para la reindexación.
- Uso Objeto Requerido
  
  Ocultar atributo de uso Mostrar atributo de uso Objeto
  
  total_tokens entero Requerido
  
  El número total de tokens procesados para la operación de reordenamiento.
400 application/json

Invalid Request
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  La solicitud no es válida. Este error puede ocurrir debido a JSON no válido, tipos de parámetros no válidos, tipos de datos incorrectos, tamaño de lote demasiado grande, que el total de tokens supere el límite o que los tokens en un ejemplo superen la longitud del contexto.
401 application/json

No autorizado
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  Autenticación no válida. Asegúrese de que la clave de API de su modelo esté correctamente especificada en el encabezado de Autorización como Bearer VOYAGE_API_KEY.
403 application/json

Forbidden
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  Acceso prohibido. Esto puede ocurrir si la dirección IP desde la que se envía la solicitud no está permitida.
429 application/json

Se superó el límite de velocidad de acceso
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  Se ha superado el límite de tasa. La frecuencia de solicitudes o el uso del token es demasiado alto. Reduce la tasa de tus solicitudes o espera antes de reintentar.
500 application/json

Error interno del servidor
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  Ocurrió un error inesperado en el servidor. Vuelve a intentar tu solicitud después de una breve espera.
502 application/json

Puerta de enlace incorrecta
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  El servidor recibió una respuesta no válida de un servidor ascendente. Vuelve a intentar tu solicitud después de una breve espera.
503 application/json

Servicio no disponible
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  El servicio no está disponible temporalmente debido a un alto tráfico o tareas de mantenimiento. Vuelve a intentar tu solicitud después de una breve espera.
504 application/json

Tiempo de espera del Gateway
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  El servidor no recibió una respuesta oportuna de un servidor aguas arriba. Vuelve a intentar tu solicitud después de una breve espera.

POST /reclasificar

curl \
 --request POST 'https://ai.mongodb.com/v1/rerank' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"query":"string","documents":["string"],"model":"rerank-2.5","top_k":42,"return_documents":false,"truncation":true}'

Solicitar ejemplos

{
  "query": "string",
  "documents": [
    "string"
  ],
  "model": "rerank-2.5",
  "top_k": 42,
  "return_documents": false,
  "truncation": true
}

Ejemplos de respuesta (200)

{
  "object": "list",
  "data": [
    {
      "index": 42,
      "relevance_score": 42.0,
      "document": "string"
    }
  ],
  "model": "string",
  "usage": {
    "total_tokens": 42
  }
}

Ejemplos de respuesta (400)

{
  "detail": "string"
}

Ejemplos de respuesta (401)

{
  "detail": "string"
}

Ejemplos de respuesta (403)

{
  "detail": "string"
}

Ejemplos de respuesta (429)

{
  "detail": "string"
}

Ejemplos de respuesta (500)

{
  "detail": "string"
}

Ejemplos de respuesta (502)

{
  "detail": "string"
}

Ejemplos de respuesta (503)

{
  "detail": "string"
}

Ejemplos de respuesta (504)

{
  "detail": "string"
}