Class: OpenAI::Models::Responses::ResponseInputAudio

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_input_audio.rb

Defined Under Namespace

Modules: Format

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(data: , format_: , type: :input_audio) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseInputAudio for more details.

An audio input to the model.

Parameters:

  • data (String) (defaults to: ) —

    Base64-encoded audio data.

  • format_ (Symbol, OpenAI::Models::Responses::ResponseInputAudio::Format) (defaults to: ) —

    The format of the audio data. Currently supported formats are ‘mp3` and

  • type (Symbol, :input_audio) (defaults to: :input_audio) —

    The type of the input item. Always ‘input_audio`.




# File 'lib/openai/models/responses/response_input_audio.rb', line 25

Instance Attribute Details

#data ⇒ String

Base64-encoded audio data.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_input_audio.rb', line 11

required :data, String

#format_ ⇒ Symbol, OpenAI::Models::Responses::ResponseInputAudio::Format

The format of the audio data. Currently supported formats are ‘mp3` and `wav`.

Returns:



17
 
# File 'lib/openai/models/responses/response_input_audio.rb', line 17

required :format_, enum: -> { OpenAI::Responses::ResponseInputAudio::Format }, api_name: :format

#type ⇒ Symbol, :input_audio

The type of the input item. Always ‘input_audio`.

Returns:

  • (Symbol, :input_audio) 


23
 
# File 'lib/openai/models/responses/response_input_audio.rb', line 23

required :type, const: :input_audio