@instructure/athena-api-client 3.13.0 → 3.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,12 +36,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
36
36
  */
37
37
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
38
38
  /**
39
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
39
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
40
40
  * Trigger study-objective concept extraction
41
41
  */
42
42
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
43
43
  /**
44
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
44
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
45
45
  * Trigger study-objective concept extraction
46
46
  */
47
47
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -73,7 +73,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
73
73
  });
74
74
  }
75
75
  /**
76
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
76
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
77
77
  * Trigger study-objective concept extraction
78
78
  */
79
79
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -111,7 +111,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
111
111
  });
112
112
  }
113
113
  /**
114
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
114
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
115
115
  * Trigger study-objective concept extraction
116
116
  */
117
117
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -36,12 +36,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
36
36
  */
37
37
  listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
38
38
  /**
39
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
39
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
40
40
  * Trigger study-objective concept extraction
41
41
  */
42
42
  triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
43
43
  /**
44
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
44
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
45
45
  * Trigger study-objective concept extraction
46
46
  */
47
47
  triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;
@@ -70,7 +70,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
70
70
  });
71
71
  }
72
72
  /**
73
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
73
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
74
74
  * Trigger study-objective concept extraction
75
75
  */
76
76
  triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -108,7 +108,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
108
108
  });
109
109
  }
110
110
  /**
111
- * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective.
111
+ * Begins content assembly and LLM-driven concept extraction for one or more study objectives, identified by id. Each objective is routed by its canvas link: a canvas-sourced objective extracts from live Canvas content (assignment, quiz, page, module item) and stores concepts on the shared Canvas object; a custom objective extracts from its title, notes, and attachments. Returns 202 with a per-objective status snapshot; extraction runs in the background. Canvas credentials are read from `X-Canvas-Token` / `X-Canvas-Domain` headers (never the body) and are required when the request includes a canvas-sourced objective. Set `forceReextract` to refresh canvas-sourced concepts that are already active (the default re-extracts only from a failed state or the arrival-only syllabus pickup).
112
112
  * Trigger study-objective concept extraction
113
113
  */
114
114
  triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {
@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
29
29
  syllabusHtmlByCanvasCourseId?: {
30
30
  [key: string]: string;
31
31
  };
32
+ /**
33
+ * When true, re-extract canvas-sourced objectives whose concepts are already active (bypassing the failed-only/arrival-only re-pend guard). No effect on custom objectives or in-flight extractions.
34
+ * @type {boolean}
35
+ * @memberof TriggerStudyObjectiveConceptExtractionRequest
36
+ */
37
+ forceReextract?: boolean;
32
38
  }
33
39
  /**
34
40
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
@@ -29,6 +29,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
29
29
  return {
30
30
  'studyObjectiveIds': json['studyObjectiveIds'],
31
31
  'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
32
+ 'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
32
33
  };
33
34
  }
34
35
  export function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -41,5 +42,6 @@ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value,
41
42
  return {
42
43
  'studyObjectiveIds': value['studyObjectiveIds'],
43
44
  'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
45
+ 'forceReextract': value['forceReextract'],
44
46
  };
45
47
  }
@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
29
29
  syllabusHtmlByCanvasCourseId?: {
30
30
  [key: string]: string;
31
31
  };
32
+ /**
33
+ * When true, re-extract canvas-sourced objectives whose concepts are already active (bypassing the failed-only/arrival-only re-pend guard). No effect on custom objectives or in-flight extractions.
34
+ * @type {boolean}
35
+ * @memberof TriggerStudyObjectiveConceptExtractionRequest
36
+ */
37
+ forceReextract?: boolean;
32
38
  }
33
39
  /**
34
40
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.
@@ -36,6 +36,7 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
36
36
  return {
37
37
  'studyObjectiveIds': json['studyObjectiveIds'],
38
38
  'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
39
+ 'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
39
40
  };
40
41
  }
41
42
  function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -48,5 +49,6 @@ function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreD
48
49
  return {
49
50
  'studyObjectiveIds': value['studyObjectiveIds'],
50
51
  'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
52
+ 'forceReextract': value['forceReextract'],
51
53
  };
52
54
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.13.0",
4
+ "version": "3.14.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {