Module: OpenAI::Internal::Type::Union Private

Includes:
Converter, Util::SorbetRuntimeSupport
Included in:
Helpers::StructuredOutput::UnionOf, Models::AllModels, Models::Audio::SpeechCreateParams::Model, Models::Audio::SpeechCreateParams::Voice, Models::Audio::TranscriptionCreateParams::ChunkingStrategy, Models::Audio::TranscriptionCreateParams::Model, Models::Audio::TranscriptionCreateResponse, Models::Audio::TranscriptionStreamEvent, Models::Audio::TranslationCreateParams::Model, Models::Audio::TranslationCreateResponse, Models::Beta::AssistantCreateParams::Model, Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy, Models::Beta::AssistantResponseFormatOption, Models::Beta::AssistantStreamEvent, Models::Beta::AssistantTool, Models::Beta::AssistantToolChoiceOption, Models::Beta::AssistantUpdateParams::Model, Models::Beta::MessageStreamEvent, Models::Beta::RunStepStreamEvent, Models::Beta::RunStreamEvent, Models::Beta::ThreadCreateAndRunParams::Model, Models::Beta::ThreadCreateAndRunParams::Thread::Message::Attachment::Tool, Models::Beta::ThreadCreateAndRunParams::Thread::Message::Content, Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources::FileSearch::VectorStore::ChunkingStrategy, Models::Beta::ThreadCreateParams::Message::Attachment::Tool, Models::Beta::ThreadCreateParams::Message::Content, Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy, Models::Beta::Threads::Annotation, Models::Beta::Threads::AnnotationDelta, Models::Beta::Threads::Message::Attachment::Tool, Models::Beta::Threads::MessageContent, Models::Beta::Threads::MessageContentDelta, Models::Beta::Threads::MessageContentPartParam, Models::Beta::Threads::MessageCreateParams::Attachment::Tool, Models::Beta::Threads::MessageCreateParams::Content, Models::Beta::Threads::RunCreateParams::AdditionalMessage::Attachment::Tool, Models::Beta::Threads::RunCreateParams::AdditionalMessage::Content, Models::Beta::Threads::RunCreateParams::Model, Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::Output, Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta::CodeInterpreter::Output, Models::Beta::Threads::Runs::RunStep::StepDetails, Models::Beta::Threads::Runs::RunStepDelta::StepDetails, Models::Beta::Threads::Runs::ToolCall, Models::Beta::Threads::Runs::ToolCallDelta, Models::Chat::ChatCompletionAssistantMessageParam::Content, Models::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart, Models::Chat::ChatCompletionAudioParam::Voice, Models::Chat::ChatCompletionContentPart, Models::Chat::ChatCompletionDeveloperMessageParam::Content, Models::Chat::ChatCompletionMessageParam, Models::Chat::ChatCompletionPredictionContent::Content, Models::Chat::ChatCompletionSystemMessageParam::Content, Models::Chat::ChatCompletionToolChoiceOption, Models::Chat::ChatCompletionToolMessageParam::Content, Models::Chat::ChatCompletionUserMessageParam::Content, Models::Chat::CompletionCreateParams::FunctionCall, Models::Chat::CompletionCreateParams::Model, Models::Chat::CompletionCreateParams::ResponseFormat, Models::Chat::CompletionCreateParams::Stop, Models::ComparisonFilter::Value, Models::CompletionCreateParams::Model, Models::CompletionCreateParams::Prompt, Models::CompletionCreateParams::Stop, Models::CompoundFilter::Filter, Models::EmbeddingCreateParams::Input, Models::EmbeddingCreateParams::Model, Models::EvalCreateParams::DataSourceConfig, Models::EvalCreateParams::TestingCriterion, Models::EvalCreateParams::TestingCriterion::LabelModel::Input, Models::EvalCreateParams::TestingCriterion::LabelModel::Input::EvalItem::Content, Models::EvalCreateResponse::DataSourceConfig, Models::EvalCreateResponse::TestingCriterion, Models::EvalListResponse::DataSourceConfig, Models::EvalListResponse::TestingCriterion, Models::EvalRetrieveResponse::DataSourceConfig, Models::EvalRetrieveResponse::TestingCriterion, Models::EvalUpdateResponse::DataSourceConfig, Models::EvalUpdateResponse::TestingCriterion, Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages, Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template, Models::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content, Models::Evals::CreateEvalCompletionsRunDataSource::Source, Models::Evals::CreateEvalJSONLRunDataSource::Source, Models::Evals::RunCancelResponse::DataSource, Models::Evals::RunCancelResponse::DataSource::Responses::InputMessages, Models::Evals::RunCancelResponse::DataSource::Responses::InputMessages::Template::Template, Models::Evals::RunCancelResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content, Models::Evals::RunCancelResponse::DataSource::Responses::Source, Models::Evals::RunCreateParams::DataSource, Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages, Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template, Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::InputMessages::Template::Template::EvalItem::Content, Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::Source, Models::Evals::RunCreateResponse::DataSource, Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages, Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template, Models::Evals::RunCreateResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content, Models::Evals::RunCreateResponse::DataSource::Responses::Source, Models::Evals::RunListResponse::DataSource, Models::Evals::RunListResponse::DataSource::Responses::InputMessages, Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template, Models::Evals::RunListResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content, Models::Evals::RunListResponse::DataSource::Responses::Source, Models::Evals::RunRetrieveResponse::DataSource, Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages, Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template, Models::Evals::RunRetrieveResponse::DataSource::Responses::InputMessages::Template::Template::EvalItem::Content, Models::Evals::RunRetrieveResponse::DataSource::Responses::Source, Models::FileChunkingStrategy, Models::FileChunkingStrategyParam, Models::FineTuning::Alpha::GraderRunParams::Grader, Models::FineTuning::Alpha::GraderValidateParams::Grader, Models::FineTuning::Alpha::GraderValidateResponse::Grader, Models::FineTuning::DpoHyperparameters::BatchSize, Models::FineTuning::DpoHyperparameters::Beta, Models::FineTuning::DpoHyperparameters::LearningRateMultiplier, Models::FineTuning::DpoHyperparameters::NEpochs, Models::FineTuning::FineTuningJob::Hyperparameters::BatchSize, Models::FineTuning::FineTuningJob::Hyperparameters::LearningRateMultiplier, Models::FineTuning::FineTuningJob::Hyperparameters::NEpochs, Models::FineTuning::JobCreateParams::Hyperparameters::BatchSize, Models::FineTuning::JobCreateParams::Hyperparameters::LearningRateMultiplier, Models::FineTuning::JobCreateParams::Hyperparameters::NEpochs, Models::FineTuning::JobCreateParams::Model, Models::FineTuning::ReinforcementHyperparameters::BatchSize, Models::FineTuning::ReinforcementHyperparameters::ComputeMultiplier, Models::FineTuning::ReinforcementHyperparameters::EvalInterval, Models::FineTuning::ReinforcementHyperparameters::EvalSamples, Models::FineTuning::ReinforcementHyperparameters::LearningRateMultiplier, Models::FineTuning::ReinforcementHyperparameters::NEpochs, Models::FineTuning::ReinforcementMethod::Grader, Models::FineTuning::SupervisedHyperparameters::BatchSize, Models::FineTuning::SupervisedHyperparameters::LearningRateMultiplier, Models::FineTuning::SupervisedHyperparameters::NEpochs, Models::Graders::LabelModelGrader::Input::Content, Models::Graders::MultiGrader::Graders, Models::Graders::ScoreModelGrader::Input::Content, Models::ImageCreateVariationParams::Model, Models::ImageEditParams::Image, Models::ImageEditParams::Model, Models::ImageGenerateParams::Model, Models::ModerationCreateParams::Input, Models::ModerationCreateParams::Model, Models::ModerationMultiModalInput, Models::Responses::EasyInputMessage::Content, Models::Responses::FileSearchTool::Filters, Models::Responses::Response::ToolChoice, Models::Responses::ResponseCodeInterpreterToolCall::Result, Models::Responses::ResponseComputerToolCall::Action, Models::Responses::ResponseContent, Models::Responses::ResponseContentPartAddedEvent::Part, Models::Responses::ResponseContentPartDoneEvent::Part, Models::Responses::ResponseCreateParams::Input, Models::Responses::ResponseCreateParams::ToolChoice, Models::Responses::ResponseFileSearchToolCall::Result::Attribute, Models::Responses::ResponseFormatTextConfig, Models::Responses::ResponseInputContent, Models::Responses::ResponseInputItem, Models::Responses::ResponseItem, Models::Responses::ResponseOutputItem, Models::Responses::ResponseOutputMessage::Content, Models::Responses::ResponseOutputText::Annotation, Models::Responses::ResponseStreamEvent, Models::Responses::Tool, Models::Responses::Tool::CodeInterpreter::Container, Models::Responses::Tool::Mcp::AllowedTools, Models::Responses::Tool::Mcp::RequireApproval, Models::ResponsesModel, Models::VectorStoreSearchParams::Filters, Models::VectorStoreSearchParams::Query, Models::VectorStoreSearchResponse::Attribute, Models::VectorStores::FileBatchCreateParams::Attribute, Models::VectorStores::FileCreateParams::Attribute, Models::VectorStores::FileUpdateParams::Attribute, Models::VectorStores::VectorStoreFile::Attribute
Defined in:
lib/openai/internal/type/union.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Examples:

