Development of a Moodle Plugin for OpenAI "Assistant" GPT-4+

In the ever-evolving educational context, the integration of technology into learning processes has become essential to enrich the educational experience. With this in mind, our project aims to develop an innovative plugin for the online learning platform, Moodle. This plugin will enable the integration of customized chatbots (assistants created via [login to view URL]), thus offering teachers and students an interactive and engaging resource directly within their learning environment.

The purpose of this specification document is to clearly define the objectives, features, technical requirements, and expectations regarding the deployment and maintenance of the proposed plugin. This document will serve as a reference throughout the development process, ensuring that the final product meets the specific needs of our educational environment, while adhering to Moodle's standards of quality and security.

This plugin is designed to be intuitive, secure, and adaptable, ensuring a smooth and effective integration of virtual assistants into the teaching and learning process.

IMPORTANT Existing PHP code is already written to display an OpenAI assistant chatbot on a web page. The task is to integrate this PHP code into a plugin while ensuring compatibility between this PHP code and Moodle.

Objectives and Features:

• Chatbot Integration: Enable integration of chatbot assistants created on OpenAI's site into Moodle course pages using a "secret key" and the assistant's "ID".

• Plugin Type: block.

• User Interface:

o Use of an icon provided by the client to identify the plugin.

o For all course participants: a standard question-answer interface for interacting with the chatbot.

o For teachers or administrators: ability to modify the "secret key" and the assistant's "ID" in the plugin settings.

o Plugin developed in English.

o French translation to be provided by the client and integrated into the plugin.

• Authentication and Security:

o Enable each teacher to integrate their own assistants (one at a time) into their courses by inserting information found in their OpenAI account (namely: "secret key" and "ID" of the assistant).

o Secure access to the assistants' "secret keys" and IDs, accessible only to course teachers and Moodle administrators.

• Technical Compatibility:

o Ensure plugin compatibility with Moodle standards (reference: Moodle Documentation).

o Ensure compatibility of existing PHP code with Moodle.

Parameters

• Restrict chat usage to logged-in users: If this box is checked, only users who are logged in will be able to use the chat box.

• OpenAI API Key: This is where you add the API key provided to you by OpenAI.

• OpenAI ID assistant : This is where you add the ID of the assistant provided to you by OpenAI.

• End Prompt: Here, you can modify the text added at the top of the conversation to influence the character and responses of the AI.

• Assistant's Name: This is the name that the AI will use for itself in the conversation.

• User Name: This is the name that will be used for the user in the conversation. This option and the one above can be used to influence the personality and responses of the AI.

• Maximum number of tokens to generate.

Development and Testing:

• Development Environment: The plugin must be developed in accordance with Moodle's norms and standards.

• Testing Process:

o Continuous testing by the developer on a local Moodle platform or an online Moodle platform of their choice.

o Final testing on multiple client's Moodle platforms by the client themselves.

Deployment:

• To be defined in collaboration with the client.

Maintenance, Support, and Documentation (Separate Offer):

• Maintenance planned for Moodle versions 4.X and potentially 5.X (depending on the evolution of Moodle and OpenAI).

• If the plugin is published on the Moodle plugin platform, user support and adequate technical documentation should be planned.

Budget and Timeframes:

• To be defined based on the developer's proposals.

Note : It may be interesting to consult this plugin, which allows for the integration of a "simple" OpenAI chatbot with GPT-3 (not an assistant): [login to view URL]

Moodle PHP Plugin

Numer ID Projektu: #37613313

O projekcie