Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-82942

AI: Course placement - Explain

XMLWordPrintable

    • MOODLE_500_STABLE
    • MDL-82942-main
    • Hide

      Setup

      1. Login as admin.
      2. Go to Site admin -> AI -> AI providers
      3. Enable 'OpenAI API Provider'
      4. Click on settings for 'OpenAI API Provider'
      5. Enter in a valid API key (reach out if you need assistance)
      6. Ensure 'Explain text' action is enabled (leave the other ones enabled too)
      7. Go to Site admin -> AI -> AI placements
      8. Enable 'Course Assistance Placement'
      9. Click on settings for 'Course Assistance Placement'
      10. Ensure 'Explain text' and 'Summarise text' actions are enabled.

      Test scenario 1

      1. Log in as admin
      2. Restore the attached course backup
      3. Access the course's 'Testing' page resource
      4. CONFIRM you see the 'AI features' dropdown
      5. Access the AI features dropdown and choose 'Explain'
      6. CONFIRM a response is generated
      7. CONFIRM the response appropriately explains the page contents
      8. Click 'Regenerate'
      9. CONFIRM another response is generated
      10. Click close button at the top of the AI drawer
      11. CONFIRM that the AI drawer closes
      12. Choose the 'Explain' option again
      13. CONFIRM that the AI drawer is opened with the previous response (not re-generated)
      14. Close the AI drawer
      15. Choose the 'Summarise' option
      16. CONFIRM that a new response is generated, appropriate for the existing summarise action (should be concise in contrast to the explain action)
      17. Click 'Regenerate' and then click 'Cancel'
      18. CONFIRM the generation is interrupted and the AI drawer closes.
      19. Choose the 'Explain' option again
      20. CONFIRM that the AI drawer opens and is scrolled to the position of the existing explain response.

      Test scenario 2

      1. Go to Site admin -> AI -> AI placements
      2. Click on settings for 'Course Assistance Placement'
      3. Disable the 'Summarise' action
      4. Go back to the restored 'Testing' Page resource
      5. CONFIRM you see only the 'Explain' button
      6. Go to Site admin -> AI -> AI placements
      7. Click on settings for 'Course Assistance Placement'
      8. Disable the 'Explain' action
      9. Enable the 'Summarise' action
      10. Go back to the restored 'Testing' Page resource
      11. CONFIRM you see only the 'Summarise' button
      Show
      Setup Login as admin. Go to Site admin -> AI -> AI providers Enable 'OpenAI API Provider' Click on settings for 'OpenAI API Provider' Enter in a valid API key (reach out if you need assistance) Ensure 'Explain text' action is enabled (leave the other ones enabled too) Go to Site admin -> AI -> AI placements Enable 'Course Assistance Placement' Click on settings for 'Course Assistance Placement' Ensure 'Explain text' and 'Summarise text' actions are enabled. Test scenario 1 Log in as admin Restore the attached course backup Access the course's 'Testing' page resource CONFIRM you see the 'AI features' dropdown Access the AI features dropdown and choose 'Explain' CONFIRM a response is generated CONFIRM the response appropriately explains the page contents Click 'Regenerate' CONFIRM another response is generated Click close button at the top of the AI drawer CONFIRM that the AI drawer closes Choose the 'Explain' option again CONFIRM that the AI drawer is opened with the previous response (not re-generated) Close the AI drawer Choose the 'Summarise' option CONFIRM that a new response is generated, appropriate for the existing summarise action (should be concise in contrast to the explain action) Click 'Regenerate' and then click 'Cancel' CONFIRM the generation is interrupted and the AI drawer closes. Choose the 'Explain' option again CONFIRM that the AI drawer opens and is scrolled to the position of the existing explain response. Test scenario 2 Go to Site admin -> AI -> AI placements Click on settings for 'Course Assistance Placement' Disable the 'Summarise' action Go back to the restored 'Testing' Page resource CONFIRM you see only the 'Explain' button Go to Site admin -> AI -> AI placements Click on settings for 'Course Assistance Placement' Disable the 'Explain' action Enable the 'Summarise' action Go back to the restored 'Testing' Page resource CONFIRM you see only the 'Summarise' button
    • Hide

      Code verified against automated checks with warnings.

      Checked MDL-82942 using repository: https://github.com/davewoloszyn/moodle.git

      Should these errors be fixed?

      Built on: Thu Feb 20 01:11:04 AM UTC 2025

      Show
      Code verified against automated checks with warnings. Checked MDL-82942 using repository: https://github.com/davewoloszyn/moodle.git main (0 errors / 9 warnings) [branch: MDL-82942-main | CI Job ] overview (0/1) , phplint (0/0) , phpcs (0/0) , js (0/0) , css (0/0) , phpdoc (0/0) , commit (0/0) , savepoint (0/0) , thirdparty (0/0) , externalbackup (0/2) , grunt (0/0) , shifter (0/0) , mustache (0/6) , gherkin (0/0) , Warn: the branch is based off integration.git Should these errors be fixed? Built on: Thu Feb 20 01:11:04 AM UTC 2025
    • Show
      Launching automatic jobs for branch MDL-82942 -main https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/17673/ PHPUnit (sqlsrv) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/60205/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/60206/ Behat (Firefox - boost) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/60207/ Behat (Firefox - classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/60208/ App tests (stable app version) Built on: Tue Dec 10 06:25:43 UTC 2024
    • 10
    • Team Hedgehog 2024 Sprint 4.2, Team Hedgehog 2024 Sprint 4.3, Team Hedgehog 2025 Sprint 1.0, Team Hedgehogs 2025 Sprint 1.1, Team Hedgehogs 2025 Sprint 1.2

      Add the ability for AI to explain text to users in addition to summarising text for the course placement.

      MDL-80890 introduces the course assistant placement and the summarize functionality. To further assist students we should extend this functionality with explain.

      The broad deliverables for this work are:

      1. Extend the UI CTA to have an "explain" option
      2. Make both the Summarise and Explain actions discrete choices in the UI CTA
      3. Add an explain action to the core subsystem
      4. Extend the existing provider plugins that support the summarise action to also support the explain action

      For points 1 & 2, existing UI designs already exist as they were created int eh course assist placement discovery

        1. (1) 11 Passed -- (Main)MDL-82942.png
          126 kB
          Kim Jared Lucas
        2. (1) 13 Passed -- (Main)MDL-82942.png
          193 kB
          Kim Jared Lucas
        3. (1) 16 Passed -- (Main)MDL-82942.png
          210 kB
          Kim Jared Lucas
        4. (1) 18 Passed -- (Main)MDL-82942.png
          122 kB
          Kim Jared Lucas
        5. (1) 20 Passed -- (Main)MDL-82942.png
          180 kB
          Kim Jared Lucas
        6. (1) 4 Passed -- (Main)MDL-82942.png
          102 kB
          Kim Jared Lucas
        7. (1) 7 Passed -- (Main)MDL-82942.png
          225 kB
          Kim Jared Lucas
        8. (1) 9 Passed -- (Main)MDL-82942.png
          231 kB
          Kim Jared Lucas
        9. (2) 11 Passed -- (Main)MDL-82942.png
          89 kB
          Kim Jared Lucas
        10. (2) 5 Passed -- (Main)MDL-82942.png
          68 kB
          Kim Jared Lucas
        11. Ai-courseplacement-dropdown.jpg
          771 kB
          Robert van_Garderen
        12. backup-moodle2-course-2-c1-20241202-0016-nu.mbz
          7 kB
          David Woloszyn
        13. stack-example.png
          341 kB
          David Woloszyn

            david.woloszyn@moodle.com David Woloszyn
            matt.porritt@moodle.com Matt Porritt
            Stevani Andolo Stevani Andolo
            Shamim Rezaie Shamim Rezaie
            Kim Jared Lucas Kim Jared Lucas
            Votes:
            1 Vote for this issue
            Watchers:
            13 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - 0 minutes
                0m
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 4 days, 3 hours, 9 minutes
                4d 3h 9m

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.