Merge pull request #332 from airtai/refactoring-0.3.0

Refactoring: introduce AdapterProtocol and ProviderProtocol

docs/docs/SUMMARY.md

@@ -33,7 +33,24 @@ search:
             - [TextInput](api/fastagency/TextInput.md)
             - [TextMessage](api/fastagency/TextMessage.md)
             - [UI](api/fastagency/UI.md)
-            - [Workflows](api/fastagency/Workflows.md)
+            - [WorkflowsProtocol](api/fastagency/WorkflowsProtocol.md)
+            - adapters
+                - fastapi
+                    - [FastAPIAdapter](api/fastagency/adapters/fastapi/FastAPIAdapter.md)
+                    - [FastAPIProvider](api/fastagency/adapters/fastapi/FastAPIProvider.md)
+                    - base
+                        - [FastAPIAdapter](api/fastagency/adapters/fastapi/base/FastAPIAdapter.md)
+                        - [FastAPIProvider](api/fastagency/adapters/fastapi/base/FastAPIProvider.md)
+                - nats
+                    - [InitiateModel](api/fastagency/adapters/nats/InitiateModel.md)
+                    - [InputResponseModel](api/fastagency/adapters/nats/InputResponseModel.md)
+                    - [NatsAdapter](api/fastagency/adapters/nats/NatsAdapter.md)
+                    - [NatsProvider](api/fastagency/adapters/nats/NatsProvider.md)
+                    - base
+                        - [InitiateModel](api/fastagency/adapters/nats/base/InitiateModel.md)
+                        - [InputResponseModel](api/fastagency/adapters/nats/base/InputResponseModel.md)
+                        - [NatsAdapter](api/fastagency/adapters/nats/base/NatsAdapter.md)
+                        - [NatsProvider](api/fastagency/adapters/nats/base/NatsProvider.md)
             - api
                 - openapi
                     - [OpenAPI](api/fastagency/api/openapi/OpenAPI.md)
@@ -56,22 +73,24 @@ search:
             - app
                 - [FastAgency](api/fastagency/app/FastAgency.md)
             - base
-                - [ASGI](api/fastagency/base/ASGI.md)
+                - [ASGIProtocol](api/fastagency/base/ASGIProtocol.md)
+                - [AdapterProtocol](api/fastagency/base/AdapterProtocol.md)
                 - [AskingMessage](api/fastagency/base/AskingMessage.md)
                 - [Error](api/fastagency/base/Error.md)
                 - [FunctionCallExecution](api/fastagency/base/FunctionCallExecution.md)
                 - [IOMessage](api/fastagency/base/IOMessage.md)
                 - [IOMessageVisitor](api/fastagency/base/IOMessageVisitor.md)
                 - [MultipleChoice](api/fastagency/base/MultipleChoice.md)
+                - [ProviderProtocol](api/fastagency/base/ProviderProtocol.md)
                 - [Runnable](api/fastagency/base/Runnable.md)
                 - [SuggestedFunctionCall](api/fastagency/base/SuggestedFunctionCall.md)
                 - [SystemMessage](api/fastagency/base/SystemMessage.md)
                 - [TextInput](api/fastagency/base/TextInput.md)
                 - [TextMessage](api/fastagency/base/TextMessage.md)
                 - [UI](api/fastagency/base/UI.md)
-                - [WSGI](api/fastagency/base/WSGI.md)
+                - [WSGIProtocol](api/fastagency/base/WSGIProtocol.md)
                 - [WorkflowCompleted](api/fastagency/base/WorkflowCompleted.md)
-                - [Workflows](api/fastagency/base/Workflows.md)
+                - [WorkflowsProtocol](api/fastagency/base/WorkflowsProtocol.md)
                 - [run_workflow](api/fastagency/base/run_workflow.md)
             - cli
                 - cli
@@ -103,14 +122,6 @@ search:
                 - [optional_temp_path](api/fastagency/helpers/optional_temp_path.md)
             - logging
                 - [get_logger](api/fastagency/logging/get_logger.md)
