You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c3a9037
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CHANGELOG.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,10 @@
2
2
3
3
## [Unreleased]
4
4
5
+
### Changed
6
+
7
+
- Move resource-specific README documentation into a dedicated usage guide, keeping the README focused on SDK setup and shared client behavior.
8
+
5
9
### Removed
6
10
7
11
- Remove the deprecated Managed `skills().update(...)` API and `managed.SkillUpdateParams` from the 0.2.0 candidate, including asynchronous and `withResponse()` variants. Use `skills().versions().create(...)` for Skill content updates; it does not replace Skill metadata updates. Forward Skill APIs are unchanged.
Copy file name to clipboardExpand all lines: README.md
+15-82Lines changed: 15 additions & 82 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,30 +6,17 @@ The Qoder Cloud Agents Java SDK provides typed synchronous and asynchronous clie
6
6
7
7
Version **0.2.0** supports both the **Forward API** and the **[Managed API](docs/managed.md)** in one package. Use `ForwardClient` / `AsyncForwardClient` for Forward and `ManagedClient` / `AsyncManagedClient` for Managed.
8
8
9
-
| Capability | Resources |
10
-
| --- | --- |
11
-
| Agent configuration | Forward Template, Identity and per-Identity configuration; Managed Agent and versions |
12
-
| Conversations | Session, Thread, event history and SSE subscriptions |
13
-
| Execution | Forward Schedule, Schedule Run, Batch and Batch Task; Managed Deployment, Run and self-hosted Work |
14
-
| Resources | Environment, File, Skill, Vault, Memory Store and resource Search; Forward Drive |
15
-
| Channels and notifications | Forward Channel configuration, Pairing management, QR authorization and Webhooks |
16
-
| Authentication and usage | PAT, Service Account credentials, Forward SAT issuance/revocation, Model and Usage |
17
-
| Realtime (Forward, Beta) | Text/audio WebSocket conversations and persisted History |
18
-
19
-
See the [Forward](docs/forward-api-coverage.md) and [Managed](docs/managed-api-coverage.md) coverage inventories and resource guides for the supported operations.
20
-
21
-
The [0.2.0 changelog](CHANGELOG.md) covers Forward Search, Dreams, Decisions, pairing management, contract updates, Session creation metadata, Webhooks, client extensions and 107 Managed operations. See the [Forward migration guide](docs/forward-parity.md) for the rubric field and reserved metadata changes.
22
-
23
9
-[Installation](#installation)
24
10
-[Quick start](#quick-start)
25
11
-[PAT and Service Account authentication](#pat-and-service-account-authentication)
26
-
-[Conversations and streaming](#conversations-and-streaming)
12
+
-[Streaming](#streaming)
27
13
-[Asynchronous calls and cancellation](#asynchronous-calls-and-cancellation)
28
14
-[Pagination](#pagination)
29
15
-[Timeouts, retries and errors](#timeouts-retries-and-errors)
30
-
-[Realtime](#realtime)
31
-
-[Examples and documentation](#examples-and-documentation)
16
+
-[Documentation and examples](#documentation-and-examples)
32
17
-[Development](#development)
18
+
-[Versioning](#versioning)
19
+
-[License](#license)
33
20
34
21
## Installation
35
22
@@ -50,7 +37,7 @@ Requirements:
50
37
51
38
## Quick start
52
39
53
-
Set `QODER_PAT` in your environment. This complete Forward program connects to Global and lists the enabled models. For Managed client creation, authentication and resource examples, see the [Managed quick start](docs/managed.md#client-and-authentication).
40
+
Set `QODER_PAT` in your environment. This complete Forward program connects to Global and lists the enabled models. For the other client, see the [Managed quick start](docs/managed.md#client-and-authentication).
54
41
55
42
```java
56
43
importcom.qoder.cloudagents.ForwardClient;
@@ -113,53 +100,9 @@ Business requests use the SAT; the SA Key is sent only to the exchange service.
113
100
114
101
Forward also provides explicit administrator/Identity SAT issuance and revocation through `serviceAccountTokens()` and `identities().serviceAccountTokens()`. These methods take a per-call SA Key and do not retry automatically. See [SAT management](docs/usage-sat-drive.md) and [authentication configuration](docs/client-configuration.md).
115
102
116
-
## Conversations and streaming
103
+
## Streaming
117
104
118
-
Create a Session using an existing Identity and Template, send a user message, and consume events through SSE:
if ("session.status_idle".equals(event.type())) break;
156
-
}
157
-
}
158
-
```
159
-
160
-
Reuse an idempotency key when retrying the same logical write. A successful send acknowledges input, not completed execution. An idle event can mean the turn finished or paused for input; inspect the event's stop reason in your application. The example bounds the subscription to five minutes; closing it does not cancel or archive the Session.
161
-
162
-
Thread subscriptions use `sessions().threads().events()`. For explicit reconnects with the last delivered SSE ID, use `resumableStream(...)`; user messages are not automatically resent. See [Session operations](docs/sessions.md), [streaming and cancellation](docs/session-streaming.md) and the [runnable streaming example](examples/src/main/java/com/qoder/cloudagents/examples/SessionStreamingExample.java).
105
+
Streaming responses are consumed incrementally. Close the stream when finished and handle interruption explicitly; closing a local stream does not cancel server-side work. See the [usage guide](docs/usage-guide.md) for runnable patterns and reconnection behavior.
163
106
164
107
## Asynchronous calls and cancellation
165
108
@@ -190,7 +133,7 @@ for (com.qoder.cloudagents.forward.Template template : page) {
190
133
}
191
134
```
192
135
193
-
Use `page.data()` for only the current page, or `hasNextPage()` and `getNextPage()` / `getNextPageAsync()` for manual pagination. Filters, request options and server order are preserved. Drive uses `entries` / `next_page_token`; Realtime History has its own `next_before` cursor. See the [resource guides](docs/forward-api-coverage.md#使用指南) for those APIs.
136
+
Use `page.data()` for only the current page, or `hasNextPage()` and `getNextPage()` / `getNextPageAsync()` for manual pagination. Filters, request options and server order are preserved. See the [usage guide](docs/usage-guide.md#pagination) for API-specific pagination behavior.
194
137
195
138
## Timeouts, retries and errors
196
139
@@ -219,20 +162,14 @@ try {
219
162
220
163
See [client configuration](docs/client-configuration.md) for detailed defaults and [Template configuration](docs/templates.md) for typed configuration and field semantics.
221
164
222
-
## Realtime
223
-
224
-
Realtime (Beta) supports conversation creation, text and PCM audio exchange over WebSocket, Work events and persisted History. Use `client.realtime().conversations()` for creation/history and `client.realtime().connect(...)` for connections. The Template must have Realtime enabled and be accessible to the credential.
165
+
## Documentation and examples
225
166
226
-
Microphone capture and audio playback belong to the application. Connections do not automatically reconnect or replay input. See the [Realtime guide](docs/realtime.md) and [runnable example](examples/src/main/java/com/qoder/cloudagents/examples/RealtimeExample.java) for authentication, audio formats and connection lifecycle.
Resource-specific behavior and examples for the Qoder Cloud Agents SDK. See the [README](../README.md) for installation, authentication and shared client configuration. Run shell commands from the repository root; code fragments use the clients and imports shown in the README unless stated otherwise.
4
+
5
+
-[API coverage](#api-coverage)
6
+
-[Conversations and streaming](#conversations-and-streaming)
| Agent configuration | Forward Template, Identity and per-Identity configuration; Managed Agent and versions |
17
+
| Conversations | Session, Thread, event history and SSE subscriptions |
18
+
| Execution | Forward Schedule, Schedule Run, Batch and Batch Task; Managed Deployment, Run and self-hosted Work |
19
+
| Resources | Environment, File, Skill, Vault, Memory Store and resource Search; Forward Drive |
20
+
| Channels and notifications | Forward Channel configuration, Pairing management, QR authorization and Webhooks |
21
+
| Authentication and usage | PAT, Service Account credentials, Forward SAT issuance/revocation, Model and Usage |
22
+
| Realtime (Forward, Beta) | Text/audio WebSocket conversations and persisted History |
23
+
24
+
See the [Forward](../docs/forward-api-coverage.md) and [Managed](../docs/managed-api-coverage.md) coverage inventories and resource guides for the supported operations.
25
+
26
+
The [0.2.0 changelog](../CHANGELOG.md) covers Forward Search, Dreams, Decisions, pairing management, contract updates, Session creation metadata, Webhooks, client extensions and 107 Managed operations. See the [Forward migration guide](../docs/forward-parity.md) for the rubric field and reserved metadata changes.
27
+
28
+
## Conversations and streaming
29
+
30
+
Create a Session using an existing Identity and Template, send a user message, and consume events through SSE:
if ("session.status_idle".equals(event.type())) break;
68
+
}
69
+
}
70
+
```
71
+
72
+
Reuse an idempotency key when retrying the same logical write. A successful send acknowledges input, not completed execution. An idle event can mean the turn finished or paused for input; inspect the event's stop reason in your application. The example bounds the subscription to five minutes; closing it does not cancel or archive the Session.
73
+
74
+
Thread subscriptions use `sessions().threads().events()`. For explicit reconnects with the last delivered SSE ID, use `resumableStream(...)`; user messages are not automatically resent. See [Session operations](../docs/sessions.md), [streaming and cancellation](../docs/session-streaming.md) and the [runnable streaming example](../examples/src/main/java/com/qoder/cloudagents/examples/SessionStreamingExample.java).
75
+
76
+
## Realtime
77
+
78
+
Realtime (Beta) supports conversation creation, text and PCM audio exchange over WebSocket, Work events and persisted History. Use `client.realtime().conversations()` for creation/history and `client.realtime().connect(...)` for connections. The Template must have Realtime enabled and be accessible to the credential.
79
+
80
+
Microphone capture and audio playback belong to the application. Connections do not automatically reconnect or replay input. See the [Realtime guide](../docs/realtime.md) and [runnable example](../examples/src/main/java/com/qoder/cloudagents/examples/RealtimeExample.java) for authentication, audio formats and connection lifecycle.
81
+
82
+
## Forward Webhooks (next release)
83
+
84
+
Manage webhook endpoints and verify signed event deliveries. See [Webhook usage and receiver examples](../docs/webhooks.md).
85
+
86
+
## Pagination
87
+
88
+
Drive uses `entries` / `next_page_token`; Realtime History has its own `next_before` cursor. See the [resource guides](forward-api-coverage.md#使用指南) for those APIs.
0 commit comments