Pular para o conteúdo
Menu da documentação

Produtos

Knowledge

Base de documentos por workspace, com busca que devolve o trecho e a fonte. Formatos aceitos, limites e a busca pela API.

#Documentos

Os documentos são enviados pela área do cliente e ficam numa base do workspace, com versão por documento.

FormatoTamanho máximo
Texto e Markdown5 MB
PDF com texto20 MB
CSV2 MB, até 20.000 linhas e 60 colunas

#Envio pela API

Com o escopo "Enviar documentos ao Knowledge" (knowledge:write), uma chave lista as bases do workspace e envia documentos, nos mesmos formatos e tamanhos da tela. O identificador da base vem da listagem.

bash
curl -sS "https://aiuby.com/api/platform/knowledge/bases" -H "Authorization: Bearer $AIUBY_TOKEN"
curl -sS -X POST "https://aiuby.com/api/platform/knowledge/documents" \
  -H "Authorization: Bearer $AIUBY_TOKEN" \
  -F "baseId=$BASE_ID" -F "file=@politica-de-devolucao.md;type=text/markdown"
  • A resposta traz o identificador do documento e a versão. Para enviar uma versão nova, acrescente -F "documentId=...".
  • O documento enviado por chave fica visível ao workspace inteiro. Restringir a pessoas é só pela tela.
  • A chave de envio não cria base, não apaga documento e não lê o conteúdo.
  • A fila de indexação aceita até 20 documentos pendentes por workspace; acima disso o envio responde 429.

#Busca pela API

Com o escopo "Buscar no Knowledge", uma chave busca nos documentos do workspace. A consulta tem até 2.000 caracteres e o limite de resultados é 20.

bash
curl -sS -X POST "https://aiuby.com/api/platform/knowledge/search" \
  -H "Authorization: Bearer $AIUBY_TOKEN" -H "Content-Type: application/json" \
  -d '{"query":"prazo de devolução","limit":5}'

Cada resultado traz o trecho e de onde ele veio:

json
{
  "results": [
    {
      "chunkId": "...",
      "documentId": "...",
      "title": "Política de devolução",
      "baseName": "Atendimento",
      "version": 3,
      "ordinal": 2,
      "content": "O prazo de devolução é de ...",
      "score": 0.82
    }
  ]
}

#Permissões

Cada documento tem permissão própria. Um documento restrito a determinadas pessoas fica fora do resultado de uma busca feita por chave de API.

#O que não faz

  • Não lê PDF escaneado: não há OCR. Um PDF sem texto é recusado no envio.
  • Não cria base nem apaga documento por chave de API: isso é feito pela área do cliente.
  • O conteúdo de um documento é tratado como dado, nunca como instrução para o agente.