Sign in

v4

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-112612.4 KB
RAG

RAG Retrieve

Busca chunks relevantes no banco de dados vetorial usando RAG (Retrieval-Augmented Generation). Pode retornar uma resposta gerada por IA ou apenas os chunks brutos, dependendo do returnMode.

post/api/rag/retrieve

Request body

queryTextstring required

O texto da consulta para busca semantica.

scoreThresholdnumber required

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

returnMode'ai_generated_answer' | 'chunks_only' required

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

limitinteger

Numero maximo de resultados. Padrao: 10.

useRerankboolean

Ativar reranking dos resultados para melhorar a relevancia.

companyNamestring

Nome da empresa para contexto na geracao de resposta.

companyProductsNamesstring[]

Nomes dos produtos da empresa para contexto.

clientNamestring

Nome do cliente para personalizacao da resposta.

clientServicesstring

Servicos ativos do cliente para contexto.

clientCurrentChatHistorystring

Historico de chat atual do cliente para contexto.

clientOlderChatHistorystring

Historico de chat anterior do cliente.

clientPaymentHistorystring

Historico de pagamentos do cliente.

clientLogsstring

Logs do cliente para contexto adicional.

Example request

{
  "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"
}

Response

Resultados recuperados com sucesso

aiGeneratedAnswerstring

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

totalinteger

Numero total de resultados encontrados.

retrievalTimeMsinteger

Tempo de busca em milissegundos.

Example response

{
  "aiGeneratedAnswer": "Com base nos documentos, a politica de devolucao permite devolucoes em ate 30 dias...",
  "results": [
    {
      "id": "result-uuid-123",
      "score": 0.85,
      "payload": {
        "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"
        ]
      }
    }
  ],
  "total": 5,
  "retrievalTimeMs": 150
}