openai-core/com.aallam.openai.api.exception

Package-level declarations

Types

class AuthenticationException(val statusCode: Int, val error: OpenAIError, throwable: Throwable? = null) : OpenAIAPIException

Represents an exception thrown when an authentication error occurs while interacting with the OpenAI API.

GenericIOException

class GenericIOException(throwable: Throwable? = null) : OpenAIIOException

An exception thrown in case of an I/O error

InvalidRequestException

class InvalidRequestException(val statusCode: Int, val error: OpenAIError, throwable: Throwable? = null) : OpenAIAPIException

Represents an exception thrown when an invalid request is made to the OpenAI API.

OpenAIAPIException

sealed class OpenAIAPIException : OpenAIException

Represents an exception thrown when an error occurs while interacting with the OpenAI API.

OpenAIError

@Serializable

data class OpenAIError(val detail: OpenAIErrorDetails? = null)

Represents an error response from the OpenAI API.

OpenAIErrorDetails

@Serializable

data class OpenAIErrorDetails(val code: String? = null, val message: String? = null, val param: String? = null, val type: String? = null, val line: Int? = null)

Represents an error object returned by the OpenAI API.

OpenAIException

sealed class OpenAIException : RuntimeException

OpenAI client exception

OpenAIHttpException

class OpenAIHttpException(throwable: Throwable? = null) : OpenAIException

Runtime Http Client exception

OpenAIIOException

sealed class OpenAIIOException : OpenAIException

An exception thrown in case of an I/O error

OpenAIServerException

class OpenAIServerException(throwable: Throwable? = null) : OpenAIException

An exception thrown in case of a server error

OpenAITimeoutException

class OpenAITimeoutException(throwable: Throwable) : OpenAIIOException

An exception thrown in case a request times out.

PermissionException

class PermissionException(val statusCode: Int, val error: OpenAIError, throwable: Throwable? = null) : OpenAIAPIException

Represents an exception thrown when a permission error occurs while interacting with the OpenAI API.

RateLimitException

class RateLimitException(val statusCode: Int, val error: OpenAIError, throwable: Throwable? = null) : OpenAIAPIException

Represents an exception thrown when the OpenAI API rate limit is exceeded.

UnknownAPIException

class UnknownAPIException(val statusCode: Int, val error: OpenAIError, throwable: Throwable? = null) : OpenAIAPIException

Represents an exception thrown when an unknown error occurs while interacting with the OpenAI API. This exception is used when the specific type of error is not covered by the existing subclasses.