智能体

Smolagents 是一个实验性 API，可能随时更改。由于 API 或底层模型容易发生变化，智能体返回的结果可能有所不同。

要了解更多关于智能体和工具的信息，请务必阅读入门指南。本页面包含底层类的 API 文档。

智能体

我们的智能体继承自 MultiStepAgent，这意味着它们可以分多步执行，每一步包括一个思考、一个工具调用和执行。更多信息请阅读本概念指南。

我们提供两种类型的智能体，基于主要的 `Agent` 类。

CodeAgent 用 Python 代码编写其工具调用（这是默认设置）。
ToolCallingAgent 用 JSON 编写其工具调用。

两者在初始化时都需要 `model` 参数和工具列表 `tools`。

智能体类别

类 smolagents.MultiStepAgent

< 来源 >

( tools: list model: Model prompt_templates: smolagents.agents.PromptTemplates | None = None instructions: str | None = None max_steps: int = 20 add_base_tools: bool = False verbosity_level: LogLevel = <LogLevel.INFO: 1> managed_agents: list | None = None step_callbacks: list[collections.abc.Callable] | dict[typing.Type[smolagents.memory.MemoryStep], collections.abc.Callable | list[collections.abc.Callable]] | None = None planning_interval: int | None = None name: str | None = None description: str | None = None provide_run_summary: bool = False final_answer_checks: list[collections.abc.Callable] | None = None return_full_result: bool = False logger: smolagents.monitoring.AgentLogger | None = None )

参数

tools (list[Tool]) — 智能体可使用的工具。
model (Callable[[list[dict[str, str]]], ChatMessage]) — 将生成智能体动作的模型。
prompt_templates (PromptTemplates, 可选) — 提示模板。
instructions (str, 可选) — 智能体的自定义指令，将插入到系统提示中。
max_steps (int, 默认值 20) — 智能体解决任务的最大步骤数。
add_base_tools (bool, 默认值 False) — 是否将基础工具添加到智能体的工具中。
verbosity_level (LogLevel, 默认值 LogLevel.INFO) — 智能体日志的详细程度。
managed_agents (list, 可选) — 智能体可以调用的托管智能体。
step_callbacks (list[Callable] | dict[Type[MemoryStep], Callable | list[Callable]], 可选) — 每一步将调用的回调。
planning_interval (int, 可选) — 智能体运行规划步骤的间隔。
name (str, 可选) — 仅对于托管智能体来说是必要的——该智能体可以被调用的名称。
description (str, 可选) — 仅对于托管智能体来说是必要的——该智能体的描述。
provide_run_summary (bool, 可选) — 当作为托管智能体调用时，是否提供运行摘要。
final_answer_checks (list[Callable], 可选) — 接受最终答案前要运行的验证函数列表。每个函数都应：
- 将最终答案和智能体的内存作为参数。
- 返回一个布尔值，指示最终答案是否有效。

智能体类，使用 ReAct 框架逐步解决给定任务：当目标未达成时，智能体将执行一个动作（由 LLM 提供）和观察（从环境中获取）的循环。

extract_action

< 来源 >

( model_output: str split_token: str )

参数

model_output (str) — LLM 的输出
split_token (str) — 动作的分隔符。应与系统提示中的示例匹配。

从 LLM 输出中解析动作

from_dict

< 来源 >

( agent_dict: dict **kwargs ) → MultiStepAgent

参数

agent_dict (dict[str, Any]) — 智能体的字典表示。
**kwargs — 将覆盖 `agent_dict` 值的额外关键字参数。

多步骤智能体

智能体类的实例。

从字典表示创建智能体。

from_folder

< 来源 >

( folder: str | pathlib.Path **kwargs )

参数

folder (str 或 Path) — 智能体保存的文件夹。
**kwargs — 将传递给智能体 init 的额外关键字参数。

从本地文件夹加载智能体。

from_hub

< 来源 >

( repo_id: str token: str | None = None trust_remote_code: bool = False **kwargs )

参数

repo_id (str) — 工具定义在 Hub 上的仓库名称。
token (str, 可选) — 用于在 hf.co 上识别您的令牌。如果未设置，将使用运行 `huggingface-cli login` 时生成的令牌（存储在 `~/.huggingface` 中）。
trust_remote_code(bool, 可选, 默认为 False) — 此标志表示您了解运行远程代码的风险并信任此工具。如果未将其设置为 True，则从 Hub 加载工具将失败。
kwargs (附加关键字参数，可选) — 将分为两部分的附加关键字参数：所有与 Hub 相关的参数（例如 `cache_dir`、`revision`、`subfolder`）将在下载智能体文件时使用，其余参数将传递给其初始化。

从 Hub 加载已定义的智能体。

从 Hub 加载工具意味着您将下载工具并在本地执行它。在运行时加载工具之前，请务必检查您正在下载的工具，就像您使用 pip/npm/apt 安装软件包时一样。

