enum

OpenAI::OpenAIFilePurpose

Inherits Enum < Comparable < Value < Object

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.

Constants

Assistants = 0

AssistantsOutput = 1

Batch = 2

BatchOutput = 3

FineTune = 4

FineTuneResults = 5

Vision = 6

UserData = 7

Constructors

new(pull : JSON::PullParser) : self

Source

Instance methods

assistants?

Returns true if this enum value equals Assistants

Source

assistants_output?

Returns true if this enum value equals AssistantsOutput

Source

batch?

Returns true if this enum value equals Batch

Source

batch_output?

Returns true if this enum value equals BatchOutput

Source

fine_tune?

Returns true if this enum value equals FineTune

Source

fine_tune_results?

Returns true if this enum value equals FineTuneResults

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