org.noear.solon.ai.chat

Class ChatOptions

java.lang.Object

org.noear.solon.ai.chat.ChatOptions

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

聊天选项

Since:

3.1

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
static String	FREQUENCY_PENALTY
static String	MAX_COMPLETION_TOKENS
static String	MAX_TOKENS
static String	PRESENCE_PENALTY
static String	TEMPERATURE
static String	TOOL_CHOICE
static String	TOP_K
static String	TOP_P

Constructor Summary

Constructors

Constructor and Description
ChatOptions()

Method Summary

Modifier and Type	Method and Description
ChatOptions	frequency_penalty(float frequency_penalty) 常用选项：频率惩罚
ChatOptions	max_completion_tokens(long max_completion_tokens) 常用选项：最大完成令牌数限制
ChatOptions	max_tokens(long max_tokens) 常用选项：最大提示语令牌数限制
static ChatOptions	of()
Object	option(String key) 选项获取
ChatOptions	optionAdd(String key, Object val) 选项添加
Map<String,Object>	options() 所有选项
ChatOptions	presence_penalty(float frequency_penalty) 常用选项：存在惩罚
ChatOptions	temperature(float temperature) 常用选项：temperature 采样
ChatOptions	tool_choice(String choiceOrName) 函数选择
FunctionTool	tool(String name) 工具获取
Collection<FunctionTool>	tools() 所有工具
ChatOptions	toolsAdd(FunctionTool tool) 工具添加
ChatOptions	toolsAdd(Iterable<FunctionTool> toolColl) 工具添加
ChatOptions	toolsAdd(Object toolObj) 工具添加
ChatOptions	toolsAdd(String name, Consumer<FunctionToolDesc> toolBuilder) 工具添加（构建形式）
ChatOptions	toolsAdd(ToolProvider toolProvider) 工具添加
ChatOptions	top_k(float top_k) 常用选项：top_k 采样
ChatOptions	top_p(float top_p) 常用选项：top_p 采样
ChatOptions	user(String user) 用户

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TOKENS

public static final String MAX_TOKENS

See Also:

Constant Field Values

MAX_COMPLETION_TOKENS

public static final String MAX_COMPLETION_TOKENS

See Also:

Constant Field Values

TEMPERATURE

public static final String TEMPERATURE

See Also:

Constant Field Values

TOP_P

public static final String TOP_P

See Also:

Constant Field Values

TOP_K

public static final String TOP_K

See Also:

Constant Field Values

FREQUENCY_PENALTY

public static final String FREQUENCY_PENALTY

See Also:

Constant Field Values

PRESENCE_PENALTY

public static final String PRESENCE_PENALTY

See Also:

Constant Field Values

TOOL_CHOICE

public static final String TOOL_CHOICE

See Also:

Constant Field Values

Constructor Detail

ChatOptions

public ChatOptions()

Method Detail

of

public static ChatOptions of()

tools

public Collection<FunctionTool> tools()

所有工具

tool

public FunctionTool tool(String name)

工具获取

Parameters:

name - 名字

toolsAdd

public ChatOptions toolsAdd(FunctionTool tool)

工具添加

toolsAdd

public ChatOptions toolsAdd(Iterable<FunctionTool> toolColl)

工具添加

toolsAdd

public ChatOptions toolsAdd(ToolProvider toolProvider)

工具添加

toolsAdd

public ChatOptions toolsAdd(Object toolObj)

工具添加

Parameters:

toolObj - 工具对象

toolsAdd

public ChatOptions toolsAdd(String name,
                            Consumer<FunctionToolDesc> toolBuilder)

工具添加（构建形式）

Parameters:

name - 名字

toolBuilder - 工具构建器

options

public Map<String,Object> options()

所有选项

option

public Object option(String key)

选项获取

optionAdd

public ChatOptions optionAdd(String key,
                             Object val)

选项添加

tool_choice

public ChatOptions tool_choice(String choiceOrName)

函数选择

Parameters:

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)

常用选项：存在惩罚

user

public ChatOptions user(String user)

用户