OpenAI Agents SDK TypeScript

クイックスタート

ほんの数分ではじめてのエージェントをつくることができます。

Text Agent
Voice Agent

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>',
});

概要

OpenAI Agents SDK for TypeScript は、非常に少ない抽象化で軽量かつ使いやすいパッケージにより、エージェント指向の AI アプリを構築できるようにします。これは、エージェントに関する以前の実験的取り組みである Swarm を本番運用向けにアップグレードしたもので、Python 版も利用可能です。Agents SDK はごく少数の基本コンポーネントで構成されています。

エージェント: 指示とツールを備えた LLM
ハンドオフ: 特定のタスクで他のエージェントへ委譲する機能
ガードレール: エージェントへの入力を検証する機能

TypeScript と組み合わせることで、これらの基本コンポーネントはツールとエージェント間の複雑な関係を表現でき、急な学習曲線なしに実アプリケーションを構築できます。さらに、SDK には組み込みの トレーシング があり、エージェントのフローを可視化・デバッグ・評価し、アプリケーション向けにモデルをファインチューニングすることもできます。

Agents SDK を使う理由

この SDK は 2 つの設計原則に基づいています。

使う価値があるだけの十分な機能を備えつつ、学習を速くするために基本コンポーネントは少数にとどめる
すぐに使いやすい一方で、挙動を細かくカスタマイズできる

主な機能は以下のとおりです。

エージェントループ: ツール呼び出し、結果の LLM への送信、LLM の完了までのループを内蔵
TypeScript ファースト: 新しい抽象を学ぶのではなく、言語機能でエージェントのオーケストレーションと連鎖を実現
ハンドオフ: 複数エージェント間の協調と委譲を可能にする強力な機能
ガードレール: エージェントと並行して入力の検証やチェックを実行し、失敗時は早期に停止
関数ツール: 任意の TypeScript 関数をツール化し、自動スキーマ生成と Zod による検証を提供
トレーシング: フローの可視化、デバッグ、監視に加え、OpenAI の評価、ファインチューニング、蒸留ツール群を活用可能
リアルタイムエージェント: 自動割り込み検知、コンテキスト管理、ガードレールなどを備えた強力な音声エージェントを構築

インストール

npm install @openai/agents zod@3

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-...