Interactions Extraction

Interactions

Many e-learning authoring tools include interactive elements such as quizzes, questions, and assessments within their content.

Generator can extract and include these interactions in the text extraction output when the include_interactions parameter is set to true. Interactions are also included in the Course Details for the course.

Interaction Structure

Because interactions can vary greatly within and between authoring tools, Generator provides a flexible abstraction that can apply to many different types of questions. The format for interactions metadata is as follows:

  • type: A string identifying the type of interaction. The available interaction types vary by authoring tool (see Supported Interaction Types below).
  • question: The question or prompt text for the interaction. In some cases, it will be a reference or title for the interaction.
  • choices: An array of choice objects (for question-based interactions). Each choice contains:
    • text: The choice text
    • is_correct: A boolean indicating whether this choice is correct (may be null if correctness information is not available)
    • category: An optional category string for the choice (may be null)
  • range: An optional range object (for slider-based interactions) containing:
    • min: The minimum value
    • max: The maximum value
  • feedback: An array of feedback strings associated with the interaction. In most cases, this will include a “correct” and “incorrect” response.

Supported Interaction Types

The specific interaction types available depend on the authoring tool used to create the content. The following interaction types are supported:

Articulate Storyline

Value
multiple_choice
multiple_response
matching
true_false
fill_in
essay
other

Articulate Rise

Value
multiple_choice
multiple_response
matching
other

Intellum Evolve

Value
mcq
drag_and_drop
open_input
confidence_slider
other

Adobe Captivate

Value
choice
true_false
matching
fill_in
long_fill_in
sequencing
hotspot
other

Gomo Learning

Value
mcq
sfl
dropdown_list
text_input
drag_and_drop
likert
other

LetterAI

Value
question_multiple_choice
question_true_false
question_puzzle_matching
question_fill_in_the_blank
question_multiple_select
other

Interaction Behavior by Format

  • TEXT format: When include_interactions=true, interaction text (questions and choices) is embedded directly in the course text at the location where the interaction appears. This provides a complete textual representation of the content including all interactive elements.

  • JSON format: When include_interactions=true, interactions are provided in a separate interactions array for each location. This allows you to process interactions programmatically while maintaining clean text content.

  • VTT format: Interactions are not supported in VTT format. Attempting to use include_interactions=true with VTT format will result in an error.