Class: OCI::AiSpeech::Models::SynthesizeSpeechDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_speech/models/synthesize_speech_details.rb

Overview

Input JSON to get audio inference from TTS Service.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SynthesizeSpeechDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 69

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.text = attributes[:'text'] if attributes[:'text']

  self.is_stream_enabled = attributes[:'isStreamEnabled'] unless attributes[:'isStreamEnabled'].nil?
  self.is_stream_enabled = false if is_stream_enabled.nil? && !attributes.key?(:'isStreamEnabled') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isStreamEnabled and :is_stream_enabled' if attributes.key?(:'isStreamEnabled') && attributes.key?(:'is_stream_enabled')

  self.is_stream_enabled = attributes[:'is_stream_enabled'] unless attributes[:'is_stream_enabled'].nil?
  self.is_stream_enabled = false if is_stream_enabled.nil? && !attributes.key?(:'isStreamEnabled') && !attributes.key?(:'is_stream_enabled') # rubocop:disable Style/StringLiterals

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

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

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

  self.audio_config = attributes[:'audioConfig'] if attributes[:'audioConfig']

  raise 'You cannot provide both :audioConfig and :audio_config' if attributes.key?(:'audioConfig') && attributes.key?(:'audio_config')

  self.audio_config = attributes[:'audio_config'] if attributes[:'audio_config']
end

Instance Attribute Details

#audio_config ⇒ OCI::AiSpeech::Models::TtsAudioConfig

Returns:



30
31
32
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 30

def audio_config
  @audio_config
end

#compartment_id ⇒ String

The OCID of the compartment where the user has access to call SpeechSynthesize api. But default user access will be checked at tenancy level.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 24

def compartment_id
  @compartment_id
end

#configuration ⇒ OCI::AiSpeech::Models::TtsConfiguration

Returns:



27
28
29
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 27

def configuration
  @configuration
end

#is_stream_enabled ⇒ BOOLEAN

If set to true, response will be sent in the chunked transfer-encoding and audio chunks are sent back as and when they are ready. If set to false, response will be sent only once the entire audio is generated.

Returns:

  • (BOOLEAN) 


20
21
22
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 20

def is_stream_enabled
  @is_stream_enabled
end

#text ⇒ String

[Required] The text input to get the inference audio from TTS Service.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 13

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'text': :'text',
    'is_stream_enabled': :'isStreamEnabled',
    'compartment_id': :'compartmentId',
    'configuration': :'configuration',
    'audio_config': :'audioConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'text': :'String',
    'is_stream_enabled': :'BOOLEAN',
    'compartment_id': :'String',
    'configuration': :'OCI::AiSpeech::Models::TtsConfiguration',
    'audio_config': :'OCI::AiSpeech::Models::TtsAudioConfig'
    # 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



107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 107

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

  self.class == other.class &&
    text == other.text &&
    is_stream_enabled == other.is_stream_enabled &&
    compartment_id == other.compartment_id &&
    configuration == other.configuration &&
    audio_config == other.audio_config
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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 141

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


121
122
123
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 130

def hash
  [text, is_stream_enabled, compartment_id, configuration, audio_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 174

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



168
169
170
 
# File 'lib/oci/ai_speech/models/synthesize_speech_details.rb', line 168

def to_s
  to_hash.to_s
end