Skip to content

examples.md

Latest commit

 

History

History
107 lines (85 loc) · 6.61 KB

examples.md

File metadata and controls

107 lines (85 loc) · 6.61 KB
search
exclude
true

コード例

repo の examples セクションで、 SDK のさまざまなサンプル実装をご確認ください。examples は、異なるパターンと機能を示す複数のカテゴリーに整理されています。

カテゴリー

  • agent_patterns: このカテゴリーのコード例では、一般的なエージェント設計パターンを示しています。たとえば次のとおりです。

    • 決定論的ワークフロー
    • Agents as tools
    • エージェントの並列実行
    • 条件付きツール使用
    • 入出力ガードレール
    • 審判としての LLM
    • ルーティング
    • ストリーミングガードレール
    • 承認フロー向けのカスタム拒否メッセージ (examples/agent_patterns/human_in_the_loop_custom_rejection.py)

  • basic: これらのコード例では、 SDK の基本的な機能を紹介しています。たとえば次のとおりです。

    • Hello World のコード例 (デフォルトモデル、 GPT-5、オープンウェイトモデル)
    • エージェントライフサイクル管理
    • 動的システムプロンプト
    • ストリーミング出力 (テキスト、項目、関数呼び出し引数)
    • ターン間で共有セッションヘルパーを使用する Responses websocket transport (examples/basic/stream_ws.py)
    • プロンプトテンプレート
    • ファイル処理 (ローカルおよびリモート、画像および PDF)
    • 使用状況トラッキング
    • Runner 管理の再試行設定 (examples/basic/retry.py)
    • LiteLLM を使用した Runner 管理の再試行 (examples/basic/retry_litellm.py)
    • 非 strict な出力型
    • 以前のレスポンス ID の使用

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

  • financial_research_agent: 金融データ分析向けに、エージェントとツールを使った構造化リサーチワークフローを示す金融リサーチエージェントです。

  • handoffs: メッセージフィルタリングを使ったエージェントハンドオフの実践的なコード例をご覧ください。

  • hosted_mcp: ホストされた MCP (Model context protocol) コネクタと承認の使い方を示すコード例です。

  • mcp: MCP (Model context protocol) を使ってエージェントを構築する方法を学べます。内容は次のとおりです。

    • ファイルシステムのコード例
    • Git のコード例
    • MCP プロンプトサーバーのコード例
    • SSE (Server-Sent Events) のコード例
    • ストリーム可能な HTTP のコード例

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

    • SQLite セッションストレージ
    • 高度な SQLite セッションストレージ
    • Redis セッションストレージ
    • SQLAlchemy セッションストレージ
    • Dapr state store セッションストレージ
    • 暗号化セッションストレージ
    • OpenAI Conversations セッションストレージ
    • Responses compaction セッションストレージ
    • ModelSettings(store=False) を使ったステートレスな Responses compaction (examples/memory/compaction_session_stateless_example.py)

  • model_providers: カスタムプロバイダーや LiteLLM 統合を含め、 SDK で非 OpenAI モデルを使う方法を確認できます。

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

    • 構造化テキストと画像メッセージを使う Web アプリケーションパターン
    • コマンドライン音声ループと再生処理
    • WebSocket 経由の Twilio Media Streams 統合
    • Realtime Calls API のアタッチフローを使う Twilio SIP 統合

  • reasoning_content: reasoning content と structured outputs の扱い方を示すコード例です。

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

  • tools: 次のような OpenAI がホストするツールと実験的な Codex ツール機能の実装方法を学べます。

    • Web 検索 とフィルター付き Web 検索
    • ファイル検索
    • Code Interpreter
    • インラインスキル付きホストコンテナーシェル (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: ストリーミング音声のコード例を含む、 TTS および STT モデルを使用した音声エージェントのコード例をご覧ください。