mermaid diagrams

Author: alwell-kevin

examples/deep_research_api/introduction_to_deep_research_api.ipynb

@@ -454,6 +454,47 @@
         "\n",
         "This setup gives developers full control over how research tasks are framed, but also places greater responsibility on the quality of the input prompt. Here's an example of a generic rewriting_prompt to better direct the subsequent deep research query.\n",
         "\n",
+        "```mermaid\n",
+        "flowchart TD\n",
+        "  %% Interactive ChatGPT Flow with Clarifier\n",
+        "  subgraph ChatGPT Session\n",
+        "    direction TB\n",
+        "    U1([User Query])\n",
+        "    C[Clarifier<br/>lightweight model]\n",
+        "    Q[Clarifying Questions]\n",
+        "    UQ([User’s Answers])\n",
+        "    R[Rewriter<br/>lightweight model]\n",
+        "    EP[Enriched Prompt]\n",
+        "    DR[Deep Research<br/>o3-deep-research]\n",
+        "    O[Research Results]\n",
+        "\n",
+        "    U1 --> C\n",
+        "    C  --> Q\n",
+        "    Q  --> UQ\n",
+        "    UQ --> R\n",
+        "    R  --> EP\n",
+        "    EP --> DR\n",
+        "    DR --> O\n",
+        "  end\n",
+        "\n",
+        "  %% Deep Research API Flow (no built-in clarifier)\n",
+        "  subgraph Deep Research API\n",
+        "    direction TB\n",
+        "    U2([User Query])\n",
+        "    R2[Rewriter<br/>optional]\n",
+        "    EP2[Enriched Prompt]\n",
+        "    DR2[Deep Research API<br/>o3-deep-research]\n",
+        "    O2[Research Results]\n",
+        "\n",
+        "    U2 -->|include all details up-front| EP2\n",
+        "    EP2 --> DR2\n",
+        "    DR2 --> O2\n",
+        "\n",
+        "    U2 -->|use prompt rewriter| R2\n",
+        "    R2 --> EP2\n",
+        "  end\n",
+        "```\n",
+        "\n",
         "Here's an example of a rewriting prompt:"
       ]
     },

examples/deep_research_api/introduction_to_deep_research_api_agents.ipynb

@@ -260,6 +260,27 @@
         "   - Streams intermediate events for transparency\n",
         "   - Outputs final Research Artifact (which we later parse)\n",
         "\n",
+        "```mermaid\n",
+        "flowchart LR\n",
+        "    subgraph Triage\n",
+        "        TA[Triage Agent<br/>• Inspect query<br/>• Route based on context]\n",
+        "    end\n",
+        "    subgraph Clarifier\n",
+        "        CA[Clarifier Agent<br/>• Ask follow‐up questions<br/>• Receive answers]\n",
+        "    end\n",
+        "    subgraph Instruction\n",
+        "        IA[Instruction Builder Agent<br/>• Build precise research brief]\n",
+        "    end\n",
+        "    subgraph Research\n",
+        "        RA[Research Agent<br/> o3‐deep‐research <br/>• WebSearchTool<br/>• Internal MCP search<br/>• Stream events<br/>• Output Artifact]\n",
+        "    end\n",
+        "\n",
+        "    TA -->|Missing context| CA\n",
+        "    TA -->|Context OK| IA\n",
+        "    CA --> IA\n",
+        "    IA --> RA\n",
+        "```\n",
+        "\n",
         "For more insight into _how_ the MCP server is build. [See this resource.](https://cookbook.openai.com/examples/deep_research_api/how_to_build_a_deep_research_mcp_server/README )"
       ]
     },