Feedback Aide Model Options

Model options allow configuration of the specific model parameters that are available in Feedback Aide Models.

Different models and different rubric types will accept different options and silently ignore options that not relevant to it.

In the JavaScript API, the model options should be added when initializing a feedback session with the feedbackApp.feedbackSession() method. If using the RESTFul API, it can be passed via the options parameter on the evaluate endpoints.

Language

language configuration options for outputs from models.

Property Details

feedback

(string)

Set the language which feedback will be returned in.

Default: en

Languages are input as 2 letter ISO 639-1 codes.
Currently supported languages for feedback are:

  • en or en-us English US
  • fr: French
  • es: Spanish
  • pt: Portuguese
  • it: Italian
  • de: German
  • zh: Chinese
  • id: Indonesian
  • jp: Japanese
  • kr: Korean

Preview support languages

These are allowed options, but have not been tested and results may vary in quality based on language.

  • ar: Arabic
  • en-gb:  English with United Kingdom spelling
  • fi: Finnish
  • sv: Swedish
  • no: Norwegian
  • da: Danish
  • nl: Dutch
  • pl: Polish
  • pt-br: Portuguese (Brazil)

See also the article on Internationalization for Feedback aide to customize the interface elements.

Grading

grading configuration options to provide context to the model about the learner level and the marking style required for this evaluation.

Property Details

learner_level

(string)

Learner level - provides hints to the model about the expected level of the learner response which can improve accuracy

academic-1: Junior school - ISCED 1 - Primary education (age 6-10)
academic-2: Middle school - ISCED 2 - Lower secondary education (age 11-14)
academic-3: High School - ISCED 3 - Upper secondary education (age 15-18)
academic-4: Post-secondary non-tertiary education - ISCED 4  - trades, apprenticeships etc.
academic-5: University Level - ISCED 5-8 - University education (Bachelors level and above)
business-general: For general business writing and communications

Default: academic-3

marking_style

(string)

generous: Generous marking style which is more lenient and good for more supportive learning environments.
balanced: Balanced marking style.
harsh: Harsher marking style for higher stakes assessments or scenarios where appropriate.

Default: balanced

Available on standard-essay-2025-03-14 and advanced-essay-2025-03-14 and newer models.

Thinking

thinking configuration options for enabling the model to return an explanation of its decisions.

Property Details

return_thinking

(boolean)

Enable or disable the return of the models combined 'thinking'. In its current form this is a raw unprocessed return.

Default: false

Available on 2025-03-14 and newer models.

Moderation (Essay only)

moderation configuration options for moderation - see Content moderation with Feedback Aide

Property Details

enabled

(boolean)

Enable or disable content moderation checking.

Default: false

Note: Moderation is available on advanced-essay models only.

Topic Checking (Essay only)

topic_check Check if the essay is on a topic related to the question.

Property Details

enabled

(boolean)

Enable or disable topic checking.

Default: true

relatedness

(integer)

Relatedness level from 0 to 4 to determine if the essay is on topic. Anything below the selected level will be flagged as off topic.

Note: setting this to 0 will flag all essays as on topic so it is preferable to set enabled:false instead and skip the check entirely
0: Not related
1: Slightly related
2: Moderately related
3: Highly related
4: Completely related

Default: 1

Available on 2024-11-22 and newer models.

Structure Checking (Essay only)

structure_check Check if the essay matches the required structure - checks for the minimum number of paragraphs.

Property Details

enabled

(boolean)

Enable or disable structure checking.

Default: false

min_paragraphs

(integer)

Check the minimum number of paragraphs. If there are less than this number then it will be flagged as not_scorable.

Default: 1

min_paragraph_words

(integer)

Set the minimum number of words required for a 'paragraph' to be counted as a paragraph. 

Default: 6

paragraph_mode

(string)

Mode of checking paragraphs.

simple splits on document structure based on newlines or paragraph tags.
advanced uses AI to separate paragraphs.

Default: simple

Available on 2024-11-22 and newer models.

Citation Checking (Essay only)

citation_check Check if the essay has the required number of citations.

Property Details

enabled

(boolean)

Enable or disable citation checking.

Default: false

min_in_text_citations

(integer)

Check the number of in-text citations. If there are less than this number then it will be flagged as not_scorable.

Default: 0

min_bibliography_citations

(integer)

Check the number of citations in the bibliography / works cited section. If there are less than this number then it will be flagged as not_scorable.

Default: 0 

Available on 2025-03-14 and newer models.

 

 

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.