Conecta-seEntrar na plataforma

Base de conhecimento

Pesquisar semanticamente nas bases de conhecimento disponíveis.

Lógica e processamentoRecurso internoConexão: Base de conhecimento do workspace

O que faz

Integre a base de conhecimento ao fluxo. Crie, leia, atualize e exclua documentos, trechos e tags.

Quando usar: Use quando o seu fluxo precisar pesquisar semanticamente nas bases de conhecimento disponíveis.

Exemplo de situação: Processar os dados antes de seguir para a próxima etapa.

Antes de começar

Conexão necessária: Base de conhecimento do workspace.

Confirme que a base de conhecimento já terminou de processar os documentos.

Passo a passo

  1. Adicione Base de conhecimento ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
  2. Confirme que a base de conhecimento já terminou de processar os documentos.
  3. Escolha a operação. O painel mostra só os campos que essa operação usa.
  4. Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
  5. Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
  6. Só publique depois de conferir o resultado da execução de teste.

Operações

OperaçãoO que faz
BuscarBusca com o bloco Base de conhecimento.
Listar documentosLista documentos com o bloco Base de conhecimento.
Obter documentoObtém documento com o bloco Base de conhecimento.
Criar documentoCria documento com o bloco Base de conhecimento.
Criar ou atualizar documentoCria ou atualizar documento com o bloco Base de conhecimento.
Excluir documentoExclui documento com o bloco Base de conhecimento.
Listar trechosLista trechos com o bloco Base de conhecimento.
Adicionar trechoAdiciona trecho com o bloco Base de conhecimento.
Atualizar trechoAtualiza trecho com o bloco Base de conhecimento.
Excluir trechoExclui trecho com o bloco Base de conhecimento.
Listar tagsLista tags com o bloco Base de conhecimento.
Listar conectoresLista conectores com o bloco Base de conhecimento.
Obter conectorObtém conector com o bloco Base de conhecimento.
Iniciar sincronizaçãoInicia sincronização com o bloco Base de conhecimento.

Campos

