CodeInterpreter SDK

场景介绍

支持CodeInterpreter生命周期管理和Session生命周期管理。

原理优势

用户空间已存在代码解释器时，SDK支持快速拉起代码解释器会话

api_key = "your_actual_api_key" # your api key
with code_session("your_region", "your_code_interpreter_name", api_key=api_key) as code_client:
    response = code_client.invoke(
        operate_type="your_operate_type",
        api_key=api_key,
        arguments={your_arguments}
    )

前提条件

• 已开通AgentArts。

• 登录控制台获取AK/SK，和API_KEY信息，详情请参考如何获取华为云AK/SK和如何获取代码解释器的API_KEY。

• 已安装Python，且版本不低于3.10。查看Python版本的命令示例：python --version。

操作步骤

1. 执行如下命令进行包安装。

   # 安装agentarts-sdk包
   pip install agentarts-sdk
   
   # 安装langgraph包
   pip install langgraph
   
   # 安装langchain_openai包
   pip install langchain-openai

2. 配置环境变量：

   配置环境变量。
   # === 用于通过代码创建沙箱 ===
   export HUAWEICLOUD_SDK_AK="您的华为云AK"
   export HUAWEICLOUD_SDK_SK="您的华为云SK"
   export AGENTARTS_CONTROL_ENDPOINT="https://agentarts.cn-southwest-2.myhuaweicloud.com"
   export AGENTARTS_CODEINTERPRETER_DATA_ENDPOINT="http://您的沙箱域名"
   export HUAWEICLOUD_SDK_CODE_INTERPRETER_API_KEY="您的沙箱 API Key"

   获取AK/SK请参考如何获取华为云AK/SK。

   沙箱工具的域名、API Key获取方法如下：

   1. 单击沙箱工具名称。
   2. 进入“配置信息”页面后，获取域名。
      图1 获取沙箱域名
      
   3. 单击“URN”链接，在弹出的窗口中获取沙箱的API Key。
      图2 URN链接
      
      图3 获取沙箱API Key
      

3. 创建代码解释器。

   from agentarts.sdk.tools import CodeInterpreter
   
    # auth_type为API_KEY时创建示例
   client = CodeInterpreter(region="your_region",auth_type="API_KEY")    
   code_interpreter = client.create_code_interpreter(
           name="your_code_interpreter_name",
           api_key_name="your_api_key_name"
       )
   
    # auth_type为IAM时创建示例
   demo_client = CodeInterpreter(region="your_region", auth_type="IAM")
   code_interpreter = client.create_code_interpreter(
           name="your_code_interpreter_name",
           auth_type="IAM"
       )

4. 配置工具，这里以代码执行工具为例。
   • API_KEY的配置工具示例如下，用户自定义region信息和需要使用的代码解释器，代码解释器名称和API_KEY一一对应。

     import json
     
     from agentarts.sdk.tools import code_session
     from langchain_core.tools import tool
     
     @tool
     def execute_python_tool(code: str, description: str = "") -> str | None:
         """Execute Python Code in the sandbox"""
         api_key = "your_actual_api_key" # your api key
         with code_session("cn-southwest-2", "your_code_interpreter_name", api_key=api_key) as code_client:
             response = code_client.invoke(
                 operate_type="execute_code",
                 api_key=api_key,
                 arguments={
                     "code": code,
                     "language": "python",
                     "clear_context": False
                 }
             )
     
         return json.dumps(response["result"])

   • IAM认证的配置工具示例：

     import json
     
     from agentarts.sdk.tools import code_session
     from langchain_core.tools import tool
     
     @tool
     def execute_python_tool(code: str, description: str = "") -> str | None:
         """Execute Python Code in the sandbox"""
         with code_session("cn-southwest-2", "your_code_interpreter_name", auth_type="IAM") as code_client:
             response = code_client.invoke(
                 operate_type="execute_code",
                 arguments={
                     "code": code,
                     "language": "python",
                     "clear_context": False
                 }
             )
     
         return json.dumps(response["result"])

   • TypeScript工具配置示例（以API_KEY认证为例）：

     import json
     
     from agentarts.sdk.tools import code_session
     from langchain_core.tools import tool
     
     @tool
     def execute_typescript_tool(code: str, description: str = "") -> str | None:
         """Execute TypeScript Code in the sandbox"""
         api_key = "your_actual_api_key" # your api key
         with code_session("cn-southwest-2", "your_code_interpreter_name", api_key=api_key) as code_client:
             response = code_client.invoke(
                 operate_type="execute_code",
                 api_key=api_key,
                 arguments={
                     "code": code,
                     "language": "typescript",
                     "clear_context": False
                 }
             )
     
         return json.dumps(response["result"])

5. 集成4中配置的工具，以如下执行代码为例。

   from langchain_openai import ChatOpenAI
   
   # 创建Agent
   llm = ChatOpenAI(
       model="deepseek-v4.1-flash",
       api_key=os.environ.get("MODEL_API_KEY", ""),
       base_url=os.environ.get("BASE_URL", ""),
       max_tokens=1000,
       temperature=0.7,
   )
   # 创建工具列表
   tools = [execute_python_tool]
   # 工具绑定Agent
   llm = llm.bind_tools(tools)

通过SDK可调用的管理面方法请参考表1，详细使用指导请参考工具使用方法指引。

通过SDK可调用的数据面方法请参考表2，详细使用指导请参考工具使用方法指引。

流式调用

对于长耗时任务，SDK提供invoke_stream方法，通过SSE（Server-Sent Events）逐条返回执行过程中的stdout/stderr输出和结果，避免长时间等待无反馈。流式调用通过Accept: text/event-stream触发，返回异步迭代器，客户端可逐条消费SSE事件。

• 方法名：invoke_stream
• 参数说明：

  参数名	类型	描述
  operate_type	str	操作类型，同invoke方法，支持execute_code、execute_command、read_files、write_files等。
  arguments	Dict	操作参数，同invoke方法。
  api_key	str	（API_KEY认证时必填）API Key。

• 返回值：异步迭代器（AsyncIterator），逐条产生result事件的data内容，结构与非流式InvokeResponse.result一致。

API_KEY认证流式调用示例：

import json
from agentarts.sdk.tools import code_session

api_key = "your_actual_api_key" # your api key
with code_session("cn-southwest-2", "your_code_interpreter_name", api_key=api_key) as code_client:
    async for event in code_client.invoke_stream(
        operate_type="execute_code",
        api_key=api_key,
        arguments={
            "code": 'print("Hello World!")',
            "language": "python",
            "clear_context": False
        }
    ):
        result = json.loads(event)
        if result["is_error"]:
            print(f"[ERROR] {result['content']}")
        else:
            for block in result["content"]:
                print(block.get("text", ""))

IAM认证流式调用示例：

import json
from agentarts.sdk.tools import code_session

with code_session("cn-southwest-2", "your_code_interpreter_name", auth_type="IAM") as code_client:
    async for event in code_client.invoke_stream(
        operate_type="execute_command",
        arguments={
            "command": "ls -la"
        }
    ):
        result = json.loads(event)
        for block in result["content"]:
            print(block.get("text", ""))