@instructure/athena-api-client 4.9.5 → 4.10.0

package/dist/esm/models/StudyObjectiveAccess.d.ts

@@ -118,11 +118,17 @@ export interface StudyObjectiveAccess {
      */
     suggestedScope: Array<string> | null;
     /**
-     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'syllabus' (no such item text, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
+     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     rosterSource: StudyObjectiveAccessRosterSourceEnum;
+    /**
+     * Whether the extraction that built this item's topic list was also given the course syllabus. Label a 'module' list as Athena's best guess from its module and your syllabus only when this is true; false or null never claims a syllabus. Null when no list has been recorded with its source, or the list predates this record.
+     * @type {boolean}
+     * @memberof StudyObjectiveAccess
+     */
+    rosterSyllabusSupplied: boolean | null;
 }
 /**
  * @export
@@ -168,6 +174,7 @@ export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Title: "title";
     readonly Text: "text";
     readonly Syllabus: "syllabus";
+    readonly Module: "module";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/esm/models/StudyObjectiveAccess.js

@@ -50,7 +50,8 @@ export const StudyObjectiveAccessSyllabusSourceEnum = {
 export const StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
     Text: 'text',
-    Syllabus: 'syllabus'
+    Syllabus: 'syllabus',
+    Module: 'module'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
@@ -92,6 +93,8 @@ export function instanceOfStudyObjectiveAccess(value) {
         return false;
     if (!('rosterSource' in value) || value['rosterSource'] === undefined)
         return false;
+    if (!('rosterSyllabusSupplied' in value) || value['rosterSyllabusSupplied'] === undefined)
+        return false;
     return true;
 }
 export function StudyObjectiveAccessFromJSON(json) {
@@ -120,6 +123,7 @@ export function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'readAt': (new Date(json['readAt'])),
         'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
         'rosterSource': json['rosterSource'],
+        'rosterSyllabusSupplied': json['rosterSyllabusSupplied'],
     };
 }
 export function StudyObjectiveAccessToJSON(json) {
@@ -148,5 +152,6 @@ export function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = fal
         'readAt': value['readAt'].toISOString(),
         'suggestedScope': value['suggestedScope'],
         'rosterSource': value['rosterSource'],
+        'rosterSyllabusSupplied': value['rosterSyllabusSupplied'],
     };
 }

package/dist/esm/models/StudyObjectiveConceptAttachment.d.ts

@@ -35,13 +35,13 @@ export interface StudyObjectiveConceptAttachment {
      */
     status: StudyObjectiveConceptAttachmentStatusEnum;
     /**
-     * Last recorded error message when status is `failed`.
+     * Last recorded error when status is `failed`: a fixed code, or `agent-failure:<error class>` for a model failure (never the provider's message, which can quote the prompt).
      * @type {string}
      * @memberof StudyObjectiveConceptAttachment
      */
     lastError: string | null;
     /**
-     * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction would read (title, description, supporting material, syllabus) names a subject, so the model was not asked. `agent-empty`: the model was asked and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
+     * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction could use names the item's topics — nothing it would read (title, description, supporting material, syllabus, the item's module) names a subject, so the model was not asked, or only the item's module did and the model found nothing there. `agent-empty`: the model was asked on evidence beyond the module and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
      * @type {string}
      * @memberof StudyObjectiveConceptAttachment
      */

package/dist/models/StudyObjectiveAccess.d.ts

