Model options allow configuration of the specific model parameters that are available in Feedback Aide Models.
Different models 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.
Topic Checking
topiccheck
Check if the essay is on a topic related to the question.
Property | Details |
enabled |
Enable or disable topic checking. Default: true
|
relatedness |
Relatedness level from Note: setting this to |
Available on standard-essay-2024-11-22
and advanced-essay-2024-11-22
and newer models.
Structure Checking
structurecheck
Check if the essay matches the required structure - currently checks for the minimum number of paragraphs.
Property | Details |
enabled |
Enable or disable structure checking. Default: false
|
min_paragraphs |
Check the minimum number of paragraphs. If there are less than this number then it will be flagged as |
mode |
Mode of checking paragraphs.
|
Available on standard-essay-2024-11-22
and advanced-essay-2024-11-22
and newer models.
Moderation
moderation
configuration options for moderation - see Content moderation with Feedback Aide
Property | Details |
enabled |
Enable or disable content moderation checking. Default: false
|
Note: Moderation is available on advanced-essay
models only.
Language
language
configuration options for outputs from models.
Property | Details |
feedback |
Set the language which feedback will be returned in. Default: en
|
Languages are input as 2 letter ISO 639-1 codes.
Currently supported langauges for feedback are:
-
en
: English -
fr
: French -
es
: Spanish -
pt
: Portuguese -
it
: Italian -
de
: German -
zh
: Chinese -
id
: Indonesian -
jp
: Japanese -
kr
: Korean -
ar
: Arabic (preview support)
See also the article on Internationalization for Feedback aide to customize the interface elements.