Java

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結果をページ単位で取得

シグネチャ

Page list(RequestOptions options)

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.

パラメーター

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size, from 1 to 100. The server defaults to 25.
options.cursorString: The nextCursor of the previous page. Leave it out for the first page.
options.apiKeyString: Overrides the client's API key for this call only.

戻り値

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

例

Page page = client.chats().list(RequestOptions.of("q", "invoices")); for (Map<String, Object> chat : page) {    System.out.println(chat.get("title") + " " + chat.get("messageCount"));} if (page.hasMore()) {    System.out.println("Next page: " + page.nextCursor());}

注意事項

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
C#: Chats.ListAsync
CLI: openemail chats list

`chats().listAll`

Collect every chat into one list

threads:read結果をページ単位で取得

シグネチャ

List<Map<String, Object>> listAll(RequestOptions options)

Walks every page of list and returns every chat, in the order sort names. One request per page, with the same filters on each.

パラメーター

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorString: Starts the walk after this cursor instead of the first page.
options.apiKeyString: Overrides the client API key for every page of this walk.

戻り値

A list of maps holding every chat.

例

List<Map<String, Object>> chats = client.chats().listAll(); for (Map<String, Object> all : chats) {    System.out.println(all.get("id") + " " + all.get("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
C#: Chats.ListAllAsync

`chats().iterate`

Stream the chats one at a time

threads:read結果をページ単位で取得

シグネチャ

PagedIterable iterate(RequestOptions options)

Returns a PagedIterable 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.

パラメーター

options.qString: Searches the titles.
options.sortString: newest (the default) or oldest by the last change, or title, as in uk.openemail.constants.ChatSorts. A cursor carries on in the order it was handed out in.
options.limitint: Page size for each request, from 1 to 100. The server defaults to 25.
options.cursorString: Starts the walk after this cursor instead of the first page.
options.apiKeyString: Overrides the client API key for every page of this walk.

戻り値

A PagedIterable that yields one chat map per step.

例

for (Map<String, Object> chat : client.chats().iterate(RequestOptions.of("sort", "title"))) {    System.out.println(chat.get("title"));}

注意事項

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
C#: Chats.IterateAsync

`chats().get`

Retrieve a chat

threads:read

シグネチャ

Map<String, Object> get(String id, RequestOptions options)

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.
options.apiKeyString: Overrides the client's API key for this call only.

戻り値

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

例

Map<String, Object> chat = client.chats().get("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); System.out.println(chat.get("title"));

注意事項

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
C#: Chats.GetAsync
CLI: openemail chats get

`chats().rename`

Rename a chat

threads:write

シグネチャ

Map<String, Object> rename(String id, String title, RequestOptions options)

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.
options.apiKeyString: Overrides the client's API key for this call only.

戻り値

The same map as chats().get, with the new title.

例

Map<String, Object> result = client.chats().rename("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices"); System.out.println(result.get("id") + " " + result.get("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
C#: Chats.RenameAsync
CLI: openemail chats rename

`chats().delete`

Delete a chat

threads:write

シグネチャ

Map<String, Object> delete(String id, RequestOptions options)

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.
options.apiKeyString: Overrides the client's API key for this call only.

戻り値

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

例

Map<String, Object> result = client.chats().delete("8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65"); System.out.println(result.get("id"));

注意事項

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
C#: Chats.DeleteAsync
CLI: openemail chats delete

client.chats()

メソッド

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

パラメーター

戻り値

例

注意事項

ほかの提供先

受信トレイを、あなたの思いどおりに。

受信トレイを、
あなたの思いどおりに。