Class: OpenAI::Models::Realtime::ConversationCreatedEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Realtime::ConversationCreatedEvent

Defined in:

lib/openai/models/realtime/conversation_created_event.rb

Defined Under Namespace

Classes: Conversation

Instance Attribute Summary

• #conversation ⇒ OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation

  The conversation resource.

• #event_id ⇒ String

  The unique ID of the server event.

• #type ⇒ Symbol, :"conversation.created"

  The event type, must be ‘conversation.created`.

Instance Method Summary

• #initialize(conversation:, event_id:, type: :"conversation.created") ⇒ Object constructor

  Returned when a conversation is created.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(conversation:, event_id:, type: :"conversation.created") ⇒ Object

Returned when a conversation is created. Emitted right after session creation.

Parameters:

• conversation (OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation) —

  The conversation resource.

• event_id (String) —

  The unique ID of the server event.

• type (Symbol, :"conversation.created") (defaults to: :"conversation.created") —

  The event type, must be ‘conversation.created`.

# File 'lib/openai/models/realtime/conversation_created_event.rb', line 25

Instance Attribute Details

#conversation ⇒ OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation

The conversation resource.

Returns:

• (OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation)

# File 'lib/openai/models/realtime/conversation_created_event.rb', line 11

required :conversation, -> { OpenAI::Realtime::ConversationCreatedEvent::Conversation }

#event_id ⇒ String

The unique ID of the server event.

Returns:

• (String)

# File 'lib/openai/models/realtime/conversation_created_event.rb', line 17

required :event_id, String

#type ⇒ Symbol, :"conversation.created"

The event type, must be ‘conversation.created`.

Returns:

• (Symbol, :"conversation.created")

# File 'lib/openai/models/realtime/conversation_created_event.rb', line 23

required :type, const: :"conversation.created"