mirror of
https://github.com/microsoft/autogen.git
synced 2025-08-20 22:52:06 +00:00
Add missing API doc for Python code execution tool (#4901)
* Add missing API doc for Python code execution tool * wip * Add API doc for the executor tool --------- Co-authored-by: Jack Gerrits <jackgerrits@users.noreply.github.com>
This commit is contained in:
parent
4486c67b42
commit
2ff543e876
@ -49,6 +49,7 @@ python/autogen_ext.teams.magentic_one
|
|||||||
python/autogen_ext.models.openai
|
python/autogen_ext.models.openai
|
||||||
python/autogen_ext.models.replay
|
python/autogen_ext.models.replay
|
||||||
python/autogen_ext.tools.langchain
|
python/autogen_ext.tools.langchain
|
||||||
|
python/autogen_ext.tools.code_execution
|
||||||
python/autogen_ext.code_executors.local
|
python/autogen_ext.code_executors.local
|
||||||
python/autogen_ext.code_executors.docker
|
python/autogen_ext.code_executors.docker
|
||||||
python/autogen_ext.code_executors.azure
|
python/autogen_ext.code_executors.azure
|
||||||
|
@ -0,0 +1,8 @@
|
|||||||
|
autogen\_ext.tools.code\_execution
|
||||||
|
==================================
|
||||||
|
|
||||||
|
|
||||||
|
.. automodule:: autogen_ext.tools.code_execution
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
@ -18,6 +18,49 @@ class CodeExecutionResult(BaseModel):
|
|||||||
|
|
||||||
|
|
||||||
class PythonCodeExecutionTool(BaseTool[CodeExecutionInput, CodeExecutionResult]):
|
class PythonCodeExecutionTool(BaseTool[CodeExecutionInput, CodeExecutionResult]):
|
||||||
|
"""A tool that executes Python code in a code executor and returns output.
|
||||||
|
|
||||||
|
Example executors:
|
||||||
|
|
||||||
|
* :class:`autogen_ext.code_executors.local.LocalCommandLineCodeExecutor`
|
||||||
|
* :class:`autogen_ext.code_executors.docker.DockerCommandLineCodeExecutor`
|
||||||
|
* :class:`autogen_ext.code_executors.azure.ACADynamicSessionsCodeExecutor`
|
||||||
|
|
||||||
|
Example usage:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pip install "autogen-agentchat==0.4.0.dev13" "autogen-ext[openai]==0.4.0.dev13" "yfinance" "matplotlib"
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
from autogen_agentchat.agents import AssistantAgent
|
||||||
|
from autogen_agentchat.ui import Console
|
||||||
|
from autogen_ext.models.openai import OpenAIChatCompletionClient
|
||||||
|
from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor
|
||||||
|
from autogen_ext.tools.code_execution import PythonCodeExecutionTool
|
||||||
|
|
||||||
|
|
||||||
|
async def main() -> None:
|
||||||
|
tool = PythonCodeExecutionTool(LocalCommandLineCodeExecutor(work_dir="coding"))
|
||||||
|
agent = AssistantAgent(
|
||||||
|
"assistant", OpenAIChatCompletionClient(model="gpt-4o"), tools=[tool], reflect_on_tool_use=True
|
||||||
|
)
|
||||||
|
await Console(
|
||||||
|
agent.run_stream(
|
||||||
|
task="Create a plot of MSFT stock prices in 2024 and save it to a file. Use yfinance and matplotlib."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
asyncio.run(main())
|
||||||
|
|
||||||
|
|
||||||
|
Args:
|
||||||
|
executor (CodeExecutor): The code executor that will be used to execute the code blocks.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self, executor: CodeExecutor):
|
def __init__(self, executor: CodeExecutor):
|
||||||
super().__init__(CodeExecutionInput, CodeExecutionResult, "CodeExecutor", "Execute Python code blocks.")
|
super().__init__(CodeExecutionInput, CodeExecutionResult, "CodeExecutor", "Execute Python code blocks.")
|
||||||
self._executor = executor
|
self._executor = executor
|
||||||
|
Loading…
x
Reference in New Issue
Block a user