diff --git a/en_us/course_authors/source/course_features/index.rst b/en_us/course_authors/source/course_features/index.rst index 877bbdb1f0..a76baaaf47 100644 --- a/en_us/course_authors/source/course_features/index.rst +++ b/en_us/course_authors/source/course_features/index.rst @@ -20,3 +20,4 @@ see :ref:`Developing Your Course Index`. credit_courses/index timed_exams lti/index + xpert_summaries/index diff --git a/en_us/course_authors/source/course_features/xpert_summaries/index.rst b/en_us/course_authors/source/course_features/xpert_summaries/index.rst new file mode 100644 index 0000000000..413526e921 --- /dev/null +++ b/en_us/course_authors/source/course_features/xpert_summaries/index.rst @@ -0,0 +1,11 @@ +.. _Xpert_Unit_Summaries: + +##################################### +Xpert Unit Summaries +##################################### + +.. toctree:: + :maxdepth: 2 + + summaries_overview + summaries_enabling diff --git a/en_us/course_authors/source/course_features/xpert_summaries/summaries_enabling.rst b/en_us/course_authors/source/course_features/xpert_summaries/summaries_enabling.rst new file mode 100644 index 0000000000..e445aeedef --- /dev/null +++ b/en_us/course_authors/source/course_features/xpert_summaries/summaries_enabling.rst @@ -0,0 +1,50 @@ +.. _Enabling_Xpert_Unit_Summaries: + +##################################### +Enabling Xpert Unit Summaries +##################################### + +.. only:: Partners + + ************************************************* + To enable Xpert Unit Summaries for a course + ************************************************* + + #. In Studio, course team members can navigate to the **Content > Pages & + Resources** menu item in the top navigation menu. + + #. Under the **Content permissions** heading is a box for **Xpert unit + summaries.** + + .. image:: ../../images/summary_content_permissions.png + + #. Clicking the **gear icon** opens the settings modal and allows a + course team member to enable the tool for the entire course. + + #. Toggle on the Expert unit summaries field, select whether you + want to have all of the units enabled on or off by default, and + click **Save.** + + .. image:: ../../images/summary_config_box.png + + + .. note:: The “Reset all units” button can be used if you’ve updated specified units but want to set them all back to their original configuration of all on or all off. + + *************************************************************** + To toggle Xpert Unit Summaries on or off for a specific unit + *************************************************************** + + Unit specific settings are available once summaries have been turned + on for the course. + + #. In Studio, course team members can navigate to the **Outline** menu + item in the top navigation menu. + + #. Navigate to the unit desired to update and click on the **Configure + gear icon.** + + #. Select or deselect the **“Enable summaries”** checkbox and click **Save.** + + .. image:: ../../images/summary_unit_settings.png + + .. note:: By enabling Xpert Unit Summaries, course teams are agreeing to send text-based course content to OpenAI, via API, to be summarized using a generative AI model. Read more about OpenAI’s data privacy practices. diff --git a/en_us/course_authors/source/course_features/xpert_summaries/summaries_overview.rst b/en_us/course_authors/source/course_features/xpert_summaries/summaries_overview.rst new file mode 100644 index 0000000000..d806fb14c4 --- /dev/null +++ b/en_us/course_authors/source/course_features/xpert_summaries/summaries_overview.rst @@ -0,0 +1,30 @@ +.. _Overview_of_Xpert_Unit_Summaries: + +##################################### +Overview of Xpert Unit Summaries +##################################### + +.. only:: Partners + + Xpert Unit Summaries will summarize Text and Video Transcript text + for learners at the end of a unit to reinforce the information that + was contained in the unit. + + When enabled by the course team, learners only need to click the + **Summarize button** at the bottom of the unit to see a condensed + summary of the content. + + .. image:: ../../images/summary_button.png + + .. image:: ../../images/summary_content.png + + Learners can learn more about how the summary was generated by + clicking the **information icon below the summary.** + + Learners can leave feedback about the summary using the **thumbs up + and down** icons at the bottom right of the summary card. This + feedback is only shared with edX for the purpose of improving the + tool. + + .. note:: Not all pages have the Summarize button, as the system automatically selects which units are eligible for summarization based on the amount of text in the unit. + diff --git a/en_us/course_authors/source/images/summary_button.png b/en_us/course_authors/source/images/summary_button.png new file mode 100644 index 0000000000..a9abdda05b Binary files /dev/null and b/en_us/course_authors/source/images/summary_button.png differ diff --git a/en_us/course_authors/source/images/summary_config_box.png b/en_us/course_authors/source/images/summary_config_box.png new file mode 100644 index 0000000000..bb2734250e Binary files /dev/null and b/en_us/course_authors/source/images/summary_config_box.png differ diff --git a/en_us/course_authors/source/images/summary_content.png b/en_us/course_authors/source/images/summary_content.png new file mode 100644 index 0000000000..bfb17b018d Binary files /dev/null and b/en_us/course_authors/source/images/summary_content.png differ diff --git a/en_us/course_authors/source/images/summary_content_permissions.png b/en_us/course_authors/source/images/summary_content_permissions.png new file mode 100644 index 0000000000..c3a53a3038 Binary files /dev/null and b/en_us/course_authors/source/images/summary_content_permissions.png differ diff --git a/en_us/course_authors/source/images/summary_unit_settings.png b/en_us/course_authors/source/images/summary_unit_settings.png new file mode 100644 index 0000000000..13ef7d8cf6 Binary files /dev/null and b/en_us/course_authors/source/images/summary_unit_settings.png differ