@instructure/athena-api-client 3.18.2 → 3.18.3

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 (3) hide show
  1. package/dist/esm/models/CreateChatRequest.d.ts +1 -1
  2. package/dist/models/CreateChatRequest.d.ts +1 -1
  3. package/package.json +1 -1
package/dist/esm/models/CreateChatRequest.d.ts CHANGED
@@ -58,7 +58,7 @@ export interface CreateChatRequest {
58
58
  */
59
59
  taxonomyId?: string;
60
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.
61
+ * Optional Canvas course id to ground this chat to (study-space quick actions). Persists on `chats.courseId`. When set on a conversational chat (chatType null), the chat stream injects a study-space context block that asserts the course is the subject of the chat and, when the learner's Canvas tools are registered, points the model at the course's Canvas data. Not injected for typed chats (onboarding, quizzes, learning sessions), whose curated prompts don't expect it. Not validated against a local course row — Canvas courses are not mirrored in this database.
62
62
  * @type {string}
63
63
  * @memberof CreateChatRequest
64
64
  */
package/dist/models/CreateChatRequest.d.ts CHANGED
@@ -58,7 +58,7 @@ export interface CreateChatRequest {
58
58
  */
59
59
  taxonomyId?: string;
60
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.
61
+ * Optional Canvas course id to ground this chat to (study-space quick actions). Persists on `chats.courseId`. When set on a conversational chat (chatType null), the chat stream injects a study-space context block that asserts the course is the subject of the chat and, when the learner's Canvas tools are registered, points the model at the course's Canvas data. Not injected for typed chats (onboarding, quizzes, learning sessions), whose curated prompts don't expect it. Not validated against a local course row — Canvas courses are not mirrored in this database.
62
62
  * @type {string}
63
63
  * @memberof CreateChatRequest
64
64
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.18.2",
4
+ "version": "3.18.3",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {