Reclassificar documentos

POSTAR /rerank

Reclassifica uma lista de documentos com base em sua relevância para uma query.

Esse endpoint aceita uma query e uma lista de documentos e, em seguida, retorna os documentos classificados por pontuação de relevância em ordem decrescente.

aplicação/json

corpo, corpo Obrigatório

Query string Obrigatório
A query de pesquisa como uma string.

Comprimento máximo da query:
- 8,000 tokens para rerank-2.5 e rerank-2.5-lite
- 4,000 tokens for rerank-2
- 2,000 tokens for rerank-2-lite
O comprimento mínimo é 1.
documentos array[string] Obrigatório
Uma lista de documentos a serem reclassificados, fornecidos como strings.

Restrições:
- Número máximo de documentos: 1,000
- Máximo de tokens por query + par de documento :
  - 32,000 para rerank-2.5 e rerank-2.5-lite
  - 16,000 para rerank-2
  - 8,000 para rerank-2-lite
- Total máximo de tokens (tokens de query × número de documentos + soma de todos os tokens de documento ):
  - 600K para rerank-2.5, rerank-2.5-lite, rerank-2 e rerank-2-lite
Pelo menos 1, mas não mais de 1000 elementos. O comprimento mínimo de cada um é 1.
Modelo string Obrigatório

O modelo de reclassificação a ser usado. Modelos recomendados: rerank-2.5, rerank-2.5-lite.

Os valores são rerank-2.5, rerank-2.5-lite, rerank-2 ou rerank-2-lite.
top_k inteiro | zero

O número de documentos mais relevantes a serem devolvidos. Se não forem especificados, todos os documentos serão retornados com suas pontuações de reclassificação.

O valor mínimo é 1.
return_documents booleano
Se incluir o texto do documento na resposta.
- false (padrão): retorna apenas {"index", "relevance_score"} para cada documento
- true: retorna {"index", "document", "relevance_score"} para cada documento
O valor padrão é false.
truncamento booleano
Se deve truncar entradas que excedem o limite de comprimento do contexto.
- true (padrão): a query e os documentos são automaticamente truncados para caber dentro do limite de comprimento do contexto.
- false: Um erro será retornado se a query ou qualquer par query-documento exceder o limite de comprimento do contexto.
O valor padrão é true.

Respostas

200 aplicação/json

Sucesso
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- objeto string Obrigatório
  
  O tipo de objeto . Sempre retorna "lista".
  
  O valor é list.
- de dados array[objeto] Obrigatório
  
  Uma array de resultados de reclassificação, classificados por pontuação de relevância em ordem decrescente.
  
  Ocultar atributos de dados Mostrar atributos de dados objeto
  
  index inteiro Obrigatório
  
  O índice do documento na lista de entrada original.
  
  relevância_score número Obrigatório
  
  A pontuação de relevância do documento em relação à query.
  
  documento string
  
  O texto do documento . Somente incluído quando return_documents está configurado para true.
- Modelo string Obrigatório
  
  O nome do modelo usado para a reclassificação.
- Uso objeto Obrigatório
  
  Ocultar atributo de uso Mostrar atributo de uso objeto
  
  total_tokens inteiro Obrigatório
  
  O número total de tokens processados para a operação de reclassificação.
400 aplicação/json

Invalid Request
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  A solicitação é inválida. Esse erro pode ocorrer devido a JSON inválido, tipos de parâmetros inválidos, tipos de dados incorretos, tamanho do lote muito grande, total de tokens que excede o limite ou tokens em um exemplo que excede o comprimento do contexto.
401 aplicação/json

Não autorizado
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  Autenticação inválida. Certifique-se de que a chave de API do modelo esteja especificada corretamente no cabeçalho de autorização como Bearer YOUR_API_KEY.
403 aplicação/json

Proibido
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  Acesso proibido. Isso pode ocorrer se o endereço IP do qual você está enviando a solicitação não for permitido.
429 aplicação/json

Limite de taxa excedido
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  Limite de taxa excedido. Sua frequência de solicitação ou uso de token é muito alto. Reduza sua taxa de solicitações ou aguarde antes de tentar novamente.
500 aplicação/json

Internal Server Error
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  Ocorreu um erro inesperado no servidor. Tente sua solicitação novamente após uma breve espera.
502 aplicação/json

Gateway incorreto
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  O servidor recebeu uma resposta inválida de um servidor upstream. Tente sua solicitação novamente após uma breve espera.
503 aplicação/json

Serviço não disponível
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  O serviço está temporariamente indisponível devido a alto tráfego ou manutenção. Tente sua solicitação novamente após uma breve espera.
504 aplicação/json

Tempo limite do gateway
Ocultar atributo de resposta Mostrar atributo de resposta objeto
- detalhe string
  
  O servidor não recebeu uma resposta atempada de um servidor upstream. Tente sua solicitação novamente após uma breve espera.

POST /rerank

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}'

Exemplos de solicitação

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

Exemplos de resposta (200)

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

Exemplos de resposta (400)

{
  "detail": "string"
}

Exemplos de resposta (401)

{
  "detail": "string"
}

Exemplos de resposta (403)

{
  "detail": "string"
}

Exemplos de resposta (429)

{
  "detail": "string"
}

Exemplos de resposta (500)

{
  "detail": "string"
}

Exemplos de resposta (502)

{
  "detail": "string"
}

Exemplos de resposta (503)

{
  "detail": "string"
}

Exemplos de resposta (504)

{
  "detail": "string"
}