com.huaweicloud.pangu.dev.sdk.api.tool

Interface Tool

All Known Implementing Classes:

DynamicTool, PanguUnifyTool, StaticTool, UnifyPythonInterpreter, UnifyWebSearch

public interface Tool

工具，包含对工具的描述和输入输出参数描述

Since:

2023.9.23

Method Summary

Modifier and Type	Method and Description
String	getInputDesc() 工具的输入描述
String	getInputSchema() 获取入参的Json Schema定义
String	getOutputDesc() 工具的输出描述
String	getOutputSchema() 获取出参的Json Schema定义，在prompt模板中调用
String	getPanguFunction() 获取pangu Function的定义，在prompt模板中调用
String	getToolDesc() 工具的描述
String	getToolId() 工具的唯一标识，在同一个Agent里必须唯一
String	getToolPrinciple() 工具使用原则，告诉模型在什么情况下使用工具
boolean	isEmptyInput() 是否入参为空
boolean	isSingleInput() 是否入参为单个字段
Object	runFromJson(String json) 运行工具

Method Detail

runFromJson

Object runFromJson(String json)

运行工具

Parameters:

json - 工具的输入json

Returns:

工具的输出

getToolId

String getToolId()

工具的唯一标识，在同一个Agent里必须唯一

Returns:

工具的标识

getToolDesc

String getToolDesc()

工具的描述

Returns:

工具的描述

getToolPrinciple

String getToolPrinciple()

工具使用原则，告诉模型在什么情况下使用工具

Returns:

工具的Principle

getInputDesc

String getInputDesc()

工具的输入描述

Returns:

输入的描述

getOutputDesc

String getOutputDesc()

工具的输出描述

Returns:

输出的描述

isSingleInput

boolean isSingleInput()

是否入参为单个字段

Returns:

true：单个字段

isEmptyInput

boolean isEmptyInput()

是否入参为空

Returns:

true：入参为空

getInputSchema

String getInputSchema()

获取入参的Json Schema定义

Returns:

入参的Json Schema定义

getOutputSchema

String getOutputSchema()

获取出参的Json Schema定义，在prompt模板中调用

Returns:

出参的Json Schema定义

getPanguFunction

String getPanguFunction()

获取pangu Function的定义，在prompt模板中调用

Returns:

pangu Function的定义