Skip to content

Commit 52e0217

Browse files
committed
Added simple docs for those that are missing.
1 parent d2b13f4 commit 52e0217

File tree

7 files changed

+67
-1
lines changed

7 files changed

+67
-1
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Boolean
2+
3+
This response area allows students to select True or False.
4+
5+
## Evaluation Function Options
6+
7+
### `isExactEqual`
8+
9+
Checks if the answer is exactly equal to the response. In this case if the response is True or False.
10+
The `type` should be set to `bool`, to ensure boolean comparison.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Code
2+
3+
This response area allows students to write code for a specified programming language.
4+
5+
## Evaluation Function Options
6+
7+
### `chatGPT (experimental)`
8+
9+
Passes the student's response and a teacher written prompt to GPT for evaluation.
10+
11+
12+
### `compareContsructs (experimental)`
13+
Python Only. Compares console output to a teacher's provided answer and comparing the structure of the teacher's solution to the student provided responses.
14+
Student functions can also be ran against a set of teacher provided unit tests, if these fails, feedback can be generated by GPT if enabled.
15+
It also provides feedback on syntax and style.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Essay
2+
3+
Similar to [!Text](Text.md), allows student's to enter any text input, whether that be prose, math, code or any other type of input, but in a longer format.
4+
5+
## Evaluation Function Options
6+
7+
As text supports any input, so most evaluation functions can be used.
8+
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.
9+
10+
### `chatGPT (experimental)`
11+
12+
Passes the student's response and a teacher written prompt to GPT for evaluation.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Likert
2+
3+
Allows students to fill in a five point Likert (Strongly Disagree to Strongly Agree) for any number of statements.
4+
5+
## Evaluation Function Options
6+
7+
Currently, there is no supported evaluation functions for this response area.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Milkdown
2+
3+
Similar to [!Essay](Essay.md), allows student's to enter any text input, but with standard Markdown processing, including headers, bullet points, numbers, table, etc.
4+
5+
## Evaluation Function Options
6+
7+
Currently, there is no supported evaluation functions for this response area.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
11
# Text
2+
3+
Allows student's to enter any text input, whether that be prose, math, code or any other type of input.
4+
5+
## Evaluation Function Options
6+
7+
As text supports any input, any evaluation function can be used.
8+
However, there are some text specific evaluation functions, such as shortTextAnswer and chatGPT.
9+
10+
### `chatGPT (experimental)`
11+
12+
Passes the student's response and a teacher written prompt to GPT for evaluation.
13+
14+
### `shortTextAnswer (experimental)`
15+
Uses natural language processing techniques to calculate the similarity between a student's response and a teacher's answer, using semantic similarity.

docs/teacher/reference/response_area_components/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ This opens the **Response Area Panel**, separated into four tabs:
5454
- Text (for short text answers)
5555
- Table
5656
- Multiple-choice
57-
- Expression (gives a preview for the typed symbolic expression)
57+
- MATH_SINGLE_LINE
58+
- MATH_MULTI_LINE
5859
- Numeric units (separate fields for a number and its units)
5960
- Code
6061
- Essay (for long text answers)

0 commit comments

Comments
 (0)