Skip to main content
POST
/
api
/
rag
/
retrieve
RAG Retrieve
curl --request POST \
  --url https://api-talk.saninternet.com/v1/api/rag/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queryText": "Qual a politica de devolucao?",
  "filters": {
    "sourceTypes": [
      "document",
      "qa"
    ],
    "audience": "ai_agent"
  },
  "scoreThreshold": 0.7,
  "returnMode": "ai_generated_answer",
  "limit": 10,
  "useRerank": true,
  "companyName": "Acme Corporation",
  "companyProductsNames": [
    "Produto Premium",
    "Produto Basic"
  ],
  "clientName": "Joao Silva",
  "clientServices": "Plano Premium, Suporte 24/7",
  "clientCurrentChatHistory": "<string>",
  "clientOlderChatHistory": "<string>",
  "clientPaymentHistory": "<string>",
  "clientLogs": "<string>"
}
'
{
  "aiGeneratedAnswer": "Com base nos documentos, a politica de devolucao permite devolucoes em ate 30 dias...",
  "results": [
    {
      "id": "result-uuid-123",
      "score": 0.85,
      "payload": {
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "audience": [
          "ai_agent",
          "copilot"
        ],
        "contentCategory": "policy",
        "content": "Nossa politica de devolucao permite devolucoes em ate 30 dias...",
        "sourceType": "document",
        "sourceId": "doc-123",
        "title": "Politica de Devolucao",
        "path": [
          "politicas",
          "devolucoes"
        ],
        "metadata": {}
      }
    }
  ],
  "total": 5,
  "retrievalTimeMs": 150
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
queryText
string
required

O texto da consulta para busca semantica.

Example:

"Qual a politica de devolucao?"

​
filters
object
required

Filtros para refinar a busca.

​
scoreThreshold
number
required

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

Required range: 0 <= x <= 1
Example:

0.7

​
returnMode
enum<string>
required

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

Available options:
ai_generated_answer,
chunks_only
Example:

"ai_generated_answer"

​
limit
integer

Numero maximo de resultados. Padrao: 10.

Required range: 1 <= x <= 100
Example:

10

​
useRerank
boolean

Ativar reranking dos resultados para melhorar a relevancia.

Example:

true

​
companyName
string

Nome da empresa para contexto na geracao de resposta.

Example:

"Acme Corporation"

​
companyProductsNames
string[]

Nomes dos produtos da empresa para contexto.

Example:
["Produto Premium", "Produto Basic"]
​
clientName
string

Nome do cliente para personalizacao da resposta.

Example:

"Joao Silva"

​
clientServices
string

Servicos ativos do cliente para contexto.

Example:

"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.

Response

Resultados recuperados com sucesso

​
aiGeneratedAnswer
string

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

Example:

"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.

Example:

5

​
retrievalTimeMs
integer

Tempo de busca em milissegundos.

Example:

150