O componente Busca de Produto permite localizar produtos cadastrados no ERP Sankhya a partir de um termo de busca, retornando uma lista de produtos correspondentes.
A busca pode ocorrer de duas formas:
Busca direta no Sankhya (padrão)
Busca indexada (Elastic / IAN) para melhorar relevância e tolerância a erros de digitação.
Esse componente normalmente é o ponto inicial da jornada de venda digital, permitindo ao usuário pesquisar produtos pelo nome, referência ou descrição.
bot-server: versão 1.7.0
bot-component-service: versão 1.3.0
Índice:
- Objetivo do componente
- Interface do componente (leitura da tela)
- Busca de produto
- Termo de busca
- Habilitar busca indexada
- Aviso importante
- Armazenamento
- Estrutura do retorno (busca direta no sankhya)
- Exemplo
- Estrutura do retorno (busca indexada)
- Estrutura do retorno (erro)
- Descrição dos campos retornados
- Comportamento da busca
- Quando use_indexed_search = true
- Integração técnica
- Busca direta no sankhya
- Exemplo de requisição
- Busca indexada (IAN / Elastic)
- Exemplo de requisição
- Exemplos de uso no bot
- Mostrar lista de produtos encontrados
- Selecionar produto para consulta
- Tratamento de erros
- Boas práticas
Objetivo do componente
Permitir que o bot encontre produtos no Sankhya utilizando busca textual, retornando opções para que o usuário escolha o item desejado.
Interface do componente (leitura da tela)
Busca de produto
Configuração dos parâmetros de busca
Campo |
Descrição |
|---|---|
Termo de busca* |
Texto utilizado para localizar produtos |
Habilitar busca indexada |
Ativa busca inteligente via índice (Elastic / IAN) |
Termo de busca
Campo utilizado para localizar produtos por:
nome
descrição
referência
código
Exemplo:
ou utilizando variável do fluxo:
Habilitar busca indexada
Quando ativado:
utiliza um índice de busca (Elastic)
permite busca por aproximação
tolera erros de digitação
retorna resultados ordenados por relevância
Exemplo:
retorna:
BALAS SORTIDAS
BALA DE MORANGO
BALA DE UVA
Aviso importante
A busca indexada utiliza dados de índice, que podem ter uma defasagem de até 24 horas em relação às atualizações de cadastro ou estoque no Sankhya.
Armazenamento
Campo |
Descrição |
|---|---|
Variável de armazenamento |
Nome da variável que receberá o resultado da busca |
Variável de escopo global |
Permite acessar os dados em qualquer fluxo |
Exemplo:
Estrutura do retorno (busca direta no sankhya)
Exemplo
Estrutura do retorno (busca indexada)
Estrutura do retorno (erro)
Descrição dos campos retornados
Campo |
Descrição |
|---|---|
hasMore |
Indica se existem mais registros para paginação |
size |
Quantidade de produtos retornados |
content[] |
Lista de produtos encontrados |
content[].code |
Código do produto |
content[].description |
Nome ou descrição do produto |
content[].score |
Pontuação de relevância (apenas busca indexada) |
extra.source |
Origem da busca ( |
extra.indexed |
Indica se a busca veio do índice |
extra.fallbackReason |
Motivo do fallback para Sankhya (quando aplicável) |
error |
Erro retornado pela ação |
Comportamento da busca
Quando use_indexed_search = true
Fluxo de execução:
Integração técnica
Busca direta no sankhya
Serviço utilizado:
Exemplo de requisição
Busca indexada (IAN / Elastic)
Endpoint utilizado:
Exemplo de requisição
' --data '{ "index": "qa_digital_sales_sankhya_products_data_pt", "item": "bala", "size": 50, "page": 1 }']]>Exemplos de uso no bot
Mostrar lista de produtos encontrados
Selecionar produto para consulta
Esse valor pode ser usado em:
Detalhe do produto
Estoque do produto
Preço do produto
Tratamento de erros
Situação |
Comportamento |
|---|---|
Termo vazio |
erro |
Produto não encontrado |
|
Falha na busca indexada |
fallback automático para Sankhya |
Boas práticas
Utilizar busca indexada para catálogos grandes
Validar
size > 0antes de prosseguirLimitar número de resultados exibidos ao usuário
Utilizar score para ordenar produtos por relevância
Comentários
0 comentário
Escreva seu comentário aqui
Por favor, entre para comentar.