Class: OCI::AiSpeech::Models::RealtimeMessageResultTranscription

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

Overview

Transcription object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RealtimeMessageResultTranscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 82

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

  self.is_final = attributes[:'isFinal'] unless attributes[:'isFinal'].nil?

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

  self.is_final = attributes[:'is_final'] unless attributes[:'is_final'].nil?

  self.start_time_in_ms = attributes[:'startTimeInMs'] if attributes[:'startTimeInMs']

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

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

  self.end_time_in_ms = attributes[:'endTimeInMs'] if attributes[:'endTimeInMs']

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

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

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

  self.trailing_silence = attributes[:'trailingSilence'] if attributes[:'trailingSilence']

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

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

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

Instance Attribute Details

#confidence ⇒ Float

[Required] Confidence for the transcription text.

Returns:

  • (Float) 


29
30
31
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 29

def confidence
  @confidence
end

#end_time_in_ms ⇒ Integer

[Required] End time in milliseconds for the transcription text.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 25

def end_time_in_ms
  @end_time_in_ms
end

#is_final ⇒ BOOLEAN

[Required] Whether the transcription is final or partial.

Returns:

  • (BOOLEAN) 


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

def is_final
  @is_final
end

#start_time_in_ms ⇒ Integer

[Required] Start time in milliseconds for the transcription text.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 21

def start_time_in_ms
  @start_time_in_ms
end

#tokens ⇒ Array<OCI::AiSpeech::Models::RealtimeMessageResultTranscriptionToken>

[Required] Array of individual transcription tokens.

Returns:



37
38
39
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 37

def tokens
  @tokens
end

#trailing_silence ⇒ Integer

[Required] Trailing silence after the transcription text.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 33

def trailing_silence
  @trailing_silence
end

#transcription ⇒ String

[Required] Transcription text.

Returns:

  • (String) 


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

def transcription
  @transcription
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'transcription': :'transcription',
    'is_final': :'isFinal',
    'start_time_in_ms': :'startTimeInMs',
    'end_time_in_ms': :'endTimeInMs',
    'confidence': :'confidence',
    'trailing_silence': :'trailingSilence',
    'tokens': :'tokens'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'transcription': :'String',
    'is_final': :'BOOLEAN',
    'start_time_in_ms': :'Integer',
    'end_time_in_ms': :'Integer',
    'confidence': :'Float',
    'trailing_silence': :'Integer',
    'tokens': :'Array<OCI::AiSpeech::Models::RealtimeMessageResultTranscriptionToken>'
    # 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



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 126

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

  self.class == other.class &&
    transcription == other.transcription &&
    is_final == other.is_final &&
    start_time_in_ms == other.start_time_in_ms &&
    end_time_in_ms == other.end_time_in_ms &&
    confidence == other.confidence &&
    trailing_silence == other.trailing_silence &&
    tokens == other.tokens
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 162

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


142
143
144
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 151

def hash
  [transcription, is_final, start_time_in_ms, end_time_in_ms, confidence, trailing_silence, tokens].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 195

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



189
190
191
 
# File 'lib/oci/ai_speech/models/realtime_message_result_transcription.rb', line 189

def to_s
  to_hash.to_s
end