smolagents/pr_2321/zh/tutorials/secure_code_execution.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;安全代码执行&quot;,&quot;local&quot;:&quot;安全代码执行&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;代码智能体&quot;,&quot;local&quot;:&quot;代码智能体&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;本地 Python 解释器&quot;,&quot;local&quot;:&quot;本地-python-解释器&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;E2B 代码执行器&quot;,&quot;local&quot;:&quot;e2b-代码执行器&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}">
		<link href="/docs/smolagents/pr_2321/zh/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/entry/start.cd933138.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/scheduler.00b97157.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/singletons.90f7340d.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/index.78ea7f15.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/paths.9ab9ad33.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/entry/app.6e30bf5c.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/preload-helper.2f70801c.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/index.a7c1a7a1.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/nodes/0.5a52bc41.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/nodes/16.1cb15d8b.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.3f55db13.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/CodeBlock.04718353.js">
		<link rel="modulepreload" href="/docs/smolagents/pr_2321/zh/_app/immutable/chunks/DocNotebookDropdown.be7b60e3.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;安全代码执行&quot;,&quot;local&quot;:&quot;安全代码执行&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;代码智能体&quot;,&quot;local&quot;:&quot;代码智能体&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;本地 Python 解释器&quot;,&quot;local&quot;:&quot;本地-python-解释器&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;E2B 代码执行器&quot;,&quot;local&quot;:&quot;e2b-代码执行器&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div> <div class="flex space-x-1 " style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"> <div class="relative colab-dropdown "> <button class="  " type="button">  <img alt="Open In Colab" class="!m-0" src="https://colab.research.google.com/assets/colab-badge.svg"> </button>    </div> <div class="relative colab-dropdown "> <button class="  " type="button">  <img alt="Open In Studio Lab" class="!m-0" src="https://studiolab.sagemaker.aws/studiolab.svg"> </button>    </div></div>  <h1 class="relative group"><a id="安全代码执行" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#安全代码执行"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>安全代码执行</span></h1> <blockquote class="tip" data-svelte-h="svelte-13go4bm"><p>如果你是第一次构建 agent，请先阅读 <a href="../conceptual_guides/intro_agents">agent 介绍</a> 和 <a href="../guided_tour">smolagents 导览</a>。</p></blockquote>  <h3 class="relative group"><a id="代码智能体" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#代码智能体"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>代码智能体</span></h3> <p data-svelte-h="svelte-50jhgj"><a href="https://huggingface.co/papers/2402.01030" rel="nofollow">多项</a> <a href="https://huggingface.co/papers/2411.01747" rel="nofollow">研究</a> <a href="https://huggingface.co/papers/2401.00812" rel="nofollow">表明</a>，让大语言模型用代码编写其动作（工具调用）比当前标准的工具调用格式要好得多，目前行业标准是 “将动作写成包含工具名称和参数的 JSON” 的各种变体。</p> <p data-svelte-h="svelte-wsqcpy">为什么代码更好？因为我们专门为计算机执行的动作而设计编程语言。如果 JSON 片段是更好的方式，那么这个工具包就应该是用 JSON 片段编写的，魔鬼就会嘲笑我们。</p> <p data-svelte-h="svelte-1jskndn">代码就是表达计算机动作的更好方式。它具有更好的：</p> <ul data-svelte-h="svelte-1rh1aog"><li><strong>组合性</strong>：你能像定义 Python 函数那样，在 JSON 动作中嵌套其他 JSON 动作，或者定义一组 JSON 动作以便以后重用吗？</li> <li><strong>对象管理</strong>：你如何在 JSON 中存储像 <code>generate_image</code> 这样的动作的输出？</li> <li><strong>通用性</strong>：代码是为了简单地表达任何可以让计算机做的事情而构建的。</li> <li><strong>在 LLM 训练语料库中的表示</strong>：天赐良机，为什么不利用已经包含在 LLM 训练语料库中的大量高质量动作呢？</li></ul> <p data-svelte-h="svelte-7kkwmk">下图展示了这一点，取自 <a href="https://huggingface.co/papers/2402.01030" rel="nofollow">可执行代码动作引出更好的 LLM 智能体</a>。</p> <img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/code_vs_json_actions.png"> <p data-svelte-h="svelte-n69i">这就是为什么我们强调提出代码智能体，在本例中是 Python 智能体，这意味着我们要在构建安全的 Python 解释器上投入更多精力。</p>  <h3 class="relative group"><a id="本地-python-解释器" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#本地-python-解释器"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>本地 Python 解释器</span></h3> <p data-svelte-h="svelte-st9pa7">默认情况下，<code>CodeAgent</code> 会在你的环境中运行 LLM 生成的代码。
