Quiz Generator is a plugin for Obsidian that leverages the power of OpenAI's GPT-3.5 and GPT-4 models to automatically generate interactive, exam-style questions (with answers) based on your notes. Whether you're a student looking to quiz yourself or an educator creating assessments, this plugin streamlines the question creation process.
- Personalized Questions: Select any combination of notes and folders to use as the quiz content.
- Customizable Generation: Choose the type(s) and number of questions to generate.
- Multiple Question Types: Multiple choice, true/false, and short answer are all supported. Mix and match them to best suit your needs for an effective assessment.
- Interactive UI: Answer generated questions in an interactive UI that provides real-time feedback on correctness.
- Question Saving: Save generated questions in either (or both) of the following formats.
- Inline and multiline flashcards to review with obsidian-spaced-repetition.
- Markdown callouts for seamless integration with your notes.
- Reviewable Quizzes: Review saved questions using the interactive UI (you can also create your own questions from scratch and open them in the UI without ever using the generator).
- Multiple Languages: Generate questions in the same language as your notes.
- Math Support: Generate questions from notes that contain LaTeX.
- Model Options: Choose between OpenAI's latest GPT-3.5 and GPT-4 models, depending on your needs.
- Use
GPT-3.5(16,385 token context window) for faster response times and efficient question generation with a moderate context window. - Use
GPT-4(128,000 token context window) for more extensive content and in-depth question generation, suitable for complex educational materials and detailed assessments.
- Use
This plugin is now available in the Community plugins page in Obsidian. You can install it using either of the following methods.
- Install the plugin from the Community plugins page in Obsidian.
- Settings → Community plugins → Browse.
- Search for
Quiz Generator. - Select the plugin to open its page and then select Install.
- Select Enable on the plugin page or go back to the Community plugins page and toggle the switch.
- Open the plugin settings and enter your API key.
- Configure the other settings as desired.
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Go to your Obsidian vault's
pluginsfolder and create a new folder namedquiz-generator. - Move the files you downloaded in step 1 to this folder.
- Enable the plugin in the Community plugins page in Obsidian.
- Open the plugin settings and enter your API key.
- Configure the other settings as desired.
- Open the command palette and select "Quiz Generator: Open generator" or select the brain-circuit icon in the left sidebar.
- Use the file and folder icons to add notes and folders.
- Adding a folder adds all of the notes inside it, as well as any notes in its subfolders. If you select an extremely large folder (thousands of files and hundreds of subfolders), it could take a few seconds for it to be added.
- Use the x icon to remove individual notes/folders and the book icon to remove everything.
- Once you've added your notes and/or folders, select the webhook icon to generate the questions.
- The Quiz UI will open automatically when the generation is complete (it usually takes at least a few seconds).
- The generation time may vary based on the length of your notes and the number of questions to generate.
- Saved questions will be in a Markdown file named "Quiz [number]" in the folder specified by the "Save location" setting.
- Select the save icon to save the current question.
- Select the save-all icon to save all questions.
- If the "Automatically save questions" setting is enabled, all questions will be immediately saved upon generation.
- Open the command palette and select "Quiz Generator: Open quiz from current note" or right-click a note in the file explorer and select "Open quiz from this note" in the file menu.
If you want to modify any saved questions or write your own questions from scratch, they must follow the format below to be opened in the interactive UI. Any text not enclosed by quotation marks must be written exactly as shown. However, deviations in spacing and capitalization are okay (the parser is case-insensitive and ignores whitespace). Text enclosed by quotation marks can be anything.
> [!question] "Multiple choice question goes here"
> a) "Choice 1"
> b) "Choice 2"
> c) "Choice 3"
> d) "Choice 4"
>> [!success]"- Answer"
>> One of a), b), c), or d) "You may optionally add the text of the correct choice in addition to the letter"
> [!question] "True/false question goes here"
> True or false?
>> [!success]"- Answer"
>> One of true or false
> [!question] "Short answer question goes here"
>> [!success]"- Answer"
>> "Answer goes here"
Note: The hyphen being inside the quotations marks in the nested callout is not a typo. It's optional whether you include it or not.
Example
> [!question] In the realm of artificial intelligence ethics, consider the development of autonomous weapon systems (AWS). Advocates argue that AWS can minimize human casualties in warfare, while critics express concerns about the lack of human control and potential ethical implications. Applying an ethical framework, which option aligns with a consequentialist perspective?
> a) Reject the use of AWS to preserve human control and uphold moral principles.
> b) Implement strict regulations and oversight to balance the benefits and risks of AWS.
> c) Embrace AWS deployment to reduce overall casualties and enhance military effectiveness.
> d) Encourage international collaboration to establish a global consensus on AWS usage.
>> [!success]- Answer
>> c) Embrace AWS deployment to reduce overall casualties and enhance military effectiveness.
> [!question] In the context of the nature vs. nurture debate in psychology, the consensus among researchers is that intelligence is solely determined by genetic factors.
> True or false?
>> [!success]- Answer
>> False
> [!question] Explain the concept of the "butterfly effect" in chaos theory and provide an example illustrating its significance.
>> [!success]- Answer
>> The "butterfly effect" is a phenomenon in chaos theory that suggests small initial changes can lead to vastly different outcomes over time. It is metaphorically expressed as the idea that the flap of a butterfly's wings in Brazil could set off a chain of events leading to a tornado in Texas. Essentially, tiny variations in the initial conditions of a complex system can have profound and unpredictable effects on its future state. An example of the butterfly effect is the weather, where a minor disturbance can influence atmospheric conditions, potentially leading to significant changes in weather patterns over time.
**Multiple Choice:** "Multiple choice question goes here"
a) "Choice 1"
b) "Choice 2"
c) "Choice 3"
d) "Choice 4"
Multiline separator you chose in the settings goes here
One of a), b), c), or d) "You may optionally add the text of the correct choice in addition to the letter"
**True/False:** "True/false question goes here" Inline separator you chose in the settings goes here One of true or false
**Short Answer:** "Short answer question goes here" Inline separator you chose in the settings goes here "Answer goes here"
Example
**Multiple Choice:** In the realm of artificial intelligence ethics, consider the development of autonomous weapon systems (AWS). Advocates argue that AWS can minimize human casualties in warfare, while critics express concerns about the lack of human control and potential ethical implications. Applying an ethical framework, which option aligns with a consequentialist perspective?
a) Reject the use of AWS to preserve human control and uphold moral principles.
b) Implement strict regulations and oversight to balance the benefits and risks of AWS.
c) Embrace AWS deployment to reduce overall casualties and enhance military effectiveness.
d) Encourage international collaboration to establish a global consensus on AWS usage.
?
c) Embrace AWS deployment to reduce overall casualties and enhance military effectiveness.
**True/False:** In the context of the nature vs. nurture debate in psychology, the consensus among researchers is that intelligence is solely determined by genetic factors. :: False
**Short Answer:** Explain the concept of the "butterfly effect" in chaos theory and provide an example illustrating its significance. :: The "butterfly effect" is a phenomenon in chaos theory that suggests small initial changes can lead to vastly different outcomes over time. It is metaphorically expressed as the idea that the flap of a butterfly's wings in Brazil could set off a chain of events leading to a tornado in Texas. Essentially, tiny variations in the initial conditions of a complex system can have profound and unpredictable effects on its future state. An example of the butterfly effect is the weather, where a minor disturbance can influence atmospheric conditions, potentially leading to significant changes in weather patterns over time.
- Select the scroll icon in the Generator UI to re-open the most recently generated quiz.
I'm actively working on bringing more features and improvements to Quiz Generator. Stay tuned for the following upcoming updates:
- Improved Folders: Click added folders to view the notes they contain.
- Improved Notes: Click added notes to view their contents.
- More Question Types: Fill in the blank, matching, essay/long answer, and select all that apply.
- Dynamic Analysis: Get real-time feedback on your response to short/long answer questions.
- More Models: Support for local LLM's and other LLM providers.
- Better Question Creation: Custom UI to streamline creating your own questions from scratch.
- Adjustable Difficulty: Set the difficulty of generated questions.
- Tag Adder: Add notes by tag.
- Dataview Adder: Add notes using Dataview queries.
- Advanced Question Types: Numerical response and image-based.
- Note Links: Adding a note also adds the notes it links to.
- Extended Files: Generate questions from PDF and image files.
- Question Variety: Customization options to control the question style and what it assesses.
- Quality of Life: Reducing token usage while improving question quality.
Make sure the combined token count of your input (selected notes/folders) and expected output (generated questions) does not exceed the context window of your chosen model. Otherwise your input and/or output will be truncated. The number of input tokens is shown in the Generator UI. For the number of output tokens, on average, a multiple choice question is ~60 tokens, a true/false question is ~30 tokens, and a short answer question is ~100 tokens. I recommend leaving at least 10% of the context window unused to be safe.
If you encounter any errors or have feature requests, please open an issue on the GitHub repository.
