@instructure/athena-api-client 2.13.0 → 2.14.0

package/README.md

@@ -147,6 +147,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatRequest](docs/ChatRequest.md)
 - [ChatRequestAttachmentsInner](docs/ChatRequestAttachmentsInner.md)
 - [ChatRequestExternalFileUrl](docs/ChatRequestExternalFileUrl.md)
+- [ChatRequestMessageMetadata](docs/ChatRequestMessageMetadata.md)
 - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
+import type { ChatRequestMessageMetadata } from './ChatRequestMessageMetadata';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -60,7 +61,28 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     taxonomyId?: string;
+    /**
+     * Session-chat lifecycle trigger. 'level-up-initiate' / 'quick-practice-initiate' are sent with a whitespace user message to kick off the session's first AI turn; 'level-up-resume' is sent when reopening a paused Level Up chat so the AI runs a welcome-back recap turn. Ignored for non-session chats.
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    trigger?: ChatRequestTriggerEnum;
+    /**
+     *
+     * @type {ChatRequestMessageMetadata}
+     * @memberof ChatRequest
+     */
+    messageMetadata?: ChatRequestMessageMetadata;
 }
+/**
+ * @export
+ */
+export declare const ChatRequestTriggerEnum: {
+    readonly LevelUpInitiate: "level-up-initiate";
+    readonly QuickPracticeInitiate: "quick-practice-initiate";
+    readonly LevelUpResume: "level-up-resume";
+};
+export type ChatRequestTriggerEnum = typeof ChatRequestTriggerEnum[keyof typeof ChatRequestTriggerEnum];
 /**
  * Check if a given object implements the ChatRequest interface.
  */

package/dist/esm/models/ChatRequest.js

@@ -12,8 +12,17 @@
  * Do not edit the class manually.
  */
 import { ChatRequestExternalFileUrlFromJSON, ChatRequestExternalFileUrlToJSON, } from './ChatRequestExternalFileUrl';
+import { ChatRequestMessageMetadataFromJSON, ChatRequestMessageMetadataToJSON, } from './ChatRequestMessageMetadata';
 import { ChatRequestAttachmentsInnerFromJSON, ChatRequestAttachmentsInnerToJSON, } from './ChatRequestAttachmentsInner';
 import { ChatRequestQuizContextFromJSON, ChatRequestQuizContextToJSON, } from './ChatRequestQuizContext';
+/**
+ * @export
+ */
+export const ChatRequestTriggerEnum = {
+    LevelUpInitiate: 'level-up-initiate',
+    QuickPracticeInitiate: 'quick-practice-initiate',
+    LevelUpResume: 'level-up-resume'
+};
 /**
  * Check if a given object implements the ChatRequest interface.
  */
@@ -39,6 +48,8 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'externalFileUrl': json['externalFileUrl'] == null ? undefined : ChatRequestExternalFileUrlFromJSON(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : ChatRequestQuizContextFromJSON(json['quizContext']),
         'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
+        'trigger': json['trigger'] == null ? undefined : json['trigger'],
+        'messageMetadata': json['messageMetadata'] == null ? undefined : ChatRequestMessageMetadataFromJSON(json['messageMetadata']),
     };
 }
 export function ChatRequestToJSON(json) {
@@ -56,5 +67,7 @@ export function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'externalFileUrl': ChatRequestExternalFileUrlToJSON(value['externalFileUrl']),
         'quizContext': ChatRequestQuizContextToJSON(value['quizContext']),
         'taxonomyId': value['taxonomyId'],
+        'trigger': value['trigger'],
+        'messageMetadata': ChatRequestMessageMetadataToJSON(value['messageMetadata']),
     };
 }

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

