OpenAI Agents SDK TypeScript | OpenAI Agents SDK

クイックスタート

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

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 にはごく少数の基本コンポーネントがあります:

エージェント: instructions と tools を備えた 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-...