All Classes

Class Description
AtomicProgressListener
Implementation of ProgressListener that tracks progress using an AtomicInteger.
ChatMotor
The ChatMotor class encapsulates configuration for interacting with the OpenAI API.
ChatMotor.Builder
The Builder class for the ChatMotor class.
ChunkSize
A utility class for handling chunk sizes with different units (bytes, kilobytes, megabytes, gigabytes).
ConsoleProgressListener
Implementation of ProgressListener that tracks and displays progress in the console.
ConsoleResponseListener
A concrete implementation of MotorResponseListener that outputs response chunks to the console.
EmailNotificationChannel
The EmailNotificationChannel class handles sending emails as part of response post-treatment processes.
EmailNotificationChannel.Builder
Builder class for EmailNotificationChannel.
ExecutionMode
Enum to represent the execution mode for sending responses.
FailoverNotifier
The FailoverNotifier interface is used to notify users when a failover occurs in ChatMotor API key usage.
FileProgressListener
Implementation of ProgressListener that tracks and writes progress to a file.
FileToTextConverter
A utility class for converting various file formats to plain text files.
MotorAiOptions
Encapsulates configuration settings for AI interactions within the ChatMotor system.
MotorAiOptions.Builder
Builder class for creating a MotorAiOptions instance.
MotorAudioFileConverter
The MotorAudioFileConverter class is responsible for converting audio files from one format to another.
MotorAudioFileConverter.Builder
Builder class for creating a MotorAudioFileConverter instance.
MotorCategorization
The MotorCategorization class represents a data transfer object (DTO) for text categorization results.
MotorCategorizationRequest
Handles the creation and execution of categorization using the ChatMotor API.
MotorCategorizationRequest.Builder
Builder class for MotorCategorizationRequest.
MotorCategorizationResponse
Represents the response for a categorization request processed by the ChatMotor API.
MotorCompletionUsage
Provides information about how many tokens were used by your API request.
MotorContentPartImage
Represents an image content part within the ChatMotor messaging framework, specifically designed for use with OpenAI's vision API.
MotorContentPartText
Represents a text-based content part within the ChatMotor messaging framework, specifically tailored for integration with OpenAI's vision API.
MotorDefaultContentFilters
Provides a list of default content filters for use with content filtering functionalities.
MotorDefaultsModels
Utility class containing default model values for the ChatMotor API.
MotorEntity
Represents the recognized entities extracted from text, categorized into four distinct types: persons, organizations, locations, and dates.
MotorEntityRequest
Handles the creation and execution of categorizationusing the ChatMotor API.
MotorEntityRequest.Builder
Builder class for MotorCategorizationRequest.
MotorEntityResponse
Represents the response for a categorization request processed by the ChatMotor API.
MotorExecutionException
Represents exceptions that occur during the unchecked execution of operations.
MotorExtractContentRequest
Handles the creation and execution of a content extraction request using the ChatMotor API.
MotorExtractContentRequest.Builder
Builder class for MotorSummaryRequest.
MotorFileResponseListener
A concrete implementation of MotorResponseListener that outputs response chunks to a file.
MotorFilterContentRequest
Handles the creation and execution of a filer request using the ChatMotor API.
MotorFilterContentRequest.Builder
Builder class for MotorSummaryRequest.
MotorImageContainer
Represents a container for an image generated by a MotorImageRequest.
MotorImageRequest
Handles the creation and execution of image-related requests for the ChatMotor API, designed to interface with OpenAI's Vision API.
MotorImageRequest.Builder
Builder class for creating a MotorImageRequest instance.
MotorImageResponse
Represents the response from an image processing request made through the ChatMotor API, specifically tailored for interactions with OpenAI's Image API.
MotorImageSize
Enum representing various standard image sizes for the ChatMotor Image API.
MotorLanguageGuesserRequest
Handles the creation and execution of language guessing requests using the ChatMotor API.
MotorLanguageGuesserRequest.Builder
Builder class for MotorSummaryRequest.
MotorLargeRequestLines
Facilitates the creation and execution of large-sized requests for the ChatMotor API using a builder pattern for flexible and reliable configuration.
MotorLargeRequestLines.Builder
Builder class for creating a MotorLargeRequestLines instance.
MotorLargeRequestText
Facilitates the creation and execution of large-sized requests for the ChatMotor API using a builder pattern for flexible and reliable configuration.
MotorLargeRequestText.Builder
Builder class for creating a MotorLargeRequestText instance.
MotorLargeResponse
Represents the response from executing a request that typically involves large data transfers, adapted to handle responses as files rather than strings.
MotorLargeTranscriptionRequest
Handles the creation and execution of transcription requests using the ChatMotor API.
MotorLargeTranscriptionRequest.Builder
Builder class for MotorSummaryRequest.
MotorLargeTranslationRequest
Handles the creation and execution of translation requests using the ChatMotor API.
MotorLargeTranslationRequest.Builder
Builder class for MotorSummaryRequest.
MotorMessage
Represents a generic message structure for interactions within the ChatMotor system.
MotorModel
Represents a model of OpenAI, encapsulating details about model identifiers, creation time, and ownership.
MotorModelResponse
Encapsulates the response from a query to OpenAI, providing a mechanism to assess the success of the operation and retrieve the resulting models or handle errors.
MotorModelsRequest
Represents the models associated with the Chat Motor AI.
MotorModelsRequest.Builder
Builder class for creating MotorModelsRequest instances.
MotorNoExceptionThrown
MotorNoExceptionThrown is a custom exception class used to indicate that no actual exception was thrown.
MotorNotifyResponse
The MotorNotifyResponse class encapsulates the result of a notification action in the ChatMotor API.
MotorNotImplemendException
Represents exceptions that occur during the execution of an supported methods on some devices
MotorRequest
Handles the creation and execution of requests to the ChatMotor using system and user prompts.
MotorRequest.Builder
Builder class for creating a MotorRequest instance.
MotorResponse
Represents the response from executing a MotorRequest.
MotorResponseFile
Marker interface for response that return file content in the ChatMotor framework.
MotorResponseListener
Listener interface for handling streamed responses from the ChatMotor.
MotorResponseType
Marker interface for all response types in the ChatMotor framework.
MotorSentiment
This class models the sentiment analysis results.
MotorSentiment.ConfidenceScores
Inner class to encapsulate confidence scores for various sentiment categories.
MotorSentimentRequest
Handles the creation and execution of sentiment analysis using the ChatMotor API.
MotorSentimentRequest.Builder
Builder class for MotorSentimentRequest.
MotorSentimentResponse
Represents the response for a sentiment analysis request processed by the ChatMotor API.
MotorSpeechFormat
Enum representing the various response formats for speech processing when using OpenAI Speech.
MotorSpeechRequest
Handles the creation and execution of a text to speech requests to the ChatMotor using an user prompts.
MotorSpeechRequest.Builder
Builder class for creating a MotorSpeechRequest instance.
MotorSpeechVoice
Enum representing the various voices available for speech synthesis when using the ChatMotor API.
MotorStrategicSummaryRequest
Handles the creation and execution of a strategi summarization requests using the ChatMotor API.
MotorStrategicSummaryRequest.Builder
Builder class for MotorSummaryRequest.
MotorStreamStatus
Represents the status of a streamed request within the ChatMotor API, providing detailed information about the outcome of the operation.
MotorSummaryRequest
Handles the creation and execution of summarization requests using the ChatMotor API.
MotorSummaryRequest.Builder
Builder class for MotorSummaryRequest.
MotorSystemMessage
Represents a system-level message within the ChatMotor system, specifically used to hold system prompts.
MotorTimeoutException
MotorTimeoutException is a runtime exception that represents a timeout condition.
MotorTranscriptFormatterRequest
Allows to format a transcription file with using line breaks and paragraphs.
MotorTranscriptFormatterRequest.Builder
Builder class for MotorSummaryRequest.
MotorTranscriptionDuration
Provides utility method to retrieve the duration of audio files.
MotorUserMessage
Represents a user-generated message within the ChatMotor system, specifically designed to store user prompts.
MotorVisionRequest
Handles the creation and execution of Vision requests to the ChatMotor using system and user prompts.
MotorVisionRequest.Builder
Builder class for creating a MotorVisionRequest instance.
NotificationChannel
Interface for handling post-treatment actions related to responses in the ChatMotor framework.
OpenAiError
Represents an error encountered within the OpenAI operations.
OpenAiErrorType
Enum representing the various error messages returned by the ChatGPT API.
ProgressListener
Interface for tracking and retrieving the progress of chunked processing tasks.
QueueResponseListener
A concrete implementation of MotorResponseListener that stores response chunks in a user-provided queue.
ResponseImageFormat
Enum representing the format in which an image response can be provided for the ChatMotor Image API.
SentimentType
Enum representing the possible sentiment types for sentiment analysis, each associated with an integer value.
SlackNotificationChannel
The SlackNotificationChannel class handles posting messages and files to a specified Slack channel as part of response post-treatment processes.
SlackNotificationChannel.Builder
Builder class for SlackNotificationChannel.
SmsFailoverNotifier
SmsFailoverNotifier sends an SMS to a list of phone numbers using Twilio when a failover event occurs.
SmsFailoverNotifier.Builder
Builder class for SmsFailoverNotifier.
SwingResponseListener
A Swing implementation of MotorResponseListener that updates a JTextArea with the received response chunks.
TwilioNotificationChannel
The TwilioNotificationChannel class handles sending SMS messages via Twilio as part of response post-treatment processes.
TwilioNotificationChannel.Builder
Builder class for TwilioNotificationChannel.
Version
Displays the product Version info
VersionValues
Contains constant values representing the version and release date of the API.
VisionImageUtil
Utility class for handling image files and converting them to Base64 encoded strings.