@instructure/athena-api-client 2.21.0 → 2.22.1

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.
Files changed (5) hide show
  1. package/dist/esm/models/ChatRequestMessageMetadata.d.ts +9 -3
  2. package/dist/esm/models/ChatRequestMessageMetadata.js +3 -3
  3. package/dist/models/ChatRequestMessageMetadata.d.ts +9 -3
  4. package/dist/models/ChatRequestMessageMetadata.js +3 -3
  5. package/package.json +1 -1
package/dist/esm/models/ChatRequestMessageMetadata.d.ts CHANGED
@@ -10,17 +10,17 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Optional metadata attached to the user message, used by learning session chats to bind an answer to its inline question and scoring context.
13
+ * Optional metadata attached to the user message. Used by learning session chats to bind an answer to its inline question (`inlineQuestionId` + `questionType` + `structuredAnswer`) and to mark client-auto-fired kickoff turns (`synthetic`). All fields are optional; callers supply whichever subset applies to the message being sent.
14
14
  * @export
15
15
  * @interface ChatRequestMessageMetadata
16
16
  */
17
17
  export interface ChatRequestMessageMetadata {
18
18
  /**
19
- * Identifier of the inline question this user message is answering.
19
+ * Identifier of the inline question this user message is answering. Omitted on synthetic kickoff messages (see `synthetic`).
20
20
  * @type {string}
21
21
  * @memberof ChatRequestMessageMetadata
22
22
  */
23
- inlineQuestionId: string;
23
+ inlineQuestionId?: string;
24
24
  /**
25
25
  * Widget shape the inline question used (free-text, fill-blank, teach-back, spot-error).
26
26
  * @type {string}
@@ -33,6 +33,12 @@ export interface ChatRequestMessageMetadata {
33
33
  * @memberof ChatRequestMessageMetadata
34
34
  */
35
35
  structuredAnswer?: any | null;
36
+ /**
37
+ * True when the user message is auto-fired by the client on behalf of the learner (daily-quiz opener, level-up-initiate / quick-practice-initiate kickoff). Informational only — server-side code paths do not branch on it. Persisted on the user message's first text part so clients can suppress the turn from the rendered transcript on rehydration. Absence is equivalent to `false`.
38
+ * @type {boolean}
39
+ * @memberof ChatRequestMessageMetadata
40
+ */
41
+ synthetic?: boolean;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the ChatRequestMessageMetadata interface.
package/dist/esm/models/ChatRequestMessageMetadata.js CHANGED
@@ -15,8 +15,6 @@
15
15
  * Check if a given object implements the ChatRequestMessageMetadata interface.
16
16
  */
17
17
  export function instanceOfChatRequestMessageMetadata(value) {
18
- if (!('inlineQuestionId' in value) || value['inlineQuestionId'] === undefined)
19
- return false;
20
18
  return true;
21
19
  }
22
20
  export function ChatRequestMessageMetadataFromJSON(json) {
@@ -27,9 +25,10 @@ export function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminato
27
25
  return json;
28
26
  }
29
27
  return {
30
- 'inlineQuestionId': json['inlineQuestionId'],
28
+ 'inlineQuestionId': json['inlineQuestionId'] == null ? undefined : json['inlineQuestionId'],
31
29
  'questionType': json['questionType'] == null ? undefined : json['questionType'],
32
30
  'structuredAnswer': json['structuredAnswer'] == null ? undefined : json['structuredAnswer'],
31
+ 'synthetic': json['synthetic'] == null ? undefined : json['synthetic'],
33
32
  };
34
33
  }
35
34
  export function ChatRequestMessageMetadataToJSON(json) {
@@ -43,5 +42,6 @@ export function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator
43
42
  'inlineQuestionId': value['inlineQuestionId'],
44
43
  'questionType': value['questionType'],
45
44
  'structuredAnswer': value['structuredAnswer'],
45
+ 'synthetic': value['synthetic'],
46
46
  };
47
47
  }
package/dist/models/ChatRequestMessageMetadata.d.ts CHANGED
@@ -10,17 +10,17 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Optional metadata attached to the user message, used by learning session chats to bind an answer to its inline question and scoring context.
13
+ * Optional metadata attached to the user message. Used by learning session chats to bind an answer to its inline question (`inlineQuestionId` + `questionType` + `structuredAnswer`) and to mark client-auto-fired kickoff turns (`synthetic`). All fields are optional; callers supply whichever subset applies to the message being sent.
14
14
  * @export
15
15
  * @interface ChatRequestMessageMetadata
16
16
  */
17
17
  export interface ChatRequestMessageMetadata {
18
18
  /**
19
- * Identifier of the inline question this user message is answering.
19
+ * Identifier of the inline question this user message is answering. Omitted on synthetic kickoff messages (see `synthetic`).
20
20
  * @type {string}
21
21
  * @memberof ChatRequestMessageMetadata
22
22
  */
23
- inlineQuestionId: string;
23
+ inlineQuestionId?: string;
24
24
  /**
25
25
  * Widget shape the inline question used (free-text, fill-blank, teach-back, spot-error).
26
26
  * @type {string}
@@ -33,6 +33,12 @@ export interface ChatRequestMessageMetadata {
33
33
  * @memberof ChatRequestMessageMetadata
34
34
  */
35
35
  structuredAnswer?: any | null;
36
+ /**
37
+ * True when the user message is auto-fired by the client on behalf of the learner (daily-quiz opener, level-up-initiate / quick-practice-initiate kickoff). Informational only — server-side code paths do not branch on it. Persisted on the user message's first text part so clients can suppress the turn from the rendered transcript on rehydration. Absence is equivalent to `false`.
38
+ * @type {boolean}
39
+ * @memberof ChatRequestMessageMetadata
40
+ */
41
+ synthetic?: boolean;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the ChatRequestMessageMetadata interface.
package/dist/models/ChatRequestMessageMetadata.js CHANGED
@@ -22,8 +22,6 @@ exports.ChatRequestMessageMetadataToJSONTyped = ChatRequestMessageMetadataToJSON
22
22
  * Check if a given object implements the ChatRequestMessageMetadata interface.
23
23
  */
24
24
  function instanceOfChatRequestMessageMetadata(value) {
25
- if (!('inlineQuestionId' in value) || value['inlineQuestionId'] === undefined)
26
- return false;
27
25
  return true;
28
26
  }
29
27
  function ChatRequestMessageMetadataFromJSON(json) {
@@ -34,9 +32,10 @@ function ChatRequestMessageMetadataFromJSONTyped(json, ignoreDiscriminator) {
34
32
  return json;
35
33
  }
36
34
  return {
37
- 'inlineQuestionId': json['inlineQuestionId'],
35
+ 'inlineQuestionId': json['inlineQuestionId'] == null ? undefined : json['inlineQuestionId'],
38
36
  'questionType': json['questionType'] == null ? undefined : json['questionType'],
39
37
  'structuredAnswer': json['structuredAnswer'] == null ? undefined : json['structuredAnswer'],
38
+ 'synthetic': json['synthetic'] == null ? undefined : json['synthetic'],
40
39
  };
41
40
  }
42
41
  function ChatRequestMessageMetadataToJSON(json) {
@@ -50,5 +49,6 @@ function ChatRequestMessageMetadataToJSONTyped(value, ignoreDiscriminator = fals
50
49
  'inlineQuestionId': value['inlineQuestionId'],
51
50
  'questionType': value['questionType'],
52
51
  'structuredAnswer': value['structuredAnswer'],
52
+ 'synthetic': value['synthetic'],
53
53
  };
54
54
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.21.0",
4
+ "version": "2.22.1",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {