Skip to main content

AI Coach XBlock

AI Coach Xblock helps learner in improving their answers by levering power of AI. It evaluates open response answer of a question using Open AI and provides feedback to learner.

It has the followig features:

  1. Helps learner to get feedback on their open response answer using Open AI
  2. Learner can improve answer on the basis of Open AI feedback
  3. Ability to mark Question complete in open edX
  4. Save learner answer which can be retrieved later

Setup

pip install ai-coach-xblock

Update Settings of LMS and CMS

Add the OPEN AI secret key in the lms and cms configuration file

OPENAI_SECRET_KEY='set-secret-key'

Update Advanced Settings of course

Update course advanced settings by adding ai_coach as shown in below image

Update settings image

Update settings of AI Coach Component

AI Coach Xblock will be available in Advanced component of course unit now. Add "AI Coach" xblock in unit and click "Edit" button to add question & question context and configure it.

Context is the context of question with answer which is provided to OpenAI for feedback generation. Question and Learner Answer is integrated into context using {{question}} and {{answer}} keywords which automatically picks question & learner aswer value. Example: I am grade 8 student studying leadership. My teacher asked me question: {{question}} . I answered {{answer}} . Provide two tips to improve my answer as a grade 8 student.

Configure AI Coach XBlock Image

Publish Content

Use "Preview" button to preview it or publish your content and use "View Live Version" button to see how it appears on LMS

Preview Live XBlock

Ask For Feedback

After adding answer, learner click on Ask from Coach button for feedback. Feedback is provided by OPEN AI on the basis of question context and answer.

Setting the feedback threshold

  1. The feedback threshold represents the maximum number of times a learner can request feedback. You can configure the feedback threshold by accessing the AI Coach Component settings in the CMS. Set threshold from CMS

  2. The tooltip which appears when hovering over the Ask from coach button represents the chances to request feedback from AI Coach. Show Feedback chances

  3. Once all available chances to request help from the coach have been utilized, Ask from coach button will be disabled and learners will see the following message on tooltip: "You have exhausted all available opportunities to seek guidance from the coach." Tooltip represents remaining chances to ask feedback No remaining feedback chances

Submitting Answer

Submit button saves the learner answer and mark the completion of Xblock.

Submit Answer Xblock Completion

Metadata

Release files for ai-coach-xblock 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ai-coach-xblock 1.1.0
File Size Uploaded
ai_coach_xblock-1.1.0.tar.gz 23.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ai-coach-xblock 1.1.0
File Interpreter ABI Platform
ai_coach_xblock-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 45.7 kB

Release files / ai_coach_xblock-1.1.0.tar.gz

Download URL ai_coach_xblock-1.1.0.tar.gz
Size 23.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d4e805145871d14dd4708582ead37c88d9f27151879cbedefc77efc3b2cf7981
BLAKE2b-256 checksum
How to use checksums
7a86a9c1a804c56a82b29f0a4f928b99741d205d4058c669db2fcc13dbe617d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 12, 2025.

Transparency log

Release files / ai_coach_xblock-1.1.0-py3-none-any.whl

Download URL ai_coach_xblock-1.1.0-py3-none-any.whl
Size 22.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3abf9116c957ace1612ab3cbf7b8f72d0ece474e558b8a3416a8fd99a5d257b0
BLAKE2b-256 checksum
How to use checksums
ab30a4ddade29ff65f9f74aac99c4a507c375c888996923945da0b17879ce060
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 12, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page