openai--openai-agents-python/docs/ja/examples.md

search

search
exclude true

コード例

SDK を使用したさまざまなサンプル実装は、リポジトリの examples セクションで確認できます。コード例は、さまざまなパターンや機能を示す複数のカテゴリーに分かれています。

カテゴリー

• agent_patterns: このカテゴリーのコード例では、次のような一般的なエージェント設計パターンを示します。

  • 決定論的ワークフロー
  • Agents as tools
  • ストリーミングイベントを使用する Agents as tools (examples/agent_patterns/agents_as_tools_streaming.py)
  • 構造化された入力パラメーターを使用する Agents as tools (examples/agent_patterns/agents_as_tools_structured.py)
  • エージェントの並列実行
  • 条件に応じたツールの使用
  • さまざまなツール使用動作を示しながらツールの使用を強制 (examples/agent_patterns/forcing_tool_use.py)
  • 入出力ガードレール
  • 判定者としての LLM
  • ルーティング
  • ストリーミングガードレール
  • ツールの承認と状態のシリアル化を伴うヒューマン・イン・ザ・ループ (examples/agent_patterns/human_in_the_loop.py)
  • ストリーミングを伴うヒューマン・イン・ザ・ループ (examples/agent_patterns/human_in_the_loop_stream.py)
  • 承認フロー向けのカスタム拒否メッセージ (examples/agent_patterns/human_in_the_loop_custom_rejection.py)

• basic: これらのコード例では、次のような SDK の基本機能を紹介します。

  • Hello world のコード例（デフォルトモデル、GPT-5、オープンウェイトモデル）
  • エージェントのライフサイクル管理
  • RunHooks と AgentHooks を使用したエージェントおよび実行のライフサイクルのコード例 (examples/basic/lifecycle_example.py)
  • 動的なシステムプロンプト
  • 基本的なツールの使用 (examples/basic/tools.py)
  • ツールの入出力ガードレール (examples/basic/tool_guardrails.py)
  • ツール出力としての画像の返却 (examples/basic/image_tool_output.py)
  • 出力のストリーミング（テキスト、項目、関数呼び出し引数）
  • ターン間で共有セッションヘルパーを使用する Responses の WebSocket トランスポート (examples/basic/stream_ws.py)
  • プロンプトテンプレート
  • ファイル処理（ローカルとリモート、画像と PDF）
  • 使用量の追跡
  • Runner が管理する再試行設定 (examples/basic/retry.py)
  • サードパーティアダプターを介して Runner が管理する再試行 (examples/basic/retry_litellm.py)
  • 非厳密な出力型
  • 以前のレスポンス ID の使用

• customer_service: 航空会社向けカスタマーサービスシステムのコード例です。

• financial_research_agent: エージェントとツールを使用して、財務データ分析のための構造化された調査ワークフローを示す財務調査エージェントです。

• handoffs: メッセージフィルタリングを伴うエージェントのハンドオフの実践的なコード例です。次の内容が含まれます。

  • メッセージフィルターのコード例 (examples/handoffs/message_filter.py)
  • ストリーミングを伴うメッセージフィルター (examples/handoffs/message_filter_streaming.py)

• hosted_mcp: OpenAI Responses API でホスト型 MCP（Model Context Protocol）を使用する方法を示すコード例です。次の内容が含まれます。

  • 承認なしのシンプルなホスト型 MCP (examples/hosted_mcp/simple.py)
  • Google カレンダーなどの MCP コネクター (examples/hosted_mcp/connectors.py)
  • 割り込みベースの承認を伴うヒューマン・イン・ザ・ループ (examples/hosted_mcp/human_in_the_loop.py)
  • MCP ツール承認リクエスト用のコールバック (examples/hosted_mcp/on_approval.py)

• mcp: MCP（Model Context Protocol）を使用してエージェントを構築する方法を学習できます。次の内容が含まれます。

  • ファイルシステムのコード例
  • Git のコード例
  • MCP プロンプトサーバーのコード例
  • SSE（Server-Sent Events）のコード例
  • SSE リモートサーバー接続 (examples/mcp/sse_remote_example)
  • Streamable HTTP のコード例
  • Streamable HTTP リモート接続 (examples/mcp/streamable_http_remote_example)
  • Streamable HTTP 向けのカスタム HTTP クライアントファクトリー (examples/mcp/streamablehttp_custom_client_example)
  • MCPUtil.get_all_function_tools を使用したすべての MCP ツールのプリフェッチ (examples/mcp/get_all_mcp_tools_example)
  • FastAPI アプリケーションでの MCPServerManager の使用 (examples/mcp/manager_example)
  • MCP ツールのフィルタリング (examples/mcp/tool_filter_example)

