Skip to main content

Configuration

Who is this for? Site administrators.

Tutor AI is configured at the site level. Use these settings to enable the chat, choose how it appears inside courses, and customize the tutor’s behavior.


1) Open Tutor AI settings

In Moodle, go to:

Site administration → Plugins → Local plugins → Tutor AI

Admin settings Admin settings Tutor AI settings (scroll 1: general options)

This screenshot captures the top of the settings page (scroll position 1) where the global toggles live.


2) Enable the chat (required)

Turn on Enable chat so the floating avatar shows up inside course pages.

Enable chat and related toggles (scroll 2)

If the avatar does not appear after enabling, verify you saved changes and that the Datacurso AI Provider webservice is configured (see Prerequisites).


Enable Off-topic detection and configure the response behavior to keep Tutor AI focused on course questions.

Off-topic detection & prompt sections (scroll 3)


4) Choose the avatar and drawer layout

Configure:

  • Avatar style (or upload/select a character)
  • Avatar position on the page
  • Chat drawer side (left or right)
  • Preview to confirm placement

Avatar position + drawer preview


5) Customize the tutor's identity and prompt

Set the Tutor name, Welcome message, and optionally a custom prompt that uses placeholders such as {$a->username}, {$a->fullname}, and {$a->role}.

Tutor customization + placeholders

Prompt best practice

Keep the prompt short and action-oriented. Start simple, observe real learner questions, then refine.


6) Validate the configuration (fast check)

  1. Open any course page.
  2. Confirm the floating avatar appears in the corner.
  3. Open the drawer and ask a quick question to see the streaming response.

Chat drawer in action

If you see error_webservice_not_configured, return to Prerequisites to finish the provider setup.

Troubleshooting

This section lists the most common issues when using Tutor AI and how to resolve them.


Tutor AI opens, but responses never arrive (no streaming reply)

Most common causes:

  • Provider webservice/token is not valid.
  • Network blocks streaming (SSE) connections.
  • Provider is not licensed or not responding.

What to do:

  1. Verify the provider webservice is configured (see Prerequisites).
  2. Confirm the Datacurso AI Provider is licensed (license key configured).
  3. Try from a different network/environment to rule out SSE blocking.

Most common causes:

  • Custom prompt is too broad or missing.
  • Off-topic detection is disabled (optional).

What to do:

  1. Go to Tutor AI settings and add a short, course-focused prompt.
  2. Enable off-topic detection if you want the assistant to redirect unrelated questions.

Off-topic detection + prompt area (scroll 3)

Tip: Use the prompt templates in Use cases (Templates).


Off-topic detection is blocking valid questions

Cause: The setting is too strict for your course context.

What to do:

  1. Disable off-topic detection temporarily to test.
  2. Adjust your custom prompt to clearly define what is considered on-topic.

Off-topic detection setting (scroll 3)


Placeholders in the prompt are not working

Tutor AI supports placeholders in the custom prompt, such as:

  • {$a->username}
  • {$a->fullname}
  • {$a->role}

What to do:

  1. Confirm you are using the placeholder exactly as shown.
  2. Keep placeholders inside the prompt field (do not modify the syntax).

Tutor customization + placeholders (scroll 3)