OpenAI Agents SDK TypeScript
import { Agent, run } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'You are a helpful assistant.',});
const result = await run( agent, 'Write a haiku about recursion in programming.',);
console.log(result.finalOutput);
import { RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';
const agent = new RealtimeAgent({ name: 'Assistant', instructions: 'You are a helpful assistant.',});
// Automatically connects your microphone and audio output in the browser via WebRTC.const session = new RealtimeSession(agent);await session.connect({ apiKey: '<client-api-key>',});
TypeScript 向け OpenAI Agents SDK は、抽象化を最小限に抑えた軽量で使いやすいパッケージで、エージェント型の AI アプリを構築できます。これは、以前のエージェント向け実験である Swarm の本番運用対応版で、Python でも利用可能 です。Agents SDK には非常に小さな基本コンポーネントのセットがあります。
- エージェント: instructions と tools を備えた LLMs
- ハンドオフ: 特定のタスクを他のエージェントに委譲する仕組み
- ガードレール: エージェントへの入力を検証できる仕組み
TypeScript と組み合わせることで、これらの基本コンポーネントは tools とエージェント間の複雑な関係を表現でき、学習コストなしに実アプリケーションを構築できます。さらに、この SDK には組み込みの トレーシング があり、エージェントのフローを可視化・デバッグし、評価したり、アプリ向けにモデルをファインチューニングすることもできます。
Agents SDK を使う理由
Section titled “Agents SDK を使う理由”この SDK は 2 つの設計原則に基づいています。
- 使う価値があるだけの機能を備えつつ、学習を速くするために基本コンポーネントは少なく
- すぐに使えてもうまく動作しつつ、実際に何が起きるかを正確にカスタマイズ可能
主な機能は次のとおりです。
- エージェントループ: tools の呼び出し、結果を LLM に渡す処理、LLM が完了するまでのループを内蔵
- TypeScript ファースト: 新しい抽象を学ばずに、言語機能でエージェントのオーケストレーションや連鎖を実現
- ハンドオフ: 複数エージェント間の調整や委譲を可能にする強力な機能
- ガードレール: エージェントと並行して入力の検証やチェックを実行し、失敗時には早期に中断
- 関数ツール: 任意の TypeScript 関数をツール化し、自動スキーマ生成と Zod ベースの検証を提供
- トレーシング: ワークフローの可視化・デバッグ・監視に加え、OpenAI の評価、ファインチューニング、蒸留ツールを活用可能
- リアルタイムエージェント: 自動割り込み検知、コンテキスト管理、ガードレールなどを備えた強力な音声エージェントを構築
インストール
Section titled “インストール”npm install @openai/agents zod@3
Hello World の例
Section titled “Hello World の例”import { Agent, run } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'You are a helpful assistant',});
const result = await run( agent, 'Write a haiku about recursion in programming.',);console.log(result.finalOutput);
// Code within the code,// Functions calling themselves,// Infinite loop's dance.
(これを実行する場合は、OPENAI_API_KEY
環境変数を設定してください)
export OPENAI_API_KEY=sk-...