start_medical_stream_transcription¶
Operation¶
async
¶
start_medical_stream_transcription(input: StartMedicalStreamTranscriptionInput, plugins: list[Plugin] | None = None) -> DuplexEventStream[AudioStream, MedicalTranscriptResultStream, StartMedicalStreamTranscriptionOutput]
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
The following parameters are required:
-
language-code -
media-encoding -
sample-rate
For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartMedicalStreamTranscriptionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DuplexEventStream[AudioStream, MedicalTranscriptResultStream, StartMedicalStreamTranscriptionOutput]
|
A |
Input¶
dataclass
¶
Dataclass for StartMedicalStreamTranscriptionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
content_identification_type: MedicalContentIdentificationType | None = None
Labels all personal health information (PHI) identified in your transcript.
Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.
For more information, see Identifying personal health information (PHI) in a transcription.
class-attribute
instance-attribute
¶
enable_channel_identification: bool = False
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.
If you include EnableChannelIdentification in your request, you must
also include NumberOfChannels.
For more information, see Transcribing multi-channel audio.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
Specify the language code that represents the language spoken in your audio.
Warning
Amazon Transcribe Medical only supports US English (en-US).
class-attribute
instance-attribute
¶
media_encoding: MediaEncoding | None = None
Specify the encoding used for the input audio. Supported formats are:
-
FLAC
-
OPUS-encoded audio in an Ogg container
-
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
class-attribute
instance-attribute
¶
media_sample_rate_hertz: int | None = None
The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
class-attribute
instance-attribute
¶
number_of_channels: int | None = None
Specify the number of channels in your audio stream. This value must be
2, as only two channels are supported. If your audio doesn't contain
multiple channels, do not include this parameter in your request.
If you include NumberOfChannels in your request, you must also include
EnableChannelIdentification.
class-attribute
instance-attribute
¶
session_id: str | None = None
Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.
class-attribute
instance-attribute
¶
show_speaker_label: bool = False
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization).
class-attribute
instance-attribute
¶
specialty: Specialty | None = None
Specify the medical specialty contained in your audio.
Output¶
This operation returns a DuplexEventStream for bidirectional streaming.
Event Stream Structure¶
Input Event Type¶
Output Event Type¶
Initial Response Structure¶
dataclass
¶
Dataclass for StartMedicalStreamTranscriptionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
content_identification_type: MedicalContentIdentificationType | None = None
Shows whether content identification was enabled for your transcription.
class-attribute
instance-attribute
¶
enable_channel_identification: bool = False
Shows whether channel identification was enabled for your transcription.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
Provides the language code that you specified in your request. This must
be en-US.
class-attribute
instance-attribute
¶
media_encoding: MediaEncoding | None = None
Provides the media encoding you specified in your request.
class-attribute
instance-attribute
¶
media_sample_rate_hertz: int | None = None
Provides the sample rate that you specified in your request.
class-attribute
instance-attribute
¶
number_of_channels: int | None = None
Provides the number of channels that you specified in your request.
class-attribute
instance-attribute
¶
request_id: str | None = None
Provides the identifier for your streaming request.
class-attribute
instance-attribute
¶
session_id: str | None = None
Provides the identifier for your transcription session.
class-attribute
instance-attribute
¶
show_speaker_label: bool = False
Shows whether speaker partitioning was enabled for your transcription.
class-attribute
instance-attribute
¶
specialty: Specialty | None = None
Provides the medical specialty that you specified in your request.