RealtimeMessageConnect¶

class oci.ai_speech.models.RealtimeMessageConnect(**kwargs)¶

Bases: RealtimeMessage

The websocket connection message received from service.

Attributes:

`EVENT_ACKAUDIO`	A constant which can be used with the event property of a RealtimeMessage.
`EVENT_CONNECT`	A constant which can be used with the event property of a RealtimeMessage.
`EVENT_ERROR`	A constant which can be used with the event property of a RealtimeMessage.
`EVENT_RESULT`	A constant which can be used with the event property of a RealtimeMessage.
`event`	[Required] Gets the event of this RealtimeMessage.
`session_id`	Gets the session_id of this RealtimeMessage.

Methods:

`__init__`(**kwargs)	Initializes a new RealtimeMessageConnect object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

EVENT_ACKAUDIO = 'ACKAUDIO'¶: A constant which can be used with the event property of a RealtimeMessage. This constant has a value of “ACKAUDIO”

EVENT_CONNECT = 'CONNECT'¶: A constant which can be used with the event property of a RealtimeMessage. This constant has a value of “CONNECT”

EVENT_ERROR = 'ERROR'¶: A constant which can be used with the event property of a RealtimeMessage. This constant has a value of “ERROR”

EVENT_RESULT = 'RESULT'¶: A constant which can be used with the event property of a RealtimeMessage. This constant has a value of “RESULT”

__init__(**kwargs)¶

Initializes a new RealtimeMessageConnect object with values from keyword arguments. The default value of the event attribute of this class is CONNECT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

event (str) – The value to assign to the event property of this RealtimeMessageConnect. Allowed values for this property are: “RESULT”, “ACKAUDIO”, “ERROR”, “CONNECT”
session_id (str) – The value to assign to the session_id property of this RealtimeMessageConnect.

property event¶

[Required] Gets the event of this RealtimeMessage. Incoming Types of message event sent from Service -> Client - RESULT - result - ACKAUDIO - ackAudio - ERROR - error - CONNECT - connect Outgoing Types of message event sent from Client -> Service - SEND_FINAL_RESULT - sendFinalResult

Allowed values for this property are: “RESULT”, “ACKAUDIO”, “ERROR”, “CONNECT”

Returns: The event of this RealtimeMessage.
Return type: str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property session_id¶

Gets the session_id of this RealtimeMessage. Session ID for the connected session.

Returns: The session_id of this RealtimeMessage.
Return type: str