Merge branch 'main' into bug-468

Author: SkinnnyJay

.github/workflows/issues.yml

@@ -22,6 +22,7 @@ jobs:
           days-before-pr-stale: 10
           days-before-pr-close: 7
           stale-pr-label: "stale"
+          exempt-pr-labels: "skip-stale"
           stale-pr-message: "This PR is stale because it has been open for 10 days with no activity."
           close-pr-message: "This PR was closed because it has been inactive for 7 days since being marked as stale."
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.16.0
+          version: 10.17.1
           run_install: false
       - name: Setup Node.js
         uses: actions/setup-node@v4

.github/workflows/update-docs.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10.16.0
+          version: 10.17.1
           run_install: false
       - name: Setup Node.js
         uses: actions/setup-node@v4

README.md

@@ -162,7 +162,7 @@ const getWeatherTool = tool({
 
 const agent = new RealtimeAgent({
   name: 'Data agent',
-  instructions: 'You are a data agent',
+  instructions: 'You are a data agent. When you are asked to check weather, you must use the available tools.',
   tools: [getWeatherTool],
 });
 

docs/astro.config.mjs

@@ -87,7 +87,7 @@ const plugins = [
         paths: ['api/**'],
       },
     ],
-    exclude: ['ja/**'],
+    exclude: ['ja/**', 'zh/**'],
   }),
 ];
 
