Skip to content

Commit aea6cd6

Browse files
committed
document new client interface
1 parent 7eff028 commit aea6cd6

File tree

2 files changed

+51
-7
lines changed

2 files changed

+51
-7
lines changed

docs/sdk/js/client/abstract-agent.mdx

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ class MyAgent extends AbstractAgent {
5353

5454
### runAgent()
5555

56-
The primary method for executing an agent and receiving the event stream.
56+
The primary method for executing an agent and processing the result.
5757

5858
```typescript
59-
runAgent(parameters?: RunAgentParameters): Observable<RuntimeProtocolEvent>
59+
runAgent(parameters?: RunAgentParameters, subscriber?: AgentSubscriber): Promise<RunAgentResult>
6060
```
6161

6262
#### Parameters
@@ -70,6 +70,31 @@ interface RunAgentParameters {
7070
}
7171
```
7272

73+
The optional `subscriber` parameter allows you to provide an
74+
[AgentSubscriber](/sdk/js/client/subscriber) for handling events during this
75+
specific run.
76+
77+
#### Return Value
78+
79+
```typescript
80+
interface RunAgentResult {
81+
result: any // The final result returned by the agent
82+
newMessages: Message[] // New messages added during this run
83+
}
84+
```
85+
86+
### subscribe()
87+
88+
Adds an [AgentSubscriber](/sdk/js/client/subscriber) to handle events across
89+
multiple agent runs.
90+
91+
```typescript
92+
subscribe(subscriber: AgentSubscriber): { unsubscribe: () => void }
93+
```
94+
95+
Returns an object with an `unsubscribe()` method to remove the subscriber when
96+
no longer needed.
97+
7398
### abortRun()
7499

75100
Cancels the current agent execution.

docs/sdk/js/client/http-agent.mdx

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,40 @@ const agent = new HttpAgent({
3939

4040
### runAgent()
4141

42-
Executes the agent by making an HTTP request to the configured endpoint. Returns
43-
an observable event stream.
42+
Executes the agent by making an HTTP request to the configured endpoint.
4443

4544
```typescript
46-
runAgent(parameters?: RunHttpAgentConfig): Observable<RuntimeProtocolEvent>
45+
runAgent(parameters?: RunAgentParameters, subscriber?: AgentSubscriber): Promise<RunAgentResult>
4746
```
4847

4948
#### Parameters
5049

50+
The `parameters` argument follows the standard `RunAgentParameters` interface.
51+
The optional `subscriber` parameter allows you to provide an
52+
[AgentSubscriber](/sdk/js/client/subscriber) for handling events during this
53+
specific run.
54+
55+
#### Return Value
56+
5157
```typescript
52-
interface RunHttpAgentConfig extends RunAgentParameters {
53-
abortController?: AbortController // For canceling the HTTP request
58+
interface RunAgentResult {
59+
result: any // The final result returned by the agent
60+
newMessages: Message[] // New messages added during this run
5461
}
5562
```
5663

64+
### subscribe()
65+
66+
Adds an [AgentSubscriber](/sdk/js/client/subscriber) to handle events across
67+
multiple agent runs.
68+
69+
```typescript
70+
subscribe(subscriber: AgentSubscriber): { unsubscribe: () => void }
71+
```
72+
73+
Returns an object with an `unsubscribe()` method to remove the subscriber when
74+
no longer needed.
75+
5776
### abortRun()
5877

5978
Cancels the current HTTP request using the AbortController.

0 commit comments

Comments
 (0)