openemail.chats
この名前空間のすべてのメソッドの、シグネチャ、パラメーター、戻り値、例。
メソッド
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.
パラメーター
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.
戻り値
Page<ChatResource> with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.
例
const page = await openemail.chats.list({ q: 'invoices' }) for (const chat of page.items) console.log(chat.title, chat.messageCount)注意事項
A cursor that names nothing in this list is 400
invalid_cursor.
ほかの提供先
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.
パラメーター
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.
戻り値
Array<ChatResource> holding every chat.
例
const chats = await openemail.chats.listAll() console.log(chats.length)注意事項
If any page fails the promise rejects and the rows already fetched are discarded.
ほかの提供先
- 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.
パラメーター
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.
戻り値
AsyncGenerator<ChatResource, void, undefined> yielding one chat per step.
例
for await (const chat of openemail.chats.iterate({ sort: 'title' })) console.log(chat.title)注意事項
Each page is one request, so a long walk makes many.
ほかの提供先
- 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.
パラメーター
idstring必須The chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
ChatResource with id, title, kind, messageCount and updatedAt.
例
const chat = await openemail.chats.get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65') console.log(chat.title)注意事項
An unknown id is a 404.
ほかの提供先
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.
パラメーター
idstring必須The chat id from
list.titlestring必須The new title, from 1 to 120 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
ChatResource with the new title.
例
await openemail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices')注意事項
An unknown id is a 404.
ほかの提供先
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.
パラメーター
idstring必須The chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
戻り値
DeletedChatResource with object: 'chat', the id and deleted: true.
例
await openemail.chats.delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65')注意事項
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.