initialize_system_prompt

< 来源 >

( )

将在子类中实现

interrupt

< 来源 >

( )

中断智能体执行。

provide_final_answer

< 来源 >

( task: str images: list['PIL.Image.Image'] | None = None ) → str

参数

task (str) — 要执行的任务。
images (list[PIL.Image.Image], 可选) — 图像对象。

字符串

任务的最终答案。

根据智能体交互日志提供任务的最终答案。

push_to_hub

< 来源 >

( repo_id: str commit_message: str = 'Upload agent' private: bool | None = None token: bool | str | None = None create_pr: bool = False )

参数

repo_id (str) — 您要推送到的仓库名称。当推送到给定组织时，它应包含您的组织名称。
commit_message (str, 可选, 默认为 "Upload agent") — 推送时提交的消息。
private (bool, 可选, 默认为 None) — 是否将仓库设为私有。如果为 None，除非组织的默认设置为私有，否则仓库将是公开的。如果仓库已存在，则此值将被忽略。
token (bool 或 str, 可选) — 用作远程文件 HTTP 承载授权的令牌。如果未设置，将使用运行 `huggingface-cli login` 时生成的令牌（存储在 `~/.huggingface` 中）。
create_pr (bool, 可选, 默认为 False) — 是创建 PR 上传文件还是直接提交。

将智能体上传到 Hub。

replay

< 来源 >

( detailed: bool = False )

参数

detailed (布尔值, 可选) — 如果为 True，则还显示每一步的内存。默认为 False。注意：将指数级增加日志长度。仅用于调试。

打印智能体步骤的漂亮回放。

run

< 来源 >

( task: str stream: bool = False reset: bool = True images: list['PIL.Image.Image'] | None = None additional_args: dict | None = None max_steps: int | None = None )

参数

task (str) — 要执行的任务。
stream (bool) — 是否以流模式运行。如果为 `True`，则返回一个生成器，该生成器在执行每个步骤时生成该步骤。您必须遍历此生成器才能处理单个步骤（例如，使用 for 循环或 `next()`）。如果为 `False`，则在内部执行所有步骤，并在完成后仅返回最终答案。
reset (bool) — 是否重置对话或从上次运行继续。
images (list[PIL.Image.Image], 可选) — 图像对象。
additional_args (dict, 可选) — 您希望传递给智能体运行的任何其他变量，例如图像或数据框。给它们清晰的名称！
max_steps (int, 可选) — 智能体解决任务的最大步骤数。如果未提供，将使用智能体的默认值。

运行智能体执行给定任务。

示例

from smolagents import CodeAgent
agent = CodeAgent(tools=[])
agent.run("What is the result of 2 power 3.7384?")

save

< 来源 >

( output_dir: str | pathlib.Path relative_path: str | None = None )

参数

output_dir (str 或 Path) — 您希望保存代理的文件夹。

保存代理的相关代码文件。这会将代理的代码复制到 output_dir 中，并自动生成

一个 tools 文件夹，其中包含 tools/{tool_name}.py 下每个工具的逻辑。
一个 managed_agents 文件夹，其中包含每个受管代理的逻辑。
一个 agent.json 文件，其中包含表示代理的字典。
一个 prompt.yaml 文件，其中包含代理使用的提示模板。
一个 app.py 文件，当代理使用 agent.push_to_hub() 导出到 Space 时，提供代理的 UI。
一个 requirements.txt 文件，其中包含代理工具使用的模块名称（在检查其代码时检测到）

smolagents

智能体

智能体

智能体类别

类 smolagents.MultiStepAgent

extract_action

from_dict

from_folder

from_hub

initialize_system_prompt

interrupt

provide_final_answer

push_to_hub

replay

run

save

步骤

to_dict

可视化

将内存写入消息

类 smolagents.CodeAgent

清理

from_dict

类 smolagents.ToolCallingAgent

执行工具调用

处理工具调用

stream_to_gradio

smolagents.stream_to_gradio

GradioUI

类 smolagents.GradioUI

启动

上传文件

提示

类 smolagents.PromptTemplates

class smolagents.PlanningPromptTemplate

class smolagents.ManagedAgentPromptTemplate

class smolagents.FinalAnswerPromptTemplate

记忆

class smolagents.AgentMemory

get_full_steps

get_succinct_steps

replay

重置

return_full_code

Python 代码执行器

class smolagents.PythonExecutor

本地 Python 执行器

class smolagents.LocalPythonExecutor

远程 Python 执行器

class smolagents.remote_executors.RemotePythonExecutor

run_code_raise_errors

send_variables

E2BExecutor

class smolagents.E2BExecutor

清理

DockerExecutor

class smolagents.DockerExecutor

清理

删除

WasmExecutor

class smolagents.WasmExecutor

清理

删除

安装包

run_code_raise_errors