@instructure/athena-api-client 3.11.4 → 3.12.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.
Files changed (9) hide show
  1. package/dist/esm/models/Chat.d.ts +6 -0
  2. package/dist/esm/models/Chat.js +4 -0
  3. package/dist/esm/models/CreateChatRequest.d.ts +6 -0
  4. package/dist/esm/models/CreateChatRequest.js +2 -0
  5. package/dist/models/Chat.d.ts +6 -0
  6. package/dist/models/Chat.js +4 -0
  7. package/dist/models/CreateChatRequest.d.ts +6 -0
  8. package/dist/models/CreateChatRequest.js +2 -0
  9. package/package.json +1 -1
package/dist/esm/models/Chat.d.ts CHANGED
@@ -99,6 +99,12 @@ export interface Chat {
99
99
  * @memberof Chat
100
100
  */
101
101
  taxonomyId: string | null;
102
+ /**
103
+ * Optional Canvas course id the chat is grounded to. When set, the chat stream injects study-space context pointing the model at the course's Canvas data on every turn. Null for chats without course grounding.
104
+ * @type {string}
105
+ * @memberof Chat
106
+ */
107
+ courseId: string | null;
102
108
  /**
103
109
  * Snapshot of the learner's strength (0..1) captured when a learning session chat was created. Only populated for chatType 'level-up' or 'quick-practice'; null otherwise.
104
110
  * @type {number}
package/dist/esm/models/Chat.js CHANGED
@@ -50,6 +50,8 @@ export function instanceOfChat(value) {
50
50
  return false;
51
51
  if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
52
52
  return false;
53
+ if (!('courseId' in value) || value['courseId'] === undefined)
54
+ return false;
53
55
  if (!('initialStrength' in value) || value['initialStrength'] === undefined)
54
56
  return false;
55
57
  if (!('primaryConceptId' in value) || value['primaryConceptId'] === undefined)
@@ -80,6 +82,7 @@ export function ChatFromJSONTyped(json, ignoreDiscriminator) {
80
82
  'goalAchieved': json['goalAchieved'],
81
83
  'forReview': json['forReview'],
82
84
  'taxonomyId': json['taxonomyId'],
85
+ 'courseId': json['courseId'],
83
86
  'initialStrength': json['initialStrength'],
84
87
  'primaryConceptId': json['primaryConceptId'],
85
88
  'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
@@ -107,6 +110,7 @@ export function ChatToJSONTyped(value, ignoreDiscriminator = false) {
107
110
  'goalAchieved': value['goalAchieved'],
108
111
  'forReview': value['forReview'],
109
112
  'taxonomyId': value['taxonomyId'],
113
+ 'courseId': value['courseId'],
110
114
  'initialStrength': value['initialStrength'],
111
115
  'primaryConceptId': value['primaryConceptId'],
112
116
  'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
package/dist/esm/models/CreateChatRequest.d.ts CHANGED
@@ -57,6 +57,12 @@ export interface CreateChatRequest {
57
57
  * @memberof CreateChatRequest
58
58
  */
59
59
  taxonomyId?: string;
60
+ /**
61
+ * Optional Canvas course id to ground this chat to (study-space quick actions). Persists on `chats.courseId`. When set, the chat stream injects a study-space context block pointing the model at the course's Canvas data on every turn, independent of chatType. Not validated against a local course row — Canvas courses are not mirrored in this database.
62
+ * @type {string}
63
+ * @memberof CreateChatRequest
64
+ */
65
+ courseId?: string;
60
66
  }
61
67
  /**
62
68
  * @export
package/dist/esm/models/CreateChatRequest.js CHANGED
@@ -39,6 +39,7 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
39
39
  'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
40
40
  'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
41
41
  'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
42
+ 'courseId': json['courseId'] == null ? undefined : json['courseId'],
42
43
  };
43
44
  }
44
45
  export function CreateChatRequestToJSON(json) {
@@ -56,5 +57,6 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
56
57
  'primaryConceptId': value['primaryConceptId'],
57
58
  'initialStrength': value['initialStrength'],
58
59
  'taxonomyId': value['taxonomyId'],
60
+ 'courseId': value['courseId'],
59
61
  };
60
62
  }
package/dist/models/Chat.d.ts CHANGED
@@ -99,6 +99,12 @@ export interface Chat {
99
99
  * @memberof Chat
100
100
  */
