Transcribe Streaming  >  Unions  >  MedicalScribeInputStream

MedicalScribeInputStream

Union Type

MedicalScribeInputStream module-attribute

MedicalScribeInputStream = Union[MedicalScribeInputStreamAudioEvent | MedicalScribeInputStreamSessionControlEvent | MedicalScribeInputStreamConfigurationEvent | MedicalScribeInputStreamUnknown]

An encoded stream of events. The stream is encoded as HTTP/2 data frames.

An input stream consists of the following types of events. The first element of the input stream must be the MedicalScribeConfigurationEvent event type.

• MedicalScribeConfigurationEvent

• MedicalScribeAudioEvent

• MedicalScribeSessionControlEvent

Union Member Types

MedicalScribeInputStreamAudioEvent dataclass

A wrapper for your audio chunks

For more information, see Event stream encoding.

Attributes

value instance-attribute

value: MedicalScribeAudioEvent

MedicalScribeInputStreamSessionControlEvent dataclass

Specify the lifecycle of your streaming session, such as ending the session.

Attributes

value instance-attribute

value: MedicalScribeSessionControlEvent

MedicalScribeInputStreamConfigurationEvent dataclass

Specify additional streaming session configurations beyond those provided in your initial start request headers. For example, specify channel definitions, encryption settings, and post-stream analytics settings.

Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent.

Attributes

value instance-attribute

value: MedicalScribeConfigurationEvent

MedicalScribeInputStreamUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute

tag: str