# `chat_completion_content_part` is a `OpenAI::Chat::ChatCompletionContentPart`
case chat_completion_content_part
when OpenAI::Chat::ChatCompletionContentPartText
  puts(chat_completion_content_part.text)
when OpenAI::Chat::ChatCompletionContentPartImage
  puts(chat_completion_content_part.image_url)
when OpenAI::Chat::ChatCompletionContentPartInputAudio
  puts(chat_completion_content_part.input_audio)
else
  puts(chat_completion_content_part)
end
case chat_completion_content_part
in {type: :text, text: text}
  puts(text)
in {type: :image_url, image_url: image_url}
  puts(image_url)
in {type: :input_audio, input_audio: input_audio}
  puts(input_audio)
else
  puts(chat_completion_content_part)
end

Instance Method Summary collapse

Methods included from Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, to_sorbet_type

Methods included from Converter

coerce, dump, inspect, type_info

Instance Method Details

#==(other) ⇒ Boolean

Parameters:

  • other (Object)

Returns:



132
133
134
 
# File 'lib/openai/internal/type/union.rb', line 132

def ==(other)
  OpenAI::Internal::Type::Union === other && other.derefed_variants == derefed_variants
end

#===(other) ⇒ Boolean

Parameters:

  • other (Object)

Returns:



