# **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**
```bash
pip install ai-coach-xblock
```
### **Update Settings of LMS and CMS**
Add the OPEN AI secret key in the lms and cms configuration file
```python
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 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. ```
### **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
### **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.
2. The tooltip which appears when hovering over the `Ask from coach` button represents the chances to request feedback from AI Coach.
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."
### **Submitting Answer**
Submit button saves the learner answer and mark the completion of Xblock.
Raw data
{
"_id": null,
"home_page": "https://github.com/edly-io/ai-coach-xblock",
"name": "ai-coach-xblock",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "edly",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/83/b6/4a77d0300f94b179e31887946cf12ec3eafe0d5b27170e3613b7c37ad51d/ai_coach_xblock-1.0.7.tar.gz",
"platform": null,
"description": "# **AI Coach XBlock**\n\nAI 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.\n\nIt has the followig features:\n\n1. Helps learner to get feedback on their open response answer using Open AI\n2. Learner can improve answer on the basis of Open AI feedback\n3. Ability to mark Question complete in open edX\n4. Save learner answer which can be retrieved later\n\n\n## **Setup**\n\n```bash\npip install ai-coach-xblock\n```\n\n### **Update Settings of LMS and CMS**\nAdd the OPEN AI secret key in the lms and cms configuration file\n```python\nOPENAI_SECRET_KEY='set-secret-key'\n```\n\n### **Update Advanced Settings of course**\nUpdate course advanced settings by adding `ai_coach` as shown in below image\n\n\n\n### **Update settings of AI Coach Component**\n\nAI Coach Xblock will be available in Advanced component of course unit now. Add \"AI Coach\" xblock in unit and click \"Edit\" button to\nadd `question` & `question context` and configure it.\n\n> `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. \n> Example: \n```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. ``` \n\n\n\n\n\n### **Publish Content**\n\nUse \"Preview\" button to preview it or publish your content and use \"View Live Version\" button to see how it appears on LMS\n\n\n\n\n### **Ask For Feedback**\n\nAfter 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. \n\n#### **Setting the feedback threshold**\n\n1. 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.\n\n\n2. The tooltip which appears when hovering over the `Ask from coach` button represents the chances to request feedback from AI Coach.\n\n\n3. 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.\"\n\n\n\n\n\n### **Submitting Answer**\n\nSubmit button saves the learner answer and mark the completion of Xblock.\n\n\n\n",
"bugtrack_url": null,
"license": "AGPL v3",
"summary": "AI Coach Xblock evaluates open response answer of a question using Open AI",
"version": "1.0.7",
"project_urls": {
"Homepage": "https://github.com/edly-io/ai-coach-xblock"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef63b84bde31be9bc70e87749a60bad514a2ec9948830e3d9520f7a5e980f5eb",
"md5": "de99550dd11d23a3730c9cf140c8b6d4",
"sha256": "1b9b7bc7f90f3abc42cfb45e9278347c1922c2e0bd200f9387d0f9900e4890e8"
},
"downloads": -1,
"filename": "ai_coach_xblock-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de99550dd11d23a3730c9cf140c8b6d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22058,
"upload_time": "2024-10-11T05:59:03",
"upload_time_iso_8601": "2024-10-11T05:59:03.914336Z",
"url": "https://files.pythonhosted.org/packages/ef/63/b84bde31be9bc70e87749a60bad514a2ec9948830e3d9520f7a5e980f5eb/ai_coach_xblock-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83b64a77d0300f94b179e31887946cf12ec3eafe0d5b27170e3613b7c37ad51d",
"md5": "889eb19eda2804aad3cb4ec3d6880422",
"sha256": "781220d28cf3db634d7c35b72606cc68e3b1f919603b8e0dff2f60a3eb23b03c"
},
"downloads": -1,
"filename": "ai_coach_xblock-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "889eb19eda2804aad3cb4ec3d6880422",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22342,
"upload_time": "2024-10-11T05:59:04",
"upload_time_iso_8601": "2024-10-11T05:59:04.820231Z",
"url": "https://files.pythonhosted.org/packages/83/b6/4a77d0300f94b179e31887946cf12ec3eafe0d5b27170e3613b7c37ad51d/ai_coach_xblock-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 05:59:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edly-io",
"github_project": "ai-coach-xblock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ai-coach-xblock"
}
JSON
