Class: OCI::GenerativeAiInference::Models::AudioUrl

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/audio_url.rb

Overview

Provide a base64 encoded audio or an audio uri if it's supported.

Constant Summary collapse

DETAIL_ENUM = 
[
  DETAIL_AUTO = 'AUTO'.freeze,
  DETAIL_HIGH = 'HIGH'.freeze,
  DETAIL_LOW = 'LOW'.freeze,
  DETAIL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AudioUrl

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :url (String) —

    The value to assign to the #url property

  • :detail (String) —

    The value to assign to the #detail property



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.url = attributes[:'url'] if attributes[:'url']

  self.detail = attributes[:'detail'] if attributes[:'detail']
  self.detail = "AUTO" if detail.nil? && !attributes.key?(:'detail') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#detail ⇒ String

The default value is AUTO and only AUTO is supported. This option controls how to convert the base64 encoded audio to tokens.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 42

def detail
  @detail
end

#url ⇒ String

[Required] The base64 encoded audio data or an audio uri if it's supported.

Example for an mp3 audio: { \"type\": \"AUDIO\", \"audioUrl\": { \"url\": \"data:audio/mp3;base64,<base64 encoded audio content>\" } }

Example with an audio uri: { \"type\": \"AUDIO\", \"audioUrl\": { \"url\": \"data:audio/mp3;uri,<audio uri>\" } }

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 38

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



45
46
47
48
49
50
51
52
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'url': :'url',
    'detail': :'detail'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'url': :'String',
    'detail': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



104
105
106
107
108
109
110
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 104

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    url == other.url &&
    detail == other.detail
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 135

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 124

def hash
  [url, detail].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 168

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



162
163
164
 
# File 'lib/oci/generative_ai_inference/models/audio_url.rb', line 162

def to_s
  to_hash.to_s
end