Skip to content

Commit 673c386

Browse files
authored
Update documents once #187 fix is released (#344)
1 parent 7b3d318 commit 673c386

File tree

8 files changed

+8
-16
lines changed

8 files changed

+8
-16
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,8 @@ Experimental support:
5353

5454
### Installation
5555

56-
This SDK currently does not work with `[email protected]` and above. Please install `[email protected]` (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.
57-
5856
```bash
59-
npm install @openai/agents 'zod@<=3.25.67'
57+
npm install @openai/agents zod@3
6058
```
6159

6260
## Hello world example

docs/src/content/docs/guides/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import quickstartExample from '../../../../../examples/docs/quickstart/index.ts?
2222
2. Install the Agents SDK.
2323

2424
```bash
25-
npm install @openai/agents 'zod@<=3.25.67'
25+
npm install @openai/agents zod@3
2626
```
2727

2828
3. Set an OpenAI API key. If you don't have one, follow [these instructions](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) to create an OpenAI API key.

docs/src/content/docs/guides/voice-agents/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import thinClientExample from '../../../../../../examples/docs/voice-agents/thin
3737
1. **Install the Agents SDK**
3838

3939
```bash
40-
npm install @openai/agents 'zod@<=3.25.67'
40+
npm install @openai/agents zod@3
4141
```
4242

4343
Alternatively you can install `@openai/agents-realtime` for a standalone browser package.

docs/src/content/docs/index.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,8 @@ Here are the main features of the SDK:
6363

6464
## Installation
6565

66-
This SDK currently does not work with `[email protected]` and above. Please install `[email protected]` (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.
67-
6866
```bash
69-
npm install @openai/agents 'zod@<=3.25.67'
67+
npm install @openai/agents zod@3
7068
```
7169

7270
## Hello world example

docs/src/content/docs/ja/guides/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import quickstartExample from '../../../../../../examples/docs/quickstart/index.
2222
2. Agents SDK をインストールします。
2323

2424
```bash
25-
npm install @openai/agents 'zod@<=3.25.67'
25+
npm install @openai/agents zod@3
2626
```
2727

2828
3. OpenAI API キーを設定します。まだお持ちでない場合は、 [こちらの手順](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) に従って OpenAI API キーを作成してください。

docs/src/content/docs/ja/guides/voice-agents/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import thinClientExample from '../../../../../../../examples/docs/voice-agents/t
3737
1. **Agents SDK のインストール**
3838

3939
```bash
40-
npm install @openai/agents 'zod@<=3.25.67'
40+
npm install @openai/agents zod@3
4141
```
4242

4343
代わりに、スタンドアロンのブラウザ パッケージとして `@openai/agents-realtime` をインストールすることもできます。

docs/src/content/docs/ja/index.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,8 @@ TypeScript と組み合わせることで、これらの基本コンポーネン
4848

4949
## インストール
5050

51-
この SDK は現在 `[email protected]` 以上では動作しません。明示的に `[email protected]`(またはそれ以前のバージョン)をインストールしてください。依存関係の問題はまもなく解決します。最新情報は [this issue](https://github.com/openai/openai-agents-js/issues/187) をご確認ください。
52-
5351
```bash
54-
npm install @openai/agents 'zod@<=3.25.67'
52+
npm install @openai/agents 'zod@3'
5553
```
5654

5755
## Hello World の例

packages/agents/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,8 @@ Experimental support:
4747

4848
### Installation
4949

50-
This SDK currently does not work with `[email protected]` and above. Please install `[email protected]` (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-
5250
```bash
53-
npm install @openai/agents 'zod@<=3.25.67'
51+
npm install @openai/agents zod@3
5452
```
5553

5654
## Hello world example

0 commit comments

Comments
 (0)