---
title: "RAG Retrieve"
method: POST
path: "/api/rag/retrieve"
tags: ["RAG"]
---

# RAG Retrieve

`POST /api/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`.

## Request body

- RagRetrieveRequest
  - `queryText` string, required — O texto da consulta para busca semantica.
  - `filters` object, required — Filtros para refinar a busca.
    - `sourceTypes` string[], required — Tipos de fonte para filtrar. Valores possiveis: `document`, `qa`, `website`.
    - `audience` 'ai_agent' | 'copilot' | 'strategist', required — Audiencia alvo para o conteudo recuperado.
  - `scoreThreshold` number, 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.
  - `limit` integer — Numero maximo de resultados. Padrao: 10.
  - `useRerank` boolean — Ativar reranking dos resultados para melhorar a relevancia.
  - `companyName` string — Nome da empresa para contexto na geracao de resposta.
  - `companyProductsNames` string[] — Nomes dos produtos da empresa para contexto.
  - `clientName` string — Nome do cliente para personalizacao da resposta.
  - `clientServices` string — Servicos ativos do cliente para contexto.
  - `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 `200`

Resultados recuperados com sucesso

- RagRetrieveResponse
  - `aiGeneratedAnswer` string — Resposta gerada por IA. Presente apenas quando `returnMode` e `ai_generated_answer`.
  - `results` RagResult[] — Chunks recuperados do banco vetorial.
    - `id` string — ID do resultado.
    - `score` number — Score de similaridade (0-1).
    - `payload` RagResultPayload
      - `companyId` string, uuid — ID da empresa.
      - `audience` string[] — Audiencias para as quais este conteudo e relevante.
      - `contentCategory` string — Categoria do conteudo.
      - `content` string — Conteudo textual do chunk.
      - `sourceType` string — Tipo de fonte do conteudo.
      - `sourceId` string — ID da fonte original.
      - `title` string — Titulo da fonte.
      - `path` string[] — Caminho hierarquico do conteudo.
      - `metadata` object — Metadados adicionais.
  - `total` integer — Numero total de resultados encontrados.
  - `retrievalTimeMs` integer — Tempo de busca em milissegundos.

## Other responses

- `401` — API key ausente ou invalida
- `403` — Assinatura inativa

## Changes

- **2026-02-25** `4759254a289d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/pypsystem/apis/tartini-api/changes/api/rag/retrieve/post.md)

---

[API](https://skmtc.dev/pypsystem/apis/tartini-api.md) · [All operations](https://skmtc.dev/pypsystem/apis/tartini-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pypsystem/tartini-api/revisions/7647dea97a58/schema)