Skip to main content

AI Coach Xblock evaluates open response answer of a question using Open AI

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_coach_xblock-1.1.0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_coach_xblock-1.1.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_coach_xblock-1.1.0.tar.gz.

File metadata

  • Download URL: ai_coach_xblock-1.1.0.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ai_coach_xblock-1.1.0.tar.gz
Algorithm Hash digest
SHA256 d4e805145871d14dd4708582ead37c88d9f27151879cbedefc77efc3b2cf7981
MD5 c2fb4a31aa9577a9e7dd2047f1681be9
BLAKE2b-256 7a86a9c1a804c56a82b29f0a4f928b99741d205d4058c669db2fcc13dbe617d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_coach_xblock-1.1.0.tar.gz:

Publisher: publish_pypy.yml on edly-io/ai-coach-xblock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_coach_xblock-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_coach_xblock-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3abf9116c957ace1612ab3cbf7b8f72d0ece474e558b8a3416a8fd99a5d257b0
MD5 4eb68ed9bd5c898f222806c7afb1fa53
BLAKE2b-256 ab30a4ddade29ff65f9f74aac99c4a507c375c888996923945da0b17879ce060

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_coach_xblock-1.1.0-py3-none-any.whl:

Publisher: publish_pypy.yml on edly-io/ai-coach-xblock

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page