create : Added Sunbird AI Assistant integration with Sunbird Ed APIs #686
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📥 Pull Request: Sunbird AI Assistant Integration ( #515 )
Description
This PR integrates the Sunbird AI Assistant into the repository. The AI assistant is built using the Model Context Protocol (MCP) and is capable of interacting contextually with the Sunbird Ed APIs. The assistant is designed to:
Key Changes:
.env
file for configuring the Sunbird API base URL, authentication token, and other settings.Motivation:
This integration adds a powerful conversational agent to the project, allowing users to interact with Sunbird Ed in a more intuitive way. By utilizing the Model Context Protocol (MCP), the assistant is flexible, context-aware, and ready to be extended for future use cases, such as personalized learning journeys.
Changes in Detail:
Tools: The assistant is equipped with tools that connect to the following Sunbird Ed API endpoints:
/course/v1/search
: Fetches metadata about available courses./user/enrollment/list
: Retrieves the enrollment details for the user./user/v1/profile
: Retrieves the profile information of the user.Config Settings: The assistant requires a
.env
file to store configuration like the Sunbird API base URL and Bearer token for secure API calls.CLI Interface: The command-line interface (CLI) allows users to query the assistant and get real-time responses.
Testing:
test_agent.py
file contains tests to verify if the AI assistant interacts correctly with Sunbird Ed APIs.Future Work:
How to Test Locally
Clone the repository:
git clone https://github.com/Code4GovTech/C4GT.git cd C4GT/sunbird-ai-assistant
Install the dependencies:
Set up environment variables in the
.env
file:Run the unit tests:
Start the CLI loop:
Adding connected and modified pull request for your reference and consideration Add context-aware conversational AI assistant for Sunbird Ed
Looking forward to feedback and suggestions! 🚀