• memory: エージェント向けのさまざまなメモリ実装のコード例です。次の内容が含まれます。

  • SQLite セッションストレージ
  • 高度な SQLite セッションストレージ
  • Redis セッションストレージ
  • SQLAlchemy セッションストレージ
  • Dapr 状態ストアのセッションストレージ
  • 暗号化されたセッションストレージ
  • OpenAI Conversations セッションストレージ
  • Responses 圧縮セッションストレージ
  • ModelSettings(store=False) を使用したステートレスな Responses 圧縮 (examples/memory/compaction_session_stateless_example.py)
  • ファイルベースのセッションストレージ (examples/memory/file_session.py)
  • ヒューマン・イン・ザ・ループを伴うファイルベースのセッション (examples/memory/file_hitl_example.py)
  • ヒューマン・イン・ザ・ループを伴う SQLite インメモリセッション (examples/memory/memory_session_hitl_example.py)
  • ヒューマン・イン・ザ・ループを伴う OpenAI Conversations セッション (examples/memory/openai_session_hitl_example.py)
  • セッションをまたぐ HITL の承認／拒否シナリオ (examples/memory/hitl_session_scenario.py)

• model_providers: カスタムプロバイダーやサードパーティアダプターなど、OpenAI 以外のモデルを SDK で使用する方法を確認できます。

• realtime: SDK を使用してリアルタイム体験を構築する方法を示すコード例です。次の内容が含まれます。

  • 構造化されたテキストおよび画像メッセージを使用する Web アプリケーションパターン
  • コマンドラインの音声ループと再生処理
  • WebSocket 経由の Twilio Media Streams 連携
  • Realtime Calls API の attach フローを使用した Twilio SIP 連携

• reasoning_content: 推論コンテンツの扱い方を示すコード例です。次の内容が含まれます。

  • Runner API での推論コンテンツ（ストリーミングおよび非ストリーミング） (examples/reasoning_content/runner_example.py)
  • OpenRouter 経由の OSS モデルを使用した推論コンテンツ (examples/reasoning_content/gpt_oss_stream.py)
  • 基本的な推論コンテンツのコード例 (examples/reasoning_content/main.py)

• research_bot: 複雑なマルチエージェント調査ワークフローを示す、シンプルなディープリサーチのクローンです。

• sandbox: 分離されたワークスペースでエージェントを実行するためのコード例です。次の内容が含まれます。

  • 基本的なサンドボックスエージェントのセットアップ (examples/sandbox/basic.py)
  • Unix ローカルおよび Docker サンドボックスのライフサイクルのコード例
  • サンドボックスを基盤とするハンドオフ (examples/sandbox/handoffs.py)
  • サンドボックスのメモリとスナップショットからの再開 (examples/sandbox/memory.py)
  • ツールとして公開されるサンドボックスエージェント (examples/sandbox/sandbox_agents_as_tools.py)

• tools: OpenAI がホストするツールと実験的な Codex ツール機能の実装方法を学習できます。コード例には次の内容が含まれます。

  • Web 検索とフィルター付き Web 検索
  • ファイル検索
  • Code interpreter
  • ファイル編集と承認を伴う Apply patch ツール (examples/tools/apply_patch.py)
  • 承認コールバックを伴う Shell ツールの実行 (examples/tools/shell.py)
  • ヒューマン・イン・ザ・ループによる割り込みベースの承認を伴う Shell ツール (examples/tools/shell_human_in_the_loop.py)
  • インラインスキルを使用するホスト型コンテナー Shell (examples/tools/container_shell_inline_skill.py)
  • スキル参照を使用するホスト型コンテナー Shell (examples/tools/container_shell_skill_reference.py)
  • ローカルスキルを使用するローカル Shell (examples/tools/local_shell_skill.py)
  • 名前空間と遅延読み込みを使用するツールを備えたツール検索 (examples/tools/tool_search.py)
  • 構造化されたツール呼び出しを並行実行するプログラムによるツール呼び出し (examples/tools/programmatic_tool_calling.py)
  • コンピュータ操作
  • 画像生成
  • 実験的な Codex ツールワークフロー (examples/tools/codex.py)
  • 同じ Codex 会話スレッドを再利用する実験的な Codex ワークフロー (examples/tools/codex_same_thread.py)

• voice: TTS および STT モデルを使用する音声エージェントのコード例を確認できます。音声をストリーミングするコード例も含まれます。