ShareAI Platform Docs

Reordenar documentos

Forneça uma consulta e 1–1000 documentos.

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

Reordenar documentos

URL Base
https://api.shareai.now
Autenticação
Chave de API Bearer ou token de acesso OAuth aprovado
Escopo necessário
inference or monetization_gateway

Forneça uma consulta e 1–1000 documentos. Cada documento é texto, um {"text":"..."} objeto ou um objeto suportado pelo modelo. {"image":"https://..."} objeto. top_n deve ser pelo menos 1 e não maior que a contagem de documentos. Combine os resultados com os índices dos documentos originais.

Antes de começar#

Defina SHAREAI_API_KEY no seu servidor e substitua o espaço reservado do modelo por um modelo atualmente ativado. Nunca exponha a chave da API no código do navegador. O modelo, conta, credencial e fornecedor devem permitir esta operação. As configurações opcionais abaixo requerem suporte do modelo; os limites de segurança da API não garantem que todos os modelos suportem todos os valores.

Enviar uma solicitação#

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 da solicitação#

CampoTipoSignificado e limites
model obrigatóriostringIdentificador exato do modelo público ativado. Deve declarar esta operação e ser permitido pela sua credencial.
query obrigatóriostringConsulta de relevância não vazia.
documents obrigatórioarray1–1000 cadeias de texto não vazias ou objetos de texto/imagem com uma única chave. Os valores de imagem devem ser URLs HTTPS ou URLs de dados de imagem suportados, com suporte de entrada de imagem pelo modelo.
top_ninteiroContagem de resultados opcional de 1 até o número de documentos. Os índices retornados referem-se ao array de documentos original.
return_documentsbooleanInclusão opcional, suportada pelo provedor, dos documentos originais no resultado.
providerobjetoPreferências opcionais de roteamento do fornecedor. Utilize provider.only para etiquetas de fornecedor aceites, não como prefixo no ID do modelo. As restrições de conta e credencial ainda se aplicam.

Ler o resultado#

Sucesso retorna HTTP 200 com JSON. Forneça uma consulta e 1–1000 documentos. Cada documento é texto, um {"text":"..."} objeto ou um objeto suportado pelo modelo. {"image":"https://..."} objeto. top_n deve ser pelo menos 1 e não maior que a contagem de documentos. Combine os resultados com os índices dos documentos originais.

Unidades de faturação#

As taxas de reclassificação podem usar tokens de entrada, documentos avaliados, solicitações ou uma quantidade de pesquisa reportada pelo provedor. Não se assume uma conversão universal de pesquisa para token. Um provedor que não puder relatar uma dimensão tarifada estará indisponível para essa tarifa.

Escolha o identificador exato do modelo ativado no Console. A sua operação declarada e capacidades de entrada/saída devem corresponder a este endpoint; um modelo de chat de texto não pode ser substituído por outra operação. As restrições da sua credencial, fornecedor e conta ainda se aplicam.

Preços e utilização#

As tarifas são publicadas em créditos de IA em EUR para o modelo, fornecedor, unidades e variantes selecionados. Apenas as dimensões na sua tarifa ativa são cobradas. Uma estimativa reserva créditos antes da execução; os encargos finais utilizam a utilização medida. Os preços podem depender da resolução, formato de saída ou de uma faixa de utilização. Verifique a Utilização no Console para o débito final do ShareAI. Os campos de custo a montante e bytes de media não são convertidos em contagens de tokens inventadas.

Acesso e erros#

Uso inference para inferência aprovada de custo de rede ou monetization_gateway para uma margem aprovada do Builder e termos de faturação aceites. O acesso apenas por identidade não autoriza despesas. Validação, autorização de modelo, créditos insuficientes, limites de taxa e falhas de execução retornam uma estrutura error. Após um tempo limite ou submissão incerta, inspecione a Utilização ou o trabalho de vídeo antes de criar outro pedido potencialmente pago.

Última atualização 3 de Novembro de 2026

Documentação da Plataforma ShareAI
Toda a documentação

Pesquisar por título ou conteúdo.

Perguntar sobre esta página

Escolha um assistente para explorar esta página. Também pode copiar a página e colá-la na sua conversa.

Ask ChatGPTAsk ClaudeAsk GrokAsk ShareAI