enum

OpenAI::FilePurpose

Inherits Enum < Comparable < Value < Object

The intended purpose of the uploaded file. One of: - assistants: Used in the Assistants API - batch: Used in the Batch API - fine-tune: Used for fine-tuning - vision: Images used for vision fine-tuning - user_data: Flexible file type for any purpose - evals: Used for eval data sets

Constants

Assistants = 0

Batch = 1

FineTune = 2

Vision = 3

UserData = 4

Evals = 5

Constructors

new(pull : JSON::PullParser) : self

Source

Instance methods

assistants?

Returns true if this enum value equals Assistants

Source

batch?

Returns true if this enum value equals Batch

Source

evals?

Returns true if this enum value equals Evals

Source

fine_tune?

Returns true if this enum value equals FineTune

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

user_data?

Returns true if this enum value equals UserData

Source

vision?

Returns true if this enum value equals Vision

Source