org.noear.solon.ai.chat

类 ChatOptions

java.lang.Object

org.noear.solon.ai.chat.ChatOptions

@Preview(value="3.1")
public class ChatOptions
extends java.lang.Object

聊天选项

从以下版本开始:

3.1

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	FREQUENCY_PENALTY
static java.lang.String	MAX_COMPLETION_TOKENS
static java.lang.String	MAX_TOKENS
static java.lang.String	PRESENCE_PENALTY
static java.lang.String	RESPONSE_FORMAT
static java.lang.String	TEMPERATURE
static java.lang.String	TOOL_CHOICE
static java.lang.String	TOP_K
static java.lang.String	TOP_P

构造器概要

构造器

构造器和说明
ChatOptions()

方法概要

限定符和类型	方法和说明
ChatOptions	frequency_penalty(float frequency_penalty) 常用选项：频率惩罚
ChatOptions	interceptorAdd(ChatInterceptor interceptor) 添加拦截器
ChatOptions	interceptorAdd(int index, ChatInterceptor interceptor) 添加拦截器
java.util.List<org.noear.solon.core.util.RankEntity<ChatInterceptor>>	interceptors() 获取所有拦截器
ChatOptions	max_completion_tokens(long max_completion_tokens) 常用选项：最大完成令牌数限制
ChatOptions	max_tokens(long max_tokens) 常用选项：最大提示语令牌数限制
static ChatOptions	of()
java.lang.Object	option(java.lang.String key) 选项获取
ChatOptions	optionAdd(java.lang.String key, java.lang.Object val) 选项添加
java.util.Map<java.lang.String,java.lang.Object>	options() 所有选项
ChatOptions	presence_penalty(float frequency_penalty) 常用选项：存在惩罚
ChatOptions	response_format(java.util.Map map) 常用选项：响应格式 o.response_format(Utils.asMap("type", "json_object")); o.response_format(Utils.asMap("type", "json_schema", "json_schema", Utils.asMap("type","object","properties",Utils.asMap()), "strict", true));
ChatOptions	temperature(float temperature) 常用选项：temperature 采样
ChatOptions	tool_choice(java.lang.String choiceOrName) 函数选择
FunctionTool	tool(java.lang.String name) 工具获取
java.util.Collection<FunctionTool>	tools() 所有工具
ChatOptions	toolsAdd(FunctionTool tool) 工具添加
ChatOptions	toolsAdd(java.lang.Iterable<FunctionTool> toolColl) 工具添加
ChatOptions	toolsAdd(java.lang.Object toolObj) 工具添加
ChatOptions	toolsAdd(java.lang.String name, java.util.function.Consumer<FunctionToolDesc> toolBuilder) 工具添加（构建形式）
ChatOptions	toolsAdd(ToolProvider toolProvider) 工具添加
ChatOptions	top_k(float top_k) 常用选项：top_k 采样
ChatOptions	top_p(float top_p) 常用选项：top_p 采样
java.lang.String	user() 获取用户
ChatOptions	user(java.lang.String user) 用户

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

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

字段详细资料

MAX_TOKENS

public static final java.lang.String MAX_TOKENS

另请参阅:

常量字段值

MAX_COMPLETION_TOKENS

public static final java.lang.String MAX_COMPLETION_TOKENS

另请参阅:

常量字段值

TEMPERATURE

public static final java.lang.String TEMPERATURE

另请参阅:

常量字段值

TOP_P

public static final java.lang.String TOP_P

另请参阅:

常量字段值

TOP_K

public static final java.lang.String TOP_K

另请参阅:

常量字段值

FREQUENCY_PENALTY

public static final java.lang.String FREQUENCY_PENALTY

另请参阅:

常量字段值

PRESENCE_PENALTY

public static final java.lang.String PRESENCE_PENALTY

另请参阅:

常量字段值

TOOL_CHOICE

public static final java.lang.String TOOL_CHOICE

另请参阅:

常量字段值

RESPONSE_FORMAT

public static final java.lang.String RESPONSE_FORMAT

另请参阅:

常量字段值

构造器详细资料

ChatOptions

public ChatOptions()

方法详细资料

of

public static ChatOptions of()

tools

public java.util.Collection<FunctionTool> tools()

所有工具

tool

public FunctionTool tool(java.lang.String name)

工具获取

参数:

name - 名字

toolsAdd

public ChatOptions toolsAdd(FunctionTool tool)

工具添加

toolsAdd

public ChatOptions toolsAdd(java.lang.Iterable<FunctionTool> toolColl)

工具添加

toolsAdd

public ChatOptions toolsAdd(ToolProvider toolProvider)

工具添加

toolsAdd

public ChatOptions toolsAdd(java.lang.Object toolObj)

工具添加

参数:

toolObj - 工具对象

toolsAdd

public ChatOptions toolsAdd(java.lang.String name,
                            java.util.function.Consumer<FunctionToolDesc> toolBuilder)

工具添加（构建形式）

参数:

name - 名字

toolBuilder - 工具构建器

interceptorAdd

public ChatOptions interceptorAdd(ChatInterceptor interceptor)

添加拦截器

参数:

interceptor - 拦截器

interceptorAdd

public ChatOptions interceptorAdd(int index,
                                  ChatInterceptor interceptor)

添加拦截器

参数:

index - 顺序位

interceptor - 拦截器

interceptors

public java.util.List<org.noear.solon.core.util.RankEntity<ChatInterceptor>> interceptors()

获取所有拦截器

options

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

所有选项

option

public java.lang.Object option(java.lang.String key)

选项获取

optionAdd

public ChatOptions optionAdd(java.lang.String key,
                             java.lang.Object val)

选项添加

tool_choice

public ChatOptions tool_choice(java.lang.String choiceOrName)

函数选择

参数:

choiceOrName - 选项或特定函数名

max_tokens

public ChatOptions max_tokens(long max_tokens)

常用选项：最大提示语令牌数限制

max_completion_tokens

public ChatOptions max_completion_tokens(long max_completion_tokens)

常用选项：最大完成令牌数限制

temperature

public ChatOptions temperature(float temperature)

常用选项：temperature 采样

top_p

public ChatOptions top_p(float top_p)

常用选项：top_p 采样

top_k

public ChatOptions top_k(float top_k)

常用选项：top_k 采样

frequency_penalty

public ChatOptions frequency_penalty(float frequency_penalty)

常用选项：频率惩罚

presence_penalty

public ChatOptions presence_penalty(float frequency_penalty)

常用选项：存在惩罚

response_format

public ChatOptions response_format(java.util.Map map)

常用选项：响应格式

 o.response_format(Utils.asMap("type", "json_object"));

 o.response_format(Utils.asMap("type", "json_schema",
                               "json_schema", Utils.asMap("type","object","properties",Utils.asMap()),
                               "strict", true));
 

user

public ChatOptions user(java.lang.String user)

用户

user

@Nullable
public java.lang.String user()

获取用户