Package com.chatmotorapi.api.functional

Class MotorEntityResponse

java.lang.Object
com.chatmotorapi.api.functional.MotorEntityResponse
All Implemented Interfaces:
MotorResponseType
public class MotorEntityResponse
extends Object
implements MotorResponseType
Represents the response for a categorization request processed by the ChatMotor API. This class provides information about the request's success, any errors encountered, the categorization result, and usage details.

Implements MotorResponseType and includes methods to access the categorization result (MotorCategorization), request usage data (MotorCompletionUsage), and errors (OpenAiError).

Useful for checking if a request was successful, obtaining the categorization details, and understanding any errors or exceptions that occurred.

* In this version, for simplicity, responses are available in English only.
See Also:
MotorCategorization, MotorResponseType, OpenAiError

  • Constructor Details

    • MotorEntityResponse

      public MotorEntityResponse()

  • Method Details

    • isResponseOk

      public boolean isResponseOk()
      says whether the response was successful or not.
      Returns:
      true if the response was successful, false otherwise.

    • getThrowable

      public Throwable getThrowable()
      Gets the throwable associated with the response.
      Returns:
      the throwable, or a MotorNoExceptionThrown instance if there is no throwable.

    • getOpenAiError

      public OpenAiError getOpenAiError()
      Gets the OpenAI error associated with the response.
      Returns:
      the OpenAiError

    • getMotorCompletionUsage

      public MotorCompletionUsage getMotorCompletionUsage()
      Gets the completion usage associated with the response.
      Returns:
      the completionUsage

    • getMotorEntity

      public MotorEntity getMotorEntity()
      Gets the motor entity associated with the response.
      Returns:
      the motorEntity associated with the response.

    • toString

      public String toString()
      Provides a string representation of this object. The output includes the class name along with key attribute values.
      Overrides:
      toString in class Object
      Returns:
      a string description of this object.