Update docs and README to encourage using @openai/zod - ref #187

README.md

@@ -81,7 +81,7 @@ console.log(result.finalOutput);
 ## Functions example
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({
@@ -110,7 +110,7 @@ main().catch(console.error);
 ## Handoffs example
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({
@@ -147,7 +147,7 @@ main().catch(console.error);
 ## Voice Agent
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { RealtimeAgent, RealtimeSession, tool } from '@openai/agents-realtime';
 
 const getWeatherTool = tool({

docs/src/content/docs/ja/guides/running-agents.md

@@ -165,7 +165,7 @@ SDK はキャッチ可能な少数のエラーをスローします。
 以下は `GuardrailExecutionError` を処理するコード例です。
 
 ```typescript
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import {
   Agent,
   run,

examples/docs/agents/agentForcingToolUse.ts

@@ -1,5 +1,5 @@
 import { Agent, tool } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const calculatorTool = tool({
   name: 'Calculator',

examples/docs/agents/agentWithAodOutputType.ts

@@ -1,5 +1,5 @@
 import { Agent } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const CalendarEvent = z.object({
   name: z.string(),

examples/docs/agents/agentWithTools.ts

@@ -1,5 +1,5 @@
 import { Agent, tool } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const getWeather = tool({
   name: 'get_weather',

examples/docs/context/localContext.ts

@@ -1,5 +1,5 @@
 import { Agent, run, RunContext, tool } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 interface UserInfo {
   name: string;

examples/docs/guardrails/guardrails-input.ts

@@ -4,7 +4,7 @@ import {
   InputGuardrailTripwireTriggered,
   InputGuardrail,
 } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const guardrailAgent = new Agent({
   name: 'Guardrail check',

examples/docs/guardrails/guardrails-output.ts

@@ -4,7 +4,7 @@ import {
   OutputGuardrailTripwireTriggered,
   OutputGuardrail,
 } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 // The output by the main agent
 const MessageOutput = z.object({ response: z.string() });

examples/docs/handoffs/handoffInput.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, handoff, RunContext } from '@openai/agents';
 
 const EscalationData = z.object({ reason: z.string() });

examples/docs/human-in-the-loop/index.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import readline from 'node:readline/promises';
 import fs from 'node:fs/promises';
 import { Agent, run, tool, RunState, RunResult } from '@openai/agents';

examples/docs/human-in-the-loop/toolApprovalDefinition.ts

@@ -1,5 +1,5 @@
 import { tool } from '@openai/agents';
-import z from 'zod';
+import z from '@openai/zod';
 
 const sensitiveTool = tool({
   name: 'cancelOrder',

examples/docs/readme/readme-functions.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({

examples/docs/readme/readme-handoffs.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({

examples/docs/readme/readme-voice-agent.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { RealtimeAgent, RealtimeSession, tool } from '@openai/agents-realtime';
 
 const getWeatherTool = tool({

examples/docs/results/handoffFinalOutputTypes.ts

@@ -1,5 +1,5 @@
 import { Agent, run } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const refundAgent = new Agent({
   name: 'Refund Agent',

examples/docs/running-agents/exceptions1.ts

@@ -5,7 +5,7 @@ import {
   InputGuardrail,
   InputGuardrailTripwireTriggered,
 } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const guardrailAgent = new Agent({
   name: 'Guardrail check',

examples/docs/running-agents/exceptions2.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool, ToolCallError } from '@openai/agents';
 
 const unstableTool = tool({

examples/docs/tools/functionTools.ts

@@ -1,5 +1,5 @@
 import { tool } from '@openai/agents';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const getWeatherTool = tool({
   name: 'get_weather',

examples/docs/voice-agents/defineTool.ts

@@ -1,5 +1,5 @@
 import { tool, RealtimeAgent } from '@openai/agents/realtime';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const getWeather = tool({
   name: 'get_weather',

examples/docs/voice-agents/delegationAgent.ts

@@ -4,7 +4,7 @@ import {
   tool,
 } from '@openai/agents/realtime';
 import { handleRefundRequest } from './serverAgent';
-import z from 'zod';
+import z from '@openai/zod';
 
 const refundSupervisorParameters = z.object({
   request: z.string(),

examples/docs/voice-agents/serverAgent.ts

@@ -3,7 +3,7 @@ import 'server-only';
 
 import { Agent, run } from '@openai/agents';
 import type { RealtimeItem } from '@openai/agents/realtime';
-import z from 'zod';
+import z from '@openai/zod';
 
 const agent = new Agent({
   name: 'Refund Expert',

examples/docs/voice-agents/toolHistory.ts

@@ -3,7 +3,7 @@ import {
   RealtimeContextData,
   RealtimeItem,
 } from '@openai/agents/realtime';
-import { z } from 'zod';
+import { z } from '@openai/zod';
 
 const parameters = z.object({
   request: z.string(),

packages/agents/README.md

@@ -78,7 +78,7 @@ console.log(result.finalOutput);
 ## Functions example
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({
@@ -107,7 +107,7 @@ main().catch(console.error);
 ## Handoffs example
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { Agent, run, tool } from '@openai/agents';
 
 const getWeatherTool = tool({
@@ -144,7 +144,7 @@ main().catch(console.error);
 ## Voice Agent
 
 ```js
-import { z } from 'zod';
+import { z } from '@openai/zod';
 import { RealtimeAgent, RealtimeSession, tool } from '@openai/agents-realtime';
 
 const getWeatherTool = tool({