-            - new
-                - base
-                    - [ClientProtocol](api/fastagency/new/base/ClientProtocol.md)
-                    - [Conversation](api/fastagency/new/base/Conversation.md)
-                    - [FastAPIConversationClient](api/fastagency/new/base/FastAPIConversationClient.md)
-                    - [NatsProvider](api/fastagency/new/base/NatsProvider.md)
-                    - [ProviderProtocol](api/fastagency/new/base/ProviderProtocol.md)
-                    - [WorkflowInfo](api/fastagency/new/base/WorkflowInfo.md)
             - runtime
                 - autogen
                     - [AutoGenWorkflows](api/fastagency/runtime/autogen/AutoGenWorkflows.md)
@@ -133,12 +144,6 @@ search:
                     - [ConsoleUI](api/fastagency/ui/console/ConsoleUI.md)
                     - base
                         - [ConsoleUI](api/fastagency/ui/console/base/ConsoleUI.md)
-                - fastapi
-                    - [FastAPIProvider](api/fastagency/ui/fastapi/FastAPIProvider.md)
-                    - [FastAPIWorkflows](api/fastagency/ui/fastapi/FastAPIWorkflows.md)
-                    - base
-                        - [FastAPIProvider](api/fastagency/ui/fastapi/base/FastAPIProvider.md)
-                        - [FastAPIWorkflows](api/fastagency/ui/fastapi/base/FastAPIWorkflows.md)
                 - mesop
                     - [MesopUI](api/fastagency/ui/mesop/MesopUI.md)
                     - base
@@ -173,16 +178,6 @@ search:
                         - [MesopMultipleChoiceInnerStyles](api/fastagency/ui/mesop/styles/MesopMultipleChoiceInnerStyles.md)
                         - [MesopSingleChoiceInnerStyles](api/fastagency/ui/mesop/styles/MesopSingleChoiceInnerStyles.md)
                         - [MesopTextInputInnerStyles](api/fastagency/ui/mesop/styles/MesopTextInputInnerStyles.md)
-                - nats
-                    - [InitiateModel](api/fastagency/ui/nats/InitiateModel.md)
-                    - [InputResponseModel](api/fastagency/ui/nats/InputResponseModel.md)
-                    - [NatsProvider](api/fastagency/ui/nats/NatsProvider.md)
-                    - [NatsWorkflows](api/fastagency/ui/nats/NatsWorkflows.md)
-                    - base
-                        - [InitiateModel](api/fastagency/ui/nats/base/InitiateModel.md)
-                        - [InputResponseModel](api/fastagency/ui/nats/base/InputResponseModel.md)
-                        - [NatsProvider](api/fastagency/ui/nats/base/NatsProvider.md)
-                        - [NatsWorkflows](api/fastagency/ui/nats/base/NatsWorkflows.md)
     - [CLI](cli/cli.md)
 - [Contributing](contributing/index.md)
     - [Development](contributing/CONTRIBUTING.md)

docs/docs/en/api/fastagency/Workflows.md → docs/docs/en/api/fastagency/WorkflowsProtocol.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.Workflows
+::: fastagency.WorkflowsProtocol

docs/docs/en/api/fastagency/adapters/fastapi/FastAPIAdapter.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.adapters.fastapi.FastAPIAdapter

docs/docs/en/api/fastagency/ui/fastapi/FastAPIProvider.md → docs/docs/en/api/fastagency/adapters/fastapi/FastAPIProvider.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.fastapi.FastAPIProvider
+::: fastagency.adapters.fastapi.FastAPIProvider

docs/docs/en/api/fastagency/adapters/fastapi/base/FastAPIAdapter.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.adapters.fastapi.base.FastAPIAdapter

docs/docs/en/api/fastagency/ui/fastapi/base/FastAPIProvider.md → docs/docs/en/api/fastagency/adapters/fastapi/base/FastAPIProvider.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.fastapi.base.FastAPIProvider
+::: fastagency.adapters.fastapi.base.FastAPIProvider

docs/docs/en/api/fastagency/ui/nats/InitiateModel.md → docs/docs/en/api/fastagency/adapters/nats/InitiateModel.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.nats.InitiateModel
+::: fastagency.adapters.nats.InitiateModel

docs/docs/en/api/fastagency/ui/nats/InputResponseModel.md → docs/docs/en/api/fastagency/adapters/nats/InputResponseModel.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.nats.InputResponseModel
+::: fastagency.adapters.nats.InputResponseModel

docs/docs/en/api/fastagency/adapters/nats/NatsAdapter.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.adapters.nats.NatsAdapter

docs/docs/en/api/fastagency/new/base/NatsProvider.md → docs/docs/en/api/fastagency/adapters/nats/NatsProvider.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.new.base.NatsProvider
+::: fastagency.adapters.nats.NatsProvider

docs/docs/en/api/fastagency/ui/nats/base/InitiateModel.md → docs/docs/en/api/fastagency/adapters/nats/base/InitiateModel.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.nats.base.InitiateModel
+::: fastagency.adapters.nats.base.InitiateModel

docs/docs/en/api/fastagency/ui/nats/base/InputResponseModel.md → docs/docs/en/api/fastagency/adapters/nats/base/InputResponseModel.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.nats.base.InputResponseModel
+::: fastagency.adapters.nats.base.InputResponseModel

docs/docs/en/api/fastagency/adapters/nats/base/NatsAdapter.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.adapters.nats.base.NatsAdapter

docs/docs/en/api/fastagency/ui/nats/NatsProvider.md → docs/docs/en/api/fastagency/adapters/nats/base/NatsProvider.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.ui.nats.NatsProvider
+::: fastagency.adapters.nats.base.NatsProvider

docs/docs/en/api/fastagency/base/ASGI.md → docs/docs/en/api/fastagency/base/ASGIProtocol.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.base.ASGI
+::: fastagency.base.ASGIProtocol

docs/docs/en/api/fastagency/base/Workflows.md → docs/docs/en/api/fastagency/base/AdapterProtocol.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.base.Workflows
+::: fastagency.base.AdapterProtocol

docs/docs/en/api/fastagency/base/ProviderProtocol.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.base.ProviderProtocol

docs/docs/en/api/fastagency/base/WSGI.md → docs/docs/en/api/fastagency/base/WSGIProtocol.md

@@ -8,4 +8,4 @@ search:
   boost: 0.5
 ---
 
-::: fastagency.base.WSGI
+::: fastagency.base.WSGIProtocol

docs/docs/en/api/fastagency/base/WorkflowsProtocol.md

@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: fastagency.base.WorkflowsProtocol

docs/docs_src/getting_started/main_console.py

@@ -2,7 +2,7 @@
 
 from autogen.agentchat import ConversableAgent
 
-from fastagency import UI, FastAgency, Workflows
+from fastagency import UI, FastAgency, WorkflowsProtocol
 from fastagency.runtime.autogen import AutoGenWorkflows
 from fastagency.ui.console import ConsoleUI
 
@@ -21,7 +21,7 @@
 
 @wf.register(name="simple_learning", description="Student and teacher learning chat")
 def simple_workflow(
-    wf: Workflows, ui: UI, initial_message: str, session_id: str
+    wf: WorkflowsProtocol, ui: UI, initial_message: str, session_id: str
 ) -> str:
     student_agent = ConversableAgent(
         name="Student_Agent",
@@ -44,4 +44,4 @@ def simple_workflow(
     return chat_result.summary  # type: ignore[no-any-return]
 
 
-app = FastAgency(wf=wf, ui=ConsoleUI(), title="Learning Chat")
+app = FastAgency(provider=wf, ui=ConsoleUI(), title="Learning Chat")