@instructure/athena-api-client 3.13.1 → 3.15.0

package/dist/apis/StudyObjectiveConceptsApi.d.ts

@@ -36,12 +36,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
      */
     listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;

package/dist/apis/StudyObjectiveConceptsApi.js

@@ -73,7 +73,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -111,7 +111,7 @@ class StudyObjectiveConceptsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {

package/dist/esm/apis/StudyObjectiveConceptsApi.d.ts

@@ -36,12 +36,12 @@ export declare class StudyObjectiveConceptsApi extends runtime.BaseAPI {
      */
     listStudyObjectiveConcepts(requestParameters: ListStudyObjectiveConceptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjectiveConceptAttachmentList>;
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtractionRaw(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerStudyObjectiveConceptExtractionResponse>>;
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtraction(requestParameters: TriggerStudyObjectiveConceptExtractionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerStudyObjectiveConceptExtractionResponse>;

package/dist/esm/apis/StudyObjectiveConceptsApi.js

@@ -70,7 +70,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtractionRaw(requestParameters, initOverrides) {
@@ -108,7 +108,7 @@ export class StudyObjectiveConceptsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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).
      * Trigger study-objective concept extraction
      */
     triggerStudyObjectiveConceptExtraction(requestParameters, initOverrides) {

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

@@ -55,6 +55,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     quizContext?: ChatRequestQuizContext;
+    /**
+     * When true, extract text from every PDF attachment up front and send it as text instead of as page-rendered file parts. Set by the client when retrying after a pdf_context_overflow failure. Acts as the loop guard: a textOnly request is never auto-retried again.
+     * @type {boolean}
+     * @memberof ChatRequest
+     */
+    textOnly?: boolean;
     /**
      * Optional taxonomy ID to scope this chat to a taxonomy. Only applied when a new chat is created. Requires an active enrollment.
      * @type {string}

package/dist/esm/models/ChatRequest.js

@@ -47,6 +47,7 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInnerFromJSON)),
         'externalFileUrl': json['externalFileUrl'] == null ? undefined : ChatRequestExternalFileUrlFromJSON(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : ChatRequestQuizContextFromJSON(json['quizContext']),
+        'textOnly': json['textOnly'] == null ? undefined : json['textOnly'],
         'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
         'trigger': json['trigger'] == null ? undefined : json['trigger'],
         'messageMetadata': json['messageMetadata'] == null ? undefined : ChatRequestMessageMetadataFromJSON(json['messageMetadata']),
@@ -66,6 +67,7 @@ export function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInnerToJSON)),
         'externalFileUrl': ChatRequestExternalFileUrlToJSON(value['externalFileUrl']),
         'quizContext': ChatRequestQuizContextToJSON(value['quizContext']),
+        'textOnly': value['textOnly'],
         'taxonomyId': value['taxonomyId'],
         'trigger': value['trigger'],
         'messageMetadata': ChatRequestMessageMetadataToJSON(value['messageMetadata']),

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

@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
     syllabusHtmlByCanvasCourseId?: {
         [key: string]: string;
     };
+    /**
+     * 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.
+     * @type {boolean}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    forceReextract?: boolean;
 }
 /**
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.

package/dist/esm/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -29,6 +29,7 @@ export function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json,
     return {
         'studyObjectiveIds': json['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
+        'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
     };
 }
 export function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -41,5 +42,6 @@ export function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value,
     return {
         'studyObjectiveIds': value['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
+        'forceReextract': value['forceReextract'],
     };
 }

package/dist/models/ChatRequest.d.ts

@@ -55,6 +55,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     quizContext?: ChatRequestQuizContext;
+    /**
+     * When true, extract text from every PDF attachment up front and send it as text instead of as page-rendered file parts. Set by the client when retrying after a pdf_context_overflow failure. Acts as the loop guard: a textOnly request is never auto-retried again.
+     * @type {boolean}
+     * @memberof ChatRequest
+     */
+    textOnly?: boolean;
     /**
      * Optional taxonomy ID to scope this chat to a taxonomy. Only applied when a new chat is created. Requires an active enrollment.
      * @type {string}

package/dist/models/ChatRequest.js

@@ -55,6 +55,7 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerFromJSON)),
         'externalFileUrl': json['externalFileUrl'] == null ? undefined : (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlFromJSON)(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : (0, ChatRequestQuizContext_1.ChatRequestQuizContextFromJSON)(json['quizContext']),
+        'textOnly': json['textOnly'] == null ? undefined : json['textOnly'],
         'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
         'trigger': json['trigger'] == null ? undefined : json['trigger'],
         'messageMetadata': json['messageMetadata'] == null ? undefined : (0, ChatRequestMessageMetadata_1.ChatRequestMessageMetadataFromJSON)(json['messageMetadata']),
@@ -74,6 +75,7 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerToJSON)),
         'externalFileUrl': (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlToJSON)(value['externalFileUrl']),
         'quizContext': (0, ChatRequestQuizContext_1.ChatRequestQuizContextToJSON)(value['quizContext']),
+        'textOnly': value['textOnly'],
         'taxonomyId': value['taxonomyId'],
         'trigger': value['trigger'],
         'messageMetadata': (0, ChatRequestMessageMetadata_1.ChatRequestMessageMetadataToJSON)(value['messageMetadata']),

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.d.ts

@@ -29,6 +29,12 @@ export interface TriggerStudyObjectiveConceptExtractionRequest {
     syllabusHtmlByCanvasCourseId?: {
         [key: string]: string;
     };
+    /**
+     * 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.
+     * @type {boolean}
+     * @memberof TriggerStudyObjectiveConceptExtractionRequest
+     */
+    forceReextract?: boolean;
 }
 /**
  * Check if a given object implements the TriggerStudyObjectiveConceptExtractionRequest interface.

package/dist/models/TriggerStudyObjectiveConceptExtractionRequest.js

@@ -36,6 +36,7 @@ function TriggerStudyObjectiveConceptExtractionRequestFromJSONTyped(json, ignore
     return {
         'studyObjectiveIds': json['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': json['syllabusHtmlByCanvasCourseId'] == null ? undefined : json['syllabusHtmlByCanvasCourseId'],
+        'forceReextract': json['forceReextract'] == null ? undefined : json['forceReextract'],
     };
 }
 function TriggerStudyObjectiveConceptExtractionRequestToJSON(json) {
@@ -48,5 +49,6 @@ function TriggerStudyObjectiveConceptExtractionRequestToJSONTyped(value, ignoreD
     return {
         'studyObjectiveIds': value['studyObjectiveIds'],
         'syllabusHtmlByCanvasCourseId': value['syllabusHtmlByCanvasCourseId'],
+        'forceReextract': value['forceReextract'],
     };
 }

package/package.json

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