Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/openai/models/audio/speech_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class SpeechCreateParams < OpenAI::BaseModel
# `verse`. Previews of the voices are available in the
# [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
#
# @return [String, Symbol]
# @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
required :voice, union: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice }

# @!attribute [r] instructions
Expand Down Expand Up @@ -67,7 +67,7 @@ class SpeechCreateParams < OpenAI::BaseModel
# @!parse
# # @param input [String]
# # @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel]
# # @param voice [String, Symbol]
# # @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
# # @param instructions [String]
# # @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat]
# # @param speed [Float]
Expand Down
6 changes: 3 additions & 3 deletions lib/openai/models/beta/assistant_update_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ class AssistantUpdateParams < OpenAI::BaseModel
# [Model overview](https://platform.openai.com/docs/models) for descriptions of
# them.
#
# @return [String, Symbol, nil]
# @return [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model, nil]
optional :model, union: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model }

# @!parse
# # @return [String, Symbol]
# # @return [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model]
# attr_writer :model

# @!attribute name
Expand Down Expand Up @@ -132,7 +132,7 @@ class AssistantUpdateParams < OpenAI::BaseModel
# # @param description [String, nil]
# # @param instructions [String, nil]
# # @param metadata [Hash{Symbol=>String}, nil]
# # @param model [String, Symbol]
# # @param model [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model]
# # @param name [String, nil]
# # @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
# # @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/models/chat/chat_completion_audio_param.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ChatCompletionAudioParam < OpenAI::BaseModel
# The voice the model uses to respond. Supported voices are `alloy`, `ash`,
# `ballad`, `coral`, `echo`, `sage`, and `shimmer`.
#
# @return [String, Symbol]
# @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
required :voice, union: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice }

# @!parse
Expand All @@ -24,7 +24,7 @@ class ChatCompletionAudioParam < OpenAI::BaseModel
# # [Learn more](https://platform.openai.com/docs/guides/audio).
# #
# # @param format_ [Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Format]
# # @param voice [String, Symbol]
# # @param voice [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
# #
# def initialize(format_:, voice:, **) = super

Expand Down
4 changes: 2 additions & 2 deletions lib/openai/models/completion_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class CompletionCreateParams < OpenAI::BaseModel
# [Model overview](https://platform.openai.com/docs/models) for descriptions of
# them.
#
# @return [String, Symbol]
# @return [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
required :model, union: -> { OpenAI::Models::CompletionCreateParams::Model }

# @!attribute prompt
Expand Down Expand Up @@ -186,7 +186,7 @@ class CompletionCreateParams < OpenAI::BaseModel
# attr_writer :user

# @!parse
# # @param model [String, Symbol]
# # @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
# # @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
# # @param best_of [Integer, nil]
# # @param echo [Boolean, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/models/fine_tuning/job_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class JobCreateParams < OpenAI::BaseModel
# The name of the model to fine-tune. You can select one of the
# [supported models](https://platform.openai.com/docs/guides/fine-tuning#which-models-can-be-fine-tuned).
#
# @return [String, Symbol]
# @return [String, Symbol, OpenAI::Models::FineTuning::JobCreateParams::Model]
required :model, union: -> { OpenAI::Models::FineTuning::JobCreateParams::Model }

# @!attribute training_file
Expand Down Expand Up @@ -114,7 +114,7 @@ class JobCreateParams < OpenAI::BaseModel
optional :validation_file, String, nil?: true

# @!parse
# # @param model [String, Symbol]
# # @param model [String, Symbol, OpenAI::Models::FineTuning::JobCreateParams::Model]
# # @param training_file [String]
# # @param hyperparameters [OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters]
# # @param integrations [Array<OpenAI::Models::FineTuning::JobCreateParams::Integration>, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/models/responses/response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class Response < OpenAI::BaseModel
# [model guide](https://platform.openai.com/docs/models) to browse and compare
# available models.
#
# @return [String, Symbol, OpenAI::Models::ChatModel]
# @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
required :model, union: -> { OpenAI::Models::ResponsesModel }

# @!attribute object
Expand Down Expand Up @@ -225,7 +225,7 @@ class Response < OpenAI::BaseModel
# # @param incomplete_details [OpenAI::Models::Responses::Response::IncompleteDetails, nil]
# # @param instructions [String, nil]
# # @param metadata [Hash{Symbol=>String}, nil]
# # @param model [String, Symbol, OpenAI::Models::ChatModel]
# # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
# # @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem>]
# # @param parallel_tool_calls [Boolean]
# # @param temperature [Float, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/models/responses/response_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class ResponseCreateParams < OpenAI::BaseModel
# [model guide](https://platform.openai.com/docs/models) to browse and compare
# available models.
#
# @return [String, Symbol, OpenAI::Models::ChatModel]
# @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
required :model, union: -> { OpenAI::Models::ResponsesModel }

# @!attribute include
Expand Down Expand Up @@ -201,7 +201,7 @@ class ResponseCreateParams < OpenAI::BaseModel

# @!parse
# # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
# # @param model [String, Symbol, OpenAI::Models::ChatModel]
# # @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
# # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
# # @param instructions [String, nil]
# # @param max_output_tokens [Integer, nil]
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/resources/audio/speech.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class Speech
#
# @param input [String]
# @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel]
# @param voice [String, Symbol]
# @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
# @param instructions [String]
# @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat]
# @param speed [Float]
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/resources/beta/assistants.rb
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def retrieve(assistant_id, params = {})
# @param description [String, nil]
# @param instructions [String, nil]
# @param metadata [Hash{Symbol=>String}, nil]
# @param model [String, Symbol]
# @param model [String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model]
# @param name [String, nil]
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
# @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/resources/completions.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class Completions
#
# @overload create(model:, prompt:, best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {})
#
# @param model [String, Symbol]
# @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
# @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
# @param best_of [Integer, nil]
# @param echo [Boolean, nil]
Expand Down Expand Up @@ -48,7 +48,7 @@ def create(params)
#
# @overload create_streaming(model:, prompt:, best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {})
#
# @param model [String, Symbol]
# @param model [String, Symbol, OpenAI::Models::CompletionCreateParams::Model]
# @param prompt [String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil]
# @param best_of [Integer, nil]
# @param echo [Boolean, nil]
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/resources/fine_tuning/jobs.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Jobs
#
# @overload create(model:, training_file:, hyperparameters: nil, integrations: nil, metadata: nil, method_: nil, seed: nil, suffix: nil, validation_file: nil, request_options: {})
#
# @param model [String, Symbol]
# @param model [String, Symbol, OpenAI::Models::FineTuning::JobCreateParams::Model]
# @param training_file [String]
# @param hyperparameters [OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters]
# @param integrations [Array<OpenAI::Models::FineTuning::JobCreateParams::Integration>, nil]
Expand Down
4 changes: 2 additions & 2 deletions lib/openai/resources/responses.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Responses
# @overload create(input:, model:, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, reasoning: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
#
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
# @param model [String, Symbol, OpenAI::Models::ChatModel]
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
# @param instructions [String, nil]
# @param max_output_tokens [Integer, nil]
Expand Down Expand Up @@ -72,7 +72,7 @@ def create(params)
# @overload create_streaming(input:, model:, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, reasoning: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
#
# @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
# @param model [String, Symbol, OpenAI::Models::ChatModel]
# @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel]
# @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
# @param instructions [String, nil]
# @param max_output_tokens [Integer, nil]
Expand Down
2 changes: 1 addition & 1 deletion rbi/lib/openai/models/all_models.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module OpenAI
end

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::AllModels) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::AllModels::TaggedSymbol) }
OrSymbol = T.type_alias { T.any(Symbol, String, OpenAI::Models::AllModels::TaggedSymbol) }

O1_PRO = T.let(:"o1-pro", OpenAI::Models::AllModels::TaggedSymbol)
O1_PRO_2025_03_19 = T.let(:"o1-pro-2025-03-19", OpenAI::Models::AllModels::TaggedSymbol)
Expand Down
5 changes: 3 additions & 2 deletions rbi/lib/openai/models/audio/speech_create_params.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ module OpenAI
end

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::TaggedSymbol) }
OrSymbol =
T.type_alias { T.any(Symbol, String, OpenAI::Models::Audio::SpeechCreateParams::Voice::TaggedSymbol) }

