enum

OpenAI::CreateBatchRequestBodyEndpoint

Inherits Enum < Comparable < Value < Object

The endpoint to be used for all requests in the batch. Currently /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, and /v1/moderations are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

Constants

V1Responses = 0

V1ChatCompletions = 1

V1Embeddings = 2

V1Completions = 3

V1Moderations = 4

Constructors

new(pull : JSON::PullParser) : self

Source

Instance methods

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

v1_chat_completions?

Returns true if this enum value equals V1ChatCompletions

Source

v1_completions?

Returns true if this enum value equals V1Completions

Source

v1_embeddings?

Returns true if this enum value equals V1Embeddings

Source

v1_moderations?

Returns true if this enum value equals V1Moderations

Source

v1_responses?

Returns true if this enum value equals V1Responses

Source