コンテンツにスキップ

コード例

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、オープンウェイトモデル)
    • エージェントライフサイクル管理
    • 実行フックとエージェントフックのライフサイクル例 (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 Calendar などの 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: カスタムプロバイダーやサードパーティアダプターを含め、SDK で OpenAI 以外のモデルを使用する方法を確認できます。

  • 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: 複雑なマルチエージェントリサーチワークフローを示す、シンプルなディープリサーチのクローンです。

  • tools: OpenAI がホストするツールや、次のような実験的な Codex ツール群の実装方法を学びます:

    • Web 検索およびフィルター付き Web 検索
    • ファイル検索
    • Code interpreter
    • ファイル編集と承認を伴う apply patch ツール (examples/tools/apply_patch.py)
    • 承認コールバックを伴うシェルツール実行 (examples/tools/shell.py)
    • 人間参加型の中断ベース承認を伴うシェルツール (examples/tools/shell_human_in_the_loop.py)
    • インラインスキルを使用するホスト型コンテナーシェル (examples/tools/container_shell_inline_skill.py)
    • スキル参照を使用するホスト型コンテナーシェル (examples/tools/container_shell_skill_reference.py)
    • ローカルスキルを使用するローカルシェル (examples/tools/local_shell_skill.py)
    • 名前空間と遅延ツールを使用するツール検索 (examples/tools/tool_search.py)
    • コンピュータ操作
    • 画像生成
    • 実験的な Codex ツールワークフロー (examples/tools/codex.py)
    • 実験的な Codex 同一スレッドワークフロー (examples/tools/codex_same_thread.py)

  • voice: OpenAI の TTS および STT モデルを使用する音声エージェントの例をご覧ください。ストリーミング音声の例も含まれます。