OpenAI Agents SDK for TypeScript
クイックスタート
数分で最初のエージェントを構築できます。OpenAI Agents SDK の基本を学びましょう。
はじめる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
を備えた LLM - ハンドオフ: 特定のタスクを別のエージェントに委任する仕組み
- ガードレール: エージェントへの入力を検証する仕組み
TypeScript と組み合わせることで、これらの基本コンポーネントだけでツールとエージェント間の複雑な関係を表現でき、学習コストを抑えつつ実用的なアプリケーションを構築できます。さらに、SDK には トレーシング が組み込まれており、エージェントフローの可視化やデバッグ、評価、さらにはアプリ向けモデルのファインチューニングまで行えます。
Python 用 OpenAI Agents SDK Python でエージェント指向 AI アプリを構築
Agents SDK を利用する理由
Section titled “Agents SDK を利用する理由”SDK の設計原則は次の二つです。
- 使う価値のある機能を十分に備えつつ、習得が早いようコンポーネントを絞る
- デフォルトでもすぐに使えるが、動作を細かくカスタマイズできる
主な特徴は以下のとおりです。
- エージェントループ: ツール呼び出し、結果の LLM への送信、LLM が完了するまでのループ処理を内蔵
- TypeScript ファースト: 新しい抽象概念を学ばなくても、言語機能でエージェントをオーケストレーション
- ハンドオフ: 複数エージェント間での協調や委任を実現する強力な機能
- ガードレール: 入力のバリデーションやチェックをエージェントと並行実行し、不合格なら早期終了
- 関数ツール: 任意の TypeScript 関数をツール化し、自動スキーマ生成と Zod による検証を提供
- トレーシング: ワークフローの可視化・デバッグ・モニタリングに加え、OpenAI の評価・ファインチューニング・蒸留ツールを活用可能
- Realtime Agents: 自動割り込み検知、コンテキスト管理、ガードレールなどを備えた高機能な音声エージェントを構築
インストール
Section titled “インストール”npm install @openai/agents
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-...