ShareAI Platform Docs

Reordenar documentos

Proporcione una consulta y de 1 a 1000 documentos.

Ver como Markdown
En esta página
POST https://api.shareai.now/api/v1/rerank

Reordenar documentos

URL base
https://api.shareai.now
Autenticación
Clave API Bearer o token de acceso OAuth aprobado
Alcance requerido
inference or monetization_gateway

Proporcione una consulta y de 1 a 1000 documentos. Cada documento es texto, un {"text":"..."} objeto o un {"image":"https://..."} objeto compatible con el modelo. top_n debe ser al menos 1 y no mayor que el número de documentos. Haga coincidir los resultados con los índices de los documentos originales.

Antes de comenzar#

Configure SHAREAI_API_KEY en su servidor y reemplace el marcador de posición del modelo con un modelo actualmente habilitado. Nunca exponga la clave API en el código del navegador. El modelo, la cuenta, las credenciales y el proveedor deben permitir esta operación. Las configuraciones opcionales a continuación requieren soporte del modelo; los límites de seguridad de la API no garantizan que todos los modelos admitan todos los valores.

Envía una solicitud#

cURL

curl --fail-with-body --request POST "https://api.shareai.now/api/v1/rerank" \
  -H "Authorization: Bearer $SHAREAI_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "model": "YOUR_ENABLED_RERANK_MODEL",
  "query": "A cat",
  "documents": [
    {
      "text": "A cat on a windowsill."
    },
    {
      "text": "A map of Berlin."
    }
  ],
  "top_n": 1
}'

Campos de solicitud#

CampoTipoSignificado y límites
model requeridocadenaIdentificador exacto de modelo público habilitado. Debe declarar esta operación y estar permitido por sus credenciales.
query requeridocadenaConsulta de relevancia no vacía.
documents requeridomatrizDe 1 a 1000 cadenas de texto no vacías u objetos de texto/imagen de una sola clave. Los valores de imagen deben ser URLs HTTPS o URLs de datos de imagen compatibles, con soporte de entrada de imagen del modelo.
top_nenteroCantidad opcional de resultados de 1 al número de documentos. Los índices devueltos se refieren al arreglo de documentos original.
return_documentsbooleanoInclusión opcional de documentos originales en el resultado, si es compatible con el proveedor.
providerobjetoPreferencias opcionales de enrutamiento del proveedor. Use provider.only para etiquetas de proveedor aceptadas, no como prefijo en el ID del modelo. Las restricciones de cuenta y credenciales aún se aplican.

Leer el resultado#

El éxito devuelve HTTP 200 con JSON. Proporcione una consulta y de 1 a 1000 documentos. Cada documento es texto, un {"text":"..."} objeto o un {"image":"https://..."} objeto compatible con el modelo. top_n debe ser al menos 1 y no mayor que el número de documentos. Haga coincidir los resultados con los índices de los documentos originales.

Unidades de facturación#

Las tasas de reordenamiento pueden usar tokens de entrada, documentos puntuados, solicitudes o una cantidad de búsqueda reportada por el proveedor. No se asume una conversión universal de búsqueda a token. Un proveedor que no pueda reportar una dimensión tarifada no estará disponible para esa tarifa.

Elija el identificador exacto del modelo habilitado desde la Consola. Su operación declarada y capacidades de entrada/salida deben coincidir con este endpoint; un modelo de chat de texto no puede sustituirse por otra operación. Sus restricciones de credenciales, proveedor y cuenta aún se aplican.

Precios y uso#

Las tarifas se publican en créditos de IA en EUR para el modelo, proveedor, unidades y variantes seleccionados. Solo se cobran las dimensiones en su tarifa activa. Una estimación reserva créditos antes de la ejecución; los cargos finales usan el uso medido. Los precios pueden depender de la resolución, el formato de salida o una banda de uso. Consulte Uso en la Consola para el débito final de ShareAI. Los campos de costos ascendentes y bytes de medios no se convierten en recuentos de tokens inventados.

Acceso y errores#

Usar inference para inferencia aprobada con costo de red o monetization_gateway para un margen aprobado del Builder y términos de facturación aceptados. El acceso solo con identidad no autoriza gastos. La validación, autorización del modelo, créditos insuficientes, límites de tarifa y fallos de ejecución devuelven una error. estructura. Después de un tiempo de espera o envío incierto, inspeccione Uso o el trabajo de video antes de crear otra solicitud potencialmente pagada.

Última actualización noviembre 3, 2026.

Documentación de la plataforma ShareAI
Toda la documentación

Buscar por título o contenido.

Preguntar sobre esta página

Elige un asistente para explorar esta página. También puedes copiar la página y pegarla en tu conversación.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI