Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add xpert summaries overview and enabling to partner docs #2191

Merged
merged 1 commit into from
Sep 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions en_us/course_authors/source/course_features/index.rst
Original file line number Diff line number Diff line change
@@ -20,3 +20,4 @@ see :ref:`Developing Your Course Index`.
credit_courses/index
timed_exams
lti/index
xpert_summaries/index
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _Xpert_Unit_Summaries:

#####################################
Xpert Unit Summaries
#####################################

.. toctree::
:maxdepth: 2

summaries_overview
summaries_enabling
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe Unit Summaries toggle won't be visible unless the Xpert Unit Summaries is turned on for the whole course. Is that right? If so, could you note that here?

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.
Original file line number Diff line number Diff line change
@@ -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.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.