Realtime event

[BETA] Defines the realtime event schemas for the realtime session.

Authors

Henry Wicaksono (henry.wicaksono@gdplabs.id)

References

NONE

RealtimeActivityType

Bases: StrEnum

[BETA] Defines common realtime activity types of the realtime session.

RealtimeDataType

Bases: StrEnum

[BETA] Defines the data types for the realtime session.

RealtimeEvent

Bases: BaseModel

[BETA] Defines the realtime event schemas for the realtime session.

Attributes:

Name	Type	Description
type	RealtimeEventType	The type of the event.
data	str | bytes	The data of the event.
data_type	RealtimeDataType	The data type of the event.
metadata	dict[str, Any]	The metadata of the event.

activity(activity, metadata=None) classmethod

Create an activity event.

Parameters:

Name	Type	Description	Default
activity	str	The activity of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The activity event.

input_audio(audio, metadata=None) classmethod

Create an input audio event.

Parameters:

Name	Type	Description	Default
audio	bytes	The audio of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The input audio event.

input_image(image, metadata=None) classmethod

Create an input image event.

Parameters:

Name	Type	Description	Default
image	bytes	The image of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The input image event.

input_text(text, metadata=None) classmethod

Create an input text event.

Parameters:

Name	Type	Description	Default
text	str	The text of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The input text event.

output_audio(audio, metadata=None) classmethod

Create an output audio event.

Parameters:

Name	Type	Description	Default
audio	bytes	The audio of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The output audio event.

output_image(image, metadata=None) classmethod

Create an output image event.

Parameters:

Name	Type	Description	Default
image	bytes	The image of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The output image event.

output_text(text, metadata=None) classmethod

Create an output text event.

Parameters:

Name	Type	Description	Default
text	str	The text of the event.	required
metadata	dict[str, Any]	The metadata of the event. Defaults to None.	None

Returns:

Name	Type	Description
RealtimeEvent	RealtimeEvent	The output text event.

RealtimeEventType

Bases: StrEnum

[BETA] Defines the event types for the realtime session.