| Campo | Obrigatório | Descrição |
|---|---|---|
| index | Sim | Nome do base de dados |
| item | Sim | Texto a ser pesquisado |
| size | Não | Itens por página (mín: 1, padrão: 5) |
| page | Não | Número da página (mín: 1, padrão: 1) |
| client_hostname | Não | Hostname do ambiente do cliente |
| client_username | Não | Usuário que está requisitando a API |
Responses
-
Requisição processada com sucesso. Retorna os dados correspondentes ao filtro informado.
-
Requisição inválida. Verifique a sintaxe do corpo e os campos obrigatórios.
-
Token de autenticação ausente ou inválido. Envie o header
Authorization: Bearer {token}. -
Erro interno no servidor. Tente novamente mais tarde ou contate o suporte Neppo.
POST
/transformersapi/1.0/index_search
curl \
--request POST 'https://api.neppo.com.br/transformersapi/1.0/index_search' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"index":"meu_indice","item":"texto para busca","size":5,"page":1,"client_hostname":"meu-ambiente.neppo.com.br","client_username":"usuario"}'
Request example
{
"index": "meu_indice",
"item": "texto para busca",
"size": 5,
"page": 1,
"client_hostname": "meu-ambiente.neppo.com.br",
"client_username": "usuario"
}
Response examples (200)
{
"answer": [
{
"text": "Resultado encontrado no índice",
"score": 87.43
}
],
"totalElements": 10,
"hasMorePages": true
}
Response examples (400)
{
"detail": "Requisição inválida ou índice não encontrado."
}
Response examples (401)
{
"status": "Unauthorized"
}
Response examples (500)
{
"detail": "Erro interno ou timeout."
}