Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 3.11 KB

README.md

File metadata and controls

72 lines (41 loc) · 3.11 KB
Raw

Moodle AI Chat Interface

Moodle AI Chat Interface, abbreviated as "MAICI" and pronounced "MAY-see" is a chat-based learning activity providing students with natural language conversation with an an AI Agent.

Using this plugin, an instructor or course designer can create one or several activities of this kind within the same course. This plugin supports an "initializing prompt" which is sent to the agent as well as any documents you wish to be uploaded at the beginning of the conversation thread.

The plugin works with both standard "ChatGPT" and you can access OpenAI "Assistants" which you have aready created in your account.

The amount of bandwidth back-and-forth with Open AI can be capped according to an approximate number of tokens.

Additionally, our plugin supports two types of completion criteria which can be used, or not, in any configuration:

  1. Student must view activity
  2. Student must complete a number of exchanges

Version support

This plugin has been developed to work on Moodle release 4.1.1+

Installing via uploaded ZIP file

  1. Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
  2. Upload the ZIP file with the plugin code. You should only be prompted to add extra details if your plugin type is not automatically detected.
  3. Check the plugin validation report and finish the installation.

Installing manually

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/mod/maici

Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

Global configuration for MAICI

To access the global configuration for the MAICI plugin, navigate to:

Site administration > Plugins > Activity Modules > MAICI

The global configurations:

  • Instance token limit: Here you can limit maximum tokens that teacher can set in plugin instance. Max token per day, max token per user, etc.

  • Maximum token: The maximum number of token to generate. Cannot be greater that maxtoken set in OpenAI account. Requests can use up to 2,048 or 4,000 tokens shared between prompt and completion. The exact limit varies by model. (One token is roughly 4 characters for normal English text)

  • Open AI api key: Default api key for OpenAI that will be used for each instance. Teacher can still specify their own OpenAI key.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.