121
122
123
124
125
 
# File 'lib/openai/internal/type/union.rb', line 121

def ===(other)
  known_variants.any? do |_, variant_fn|
    variant_fn.call === other
  end
end

#coerce(value, state:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • value (Object)
  • state (Hash{Symbol=>Object}) —

    .

    @option state [Boolean, :strong] :strictness

    @option state [HashSymbol=>Object] :exactness

    @option state [Integer] :branched

Returns:

  • (Object) 


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/openai/internal/type/union.rb', line 154

def coerce(value, state:)
  if (target = resolve_variant(value))
    return OpenAI::Internal::Type::Converter.coerce(target, value, state: state)
  end

  strictness = state.fetch(:strictness)
  exactness = state.fetch(:exactness)
  state[:strictness] = strictness == :strong ? true : strictness

  alternatives = []
  known_variants.each do |_, variant_fn|
    target = variant_fn.call
    exact = state[:exactness] = {yes: 0, no: 0, maybe: 0}
    state[:branched] += 1

    coerced = OpenAI::Internal::Type::Converter.coerce(target, value, state: state)
    yes, no, maybe = exact.values
    if (no + maybe).zero? || (!strictness && yes.positive?)
      exact.each { exactness[_1] += _2 }
      state[:exactness] = exactness
      return coerced
    elsif maybe.positive?
      alternatives << [[-yes, -maybe, no], exact, coerced]
    end
  end

  case alternatives.sort_by(&:first)
  in []
    exactness[:no] += 1
    if strictness == :strong
      message = "no possible conversion of #{value.class} into a variant of #{target.inspect}"
      raise ArgumentError.new(message)
    end
    value
  in [[_, exact, coerced], *]
    exact.each { exactness[_1] += _2 }
    coerced
  end
    .tap { state[:exactness] = exactness }
ensure
  state[:strictness] = strictness
end

#dump(value, state:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • value (Object)
  • state (Hash{Symbol=>Object}) —

    .

    @option state [Boolean] :can_retry

Returns:

  • (Object) 


206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/openai/internal/type/union.rb', line 206

def dump(value, state:)
  if (target = resolve_variant(value))
    return OpenAI::Internal::Type::Converter.dump(target, value, state: state)
  end

  known_variants.each do
    target = _2.call
    return OpenAI::Internal::Type::Converter.dump(target, value, state: state) if target === value
  end

  super
end

#hash ⇒ Integer

Returns:

  • (Integer) 


139
 
# File 'lib/openai/internal/type/union.rb', line 139

def hash = variants.hash

#inspect(depth: 0) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • depth (Integer) (defaults to: 0)

Returns:

  • (String) 


239
240
241
242
243
244
245
246
247
248
 
# File 'lib/openai/internal/type/union.rb', line 239

def inspect(depth: 0)
  if depth.positive?
    return is_a?(Module) ? super() : self.class.name
  end

  members = variants.map { OpenAI::Internal::Type::Converter.inspect(_1, depth: depth.succ) }
  prefix = is_a?(Module) ? name : self.class.name

  "#{prefix}[#{members.join(' | ')}]"
end

#to_sorbet_type ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Object) 


222
223
224
225
226
227
228
229
 
# File 'lib/openai/internal/type/union.rb', line 222

def to_sorbet_type
  case (v = variants)
  in []
    T.noreturn
  else
    T.any(*v.map { OpenAI::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
  end
end

#variants ⇒ Array<Object>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

All of the specified variants for this union.

Returns:

  • (Array<Object>) 


53
 
# File 'lib/openai/internal/type/union.rb', line 53

def variants = derefed_variants.map(&:last)