Edit online

AI Assistant Chatbot

It is possible to integrate a chatbot component in Oxygen WebHelp Responsive output where Oxygen Feedback is installed, allowing users to chat with the AI Assistant to help find answers to questions and find information more quickly and accurately.
Note:
This functionality requires the output to be generated using Oxygen WebHelp version 25 or later.

When the functionality is enabled, a floating AI Assistant button ( / ) is displayed in the lower-right corner of the WebHelp page.

Clicking the button opens a non-modal dialog box where the user can chat with the AI regarding information in the current page.
Note:
To access the chat feature, the user must be authenticated.

In the chat dialog box, the user can interact with the AI using the text field. The chat box can be resized on the left side and it can be closed by clicking the Close button in the top-right corner. When closing the dialog box, its size is preserved in the next session.

The following actions are available when chatting with the AI:
  • Send - Sends the data entered in the text field to the AI Assistant.
  • Stop - Stops a reply from the AI Assistant that is in progress after clicking the Send button.
  • Clear chat - Resets the discussion by removing the previous messages.
  • Debug [Available for users with an Organization or Site role of Admin or Owner] - Displays a log with the entire conversation with the AI Assistant.
  • Rate AI Response - You can rate the effectiveness of the AI Assistant's response. Click the Good Response button to rate the response as useful. Click the Bad Response button to rate the response as unhelpful.

When you click the Send button, the message is submitted to the AI for processing and the progress is displayed above the message input area. The user can continue to type data in the message input area but the Send button is disabled until the reply from the AI is complete. Note that using the ENTER key adds a new line in the message and does not submit the message.

Note:
If the AI Assistant detects that the AI's previous response is not relevant in relation to the content of the user's current publication, the AI will send an additional reply with a statement explaining that the received response may not be fully relevant for the current publication.

Enabling the AI Assistant Chatbot

The AI Assistant functionality is not enabled by default. To enable the AI Assistant:
  1. In the administration interface of Oxygen Feedback Enterprise, go to the Version Settings page for the particular version where you want semantic search enabled.
  2. Scroll to the Content Indexing and Search section and click Edit to expand the section.
  3. Select the Enable content indexing and Enable AI Assistant options.
    Note:
    The AI Assistant functionality requires that you configure Oxygen Feedback Enterprise to connect to OpenAI™ on your behalf.
  4. Click Save.
Notice:
The AI Assistant can generate costs. It is recommended to use support from OpenAI to configure a budget limit on the API key configured for the organization.

Troubleshooting

If you are having trouble getting the AI Assistant button to appear in your output, make sure you have met the conditions listed below.

The AI Assistant button appears if the following conditions are met:
  • The URL of the current page matches the base URL of the current version of the site configuration.
  • The site configuration has not been disabled.
  • The site configuration or version has not been deleted.
  • The site owner has not deleted their account.
  • The license is valid.