Package org.codelibs.fess.llm
Class LlmChatRequest
java.lang.Object
org.codelibs.fess.llm.LlmChatRequest
Request object for LLM chat completion.
- Author:
- FessProject
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAssistantMessage(String content) Adds an assistant message to the request.addMessage(LlmMessage message) Adds a message to the request.addSystemMessage(String content) Adds a system message to the request.addUserMessage(String content) Adds a user message to the request.getExtraParam(String key) Gets a single extra parameter value.Gets the extra parameters for provider-specific settings.Gets the maximum tokens for the response.Gets the messages in this request.getModel()Gets the model name.Gets the temperature parameter.Gets the thinking budget for models that support thinking tokens.booleanisStream()Checks if streaming is enabled.putExtraParam(String key, String value) Adds a single extra parameter for provider-specific settings.setExtraParams(Map<String, String> extraParams) Sets the extra parameters for provider-specific settings.setMaxTokens(Integer maxTokens) Sets the maximum tokens for the response.voidsetMessages(List<LlmMessage> messages) Sets the messages in this request.Sets the model name.setStream(boolean stream) Sets whether streaming is enabled.setTemperature(Double temperature) Sets the temperature parameter.setThinkingBudget(Integer thinkingBudget) Sets the thinking budget for models that support thinking tokens.
-
Constructor Details
-
LlmChatRequest
public LlmChatRequest()Default constructor.
-
-
Method Details
-
addMessage
Adds a message to the request.- Parameters:
message- the message to add- Returns:
- this request for method chaining
-
addSystemMessage
Adds a system message to the request.- Parameters:
content- the message content- Returns:
- this request for method chaining
-
addUserMessage
Adds a user message to the request.- Parameters:
content- the message content- Returns:
- this request for method chaining
-
addAssistantMessage
Adds an assistant message to the request.- Parameters:
content- the message content- Returns:
- this request for method chaining
-
getMessages
Gets the messages in this request.- Returns:
- the list of messages
-
setMessages
Sets the messages in this request.- Parameters:
messages- the list of messages
-
getModel
Gets the model name.- Returns:
- the model name
-
setModel
Sets the model name.- Parameters:
model- the model name- Returns:
- this request for method chaining
-
getMaxTokens
Gets the maximum tokens for the response.- Returns:
- the maximum tokens
-
setMaxTokens
Sets the maximum tokens for the response.- Parameters:
maxTokens- the maximum tokens- Returns:
- this request for method chaining
-
getTemperature
Gets the temperature parameter.- Returns:
- the temperature
-
setTemperature
Sets the temperature parameter.- Parameters:
temperature- the temperature- Returns:
- this request for method chaining
-
isStream
public boolean isStream()Checks if streaming is enabled.- Returns:
- true if streaming is enabled
-
setStream
Sets whether streaming is enabled.- Parameters:
stream- true to enable streaming- Returns:
- this request for method chaining
-
getThinkingBudget
Gets the thinking budget for models that support thinking tokens.nullmeans use the model default,0disables thinking.- Returns:
- the thinking budget
-
setThinkingBudget
Sets the thinking budget for models that support thinking tokens.nullmeans use the model default,0disables thinking.- Parameters:
thinkingBudget- the thinking budget- Returns:
- this request for method chaining
-
getExtraParams
Gets the extra parameters for provider-specific settings.- Returns:
- the extra parameters map, or
nullif not set
-
setExtraParams
Sets the extra parameters for provider-specific settings.- Parameters:
extraParams- the extra parameters map- Returns:
- this request for method chaining
-
putExtraParam
Adds a single extra parameter for provider-specific settings.- Parameters:
key- the parameter keyvalue- the parameter value- Returns:
- this request for method chaining
-
getExtraParam
Gets a single extra parameter value.- Parameters:
key- the parameter key- Returns:
- the parameter value, or
nullif not set
-