@instructure/athena-api-client 3.35.1 → 3.36.0

package/README.md

@@ -237,6 +237,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
+- [ChatRequestQuizSettings](docs/ChatRequestQuizSettings.md)
 - [ChatStudyPlanActivity](docs/ChatStudyPlanActivity.md)
 - [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md)
 - [ConceptChange](docs/ConceptChange.md)

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

@@ -11,6 +11,7 @@
  */
 import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
 import type { ChatRequestMessageMetadata } from './ChatRequestMessageMetadata';
+import type { ChatRequestQuizSettings } from './ChatRequestQuizSettings';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -55,6 +56,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     quizContext?: ChatRequestQuizContext;
+    /**
+     *
+     * @type {ChatRequestQuizSettings}
+     * @memberof ChatRequest
+     */
+    quizSettings?: ChatRequestQuizSettings;
     /**
      * 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}

package/dist/esm/models/ChatRequest.js

@@ -13,6 +13,7 @@
  */
 import { ChatRequestExternalFileUrlFromJSON, ChatRequestExternalFileUrlToJSON, } from './ChatRequestExternalFileUrl';
 import { ChatRequestMessageMetadataFromJSON, ChatRequestMessageMetadataToJSON, } from './ChatRequestMessageMetadata';
+import { ChatRequestQuizSettingsFromJSON, ChatRequestQuizSettingsToJSON, } from './ChatRequestQuizSettings';
 import { ChatRequestAttachmentsInnerFromJSON, ChatRequestAttachmentsInnerToJSON, } from './ChatRequestAttachmentsInner';
 import { ChatRequestQuizContextFromJSON, ChatRequestQuizContextToJSON, } from './ChatRequestQuizContext';
 /**
@@ -45,6 +46,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']),
+        'quizSettings': json['quizSettings'] == null ? undefined : ChatRequestQuizSettingsFromJSON(json['quizSettings']),
         'textOnly': json['textOnly'] == null ? undefined : json['textOnly'],
         'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
         'trigger': json['trigger'] == null ? undefined : json['trigger'],
@@ -65,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']),
+        'quizSettings': ChatRequestQuizSettingsToJSON(value['quizSettings']),
         'textOnly': value['textOnly'],
         'taxonomyId': value['taxonomyId'],
         'trigger': value['trigger'],

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

@@ -0,0 +1,54 @@
+/**
+ * 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 learner-chosen settings for a quiz generated during this turn (question formats, count, free-text focus). Applies to this request only and requires the enhanced-quizzing feature; without it the field is ignored.
+ * @export
+ * @interface ChatRequestQuizSettings
+ */
+export interface ChatRequestQuizSettings {
+    /**
+     * Question formats the quiz may use. Every generated question is one of these; omit to let Athena choose the default active-recall mix. Duplicates are ignored. Only applies to quiz mode.
+     * @type {Array<string>}
+     * @memberof ChatRequestQuizSettings
+     */
+    questionTypes?: Array<ChatRequestQuizSettingsQuestionTypesEnum>;
+    /**
+     * Exact number of questions to generate. Overrides whatever count the conversation would otherwise settle on.
+     * @type {number}
+     * @memberof ChatRequestQuizSettings
+     */
+    questionCount?: number;
+    /**
+     * Free-text notes from the learner about what the quiz should cover, emphasize, or how hard it should be. Steers content only; it cannot change the formats or the count above.
+     * @type {string}
+     * @memberof ChatRequestQuizSettings
+     */
+    instructions?: string;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestQuizSettingsQuestionTypesEnum: {
+    readonly Mcq: "mcq";
+    readonly FillBlank: "fill-blank";
+    readonly SpotError: "spot-error";
+    readonly TeachBack: "teach-back";
+};
+export type ChatRequestQuizSettingsQuestionTypesEnum = typeof ChatRequestQuizSettingsQuestionTypesEnum[keyof typeof ChatRequestQuizSettingsQuestionTypesEnum];
+/**
+ * Check if a given object implements the ChatRequestQuizSettings interface.
+ */
+export declare function instanceOfChatRequestQuizSettings(value: object): value is ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsFromJSON(json: any): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsToJSON(json: any): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsToJSONTyped(value?: ChatRequestQuizSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestQuizSettings.js

@@ -0,0 +1,54 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ChatRequestQuizSettingsQuestionTypesEnum = {
+    Mcq: 'mcq',
+    FillBlank: 'fill-blank',
+    SpotError: 'spot-error',
+    TeachBack: 'teach-back'
+};
+/**
+ * Check if a given object implements the ChatRequestQuizSettings interface.
+ */
+export function instanceOfChatRequestQuizSettings(value) {
+    return true;
+}
+export function ChatRequestQuizSettingsFromJSON(json) {
+    return ChatRequestQuizSettingsFromJSONTyped(json, false);
+}
+export function ChatRequestQuizSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'questionTypes': json['questionTypes'] == null ? undefined : json['questionTypes'],
+        'questionCount': json['questionCount'] == null ? undefined : json['questionCount'],
+        'instructions': json['instructions'] == null ? undefined : json['instructions'],
+    };
+}
+export function ChatRequestQuizSettingsToJSON(json) {
+    return ChatRequestQuizSettingsToJSONTyped(json, false);
+}
+export function ChatRequestQuizSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'questionTypes': value['questionTypes'],
+        'questionCount': value['questionCount'],
+        'instructions': value['instructions'],
+    };
+}

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

