Skip to main content
POST
RAG Retrieve

Autorizações

Authorization
string
header
obrigatório

API key no formato pyp_live_*. Enviada como Bearer token no header Authorization.

Corpo

application/json
queryText
string
obrigatório

O texto da consulta para busca semantica.

Exemplo:

"Qual a politica de devolucao?"

filters
object
obrigatório

Filtros para refinar a busca.

scoreThreshold
number
obrigatório

Score minimo de similaridade para incluir um resultado. Valores mais altos retornam resultados mais relevantes.

Intervalo obrigatório: 0 <= x <= 1
Exemplo:

0.7

returnMode
enum<string>
obrigatório

ai_generated_answer retorna uma resposta gerada por IA alem dos chunks. chunks_only retorna apenas os chunks brutos.

Opções disponíveis:
ai_generated_answer,
chunks_only
Exemplo:

"ai_generated_answer"

limit
integer

Numero maximo de resultados. Padrao: 10.

Intervalo obrigatório: 1 <= x <= 100
Exemplo:

10

useRerank
boolean

Ativar reranking dos resultados para melhorar a relevancia.

Exemplo:

true

companyName
string

Nome da empresa para contexto na geracao de resposta.

Exemplo:

"Acme Corporation"

companyProductsNames
string[]

Nomes dos produtos da empresa para contexto.

Exemplo:
clientName
string

Nome do cliente para personalizacao da resposta.

Exemplo:

"Joao Silva"

clientServices
string

Servicos ativos do cliente para contexto.

Exemplo:

"Plano Premium, Suporte 24/7"

clientCurrentChatHistory
string

Historico de chat atual do cliente para contexto.

clientOlderChatHistory
string

Historico de chat anterior do cliente.

clientPaymentHistory
string

Historico de pagamentos do cliente.

clientLogs
string

Logs do cliente para contexto adicional.

Resposta

Resultados recuperados com sucesso

aiGeneratedAnswer
string

Resposta gerada por IA. Presente apenas quando returnMode e ai_generated_answer.

Exemplo:

"Com base nos documentos, a politica de devolucao permite devolucoes em ate 30 dias..."

results
object[]

Chunks recuperados do banco vetorial.

total
integer

Numero total de resultados encontrados.

Exemplo:

5

retrievalTimeMs
integer

Tempo de busca em milissegundos.

Exemplo:

150