Package com.chatmotorapi.api

Class MotorLargeRequestText.Builder

java.lang.Object
com.chatmotorapi.api.MotorLargeRequestText.Builder
Enclosing class:
MotorLargeRequestText
public static class MotorLargeRequestText.Builder
extends Object
Builder class for creating a MotorLargeRequestText instance.

  • Constructor Details

    • Builder

      public Builder()
      Sets default values for the Request.

  • Method Details

    • chatMotor

      public MotorLargeRequestText.Builder chatMotor​(ChatMotor chatMotor)
      Sets the ChatMotor instance to be used for the request.
      Parameters:
      chatMotor - the ChatMotor instance
      Returns:
      this Builder instance for chaining

    • motorAiOptions

      public MotorLargeRequestText.Builder motorAiOptions​(MotorAiOptions aiOptions)
      Sets the MotorAiOptions instance to be used for the request.
      Parameters:
      aiOptions - the MotorAiOptions instance
      Returns:
      this Builder instance for chaining

    • aiModel

      public MotorLargeRequestText.Builder aiModel​(String aiModel)
      Sets the OpenAI model to use for the request
      Parameters:
      aiModel - the model identifier, e.g., "gpt-4-turbo-preview"
      Returns:
      this Builder instance for chaining

    • systemMessage

      public MotorLargeRequestText.Builder systemMessage​(MotorSystemMessage systemMessage)
      Sets the system prompt to be used for the request.
      Parameters:
      systemMessage - system prompt to be used for the request.
      Returns:
      this

    • filePath

      public MotorLargeRequestText.Builder filePath​(String filePath)
      Sets the file path for the text file to be processed. Note: This method only accepts text files (txt, text, csv, and their uppercase equivalents). For other file formats, use the FileToTextConverter utility to convert them to text files.
      Parameters:
      filePath - the path to the text file
      Returns:
      the builder instance for chaining

    • inputChunkSize

      public MotorLargeRequestText.Builder inputChunkSize​(ChunkSize inputChunkSize)
      Sets the input chunk size.

      Note: This method is generally not recommended for use. The default chunk size defined in ChatMotor.maxChunkInputSize() is used.

      Parameters:
      inputChunkSize - the input chunk size
      Returns:
      this builder instance for chaining

    • progressListener

      public MotorLargeRequestText.Builder progressListener​(ProgressListener progressListener)
      Sets the progress listener to track progress.
      Parameters:
      progressListener - the progress listener
      Returns:
      this builder instance for chaining

    • build

      public MotorLargeRequestText build()
      Builds and returns a MotorLargeRequestText instance based on the set parameters.
      Returns:
      a new MotorLargeRequestText
      Throws:
      IllegalArgumentException - if the chatMotor is not provided.
      IllegalArgumentException - if the filePath is not provided.
      IllegalArgumentException - if the file specified by filePath does notexist.
      IllegalArgumentException - if the file is not in text format.