Class: OpenApiOpenAIClient::RealtimeSessionTurnDetection

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/realtime_session_turn_detection.rb

Overview

Configuration for turn detection. Can be set to null to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ RealtimeSessionTurnDetection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 91

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::RealtimeSessionTurnDetection` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::RealtimeSessionTurnDetection`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'threshold')
    self.threshold = attributes[:'threshold']
  end

  if attributes.key?(:'prefix_padding_ms')
    self.prefix_padding_ms = attributes[:'prefix_padding_ms']
  end

  if attributes.key?(:'silence_duration_ms')
    self.silence_duration_ms = attributes[:'silence_duration_ms']
  end
end

Instance Attribute Details

#prefix_padding_ms ⇒ Object

Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.



26
27
28
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 26

def prefix_padding_ms
  @prefix_padding_ms
end

#silence_duration_ms ⇒ Object

Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.



29
30
31
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 29

def silence_duration_ms
  @silence_duration_ms
end

#threshold ⇒ Object

Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.



23
24
25
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 23

def threshold
  @threshold
end

#type ⇒ Object

Type of turn detection, only server_vad is currently supported.



20
21
22
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



64
65
66
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 64

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 54

def self.attribute_map
  {
    :'type' => :'type',
    :'threshold' => :'threshold',
    :'prefix_padding_ms' => :'prefix_padding_ms',
    :'silence_duration_ms' => :'silence_duration_ms'
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 175

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 84

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 74

def self.openapi_types
  {
    :'type' => :'String',
    :'threshold' => :'Float',
    :'prefix_padding_ms' => :'Integer',
    :'silence_duration_ms' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      threshold == o.threshold &&
      prefix_padding_ms == o.prefix_padding_ms &&
      silence_duration_ms == o.silence_duration_ms
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 168

def hash
  [type, threshold, prefix_padding_ms, silence_duration_ms].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



124
125
126
127
128
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 124

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 197

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



132
133
134
135
136
137
 
# File 'lib/openapi_openai/models/realtime_session_turn_detection.rb', line 132

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["server_vad"])
  return false unless type_validator.valid?(@type)
  true
end