@gleanwork/api-client 0.1.0-beta.3 → 0.1.0-beta.5

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 (90) hide show
  1. package/README.md +34 -1
  2. package/dist/commonjs/__tests__/chat.test.js +233 -414
  3. package/dist/commonjs/__tests__/chat.test.js.map +1 -1
  4. package/dist/commonjs/funcs/clientChatStart.d.ts +1 -1
  5. package/dist/commonjs/funcs/clientChatStart.d.ts.map +1 -1
  6. package/dist/commonjs/funcs/clientChatStart.js +3 -3
  7. package/dist/commonjs/funcs/clientChatStart.js.map +1 -1
  8. package/dist/commonjs/funcs/clientChatStartStream.d.ts +16 -0
  9. package/dist/commonjs/funcs/clientChatStartStream.d.ts.map +1 -0
  10. package/dist/commonjs/funcs/clientChatStartStream.js +121 -0
  11. package/dist/commonjs/funcs/clientChatStartStream.js.map +1 -0
  12. package/dist/commonjs/lib/config.d.ts +2 -2
  13. package/dist/commonjs/lib/config.js +2 -2
  14. package/dist/commonjs/models/components/workflow.d.ts +0 -2
  15. package/dist/commonjs/models/components/workflow.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/workflow.js.map +1 -1
  17. package/dist/commonjs/models/operations/chatstream.d.ts +38 -0
  18. package/dist/commonjs/models/operations/chatstream.d.ts.map +1 -0
  19. package/dist/commonjs/models/operations/chatstream.js +81 -0
  20. package/dist/commonjs/models/operations/chatstream.js.map +1 -0
  21. package/dist/commonjs/models/operations/index.d.ts +1 -0
  22. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  23. package/dist/commonjs/models/operations/index.js +1 -0
  24. package/dist/commonjs/models/operations/index.js.map +1 -1
  25. package/dist/commonjs/react-query/clientChatStart.d.ts +1 -1
  26. package/dist/commonjs/react-query/clientChatStart.d.ts.map +1 -1
  27. package/dist/commonjs/react-query/clientChatStartStream.d.ts +24 -0
  28. package/dist/commonjs/react-query/clientChatStartStream.d.ts.map +1 -0
  29. package/dist/commonjs/react-query/clientChatStartStream.js +47 -0
  30. package/dist/commonjs/react-query/clientChatStartStream.js.map +1 -0
  31. package/dist/commonjs/react-query/index.d.ts +1 -0
  32. package/dist/commonjs/react-query/index.d.ts.map +1 -1
  33. package/dist/commonjs/react-query/index.js +1 -0
  34. package/dist/commonjs/react-query/index.js.map +1 -1
  35. package/dist/commonjs/sdk/chat.d.ts +8 -1
  36. package/dist/commonjs/sdk/chat.d.ts.map +1 -1
  37. package/dist/commonjs/sdk/chat.js +10 -0
  38. package/dist/commonjs/sdk/chat.js.map +1 -1
  39. package/dist/esm/__tests__/chat.test.js +234 -415
  40. package/dist/esm/__tests__/chat.test.js.map +1 -1
  41. package/dist/esm/funcs/clientChatStart.d.ts +1 -1
  42. package/dist/esm/funcs/clientChatStart.d.ts.map +1 -1
  43. package/dist/esm/funcs/clientChatStart.js +3 -3
  44. package/dist/esm/funcs/clientChatStart.js.map +1 -1
  45. package/dist/esm/funcs/clientChatStartStream.d.ts +16 -0
  46. package/dist/esm/funcs/clientChatStartStream.d.ts.map +1 -0
  47. package/dist/esm/funcs/clientChatStartStream.js +85 -0
  48. package/dist/esm/funcs/clientChatStartStream.js.map +1 -0
  49. package/dist/esm/lib/config.d.ts +2 -2
  50. package/dist/esm/lib/config.js +2 -2
  51. package/dist/esm/models/components/workflow.d.ts +0 -2
  52. package/dist/esm/models/components/workflow.d.ts.map +1 -1
  53. package/dist/esm/models/components/workflow.js.map +1 -1
  54. package/dist/esm/models/operations/chatstream.d.ts +38 -0
  55. package/dist/esm/models/operations/chatstream.d.ts.map +1 -0
  56. package/dist/esm/models/operations/chatstream.js +43 -0
  57. package/dist/esm/models/operations/chatstream.js.map +1 -0
  58. package/dist/esm/models/operations/index.d.ts +1 -0
  59. package/dist/esm/models/operations/index.d.ts.map +1 -1
  60. package/dist/esm/models/operations/index.js +1 -0
  61. package/dist/esm/models/operations/index.js.map +1 -1
  62. package/dist/esm/react-query/clientChatStart.d.ts +1 -1
  63. package/dist/esm/react-query/clientChatStart.d.ts.map +1 -1
  64. package/dist/esm/react-query/clientChatStartStream.d.ts +24 -0
  65. package/dist/esm/react-query/clientChatStartStream.d.ts.map +1 -0
  66. package/dist/esm/react-query/clientChatStartStream.js +42 -0
  67. package/dist/esm/react-query/clientChatStartStream.js.map +1 -0
  68. package/dist/esm/react-query/index.d.ts +1 -0
  69. package/dist/esm/react-query/index.d.ts.map +1 -1
  70. package/dist/esm/react-query/index.js +1 -0
  71. package/dist/esm/react-query/index.js.map +1 -1
  72. package/dist/esm/sdk/chat.d.ts +8 -1
  73. package/dist/esm/sdk/chat.d.ts.map +1 -1
  74. package/dist/esm/sdk/chat.js +10 -0
  75. package/dist/esm/sdk/chat.js.map +1 -1
  76. package/docs/sdks/chat/README.md +112 -1
  77. package/docs/sdks/glean/README.md +10 -0
  78. package/jsr.json +1 -1
  79. package/package.json +1 -1
  80. package/src/__tests__/chat.test.ts +292 -457
  81. package/src/funcs/clientChatStart.ts +5 -6
  82. package/src/funcs/clientChatStartStream.ts +169 -0
  83. package/src/lib/config.ts +2 -2
  84. package/src/models/components/workflow.ts +0 -2
  85. package/src/models/operations/chatstream.ts +86 -0
  86. package/src/models/operations/index.ts +1 -0
  87. package/src/react-query/clientChatStart.ts +1 -1
  88. package/src/react-query/clientChatStartStream.ts +91 -0
  89. package/src/react-query/index.ts +1 -0
  90. package/src/sdk/chat.ts +21 -1
