Welcome to the configuration guide for the AI Assistant module for WHMCS. This documentation will assist you in setting up and customizing the AI Assistant to enhance your support operations and customer interactions. Below you will find detailed instructions for each configuration setting available in the module.
Accessing the Configuration Page
To begin configuring the AI Assistant, log into your WHMCS admin panel. Navigate to Setup > Addon Modules and locate the AI Assistant module in the list. Click on the Configure button adjacent to the module name to access the configuration settings.
Configuration Options
Basic Configurations
- API Token
- Purpose: This is the key required for your module to interact with OpenAI’s services. It allows the AI to generate responses based on your specified parameters.
- How to Configure: Obtain an API token by registering or logging into your OpenAI account at OpenAI API Management. After generating your API key, enter it into this field to enable AI functionalities.
- Max Tokens
- Purpose: Specifies the maximum number of tokens (or units of text) that the AI can use to generate a response. This setting helps you control the length of responses and manage API usage costs.
- How to Configure: Enter the number of tokens you want to allocate per response. For context, 1000 tokens approximately equate to 750 words.
- Model
- Purpose: Determines which of the available OpenAI models your module will use to generate responses. Different models may offer different capabilities and cost structures.
- How to Configure: Select a model from those listed on the OpenAI model overview page OpenAI Models Overview. Choose based on the balance of cost and performance that suits your needs.
Training AI Configurations
- Trained Model
- Purpose: Allows the use of a specific model trained for your unique requirements.
- How to Configure: If you have trained a custom model with OpenAI, enter the model’s name here. This custom model will then be used to generate responses instead of the default models.
- Auto Ticket Response
- Purpose: Enables the module to automatically respond to support tickets using the configured AI model.
- How to Configure: Toggle this option ON if you want the AI to autonomously handle initial or all responses for incoming support tickets.
- Auto Ticket Response Admin
- Purpose: Selects the admin user under whose name the automated responses will be sent.
- How to Configure: Choose an admin from the dropdown list. The selected admin’s name will appear in the ticket responses as if the admin himself/herself has replied.
- Auto Ticket Response Departments
- Purpose: Defines which departments are authorized for AI to respond to automatically.
- How to Configure: Select the departments you wish to enable for AI responses. You can choose multiple departments as needed.
- New Department
- Purpose: Allows tickets to be reassigned to a different department automatically after the AI has responded.
- How to Configure: From the dropdown list, select the department to which the ticket should be moved after the AI’s response.
- Auto Ticket Response After
- Purpose: Sets the delay before the AI responds to a ticket, allowing time for clients to add additional information or for staff to intervene if necessary.
- How to Configure: Enter the delay in minutes before the AI should respond. The minimum time is 5 minutes, but it can be set higher based on your workflow requirements.
- AI Reply Limit
- Purpose: Restricts the number of times the AI can autonomously respond to a single ticket.
- How to Configure: Set a limit to the number of AI responses per ticket to ensure that customer interactions retain a human touch when necessary.
Conclusion
By configuring each setting appropriately, you can tailor the AI Assistant’s functionality to match your organization’s needs, optimizing both resource utilization and customer satisfaction. This configuration guide is designed to help you harness the full potential of AI within your WHMCS environment. For further assistance or specific use cases, refer to our support resources or contact our help desk.