@@ -0,0 +1,44 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Optional metadata attached to the user message, used by session chats to bind an answer to its inline question and scoring context.
+ * @export
+ * @interface ChatRequestMessageMetadata
+ */
+export interface ChatRequestMessageMetadata {
+    /**
+     * Identifier of the inline question this user message is answering.
+     * @type {string}
+     * @memberof ChatRequestMessageMetadata
+     */
+    inlineQuestionId: string;
+    /**
+     * Widget shape the inline question used (free-text, fill-blank, teach-back, spot-error).
+     * @type {string}
+     * @memberof ChatRequestMessageMetadata
+     */
+    questionType?: string;
+    /**
+     * Raw typed answer shape from the widget (e.g. string[] of fill-blank answers). Server passes it through to the evaluator.
+     * @type {any}
+     * @memberof ChatRequestMessageMetadata
+     */
+    structuredAnswer?: any | null;
+}
+/**
+ * Check if a given object implements the ChatRequestMessageMetadata interface.
+ */
+export declare function instanceOfChatRequestMessageMetadata(value: object): value is ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataFromJSON(json: any): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataToJSON(json: any): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataToJSONTyped(value?: ChatRequestMessageMetadata | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestMessageMetadata.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ChatRequestMessageMetadata interface.
+ */
+export function instanceOfChatRequestMessageMetadata(value) {
+    if (!('inlineQuestionId' in value) || value['inlineQuestionId'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestMessageMetadataFromJSON(json) {
+    return ChatRequestMessageMetadataFromJSONTyped(json, false);
+}
+export function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'inlineQuestionId': json['inlineQuestionId'],
+        'questionType': json['questionType'] == null ? undefined : json['questionType'],
+        'structuredAnswer': json['structuredAnswer'] == null ? undefined : json['structuredAnswer'],
+    };
+}
+export function ChatRequestMessageMetadataToJSON(json) {
+    return ChatRequestMessageMetadataToJSONTyped(json, false);
+}
+export function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'inlineQuestionId': value['inlineQuestionId'],
+        'questionType': value['questionType'],
+        'structuredAnswer': value['structuredAnswer'],
+    };
+}

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

@@ -28,7 +28,7 @@ export interface CreateChatRequest {
      */
     title?: string;
     /**
-     * Optional chat type. Defaults to a general chat if omitted.
+     * Optional chat type. Defaults to a general chat if omitted. Use 'level-up' or 'quick-practice' to create a session chat; both require primaryConceptId + initialStrength.
      * @type {string}
      * @memberof CreateChatRequest
      */
@@ -39,6 +39,18 @@ export interface CreateChatRequest {
      * @memberof CreateChatRequest
      */
     visibility?: CreateChatRequestVisibilityEnum;
+    /**
+     * Concept this session chat is bound to. Required when chatType is 'level-up' or 'quick-practice'; ignored for other chat types.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    primaryConceptId?: string;
+    /**
+     * Snapshot of the learner's current strength for primaryConceptId (0..1). Required when chatType is 'level-up' or 'quick-practice'. Used by the session-end rollup and the surprise tier-advance check at close.
+     * @type {number}
+     * @memberof CreateChatRequest
+     */
+    initialStrength?: number;
 }
 /**
  * @export

package/dist/esm/models/CreateChatRequest.js

@@ -36,6 +36,8 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'] == null ? undefined : json['title'],
         'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'visibility': json['visibility'] == null ? undefined : json['visibility'],
+        'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
+        'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
     };
 }
 export function CreateChatRequestToJSON(json) {
@@ -50,5 +52,7 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
         'title': value['title'],
         'chatType': value['chatType'],
         'visibility': value['visibility'],
+        'primaryConceptId': value['primaryConceptId'],
+        'initialStrength': value['initialStrength'],
     };
 }

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

@@ -15,6 +15,7 @@ export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './ChatRequestExternalFileUrl';
+export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/esm/models/index.js

@@ -17,6 +17,7 @@ export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './ChatRequestExternalFileUrl';
+export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/models/ChatRequest.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
+import type { ChatRequestMessageMetadata } from './ChatRequestMessageMetadata';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -60,7 +61,28 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     taxonomyId?: string;
+    /**
+     * Session-chat lifecycle trigger. 'level-up-initiate' / 'quick-practice-initiate' are sent with a whitespace user message to kick off the session's first AI turn; 'level-up-resume' is sent when reopening a paused Level Up chat so the AI runs a welcome-back recap turn. Ignored for non-session chats.
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    trigger?: ChatRequestTriggerEnum;
+    /**
+     *
+     * @type {ChatRequestMessageMetadata}
+     * @memberof ChatRequest
+     */
+    messageMetadata?: ChatRequestMessageMetadata;
 }
