client.Chats
Cada método de este espacio de nombres: su firma, sus parámetros, lo que devuelve y un ejemplo.
Métodos
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
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.
Parámetros
qstring?Searches the titles.
sortstring?newest(the default) oroldestby the last change, ortitle, as inOpenEmail\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
nextCursorof the previous page. Leave it out for the first page.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Devuelve
A Page with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.
Ejemplo
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"}");}Notas
A cursor that names nothing in this list is 400
invalid_cursor.
También disponible en
- 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
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.
Parámetros
qstring?Searches the titles.
sortstring?newest(the default) oroldestby the last change, ortitle, as inOpenEmail\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.
cancellationTokenCancellationTokenCancels the request.
Devuelve
A list of JsonObject items holding every chat.
Ejemplo
var chats = await client.Chats.ListAllAsync(q: "invoices"); Console.WriteLine($"{string.Join(Environment.NewLine, chats.Select(row => row?["title"]))}");Notas
If any page fails the call throws and the rows already fetched are discarded.
También disponible en
- 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
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.
Parámetros
qstring?Searches the titles.
sortstring?newest(the default) oroldestby the last change, ortitle, as inOpenEmail\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.
cancellationTokenCancellationTokenCancels the request.
Devuelve
An IAsyncEnumerable<JsonObject> that yields one chat per step.
Ejemplo
using OpenEmail.Constants; await foreach (var chat in client.Chats.IterateAsync(sort: ChatSorts.Title)){ Console.WriteLine($"{chat["title"]} {chat["updatedAt"]}");}Notas
Each page is one request, so a long walk makes many.
También disponible en
- 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
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.
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.
Parámetros
idstringObligatorioThe chat id from
ListAsync.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Devuelve
A JsonObject with id, title, kind, messageCount and updatedAt.
Ejemplo
var chat = await client.Chats.GetAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); Console.WriteLine($"{chat["title"]}, last changed {chat["updatedAt"]}");Notas
An unknown id is a 404.
También disponible en
- 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
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.
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.
Parámetros
idstringObligatorioThe chat id from
ListAsync.titlestringObligatorioThe new title, from 1 to 120 characters.
apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Devuelve
The same object as Chats.GetAsync, with the new title.
Ejemplo
var chat = await client.Chats.RenameAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices"); Console.WriteLine($"{chat["title"]}");Notas
An unknown id is a 404.
También disponible en
- 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
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.
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.
Parámetros
idstringObligatorioThe chat id from
ListAsync.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Devuelve
A JsonObject with object set to chat, the id and deleted set to true.
Ejemplo
try{ await client.Chats.DeleteAsync("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65");}catch (OpenEmailApiException error) when (error.IsNotFound){ Console.WriteLine("Already gone");}Notas
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.
También disponible en
- 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