Advice and answers from the UserGuiding Team
Users
Engagement
Settings
AI Assistant
Learn how to utilize the UserGuiding's JavaScript API AI Assistant methods

Launch AI Assistant

Displays the AI Assistant launcher. 


Type Definition

type launchAiAssistant = () => void


Example:

Shows the AI Assistant launcher on the page


userGuiding.launchAiAssistant();


Expand AI Assistant

Expands the AI Assistant’s chat widget. If the assistant launcher is present (visible as a launcher), this will open the whole assistant conversation window.


Type Definition

type expandAiAssistant = () => void


Example:

Opens the AI Assistant chat window


userGuiding.expandAiAssistant();


Collapse AI Assistant Widget

Collapses the AI Assistant widget. If the AI Assistant’s chat window is currently open, this will minimize it back to the launcher icon.


Type Definition

type collapseAiAssistant = () => void


Example:

Minimizes the AI Assistant chat window


userGuiding.collapseAiAssistant();



Hide AI Assistant

Completely hides the AI Assistant from view. This removes the assistant’s launcher.


Type Definition

type hideAiAssistant = () => void


Example:

Removes the AI Assistant from the page


userGuiding.hideAiAssistant();


Did this answer your question?