package/README.md CHANGED
@@ -79,7 +79,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
79
79
  <!-- Start SDK Example Usage [usage] -->
80
80
  ## SDK Example Usage
81
81
 
82
- ### Example
82
+ ### Example 1
83
83
 
84
84
  ```typescript
85
85
  import { Glean } from "@gleanwork/api-client";
@@ -107,6 +107,36 @@ async function run() {
107
107
 
108
108
  run();
109
109
 
110
+ ```
111
+
112
+ ### Example 2
113
+
114
+ ```typescript
115
+ import { Glean } from "@gleanwork/api-client";
116
+
117
+ const glean = new Glean({
118
+ bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
119
+ });
120
+
121
+ async function run() {
122
+ const result = await glean.client.chat.startStream({
123
+ messages: [
124
+ {
125
+ fragments: [
126
+ {
127
+ text: "What are the company holidays this year?",
128
+ },
129
+ ],
130
+ },
131
+ ],
132
+ });
133
+
134
+ // Handle the result
135
+ console.log(result);
136
+ }
137
+
138
+ run();
139
+
110
140
  ```
111
141
  <!-- End SDK Example Usage [usage] -->
112
142
 
@@ -215,6 +245,7 @@ run();
215
245
  * [uploadFiles](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
216
246
  * [getFiles](docs/sdks/chat/README.md#getfiles) - Get files uploaded by a user for Chat.
217
247
  * [deleteFiles](docs/sdks/chat/README.md#deletefiles) - Delete files uploaded by a user for chat.
248
+ * [startStream](docs/sdks/chat/README.md#startstream) - Chat
218
249
 
219
250
  #### [client.collections](docs/sdks/collections/README.md)
220
251
 
@@ -387,6 +418,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
387
418
  - [`clientChatGetFiles`](docs/sdks/chat/README.md#getfiles) - Get files uploaded by a user for Chat.
388
419
  - [`clientChatList`](docs/sdks/chat/README.md#list) - Retrieves all saved Chats
389
420
  - [`clientChatStart`](docs/sdks/chat/README.md#start) - Chat
421
+ - [`clientChatStartStream`](docs/sdks/chat/README.md#startstream) - Chat
390
422
  - [`clientChatUploadFiles`](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
391
423
  - [`clientCollectionsAddItems`](docs/sdks/collections/README.md#additems) - Add Collection item
392
424
  - [`clientCollectionsCreate`](docs/sdks/collections/README.md#create) - Create Collection
@@ -512,6 +544,7 @@ To learn about this feature and how to get started, check
512
544
  - [`useClientChatGetMutation`](docs/sdks/chat/README.md#get) - Retrieves a Chat
513
545
  - [`useClientChatListMutation`](docs/sdks/chat/README.md#list) - Retrieves all saved Chats
514
546
  - [`useClientChatStartMutation`](docs/sdks/chat/README.md#start) - Chat
547
+ - [`useClientChatStartStreamMutation`](docs/sdks/chat/README.md#startstream) - Chat
515
548
  - [`useClientChatUploadFilesMutation`](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
516
549
  - [`useClientCollectionsAddItemsMutation`](docs/sdks/collections/README.md#additems) - Add Collection item
517
550
  - [`useClientCollectionsCreateMutation`](docs/sdks/collections/README.md#create) - Create Collection