Class LlmChatRequest

java.lang.Object
org.codelibs.fess.llm.LlmChatRequest

public class LlmChatRequest extends Object
Request object for LLM chat completion.
Author:
FessProject
  • Constructor Details

    • LlmChatRequest

      public LlmChatRequest()
      Default constructor.
  • Method Details

    • addMessage

      public LlmChatRequest addMessage(LlmMessage message)
      Adds a message to the request.
      Parameters:
      message - the message to add
      Returns:
      this request for method chaining
    • addSystemMessage

      public LlmChatRequest addSystemMessage(String content)
      Adds a system message to the request.
      Parameters:
      content - the message content
      Returns:
      this request for method chaining
    • addUserMessage

      public LlmChatRequest addUserMessage(String content)
      Adds a user message to the request.
      Parameters:
      content - the message content
      Returns:
      this request for method chaining
    • addAssistantMessage

      public LlmChatRequest addAssistantMessage(String content)
      Adds an assistant message to the request.
      Parameters:
      content - the message content
      Returns:
      this request for method chaining
    • getMessages

      public List<LlmMessage> getMessages()
      Gets the messages in this request.
      Returns:
      the list of messages
    • setMessages

      public void setMessages(List<LlmMessage> messages)
      Sets the messages in this request.
      Parameters:
      messages - the list of messages
    • getModel

      public String getModel()
      Gets the model name.
      Returns:
      the model name
    • setModel

      public LlmChatRequest setModel(String model)
      Sets the model name.
      Parameters:
      model - the model name
      Returns:
      this request for method chaining
    • getMaxTokens

      public Integer getMaxTokens()
      Gets the maximum tokens for the response.
      Returns:
      the maximum tokens
    • setMaxTokens

      public LlmChatRequest setMaxTokens(Integer maxTokens)
      Sets the maximum tokens for the response.
      Parameters:
      maxTokens - the maximum tokens
      Returns:
      this request for method chaining
    • getTemperature

      public Double getTemperature()
      Gets the temperature parameter.
      Returns:
      the temperature
    • setTemperature

      public LlmChatRequest setTemperature(Double temperature)
      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

      public LlmChatRequest setStream(boolean stream)
      Sets whether streaming is enabled.
      Parameters:
      stream - true to enable streaming
      Returns:
      this request for method chaining
    • getThinkingBudget

      public Integer getThinkingBudget()
      Gets the thinking budget for models that support thinking tokens. null means use the model default, 0 disables thinking.
      Returns:
      the thinking budget
    • setThinkingBudget

      public LlmChatRequest setThinkingBudget(Integer thinkingBudget)
      Sets the thinking budget for models that support thinking tokens. null means use the model default, 0 disables thinking.
      Parameters:
      thinkingBudget - the thinking budget
      Returns:
      this request for method chaining
    • getExtraParams

      public Map<String,String> getExtraParams()
      Gets the extra parameters for provider-specific settings.
      Returns:
      the extra parameters map, or null if not set
    • setExtraParams

      public LlmChatRequest setExtraParams(Map<String,String> extraParams)
      Sets the extra parameters for provider-specific settings.
      Parameters:
      extraParams - the extra parameters map
      Returns:
      this request for method chaining
    • putExtraParam

      public LlmChatRequest putExtraParam(String key, String value)
      Adds a single extra parameter for provider-specific settings.
      Parameters:
      key - the parameter key
      value - the parameter value
      Returns:
      this request for method chaining
    • getExtraParam

      public String getExtraParam(String key)
      Gets a single extra parameter value.
      Parameters:
      key - the parameter key
      Returns:
      the parameter value, or null if not set