@@ -118,11 +118,17 @@ export interface StudyObjectiveAccess {
      */
     suggestedScope: Array<string> | null;
     /**
-     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'syllabus' (no such item text, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
+     * What built this item's topic list, decided from the text its extraction was given: 'text' (the item's own text, long enough to count as material), 'module' (no item text that says what it covers, so the list was suggested from the name of the course module the item sits in and the names of the other items there), 'syllabus' (neither, so the list was inferred from the course syllabus) or 'title' (the course and item names, with no syllabus, subject-naming module or item text long enough to count). Files never feed the list, so a 'grounded' course can still have a 'title' list. Label an inferred list with its source: a 'title' list as Athena's best guess from the item's title, a 'module' list as Athena's best guess from its module, a 'syllabus' list as suggested from the syllabus; key that label on this field, not on `state`. A 'module' list never makes the scope known: only a syllabus assessment whose title pairs exactly (or nearly) with the item's can. Recorded when the list is extracted; for a list extracted before that record existed it is read from these facts by the same rule (item text means 'text', else a syllabus means 'syllabus', else 'title'), which can read as built from text a course gained after its list was built. A 'text' recorded before 'syllabus' existed is read the same way when these facts show a syllabus and no item text.
      * @type {string}
      * @memberof StudyObjectiveAccess
      */
     rosterSource: StudyObjectiveAccessRosterSourceEnum;
+    /**
+     * Whether the extraction that built this item's topic list was also given the course syllabus. Label a 'module' list as Athena's best guess from its module and your syllabus only when this is true; false or null never claims a syllabus. Null when no list has been recorded with its source, or the list predates this record.
+     * @type {boolean}
+     * @memberof StudyObjectiveAccess
+     */
+    rosterSyllabusSupplied: boolean | null;
 }
 /**
  * @export
@@ -168,6 +174,7 @@ export declare const StudyObjectiveAccessRosterSourceEnum: {
     readonly Title: "title";
     readonly Text: "text";
     readonly Syllabus: "syllabus";
+    readonly Module: "module";
 };
 export type StudyObjectiveAccessRosterSourceEnum = typeof StudyObjectiveAccessRosterSourceEnum[keyof typeof StudyObjectiveAccessRosterSourceEnum];
 /**

package/dist/models/StudyObjectiveAccess.js

@@ -58,7 +58,8 @@ exports.StudyObjectiveAccessSyllabusSourceEnum = {
 exports.StudyObjectiveAccessRosterSourceEnum = {
     Title: 'title',
     Text: 'text',
-    Syllabus: 'syllabus'
+    Syllabus: 'syllabus',
+    Module: 'module'
 };
 /**
  * Check if a given object implements the StudyObjectiveAccess interface.
@@ -100,6 +101,8 @@ function instanceOfStudyObjectiveAccess(value) {
         return false;
     if (!('rosterSource' in value) || value['rosterSource'] === undefined)
         return false;
+    if (!('rosterSyllabusSupplied' in value) || value['rosterSyllabusSupplied'] === undefined)
+        return false;
     return true;
 }
 function StudyObjectiveAccessFromJSON(json) {
@@ -128,6 +131,7 @@ function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
         'readAt': (new Date(json['readAt'])),
         'suggestedScope': json['suggestedScope'] == null ? null : json['suggestedScope'],
         'rosterSource': json['rosterSource'],
+        'rosterSyllabusSupplied': json['rosterSyllabusSupplied'],
     };
 }
 function StudyObjectiveAccessToJSON(json) {
@@ -156,5 +160,6 @@ function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
         'readAt': value['readAt'].toISOString(),
         'suggestedScope': value['suggestedScope'],
         'rosterSource': value['rosterSource'],
+        'rosterSyllabusSupplied': value['rosterSyllabusSupplied'],
     };
 }

package/dist/models/StudyObjectiveConceptAttachment.d.ts

@@ -35,13 +35,13 @@ export interface StudyObjectiveConceptAttachment {
      */
     status: StudyObjectiveConceptAttachmentStatusEnum;
     /**
-     * Last recorded error message when status is `failed`.
+     * Last recorded error when status is `failed`: a fixed code, or `agent-failure:<error class>` for a model failure (never the provider's message, which can quote the prompt).
      * @type {string}
      * @memberof StudyObjectiveConceptAttachment
      */
     lastError: string | null;
     /**
-     * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction would read (title, description, supporting material, syllabus) names a subject, so the model was not asked. `agent-empty`: the model was asked and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
+     * Why the latest finished extraction left this Canvas item no concept list. `no-evidence`: nothing the extraction could use names the item's topics — nothing it would read (title, description, supporting material, syllabus, the item's module) names a subject, so the model was not asked, or only the item's module did and the model found nothing there. `agent-empty`: the model was asked on evidence beyond the module and returned no concepts. Null when the item has concepts (a list a later empty run kept wins), while an extraction is due or in flight, and for custom objectives. Shared by every learner on the item: show `no-evidence` as the item naming nothing only when the objective's `titleNamesSubject` is false. A later fresh read or a rename that names a subject re-runs a `no-evidence` row.
      * @type {string}
      * @memberof StudyObjectiveConceptAttachment
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "4.9.5",
+  "version": "4.10.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {