Reclasificar documentos

PUBLICAR /rerank

Reordena una lista de documentos según su relevancia para una consulta.

Este punto final acepta una consulta y una lista de documentos, luego devuelve los documentos ordenados por puntaje de relevancia en orden descendente.

aplicación/json

Cuerpo Requerido

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

Longitud máxima de consulta:
- 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 que deben reclasificarse, proporcionada como cadenas.

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

Modelo de reordenamiento a utilizar. 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 que se devolverán. Si no se especifica, se devolverán todos los documentos con sus puntuaciones de reclasificación.

El valor mínimo es 1.
devolver_documentos booleano
Si se incluirá el texto del documento en la respuesta.
- false (predeterminado): devuelve solo {"index", "relevance_score"} para cada documento
- true: Devuelve {"index", "document", "relevance_score"} para cada documento
El valor predeterminado es false.
Truncamiento booleano
Si desea truncar las entradas que exceden el límite de longitud del contexto.
- true (predeterminado): la consulta y los documentos se truncan automáticamente para ajustarse al límite de longitud del contexto.
- false:Se devuelve un error si la consulta o cualquier par consulta-documento excede el límite de longitud del contexto.
El valor predeterminado es true.

Respuestas

200 aplicación/json

Éxito
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Objeto string Requerido
  
  El tipo de objeto. Siempre devuelve "lista".
  
  El valor es list.
- datos matriz[objeto] Requerido
  
  Una serie de resultados de reclasificación, ordenados por puntuación de relevancia en orden descendente.
  
  Ocultar atributos de datos Mostrar atributos de datos Objeto
  
  index entero Requerido
  
  El índice del documento en la lista de entrada original.
  
  puntuación de relevancia Número Requerido
  
  La puntuación de relevancia del documento con respecto a la consulta.
  
  Documento string
  
  El texto del documento. Solo se incluye cuando return_documents se establece en true.
- modelo string Requerido
  
  El nombre del modelo utilizado para la reclasificació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 reclasificación.
400 aplicación/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 un JSON no válido, tipos de parámetros no válidos, tipos de datos incorrectos, un tamaño de lote demasiado grande, un número total de tokens que excede el límite o tokens en un ejemplo que exceden la longitud del contexto.
401 aplicación/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 API de su modelo esté especificada correctamente en el encabezado de autorización como Bearer VOYAGE_API_KEY.
403 aplicación/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 envía la solicitud no está permitida.
429 aplicación/json

Límite de velocidad excedido
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 aplicación/json

Error interno del servidor
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  Se produjo un error inesperado en el servidor. Vuelva a intentar su solicitud después de una breve espera.
502 aplicación/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. Vuelva a intentar su solicitud después de una breve espera.
503 aplicación/json

Servicio no disponible
Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
- detalle string
  
  El servicio no está disponible temporalmente debido a alto tráfico o mantenimiento. Vuelva a intentar su solicitud después de una breve espera.
504 aplicación/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.

PUBLICAR/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 respuestas (200)

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

Ejemplos de respuestas (400)

{
  "detail": "string"
}

Ejemplos de respuestas (401)

{
  "detail": "string"
}

Ejemplos de respuestas (403)

{
  "detail": "string"
}

Ejemplos de respuestas (429)

{
  "detail": "string"
}

Ejemplos de respuestas (500)

{
  "detail": "string"
}

Ejemplos de respuestas (502)

{
  "detail": "string"
}

Ejemplos de respuestas (503)

{
  "detail": "string"
}

Ejemplos de respuestas (504)

{
  "detail": "string"
}