enum

OpenAI::ResponseErrorCode

Inherits Enum < Comparable < Value < Object

The error code for the response.

Constants

ServerError = 0
RateLimitExceeded = 1
InvalidPrompt = 2
VectorStoreTimeout = 3
InvalidImage = 4
InvalidImageFormat = 5
InvalidBase64Image = 6
InvalidImageUrl = 7
ImageTooLarge = 8
ImageTooSmall = 9
ImageParseError = 10
ImageContentPolicyViolation = 11
InvalidImageMode = 12
ImageFileTooLarge = 13
UnsupportedImageMediaType = 14
EmptyImageFile = 15
FailedToDownloadImage = 16
ImageFileNotFound = 17

Constructors

new(pull : JSON::PullParser) : self
Source

Instance methods

empty_image_file?

Returns true if this enum value equals EmptyImageFile

Source
failed_to_download_image?

Returns true if this enum value equals FailedToDownloadImage

Source
image_content_policy_violation?

Returns true if this enum value equals ImageContentPolicyViolation

Source
image_file_not_found?

Returns true if this enum value equals ImageFileNotFound

Source
image_file_too_large?

Returns true if this enum value equals ImageFileTooLarge

Source
image_parse_error?

Returns true if this enum value equals ImageParseError

Source
image_too_large?

Returns true if this enum value equals ImageTooLarge

Source
image_too_small?

Returns true if this enum value equals ImageTooSmall

Source
invalid_base64_image?

Returns true if this enum value equals InvalidBase64Image

Source
invalid_image?

Returns true if this enum value equals InvalidImage

Source
invalid_image_format?

Returns true if this enum value equals InvalidImageFormat

Source
invalid_image_mode?

Returns true if this enum value equals InvalidImageMode

Source
invalid_image_url?

Returns true if this enum value equals InvalidImageUrl

Source
invalid_prompt?

Returns true if this enum value equals InvalidPrompt

Source
rate_limit_exceeded?

Returns true if this enum value equals RateLimitExceeded

Source
server_error?

Returns true if this enum value equals ServerError

Source
to_json(json : JSON::Builder) : Nil

Serializes this enum member by name.

For non-flags enums, the serialization is a JSON string. The value is the member name (see #to_s) transformed with String#underscore.

enum Stages
  INITIAL
  SECOND_STAGE
end

Stages::INITIAL.to_json      # => %("initial")
Stages::SECOND_STAGE.to_json # => %("second_stage")

For flags enums, the serialization is a JSON array including every flagged member individually serialized in the same way as a member of a non-flags enum. None is serialized as an empty array, All as an array containing all members.

@[Flags]
enum Sides
  LEFT
  RIGHT
end

Sides::LEFT.to_json                  # => %(["left"])
(Sides::LEFT | Sides::RIGHT).to_json # => %(["left","right"])
Sides::All.to_json                   # => %(["left","right"])
Sides::None.to_json                  # => %([])

ValueConverter.to_json offers a different serialization strategy based on the member value.

Source
unsupported_image_media_type?

Returns true if this enum value equals UnsupportedImageMediaType

Source
vector_store_timeout?

Returns true if this enum value equals VectorStoreTimeout

Source