@@ -97,131 +97,150 @@ const sidebar = [
     link: '/',
     translations: {
       ja: '概要',
+      zh: '概述',
     },
   },
   {
     label: 'Quickstart',
     link: '/guides/quickstart',
     translations: {
       ja: 'クイックスタート',
+      zh: '快速开始',
     },
   },
   {
     label: 'Guides',
     translations: {
       ja: 'ガイド',
+      zh: '指南',
     },
     items: [
       {
         label: 'Agents',
         link: '/guides/agents',
         translations: {
           ja: 'エージェント',
+          zh: '智能体',
         },
       },
       {
         label: 'Running Agents',
         link: '/guides/running-agents',
         translations: {
           ja: 'エージェントの実行',
+          zh: '运行智能体',
         },
       },
       {
         label: 'Results',
         link: '/guides/results',
         translations: {
           ja: 'エージェントの実行結果',
+          zh: '执行结果',
         },
       },
       {
         label: 'Tools',
         link: '/guides/tools',
         translations: {
           ja: 'ツール',
+          zh: '工具',
         },
       },
       {
         label: 'Orchestrating multiple agents',
         link: '/guides/multi-agent',
         translations: {
           ja: 'マルチエージェント',
+          zh: '多智能体编排',
         },
       },
       {
         label: 'Handoffs',
         link: '/guides/handoffs',
         translations: {
           ja: 'ハンドオフ',
+          zh: '交接',
         },
       },
       {
         label: 'Context management',
         link: '/guides/context',
         translations: {
           ja: 'コンテキスト管理',
+          zh: '上下文管理',
         },
       },
       {
         label: 'Models',
         link: '/guides/models',
         translations: {
           ja: 'モデル',
+          zh: '模型',
         },
       },
       {
         label: 'Guardrails',
         link: '/guides/guardrails',
         translations: {
           ja: 'ガードレール',
+          zh: '护栏',
         },
       },
       {
         label: 'Streaming',
         link: '/guides/streaming',
         translations: {
           ja: 'ストリーミング',
+          zh: '流式传输',
         },
       },
       {
         label: 'Human-in-the-loop',
         link: '/guides/human-in-the-loop',
         translations: {
           ja: '人間の介入（HITL）',
+          zh: '人机协作',
         },
       },
       {
         label: 'Model Context Protocol (MCP)',
         link: '/guides/mcp',
         translations: {
           ja: 'MCP 連携',
+          zh: 'MCP 集成',
         },
       },
       {
         label: 'Tracing',
         link: '/guides/tracing',
         translations: {
           ja: 'トレーシング',
+          zh: '追踪',
         },
       },
       {
         label: 'Configuring the SDK',
         link: '/guides/config',
         translations: {
           ja: 'SDK の設定',
+          zh: 'SDK 配置',
         },
       },
       {
         label: 'Troubleshooting',
         link: '/guides/troubleshooting',
         translations: {
           ja: 'トラブルシューティング',
+          zh: '故障排除',
         },
       },
       {
         label: 'Release process',
         link: '/guides/release',
         translations: {
           ja: 'リリースプロセス',
+          zh: '发布流程',
         },
       },
     ],
@@ -230,34 +249,39 @@ const sidebar = [
     label: 'Voice Agents',
     translations: {
       ja: '音声エージェント',
+      zh: '语音智能体',
     },
     items: [
       {
         label: 'Overview',
         link: '/guides/voice-agents',
         translations: {
           ja: '音声エージェントの概要',
+          zh: '语音智能体概述',
         },
       },
       {
         label: 'Quickstart',
         link: '/guides/voice-agents/quickstart',
         translations: {
           ja: 'クイックスタート',
+          zh: '快速开始',
         },
       },
       {
         label: 'Building Voice Agents',
         link: '/guides/voice-agents/build',
         translations: {
           ja: '音声エージェントの構築',
+          zh: '构建语音智能体',
         },
       },
       {
         label: 'Transport Mechanisms',
         link: '/guides/voice-agents/transport',
         translations: {
           ja: 'リアルタイムトランスポート',
+          zh: '传输机制',
         },
       },
     ],
@@ -266,20 +290,31 @@ const sidebar = [
     label: 'Extensions',
     translations: {
       ja: '拡張機能',
+      zh: '扩展',
     },
     items: [
       {
         label: 'Use any model with the AI SDK',
         link: '/extensions/ai-sdk',
         translations: {
           ja: 'AI SDK で任意モデルを指定',
+          zh: '使用 AI SDK 指定任意模型',
         },
       },
       {
         label: 'Connect Realtime Agents to Twilio',
         link: '/extensions/twilio',
         translations: {
           ja: 'Realtime Agent を Twilio に接続',
+          zh: '将实时智能体连接到 Twilio',
+        },
+      },
+      {
+        label: 'Cloudflare Workers Transport',
+        link: '/extensions/cloudflare',
+        translations: {
+          ja: 'Cloudflare Workers 用トランスポート',
+          zh: 'Cloudflare Workers 传输',
         },
       },
     ],
@@ -288,6 +323,7 @@ const sidebar = [
     label: 'API Reference',
     translations: {
       ja: 'APIリファレンス',
+      zh: 'API 参考',
     },
     collapsed: false,
     items: [
@@ -350,6 +386,10 @@ export default defineConfig({
           label: '日本語',
           lang: 'ja',
         },
+        zh: {
+          label: '中文',
+          lang: 'zh',
+        },
       },
       social: [
         {

docs/package.json

@@ -11,21 +11,21 @@
     "translate": "tsx src/scripts/translate.ts"
   },
   "dependencies": {
-    "@astrojs/starlight": "^0.35.2",
+    "@astrojs/starlight": "^0.35.3",
     "@astrojs/starlight-tailwind": "^4.0.1",
     "@openai/agents": "workspace:*",
-    "@tailwindcss/vite": "^4.0.17",
-    "astro": "^5.13.7",
-    "sharp": "^0.34.2",
+    "@tailwindcss/vite": "^4.1.13",
+    "astro": "^5.13.11",
+    "sharp": "^0.34.4",
     "starlight-llms-txt": "^0.6.0",
     "starlight-typedoc": "^0.21.3",
-    "typedoc": "^0.28.1",
-    "typedoc-plugin-markdown": "^4.8.1"
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-markdown": "^4.9.0"
   },
   "devDependencies": {
-    "tailwindcss": "^3.3.3",
-    "tsx": "^4.19.4",
+    "tailwindcss": "^3.4.17",
+    "tsx": "^4.20.5",
     "typedoc-plugin-frontmatter": "^1.3.0",
-    "typedoc-plugin-zod": "^1.4.1"
+    "typedoc-plugin-zod": "^1.4.2"
   }
 }

docs/src/content/docs/extensions/ai-sdk.mdx

@@ -41,7 +41,7 @@ Out of the box the Agents SDK works with OpenAI models through the Responses API
 4. Initialize an instance of the model to be used by the agent:
 
    ```typescript
-   const model = aisdk(openai('o4-mini'));
+   const model = aisdk(openai('gpt-5-mini'));
    ```
 
 </Steps>

docs/src/content/docs/extensions/cloudflare.mdx

@@ -0,0 +1,48 @@
+---
+title: Realtime Agents on Cloudflare
+description: Connect your Agents SDK agents from Cloudflare Workers/workerd using a dedicated transport.
+---
+
+import { Aside, Steps, Code } from '@astrojs/starlight/components';
+import cloudflareBasicExample from '../../../../../examples/docs/extensions/cloudflare-basic.ts?raw';
+
+Cloudflare Workers and other workerd runtimes cannot open outbound WebSockets using the global
+`WebSocket` constructor. To simplify connecting Realtime Agents from these environments, the
+extensions package provides a dedicated transport that performs the `fetch()`-based upgrade
+internally.
+
+<Aside type="caution">
+  This adapter is still in beta. You may run into edge case issues or bugs.
+  Please report any issues via [GitHub
+  issues](https://github.com/openai/openai-agents-js/issues) and we'll fix
+  quickly. For Node.js-style APIs in Workers, consider enabling `nodejs_compat`.
+</Aside>
+
+## Setup
+
+<Steps>
+
+1. **Install the extensions package.**
+
+   ```bash
+   npm install @openai/agents-extensions
+   ```
+
+2. **Create a transport and attach it to your session.**
+
+   <Code lang="typescript" code={cloudflareBasicExample} />
+
+3. **Connect your `RealtimeSession`.**
+
+   ```typescript
+   await session.connect({ apiKey: 'your-openai-ephemeral-or-server-key' });
+   ```
+
+</Steps>
+
+## Notes
+
+- The Cloudflare transport uses `fetch()` with `Upgrade: websocket` under the hood and skips
+  waiting for a socket `open` event, matching the workerd APIs.
+- All `RealtimeSession` features (tools, guardrails, etc.) work as usual when using this transport.
+- Use `DEBUG=openai-agents*` to inspect detailed logs during development.

docs/src/content/docs/extensions/twilio.mdx

@@ -1,5 +1,5 @@
 ---
-title: Using Realtime Agents with Twilio
+title: Connect Realtime Agents to Twilio
 description: Connect your Agents SDK agents to Twilio to use voice agents
 ---