这个执行不是由普通的 Python 解释器完成的：我们从零开始重新构建了一个更安全的 <code>LocalPythonExecutor</code>。
这个解释器通过以下方式设计以确保安全：</p> <ul data-svelte-h="svelte-r5ls43"><li>将导入限制为用户显式传递的列表</li> <li>限制操作次数以防止无限循环和资源膨胀</li> <li>不会执行任何未预定义的操作</li></ul> <p data-svelte-h="svelte-14u3l5f">我们已经在许多用例中使用了这个解释器，从未观察到对环境造成任何损害。</p> <p data-svelte-h="svelte-hm1f2r">然而，这个解决方案并不是万无一失的：可以想象，如果 LLM 被微调用于恶意操作，仍然可能损害你的环境。例如，如果你允许像 <code>Pillow</code> 这样无害的包处理图像，LLM 可能会生成数千张图像保存以膨胀你的硬盘。
如果你自己选择了 LLM 引擎，这当然不太可能，但它可能会发生。</p> <p data-svelte-h="svelte-1iwo0wb">所以如果你想格外谨慎，可以使用下面描述的远程代码执行选项。</p>  <h3 class="relative group"><a id="e2b-代码执行器" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#e2b-代码执行器"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>E2B 代码执行器</span></h3> <p data-svelte-h="svelte-1mwu7as">为了最大程度的安全性，你可以使用我们与 E2B 的集成在沙盒环境中运行代码。这是一个远程执行服务，可以在隔离的容器中运行你的代码，使代码无法影响你的本地环境。</p> <p data-svelte-h="svelte-1ont1lb">为此，你需要设置你的 E2B 账户并在环境变量中设置 <code>E2B_API_KEY</code>。请前往 <a href="https://e2b.dev/docs/quickstart" rel="nofollow">E2B 快速入门文档</a> 了解更多信息。</p> <p data-svelte-h="svelte-z794n4">然后你可以通过 <code>pip install e2b-code-interpreter python-dotenv</code> 安装它。</p> <p data-svelte-h="svelte-lnqw0e">现在你已经准备好了！</p> <p data-svelte-h="svelte-vqe432">要将代码执行器设置为 E2B，只需在初始化 <code>CodeAgent</code> 时传递标志 <code>executor_type=&quot;e2b&quot;</code>。
请注意，你应该将所有工具的依赖项添加到 <code>additional_authorized_imports</code> 中，以便执行器安装它们。</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class="language-py "><!-- HTML_TAG_START --><span class="hljs-keyword">from</span> smolagents <span class="hljs-keyword">import</span> CodeAgent, VisitWebpageTool, InferenceClientModel
agent = CodeAgent(
    tools = [VisitWebpageTool()],
    model=InferenceClientModel(),
    additional_authorized_imports=[<span class="hljs-string">&quot;requests&quot;</span>, <span class="hljs-string">&quot;markdownify&quot;</span>],
    executor_type=<span class="hljs-string">&quot;e2b&quot;</span>
)

agent.run(<span class="hljs-string">&quot;What was Abraham Lincoln&#x27;s preferred pet?&quot;</span>)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-11hsivv">目前 E2B 代码执行暂不兼容多 agent——因为把 agent 调用放在应该在远程执行的代码块里，是非常混乱的。但我们正在努力做到这件事！</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/smolagents/blob/main/docs/source/zh/tutorials/secure_code_execution.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_3wial0 = {
						assets: "/docs/smolagents/pr_2321/zh",
						base: "/docs/smolagents/pr_2321/zh",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/smolagents/pr_2321/zh/_app/immutable/entry/start.cd933138.js"),
						import("/docs/smolagents/pr_2321/zh/_app/immutable/entry/app.6e30bf5c.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 16],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>