@@ -79,7 +79,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
7979<!-- Start SDK Example Usage [usage] -->
8080## SDK Example Usage
8181
82- ### Example
82+ ### Example 1
8383
8484``` typescript
8585import { Glean } from " @gleanwork/api-client" ;
@@ -107,6 +107,36 @@ async function run() {
107107
108108run ();
109109
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+
110140```
111141<!-- End SDK Example Usage [usage] -->
112142
@@ -175,10 +205,6 @@ run();
175205* [ listagents] ( docs/sdks/agents/README.md#listagents ) - Lists all agents.
176206* [ getagentinputs] ( docs/sdks/agents/README.md#getagentinputs ) - Gets the inputs to an agent.
177207
178- ### [ chat] ( docs/sdks/chat/README.md )
179-
180- * [ chatStream] ( docs/sdks/chat/README.md#chatstream ) - Chat
181-
182208### [ client] ( docs/sdks/client/README.md )
183209
184210
@@ -208,17 +234,18 @@ run();
208234
209235* [ createToken] ( docs/sdks/clientauthentication/README.md#createtoken ) - Create authentication token
210236
211- #### [ client.chat] ( docs/sdks/clientchat /README.md )
237+ #### [ client.chat] ( docs/sdks/chat /README.md )
212238
213- * [ start] ( docs/sdks/clientchat/README.md#start ) - Chat
214- * [ deleteAll] ( docs/sdks/clientchat/README.md#deleteall ) - Deletes all saved Chats owned by a user
215- * [ delete] ( docs/sdks/clientchat/README.md#delete ) - Deletes saved Chats
216- * [ get] ( docs/sdks/clientchat/README.md#get ) - Retrieves a Chat
217- * [ list] ( docs/sdks/clientchat/README.md#list ) - Retrieves all saved Chats
218- * [ getApplication] ( docs/sdks/clientchat/README.md#getapplication ) - Gets the metadata for a custom Chat application
219- * [ uploadFiles] ( docs/sdks/clientchat/README.md#uploadfiles ) - Upload files for Chat.
220- * [ getFiles] ( docs/sdks/clientchat/README.md#getfiles ) - Get files uploaded by a user for Chat.
221- * [ deleteFiles] ( docs/sdks/clientchat/README.md#deletefiles ) - Delete files uploaded by a user for chat.
239+ * [ start] ( docs/sdks/chat/README.md#start ) - Chat
240+ * [ deleteAll] ( docs/sdks/chat/README.md#deleteall ) - Deletes all saved Chats owned by a user
241+ * [ delete] ( docs/sdks/chat/README.md#delete ) - Deletes saved Chats
242+ * [ get] ( docs/sdks/chat/README.md#get ) - Retrieves a Chat
243+ * [ list] ( docs/sdks/chat/README.md#list ) - Retrieves all saved Chats
244+ * [ getApplication] ( docs/sdks/chat/README.md#getapplication ) - Gets the metadata for a custom Chat application
245+ * [ uploadFiles] ( docs/sdks/chat/README.md#uploadfiles ) - Upload files for Chat.
246+ * [ getFiles] ( docs/sdks/chat/README.md#getfiles ) - Get files uploaded by a user for Chat.
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
222249
223250#### [ client.collections] ( docs/sdks/collections/README.md )
224251
@@ -372,7 +399,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
372399- [ ` agentsGetagentinputs ` ] ( docs/sdks/agents/README.md#getagentinputs ) - Gets the inputs to an agent.
373400- [ ` agentsListagents ` ] ( docs/sdks/agents/README.md#listagents ) - Lists all agents.
374401- [ ` agentsRunagent ` ] ( docs/sdks/agents/README.md#runagent ) - Runs an Agent.
375- - [ ` chatChatStream ` ] ( docs/sdks/chat/README.md#chatstream ) - Chat
376402- [ ` clientActivitiesReportActivity ` ] ( docs/sdks/activities/README.md#reportactivity ) - Report client activity
377403- [ ` clientActivityReport ` ] ( docs/sdks/activity/README.md#report ) - Report document activity
378404- [ ` clientAnnouncementsCreate ` ] ( docs/sdks/announcements/README.md#create ) - Create Announcement
@@ -384,15 +410,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
384410- [ ` clientAnswersGet ` ] ( docs/sdks/answers/README.md#get ) - Read Answer
385411- [ ` clientAnswersList ` ] ( docs/sdks/answers/README.md#list ) - List Answers
386412- [ ` clientAuthenticationCreateToken ` ] ( docs/sdks/clientauthentication/README.md#createtoken ) - Create authentication token
387- - [ ` clientChatDelete ` ] ( docs/sdks/clientchat/README.md#delete ) - Deletes saved Chats
388- - [ ` clientChatDeleteAll ` ] ( docs/sdks/clientchat/README.md#deleteall ) - Deletes all saved Chats owned by a user
389- - [ ` clientChatDeleteFiles ` ] ( docs/sdks/clientchat/README.md#deletefiles ) - Delete files uploaded by a user for chat.
390- - [ ` clientChatGet ` ] ( docs/sdks/clientchat/README.md#get ) - Retrieves a Chat
391- - [ ` clientChatGetApplication ` ] ( docs/sdks/clientchat/README.md#getapplication ) - Gets the metadata for a custom Chat application
392- - [ ` clientChatGetFiles ` ] ( docs/sdks/clientchat/README.md#getfiles ) - Get files uploaded by a user for Chat.
393- - [ ` clientChatList ` ] ( docs/sdks/clientchat/README.md#list ) - Retrieves all saved Chats
394- - [ ` clientChatStart ` ] ( docs/sdks/clientchat/README.md#start ) - Chat
395- - [ ` clientChatUploadFiles ` ] ( docs/sdks/clientchat/README.md#uploadfiles ) - Upload files for Chat.
413+ - [ ` clientChatDelete ` ] ( docs/sdks/chat/README.md#delete ) - Deletes saved Chats
414+ - [ ` clientChatDeleteAll ` ] ( docs/sdks/chat/README.md#deleteall ) - Deletes all saved Chats owned by a user
415+ - [ ` clientChatDeleteFiles ` ] ( docs/sdks/chat/README.md#deletefiles ) - Delete files uploaded by a user for chat.
416+ - [ ` clientChatGet ` ] ( docs/sdks/chat/README.md#get ) - Retrieves a Chat
417+ - [ ` clientChatGetApplication ` ] ( docs/sdks/chat/README.md#getapplication ) - Gets the metadata for a custom Chat application
418+ - [ ` clientChatGetFiles ` ] ( docs/sdks/chat/README.md#getfiles ) - Get files uploaded by a user for Chat.
419+ - [ ` clientChatList ` ] ( docs/sdks/chat/README.md#list ) - Retrieves all saved Chats
420+ - [ ` clientChatStart ` ] ( docs/sdks/chat/README.md#start ) - Chat
421+ - [ ` clientChatStartStream ` ] ( docs/sdks/chat/README.md#startstream ) - Chat
422+ - [ ` clientChatUploadFiles ` ] ( docs/sdks/chat/README.md#uploadfiles ) - Upload files for Chat.
396423- [ ` clientCollectionsAddItems ` ] ( docs/sdks/collections/README.md#additems ) - Add Collection item
397424- [ ` clientCollectionsCreate ` ] ( docs/sdks/collections/README.md#create ) - Create Collection
398425- [ ` clientCollectionsDelete ` ] ( docs/sdks/collections/README.md#delete ) - Delete Collection
@@ -498,7 +525,6 @@ To learn about this feature and how to get started, check
498525- [ ` useAgentsGetagentinputsMutation ` ] ( docs/sdks/agents/README.md#getagentinputs ) - Gets the inputs to an agent.
499526- [ ` useAgentsListagentsMutation ` ] ( docs/sdks/agents/README.md#listagents ) - Lists all agents.
500527- [ ` useAgentsRunagentMutation ` ] ( docs/sdks/agents/README.md#runagent ) - Runs an Agent.
501- - [ ` useChatChatStreamMutation ` ] ( docs/sdks/chat/README.md#chatstream ) - Chat
502528- [ ` useClientActivitiesReportActivityMutation ` ] ( docs/sdks/activities/README.md#reportactivity ) - Report client activity
503529- [ ` useClientActivityReportMutation ` ] ( docs/sdks/activity/README.md#report ) - Report document activity
504530- [ ` useClientAnnouncementsCreateMutation ` ] ( docs/sdks/announcements/README.md#create ) - Create Announcement
@@ -510,15 +536,16 @@ To learn about this feature and how to get started, check
510536- [ ` useClientAnswersGetMutation ` ] ( docs/sdks/answers/README.md#get ) - Read Answer
511537- [ ` useClientAnswersListMutation ` ] ( docs/sdks/answers/README.md#list ) - List Answers
512538- [ ` useClientAuthenticationCreateTokenMutation ` ] ( docs/sdks/clientauthentication/README.md#createtoken ) - Create authentication token
513- - [ ` useClientChatDeleteAllMutation ` ] ( docs/sdks/clientchat/README.md#deleteall ) - Deletes all saved Chats owned by a user
514- - [ ` useClientChatDeleteFilesMutation ` ] ( docs/sdks/clientchat/README.md#deletefiles ) - Delete files uploaded by a user for chat.
515- - [ ` useClientChatDeleteMutation ` ] ( docs/sdks/clientchat/README.md#delete ) - Deletes saved Chats
516- - [ ` useClientChatGetApplicationMutation ` ] ( docs/sdks/clientchat/README.md#getapplication ) - Gets the metadata for a custom Chat application
517- - [ ` useClientChatGetFilesMutation ` ] ( docs/sdks/clientchat/README.md#getfiles ) - Get files uploaded by a user for Chat.
518- - [ ` useClientChatGetMutation ` ] ( docs/sdks/clientchat/README.md#get ) - Retrieves a Chat
519- - [ ` useClientChatListMutation ` ] ( docs/sdks/clientchat/README.md#list ) - Retrieves all saved Chats
520- - [ ` useClientChatStartMutation ` ] ( docs/sdks/clientchat/README.md#start ) - Chat
521- - [ ` useClientChatUploadFilesMutation ` ] ( docs/sdks/clientchat/README.md#uploadfiles ) - Upload files for Chat.
539+ - [ ` useClientChatDeleteAllMutation ` ] ( docs/sdks/chat/README.md#deleteall ) - Deletes all saved Chats owned by a user
540+ - [ ` useClientChatDeleteFilesMutation ` ] ( docs/sdks/chat/README.md#deletefiles ) - Delete files uploaded by a user for chat.
541+ - [ ` useClientChatDeleteMutation ` ] ( docs/sdks/chat/README.md#delete ) - Deletes saved Chats
542+ - [ ` useClientChatGetApplicationMutation ` ] ( docs/sdks/chat/README.md#getapplication ) - Gets the metadata for a custom Chat application
543+ - [ ` useClientChatGetFilesMutation ` ] ( docs/sdks/chat/README.md#getfiles ) - Get files uploaded by a user for Chat.
544+ - [ ` useClientChatGetMutation ` ] ( docs/sdks/chat/README.md#get ) - Retrieves a Chat
545+ - [ ` useClientChatListMutation ` ] ( docs/sdks/chat/README.md#list ) - Retrieves all saved Chats
546+ - [ ` useClientChatStartMutation ` ] ( docs/sdks/chat/README.md#start ) - Chat
547+ - [ ` useClientChatStartStreamMutation ` ] ( docs/sdks/chat/README.md#startstream ) - Chat
548+ - [ ` useClientChatUploadFilesMutation ` ] ( docs/sdks/chat/README.md#uploadfiles ) - Upload files for Chat.
522549- [ ` useClientCollectionsAddItemsMutation ` ] ( docs/sdks/collections/README.md#additems ) - Add Collection item
523550- [ ` useClientCollectionsCreateMutation ` ] ( docs/sdks/collections/README.md#create ) - Create Collection
524551- [ ` useClientCollectionsDeleteItemMutation ` ] ( docs/sdks/collections/README.md#deleteitem ) - Delete Collection item
0 commit comments