$client->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( ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): PageReturns 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.
パラメーター
qstringSearches the titles.
sortstringnewest(the default) oroldestby the last change, ortitle, as inOpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.limitintPage size, from 1 to 100. The server defaults to 25.
cursorstringThe
nextCursorof the previous page. Leave it out for the first page.apiKeystringOverrides the client's API key for this call only.
戻り値
A Page of arrays with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.
例
use OpenEmail\Constants\ChatSorts; $page = $client->chats->list(q: 'invoices', sort: ChatSorts::NEWEST, limit: 20); foreach ($page as $chat) { echo $chat['title'], ' (', $chat['messageCount'], ' messages)', PHP_EOL;} if ($page->hasMore) { $next = $client->chats->list(q: 'invoices', cursor: $page->nextCursor); echo $next->items[0]['title'] ?? 'nothing more', PHP_EOL;}注意事項
A cursor that names nothing in this list is 400
invalid_cursor.
ほかの提供先
- API
GET /chats- TypeScript
chats.list()- Python
chats.list()- Ruby
chats.list- CLI
openemail chats list
chats->listAll
Collect every chat into one array
listAll( ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayWalks every page of list and returns every chat, in the order sort: names. One request per page, with the same filters on each.
パラメーター
qstringSearches the titles.
sortstringnewest(the default) oroldestby the last change, ortitle, as inOpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.limitintPage size for each request, from 1 to 100. The server defaults to 25.
cursorstringStarts the walk after this cursor instead of the first page.
apiKeystringOverrides the client API key for every page of this walk.
戻り値
A list of arrays holding every chat.
例
$chats = $client->chats->listAll(q: 'invoices'); echo implode(PHP_EOL, array_column($chats, 'title')), PHP_EOL;注意事項
If any page fails the call throws and the rows already fetched are discarded.
ほかの提供先
- API
GET /chats- TypeScript
chats.listAll()- Python
chats.list_all()- Ruby
chats.list_all
chats->iterate
Stream the chats one at a time
iterate( ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a 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.
パラメーター
qstringSearches the titles.
sortstringnewest(the default) oroldestby the last change, ortitle, as inOpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.limitintPage size for each request, from 1 to 100. The server defaults to 25.
cursorstringStarts the walk after this cursor instead of the first page.
apiKeystringOverrides the client API key for every page of this walk.
戻り値
A Generator that yields one chat array per step.
例
use OpenEmail\Constants\ChatSorts; foreach ($client->chats->iterate(sort: ChatSorts::TITLE) as $chat) { echo $chat['title'], ' ', $chat['updatedAt'], PHP_EOL;}注意事項
Each page is one request, so a long walk makes many.
ほかの提供先
- API
GET /chats- TypeScript
chats.iterate()- Python
chats.iterate()- Ruby
chats.iterate
chats->get
Retrieve a chat
get(string $id, ?string $apiKey = null): arrayReturns 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.apiKeystringOverrides the client's API key for this call only.
戻り値
An array with id, title, kind, messageCount and updatedAt.
例
$chat = $client->chats->get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65'); echo $chat['title'], ', last changed ', $chat['updatedAt'], PHP_EOL;注意事項
An unknown id is a 404.
ほかの提供先
- API
GET /chats/{id}- TypeScript
chats.get()- Python
chats.get()- Ruby
chats.get- CLI
openemail chats get
chats->rename
Rename a chat
rename(string $id, string $title, ?string $apiKey = null): arrayGives a chat with the assistant a new title, up to 120 characters, and returns 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.
apiKeystringOverrides the client's API key for this call only.
戻り値
The same array as chats->get, with the new title.
例
$chat = $client->chats->rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices'); echo $chat['title'], PHP_EOL;注意事項
An unknown id is a 404.
ほかの提供先
- API
PATCH /chats/{id}- TypeScript
chats.rename()- Python
chats.rename()- Ruby
chats.rename- CLI
openemail chats rename
chats->delete
Delete a chat
delete(string $id, ?string $apiKey = null): arrayDeletes 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.apiKeystringOverrides the client's API key for this call only.
戻り値
An array with object set to chat, the id and deleted set to true.
例
use OpenEmail\Exception\NotFoundException; try { $client->chats->delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65');} catch (NotFoundException) { echo 'Already gone', PHP_EOL;}注意事項
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.
ほかの提供先
- API
DELETE /chats/{id}- TypeScript
chats.delete()- Python
chats.delete()- Ruby
chats.delete- CLI
openemail chats delete