superdialog 0.2.0a0__tar.gz

superdialog-0.2.0a0/.gitignore

@@ -0,0 +1,25 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtualenv / tooling caches
+.venv/
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+
+# Environment
+.env
+.env.*
+!.env.example
+
+# Editor / OS
+.DS_Store
+
+# Local-only planning docs (kept out of the deploy repo)
+docs/plans/
+docs/superpowers/

superdialog-0.2.0a0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

superdialog-0.2.0a0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: superdialog
+Version: 0.2.0a0
+Summary: Standalone dialog state machine framework — text in, text out.
+Author-email: Unpod <parvinder@unpod.ai>
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: litellm>=1.50
+Requires-Dist: pydantic>=2.5
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: transitions>=0.9
+Requires-Dist: typing-extensions>=4.10
+Provides-Extra: dev
+Requires-Dist: anyio>=4; extra == 'dev'
+Requires-Dist: pyrefly>=0.1; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.110; extra == 'fastapi'
+Requires-Dist: uvicorn>=0.27; extra == 'fastapi'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3; extra == 'langchain'
+Provides-Extra: livekit
+Requires-Dist: livekit-agents>=0.12; extra == 'livekit'
+Provides-Extra: mcp
+Requires-Dist: mcp>=0.9; extra == 'mcp'
+Provides-Extra: pipecat
+Requires-Dist: pipecat-ai>=0.0.50; extra == 'pipecat'
+Provides-Extra: ws
+Requires-Dist: websockets>=12; extra == 'ws'
+Description-Content-Type: text/markdown
+
+# superdialog
+
+Standalone dialog state machine framework. Text in, text out.
+
+See `docs/` for product spec; see `docs/plans/` for implementation plans.

superdialog-0.2.0a0/README.md

@@ -0,0 +1,5 @@
+# superdialog
+
+Standalone dialog state machine framework. Text in, text out.
+
+See `docs/` for product spec; see `docs/plans/` for implementation plans.

superdialog-0.2.0a0/chat.py

