PHP

$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

threads:readنتایج را صفحه‌به‌صفحه مرور می‌کند

امضای متد

list(    ?string $q = null,    ?string $sort = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Page

Returns 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.

پارامترها

qstring: Searches the titles.
sortstring: newest (the default) or oldest by the last change, or title, as in OpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.
limitint: Page size, from 1 to 100. The server defaults to 25.
cursorstring: The nextCursor of the previous page. Leave it out for the first page.
apiKeystring: Overrides 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

threads:readنتایج را صفحه‌به‌صفحه مرور می‌کند

امضای متد

listAll(    ?string $q = null,    ?string $sort = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): array

Walks every page of list and returns every chat, in the order sort: names. One request per page, with the same filters on each.

پارامترها

qstring: Searches the titles.
sortstring: newest (the default) or oldest by the last change, or title, as in OpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.
limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides 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

threads:readنتایج را صفحه‌به‌صفحه مرور می‌کند

امضای متد

iterate(    ?string $q = null,    ?string $sort = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Generator

Returns 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.

پارامترها

qstring: Searches the titles.
sortstring: newest (the default) or oldest by the last change, or title, as in OpenEmail\Constants\ChatSorts. A cursor carries on in the order it was handed out in.
limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides 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

threads:read

امضای متد

get(string $id, ?string $apiKey = null): array

Returns one chat with the assistant by its id: its title, how many messages it holds and when it last changed.

پارامترها

idstringالزامی: The chat id from list.
apiKeystring: Overrides 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

threads:write

امضای متد

rename(string $id, string $title, ?string $apiKey = null): array

Gives a chat with the assistant a new title, up to 120 characters, and returns the chat as it is now.

پارامترها

idstringالزامی: The chat id from list.
titlestringالزامی: The new title, from 1 to 120 characters.
apiKeystring: Overrides 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

threads:write

امضای متد

delete(string $id, ?string $apiKey = null): array

Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.

پارامترها

idstringالزامی: The chat id from list.
apiKeystring: Overrides 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

$client->chats

متدها

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

پارامترها

خروجی

نمونه

نکته‌ها

همچنین در دسترس در

صندوق ورودی شما،با شرایط خودتان.

صندوق ورودی شما،
با شرایط خودتان.