|
| 1 | +.. _AI Extensions Framework: |
| 2 | + |
| 3 | +AI Extensions Framework |
| 4 | +####################### |
| 5 | + |
| 6 | +The Open edX AI Extensions plugin is now publicly available. The plugin is |
| 7 | +compatible with Teak and Ulmo as well as Verawood — this is the first release |
| 8 | +with public release notes. |
| 9 | + |
| 10 | +The framework brings AI capabilities to the Open edX platform: for learners |
| 11 | +asking questions, for educators building content, and for platform operators who |
| 12 | +want control over how AI behaves in their courses. |
| 13 | + |
| 14 | +AI Assistant for Learners |
| 15 | +************************* |
| 16 | + |
| 17 | +Learners can chat with an AI assistant directly inside a course unit. The |
| 18 | +assistant understands the content of the unit and can answer questions, clarify |
| 19 | +concepts, and maintain a conversation across multiple turns — without the learner |
| 20 | +leaving the page. |
| 21 | + |
| 22 | +.. image:: /_images/release_notes/verawood/chat_in_context.png |
| 23 | + :alt: The learner-facing LMS is displayed, with a right-hand sidebar overlaying the course content showing an interactive AI chat session |
| 24 | + |
| 25 | +Once questions are generated, a screen appears allowing human review and editing |
| 26 | +of the AI-generated questions. Authors may also choose to regenerate the |
| 27 | +question(s) using the same prompt. |
| 28 | + |
| 29 | +.. image:: /_images/release_notes/verawood/human_review_ui.png |
| 30 | + :alt: A full screen UI which displays the AI generated questions and allows a human reviewer to edit the questions directly. This UI also allows authors to regenerate the question(s) using the same prompt. |
| 31 | + |
| 32 | +Platform operators configure which courses and units have the assistant available, |
| 33 | +and what the AI is instructed to do. |
| 34 | + |
| 35 | +AI Assistance for Educators |
| 36 | +**************************** |
| 37 | + |
| 38 | +Course authors in Studio can use AI to generate multiple-choice questions from |
| 39 | +unit content. Generated questions are saved to a content library for review, |
| 40 | +editing, and reuse across courses. |
| 41 | + |
| 42 | +.. image:: /_images/release_notes/verawood/ai_question_builder.png |
| 43 | + :alt: The AI Question Builder tool is shown in the right sidebar in Studio |
| 44 | + |
| 45 | +The assistant runs in the Studio course outline sidebar and works with Open edX |
| 46 | +Content Libraries, so authors can build up a bank of reviewed, AI-drafted |
| 47 | +questions over time. |
| 48 | + |
| 49 | +Configurable by Design |
| 50 | +********************** |
| 51 | + |
| 52 | +Every AI behavior in the framework runs from a prompt template — the instructions |
| 53 | +that tell the AI what to do and how to respond. Operators set the defaults; course |
| 54 | +authors can adjust them per course when the operator allows it. |
| 55 | + |
| 56 | +This means the same framework can power a general-purpose learning assistant in |
| 57 | +one course and a subject-specific tutor in another, all through configuration. No |
| 58 | +two deployments need to behave the same way. |
| 59 | + |
| 60 | +Managing AI Workflows in Studio |
| 61 | +******************************** |
| 62 | + |
| 63 | +Verawood adds a **Workflows** tab to the AI Extensions card in **Pages & |
| 64 | +Resources**. Course authors can now see every AI profile active in their course, |
| 65 | +where each one runs, and the prompt template guiding it — all without needing |
| 66 | +Django admin access. |
| 67 | + |
| 68 | +When a platform administrator has enabled editing for a profile, authors can |
| 69 | +update the prompt text directly from Studio. The interface shows how many profiles |
| 70 | +use a given template, so authors know how far a change reaches before saving. |
| 71 | + |
| 72 | +Platform operators still create and configure profiles, scopes, and providers |
| 73 | +through Django admin. The Workflows tab brings that configuration into view for |
| 74 | +course authors. |
| 75 | + |
| 76 | +Flexible Provider Support |
| 77 | +************************* |
| 78 | + |
| 79 | +The framework works with OpenAI, Anthropic, and self-hosted models via Ollama or |
| 80 | +vLLM. Operators configure providers in ``config.yml`` in Tutor and reference them |
| 81 | +from workflow profiles. Switching providers or running different models for |
| 82 | +different courses requires only a configuration change — no code. |
| 83 | + |
| 84 | +Built to Be Extended |
| 85 | +******************** |
| 86 | + |
| 87 | +The framework is open for extension. ``openedx-ai-badges`` is one example — it |
| 88 | +adds badge-related AI workflows by registering new components into the same |
| 89 | +framework, without touching the core plugin. Its **Flashcards** and **AI Badges** |
| 90 | +features are available for early testing, though both are still under active |
| 91 | +development and not recommended for production use yet. |
| 92 | + |
| 93 | +Anyone can build on the same pattern. The source code shows how to register new |
| 94 | +workflow components, add Studio tabs, and wire up custom AI behaviors. |
| 95 | + |
| 96 | +Getting Started |
| 97 | +*************** |
| 98 | + |
| 99 | +See the AI Extensions documentation to get up and running: |
| 100 | + |
| 101 | +- `Configuration Guide <https://docs.openedx.org/projects/openedx-ai-extensions/en/latest/quickstarts/configuration_guide.html>`_ — install the plugin and configure a provider |
| 102 | +- `Usage Guide <https://docs.openedx.org/projects/openedx-ai-extensions/en/latest/quickstarts/usage_guide.html>`_ — create your first profile and scope |
| 103 | +- `Customizing Prompts <https://docs.openedx.org/projects/openedx-ai-extensions/en/latest/how-tos/customizing_prompts.html>`_ — tailor the AI's instructions per course |
| 104 | + |
| 105 | + |
| 106 | +.. seealso:: |
| 107 | + |
| 108 | + :ref:`Verawood Product Notes` (reference) |
| 109 | + |
| 110 | + :ref:`Verawood Dev Notes` (reference) |
| 111 | + |
| 112 | + |
| 113 | +**Maintenance chart** |
| 114 | + |
| 115 | ++--------------+-------------------------------+----------------+--------------------------------+ |
| 116 | +| Review Date | Working Group Reviewer | Release |Test situation | |
| 117 | ++--------------+-------------------------------+----------------+--------------------------------+ |
| 118 | +| 2025-07-30 | eduNEXT | Verawood | Pass | |
| 119 | ++--------------+-------------------------------+----------------+--------------------------------+ |
0 commit comments