Skip to content

Commit

Permalink
socratiQ and widget updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kai4avaya committed Nov 18, 2024
1 parent 9bc2230 commit 9646aef
Show file tree
Hide file tree
Showing 9 changed files with 2,578 additions and 6 deletions.
2 changes: 1 addition & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ format:
include-in-header:
text: |
<script async src="https://www.googletagmanager.com/gtag/js?id=G-M21L0CBCVN"></script>
<script src="/scripts/ai_menu/dist/bundle.js" defer></script>
<script type="module" src="/scripts/ai_menu/dist/bundle.js" defer></script>
# <script src="/scripts/ai_menu/dist/142.bundle.js" defer></script>
# <script src="/scripts/ai_menu/dist/384.bundle.js" defer></script>
# <script src="/scripts/ai_menu/dist/761.bundle.js" defer></script>
Expand Down
Binary file added contents/ai/images/gif/Reference.gif
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.
Binary file added contents/ai/images/png/download_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/ai/images/png/prev_conversations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/ai/images/png/quiz_button2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/ai/images/png/top_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 52 additions & 3 deletions contents/ai/socratiq.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ Please note that this is an experimental feature. We are experimenting with the
**About AI Responses**: While SocratiQ uses advanced AI to generate quizzes and provide assistance, like all AI systems, it may occasionally provide imperfect or incomplete answers. However, we've designed and tested it to ensure it's effective for supporting your learning journey. If you're unsure about any response, refer to the textbook content or consult your instructor.
:::

You can enable SocratiQ by clicking the button below:

[Activate SocratiQ]{.btn .btn-success onclick="window.location.href = window.location.pathname + '?widget_access=true'"}

At anytime, you can deacticate SocratiQ by clicking this button:

[Deactivate SocratiQ]{.btn .btn-warning onclick="window.location.href = window.location.pathname + '?widget_access=false'"}

:::{.callout-tip}
## Quick URL Access
You can directly control SocratiQ by adding these parameters to your URL:

- To activate: [mlsysbook.ai/?widget_access=true](https://mlsysbook.ai/?widget_access=true)
- To deactivate: [mlsysbook.ai/?widget_access=false](https://mlsysbook.ai/?widget_access=false)

This gives you quick access to toggle SocratiQ's functionality directly from your browser's address bar.
:::


Once you've enabled SocratiQ it will always be available when you visit this site.

You can access SocratiQ at any time using a keyboard shortcut shown in @fig-main-shortcut, which brings up the interface shown in @fig-main-interface.

![Keyboard shortcut for SocratiQ.](images/png/shortcut.png){#fig-main-shortcut}
Expand All @@ -23,11 +44,16 @@ Before diving into your studies, take a moment to configure SocratiQ for your ac

![The settings panel where you can customize SocratiQ to match your academic level.](images/png/settings.png){#fig-settings-panel}

You can augment any AI SocratiQ response using the dropdown menu at the top of each message.

![Redo an AI message by choosing a new experience level..](images/gif/adjust_message_difficulty.gif){#fig-adjust_message_difficulty}


## Learning with SocratiQ

As you progress through each section of the textbook, you'll find automatically generated quizzes designed to reinforce key concepts. These quizzes typically contain 3-5 questions, carefully crafted to check your understanding of the material you've just covered, as shown in @fig-quiz-interface.

![A typical quiz interface showing AI-generated questions.](images/png/quiz_button.png){#fig-quiz-interface}
![Quizzes are generated at the end of every section.](images/png/quiz_button2.png){#fig-quiz-interface}

After submitting your answers, SocratiQ provides immediate feedback and detailed explanations for each question, as demonstrated in @fig-quiz-feedback.

Expand All @@ -45,6 +71,12 @@ Once you've selected the text, you can ask questions about it, and SocratiQ will

@fig-interactive-chat shows the response for the ask in @fig-context-explanation.

Additionally, you can also reference Sections, Sub-sections and keywords directly as you converse with SocratiQ. Use the `@` symbol to reference a section, sub-section or keyword.
You can also click the `+ Context` button right above the input.

![Referencing different sections from the textbook.](images/gif/Reference.gif){#reference-sections}


![An interactive chat session with SocratiQ, demonstrating how to get clarification on concepts.](images/png/chat_explanation.png){#fig-interactive-chat}

To enhance your learning experience, SocratiQ doesn't just answer your questions---it also suggests related content from the textbook that might be helpful for deeper understanding, as shown in @fig-related-content.
Expand All @@ -61,12 +93,29 @@ As you continue to engage with the material and complete quizzes, you'll earn va

![Examples of achievement badges you can earn through consistent engagement.](images/png/badges.png){#fig-achievement-badges}

If you'd like a record of your progress you can generate a PDF report. It will show your progress, average performance and all the questions you've attempted. The PDF is a generated with a unique hash and can be uniquely validated.

![You can click the Download Progress Report button to view your report. You can verify that your PDF has been created by SocratiQ by clicking the verify button and uploading your generate PDF. ](images/png/download_report.png){#fig-download-report}

## Button Overview

The top nav bar provices quick access to 1) New or saved conversations with SocratiQ. 2) View or generate your progress report. 3) Adjust your settings.

![View of the top nav menu. ](images/png/top_menu.png){#fig-top-menu}


## Data Storage

:::{.callout-important}
**Important Note**: All progress data is stored locally in your browser. Clearing your browser history or cache will erase your entire learning history, including quiz scores, streaks, and achievement badges. Please keep this in mind before clearing browser data.
:::

You can also delete all of your saved conversations by clicking the New Chat button in the nav bar.

![Load or delete previous chats or start a new chat. ](images/png/prev_conversations.png){#fig-previous-conversations}



## Technical Requirements

To use SocratiQ effectively, you'll need:
Expand All @@ -77,8 +126,8 @@ To use SocratiQ effectively, you'll need:

## Providing Feedback

Your feedback helps us improve SocratiQ. You can report technical issues, suggest improvements to quiz questions, or share thoughts about AI responses using the feedback buttons located throughout the interface, as shown in @fig-feedback-interface.
Your feedback helps us improve SocratiQ. You can report technical issues, suggest improvements to quiz questions, or share thoughts about AI responses using the feedback buttons located throughout the interface.

![The location of feedback buttons and how to submit your suggestions.](images/png/buttons.png){#fig-feedback-interface}
[Share Your Feedback]{.btn .btn-primary onclick="window.open('https://docs.google.com/forms/d/e/1FAIpQLSeK8RXgc6kbT1IbWVLjyUhwowp3x1ySbAjUQQqztdDs5ccmmQ/viewform?embedded=true', '_blank')"}

Remember: SocratiQ is designed to help you learn effectively. By consistently engaging with the quizzes, asking questions when needed, and tracking your progress, you'll get the most out of this AI learning assistant.
2,527 changes: 2,525 additions & 2 deletions scripts/ai_menu/dist/bundle.js

Large diffs are not rendered by default.

0 comments on commit 9646aef

Please sign in to comment.