Skip to main content
Version: Próxima

Visão Geral

O useAgentVtexCX conversa com um agente que já existe no VTEX CX Platform (transporte WebSocket da Weni), em vez de chamar o backend de agentes do Eitri.

A diferença que mais aparece na tela: a resposta chega em streaming. O texto é atualizado a cada frame recebido do socket, então a conversa cresce na tela palavra por palavra, sem esperar a resposta inteira.

Qual hook usar​

useAgentuseAgentVtexCX
Onde o agente vivebackend de agentes do Eitricanal do VTEX CX Platform
TransporteHTTP (Eitri.http.post)WebSocket
Respostade uma vez, ao fim da requisiçãoem streaming, frame a frame
Prompt do agenteagents/*.md no seu projetoflow configurado no CX
Ferramentas (tools)sim, via window['AGENT_TOOLS'] em runtime do Eitri-Appnão — tudo é montado no painel do CX
RAG / embeddingssim (useKnowledge)não
speech (áudio)simnão
Histórico da conversacontexto local, em memóriaservidor é a fonte da verdade
Dado estruturadoJSON no texto da respostacampos do protocolo (product_list, quick_replies…) e JSON do agente
Configuraçãoeitri agents setup (LLM + API key)channelUuid do canal

Resumindo: useAgent quando o agente é seu e roda na infra de agentes do Eitri; useAgentVtexCX quando o atendimento já está montado no CX Platform e o app é só mais um canal dele.

Os dois vêm na mesma biblioteca e podem coexistir no mesmo app.

Como funciona​

Fluxo de uma conversa com o useAgentVtexCX

  1. O hook resolve a identidade da conversa (o campo from do registro): o sessionId que você passar ou um id anônimo guardado no Eitri.sharedStorage.
  2. Abre o WebSocket e faz o register com o callback do canal.
  3. Quando o servidor responde ready_for_message, pede o histórico (get_history) e monta a conversa.
  4. call() envia a mensagem como frame message (texto e/ou mídia).
  5. A resposta chega de um destes jeitos, e o hook normaliza todos para o mesmo formato de mensagem:
    • typing_start → o status vira thinking (IA) ou typing (atendente);
    • stream_start + delta + stream_end → texto em streaming;
    • frame message completo → texto, mídia, quick_replies, product_list…;
    • JSON do agente no texto → aberto em mensagens e catálogo de produtos.
  6. Quedas de conexão voltam sozinhas, com backoff exponencial.

O que você precisa antes de começar​

  • O channelUuid do canal do CX Platform (o mesmo id usado pelo webchat).
  • O flow/agente publicado no CX. Nada de eitri agents setup: este caminho não usa LLM nem API key configurada no Eitri — quem responde é o CX.

Siga para Uso Básico.