@@ -49,6 +49,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';

package/dist/esm/models/index.js

@@ -51,6 +51,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';

package/dist/models/ChatRequest.d.ts

@@ -11,6 +11,7 @@
  */
 import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
 import type { ChatRequestMessageMetadata } from './ChatRequestMessageMetadata';
+import type { ChatRequestQuizSettings } from './ChatRequestQuizSettings';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -55,6 +56,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     quizContext?: ChatRequestQuizContext;
+    /**
+     *
+     * @type {ChatRequestQuizSettings}
+     * @memberof ChatRequest
+     */
+    quizSettings?: ChatRequestQuizSettings;
     /**
      * 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}

package/dist/models/ChatRequest.js

@@ -21,6 +21,7 @@ exports.ChatRequestToJSON = ChatRequestToJSON;
 exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
 const ChatRequestExternalFileUrl_1 = require("./ChatRequestExternalFileUrl");
 const ChatRequestMessageMetadata_1 = require("./ChatRequestMessageMetadata");
+const ChatRequestQuizSettings_1 = require("./ChatRequestQuizSettings");
 const ChatRequestAttachmentsInner_1 = require("./ChatRequestAttachmentsInner");
 const ChatRequestQuizContext_1 = require("./ChatRequestQuizContext");
 /**
@@ -53,6 +54,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']),
+        'quizSettings': json['quizSettings'] == null ? undefined : (0, ChatRequestQuizSettings_1.ChatRequestQuizSettingsFromJSON)(json['quizSettings']),
         'textOnly': json['textOnly'] == null ? undefined : json['textOnly'],
         'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
         'trigger': json['trigger'] == null ? undefined : json['trigger'],
@@ -73,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']),
+        'quizSettings': (0, ChatRequestQuizSettings_1.ChatRequestQuizSettingsToJSON)(value['quizSettings']),
         'textOnly': value['textOnly'],
         'taxonomyId': value['taxonomyId'],
         'trigger': value['trigger'],

package/dist/models/ChatRequestQuizSettings.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 learner-chosen settings for a quiz generated during this turn (question formats, count, free-text focus). Applies to this request only and requires the enhanced-quizzing feature; without it the field is ignored.
+ * @export
+ * @interface ChatRequestQuizSettings
+ */
+export interface ChatRequestQuizSettings {
+    /**
+     * Question formats the quiz may use. Every generated question is one of these; omit to let Athena choose the default active-recall mix. Duplicates are ignored. Only applies to quiz mode.
+     * @type {Array<string>}
+     * @memberof ChatRequestQuizSettings
+     */
+    questionTypes?: Array<ChatRequestQuizSettingsQuestionTypesEnum>;
+    /**
+     * Exact number of questions to generate. Overrides whatever count the conversation would otherwise settle on.
+     * @type {number}
+     * @memberof ChatRequestQuizSettings
+     */
+    questionCount?: number;
+    /**
+     * Free-text notes from the learner about what the quiz should cover, emphasize, or how hard it should be. Steers content only; it cannot change the formats or the count above.
+     * @type {string}
+     * @memberof ChatRequestQuizSettings
+     */
+    instructions?: string;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestQuizSettingsQuestionTypesEnum: {
+    readonly Mcq: "mcq";
+    readonly FillBlank: "fill-blank";
+    readonly SpotError: "spot-error";
+    readonly TeachBack: "teach-back";
+};
+export type ChatRequestQuizSettingsQuestionTypesEnum = typeof ChatRequestQuizSettingsQuestionTypesEnum[keyof typeof ChatRequestQuizSettingsQuestionTypesEnum];
+/**
+ * Check if a given object implements the ChatRequestQuizSettings interface.
+ */
+export declare function instanceOfChatRequestQuizSettings(value: object): value is ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsFromJSON(json: any): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsToJSON(json: any): ChatRequestQuizSettings;
+export declare function ChatRequestQuizSettingsToJSONTyped(value?: ChatRequestQuizSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestQuizSettings.js

@@ -0,0 +1,62 @@
+"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.ChatRequestQuizSettingsQuestionTypesEnum = void 0;
+exports.instanceOfChatRequestQuizSettings = instanceOfChatRequestQuizSettings;
+exports.ChatRequestQuizSettingsFromJSON = ChatRequestQuizSettingsFromJSON;
+exports.ChatRequestQuizSettingsFromJSONTyped = ChatRequestQuizSettingsFromJSONTyped;
+exports.ChatRequestQuizSettingsToJSON = ChatRequestQuizSettingsToJSON;
+exports.ChatRequestQuizSettingsToJSONTyped = ChatRequestQuizSettingsToJSONTyped;
+/**
+ * @export
+ */
+exports.ChatRequestQuizSettingsQuestionTypesEnum = {
+    Mcq: 'mcq',
+    FillBlank: 'fill-blank',
+    SpotError: 'spot-error',
+    TeachBack: 'teach-back'
+};
+/**
+ * Check if a given object implements the ChatRequestQuizSettings interface.
+ */
+function instanceOfChatRequestQuizSettings(value) {
+    return true;
+}
+function ChatRequestQuizSettingsFromJSON(json) {
+    return ChatRequestQuizSettingsFromJSONTyped(json, false);
+}
+function ChatRequestQuizSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'questionTypes': json['questionTypes'] == null ? undefined : json['questionTypes'],
+        'questionCount': json['questionCount'] == null ? undefined : json['questionCount'],
+        'instructions': json['instructions'] == null ? undefined : json['instructions'],
+    };
+}
+function ChatRequestQuizSettingsToJSON(json) {
+    return ChatRequestQuizSettingsToJSONTyped(json, false);
+}
+function ChatRequestQuizSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'questionTypes': value['questionTypes'],
+        'questionCount': value['questionCount'],
+        'instructions': value['instructions'],
+    };
+}

package/dist/models/index.d.ts

@@ -49,6 +49,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ChatRequestQuizSettings';
 export * from './ChatStudyPlanActivity';
 export * from './ConceptAssessmentEntity';
 export * from './ConceptChange';

package/dist/models/index.js

@@ -67,6 +67,7 @@ __exportStar(require("./ChatRequestMessageMetadata"), exports);
 __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);
+__exportStar(require("./ChatRequestQuizSettings"), exports);
 __exportStar(require("./ChatStudyPlanActivity"), exports);
 __exportStar(require("./ConceptAssessmentEntity"), exports);
 __exportStar(require("./ConceptChange"), exports);

package/package.json

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