xblock-ai-eval 0.2.0__tar.gz

xblock_ai_eval-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

xblock_ai_eval-0.2.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.2
+Name: xblock-ai-eval
+Version: 0.2.0
+Summary: XBlocks to write short text and code entries with AI-driven evaluation
+License: Apache 2.0
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: XBlock
+Requires-Dist: litellm>=1.42
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

xblock_ai_eval-0.2.0/README.md

@@ -0,0 +1,73 @@
+## Introduction
+
+This repository hosts two Open edX XBlocks: 
+
+1. **Short Answer with AI Evaluation**: This XBlock allows students to submit short answers, which are then evaluated with the help of a large language model (LLM).
+2. **Coding with AI Evaluation**: This XBlock allows students to submit code in a text editor. The code is executed via a third-party API (currently using [Judge0](https://judge0.com/)), and both the code and its output are sent to an LLM for feedback.
+
+## Screeshots
+
+| ![Short Answer with AI evaluation Xblock](docs/shortanswer-xblock.png) | ![Coding with AI evaluation Xblock](docs/coding-xblock.png) |
+|-----------------------------------------------------------------------|----------------------------------------------------------------|
+| ![Coding with AI evaluation Xblock HTML](docs/coding-xblock-ai-feedback.png) | ![Coding with AI evaluation Xblock AI feedback](docs/coding-xblock-html.png) |
+
+
+
+## Setup
+
+### Using Tutor
+
+1. Add the following line to the `OPENEDX_EXTRA_PIP_REQUIREMENTS` in your Tutor `config.yml` file:
+   ```yaml
+   OPENEDX_EXTRA_PIP_REQUIREMENTS:
+     - git+https://github.com/open-craft/xblock-ai-evaluation
+   ```
+   You can append  `@vX.Y.Z` to the URL to specify your desired version.
+
+2. Launch Tutor.
+
+3. In the Open edX platform, navigate to `Settings > Advanced Settings` and add `shortanswer_ai_eval` and `coding_ai_eval` to the `Advanced Module List`.
+
+4. Add either XBlock using the `Advanced` button in the `Add New Component` section of Studio.
+
+5. Configure the added Xblock and make sure to add correct API keys. You can format your question and prompts using [Markdown](https://marked.js.org/demo/).
+
+### API Configuration
+
+The XBlocks support multiple ways to configure API keys and URLs for language models.  
+The system will check for these configurations in the following order:
+1. **XBlock-level configuration**: API keys and URLs can be set directly in each XBlock instance through the Studio UI.
+2. **Site configuration**: Values can be set globally for all XBlocks using Open edX's Site Configuration.
+   To configure values in Site Configuration, navigate to `Django admin > Site Configurations` and add the following keys:
+   ```json
+    {
+        "ai_eval": {
+             "GPT4O_API_KEY": "your-openai-api-key",
+             "LLAMA_API_URL": "https://your-llama-endpoint"
+        }
+    }
+    ```
+3. **Django settings**: Values can be defined in the Django settings. 
+   To configure in Django settings (e.g., in Tutor), add the following to your configuration:
+   ```python
+   XBLOCK_SETTINGS = {
+       "ai_eval": {
+           "GPT4O_API_KEY": "your-openai-api-key",
+           "LLAMA_API_URL": "https://your-llama-endpoint"
+        }
+    }
+    ```
+
+#### Note About API URLs
+
+API URLs are only required and used with the LLAMA model (`ollama/llama2`). Other models use their standard endpoints and only require API keys.
+
+#### Security Considerations
+
+For better security, we recommend using site configuration or Django settings instead of configuring API keys at the 
+XBlock level. This prevents API keys from being exposed in course exports.
+
+## Dependencies
+- [Judge0 API](https://judge0.com/)
+- [Monaco editor](https://github.com/microsoft/monaco-editor)
+- [LiteLLM](https://github.com/BerriAI/litellm)

xblock_ai_eval-0.2.0/ai_eval/__init__.py

@@ -0,0 +1,6 @@
+"""
+Xblock to have short text and code entries with AI-driven evaluation.
+"""
+
+from .shortanswer import ShortAnswerAIEvalXBlock
+from .coding_ai_eval import CodingAIEvalXBlock

xblock_ai_eval-0.2.0/ai_eval/base.py

@@ -0,0 +1,193 @@
+"""Base Xblock with AI evaluation."""
+from typing import Self
+
+import pkg_resources
+
+from django.utils.translation import gettext_noop as _
+from xblock.core import XBlock
+from xblock.fields import String, Scope, Dict
+from xblock.utils.resources import ResourceLoader
+from xblock.utils.studio_editable import StudioEditableXBlockMixin
+from xblock.validation import ValidationMessage
+
+from .compat import get_site_configuration_value
+from .llm import SupportedModels
+
+
+@XBlock.wants("settings")
+class AIEvalXBlock(StudioEditableXBlockMixin, XBlock):
+    """
+    Base class for Xblocks with AI evaluation
+    """
+
+    USER_KEY = "USER"
+    LLM_KEY = "LLM"
+
+    loader = ResourceLoader(__name__)
+
+    icon_class = "problem"
+    model_api_key = String(
+        display_name=_("Chosen model API Key"),
+        help=_("Enter the API Key of your chosen model. Not required if your administrator has set it globally."),
+        default="",
+        scope=Scope.settings,
+    )
+    model_api_url = String(
+        display_name=_("Set your API URL"),
+        help=_(
+            "Fill this only for LLama. This required with models that don't have an official provider."
+            " Example URL: https://model-provider-example/llama3_70b"
+        ),
+        default=None,
+        scope=Scope.settings,
+    )
+    model = String(
+        display_name=_("AI model"),
+        help=_("Select the AI language model to use."),
+        values=[
+            {"display_name": model, "value": model} for model in SupportedModels.list()
+        ],
+        Scope=Scope.settings,
+        default=SupportedModels.GPT4O.value,
+    )
+
+    evaluation_prompt = String(
+        display_name=_("Evaluation prompt"),
+        help=_(
+            "Enter the evaluation prompt given to the model."
+            " The question will be inserted right after it."
+            " The student's answer would then follow the question. Markdown format can be used."
+        ),
+        default="You are a teacher. Evaluate the student's answer for the following question:",
+        multiline_editor=True,
+        scope=Scope.settings,
+    )
+    question = String(
+        display_name=_("Question"),
+        help=_(
+            "Enter the question you would like the students to answer."
+            " Markdown format can be used."
+        ),
+        default="",
+        multiline_editor=True,
+        scope=Scope.settings,
+    )
+
+    messages = Dict(
+        help=_("Dictionary with chat messages"),
+        scope=Scope.user_state,
+        default={USER_KEY: [], LLM_KEY: []},
+    )
+    editable_fields = (
+        "display_name",
+        "evaluation_prompt",
+        "question",
+        "model",
+        "model_api_key",
+        "model_api_url",
+    )
+
+    block_settings_key = "ai_eval"
+
+    def _get_settings(self) -> dict:  # pragma: nocover
+        """Get the XBlock settings bucket via the SettingsService."""
+        settings_service = self.runtime.service(self, "settings")
+        if settings_service:
+            return settings_service.get_settings_bucket(self)
+
+        return {}
+
+    def resource_string(self, path):
+        """Handy helper for getting resources from our kit."""
+        data = pkg_resources.resource_string(__name__, path)
+        return data.decode("utf8")
+
+    def _get_model_config_value(self, config_parameter: str, obj: Self = None) -> str | None:
+        """
+        Get configuration value for the model provider with a fallback chain.
+
+        Checks for the value in the following order:
+        1. XBlock field (model_api_key or model_api_url)
+        2. Site configuration
+        3. XBlock settings (defined in Django settings)
+
+        Args:
+            config_parameter: Parameter to retrieve (e.g., "API_KEY" or "API_URL").
+            obj: Optional data object for validation context.
+
+        Returns:
+            The configuration value if found in any of the sources, None otherwise.
+        """
+        obj = obj or self
+        field_name = f"model_{config_parameter}"
+        config_key = f"{SupportedModels(obj.model).name}_{config_parameter.upper()}"
+
+        # XBlock field
+        if value := getattr(obj, field_name, None):
+            return str(value)
+
+        # Site configuration
+        if value := get_site_configuration_value(self.block_settings_key, config_key):
+            return value
+
+        # XBlock settings
+        return self._get_settings().get(config_key)
+
+    def get_model_api_key(self, obj: Self = None) -> str | None:
+        """Get the API key for the model provider."""
+
+        return self._get_model_config_value("api_key", obj)
+
+    def get_model_api_url(self, obj: Self = None) -> str | None:
+        """
+        Get the API URL for the model provider.
+        """
+        return self._get_model_config_value("api_url", obj)
+
+    def validate_field_data(self, validation, data):
+        """
+        Validate fields.
+        """
+
+        if not data.model or data.model not in SupportedModels.list():
+            validation.add(
+                ValidationMessage(
+                    ValidationMessage.ERROR,
+                    _(  # pylint: disable=translation-of-non-string
+                        f"Model field is mandatory and must be one of {', '.join(SupportedModels.list())}"
+                    ),
+                )
+            )
+
+        if not self.get_model_api_key(data):
+            validation.add(
+                ValidationMessage(
+                    ValidationMessage.ERROR, _("Model API key is mandatory, if not set globally by your administrator.")
+                )
+            )
+
+        if data.model == SupportedModels.LLAMA.value and not self.get_model_api_url(data):
+            validation.add(
+                ValidationMessage(
+                    ValidationMessage.ERROR,
+                    _(
+                        "API URL field is mandatory when using ollama/llama2, "
+                        "if not set globally by your administrator."
+                    ),
+                )
+            )
+
+        if data.model != SupportedModels.LLAMA.value and data.model_api_url:
+            validation.add(
+                ValidationMessage(
+                    ValidationMessage.ERROR,
+                    _("API URL field can be set only when using ollama/llama2."),
+                )
+            )
+
+        if not data.question:
+            validation.add(
+                ValidationMessage(
+                    ValidationMessage.ERROR, _("Question field is mandatory")
+                )
+            )