org.noear.solon.ai.chat.tool

Class FunctionToolDesc

java.lang.Object

org.noear.solon.ai.chat.tool.FunctionToolDesc

All Implemented Interfaces:

FunctionTool, Tool

public class FunctionToolDesc
extends Object
implements FunctionTool

函数工具描述（相当于构建器）

Since:

3.1

Author:

noear

Constructor Summary

Constructors

Constructor and Description
FunctionToolDesc(String name)

Method Summary

Modifier and Type	Method and Description
FunctionToolDesc	boolParam(String name, String description) 申明函数布尔参数
FunctionToolDesc	dateParam(String name, String description) 申明函数时间参数
String	description() 函数描述
FunctionToolDesc	description(String description) 申明函数描述
FunctionToolDesc	doHandle(Function<Map<String,Object>,String> handler) 申明函数处理
FunctionToolDesc	floatParam(String name, String description) 申明函数浮点数参数
String	handle(Map<String,Object> args) 执行处理
org.noear.snack.ONode	inputSchema() 输入架构
FunctionToolDesc	intParam(String name, String description) 申明函数整型参数
String	name() 函数名字
FunctionToolDesc	param(String name, Class<?> type, boolean required, String description) 申明函数参数
FunctionToolDesc	param(String name, Class<?> type, String description) 申明函数参数
List<FunctionToolParam>	params() 函数参数
boolean	returnDirect() 是否直接返回给调用者
FunctionToolDesc	returnDirect(boolean returnDirect) 申明直接返回给调用者
FunctionToolDesc	stringParam(String name, String description) 申明函数字符串参数

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.noear.solon.ai.chat.tool.FunctionTool

type

Constructor Detail

FunctionToolDesc

public FunctionToolDesc(String name)

Parameters:

name - 函数名字

Method Detail

description

public FunctionToolDesc description(String description)

申明函数描述

Parameters:

description - 参数

returnDirect

public FunctionToolDesc returnDirect(boolean returnDirect)

申明直接返回给调用者

Parameters:

returnDirect - 直接返回

param

public FunctionToolDesc param(String name,
                              Class<?> type,
                              boolean required,
                              String description)

申明函数参数

Parameters:

name - 参数名字

type - 参数类型

required - 是否必须

description - 参数描述

param

public FunctionToolDesc param(String name,
                              Class<?> type,
                              String description)

申明函数参数

Parameters:

name - 参数名字

type - 参数类型

description - 参数描述

stringParam

public FunctionToolDesc stringParam(String name,
                                    String description)

申明函数字符串参数

Parameters:

name - 参数名字

description - 参数描述

intParam

public FunctionToolDesc intParam(String name,
                                 String description)

申明函数整型参数

Parameters:

name - 参数名字

description - 参数描述

floatParam

public FunctionToolDesc floatParam(String name,
                                   String description)

申明函数浮点数参数

Parameters:

name - 参数名字

description - 参数描述

boolParam

public FunctionToolDesc boolParam(String name,
                                  String description)

申明函数布尔参数

Parameters:

name - 参数名字

description - 参数描述

dateParam

public FunctionToolDesc dateParam(String name,
                                  String description)

申明函数时间参数

Parameters:

name - 参数名字

description - 参数描述

doHandle

public FunctionToolDesc doHandle(Function<Map<String,Object>,String> handler)

申明函数处理

Parameters:

handler - 处理器

name

public String name()

函数名字

Specified by:

name in interface FunctionTool

description

public String description()

函数描述

Specified by:

description in interface FunctionTool

returnDirect

public boolean returnDirect()

是否直接返回给调用者

Specified by:

returnDirect in interface FunctionTool

params

public List<FunctionToolParam> params()

函数参数

inputSchema

public org.noear.snack.ONode inputSchema()

输入架构

Specified by:

inputSchema in interface FunctionTool

handle

public String handle(Map<String,Object> args)
              throws Throwable

执行处理

Specified by:

handle in interface FunctionTool

Throws:

Throwable