OL OpenedX Chat xBlock
An xBlock to add MIT Open Learning chat in courses.
Purpose
MIT’s AI chatbot xBlock for Open edX
Version Compatibility
For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.
Setup
For detailed installation instructions, please refer to the plugin installation guide.
Installation required in:
LMS
Studio (CMS)
Configuration
edx-platform configuration
Go to the course page in Studio (CMS), open Advanced Settings and add ol_openedx_chat_xblock to the Advanced module list.
To add this xBlock to a course, you can now select the Advanced tile on the new unit page and select OL Chat xBlock from the list of available advanced xBlocks.
Add the following configuration values to the config files in Open edX. For any release after Juniper, these config files are /edx/etc/lms.yml and /edx/etc/cms.yml. If you’re using private.py, add these values to lms/envs/private.py and cms/envs/private.py. These should be added to the top level. Ask a fellow developer for these values.
# Required MIT_LEARN_AI_XBLOCK_CHAT_API_TOKEN: <MIT_LEARN_AI_XBLOCK_CHAT_API_TOKEN> # Required for Syllabus Chat MIT_LEARN_AI_XBLOCK_CHAT_API_URL: <MIT_LEARN_AI_XBLOCK_CHAT_API_URL> # Required for Tutor Chat MIT_LEARN_AI_XBLOCK_TUTOR_CHAT_API_URL: <MIT_LEARN_AI_XBLOCK_TUTOR_CHAT_API_URL> MIT_LEARN_AI_XBLOCK_PROBLEM_SET_LIST_URL: <MIT_LEARN_AI_XBLOCK_PROBLEM_SET_LIST_URL>
For Tutor installations, these values can also be managed through a custom Tutor plugin.
xBlock configuration
Course ID Configuration
The chat xBlock needs a course ID to work. (NOTE: This is not the course ID of the course xBlock is created in) Here is how the course ID can be set:
- Course ID setting in the xBlock in Studio (CMS)
Just open the chat xBlock settings in Studio (CMS) and set the course ID in the configuration field named Course ID.
- Auto-generate course ID (LTI Launch Only)
If you don’t set the course ID in the xBlock configuration, the xBlock will automatically try to generate a course ID based on the LTI launch request. This is useful if you want to use the xBlock in multiple courses without having to set the course ID manually.
Just make sure to add a custom field course_id=$Canvas.course.id in Canvas LTI app configuration so that the course ID can be extracted from the LTI launch request.
Tutor Configuration
The chat xBlock can work as a tutor xBlock as well. Here is how you can set an xBlock to be a tutor xBlock:
- Is Tutor setting in the xBlock in Studio (CMS)
Just open the chat xBlock settings in Studio (CMS) and use the toggle field named Is Tutor xBlock?.
Documentation
The chat xBlock enables students to interact with an AI chatbot powered by MIT Learn AI. It provides a user-friendly interface for students to ask questions and receive answers in real-time.
The xBlock provides different features such as: - Syllabus Chat interface for students to interact with the AI chatbot and receive assistance with syllabus-related queries. - Tutor Chat interface for students to interact with the AI chatbot and receive assistance with different problems in the courseware.
License
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
1 maintainer
Metadata
1 maintainer
Release files for ol-openedx-chat-xblock 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ol_openedx_chat_xblock-0.5.0.tar.gz | 10.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ol_openedx_chat_xblock-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.9 kB
Release files / ol_openedx_chat_xblock-0.5.0.tar.gz
| Download URL | ol_openedx_chat_xblock-0.5.0.tar.gz |
|---|---|
| Size | 10.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7f8dd3d3f2b9dadc4df0c5bbcfcb4f2247b2e87245458bdb2cc497f6da886720
|
|
BLAKE2b-256 checksum How to use checksums |
b05d15c752abd823f642e93f2190d9bef92646481813df9b1f5e5bd80ef2973e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / ol_openedx_chat_xblock-0.5.0-py3-none-any.whl
| Download URL | ol_openedx_chat_xblock-0.5.0-py3-none-any.whl |
|---|---|
| Size | 16.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
08ac0320b3d0b93108cea8000724e2234098cfaf3f8f6725e488dc2e018fd4ba
|
|
BLAKE2b-256 checksum How to use checksums |
1aa976e54d03db0403c850dc3e247957b7ea72e62df59df1c850d7ba916d1613
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
