Class: OCI::AiSpeech::Models::Diarization

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

Overview

Speaker diarization is a combination of speaker segmentation and speaker clustering. Provide diarization details to enable this feature.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Diarization

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 47

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.is_diarization_enabled = attributes[:'isDiarizationEnabled'] unless attributes[:'isDiarizationEnabled'].nil?
  self.is_diarization_enabled = false if is_diarization_enabled.nil? && !attributes.key?(:'isDiarizationEnabled') # rubocop:disable Style/StringLiterals

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

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

  self.number_of_speakers = attributes[:'numberOfSpeakers'] if attributes[:'numberOfSpeakers']

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

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

Instance Attribute Details

#is_diarization_enabled ⇒ BOOLEAN

Set true to enable Speaker diarization and tag transcription with speaker tags. By default this is disabled.

Returns:

  • (BOOLEAN) 


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

def is_diarization_enabled
  @is_diarization_enabled
end

#number_of_speakers ⇒ Integer

Number of speakers in the audio provided. By default service will auto detect all speakers in audio file

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 17

def number_of_speakers
  @number_of_speakers
end

Class Method Details

.attribute_map ⇒ Object

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



20
21
22
23
24
25
26
27
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 20

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_diarization_enabled': :'isDiarizationEnabled',
    'number_of_speakers': :'numberOfSpeakers'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



30
31
32
33
34
35
36
37
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 30

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_diarization_enabled': :'BOOLEAN',
    'number_of_speakers': :'Integer'
    # 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



75
76
77
78
79
80
81
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 75

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

  self.class == other.class &&
    is_diarization_enabled == other.is_diarization_enabled &&
    number_of_speakers == other.number_of_speakers
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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 106

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


86
87
88
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 86

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 95

def hash
  [is_diarization_enabled, number_of_speakers].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 139

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



133
134
135
 
# File 'lib/oci/ai_speech/models/diarization.rb', line 133

def to_s
  to_hash.to_s
end