RealtimeSessionToken¶

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

Bases: object

The response from the realtime session token endpoint that creates the auth token to be used with the realtime speech service.

Methods

__init__(**kwargs) Initializes a new RealtimeSessionToken object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this RealtimeSessionToken.
`defined_tags`	Gets the defined_tags of this RealtimeSessionToken.
`freeform_tags`	Gets the freeform_tags of this RealtimeSessionToken.
`session_id`	[Required] Gets the session_id of this RealtimeSessionToken.
`token`	[Required] Gets the token of this RealtimeSessionToken.

__init__(**kwargs)¶

Initializes a new RealtimeSessionToken object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

token (str) – The value to assign to the token property of this RealtimeSessionToken.
session_id (str) – The value to assign to the session_id property of this RealtimeSessionToken.
compartment_id (str) – The value to assign to the compartment_id property of this RealtimeSessionToken.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RealtimeSessionToken.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RealtimeSessionToken.

compartment_id¶

[Required] Gets the compartment_id of this RealtimeSessionToken. Compartment ID that was used to create the token.

Returns:	The compartment_id of this RealtimeSessionToken.
Return type:	str

defined_tags¶

Gets the defined_tags of this RealtimeSessionToken. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace-1”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}, “foo-namespace-2”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}}.

Returns:	The defined_tags of this RealtimeSessionToken.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this RealtimeSessionToken. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

Returns:	The freeform_tags of this RealtimeSessionToken.
Return type:	dict(str, str)

session_id¶

[Required] Gets the session_id of this RealtimeSessionToken. The session ID this token corresponds to. Provided for convenience, the session ID is already present in the JWT token.

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

token¶

[Required] Gets the token of this RealtimeSessionToken. The session token (JWT) to be consumed by the websocket server. The token contains the session/tenant ID, as well as the expiry time.

Returns:	The token of this RealtimeSessionToken.
Return type:	str