client.Chats
Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.
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.List
List the assistant chats
List(ctx context.Context, opts ...openemail.RequestOption) (*openemail.Page, error)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
openemail.WithQstringSearches the titles.
openemail.WithSortstringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.openemail.WithLimitintPage size, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringThe
NextCursorof the previous page. Leave it out for the first page.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
A *openemail.Page with Items, HasMore and NextCursor. Each item has id, title, kind, messageCount and updatedAt.
Exemplo
page, err := client.Chats.List(ctx, openemail.WithQ("invoices"))if err != nil { return err} for _, chat := range page.Items { fmt.Println(chat.String("title"), chat.Int("messageCount"))} fmt.Println(page.HasMore, page.NextCursor)Notas
A cursor that names nothing in this list is 400
invalid_cursor.
Também disponível em
- API
GET /chats- TypeScript
chats.list()- Python
chats.list()- Ruby
chats.list- PHP
chats->list- Java
chats().list- C#
Chats.ListAsync- CLI
openemail chats list
Chats.ListAll
Collect every chat into one slice
ListAll(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)Walks every page of List and returns with every chat, in the order sort names. One request per page, with the same filters on each.
Parâmetros
openemail.WithQstringSearches the titles.
openemail.WithSortstringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.openemail.WithLimitintPage size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringStarts the walk after this cursor instead of the first page.
openemail.WithAPIKeystringOverrides the client API key for every page of this walk.
Devolve
A []openemail.Object holding every chat.
Exemplo
chats, err := client.Chats.ListAll(ctx)if err != nil { return err} for _, chat := range chats { fmt.Println(chat.String("id"), chat.String("object"))}Notas
If any page fails the call fails and the rows already fetched are discarded.
Também disponível em
- API
GET /chats- TypeScript
chats.listAll()- Python
chats.list_all()- Ruby
chats.list_all- PHP
chats->listAll- Java
chats().listAll- C#
Chats.ListAllAsync
Chats.Iterate
Stream the chats one at a time
Iterate(ctx context.Context, opts ...openemail.RequestOption) *openemail.IteratorReturns an iterator 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
openemail.WithQstringSearches the titles.
openemail.WithSortstringnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.openemail.WithLimitintPage size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringStarts the walk after this cursor instead of the first page.
openemail.WithAPIKeystringOverrides the client API key for every page of this walk.
Devolve
An *openemail.Iterator yielding one chat per step.
Exemplo
for chat, err := range client.Chats.Iterate(ctx, openemail.WithSort("title")).All() { if err != nil { return err } fmt.Println(chat.String("title"))}Notas
Each page is one request, so a long walk makes many.
Também disponível em
- API
GET /chats- TypeScript
chats.iterate()- Python
chats.iterate()- Ruby
chats.iterate- PHP
chats->iterate- Java
chats().iterate- C#
Chats.IterateAsync
Chats.Get
Retrieve a chat
Get(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)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
idstringObrigatórioThe chat id from
List.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with id, title, kind, messageCount and updatedAt.
Exemplo
chat, err := client.Chats.Get(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")if err != nil { return err} fmt.Println(chat.String("title"))Notas
An unknown id is a 404.
Também disponível em
- API
GET /chats/{id}- TypeScript
chats.get()- Python
chats.get()- Ruby
chats.get- PHP
chats->get- Java
chats().get- C#
Chats.GetAsync- CLI
openemail chats get
Chats.Rename
Rename a chat
Rename(ctx context.Context, id string, title string, opts ...openemail.RequestOption) (openemail.Object, error)Gives a chat with the assistant a new title, up to 120 characters, and returns with 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
idstringObrigatórioThe chat id from
List.titlestringObrigatórioThe new title, from 1 to 120 characters.
openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with the new title.
Exemplo
chat, err := client.Chats.Rename(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices")if err != nil { return err} fmt.Println(chat.String("id"), chat.String("object"))Notas
An unknown id is a 404.
Também disponível em
- API
PATCH /chats/{id}- TypeScript
chats.rename()- Python
chats.rename()- Ruby
chats.rename- PHP
chats->rename- Java
chats().rename- C#
Chats.RenameAsync- CLI
openemail chats rename
Chats.Delete
Delete a chat
Delete(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)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
idstringObrigatórioThe chat id from
List.openemail.WithAPIKeystringOverrides the client's API key for this call only.
Devolve
An openemail.Object with object: 'chat', the id and deleted: true.
Exemplo
chat, err := client.Chats.Delete(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")if err != nil { return err} fmt.Println(chat.String("id"), chat.String("object"))Notas
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.
Também disponível em
- API
DELETE /chats/{id}- TypeScript
chats.delete()- Python
chats.delete()- Ruby
chats.delete- PHP
chats->delete- Java
chats().delete- C#
Chats.DeleteAsync- CLI
openemail chats delete