client.Chats

Çdo metodë në këtë hapësirë emrash: nënshkrimi, parametrat, çfarë kthen dhe një shembull.

Metodat

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:readKalon nëpër rezultate faqe pas faqeje

Nënshkrimi

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.

Parametrat

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.

Kthen

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

Shembull

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

Shënime

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

E disponueshme edhe në

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:readKalon nëpër rezultate faqe pas faqeje

Nënshkrimi

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.

Parametrat

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.

Kthen

A list of JsonObject items holding every chat.

Shembull

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

Shënime

If any page fails the call throws and the rows already fetched are discarded.

E disponueshme edhe në

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:readKalon nëpër rezultate faqe pas faqeje

Nënshkrimi

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.

Parametrat

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.

Kthen

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

Shembull

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

Shënime

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

E disponueshme edhe në

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

Nënshkrimi

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.

Parametrat

idstringE detyrueshme: The chat id from ListAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Kthen

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

Shembull

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

Shënime

An unknown id is a 404.

E disponueshme edhe në

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

Nënshkrimi

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.

Parametrat

idstringE detyrueshme: The chat id from ListAsync.
titlestringE detyrueshme: The new title, from 1 to 120 characters.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Kthen

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

Shembull

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

Shënime

An unknown id is a 404.

E disponueshme edhe në

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

Nënshkrimi

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.

Parametrat

idstringE detyrueshme: The chat id from ListAsync.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Kthen

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

Shembull

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

Shënime

An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.

E disponueshme edhe në

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

Metodat

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Parametrat

Kthen

Shembull

Shënime

E disponueshme edhe në

Kutia juaj hyrëse,sipas kushteve tuaja.

Kutia juaj hyrëse,
sipas kushteve tuaja.