ALLOY = T.let(:alloy, OpenAI::Models::Audio::SpeechCreateParams::Voice::TaggedSymbol)
ASH = T.let(:ash, OpenAI::Models::Audio::SpeechCreateParams::Voice::TaggedSymbol)
Expand All @@ -131,7 +132,7 @@ module OpenAI

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat) }
OrSymbol =
T.type_alias { T.any(Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::TaggedSymbol) }
T.type_alias { T.any(Symbol, String, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::TaggedSymbol) }

MP3 = T.let(:mp3, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::TaggedSymbol)
OPUS = T.let(:opus, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat::TaggedSymbol)
Expand Down
2 changes: 1 addition & 1 deletion rbi/lib/openai/models/audio/speech_model.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module OpenAI
extend OpenAI::Enum

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::Audio::SpeechModel) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::Audio::SpeechModel::TaggedSymbol) }
OrSymbol = T.type_alias { T.any(Symbol, String, OpenAI::Models::Audio::SpeechModel::TaggedSymbol) }

TTS_1 = T.let(:"tts-1", OpenAI::Models::Audio::SpeechModel::TaggedSymbol)
TTS_1_HD = T.let(:"tts-1-hd", OpenAI::Models::Audio::SpeechModel::TaggedSymbol)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,13 @@ module OpenAI
TaggedSymbol =
T.type_alias { T.all(Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity) }
OrSymbol =
T.type_alias { T.any(Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity::TaggedSymbol) }
T.type_alias do
T.any(
Symbol,
String,
OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity::TaggedSymbol
)
end

WORD = T.let(:word, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity::TaggedSymbol)
SEGMENT =
Expand Down
3 changes: 2 additions & 1 deletion rbi/lib/openai/models/audio/transcription_include.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ module OpenAI
extend OpenAI::Enum

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::Audio::TranscriptionInclude) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::Audio::TranscriptionInclude::TaggedSymbol) }
OrSymbol =
T.type_alias { T.any(Symbol, String, OpenAI::Models::Audio::TranscriptionInclude::TaggedSymbol) }

LOGPROBS = T.let(:logprobs, OpenAI::Models::Audio::TranscriptionInclude::TaggedSymbol)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ module OpenAI
TaggedSymbol =
T.type_alias { T.all(Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat) }
OrSymbol =
T.type_alias { T.any(Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat::TaggedSymbol) }
T.type_alias { T.any(Symbol, String, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat::TaggedSymbol) }

JSON = T.let(:json, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat::TaggedSymbol)
TEXT = T.let(:text, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat::TaggedSymbol)
Expand Down
2 changes: 1 addition & 1 deletion rbi/lib/openai/models/audio_model.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module OpenAI
extend OpenAI::Enum

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::AudioModel) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::AudioModel::TaggedSymbol) }
OrSymbol = T.type_alias { T.any(Symbol, String, OpenAI::Models::AudioModel::TaggedSymbol) }

WHISPER_1 = T.let(:"whisper-1", OpenAI::Models::AudioModel::TaggedSymbol)
GPT_4O_TRANSCRIBE = T.let(:"gpt-4o-transcribe", OpenAI::Models::AudioModel::TaggedSymbol)
Expand Down
2 changes: 1 addition & 1 deletion rbi/lib/openai/models/audio_response_format.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module OpenAI
extend OpenAI::Enum

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::AudioResponseFormat) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::AudioResponseFormat::TaggedSymbol) }
OrSymbol = T.type_alias { T.any(Symbol, String, OpenAI::Models::AudioResponseFormat::TaggedSymbol) }

JSON = T.let(:json, OpenAI::Models::AudioResponseFormat::TaggedSymbol)
TEXT = T.let(:text, OpenAI::Models::AudioResponseFormat::TaggedSymbol)
Expand Down
2 changes: 1 addition & 1 deletion rbi/lib/openai/models/batch.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ module OpenAI
extend OpenAI::Enum

TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::Batch::Status) }
OrSymbol = T.type_alias { T.any(Symbol, OpenAI::Models::Batch::Status::TaggedSymbol) }
OrSymbol = T.type_alias { T.any(Symbol, String, OpenAI::Models::Batch::Status::TaggedSymbol) }

VALIDATING = T.let(:validating, OpenAI::Models::Batch::Status::TaggedSymbol)
FAILED = T.let(:failed, OpenAI::Models::Batch::Status::TaggedSymbol)
Expand Down
Loading