101
101
  taxonomyId: string | null;
102
+ /**
103
+ * Optional Canvas course id the chat is grounded to. When set, the chat stream injects study-space context pointing the model at the course's Canvas data on every turn. Null for chats without course grounding.
104
+ * @type {string}
105
+ * @memberof Chat
106
+ */
107
+ courseId: string | null;
102
108
  /**
103
109
  * Snapshot of the learner's strength (0..1) captured when a learning session chat was created. Only populated for chatType 'level-up' or 'quick-practice'; null otherwise.
104
110
  * @type {number}
package/dist/models/Chat.js CHANGED
@@ -58,6 +58,8 @@ function instanceOfChat(value) {
58
58
  return false;
59
59
  if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
60
60
  return false;
61
+ if (!('courseId' in value) || value['courseId'] === undefined)
62
+ return false;
61
63
  if (!('initialStrength' in value) || value['initialStrength'] === undefined)
62
64
  return false;
63
65
  if (!('primaryConceptId' in value) || value['primaryConceptId'] === undefined)
@@ -88,6 +90,7 @@ function ChatFromJSONTyped(json, ignoreDiscriminator) {
88
90
  'goalAchieved': json['goalAchieved'],
89
91
  'forReview': json['forReview'],
90
92
  'taxonomyId': json['taxonomyId'],
93
+ 'courseId': json['courseId'],
91
94
  'initialStrength': json['initialStrength'],
92
95
  'primaryConceptId': json['primaryConceptId'],
93
96
  'closedAt': (json['closedAt'] == null ? null : new Date(json['closedAt'])),
@@ -115,6 +118,7 @@ function ChatToJSONTyped(value, ignoreDiscriminator = false) {
115
118
  'goalAchieved': value['goalAchieved'],
116
119
  'forReview': value['forReview'],
117
120
  'taxonomyId': value['taxonomyId'],
121
+ 'courseId': value['courseId'],
118
122
  'initialStrength': value['initialStrength'],
119
123
  'primaryConceptId': value['primaryConceptId'],
120
124
  'closedAt': value['closedAt'] == null ? value['closedAt'] : value['closedAt'].toISOString(),
package/dist/models/CreateChatRequest.d.ts CHANGED
@@ -57,6 +57,12 @@ export interface CreateChatRequest {
57
57
  * @memberof CreateChatRequest
58
58
  */
59
59
  taxonomyId?: string;
60
+ /**
61
+ * Optional Canvas course id to ground this chat to (study-space quick actions). Persists on `chats.courseId`. When set, the chat stream injects a study-space context block pointing the model at the course's Canvas data on every turn, independent of chatType. Not validated against a local course row — Canvas courses are not mirrored in this database.
62
+ * @type {string}
63
+ * @memberof CreateChatRequest
64
+ */
65
+ courseId?: string;
60
66
  }
61
67
  /**
62
68
  * @export
package/dist/models/CreateChatRequest.js CHANGED
@@ -47,6 +47,7 @@ function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
47
47
  'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
48
48
  'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
49
49
  'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
50
+ 'courseId': json['courseId'] == null ? undefined : json['courseId'],
50
51
  };
51
52
  }
52
53
  function CreateChatRequestToJSON(json) {
@@ -64,5 +65,6 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
64
65
  'primaryConceptId': value['primaryConceptId'],
65
66
  'initialStrength': value['initialStrength'],
66
67
  'taxonomyId': value['taxonomyId'],
68
+ 'courseId': value['courseId'],
67
69
  };
68
70
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.11.4",
4
+ "version": "3.12.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {