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.ListAsync`

List the assistant chats

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

امضای متد

Task<Page> ListAsync(    string? q = null,    string? sort = null,    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

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.
cancellationTokenCancellationToken: Cancels the request.

خروجی

A Page with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.

نمونه

using OpenEmail.Constants; var page = await client.Chats.ListAsync(q: "invoices", sort: ChatSorts.Newest, limit: 20); foreach (var chat in page){    Console.WriteLine($"{chat["title"]} ({chat["messageCount"]} messages)");} if (page.HasMore){    var next = await client.Chats.ListAsync(q: "invoices", cursor: page.NextCursor);     Console.WriteLine($"{next.Items[0]?["title"]?.ToString() ?? "nothing more"}");}

نکته‌ها

A cursor that names nothing in this list is 400 invalid_cursor.

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

API: GET /chats
TypeScript: chats.list()
Python: chats.list()
Ruby: chats.list
PHP: chats->list
Go: Chats.List
Java: chats().list
CLI: openemail chats list

`Chats.ListAllAsync`

Collect every chat into one object

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

امضای متد

Task<IReadOnlyList<JsonObject>> ListAllAsync(    string? q = null,    string? sort = null,    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Walks every page of ListAsync 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.
cancellationTokenCancellationToken: Cancels the request.

خروجی

A list of JsonObject items holding every chat.

نمونه

var chats = await client.Chats.ListAllAsync(q: "invoices"); Console.WriteLine($"{string.Join(Environment.NewLine, chats.Select(row => row?["title"]))}");

نکته‌ها

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
PHP: chats->listAll
Go: Chats.ListAll
Java: chats().listAll

`Chats.IterateAsync`

Stream the chats one at a time

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

امضای متد

IAsyncEnumerable<JsonObject> IterateAsync(    string? q = null,    string? sort = null,    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns an IAsyncEnumerable<JsonObject> 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.
cancellationTokenCancellationToken: Cancels the request.

خروجی

An IAsyncEnumerable<JsonObject> that yields one chat per step.

نمونه

using OpenEmail.Constants; await foreach (var chat in client.Chats.IterateAsync(sort: ChatSorts.Title)){    Console.WriteLine($"{chat["title"]} {chat["updatedAt"]}");}

نکته‌ها

Each page is one request, so a long walk makes many.

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

API: GET /chats
TypeScript: chats.iterate()
Python: chats.iterate()
Ruby: chats.iterate
PHP: chats->iterate
Go: Chats.Iterate
Java: chats().iterate

`Chats.GetAsync`

Retrieve a chat

threads:read

امضای متد

Task<JsonObject> GetAsync(    string id,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 ListAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

خروجی

A JsonObject with id, title, kind, messageCount and updatedAt.

نمونه

var chat = await client.Chats.GetAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); Console.WriteLine($"{chat["title"]}, last changed {chat["updatedAt"]}");

نکته‌ها

An unknown id is a 404.

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

API: GET /chats/{id}
TypeScript: chats.get()
Python: chats.get()
Ruby: chats.get
PHP: chats->get
Go: Chats.Get
Java: chats().get
CLI: openemail chats get

`Chats.RenameAsync`

Rename a chat

threads:write

امضای متد

Task<JsonObject> RenameAsync(    string id,    string title,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 ListAsync.
titlestringالزامی: The new title, from 1 to 120 characters.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

خروجی

The same object as Chats.GetAsync, with the new title.

نمونه

var chat = await client.Chats.RenameAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices"); Console.WriteLine($"{chat["title"]}");

نکته‌ها

An unknown id is a 404.

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

API: PATCH /chats/{id}
TypeScript: chats.rename()
Python: chats.rename()
Ruby: chats.rename
PHP: chats->rename
Go: Chats.Rename
Java: chats().rename
CLI: openemail chats rename

`Chats.DeleteAsync`

Delete a chat

threads:write

امضای متد

Task<JsonObject> DeleteAsync(    string id,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 ListAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

خروجی

A JsonObject with object set to chat, the id and deleted set to true.

نمونه

try{    await client.Chats.DeleteAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65");}catch (OpenEmailApiException error) when (error.IsNotFound){    Console.WriteLine("Already gone");}

نکته‌ها

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
PHP: chats->delete
Go: Chats.Delete
Java: chats().delete
CLI: openemail chats delete

client.Chats

متدها

پارامترها

خروجی

نمونه

نکته‌ها

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

پارامترها

خروجی

نمونه

نکته‌ها

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

پارامترها

خروجی

نمونه

نکته‌ها

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

پارامترها

خروجی

نمونه

نکته‌ها

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

پارامترها

خروجی

نمونه

نکته‌ها

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

پارامترها

خروجی

نمونه

نکته‌ها

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

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

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