Class: OpenAI::Resources::Realtime::ClientSecrets

Inherits:

Object

• Object
• OpenAI::Resources::Realtime::ClientSecrets

Defined in:

lib/openai/resources/realtime/client_secrets.rb

Instance Method Summary

• #create(expires_after: nil, session: nil, request_options: {}) ⇒ OpenAI::Models::Realtime::ClientSecretCreateResponse

  Some parameter documentations has been truncated, see Models::Realtime::ClientSecretCreateParams for more details.

• #initialize(client:) ⇒ ClientSecrets constructor private

  A new instance of ClientSecrets.

Constructor Details

#initialize(client:) ⇒ ClientSecrets

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ClientSecrets.

Parameters:

• client (OpenAI::Client)

# File 'lib/openai/resources/realtime/client_secrets.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#create(expires_after: nil, session: nil, request_options: {}) ⇒ OpenAI::Models::Realtime::ClientSecretCreateResponse

Some parameter documentations has been truncated, see Models::Realtime::ClientSecretCreateParams for more details.

Create a Realtime client secret with an associated session configuration.

Parameters:

• expires_after (OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter) —

  Configuration for the client secret expiration. Expiration refers to the time af

• session (OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest) —

  Session configuration to use for the client secret. Choose either a realtime

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (OpenAI::Models::Realtime::ClientSecretCreateResponse)

See Also:

• Models::Realtime::ClientSecretCreateParams

# File 'lib/openai/resources/realtime/client_secrets.rb', line 23

def create(params = {})
  parsed, options = OpenAI::Realtime::ClientSecretCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "realtime/client_secrets",
    body: parsed,
    model: OpenAI::Models::Realtime::ClientSecretCreateResponse,
    options: options
  )
end