Iniciar assistente de IA

Exibe o ícone do Assistente de IA.

Definição de tipo

 type launchAiAssistant = () => void

Exemplo:

Exibe o ícone do Assistente de IA na página.

 userGuiding.launchAiAssistant();

Expandir o Assistente de IA

Expande o widget de bate-papo do Assistente de IA. Se o ícone do assistente estiver presente (visível como um ícone), isso abrirá a janela de conversa completa do assistente.

Opcionalmente, você pode enviar uma mensagem para preencher previamente o campo de entrada do chat. O widget será aberto em um novo chat com o texto inserido. A mensagem não é enviada automaticamente; o usuário a revisa e a envia.

Definição de tipo

 type expandAiAssistant = (options?: { message?: string }) => boolean

Parâmetros

options.message (string, opcional): Texto para preencher previamente o campo de entrada do chat.

Valor de retorno

true quando o widget abre. false quando não abre: o usuário não foi identificado, nenhum Assistente de IA está ativo para o usuário ou o limite de uso foi atingido. Você pode usar isso para recorrer a outro recurso de ajuda.

Exemplo:

Abre a janela de bate-papo do Assistente de IA.

 userGuiding.expandAiAssistant();

Exemplo:

Abre o Assistente de IA em um novo chat com uma pergunta pré-preenchida.

 userGuiding.expandAiAssistant({ message: 'How do I export my invoices?' });

Exemplo:

Recorra à sua central de ajuda quando o Assistente de IA não conseguir abrir.

 const opened = userGuiding.expandAiAssistant({ message: 'How do I export my invoices?' });
 if (!opened) {
  window.open('https://help.example.com', '_blank');
 }

Recolher widget do Assistente de IA

Recolhe o widget do Assistente de IA. Se a janela de bate-papo do Assistente de IA estiver aberta, ela será minimizada e retornará ao ícone do iniciador.

Definição de tipo

 type collapseAiAssistant = () => void

Exemplo:

Minimiza a janela de bate-papo do Assistente de IA.

 userGuiding.collapseAiAssistant();

Ocultar assistente de IA

Oculta completamente o Assistente de IA da visualização. Isso remove o ícone do assistente.

Definição de tipo

 type hideAiAssistant = () => void

Exemplo:

Remove o Assistente de IA da página.

 userGuiding.hideAiAssistant();