Step 1: Download the Module


Step 2: Install the Module in Joomla

  1. Log into the Joomla backend.
  2. Navigate to System > Extensions > Install.
  3. Upload and install the downloaded module file.

Step 3: Configure the Module

  1. Go to Content > Site Modules and open the newly installed module.
  2. Insert API Key:
  3. Set the Module Position:
    • Set the module position to a location that is visible on the front-end.
    • Publish the module and activate it on all pages.
  4. Chat Limit: Set the maximum responses.

Step 4: View Options

  • Button Position: Set the position for the chat icon.
  • Button Icon: Choose the icon type (you can find options at FontAwesome Icons).

Step 5: Text Options

  • Set the initial message as well as messages to be shown before and after the last input. For example:
    • “If you have further questions, feel free to contact us via our contact form.”

Step 6: Personalization

  1. OpenAI API Endpoint: No changes needed here.
  2. Model Instructions:
    • In the Initial Model Instruction field, add instructions for how the assistant should respond. Example:
      • "You are a helpful assistant for an online educational platform. Assist users in course selection and provide study tips. Respond professionally, educationally, and supportively."
  3. Additional Options:
    • Include Model in Request: Do you want your instructions to be considered in every request?
    • Chat Model: Choose the language model to be used. This affects both quality and price/token. See OpenAI API Pricing for more information.
    • Max Tokens: Limit the length of the responses (recommended: 100-300).
    • Temperature: Adjust creativity (0 for precise answers, 1 for more creative responses, with 0.1-step increments).
    • User/Assistant Response Format: Should a name be prefixed to the text (e.g., “ChatBot: %s”)?
    • Limit Reach Instruction: Add a closing message once the limit is reached.

Step 7: Test and Optimize

  • Testing: Open the front-end and test the module.
    • Ask general and specific questions to ensure the answers meet your expectations.
    • Adjust the instructions in the backend as needed until the results are perfect.

By following this guide, you can successfully install and configure the ChatGPT Assistant module for Joomla and integrate it into your website.