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

Class StaticTool<INPUT,OUTPUT>

java.lang.Object

com.huaweicloud.pangu.dev.sdk.api.tool.StaticTool<INPUT,OUTPUT>

Type Parameters:

INPUT - 输入类型，使用LLMParamDesc注解修饰

OUTPUT - 输出类型，使用LLMParamDesc注解修饰

All Implemented Interfaces:

Tool

public abstract class StaticTool<INPUT,OUTPUT>
extends Object
implements Tool

静态工具，通过预先编码的工具实现，不支持动态的组装与修改

Since:

2023.7.17

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SINGLE_ARG

Constructor Summary

Constructors

Constructor and Description
StaticTool()

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() 是否入参为单个字段
protected abstract OUTPUT	run(INPUT input) 运行工具
Object	runFromJson(String json) 运行工具

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SINGLE_ARG

public static final String DEFAULT_SINGLE_ARG

See Also:

Constant Field Values

Constructor Detail

StaticTool

public StaticTool()

Method Detail

run

protected abstract OUTPUT run(INPUT input)

运行工具

Parameters:

input - 工具的输入

Returns:

工具的输出

runFromJson

public Object runFromJson(String json)

Description copied from interface: Tool

运行工具

Specified by:

runFromJson in interface Tool

Parameters:

json - 工具的输入json

Returns:

工具的输出

getToolId

public String getToolId()

Description copied from interface: Tool

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

Specified by:

getToolId in interface Tool

Returns:

工具的标识

getToolDesc

public String getToolDesc()

Description copied from interface: Tool

工具的描述

Specified by:

getToolDesc in interface Tool

Returns:

工具的描述

getToolPrinciple

public String getToolPrinciple()

Description copied from interface: Tool

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

Specified by:

getToolPrinciple in interface Tool

Returns:

工具的Principle

getInputDesc

public String getInputDesc()

Description copied from interface: Tool

工具的输入描述

Specified by:

getInputDesc in interface Tool

Returns:

输入的描述

getOutputDesc

public String getOutputDesc()

Description copied from interface: Tool

工具的输出描述

Specified by:

getOutputDesc in interface Tool

Returns:

输出的描述

isSingleInput

public boolean isSingleInput()

Description copied from interface: Tool

是否入参为单个字段

Specified by:

isSingleInput in interface Tool

Returns:

true：单个字段

isEmptyInput

public boolean isEmptyInput()

Description copied from interface: Tool

是否入参为空

Specified by:

isEmptyInput in interface Tool

Returns:

true：入参为空

getInputSchema

public String getInputSchema()

Description copied from interface: Tool

获取入参的Json Schema定义

Specified by:

getInputSchema in interface Tool

Returns:

入参的Json Schema定义

getOutputSchema

public String getOutputSchema()

Description copied from interface: Tool

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

Specified by:

getOutputSchema in interface Tool

Returns:

出参的Json Schema定义

getPanguFunction

public String getPanguFunction()

Description copied from interface: Tool

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

Specified by:

getPanguFunction in interface Tool

Returns:

pangu Function的定义