@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.
- package/README.md +34 -1
- package/dist/commonjs/__tests__/chat.test.js +233 -414
- package/dist/commonjs/__tests__/chat.test.js.map +1 -1
- package/dist/commonjs/funcs/clientChatStart.d.ts +1 -1
- package/dist/commonjs/funcs/clientChatStart.d.ts.map +1 -1
- package/dist/commonjs/funcs/clientChatStart.js +3 -3
- package/dist/commonjs/funcs/clientChatStart.js.map +1 -1
- package/dist/commonjs/funcs/clientChatStartStream.d.ts +16 -0
- package/dist/commonjs/funcs/clientChatStartStream.d.ts.map +1 -0
- package/dist/commonjs/funcs/clientChatStartStream.js +121 -0
- package/dist/commonjs/funcs/clientChatStartStream.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/models/components/workflow.d.ts +0 -2
- package/dist/commonjs/models/components/workflow.d.ts.map +1 -1
- package/dist/commonjs/models/components/workflow.js.map +1 -1
- package/dist/commonjs/models/operations/chatstream.d.ts +38 -0
- package/dist/commonjs/models/operations/chatstream.d.ts.map +1 -0
- package/dist/commonjs/models/operations/chatstream.js +81 -0
- package/dist/commonjs/models/operations/chatstream.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/react-query/clientChatStart.d.ts +1 -1
- package/dist/commonjs/react-query/clientChatStart.d.ts.map +1 -1
- package/dist/commonjs/react-query/clientChatStartStream.d.ts +24 -0
- package/dist/commonjs/react-query/clientChatStartStream.d.ts.map +1 -0
- package/dist/commonjs/react-query/clientChatStartStream.js +47 -0
- package/dist/commonjs/react-query/clientChatStartStream.js.map +1 -0
- package/dist/commonjs/react-query/index.d.ts +1 -0
- package/dist/commonjs/react-query/index.d.ts.map +1 -1
- package/dist/commonjs/react-query/index.js +1 -0
- package/dist/commonjs/react-query/index.js.map +1 -1
- package/dist/commonjs/sdk/chat.d.ts +8 -1
- package/dist/commonjs/sdk/chat.d.ts.map +1 -1
- package/dist/commonjs/sdk/chat.js +10 -0
- package/dist/commonjs/sdk/chat.js.map +1 -1
- package/dist/esm/__tests__/chat.test.js +234 -415
- package/dist/esm/__tests__/chat.test.js.map +1 -1
- package/dist/esm/funcs/clientChatStart.d.ts +1 -1
- package/dist/esm/funcs/clientChatStart.d.ts.map +1 -1
- package/dist/esm/funcs/clientChatStart.js +3 -3
- package/dist/esm/funcs/clientChatStart.js.map +1 -1
- package/dist/esm/funcs/clientChatStartStream.d.ts +16 -0
- package/dist/esm/funcs/clientChatStartStream.d.ts.map +1 -0
- package/dist/esm/funcs/clientChatStartStream.js +85 -0
- package/dist/esm/funcs/clientChatStartStream.js.map +1 -0
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/models/components/workflow.d.ts +0 -2
- package/dist/esm/models/components/workflow.d.ts.map +1 -1
- package/dist/esm/models/components/workflow.js.map +1 -1
- package/dist/esm/models/operations/chatstream.d.ts +38 -0
- package/dist/esm/models/operations/chatstream.d.ts.map +1 -0
- package/dist/esm/models/operations/chatstream.js +43 -0
- package/dist/esm/models/operations/chatstream.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/react-query/clientChatStart.d.ts +1 -1
- package/dist/esm/react-query/clientChatStart.d.ts.map +1 -1
- package/dist/esm/react-query/clientChatStartStream.d.ts +24 -0
- package/dist/esm/react-query/clientChatStartStream.d.ts.map +1 -0
- package/dist/esm/react-query/clientChatStartStream.js +42 -0
- package/dist/esm/react-query/clientChatStartStream.js.map +1 -0
- package/dist/esm/react-query/index.d.ts +1 -0
- package/dist/esm/react-query/index.d.ts.map +1 -1
- package/dist/esm/react-query/index.js +1 -0
- package/dist/esm/react-query/index.js.map +1 -1
- package/dist/esm/sdk/chat.d.ts +8 -1
- package/dist/esm/sdk/chat.d.ts.map +1 -1
- package/dist/esm/sdk/chat.js +10 -0
- package/dist/esm/sdk/chat.js.map +1 -1
- package/docs/sdks/chat/README.md +112 -1
- package/docs/sdks/glean/README.md +10 -0
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/chat.test.ts +292 -457
- package/src/funcs/clientChatStart.ts +5 -6
- package/src/funcs/clientChatStartStream.ts +169 -0
- package/src/lib/config.ts +2 -2
- package/src/models/components/workflow.ts +0 -2
- package/src/models/operations/chatstream.ts +86 -0
- package/src/models/operations/index.ts +1 -0
- package/src/react-query/clientChatStart.ts +1 -1
- package/src/react-query/clientChatStartStream.ts +91 -0
- package/src/react-query/index.ts +1 -0
- 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
|