Feedback Aide API Methods

Creates or retrieves a scoring feedback session for a student based on the essay prompt (stimulus), the submitted response, and the rubric.

You would use this method when you want to create a feedback instance to grade or review a student's response.

Each feedback session requires a server-generated security object and a unique session_uuid to represent the session. If the provided session_uuid already exists in the database, the stored stimulus, response, rubric, and feedback scores are retrieved. Otherwise, a new feedback session instance is created and saved after the user performs a save action.

Examples

const security = {
    access_token: '5eb0cb0f-183b-426c-8c62-0ed18ec113fc',
    token_type: 'bearer',
    expires_in: 7200
};

const feedbackSessionOptions = {
    state: 'grade',
    session_uuid: '36eebda5-b6fd-4e74-ad06-8e69dfb89e3e',
    stimulus: 'Write an essay about obesity and its impact on society',
    response: 'Obesity is ...',
    rubric: { ... },
    options: { ... },
    sources: [{ ... }],
};

const feedbackSession = await feedbackApp.feedbackSession(
    security,
    feedbackSessionOptions
);

Arguments

• security object

  Specifies the security details required for authentication.

  This object is returned from the token API endpoint and should be passed directly into this method.

  See Feedback Aide Security Tokens for more information.

  The following properties are supported.

  • access_token string

    The access token for authentication.

  • expires_in number

    Specifies how long the token is valid for, in seconds.

  • token_type string

    Must be set to "bearer".

• feedbackSessionOptions object

  Configuration options for the feedback session.

  The following properties are supported.

  • session_uuid string

    Unique identifier for the feedback session.

  • state string

    Defines the current state of the feedback session.

    Default: "grade"

    Possible values

    • "grade"
    • "review"

  • options object

    Evaluation options for the model used by Feedback Aide. These options will affect the response and feedback when grading students' responses.

    See Feedback Aide Evaluation Options for a full list of options.

    Important This option is only required when state is set to "grade".

  • response string

    The student's response to the essay prompt or stimulus.

    Important This option is only required when state is set to "grade".

  • rubric object

    The rubric that will be used to grade the student's response.

    See Feedback Aide Rubrics for more information.

    Important This option is only required when state is set to "grade".

  • sources array[object]

    A list of sources which are a part of a stimulus. The sources are additional content which the student can view when providing their response.

    See Feedback Aide Sources for more information.

    Important This option is only required when state is set to "grade".

  • stimulus string

    The prompt or stimulus for the essay.

    Important This option is only required when state is set to "grade".

Return value

Type Promise

When the promise resolves, it will return a FeedbackSession interface.

See feedbackSession methods for more information.