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;}

इनमें भी उपलब्ध

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;

इनमें भी उपलब्ध

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;}

इनमें भी उपलब्ध

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;

इनमें भी उपलब्ध

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;

इनमें भी उपलब्ध

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;}

इनमें भी उपलब्ध

API: DELETE /chats/{id}
TypeScript: chats.delete()
Python: chats.delete()
Ruby: chats.delete
CLI: openemail chats delete

$client->chats

मेथड

`chats->list`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

`chats->listAll`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

`chats->iterate`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

`chats->get`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

`chats->rename`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

`chats->delete`

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

आपका इनबॉक्स,
आपकी अपनी शर्तों पर।

$client->chats

मेथड

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

आपका इनबॉक्स,आपकी अपनी शर्तों पर।

आपका इनबॉक्स,
आपकी अपनी शर्तों पर।