从零开始创建一个CodeAct智能体
虽然LlamaIndex提供了一个预构建的CodeActAgent,我们也可以从头开始创建自己的智能体。
通过这种方式,我们能够全面理解并自定义智能体的行为,超越预置智能体所提供的功能。
在本笔记本中,我们将
- 创建一个用于生成和解析代码的工作流
- 实现基础代码执行
- 为智能体添加记忆和状态
如果我们希望智能体执行我们的代码,我们需要为其定义要执行的代码!
现在,让我们使用几个基础的数学函数。
# Define a few helper functionsdef add(a: int, b: int) -> int: """Add two numbers together""" return a + b
def subtract(a: int, b: int) -> int: """Subtract two numbers""" return a - b
def multiply(a: int, b: int) -> int: """Multiply two numbers""" return a * b
def divide(a: int, b: int) -> float: """Divide two numbers""" return a / b为了执行代码,我们需要创建一个代码执行器。
这里,我们将使用一个简单的进程内代码执行器,它维护自身的状态。
注意: 这是一个简单示例,未包含适当的沙箱隔离机制。在生产环境中,您应当使用类似docker的工具或专业的代码沙箱环境。
from typing import Any, Dict, Tupleimport ioimport contextlibimport astimport traceback
class SimpleCodeExecutor: """ A simple code executor that runs Python code with state persistence.
This executor maintains a global and local state between executions, allowing for variables to persist across multiple code runs.
NOTE: not safe for production use! Use with caution. """
def __init__(self, locals: Dict[str, Any], globals: Dict[str, Any]): """ Initialize the code executor.
Args: locals: Local variables to use in the execution context globals: Global variables to use in the execution context """ # State that persists between executions self.globals = globals self.locals = locals
def execute(self, code: str) -> Tuple[bool, str, Any]: """ Execute Python code and capture output and return values.
Args: code: Python code to execute
Returns: Dict with keys `success`, `output`, and `return_value` """ # Capture stdout and stderr stdout = io.StringIO() stderr = io.StringIO()
output = "" return_value = None try: # Execute with captured output with contextlib.redirect_stdout( stdout ), contextlib.redirect_stderr(stderr): # Try to detect if there's a return value (last expression) try: tree = ast.parse(code) last_node = tree.body[-1] if tree.body else None
# If the last statement is an expression, capture its value if isinstance(last_node, ast.Expr): # Split code to add a return value assignment last_line = code.rstrip().split("\n")[-1] exec_code = ( code[: -len(last_line)] + "\n__result__ = " + last_line )
# Execute modified code exec(exec_code, self.globals, self.locals) return_value = self.locals.get("__result__") else: # Normal execution exec(code, self.globals, self.locals) except: # If parsing fails, just execute the code as is exec(code, self.globals, self.locals)
# Get output output = stdout.getvalue() if stderr.getvalue(): output += "\n" + stderr.getvalue()
except Exception as e: # Capture exception information output = f"Error: {type(e).__name__}: {str(e)}\n" output += traceback.format_exc()
if return_value is not None: output += "\n\n" + str(return_value)
return outputcode_executor = SimpleCodeExecutor( # give access to our functions defined above locals={ "add": add, "subtract": subtract, "multiply": multiply, "divide": divide, }, globals={ # give access to all builtins "__builtins__": __builtins__, # give access to numpy "np": __import__("numpy"), },)定义 CodeAct 智能体
Section titled “Defining the CodeAct Agent”现在,我们可以使用LlamaIndex工作流来定义我们智能体的工作流程。
基本流程如下:
- 接收我们的提示词 + 聊天历史
- 解析出要执行的代码(如果有的话)
- 执行代码
- 将代码执行的结果返回给智能体
- 重复直到智能体对答案满意
首先,我们可以在工作流中创建事件。
from llama_index.core.llms import ChatMessagefrom llama_index.core.workflow import Event
class InputEvent(Event): input: list[ChatMessage]
class StreamEvent(Event): delta: str
class CodeExecutionEvent(Event): code: str接下来,我们可以定义编排使用这些事件的工作流。
import inspectimport refrom typing import Any, Callable, List
from llama_index.core.llms import ChatMessage, LLMfrom llama_index.core.memory import ChatMemoryBufferfrom llama_index.core.tools.types import BaseToolfrom llama_index.core.workflow import ( Context, Workflow, StartEvent, StopEvent, step,)from llama_index.llms.openai import OpenAI
CODEACT_SYSTEM_PROMPT = """You are a helpful assistant that can execute code.
Given the chat history, you can write code within <execute>...</execute> tags to help the user with their question.
In your code, you can reference any previously used variables or functions.
The user has also provided you with some predefined functions:{fn_str}
To execute code, write the code between <execute>...</execute> tags."""
class CodeActAgent(Workflow): def __init__( self, fns: List[Callable], code_execute_fn: Callable, llm: LLM | None = None, **workflow_kwargs: Any, ) -> None: super().__init__(**workflow_kwargs) self.fns = fns or [] self.code_execute_fn = code_execute_fn self.llm = llm or OpenAI(model="gpt-4o-mini")
# parse the functions into truncated function strings self.fn_str = "\n\n".join( f'def {fn.__name__}{str(inspect.signature(fn))}:\n """ {fn.__doc__} """\n ...' for fn in self.fns ) self.system_message = ChatMessage( role="system", content=CODEACT_SYSTEM_PROMPT.format(fn_str=self.fn_str), )
def _parse_code(self, response: str) -> str | None: # find the code between <execute>...</execute> tags matches = re.findall(r"<execute>(.*?)</execute>", response, re.DOTALL) if matches: return "\n\n".join(matches)
return None
@step async def prepare_chat_history( self, ctx: Context, ev: StartEvent ) -> InputEvent: # check if memory is setup memory = await ctx.store.get("memory", default=None) if not memory: memory = ChatMemoryBuffer.from_defaults(llm=self.llm)
# get user input user_input = ev.get("user_input") if user_input is None: raise ValueError("user_input kwarg is required") user_msg = ChatMessage(role="user", content=user_input) memory.put(user_msg)
# get chat history chat_history = memory.get()
# update context await ctx.store.set("memory", memory)
# add the system message to the chat history and return return InputEvent(input=[self.system_message, *chat_history])
@step async def handle_llm_input( self, ctx: Context, ev: InputEvent ) -> CodeExecutionEvent | StopEvent: chat_history = ev.input
# stream the response response_stream = await self.llm.astream_chat(chat_history) async for response in response_stream: ctx.write_event_to_stream(StreamEvent(delta=response.delta or ""))
# save the final response, which should have all content memory = await ctx.store.get("memory") memory.put(response.message) await ctx.store.set("memory", memory)
# get the code to execute code = self._parse_code(response.message.content)
if not code: return StopEvent(result=response) else: return CodeExecutionEvent(code=code)
@step async def handle_code_execution( self, ctx: Context, ev: CodeExecutionEvent ) -> InputEvent: # execute the code ctx.write_event_to_stream(ev) output = self.code_execute_fn(ev.code)
# update the memory memory = await ctx.store.get("memory") memory.put(ChatMessage(role="assistant", content=output)) await ctx.store.set("memory", memory)
# get the latest chat history and loop back to the start chat_history = memory.get() return InputEvent(input=[self.system_message, *chat_history])测试 CodeAct 智能体
Section titled “Testing the CodeAct Agent”现在,我们可以测试 CodeAct 智能体了!
我们将创建一个简单的智能体,并通过请求逐步增加其复杂性。
from llama_index.core.workflow import Context
agent = CodeActAgent( fns=[add, subtract, multiply, divide], code_execute_fn=code_executor.execute, llm=OpenAI(model="gpt-4o-mini", api_key="sk-..."),)
# context to hold the agent's state / memoryctx = Context(agent)async def run_agent_verbose(agent: CodeActAgent, ctx: Context, query: str): handler = agent.run(user_input=query, ctx=ctx) print(f"User: {query}") async for event in handler.stream_events(): if isinstance(event, StreamEvent): print(f"{event.delta}", end="", flush=True) elif isinstance(event, CodeExecutionEvent): print(f"\n-----------\nParsed code:\n{event.code}\n")
return await handlerresponse = await run_agent_verbose( agent, ctx, "Calculate the sum of all numbers from 1 to 10")User: Calculate the sum of all numbers from 1 to 10To calculate the sum of all numbers from 1 to 10, we can use the `add` function in a loop. Here's how we can do it:
<execute>total_sum = 0for number in range(1, 11): total_sum = add(total_sum, number)total_sum</execute>-----------Parsed code:
total_sum = 0for number in range(1, 11): total_sum = add(total_sum, number)total_sum
The sum of all numbers from 1 to 10 is 55.response = await run_agent_verbose( agent, ctx, "Add 5 and 3, then multiply the result by 2")User: Add 5 and 3, then multiply the result by 2To perform the calculation, we will first add 5 and 3 using the `add` function, and then multiply the result by 2 using the `multiply` function. Here's how we can do it:
<execute>result_addition = add(5, 3)final_result = multiply(result_addition, 2)final_result</execute>-----------Parsed code:
result_addition = add(5, 3)final_result = multiply(result_addition, 2)final_result
The final result of adding 5 and 3, then multiplying by 2, is 16.response = await run_agent_verbose( agent, ctx, "Calculate the sum of the first 10 fibonacci numbers0")User: Calculate the sum of the first 10 fibonacci numbers0To calculate the sum of the first 10 Fibonacci numbers, we first need to generate the Fibonacci sequence up to the 10th number and then sum those numbers. The Fibonacci sequence starts with 0 and 1, and each subsequent number is the sum of the two preceding ones.
Here's how we can do it:
<execute>def fibonacci(n: int) -> int: """ Return the nth Fibonacci number """ if n == 0: return 0 elif n == 1: return 1 else: a, b = 0, 1 for _ in range(2, n + 1): a, b = b, a + b return b
# Calculate the sum of the first 10 Fibonacci numbersfibonacci_sum = 0for i in range(10): fibonacci_sum = add(fibonacci_sum, fibonacci(i))
fibonacci_sum</execute>-----------Parsed code:
def fibonacci(n: int) -> int: """ Return the nth Fibonacci number """ if n == 0: return 0 elif n == 1: return 1 else: a, b = 0, 1 for _ in range(2, n + 1): a, b = b, a + b return b
# Calculate the sum of the first 10 Fibonacci numbersfibonacci_sum = 0for i in range(10): fibonacci_sum = add(fibonacci_sum, fibonacci(i))
fibonacci_sum
The sum of the first 10 Fibonacci numbers is 55.response = await run_agent_verbose( agent, ctx, "Calculate the sum of the first 20 fibonacci numbers")User: Calculate the sum of the first 20 fibonacci numbersTo calculate the sum of the first 20 Fibonacci numbers, we can use the same approach as before, but this time we will iterate up to 20. Here's how we can do it:
<execute># Calculate the sum of the first 20 Fibonacci numbersfibonacci_sum_20 = 0for i in range(20): fibonacci_sum_20 = add(fibonacci_sum_20, fibonacci(i))
fibonacci_sum_20</execute>-----------Parsed code:
# Calculate the sum of the first 20 Fibonacci numbersfibonacci_sum_20 = 0for i in range(20): fibonacci_sum_20 = add(fibonacci_sum_20, fibonacci(i))
fibonacci_sum_20
The sum of the first 20 Fibonacci numbers is 6765.