openemail.chats
Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.
Méthodes
The conversations held with the assistant in the app: list and search them, read one, rename it and delete it. Only the workspace owner reaches them.
chats.list()
List the assistant chats
list(options?: ChatListOptions): Promise<Page<ChatResource>>Resolves one page of the conversations held with the assistant in the app, newest first, as its Chats page lists them, each with its title, how many messages it holds and when it last changed.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Paramètres
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size, from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorof the previous page. Leave it out for the first page.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Retourne
Page<ChatResource> with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.
Exemple
const page = await openemail.chats.list({ q: 'invoices' }) for (const chat of page.items) console.log(chat.title, chat.messageCount)Remarques
A cursor that names nothing in this list is 400
invalid_cursor.
Aussi disponible dans
chats.listAll()
Collect every chat into one array
listAll(options?: ChatListOptions): Promise<Array<ChatResource>>Walks every page of list and resolves with every chat, in the order sort names. One request per page, with the same filters on each.
Paramètres
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Retourne
Array<ChatResource> holding every chat.
Exemple
const chats = await openemail.chats.listAll() console.log(chats.length)Remarques
If any page fails the promise rejects and the rows already fetched are discarded.
Aussi disponible dans
- API
GET /chats
chats.iterate()
Stream the chats one at a time
iterate(options?: ChatListOptions): AsyncGenerator<ChatResource, void, undefined>Returns an async generator that yields one chat at a time, in the order sort names, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Paramètres
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Retourne
AsyncGenerator<ChatResource, void, undefined> yielding one chat per step.
Exemple
for await (const chat of openemail.chats.iterate({ sort: 'title' })) console.log(chat.title)Remarques
Each page is one request, so a long walk makes many.
Aussi disponible dans
- API
GET /chats
chats.get()
Retrieve a chat
get(id: string, options?: RequestScope): Promise<ChatResource>Resolves one chat with the assistant by its id: its title, how many messages it holds and when it last changed.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Paramètres
idstringObligatoireThe chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Retourne
ChatResource with id, title, kind, messageCount and updatedAt.
Exemple
const chat = await openemail.chats.get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65') console.log(chat.title)Remarques
An unknown id is a 404.
Aussi disponible dans
chats.rename()
Rename a chat
rename(id: string, title: string, options?: RequestScope): Promise<ChatResource>Gives a chat with the assistant a new title, up to 120 characters, and resolves with the chat as it is now.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Paramètres
idstringObligatoireThe chat id from
list.titlestringObligatoireThe new title, from 1 to 120 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Retourne
ChatResource with the new title.
Exemple
await openemail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices')Remarques
An unknown id is a 404.
Aussi disponible dans
chats.delete()
Delete a chat
delete(id: string, options?: RequestScope): Promise<DeletedChatResource>Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.
Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.
Paramètres
idstringObligatoireThe chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Retourne
DeletedChatResource with object: 'chat', the id and deleted: true.
Exemple
await openemail.chats.delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65')Remarques
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.