Extensão Catalyst AI Personal Shopper @ Blip Store

Documentação para uso da extensão Catalyst AI Personal Shopper feita pela Dawntech Inc. para a plataforma Blip

Introdução

A extensão Catalyst AI Personal Shopper foi desenvolvida pela empresa Dawntech Inc. Atualmente, ela se encontra na versão 1.0 e está disponível nos idiomas Português do Brasil, Espanhol e Inglês.

Com essa extensão, o usuário pode ter acesso a um catálogo personalizado de produtos gerado através de inteligência artificial, funcionando como um personal shopper via WhatsApp!

Este manual tem como objetivo auxiliar os usuários da plataforma Blip na instalação, configuração e utilização da extensão Catalyst AI Personal Shopper. Em adendo, qualquer dúvida de uso pode ser encaminhada para contact@dawntech.dev ou entrando em contato pelo número (51) 3557-2998.

Sobre a extensão

A extensão Catalyst AI Personal Shopper foi desenvolvida tendo como o objetivo a associação de um fluxo de e-commerce dentro do Builder do Blip a um catálogo específico do Facebook, tornando assim possível mostrar os produtos nos canais publicados.

As seguintes funcionalidades são oferecidas:

  • Obtenção de componente de catálogo WhatsApp de produtos a partir de um catálogo do Facebook, filtrado por campo personalizado e mensagem de contatos ao chatbot, fazendo uso do contexto de 24 horas da conversa dos contatos.
  • Possibilidade de obter PLMs (product list messages) para o WhatsApp e carrosséis de imagens para outros canais.
  • Diversos filtros já prontos via API, assim como pode ser visto na documentação.
  • Retorno de mensagem personalizada de acordo com o input dos usuários e produtos retornados.

Instalação e configuração

Para utilizar a extensão Catalyst AI Personal Shopper, no bot Router associado ao contrato, vá até a BlipStore e procure a extensão Catalyst AI Personal Shopper na aba de Extensões. Quando a encontrar, ative-a nesse mesmo bot. Após a instalação, ao abrir o bot Router, as opções de configuração da extensão Catalyst AI Personal Shopper estarão disponíveis: A tela de configuração da extensão é mostrada na figura abaixo:

Catalyst

Em caso de erros, a extensão avisará os inputs com problemas:

Catalyst

Manual de uso

Usuários com permissão de administrador podem alterar as informações de configuração da extensão, além de adicionar ao Builder chamadas HTTP específicas para a extensão, que utiliza as configurações supracitadas.

Para utilizar os recursos da extensão, é necessário configurar uma ação do tipo Requisição HTTP chamando a URL abaixo, com dois parâmetros de URL: takeblip-bot-key e takeblip-tenant-id (ou via headers, com os mesmos nomes), sendo a chave de acesso do bot onde a extensão foi instalada (bot Router) e o nome do contrato, respectivamente (conforme ilustrado na figura a seguir). Para facilitar seu uso, a URL com esses parâmetros é gerada automaticamente na seção Informações Geradas.

A extensão provê dois endpoints HTTP:

  1. Obtenção de produtos do catálogo (POST):
    • URL: https://api.catalyst.dwnt.store/catalyst-ai-personal-shopper/search?takeblip-tenant-id={{tenant_id}}&takeblip-bot-key={{router_api_key}}&openai-api-key={{openai_key}}.
    • Payload (JSON):
    {
        "input": "Mensagem livre do usuário",
        "phone": "Identificador do contato para salvar contexto",
        "filter": { "{campo}": "{valor}" }, // Filtro pode ser usado em conjunto com o input do usuário
        "text": {
            "header": "Produtos",
            "body": "Saiba mais clicando aqui!",
            "footer": "Clique abaixo!",
            "section_name": "Produtos"
        }
    }
    
    • Onde {campo} e {valor} determinam o filtro a ser aplicado no catálogo do Facebook. Por exemplo, usando {campo} e {valor} com os valores “name” e “Blusa”, respectivamente, irá retornar os produtos do catálogo do Facebook que possuem "Blusa" na coluna “name”.
    • A mensagem livre ("input") pode ser qualquer coisa, como por exemplo "Preciso de uma roupa para ir em um aniversário em um local aberto".
    • O campo "phone" é utilizado para armazenamento de contexto da conversa do usuário para uma maior assertividade das respostas e possui um tempo máximo de armazenamento de 24 horas, sendo resetado após esse período.
  • A resposta da requisição vem no seguinte formato:
    {
        "dynamic-content": { // Conteúdo dinâmico para usar no Builder com o tipo application/json
            "type": "interactive",
            "interactive": {
                "type": "product_list",
                "header": {
                    "type": "text",
                    "text": "Produtos"
                },
                "body": {
                    "text": "Saiba mais clicando aqui!"
                },
                "footer": {
                    "text": "Clique abaixo!"
                },
                "action": {
                    "catalog_id": "865085895408431",
                    "sections": [
                        {
                            "product_items": [
                                {
                                    "product_retailer_id": "ID_1"
                                },
                                {
                                    "product_retailer_id": "ID_2"
                                }, // ...
                                {
                                    "product_retailer_id": "ID_N"
                                }
                            ]
                        }
                    ]
                }
            }
        },
        "message": "Mensagem personalizada gerada por inteligência artificial de acordo com os produtos encontrados e a pergunta do contato"
    }
    
  1. Obtenção de resumo de carrinho (POST):
    • URL: https://api.catalyst.dwnt.store/catalog-extension/cartSummary?takeblip-tenant-id={{tenant_id}}&takeblip-bot-key={{router_api_key}}.
    • Payload (JSON):
    {
        "product_items": [
            {
                "product_retailer_id": "<STRING>",
                "quantity": "<STRING (e.g.: 1)>",
                "item_price": "<STRING (e.g.: 1.5)>",
                "currency": "<STRING (e.g.: USD)>"
            },
            ...
        ]
    }
    

Termos de Uso

Ao instalar esta extensão você concorda com os termos de uso descritos em dawntech.dev/privacy, política válida também para o uso dos dados coletados coletados pela extensão (se/quando necessário).

SLA

O SLA desse e outras extensões da Dawntech Inc. podem ser acessados em status.dawntech.dev.