@@ -0,0 +1,246 @@
+"""
+superdialog tester.
+
+    python chat.py               → chat with last generated flow
+    python chat.py --generate    → generate new flow from GENERATE_PROMPT,
+                                   save to FLOW_PATH, then chat with it
+
+Workflow:
+  1. Edit GENERATE_PROMPT below
+  2. Run: python chat.py --generate
+     → new flow JSON saved to FLOW_PATH (overwrites)
+     → chat starts immediately
+  3. Next time, just: python chat.py   (reuses saved flow, no LLM generate call)
+"""
+
+from __future__ import annotations
+import asyncio, os, sys, textwrap, argparse, json
+from datetime import datetime, timezone
+from pathlib import Path
+from dotenv import load_dotenv
+
+load_dotenv("/home/ankit/Unpod/super-sanyam/.env")
+
+from superdialog.traversal import build_traversal, save_traversal
+
+# ── CONFIGURE HERE ─────────────────────────────────────────────────────────────
+MODEL = "openai/gpt-4.1-mini"
+
+# --- generated flow always saved/loaded here ---
+FLOW_PATH        = "/home/ankit/Downloads/flow_golf_ai_updated.json"
+SYSTEM_PROMPT_PATH = "/home/ankit/Unpod/super-sanyam/super/superdialog/generated_system_prompt.txt"
+TRAVERSAL_DIR = Path(__file__).parent / "src/superdialog/traversal"
+
+# --- describe the agent you want to build ---
+GENERATE_PROMPT = """
+A voice tee-time booking agent for GolfAI TeeTime named Arjun (male).
+
+On start: greet the caller with time-of-day salutation (Good morning / Good afternoon /
+Good evening). Returning callers (with booking history) get a personalised greeting
+mentioning their last course and are offered to rebook or go somewhere new.
+New callers get a standard welcome.
+
+Core booking flow:
+1. Collect: city or specific course name.
+2. If multiple courses in city, list them and ask caller to choose.
+3. Collect: booking date, preferred tee time (range 6 AM – 5:45 PM), number of players (max 4).
+4. Check availability for the selected course, date, and time window.
+5. Present nearest available slot and price. Confirm full summary (course, date, time, players, total price).
+6. Inform caller that payment link has been sent to their registered email and they have 7 minutes to pay.
+7. End call after payment instruction — do not wait for payment.
+
+Additional paths:
+- Caller wants to rebook the same course as last time → skip city/course collection, ask only for date, time, players.
+- Caller wants to check an existing booking → ask for booking reference, read back details.
+- Caller wants to cancel a booking → ask for reference, confirm cancellation.
+- Caller asks about course details (pricing, facilities, policy) → provide details, then offer to book.
+- Caller asks which cities have courses → list available cities.
+- Caller is silent after greeting → ask "Hello, can you hear me?"; if still silent → end call.
+- Caller says call back later → collect preferred callback time, confirm, end call.
+- Caller says goodbye → immediately end call politely without asking further questions.
+
+Language: detect caller's language and respond in the same language throughout.
+Support Hinglish (Hindi-English mix). Agent (Arjun) uses masculine Hindi verb forms for himself
+but gender-neutral forms when addressing the caller.
+Numbers are always spoken as words (e.g. four thousand eight hundred, not 4800).
+Never reveal internal IDs (course_id, booking_id) to the caller.
+Never re-greet after the greeting node.
+"""
+# ───────────────────────────────────────────────────────────────────────────────
+
+R="\033[0m"; B="\033[1m"; DIM="\033[2m"
+GRN="\033[92m"; CYN="\033[96m"; YLW="\033[93m"
+GRY="\033[90m"; RED="\033[91m"; WHT="\033[97m"
+
+W = min(os.get_terminal_size().columns if sys.stdout.isatty() else 88, 100)
+
+def hr(c="─"): print(GRY + c*W + R)
+def wrap(text, pad=6):
+    p = " " * pad
+    return textwrap.fill(text.strip(), width=W-pad, initial_indent=p, subsequent_indent=p)
+
+
+def print_msg(msg: dict):
+    role, content, n = msg.get("role"), msg.get("content","").strip(), msg.get("_node","")
+    if not content or role == "system":
+        return
+    if role == "user":
+        print(f"  {B}{GRN}You{R}")
+        print(wrap(content)); print()
+    elif role == "assistant":
+        print(f"  {B}{CYN}Bot{R}  {GRY}[{n}]{R}")
+        for line in content.split("\n"):
+            if line.strip(): print(wrap(line))
+        print()
+
+
+def print_node_status(node: str):
+    hr()
+    print(f"  {DIM}node: {B}{WHT}{node}{R}  {GRY}│  quit = exit{R}")
+    hr()
+
+
+
+
+async def generate_and_save():
+    """Generate flow from GENERATE_PROMPT, save to FLOW_PATH."""
+    from superdialog import create_dialog_flow
+
+    hr("═")
+    print(f"{B}{WHT}  Generating flow...{R}  {DIM}{MODEL}{R}"); hr("═"); print()
+    print(f"{YLW}  Prompt:{R}")
+    for line in GENERATE_PROMPT.strip().split("\n"):
+        if line.strip(): print(f"    {DIM}{line.strip()}{R}")
+    print(f"\n  {DIM}Calling LLM...{R}", flush=True)
+
+    flow = await create_dialog_flow(prompt=GENERATE_PROMPT.strip(), llm=MODEL)
+
+    flow.save(FLOW_PATH)
+    with open(SYSTEM_PROMPT_PATH, "w") as f:
+        f.write(flow.system_prompt)
+    print(f"  {GRN}✓ System prompt saved:{R}  {B}{SYSTEM_PROMPT_PATH}{R}")
+
+    node_count = len(flow.nodes)
+    edge_count = sum(len(n.edges) for n in flow.nodes)
+    print(f"\n  {GRN}✓ Flow generated + saved:{R}  {B}{FLOW_PATH}{R}")
+    print(f"  {B}{node_count} nodes{R}  {GRY}│{R}  {B}{edge_count} edges{R}\n")
+    print(f"  {DIM}Nodes:{R}")
+    for n in flow.nodes:
+        star = f"{GRN}★{R}" if n.id == flow.initial_node else " "
+        edges_preview = ", ".join(e.id for e in n.edges[:3])
+        if len(n.edges) > 3: edges_preview += "..."
+        print(f"    {star} {B}{n.id}{R}  {GRY}→ [{edges_preview}]{R}")
+    print()
+    input(f"  {DIM}Press Enter to start chat...{R} ")
+
+
+async def chat(flow_path: str):
+    from superdialog import DialogMachine, Flow
+
+    if not os.path.exists(flow_path):
+        print(f"{RED}Flow not found: {flow_path}{R}"); sys.exit(1)
+
+    flow    = Flow.load(flow_path)
+    machine = DialogMachine(flow=flow, llm=MODEL)
+    source  = os.path.basename(flow_path)
+    chat_turns: list[dict] = []
+    started_at = datetime.now(timezone.utc)
+
+    hr("═")
+    print(f"{B}{WHT}  superdialog tester{R}  {GRY}│{R}  {CYN}{source}{R}  {GRY}│{R}  {DIM}model: {MODEL}{R}")
+    hr("═"); print()
+
+    try:
+        first = await machine.start()
+    except Exception as e:
+        print(f"{RED}Failed to start: {e}{R}"); sys.exit(1)
+
+    node = machine.state["node_id"]
+    if first.text:
+        msg = {"role": "assistant", "content": first.text, "_node": node}
+        print_msg(msg)
+    chat_turns.append({
+        "step": 1,
+        "bot": first.text or "",
+        "user": None,
+        "node": node,
+        "ts": datetime.now(timezone.utc).isoformat(),
+    })
+
+    while True:
+        print_node_status(node)
+
+        if machine._machine and machine._machine.is_complete:
+            print(f"\n  {B}{GRN}✓ Conversation complete.{R}\n"); break
+
+        try:
+            raw = input(f"\n  {B}{GRN}You ›{R} ").strip()
+        except (EOFError, KeyboardInterrupt):
+            print(f"\n\n  {DIM}[exited]{R}\n"); break
+
+        if raw.lower() in {"quit","exit","q","/quit"}:
+            print(f"\n  {DIM}[exited]{R}\n"); break
+        if not raw:
+            continue
+
+        print()
+        print_msg({"role": "user", "content": raw})
+
+        try:
+            turn = await machine.turn(raw)
+        except Exception as e:
+            print_msg({"role": "assistant", "content": f"[ERROR: {e}]", "_node": node})
+            continue
+
+        node = machine.state["node_id"]
+        if turn.text:
+            print_msg({"role": "assistant", "content": turn.text, "_node": node})
+        chat_turns.append({
+            "step": len(chat_turns) + 1,
+            "bot": turn.text or "",
+            "user": raw,
+            "node": node,
+            "ts": datetime.now(timezone.utc).isoformat(),
+        })
+
+    # Save traversal after loop exits
+    if chat_turns:
+        try:
+            traversal = build_traversal(
+                machine, chat_turns, flow, source, MODEL, started_at
+            )
+            saved_path = save_traversal(traversal, TRAVERSAL_DIR)
+            print(f"\n  {GRN}✓ Traversal saved:{R}  {B}{saved_path}{R}")
+            print(f"  {DIM}  {len(traversal['traversal'])} steps  │  "
+                  f"{sum(1 for n in traversal['graph']['nodes'] if n['visited'])} nodes visited{R}\n")
+        except Exception as e:
+            print(f"\n  {YLW}Warning: traversal save failed: {e}{R}\n")
+
+
+async def main_async(generate: bool):
+    import asyncio as _aio
+    if generate:
+        await generate_and_save()
+    elif not os.path.exists(FLOW_PATH):
+        print(f"{YLW}No flow found at:{R}  {FLOW_PATH}")
+        print(f"{DIM}Run with --generate first to create one.{R}")
+        sys.exit(1)
+    await chat(FLOW_PATH)
+    await _aio.sleep(0.15)  # let SSL connections flush before loop closes
+
+
+def main():
+    p = argparse.ArgumentParser(description=__doc__,
+                                formatter_class=argparse.RawDescriptionHelpFormatter)
+    p.add_argument("--generate", action="store_true",
+                   help="Generate new flow from GENERATE_PROMPT, save, then chat")
+    args = p.parse_args()
+
+    if not os.environ.get("OPENAI_API_KEY") and MODEL.startswith("openai/"):
+        print(f"{YLW}Warning: OPENAI_API_KEY not set{R}")
+
+    asyncio.run(main_async(args.generate))
+
+
+if __name__ == "__main__":
+    main()

