> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/platform/collections/generated-attempts.md).

# Generated attempts

Generated attempts let students create their own practice tests from the quiz questions in a collection. You decide which choices are available—such as mode, length and topic—and the student chooses from those options before starting.

{% hint style="info" %}
**Location:** Collections → select a collection → Configure → Allow generated attempts
{% endhint %}

### What students see

When generated attempts are enabled, **Generate attempt** appears in both Cards and Player views. The setup window only shows the choices you have allowed.

![The Generate attempt window showing the choices available to a student and the number of matching questions](https://3891068282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2Fu55pepCYvXfghEDDhl5P%2Fgenerated-attempt.png?alt=media\&token=5b7257d5-4b45-4bd2-ad96-41b68f8a6623)

Before the test is created, Synap shows how many questions it will contain and how many currently match the student's choices. If no questions match, the student cannot start the test.

### Where the questions come from

Synap gathers questions from the quiz items in the collection. Questions from locked quiz placements are not included. It then applies the student's tag or mastery choices and creates a test up to the selected length.

The selected length is a maximum. Synap does not invent or repeat questions to reach it. If 13 questions match and the chosen length allows 20, the test contains 13 questions.

{% hint style="warning" %}
The available questions can change when you edit a quiz, its questions, tags, lock status or placement in the collection. Recheck important topic combinations after updating the source content.
{% endhint %}

### Modes and lengths

| Mode           | What it means for the student                                                             |
| -------------- | ----------------------------------------------------------------------------------------- |
| **Practice**   | A learning-focused attempt using your portal's practice behaviour and feedback.           |
| **Exam**       | An exam-style attempt, with feedback and results controlled by the settings on this page. |
| **Timed exam** | An exam-style attempt with a timer where this is available on your portal.                |

Only the modes you select appear. If you allow one mode, it is used automatically. If you allow several, the student chooses before starting.

| Length         | What it means for the student                                |
| -------------- | ------------------------------------------------------------ |
| **Short**      | A quick test from the matching questions.                    |
| **Medium**     | A longer test using more of the matching questions.          |
| **Long**       | A substantial test, limited by the questions available.      |
| **Extra long** | The largest generated-test option configured for the portal. |

The exact question count can be smaller than the selected length when only a few questions match the student's filters.

### Quiz players

If your portal has more than one quiz player, you can choose which ones students may use. A player choice only appears when more than one is allowed. This controls the interface used during the quiz; it is separate from the collection's Cards or Player layout.

### Tags, facets and mastery

Tags and facets let students narrow a test to the areas they want to practise.

| Setting                          | What it changes in the student setup                                                                                                        |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| **Allowed facets**               | Chooses which classifications—such as Subject, Topic, Subtopic, Difficulty or Skill—students can use. Your portal may use different labels. |
| **Allowed tag sets**             | Chooses which groups of tags are available.                                                                                                 |
| **Display mode**                 | Shows tag choices as a dropdown or a set of toggles.                                                                                        |
| **Allow multiple tag selection** | Lets students choose more than one value where supported.                                                                                   |
| **Exclude untagged questions**   | Removes questions that do not have an applicable tag.                                                                                       |
| **Show mastery filters**         | Lets students use their recorded mastery state where Study is available.                                                                    |

The matching question count updates as the student changes their choices. This makes it clear how much content is available before they start.

![The admin settings for choosing which modes, lengths, players and tags students can select](https://3891068282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2FfGtxx5NDO6srXKAm2cyL%2Fgenerated-attempt-settings.png?alt=media\&token=317d162e-bf9d-4f99-814b-7d01f2e19312)

### Tools available during the test

You can choose which tools are available during tests generated from this collection:

| Tool               | Options                                                                |
| ------------------ | ---------------------------------------------------------------------- |
| **Calculator**     | None, Standard or Scientific.                                          |
| **Notepad**        | Show or hide.                                                          |
| **Strike-through** | Show or hide the option-elimination tool.                              |
| **Highlighting**   | Show or hide text highlighting.                                        |
| **Bookmarking**    | Show or hide bookmarks.                                                |
| **Lab values**     | Show or hide the lab-values tool and provide its content when enabled. |
| **Flagging**       | Show or hide question flagging.                                        |

These choices only affect tests generated from this collection. They do not change the original quizzes.

### Results page

The results settings determine what students see after their results are released.

![The admin settings that control scores, question review and cohort information on generated-attempt results](https://3891068282-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2FouM7YrJNKpn2fIkyStIv%2Fgenerated-attempt-results.png?alt=media\&token=a87f246f-e5e2-4232-bcb7-ea69c22459bc)

#### Individual results

| Setting        | Information shown                                       |
| -------------- | ------------------------------------------------------- |
| **Score**      | Overall percentage and number of correct answers.       |
| **Time spent** | Time taken to complete the attempt.                     |
| **Grade**      | The grade and pass or fail result when grading applies. |

#### Question review

| Level                       | What the student can see                                                                              |
| --------------------------- | ----------------------------------------------------------------------------------------------------- |
| **Full question breakdown** | Question text, answer options, feedback, correct answers, tags and IDs.                               |
| **Hide correct options**    | Question text, options and feedback, but not the correct option after an incorrect answer.            |
| **Hide question content**   | Answer letters and correctness without the question or option text. Some metadata may remain visible. |
| **Hide question breakdown** | No question content, feedback or tags.                                                                |

{% hint style="warning" %}
A full question breakdown reveals the questions and correct answers. Consider this carefully when students will generate repeated tests from the same question bank.
{% endhint %}

#### Cohort and tag information

Cohort metrics can include the average score, percentile and score distribution. Tag metrics can show performance by subject or topic and progress over time. You can include every available facet or only selected ones.

#### Other results controls

* **Educators can view full admin results page** lets educator roles see the full administrative results page where supported.
* **Hide title** removes the standard heading above your completion message.
* **When a candidate has completed their attempt** adds a rich-text message with any next steps you want to show.

### After the student selects Generate attempt

Synap selects matching questions, creates a new test using the chosen mode and quiz player, and takes the student to it. The attempt remains linked to the collection, so you can find it later from the collection's **Attempts** page.

### Check the student experience

After changing these settings, preview the collection and check:

* every mode and length you have allowed;
* a broad and a narrow tag selection;
* what happens when no questions match;
* the player and tools shown during the test; and
* the question review and metrics shown after completion.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synap.ac/docs/platform/collections/generated-attempts.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
