Tools 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. 配置华为云访问凭证：
   • 管理面（控制面）：使用AK/SK认证，通过HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK设置环境变量。获取AK/SK请参考如何获取华为云AK/SK。
   • 数据面：使用API_KEY认证，通过HUAWEICLOUD_SDK_CODE_INTERPRETER_API_KEY设置环境变量(可选，也可作为客户端参数传入)，SDK内部自动处理。获取API_KEY请参考如何获取沙箱工具的API_KEY。

     配置访问端点：通过AGENTARTS_CODEINTERPRETER_DATA_ENDPOINT设置环境变量 ，访问端点获取请参考终端节点，获取到终端节点后，在配置使用时，请配置为http://{域名}。

3. 创建代码解释器。

   from agentarts.sdk.tools import CodeInterpreter
   
   client = CodeInterpreter(region="your_region")
   code_interpreter = client.create_code_interpreter(
           name="your_code_interpreter_name",
           api_key_name="your_api_key_name"
       )

4. 配置工具，这里以代码执行工具为例。用户自定义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("your_region", "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"])

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

   from langchain_openai import ChatOpenAI
   
   # 创建Agent
   llm = ChatOpenAI(
       model="DeepSeek-V3",
       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，详细使用指导请参考工具使用方法指引。