Package com.chatmotorapi.api.functional

Class MotorSummaryRequest.Builder

java.lang.Object
com.chatmotorapi.api.functional.MotorSummaryRequest.Builder
Enclosing class:
MotorSummaryRequest
public static class MotorSummaryRequest.Builder
extends Object
Builder class for MotorSummaryRequest.

  • Constructor Details

    • Builder

      public Builder()
      Sets default values for the Request.

  • Method Details

    • chatMotor

      public MotorSummaryRequest.Builder chatMotor​(ChatMotor chatMotor)
      Sets the ChatMotor instance for this request.
      Parameters:
      chatMotor - the ChatMotor instance
      Returns:
      this builder instance for chaining

    • motorAiOptions

      public MotorSummaryRequest.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 MotorSummaryRequest.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

    • filePath

      public MotorSummaryRequest.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

    • languageCode

      public MotorSummaryRequest.Builder languageCode​(String languageCode)
      Sets the language code for the summarization.
      Parameters:
      languageCode - the language code
      Returns:
      this Builder instance for chaining

    • build

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