superdialog-0.2.0a0/docs/00-overview.md

@@ -0,0 +1,95 @@
+# SuperDialog — Overview
+
+**Status:** Canonical
+**Parent:** [README.md](README.md)
+
+---
+
+## 1. What it is
+
+A Python library that turns a prompt or a flow graph into an executable dialog state machine. Pure text in, pure text out. Plays the role of the "brain" in conversational systems.
+
+## 2. Why standalone
+
+Two reasons:
+
+**(a) The brain has natural reuse beyond voice.** A dialog state machine that runs a customer-onboarding flow works the same whether the user is on a phone, a WhatsApp thread, an Intercom widget, or a CLI test harness. Coupling it to telephony forecloses every non-voice use case.
+
+**(b) The dependency direction matters.** Voice Infrastructure should depend on SuperDialog (as one brain option), not the other way around. Putting SuperDialog inside the platform makes the platform non-modular and the framework non-portable.
+
+> *"उस machine को release करने का more less idea यह है... इस architecture से इन इस infrastructure से उसका कोई लेना देना नहीं है."*
+
+## 3. Why OSS
+
+- **Community pull.** LiveKit and PipeCat owe their adoption to OSS. Releasing a strong dialog framework — with good docs, working LiveKit/PipeCat adapters, and a CLI chatbot mode for evaluation — creates a top-of-funnel that no closed product can match.
+- **Lower support burden.** Developers who build complex flows will keep modifying them. If the framework is theirs to fork, our team is not in the loop for every prompt change.
+- **Trust.** Buyers who don't want vendor lock-in see an open core and engage further. The closed parts (telephony, voice profiles) are the parts they don't care about owning.
+
+## 4. Why it ships first
+
+Three reasons:
+
+**(a) It already exists.** The dialog state machine code is the most mature part of the Unpod stack. Polishing it for OSS release is faster than building new telephony infrastructure.
+
+**(b) Independent shippability.** It needs no telephony, no speech, no media server, no Room — none of the platform pieces. Therefore nothing on the platform side gates it.
+
+**(c) Validation channel.** Public release is the cheapest way to learn whether the framework actually solves the *"developer wants to own their flow"* problem we hypothesize. If the OSS adoption signal is weak, the Voice Infra GTM (which depends on the same hypothesis) needs rethinking before we burn cycles on it.
+
+## 5. Positioning
+
+SuperDialog is to **conversation flow** what n8n is to **integration workflow** — a simple, composable, eval-able runtime for orchestrating turn-by-turn logic. Where LangChain and LangGraph expose agent primitives, SuperDialog focuses narrowly on the conversational state machine: who speaks next, what flow to switch to, when to call a tool, when to escalate.
+
+It is intentionally smaller than LangChain in surface area. The pitch is: *"if your problem is conversation state, this is the right size."*
+
+## 6. Audiences
+
+| Audience | Why they care |
+|---|---|
+| **Voice developer using LiveKit / PipeCat today** | Drop SuperDialog in as the brain; stop hand-writing turn logic |
+| **Chatbot developer (text-only)** | Use SuperDialog directly with FastAPI; test as a CLI chat |
+| **Enterprise dev with their own LLM** | Plug their custom LLM URI (`custom/internal/...`) and get the rest of the framework for free |
+| **Unpod Voice Infra customer** | SuperDialog is the default brain Unpod offers; same code runs locally and inside Unpod cloud |
+
+## 7. What it does well
+
+| Capability | Status |
+|---|---|
+| Prompt → flow: `await create_dialog_flow(prompt=..., llm=...)` | shipped (v0.1) |
+| Turn execution: `await dialog_machine.turn(text)` | shipped (v0.1) |
+| LLM provider abstraction (model URIs) | shipped (v0.1) |
+| Tools: Python callables, HTTP endpoints, MCP servers | shipped (v0.1) |
+| Mid-conversation flow switching (`FlowSet`, `switch_flow`) | shipped (v0.1) |
+| CLI: `chat`, `flow lint / draw / generate` | shipped (v0.1) |
+| Adapters: LiveKit `DialogMachineLLM`, PipeCat `make_processor`, FastAPI, WebSocket | shipped (v0.1) |
+| `Agent` Protocol + `Session` + `SessionWorker` (multi-conversation lifecycle, in-process persistence, per-session locking) | shipped (v0.2) |
+| `LLMAgent`, `LangChainAgent` (non-DM brains usable in SessionWorker) | shipped (v0.2) |
+| `assist(text)` (renamed from `inject_system`) | shipped (v0.2) |
+| Distributed stores (`RedisSessionStore`, `FileSessionStore`, `SQLiteSessionStore`) + `RedisLockBackend` | planned (v0.3) |
+| Pluggable HTTP auth (`BearerAuth`, `BasicAuth`, callable) | planned (v0.3) |
+| `Eval` harness + `superdialog eval` CLI | planned (v0.3) |
+| True provider-level streaming inference | planned (v0.4) |
+| Streaming-interruption (`UserChunk`/`AgentChunk` protocol) | planned (v0.4) |
+
+## 8. What it explicitly is not
+
+- **Not a UI flow designer.** That belongs to a downstream tool (future, n8n-style).
+- **Not a voice framework.** Audio/STT/TTS are out of scope.
+- **Not multi-modal.** Text only at the interface. (Vision/audio inputs through tools, if needed.)
+- **Not a hosted service.** A library. Hosting is offered by Voice Infra for those who want it.
+
+## 9. Success criteria
+
+- **GitHub stars and forks.** Baseline target TBD, but real numbers — not vanity metrics.
+- **Adapter usage.** Are developers actually plugging SuperDialog into LiveKit and PipeCat? Telemetry from optional usage pings if they opt in.
+- **Eval adoption.** Are developers running the eval harness, or just using the runtime? The eval is part of what differentiates this from "yet another agent framework."
+- **Issue and PR volume.** OSS health.
+- **Unpod Voice Infra trial conversion.** Of the OSS users who try Voice Infra, what fraction stick? This is the funnel justification for releasing the framework freely.
+
+## 10. Anti-goals
+
+We will refuse to:
+- Add features that only matter on a phone call (audio handling, RTP, SIP, etc.).
+- Tie OSS releases to Unpod account creation.
+- Use the OSS as a freemium ladder where critical features are paid. The framework is fully usable without ever paying Unpod.
+
+The paid product is the Speech Pipe. The framework is the loss leader.