Transcribe Streaming¶
Installation¶
To install the Transcribe Streaming client:
Bidirectional streaming¶
This client supports bidirectional event streams, which require the HTTP client from the AWS Common Runtime (CRT). To use this feature, install the package with the awscrt extra:
Then pass an AWSCRTHTTPClient instance as the transport when you resolve the config.
Clients¶
The package provides a synchronous client, TranscribeStreamingClient, and an asynchronous client, AsyncTranscribeStreamingClient. Both clients use the same models.
Operations that use event streams are available only on AsyncTranscribeStreamingClient. They are marked Async only under Operations.
TranscribeStreamingClient
¶
TranscribeStreamingClient(config: TranscribeStreamingConfig | None = None, plugins: list[Plugin] | None = None)
Bases: Client[TranscribeStreamingConfig]
Amazon Transcribe streaming offers four main types of real-time transcription: Standard, Medical, Call Analytics, and Health Scribe.
-
Standard transcriptions are the most common option. Refer to for details.
-
Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details.
-
Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.
-
HealthScribe transcriptions are designed to automatically create clinical notes from patient-clinician conversations using generative AI. Refer to [here] for details.
AsyncTranscribeStreamingClient
¶
AsyncTranscribeStreamingClient(config: AsyncTranscribeStreamingConfig | None = None, plugins: list[Plugin] | None = None)
Bases: AsyncClient[AsyncTranscribeStreamingConfig]
Amazon Transcribe streaming offers four main types of real-time transcription: Standard, Medical, Call Analytics, and Health Scribe.
-
Standard transcriptions are the most common option. Refer to for details.
-
Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details.
-
Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.
-
HealthScribe transcriptions are designed to automatically create clinical notes from patient-clinician conversations using generative AI. Refer to [here] for details.
Operations¶
get_medical_scribe_streamstart_call_analytics_stream_transcriptionAsync onlystart_medical_scribe_streamAsync onlystart_medical_stream_transcriptionAsync onlystart_stream_transcriptionAsync only
Configuration¶
TranscribeStreamingConfig
dataclass
¶
Bases: AwsConfig
Transcribe Streaming configuration.
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.protocols to select the protocol, e.g. protocol=AwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_dualstack_endpoint
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
classmethod
¶
resolve(*, profile: str | None = None, fs: FileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_TranscribeStreamingConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[TranscribeStreamingConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
AsyncTranscribeStreamingConfig
dataclass
¶
Bases: AsyncAwsConfig
Transcribe Streaming configuration (async-resolved).
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_dualstack_endpoint
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncTranscribeStreamingConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncTranscribeStreamingConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
AlternativeAudioEventCallAnalyticsEntityCallAnalyticsItemCallAnalyticsLanguageWithScoreCategoryEventChannelDefinitionCharacterOffsetsClinicalNoteGenerationResultClinicalNoteGenerationSettingsConfigurationEventEntityIssueDetectedItemLanguageWithScoreMedicalAlternativeMedicalEntityMedicalItemMedicalResultMedicalScribeAudioEventMedicalScribeChannelDefinitionMedicalScribeConfigurationEventMedicalScribeContextMedicalScribeEncryptionSettingsMedicalScribePatientContextMedicalScribePostStreamAnalyticsResultMedicalScribePostStreamAnalyticsSettingsMedicalScribeSessionControlEventMedicalScribeStreamDetailsMedicalScribeTranscriptEventMedicalScribeTranscriptItemMedicalScribeTranscriptSegmentMedicalTranscriptMedicalTranscriptEventPointsOfInterestPostCallAnalyticsSettingsResultTimestampRangeTranscriptTranscriptEventUtteranceEvent
Errors¶
BadRequestExceptionConflictExceptionInternalFailureExceptionLimitExceededExceptionResourceNotFoundExceptionServiceErrorServiceUnavailableException
Unions¶
AudioStreamCallAnalyticsTranscriptResultStreamMedicalScribeInputStreamMedicalScribeResultStreamMedicalTranscriptResultStreamTranscriptResultStream
Enums¶
CallAnalyticsLanguageCodeClinicalNoteGenerationStatusContentIdentificationTypeContentRedactionOutputContentRedactionTypeItemTypeLanguageCodeMediaEncodingMedicalContentIdentificationTypeMedicalScribeLanguageCodeMedicalScribeMediaEncodingMedicalScribeNoteTemplateMedicalScribeParticipantRoleMedicalScribeSessionControlEventTypeMedicalScribeStreamStatusMedicalScribeTranscriptItemTypeMedicalScribeVocabularyFilterMethodPartialResultsStabilityParticipantRolePronounsSentimentSpecialtyTranscriptFormatTypeVocabularyFilterMethod