Package dev.langchain4j.kotlin.model.chat.request

Class ChatRequestBuilder

  • All Implemented Interfaces:
    
public class ChatRequestBuilder

    Builder class for constructing a dev.langchain4j.model.chat.request.ChatRequest instance. Allows configuring messages and request parameters to customize the resulting request.

    This builder provides methods to add individual or multiple chat messages, as well as set request parameters for the generated dev.langchain4j.model.chat.request.ChatRequest.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private List<ChatMessage> messages
      private ChatRequestParameters parameters

    • Constructor Summary

      Constructors 
      Constructor Description
      ChatRequestBuilder(List<ChatMessage> messages, ChatRequestParameters parameters)

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

      • ChatRequestBuilder

        ChatRequestBuilder(List<ChatMessage> messages, ChatRequestParameters parameters)

    • Method Detail

      • messages

         ChatRequestBuilder messages(List<ChatMessage> value)

        Adds a list of ChatMessage objects to the builder's messages collection.

        Parameters:
        value - The list of ChatMessage objects to be added to the builder.
        Returns:

        This builder instance for chaining other method calls.

      • parameters

        @JvmOverloads() <B extends DefaultChatRequestParameters.Builder<?>> Unit parameters(B builder, Function1<ChatRequestParametersBuilder<B>, Unit> configurer)

        Configures and sets the parameters for the chat request.

        Parameters:
        builder - The builder instance used to create the chat request parameters.
        configurer - A lambda with the builder as receiver to configure the chat request parameters.

      • parameters

        @JvmOverloads() <B extends DefaultChatRequestParameters.Builder<?>> Unit parameters(Function1<ChatRequestParametersBuilder<B>, Unit> configurer)

        Configures and sets the parameters for the chat request.

        Parameters:
        configurer - A lambda with the builder as receiver to configure the chat request parameters.

      • message

         ChatRequestBuilder message(ChatMessage value)

        Adds a chat message to the message list.

        Parameters:
        value - The chat message to be added.
        Returns:

        The current instance for method chaining.

      • build

         ChatRequest build()

        Builds and returns a ChatRequest instance using the current state of messages and parameters.

        Returns:

        A new instance of ChatRequest configured with the provided messages and parameters.