Content Details
When parsing content, Generator will extract as much useful information as possible. This includes text, but also other details such as authoring tool version or content length. As we improve our parsers, we will add more information to the content_details property of the content object.
Currently, the content_details object looks like this:
{
"content_type": "STORYLINE",
"existing_metadata": {
"authoring_tool_version": "1.0.0",
"slides": 7
},
"interactions": [
{
"question": "What is 6x6?",
"choices": [
{
"text": "36",
"is_correct": true,
"category": null
},
{
"text": "66",
"is_correct": false,
"category": null
},
{
"text": "12",
"is_correct": false,
"category": null
},
{
"text": "1",
"is_correct": false,
"category": null
}
],
"feedback": [
"That is correct. 6x6 is equivalent which is 36",
"That is incorrect. 6x6 is equivalent which is 36"
],
"type": "multiple_choice",
"range": null
}
]
}
The existing_metadata property defines metadata properties that are extracted directly from the learning content. The schema of property is dependent on the type of content. Details about the supported schemas and their properties are listed below.
Each metadata object has a property intended to signify “length”, which indicates the total number of ’elements’ that will be visible to learners taking the course. Generator makes an effort to align the term used to indicate “length” with the terminology used by each authoring tool (such as slides or pages). Additionally, Generator will consider element visibility when determining the content “length”, as not all elements defined in the course structure will ultimately be visible to learners.
For example, a course may present a quiz with one question per slide. The course may define 10 questions in its question bank, but will only present 5 questions to a learner. For this course, the “length” of the quiz section would be “5”.
When applicable, Generator will also expose the version of the authoring tool used to publish the content. This version string is defined in the authoring_tool_version property. A value of null indicates that the tool doesn’t support or expose versioning (as is the case with Articulate Rise 360 and gomo). If Generator fails to derive the tool version with content from a tool that typically defines a version value, Generator will use the value "undetected".
| Field | Type | Description |
|---|
| pages | int (optional) | The number of pages in the document |
| Field | Type | Description |
|---|
| web_pages | int (optional) | The number of webpages scraped |
| Field | Type | Description |
|---|
| transcript_duration | str (optional) | The timestamp of the end of the transcript |
Storyline Metadata
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| slides | int (optional) | The number of visible slides in the content |
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| lessons | int (optional) | The number of visible lessons in the content |
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| pages | int (optional) | The number of visible pages in the content |
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| pages | int (optional) | The number of visible pages in the content |
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| topics | int (optional) | The number of visible topics in the content |
| Field | Type | Description |
|---|
| authoring_tool_version | str (optional) | The version of the authoring tool which produced this content (if applicable) |
| slides | int (optional) | The number of visible slides in the content |
Interactions
Among other content data, Generator will attempt to extract information about interactions present in the content. More information about interactions can be found here.