+/**
+ * @export
+ */
+export declare const ChatRequestTriggerEnum: {
+    readonly LevelUpInitiate: "level-up-initiate";
+    readonly QuickPracticeInitiate: "quick-practice-initiate";
+    readonly LevelUpResume: "level-up-resume";
+};
+export type ChatRequestTriggerEnum = typeof ChatRequestTriggerEnum[keyof typeof ChatRequestTriggerEnum];
 /**
  * Check if a given object implements the ChatRequest interface.
  */

package/dist/models/ChatRequest.js

@@ -13,14 +13,24 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatRequestTriggerEnum = void 0;
 exports.instanceOfChatRequest = instanceOfChatRequest;
 exports.ChatRequestFromJSON = ChatRequestFromJSON;
 exports.ChatRequestFromJSONTyped = ChatRequestFromJSONTyped;
 exports.ChatRequestToJSON = ChatRequestToJSON;
 exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
 const ChatRequestExternalFileUrl_1 = require("./ChatRequestExternalFileUrl");
+const ChatRequestMessageMetadata_1 = require("./ChatRequestMessageMetadata");
 const ChatRequestAttachmentsInner_1 = require("./ChatRequestAttachmentsInner");
 const ChatRequestQuizContext_1 = require("./ChatRequestQuizContext");
+/**
+ * @export
+ */
+exports.ChatRequestTriggerEnum = {
+    LevelUpInitiate: 'level-up-initiate',
+    QuickPracticeInitiate: 'quick-practice-initiate',
+    LevelUpResume: 'level-up-resume'
+};
 /**
  * Check if a given object implements the ChatRequest interface.
  */
@@ -46,6 +56,8 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'externalFileUrl': json['externalFileUrl'] == null ? undefined : (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlFromJSON)(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : (0, ChatRequestQuizContext_1.ChatRequestQuizContextFromJSON)(json['quizContext']),
         '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']),
     };
 }
 function ChatRequestToJSON(json) {
@@ -63,5 +75,7 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'externalFileUrl': (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlToJSON)(value['externalFileUrl']),
         'quizContext': (0, ChatRequestQuizContext_1.ChatRequestQuizContextToJSON)(value['quizContext']),
         'taxonomyId': value['taxonomyId'],
+        'trigger': value['trigger'],
+        'messageMetadata': (0, ChatRequestMessageMetadata_1.ChatRequestMessageMetadataToJSON)(value['messageMetadata']),
     };
 }

