enum

AI::OpenAI::Responses::IncludeValue

Inherits Enum < Comparable < Value < Object

Include values for extra response fields

Constants

ReasoningEncryptedContent = 0
FileSearchCallResults = 1
MessageOutputTextLogprobs = 2

Constructors

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

Instance methods

file_search_call_results?

Returns true if this enum value equals FileSearchCallResults

Source
message_output_text_logprobs?

Returns true if this enum value equals MessageOutputTextLogprobs

Source
reasoning_encrypted_content?

Returns true if this enum value equals ReasoningEncryptedContent

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
to_s

Returns a String representation of this enum member. In the case of regular enums, this is just the name of the member. In the case of flag enums, it's the names joined by vertical bars, or "None", if the value is zero.

If an enum's value doesn't match a member's value, the raw value is returned as a string.

Color::Red.to_s                     # => "Red"
IOMode::None.to_s                   # => "None"
(IOMode::Read | IOMode::Write).to_s # => "Read | Write"

Color.new(10).to_s # => "10"
Source