Skip to content

Conversation

@Henrrypg
Copy link
Contributor

@Henrrypg Henrrypg commented Dec 23, 2025

This pull request introduces support for custom system prompts in the AI extensions processors, allowing for greater flexibility when configuring prompt behavior. The main changes ensure that a custom prompt, if provided in the configuration, is used in place of the default system role in relevant API calls.

Custom Prompt Handling:

  • Added a custom_prompt attribute to the litellm_base_processor.py class, initialized from the configuration if present.

Prompt Usage in API Calls:

  • Updated _build_response_api_params in llm_processor.py to use self.custom_prompt as the system prompt if it exists, otherwise defaulting to the original system_role.
  • Updated _call_completion_wrapper in llm_processor.py to use self.custom_prompt as the system prompt if it exists, otherwise defaulting to the original system_role.

How to test

You can setup prompt in LLMProcessor or EducatorAssistantProcessor via AIWorkflowProfile overrides

image

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 23, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @Henrrypg!

This repository is currently maintained by @felipemontoya.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov
Copy link

codecov bot commented Dec 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.09%. Comparing base (c3ea4c2) to head (d03d9d2).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #77      +/-   ##
==========================================
+ Coverage   89.80%   90.09%   +0.28%     
==========================================
  Files          46       46              
  Lines        4041     4129      +88     
  Branches      264      266       +2     
==========================================
+ Hits         3629     3720      +91     
+ Misses        321      320       -1     
+ Partials       91       89       -2     
Flag Coverage Δ
unittests 90.09% <ø> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Henrrypg Henrrypg force-pushed the hpg/override_prompts branch from cde23d9 to 760b11d Compare December 23, 2025 14:55
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Dec 23, 2025
Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple and efective.

Combining this with the flexibility of json5 is fantastic.

The one thing I would like is to add a new base template for this. I would call it base.box_custom_prompt

{
  "orchestrator_class": "DirectLLMResponse",
  "processor_config": {
    "LLMProcessor": {
      "stream": true,
      "prompt": "\
You are an educational assistant embedded in an online course. \
 \
Rephrase the given content using different wording while preserving the original meaning, intent, and factual accuracy. \
 \
Guidelines: \
- Do not add new information. \
- Do not remove important details. \
- Do not simplify unless explicitly asked. \
- Keep the length roughly similar to the original. \
- Use clear, natural language suitable for the course audience. \
- Avoid repeating sentence structures or phrases from the original text. \
 \
Output only the rephrased content. \
",
    }
  },
}

@Henrrypg Henrrypg force-pushed the hpg/override_prompts branch from 41164f4 to df95048 Compare December 23, 2025 21:10
@felipemontoya
Copy link
Member

Thank you @Henrrypg for taking charge of the QA for this PR

@felipemontoya felipemontoya merged commit c4a03d7 into openedx:main Dec 23, 2025
9 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants