From bc13310303cf39d88286fd0d3bfdd39223d89a3e Mon Sep 17 00:00:00 2001 From: dcocco Date: Mon, 22 Dec 2025 17:06:47 +0100 Subject: [PATCH] Completed splitting of import and export usage examples --- .../source/_templates/navbar-new.html | 4 +- docs/pyagentspec/source/adapters/autogen.rst | 61 ------------------- .../adapters/autogen/autogen_to_spec.rst | 12 ++++ .../source/adapters/autogen/index.rst | 43 +++++++++++++ .../adapters/autogen/spec_to_autogen.rst | 12 ++++ .../pyagentspec/source/adapters/langgraph.rst | 60 ------------------ .../source/adapters/langgraph/index.rst | 44 +++++++++++++ .../adapters/langgraph/langgraph_to_spec.rst | 11 ++++ .../adapters/langgraph/spec_to_langgraph.rst | 12 ++++ .../{wayflow.rst => wayflow/index.rst} | 34 +++-------- .../adapters/wayflow/spec_to_wayflow.rst | 12 ++++ .../adapters/wayflow/wayflow_to_spec.rst | 11 ++++ docs/pyagentspec/source/docs_home.rst | 8 +-- 13 files changed, 171 insertions(+), 153 deletions(-) delete mode 100644 docs/pyagentspec/source/adapters/autogen.rst create mode 100644 docs/pyagentspec/source/adapters/autogen/autogen_to_spec.rst create mode 100644 docs/pyagentspec/source/adapters/autogen/index.rst create mode 100644 docs/pyagentspec/source/adapters/autogen/spec_to_autogen.rst delete mode 100644 docs/pyagentspec/source/adapters/langgraph.rst create mode 100644 docs/pyagentspec/source/adapters/langgraph/index.rst create mode 100644 docs/pyagentspec/source/adapters/langgraph/langgraph_to_spec.rst create mode 100644 docs/pyagentspec/source/adapters/langgraph/spec_to_langgraph.rst rename docs/pyagentspec/source/adapters/{wayflow.rst => wayflow/index.rst} (50%) create mode 100644 docs/pyagentspec/source/adapters/wayflow/spec_to_wayflow.rst create mode 100644 docs/pyagentspec/source/adapters/wayflow/wayflow_to_spec.rst diff --git a/docs/pyagentspec/source/_templates/navbar-new.html b/docs/pyagentspec/source/_templates/navbar-new.html index f59be579..a2c3870a 100644 --- a/docs/pyagentspec/source/_templates/navbar-new.html +++ b/docs/pyagentspec/source/_templates/navbar-new.html @@ -13,8 +13,8 @@
  • Release Notes
    • -
  • - Adapters +
  • + Adapters
  • Ecosystem diff --git a/docs/pyagentspec/source/adapters/autogen.rst b/docs/pyagentspec/source/adapters/autogen.rst deleted file mode 100644 index 0807aa1c..00000000 --- a/docs/pyagentspec/source/adapters/autogen.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _autogenadapter: - -============================= -Agent Spec Adapters - AutoGen -============================= - - -.. figure:: ../_static/icons/autogen-adapter.jpg - :align: center - :scale: 20% - :alt: Agent Spec adapter for AutoGen - - ↑ With the **Agent Spec adapter for AutoGen**, you can easily import agents from external frameworks using Agent Spec and run them with AutoGen. - - -*Microsoft AutoGen supports the development of multi-agent conversational systems, -allowing agents to communicate and collaborate to solve tasks.* - - -Get started -=========== - -To get started, set up your Python environment (Python 3.10 to 3.12 required), -and then install the PyAgentSpec package with the AutoGen extension. - - -.. code-block:: bash - - python -m venv .venv - source .venv/bin/activate # On Windows: .venv\Scripts\activate - pip install "pyagentspec[autogen]" - - -You are now ready to use the adapter: - -- Run Agent Spec configurations with AutoGen (see more details :ref:`below `) -- Convert AutoGen agents to Agent Spec (see more details :ref:`below `) - - - -.. _spectoautogen: - -Run Agent Spec configurations with AutoGen -========================================== - - -.. literalinclude:: ../code_examples/adapter_autogen_quickstart.py - :language: python - :start-after: .. start-agentspec_to_runtime - :end-before: .. end-agentspec_to_runtime - - -.. _autogentospec: - -Convert AutoGen agents to Agent Spec -==================================== - -.. literalinclude:: ../code_examples/adapter_autogen_quickstart.py - :language: python - :start-after: .. start-runtime_to_agentspec - :end-before: .. end-runtime_to_agentspec diff --git a/docs/pyagentspec/source/adapters/autogen/autogen_to_spec.rst b/docs/pyagentspec/source/adapters/autogen/autogen_to_spec.rst new file mode 100644 index 00000000..991553e1 --- /dev/null +++ b/docs/pyagentspec/source/adapters/autogen/autogen_to_spec.rst @@ -0,0 +1,12 @@ + +.. _autogentospec: + +Convert AutoGen agents to Agent Spec +==================================== + +This usage example showcases how an AutoGen Agent can be converted into an Agent Spec configuration in JSON format. + +.. literalinclude:: ../../code_examples/adapter_autogen_quickstart.py + :language: python + :start-after: .. start-runtime_to_agentspec + :end-before: .. end-runtime_to_agentspec diff --git a/docs/pyagentspec/source/adapters/autogen/index.rst b/docs/pyagentspec/source/adapters/autogen/index.rst new file mode 100644 index 00000000..fbad985c --- /dev/null +++ b/docs/pyagentspec/source/adapters/autogen/index.rst @@ -0,0 +1,43 @@ +.. _autogenadapter: + +============================= +Agent Spec Adapters - AutoGen +============================= + + +.. figure:: ../../_static/icons/autogen-adapter.jpg + :align: center + :scale: 20% + :alt: Agent Spec adapter for AutoGen + + ↑ With the **Agent Spec adapter for AutoGen**, you can easily import agents from external frameworks using Agent Spec and run them with AutoGen. + + +*Microsoft AutoGen supports the development of multi-agent conversational systems, +allowing agents to communicate and collaborate to solve tasks.* + + +Get started +=========== + +To get started, set up your Python environment (Python 3.10 to 3.12 required), +and then install the PyAgentSpec package with the AutoGen extension. + + +.. code-block:: bash + + python -m venv .venv + source .venv/bin/activate # On Windows: .venv\Scripts\activate + pip install "pyagentspec[autogen]" + + +Usage Examples +============== + +You are now ready to use the adapter to: + +.. toctree:: + :maxdepth: 1 + + Run Agent Spec configurations with AutoGen + Convert AutoGen agents to Agent Spec diff --git a/docs/pyagentspec/source/adapters/autogen/spec_to_autogen.rst b/docs/pyagentspec/source/adapters/autogen/spec_to_autogen.rst new file mode 100644 index 00000000..4e12b749 --- /dev/null +++ b/docs/pyagentspec/source/adapters/autogen/spec_to_autogen.rst @@ -0,0 +1,12 @@ +.. _spectoautogen: + +Run Agent Spec configurations with AutoGen +========================================== + +This usage example showcases the creation of a simple Agent Spec Agent, subsequently serialized into JSON and converted into an AutoGen +assistant. Also includes mapping of a `ServerTool` and execution of the conversation. + +.. literalinclude:: ../../code_examples/adapter_autogen_quickstart.py + :language: python + :start-after: .. start-agentspec_to_runtime + :end-before: .. end-agentspec_to_runtime diff --git a/docs/pyagentspec/source/adapters/langgraph.rst b/docs/pyagentspec/source/adapters/langgraph.rst deleted file mode 100644 index 7ad1cfe9..00000000 --- a/docs/pyagentspec/source/adapters/langgraph.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. _langgraphadapter: - -=============================== -Agent Spec Adapters - LangGraph -=============================== - - -.. figure:: ../_static/icons/langgraph-adapter.jpg - :align: center - :scale: 18% - :alt: Agent Spec adapter for LangGraph - - ↑ With the **Agent Spec adapter for LangGraph**, you can easily import agents from external frameworks using Agent Spec and run them with LangGraph. - - -*LangGraph facilitates the creation and management of long-running, stateful agents -with durable execution and human-in-the-loop capabilities.* - - -Get started -=========== - -To get started, set up your Python environment (Python 3.10 or newer required), -and then install the PyAgentSpec package with the LangGraph extension. - - -.. code-block:: bash - - python -m venv .venv - source .venv/bin/activate # On Windows: .venv\Scripts\activate - pip install "pyagentspec[langgraph]" - - -You are now ready to use the adapter: - -- Run Agent Spec configurations with LangGraph (see more details :ref:`below `) -- Convert LangGraph agents to Agent Spec (see more details :ref:`below `) - - -.. _spectolanggraph: - -Run Agent Spec configurations with LangGraph -============================================ - - -.. literalinclude:: ../code_examples/adapter_langgraph_quickstart.py - :language: python - :start-after: .. start-agentspec_to_runtime - :end-before: .. end-agentspec_to_runtime - - -.. _langgraphtospec: - -Convert LangGraph agents to Agent Spec -====================================== - -.. literalinclude:: ../code_examples/adapter_langgraph_quickstart.py - :language: python - :start-after: .. start-runtime_to_agentspec - :end-before: .. end-runtime_to_agentspec diff --git a/docs/pyagentspec/source/adapters/langgraph/index.rst b/docs/pyagentspec/source/adapters/langgraph/index.rst new file mode 100644 index 00000000..e0955df8 --- /dev/null +++ b/docs/pyagentspec/source/adapters/langgraph/index.rst @@ -0,0 +1,44 @@ +.. _langgraphadapter: + +=============================== +Agent Spec Adapters - LangGraph +=============================== + + +.. figure:: ../../_static/icons/langgraph-adapter.jpg + :align: center + :scale: 18% + :alt: Agent Spec adapter for LangGraph + + ↑ With the **Agent Spec adapter for LangGraph**, you can easily import agents from external frameworks using Agent Spec and run them with LangGraph. + + +*LangGraph facilitates the creation and management of long-running, stateful agents +with durable execution and human-in-the-loop capabilities.* + + +Get started +=========== + +To get started, set up your Python environment (Python 3.10 or newer required), +and then install the PyAgentSpec package with the LangGraph extension. + + +.. code-block:: bash + + python -m venv .venv + source .venv/bin/activate # On Windows: .venv\Scripts\activate + pip install "pyagentspec[langgraph]" + + + +Usage Examples +============== + +You are now ready to use the adapter to: + +.. toctree:: + :maxdepth: 1 + + Run Agent Spec configurations with LangGraph + Convert LangGraph agents to Agent Spec diff --git a/docs/pyagentspec/source/adapters/langgraph/langgraph_to_spec.rst b/docs/pyagentspec/source/adapters/langgraph/langgraph_to_spec.rst new file mode 100644 index 00000000..35d5c3df --- /dev/null +++ b/docs/pyagentspec/source/adapters/langgraph/langgraph_to_spec.rst @@ -0,0 +1,11 @@ +.. _langgraphtospec: + +Convert LangGraph agents to Agent Spec +====================================== + +This usage example showcases how a LangGraph Agent can be converted into an Agent Spec configuration in JSON format. + +.. literalinclude:: ../../code_examples/adapter_langgraph_quickstart.py + :language: python + :start-after: .. start-runtime_to_agentspec + :end-before: .. end-runtime_to_agentspec diff --git a/docs/pyagentspec/source/adapters/langgraph/spec_to_langgraph.rst b/docs/pyagentspec/source/adapters/langgraph/spec_to_langgraph.rst new file mode 100644 index 00000000..663351e1 --- /dev/null +++ b/docs/pyagentspec/source/adapters/langgraph/spec_to_langgraph.rst @@ -0,0 +1,12 @@ +.. _spectolanggraph: + +Run Agent Spec configurations with LangGraph +============================================ + +This usage example showcases the creation of a simple Agent Spec Agent, subsequently serialized into JSON and converted into a LangGraph +assistant. Also includes mapping of a `ServerTool` and execution of the conversation. + +.. literalinclude:: ../../code_examples/adapter_langgraph_quickstart.py + :language: python + :start-after: .. start-agentspec_to_runtime + :end-before: .. end-agentspec_to_runtime diff --git a/docs/pyagentspec/source/adapters/wayflow.rst b/docs/pyagentspec/source/adapters/wayflow/index.rst similarity index 50% rename from docs/pyagentspec/source/adapters/wayflow.rst rename to docs/pyagentspec/source/adapters/wayflow/index.rst index 670482bc..b3c92abc 100644 --- a/docs/pyagentspec/source/adapters/wayflow.rst +++ b/docs/pyagentspec/source/adapters/wayflow/index.rst @@ -5,7 +5,7 @@ Agent Spec Adapters - WayFlow ============================= -.. figure:: ../_static/icons/wayflow-adapter.jpg +.. figure:: ../../_static/icons/wayflow-adapter.jpg :align: center :scale: 18% :alt: Agent Spec adapter for WayFlow @@ -31,31 +31,13 @@ and then install the PyAgentSpec package as well as WayFlowCore. pip install pyagentspec wayflowcore -You are now ready to use the adapter: +Usage Examples +============== -- Run Agent Spec configurations with WayFlow (see more details :ref:`below `) -- Convert WayFlow agents to Agent Spec (see more details :ref:`below `) +You are now ready to use the adapter to: +.. toctree:: + :maxdepth: 1 - -.. _spectowayflow: - -Run Agent Spec configurations with WayFlow -========================================== - - -.. literalinclude:: ../code_examples/adapter_wayflow_quickstart.py - :language: python - :start-after: .. start-agentspec_to_runtime - :end-before: .. end-agentspec_to_runtime - - -.. _wayflowtospec: - -Convert WayFlow agents to Agent Spec -==================================== - -.. literalinclude:: ../code_examples/adapter_wayflow_quickstart.py - :language: python - :start-after: .. start-runtime_to_agentspec - :end-before: .. end-runtime_to_agentspec + Run Agent Spec configurations with WayFlow + Convert WayFlow agents to Agent Spec diff --git a/docs/pyagentspec/source/adapters/wayflow/spec_to_wayflow.rst b/docs/pyagentspec/source/adapters/wayflow/spec_to_wayflow.rst new file mode 100644 index 00000000..0c119624 --- /dev/null +++ b/docs/pyagentspec/source/adapters/wayflow/spec_to_wayflow.rst @@ -0,0 +1,12 @@ +.. _spectowayflow: + +Run Agent Spec configurations with WayFlow +========================================== + +This usage example showcases the creation of a simple Agent Spec Agent, subsequently serialized into JSON and converted into a WayFlow +assistant. Also includes mapping of a `ServerTool` and execution of the conversation. + +.. literalinclude:: ../../code_examples/adapter_wayflow_quickstart.py + :language: python + :start-after: .. start-agentspec_to_runtime + :end-before: .. end-agentspec_to_runtime diff --git a/docs/pyagentspec/source/adapters/wayflow/wayflow_to_spec.rst b/docs/pyagentspec/source/adapters/wayflow/wayflow_to_spec.rst new file mode 100644 index 00000000..a2b61354 --- /dev/null +++ b/docs/pyagentspec/source/adapters/wayflow/wayflow_to_spec.rst @@ -0,0 +1,11 @@ +.. _wayflowtospec: + +Convert WayFlow agents to Agent Spec +==================================== + +This usage example shows how a WayFlow Agent can be converted into an Agent Spec JSON format. + +.. literalinclude:: ../../code_examples/adapter_wayflow_quickstart.py + :language: python + :start-after: .. start-runtime_to_agentspec + :end-before: .. end-runtime_to_agentspec diff --git a/docs/pyagentspec/source/docs_home.rst b/docs/pyagentspec/source/docs_home.rst index e19eb1fd..5ac651e9 100644 --- a/docs/pyagentspec/source/docs_home.rst +++ b/docs/pyagentspec/source/docs_home.rst @@ -114,13 +114,13 @@ Agent Spec is developed jointly between Oracle Cloud Infrastructure and Oracle L .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Adapters :hidden: - LangGraph - WayFlow - AutoGen + LangGraph + WayFlow + AutoGen .. toctree::