Package dev.langchain4j.model.chat

Class DisabledChatLanguageModel

java.lang.Object
dev.langchain4j.model.chat.DisabledChatLanguageModel
All Implemented Interfaces:
ChatLanguageModel
public class DisabledChatLanguageModel extends Object implements ChatLanguageModel
A ChatLanguageModel which throws a ModelDisabledException for all of its methods

This could be used in tests, or in libraries that extend this one to conditionally enable or disable functionality.

  • Constructor Details

    • DisabledChatLanguageModel

      public DisabledChatLanguageModel()

  • Method Details

    • generate

      public String generate(String userMessage)
      Description copied from interface: ChatLanguageModel
      Generates a response from the model based on a message from a user. This is a convenience method that receives the message from a user as a String and returns only the generated response.
      Specified by:
      generate in interface ChatLanguageModel
      Parameters:
      userMessage - The message from the user.
      Returns:
      The response generated by the model.

    • generate

      public Response<AiMessage> generate(ChatMessage... messages)
      Description copied from interface: ChatLanguageModel
      Generates a response from the model based on a sequence of messages. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...
      Specified by:
      generate in interface ChatLanguageModel
      Parameters:
      messages - An array of messages.
      Returns:
      The response generated by the model.

    • generate

      public Response<AiMessage> generate(List<ChatMessage> messages)
      Description copied from interface: ChatLanguageModel
      Generates a response from the model based on a sequence of messages. Typically, the sequence contains messages in the following order: System (optional) - User - AI - User - AI - User ...
      Specified by:
      generate in interface ChatLanguageModel
      Parameters:
      messages - A list of messages.
      Returns:
      The response generated by the model.

    • generate

      public Response<AiMessage> generate(List<ChatMessage> messages, List<ToolSpecification> toolSpecifications)
      Description copied from interface: ChatLanguageModel
      Generates a response from the model based on a list of messages and a list of tool specifications. The response may either be a text message or a request to execute one of the specified tools. Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...
      Specified by:
      generate in interface ChatLanguageModel
      Parameters:
      messages - A list of messages.
      toolSpecifications - A list of tools that the model is allowed to execute. The model autonomously decides whether to use any of these tools.
      Returns:
      The response generated by the model. AiMessage can contain either a textual response or a request to execute one of the tools.

    • generate

      public Response<AiMessage> generate(List<ChatMessage> messages, ToolSpecification toolSpecification)
      Description copied from interface: ChatLanguageModel
      Generates a response from the model based on a list of messages and a single tool specification. The model is forced to execute the specified tool. This is usually achieved by setting `tool_choice=ANY` in the LLM provider API.
      Typically, the list contains messages in the following order: System (optional) - User - AI - User - AI - User ...
      Specified by:
      generate in interface ChatLanguageModel
      Parameters:
      messages - A list of messages.
      toolSpecification - The specification of a tool that must be executed. The model is forced to execute this tool.
      Returns:
      The response generated by the model. AiMessage contains a request to execute the specified tool.