Class: OpenApiOpenAIClient::RealtimeSessionCreateRequest

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

Overview

Realtime session object configuration.

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 = {}) ⇒ RealtimeSessionCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::RealtimeSessionCreateRequest` 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::RealtimeSessionCreateRequest`. 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?(:'modalities')
    if (value = attributes[:'modalities']).is_a?(Array)
      self.modalities = value
    end
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  else
    self.model = nil
  end

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

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

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

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

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

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

  if attributes.key?(:'tools')
    if (value = attributes[:'tools']).is_a?(Array)
      self.tools = value
    end
  end

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

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

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

Instance Attribute Details

#input_audio_format ⇒ Object

The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw.



32
33
34
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 32

def input_audio_format
  @input_audio_format
end

#input_audio_transcription ⇒ Object

Returns the value of attribute input_audio_transcription.



37
38
39
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 37

def input_audio_transcription
  @input_audio_transcription
end

#instructions ⇒ Object

The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. "be extremely succinct", "act friendly", "here are examples of good responses") and on audio behavior (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior. Note that the server sets default instructions which will be used if this field is not set and are visible in the session.created event at the start of the session.



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

def instructions
  @instructions
end

#max_response_output_tokens ⇒ Object

Returns the value of attribute max_response_output_tokens.



50
51
52
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 50

def max_response_output_tokens
  @max_response_output_tokens
end

#modalities ⇒ Object

The set of modalities the model can respond with. To disable audio, set this to ["text"].



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

def modalities
  @modalities
end

#model ⇒ Object

The Realtime model used for this session.



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

def model
  @model
end

#output_audio_format ⇒ Object

The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw.



35
36
37
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 35

def output_audio_format
  @output_audio_format
end

#temperature ⇒ Object

Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.



48
49
50
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 48

def temperature
  @temperature
end

#tool_choice ⇒ Object

How the model chooses tools. Options are auto, none, required, or specify a function.



45
46
47
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 45

def tool_choice
  @tool_choice
end

#tools ⇒ Object

Tools (functions) available to the model.



42
43
44
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 42

def tools
  @tools
end

#turn_detection ⇒ Object

Returns the value of attribute turn_detection.



39
40
41
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 39

def turn_detection
  @turn_detection
end

#voice ⇒ Object

The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are alloy, ash, ballad, coral, echo sage, shimmer and verse.



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

def voice
  @voice
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



93
94
95
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 98

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 75

def self.attribute_map
  {
    :'modalities' => :'modalities',
    :'model' => :'model',
    :'instructions' => :'instructions',
    :'voice' => :'voice',
    :'input_audio_format' => :'input_audio_format',
    :'output_audio_format' => :'output_audio_format',
    :'input_audio_transcription' => :'input_audio_transcription',
    :'turn_detection' => :'turn_detection',
    :'tools' => :'tools',
    :'tool_choice' => :'tool_choice',
    :'temperature' => :'temperature',
    :'max_response_output_tokens' => :'max_response_output_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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 299

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



121
122
123
124
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 103

def self.openapi_types
  {
    :'modalities' => :'Array<String>',
    :'model' => :'String',
    :'instructions' => :'String',
    :'voice' => :'String',
    :'input_audio_format' => :'String',
    :'output_audio_format' => :'String',
    :'input_audio_transcription' => :'RealtimeSessionInputAudioTranscription',
    :'turn_detection' => :'RealtimeSessionCreateRequestTurnDetection',
    :'tools' => :'Array<RealtimeResponseCreateParamsToolsInner>',
    :'tool_choice' => :'String',
    :'temperature' => :'Float',
    :'max_response_output_tokens' => :'RealtimeResponseCreateParamsMaxResponseOutputTokens'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      modalities == o.modalities &&
      model == o.model &&
      instructions == o.instructions &&
      voice == o.voice &&
      input_audio_format == o.input_audio_format &&
      output_audio_format == o.output_audio_format &&
      input_audio_transcription == o.input_audio_transcription &&
      turn_detection == o.turn_detection &&
      tools == o.tools &&
      tool_choice == o.tool_choice &&
      temperature == o.temperature &&
      max_response_output_tokens == o.max_response_output_tokens
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



292
293
294
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 292

def hash
  [modalities, model, instructions, voice, input_audio_format, output_audio_format, input_audio_transcription, turn_detection, tools, tool_choice, temperature, max_response_output_tokens].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



199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 199

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @model.nil?
    invalid_properties.push('invalid value for "model", model cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 321

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/openapi_openai/models/realtime_session_create_request.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @model.nil?
  model_validator = EnumAttributeValidator.new('String', ["gpt-4o-realtime-preview", "gpt-4o-realtime-preview-2024-10-01", "gpt-4o-realtime-preview-2024-12-17", "gpt-4o-mini-realtime-preview", "gpt-4o-mini-realtime-preview-2024-12-17"])
  return false unless model_validator.valid?(@model)
  voice_validator = EnumAttributeValidator.new('String', ["alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse"])
  return false unless voice_validator.valid?(@voice)
  input_audio_format_validator = EnumAttributeValidator.new('String', ["pcm16", "g711_ulaw", "g711_alaw"])
  return false unless input_audio_format_validator.valid?(@input_audio_format)
  output_audio_format_validator = EnumAttributeValidator.new('String', ["pcm16", "g711_ulaw", "g711_alaw"])
  return false unless output_audio_format_validator.valid?(@output_audio_format)
  true
end