Class: OpenAI::Realtime

Inherits:

Object

• Object
• OpenAI::Realtime

Defined in:

lib/openai/realtime.rb

Instance Method Summary

• #create(parameters: {}) ⇒ Hash

  Create a new real-time session with OpenAI.

• #initialize(client:) ⇒ Realtime constructor

  A new instance of Realtime.

Constructor Details

#initialize(client:) ⇒ Realtime

Returns a new instance of Realtime.

# File 'lib/openai/realtime.rb', line 3

def initialize(client:)
  @client = client.beta(realtime: "v1")
end

Instance Method Details

#create(parameters: {}) ⇒ Hash

Create a new real-time session with OpenAI.

This method sets up a new session for real-time voice interaction with an OpenAI model. It returns session details that can be used to establish a WebRTC connection.

connection information

Parameters:

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

  parameters for the session (see: platform.openai.com/docs/api-reference/realtime-sessions/create)

Returns:

• (Hash) —

  Session details including session ID, ICE servers, and other

# File 'lib/openai/realtime.rb', line 15

def create(parameters: {})
  @client.json_post(path: "/realtime/sessions", parameters: parameters)
end