@openai/agents 0.0.17 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -35
- package/dist/metadata.js +3 -3
- package/dist/metadata.js.map +1 -1
- package/dist/metadata.mjs +3 -3
- package/dist/metadata.mjs.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -24,7 +24,7 @@ Explore the [`examples/`](examples/) directory to see the SDK in action.
|
|
|
24
24
|
- [x] **Guardrails**: Input and output validation for safety and reliability.
|
|
25
25
|
- [x] **Parallelization**: Run agents or tool calls in parallel and aggregate results.
|
|
26
26
|
- [x] **Human-in-the-Loop**: Integrate human approval or intervention into workflows.
|
|
27
|
-
- [x] **Realtime Voice Agents**: Build realtime voice agents using WebRTC or
|
|
27
|
+
- [x] **Realtime Voice Agents**: Build realtime voice agents using WebRTC or WebSockets
|
|
28
28
|
- [x] **Local MCP Server Support**: Give an Agent access to a locally running MCP server to provide tools
|
|
29
29
|
- [x] **Separate optimized browser package**: Dedicated package meant to run in the browser for Realtime agents.
|
|
30
30
|
- [x] **Broader model support**: Use non-OpenAI models through the Vercel AI SDK adapter
|
|
@@ -47,10 +47,8 @@ Experimental support:
|
|
|
47
47
|
|
|
48
48
|
### Installation
|
|
49
49
|
|
|
50
|
-
This SDK currently does not work with `zod@3.25.68` and above. Please install `zod@3.25.67` (or any older version) explicitly. We will resolve this dependency issue soon. Please check [this issue](https://github.com/openai/openai-agents-js/issues/187) for updates.
|
|
51
|
-
|
|
52
50
|
```bash
|
|
53
|
-
npm install @openai/agents
|
|
51
|
+
npm install @openai/agents zod@3
|
|
54
52
|
```
|
|
55
53
|
|
|
56
54
|
## Hello world example
|
|
@@ -162,11 +160,11 @@ const agent = new RealtimeAgent({
|
|
|
162
160
|
tools: [getWeatherTool],
|
|
163
161
|
});
|
|
164
162
|
|
|
165
|
-
// Intended to
|
|
166
|
-
const { apiKey } = await fetch('/path/to/
|
|
163
|
+
// Intended to run in the browser
|
|
164
|
+
const { apiKey } = await fetch('/path/to/ephemeral/key/generation').then(
|
|
167
165
|
(resp) => resp.json(),
|
|
168
166
|
);
|
|
169
|
-
//
|
|
167
|
+
// Automatically configures audio input/output — start talking
|
|
170
168
|
const session = new RealtimeSession(agent);
|
|
171
169
|
await session.connect({ apiKey });
|
|
172
170
|
```
|
|
@@ -200,34 +198,6 @@ The final output is the last thing the agent produces in the loop.
|
|
|
200
198
|
- If the maximum number of turns is exceeded, a `MaxTurnsExceededError` is thrown.
|
|
201
199
|
- If a guardrail is triggered, a `GuardrailTripwireTriggered` exception is raised.
|
|
202
200
|
|
|
203
|
-
## Documentation
|
|
204
|
-
|
|
205
|
-
To view the documentation locally:
|
|
206
|
-
|
|
207
|
-
```bash
|
|
208
|
-
pnpm docs:dev
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
Then visit [http://localhost:4321](http://localhost:4321) in your browser.
|
|
212
|
-
|
|
213
|
-
## Development
|
|
214
|
-
|
|
215
|
-
If you want to contribute or edit the SDK/examples:
|
|
216
|
-
|
|
217
|
-
1. Install dependencies
|
|
218
|
-
|
|
219
|
-
```bash
|
|
220
|
-
pnpm install
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
2. Build the project
|
|
224
|
-
|
|
225
|
-
```bash
|
|
226
|
-
pnpm build
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
3. Run tests, linter, etc. (add commands as appropriate for your project)
|
|
230
|
-
|
|
231
201
|
## Acknowledgements
|
|
232
202
|
|
|
233
203
|
We'd like to acknowledge the excellent work of the open-source community, especially:
|
package/dist/metadata.js
CHANGED
|
@@ -4,13 +4,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.METADATA = void 0;
|
|
5
5
|
exports.METADATA = {
|
|
6
6
|
"name": "@openai/agents",
|
|
7
|
-
"version": "0.
|
|
7
|
+
"version": "0.1.1",
|
|
8
8
|
"versions": {
|
|
9
|
-
"@openai/agents": "0.
|
|
9
|
+
"@openai/agents": "0.1.1",
|
|
10
10
|
"@openai/agents-core": "workspace:*",
|
|
11
11
|
"@openai/agents-openai": "workspace:*",
|
|
12
12
|
"@openai/agents-realtime": "workspace:*",
|
|
13
|
-
"openai": "^5.
|
|
13
|
+
"openai": "^5.16.0"
|
|
14
14
|
}
|
|
15
15
|
};
|
|
16
16
|
exports.default = exports.METADATA;
|
package/dist/metadata.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";AACA,uCAAuC;;;AAE1B,QAAA,QAAQ,GAAG;IACtB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";AACA,uCAAuC;;;AAE1B,QAAA,QAAQ,GAAG;IACtB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,OAAO;IAClB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO;QACzB,qBAAqB,EAAE,aAAa;QACpC,uBAAuB,EAAE,aAAa;QACtC,yBAAyB,EAAE,aAAa;QACxC,QAAQ,EAAE,SAAS;KACpB;CACF,CAAC;AAEF,kBAAe,gBAAQ,CAAC"}
|
package/dist/metadata.mjs
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
// This file is automatically generated
|
|
2
2
|
export const METADATA = {
|
|
3
3
|
"name": "@openai/agents",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.1.1",
|
|
5
5
|
"versions": {
|
|
6
|
-
"@openai/agents": "0.
|
|
6
|
+
"@openai/agents": "0.1.1",
|
|
7
7
|
"@openai/agents-core": "workspace:*",
|
|
8
8
|
"@openai/agents-openai": "workspace:*",
|
|
9
9
|
"@openai/agents-realtime": "workspace:*",
|
|
10
|
-
"openai": "^5.
|
|
10
|
+
"openai": "^5.16.0"
|
|
11
11
|
}
|
|
12
12
|
};
|
|
13
13
|
export default METADATA;
|
package/dist/metadata.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metadata.mjs","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AACA,uCAAuC;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"metadata.mjs","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AACA,uCAAuC;AAEvC,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,MAAM,EAAE,gBAAgB;IACxB,SAAS,EAAE,OAAO;IAClB,UAAU,EAAE;QACV,gBAAgB,EAAE,OAAO;QACzB,qBAAqB,EAAE,aAAa;QACpC,uBAAuB,EAAE,aAAa;QACtC,yBAAyB,EAAE,aAAa;QACxC,QAAQ,EAAE,SAAS;KACpB;CACF,CAAC;AAEF,eAAe,QAAQ,CAAC"}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@openai/agents",
|
|
3
3
|
"repository": "https://github.com/openai/openai-agents-js",
|
|
4
4
|
"homepage": "https://openai.github.io/openai-agents-js/",
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "0.1.1",
|
|
6
6
|
"description": "The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.",
|
|
7
7
|
"author": "OpenAI <support@openai.com>",
|
|
8
8
|
"main": "dist/index.js",
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
}
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"openai": "^5.10.1",
|
|
29
28
|
"debug": "^4.4.0",
|
|
30
|
-
"
|
|
31
|
-
"@openai/agents-
|
|
32
|
-
"@openai/agents-openai": "0.
|
|
29
|
+
"openai": "^5.16.0",
|
|
30
|
+
"@openai/agents-core": "0.1.1",
|
|
31
|
+
"@openai/agents-openai": "0.1.1",
|
|
32
|
+
"@openai/agents-realtime": "0.1.1"
|
|
33
33
|
},
|
|
34
34
|
"keywords": [
|
|
35
35
|
"openai",
|