package/dist/models/ChatRequestMessageMetadata.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Optional metadata attached to the user message, used by session chats to bind an answer to its inline question and scoring context.
+ * @export
+ * @interface ChatRequestMessageMetadata
+ */
+export interface ChatRequestMessageMetadata {
+    /**
+     * Identifier of the inline question this user message is answering.
+     * @type {string}
+     * @memberof ChatRequestMessageMetadata
+     */
+    inlineQuestionId: string;
+    /**
+     * Widget shape the inline question used (free-text, fill-blank, teach-back, spot-error).
+     * @type {string}
+     * @memberof ChatRequestMessageMetadata
+     */
+    questionType?: string;
+    /**
+     * Raw typed answer shape from the widget (e.g. string[] of fill-blank answers). Server passes it through to the evaluator.
+     * @type {any}
+     * @memberof ChatRequestMessageMetadata
+     */
+    structuredAnswer?: any | null;
+}
+/**
+ * Check if a given object implements the ChatRequestMessageMetadata interface.
+ */
+export declare function instanceOfChatRequestMessageMetadata(value: object): value is ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataFromJSON(json: any): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataToJSON(json: any): ChatRequestMessageMetadata;
+export declare function ChatRequestMessageMetadataToJSONTyped(value?: ChatRequestMessageMetadata | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestMessageMetadata.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfChatRequestMessageMetadata = instanceOfChatRequestMessageMetadata;
+exports.ChatRequestMessageMetadataFromJSON = ChatRequestMessageMetadataFromJSON;
+exports.ChatRequestMessageMetadataFromJSONTyped = ChatRequestMessageMetadataFromJSONTyped;
+exports.ChatRequestMessageMetadataToJSON = ChatRequestMessageMetadataToJSON;
+exports.ChatRequestMessageMetadataToJSONTyped = ChatRequestMessageMetadataToJSONTyped;
+/**
+ * Check if a given object implements the ChatRequestMessageMetadata interface.
+ */
+function instanceOfChatRequestMessageMetadata(value) {
+    if (!('inlineQuestionId' in value) || value['inlineQuestionId'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestMessageMetadataFromJSON(json) {
+    return ChatRequestMessageMetadataFromJSONTyped(json, false);
+}
+function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'inlineQuestionId': json['inlineQuestionId'],
+        'questionType': json['questionType'] == null ? undefined : json['questionType'],
+        'structuredAnswer': json['structuredAnswer'] == null ? undefined : json['structuredAnswer'],
+    };
+}
+function ChatRequestMessageMetadataToJSON(json) {
+    return ChatRequestMessageMetadataToJSONTyped(json, false);
+}
+function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'inlineQuestionId': value['inlineQuestionId'],
+        'questionType': value['questionType'],
+        'structuredAnswer': value['structuredAnswer'],
+    };
+}

package/dist/models/CreateChatRequest.d.ts

@@ -28,7 +28,7 @@ export interface CreateChatRequest {
      */
     title?: string;
     /**
-     * Optional chat type. Defaults to a general chat if omitted.
+     * Optional chat type. Defaults to a general chat if omitted. Use 'level-up' or 'quick-practice' to create a session chat; both require primaryConceptId + initialStrength.
      * @type {string}
      * @memberof CreateChatRequest
      */
@@ -39,6 +39,18 @@ export interface CreateChatRequest {
      * @memberof CreateChatRequest
      */
     visibility?: CreateChatRequestVisibilityEnum;
+    /**
+     * Concept this session chat is bound to. Required when chatType is 'level-up' or 'quick-practice'; ignored for other chat types.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    primaryConceptId?: string;
+    /**
+     * Snapshot of the learner's current strength for primaryConceptId (0..1). Required when chatType is 'level-up' or 'quick-practice'. Used by the session-end rollup and the surprise tier-advance check at close.
+     * @type {number}
+     * @memberof CreateChatRequest
+     */
+    initialStrength?: number;
 }
 /**
  * @export

package/dist/models/CreateChatRequest.js

@@ -44,6 +44,8 @@ function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'title': json['title'] == null ? undefined : json['title'],
         'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'visibility': json['visibility'] == null ? undefined : json['visibility'],
+        'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
+        'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
     };
 }
 function CreateChatRequestToJSON(json) {
@@ -58,5 +60,7 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'title': value['title'],
         'chatType': value['chatType'],
         'visibility': value['visibility'],
+        'primaryConceptId': value['primaryConceptId'],
+        'initialStrength': value['initialStrength'],
     };
 }

package/dist/models/index.d.ts

@@ -15,6 +15,7 @@ export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './ChatRequestExternalFileUrl';
+export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/models/index.js

@@ -33,6 +33,7 @@ __exportStar(require("./ChatAnalysis"), exports);
 __exportStar(require("./ChatRequest"), exports);
 __exportStar(require("./ChatRequestAttachmentsInner"), exports);
 __exportStar(require("./ChatRequestExternalFileUrl"), exports);
+__exportStar(require("./ChatRequestMessageMetadata"), exports);
 __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);

package/package.json

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