Mostrar campos de

  • Operação

    Escolhe qual ação este bloco executará.

    Opções:
    Buscar · Listar documentos · Obter documento · Criar documento · Criar ou atualizar documento · Excluir documento · Listar trechos · Adicionar trecho · Atualizar trecho · Excluir trecho · Listar tags · Listar conectores · Obter conector · Iniciar sincronização
    Padrão:
    Buscar

  • Base de conhecimento

    Obrigatório

    Selecione a base de conhecimento.

    Exemplo:
    (escolha na lista do campo)

  • Identificador da base

    ObrigatórioEm campos adicionais

    Informe o ID da base.

    Exemplo:
    id-do-recurso

  • Consulta

    Informa a consulta usada para localizar ou transformar dados.

    Aparece em:
    Buscar
    Exemplo:
    SELECT * FROM clientes WHERE status = 'ativo'

  • Quantidade de resultados

    Quantidade de resultados (padrão: 10).

    Aparece em:
    Buscar
    Exemplo:
    Quantidade de resultados (padrão: 10)

  • Filtros por tag

    Adicionar filtros por tag.

    Aparece em:
    Buscar
    Exemplo:
    status = 'ativo'

  • Modo de busca

    Em campos adicionais

    Define a consulta ou o filtro aplicado aos dados.

    Aparece em:
    Buscar
    Opções:
    Automático · Híbrida (texto completo + vetorial) · Somente vetorial
    Padrão:
    Automático

  • Reordenar resultados

    Ativa ou desativa este comportamento.

    Aparece em:
    Buscar
    Exemplo:
    false

  • Modelo de reordenação

    Escolhe uma das opções aceitas por este campo.

    Aparece em:
    Buscar
    Opções:
    rerank-v4.0-pro · rerank-v4.0-fast · rerank-v3.5
    Padrão:
    rerank-v4.0-fast
    Exemplo:
    rerank-v4.0-pro

  • Documentos enviados ao reordenador

    Em campos adicionais

    Automático (4× os resultados, até 100).

    Aparece em:
    Buscar
    Exemplo:
    10

  • Chave de API da Cohere

    Obrigatório conforme a operaçãoDado protegido

    Informe sua chave de API da Cohere.

    Aparece em:
    Buscar
    Padrão:
    Segredo protegido

  • Busca

    Filtrar documentos pelo nome do arquivo.

    Aparece em:
    Listar documentos
    Exemplo:
    Filtrar documentos pelo nome do arquivo

  • Filtro de status

    Define a consulta ou o filtro aplicado aos dados.

    Aparece em:
    Listar documentos
    Opções:
    Todos · Ativos · Inativos
    Exemplo:
    Todos

  • Limite de resultados

    Define um valor numérico, quantidade ou limite da operação.

    Aparece em:
    Listar documentos, Listar trechos
    Exemplo:
    10

  • Posição inicial

    Itens a pular (padrão: 0).

    Aparece em:
    Listar documentos, Listar trechos
    Exemplo:
    Itens a pular (padrão: 0)

  • Documento

    Obrigatório conforme a operação

    Selecione o documento.

    Aparece em:
    Obter documento, Adicionar trecho, Excluir documento, Listar trechos, Atualizar trecho, Excluir trecho
    Exemplo:
    (escolha na lista do campo)

  • ID do documento

    Obrigatório conforme a operaçãoEm campos adicionais

    Informe o ID do documento.

    Aparece em:
    Obter documento, Adicionar trecho, Excluir documento, Listar trechos, Atualizar trecho, Excluir trecho
    Exemplo:
    id-do-recurso

  • Conteúdo

    Obrigatório conforme a operação

    Informe o conteúdo do trecho.

    Aparece em:
    Adicionar trecho
    Exemplo:
    Olá! Sua solicitação foi processada com sucesso.

  • Nome

    Obrigatório conforme a operação

    Informe o nome do documento.

    Aparece em:
    Criar documento, Criar ou atualizar documento
    Exemplo:
    Exemplo de atendimento

  • ID do documento (opcional)

    ID de um documento existente para atualizar (ou vazio para casar pelo nome).

    Aparece em:
    Criar ou atualizar documento
    Exemplo:
    id-do-recurso

  • Tags do documento

    Informa ou seleciona o arquivo usado nesta operação.

    Aparece em:
    Criar documento, Criar ou atualizar documento

  • ID do trecho

    Obrigatório conforme a operação

    Informe o ID do trecho.

    Aparece em:
    Atualizar trecho, Excluir trecho
    Exemplo:
    id-do-recurso

  • Ativo

    Define se este comportamento fica ativado ou desativado.

    Aparece em:
    Atualizar trecho
    Opções:
    Sim · Não
    Exemplo:
    Sim

  • ID do conector

    Obrigatório conforme a operação

    Informe o ID do conector.

    Aparece em:
    Obter conector, Iniciar sincronização
    Exemplo:
    id-do-recurso

  • Busca

    Filtrar trechos pelo conteúdo.

    Aparece em:
    Listar trechos
    Exemplo:
    Filtrar trechos pelo conteúdo

  • Filtro de status

    Define a consulta ou o filtro aplicado aos dados.

    Aparece em:
    Listar trechos
    Opções:
    Todos · Ativos · Inativos
    Exemplo:
    Todos

Saídas

Para usar um resultado deste bloco em uma etapa seguinte, digite < no campo e escolha o bloco e o campo. A referência tem o formato <basedeconhecimento.results>: antes do ponto vai o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.

ReferênciaTipoO que contém
<basedeconhecimento.results>jsonResultados da busca.
<basedeconhecimento.query>stringConsulta usada.
<basedeconhecimento.totalResults>numberTotal de resultados.
<basedeconhecimento.cost>jsonDetalhamento do custo da busca: input, output e total em USD do embedding da consulta, além de rerankerCost, rerankerModel e rerankerSearchUnits quando houve reordenação. Não aparece quando a busca não foi cobrada (ex.: busca só por tags ou com chave própria, BYOK).
<basedeconhecimento.tokens>jsonUso de tokens do embedding da consulta: prompt, completion e total. Aparece junto com o custo.
<basedeconhecimento.model>stringModelo de embedding que pontuou a consulta. Aparece junto com o custo.

Exemplo de uso

Objetivo: Processar os dados antes de seguir para a próxima etapa.

InícioBase de conhecimentopróxima etapa
Operação
Buscar
Base de conhecimento
(escolha na lista do campo)
Consulta
SELECT * FROM clientes WHERE status = 'ativo'
Quantidade de resultados
Quantidade de resultados (padrão: 10)
Filtros por tag
status = 'ativo'
Reordenar resultados
false

Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.

Erros comuns e como resolver

O bloco não executa
Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
Aparece “Validação do fluxo” no terminal
Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
Um campo chega vazio na etapa seguinte
Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <basedeconhecimento.results>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
O campo que eu procuro não aparece
Os campos mudam conforme a operação escolhida. Escolha a operação primeiro; campos menos usados ficam em “Mostrar campos adicionais”.

Blocos relacionados