org.noear.solon.ai.chat.tool

类 FunctionToolDesc

java.lang.Object

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

所有已实现的接口:

FunctionTool, Tool

public class FunctionToolDesc
extends java.lang.Object
implements FunctionTool

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

从以下版本开始:

3.1

构造器概要

构造器

构造器和说明
FunctionToolDesc(java.lang.String name)
FunctionToolDesc(java.lang.String name, java.lang.String title, java.lang.String description, java.lang.Boolean returnDirect, java.lang.String inputSchema, java.lang.String outputSchema, ToolHandler handler)

方法概要

限定符和类型	方法和说明
FunctionToolDesc	boolParamAdd(java.lang.String name, java.lang.String description) 申明函数布尔参数
FunctionToolDesc	dateParamAdd(java.lang.String name, java.lang.String description) 申明函数时间参数
java.lang.String	description() 函数描述
FunctionToolDesc	description(java.lang.String description) 申明函数描述
FunctionToolDesc	doHandle(ToolHandler handler) 申明函数处理
FunctionToolDesc	floatParamAdd(java.lang.String name, java.lang.String description) 申明函数浮点数参数
java.lang.Object	handle(java.util.Map<java.lang.String,java.lang.Object> args) 执行处理
java.lang.String	inputSchema() 输入架构
FunctionToolDesc	inputSchema(java.lang.String inputSchema) 输入架构
FunctionToolDesc	intParamAdd(java.lang.String name, java.lang.String description) 申明函数整型参数
java.util.Map<java.lang.String,java.lang.Object>	meta() 元信息
void	metaPut(java.lang.String key, java.lang.Object value)
java.lang.String	name() 函数名字
java.lang.String	outputSchema() 输出架构 JsonSchema { String type; Map<String, Object> properties; List<String> required; Boolean additionalProperties; }
FunctionToolDesc	outputSchema(java.lang.String outputSchema) 输出架构
FunctionToolDesc	paramAdd(java.lang.String name, java.lang.reflect.Type type, boolean required, java.lang.String description) 申明函数参数
FunctionToolDesc	paramAdd(java.lang.String name, java.lang.reflect.Type type, java.lang.String description) 申明函数参数
boolean	returnDirect() 是否直接返回给调用者
FunctionToolDesc	returnDirect(boolean returnDirect) 申明直接返回给调用者
java.lang.reflect.Type	returnType()
FunctionToolDesc	returnType(java.lang.reflect.Type returnType) 申明返回类型
FunctionToolDesc	stringParamAdd(java.lang.String name, java.lang.String description) 申明函数字符串参数
java.lang.String	title() 函数标题
FunctionToolDesc	title(java.lang.String title) 申明函数标题
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.noear.solon.ai.chat.tool.FunctionTool

call, descriptionAndMeta, handleAsync, resultConverter, type

构造器详细资料

FunctionToolDesc

public FunctionToolDesc(java.lang.String name,
                        java.lang.String title,
                        java.lang.String description,
                        java.lang.Boolean returnDirect,
                        java.lang.String inputSchema,
                        java.lang.String outputSchema,
                        ToolHandler handler)

FunctionToolDesc

public FunctionToolDesc(java.lang.String name)

参数:

name - 函数名字

方法详细资料

title

public FunctionToolDesc title(java.lang.String title)

申明函数标题

参数:

title - 参数

description

public FunctionToolDesc description(java.lang.String description)

申明函数描述

参数:

description - 参数

returnType

public FunctionToolDesc returnType(java.lang.reflect.Type returnType)

申明返回类型

参数:

returnType - 直接类型

returnDirect

public FunctionToolDesc returnDirect(boolean returnDirect)

申明直接返回给调用者

参数:

returnDirect - 直接返回

inputSchema

public FunctionToolDesc inputSchema(java.lang.String inputSchema)

输入架构

从以下版本开始:

3.8.4

outputSchema

public FunctionToolDesc outputSchema(java.lang.String outputSchema)

输出架构

从以下版本开始:

3.8.4

paramAdd

public FunctionToolDesc paramAdd(java.lang.String name,
                                 java.lang.reflect.Type type,
                                 java.lang.String description)

申明函数参数

参数:

name - 参数名字

type - 参数类型

description - 参数描述

paramAdd

public FunctionToolDesc paramAdd(java.lang.String name,
                                 java.lang.reflect.Type type,
                                 boolean required,
                                 java.lang.String description)

申明函数参数

参数:

name - 参数名字

type - 参数类型

required - 是否必须

description - 参数描述

stringParamAdd

public FunctionToolDesc stringParamAdd(java.lang.String name,
                                       java.lang.String description)

申明函数字符串参数

参数:

name - 参数名字

description - 参数描述

intParamAdd

public FunctionToolDesc intParamAdd(java.lang.String name,
                                    java.lang.String description)

申明函数整型参数

参数:

name - 参数名字

description - 参数描述

floatParamAdd

public FunctionToolDesc floatParamAdd(java.lang.String name,
                                      java.lang.String description)

申明函数浮点数参数

参数:

name - 参数名字

description - 参数描述

boolParamAdd

public FunctionToolDesc boolParamAdd(java.lang.String name,
                                     java.lang.String description)

申明函数布尔参数

参数:

name - 参数名字

description - 参数描述

dateParamAdd

public FunctionToolDesc dateParamAdd(java.lang.String name,
                                     java.lang.String description)

申明函数时间参数

参数:

name - 参数名字

description - 参数描述

doHandle

public FunctionToolDesc doHandle(ToolHandler handler)

申明函数处理

参数:

handler - 处理器

name

public java.lang.String name()

函数名字

指定者:

name 在接口中 FunctionTool

title

public java.lang.String title()

函数标题

指定者:

title 在接口中 FunctionTool

description

public java.lang.String description()

函数描述

指定者:

description 在接口中 FunctionTool

meta

public java.util.Map<java.lang.String,java.lang.Object> meta()

从接口复制的说明: FunctionTool

元信息

指定者:

meta 在接口中 FunctionTool

metaPut

public void metaPut(java.lang.String key,
                    java.lang.Object value)

指定者:

metaPut 在接口中 FunctionTool

returnDirect

public boolean returnDirect()

是否直接返回给调用者

指定者:

returnDirect 在接口中 FunctionTool

inputSchema

public java.lang.String inputSchema()

输入架构

指定者:

inputSchema 在接口中 FunctionTool

outputSchema

public java.lang.String outputSchema()

从接口复制的说明: FunctionTool

输出架构

 JsonSchema {
     String type;
     Map<String, Object> properties;
     List<String> required;
     Boolean additionalProperties;
 }
 

指定者:

outputSchema 在接口中 FunctionTool

returnType

public java.lang.reflect.Type returnType()

指定者:

returnType 在接口中 FunctionTool

handle

public java.lang.Object handle(java.util.Map<java.lang.String,java.lang.Object> args)
                        throws java.lang.Throwable

执行处理

指定者:

handle 在接口中 FunctionTool

抛出:

java.lang.Throwable

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object