Transcribe Streaming¶
Client¶
AsyncTranscribeStreamingClient
¶
AsyncTranscribeStreamingClient(config: AsyncTranscribeStreamingConfig | None = None, plugins: list[Plugin] | None = None)
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
AsyncTranscribeStreamingConfig | None
|
Optional configuration for the client. Here you can set things like the endpoint for HTTP services or auth credentials. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables applied once to the client's base configuration. Their changes are inherited by every operation invocation. |
None
|
Operations¶
get_medical_scribe_streamstart_call_analytics_stream_transcriptionstart_medical_scribe_streamstart_medical_stream_transcriptionstart_stream_transcription
Configuration¶
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: 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
¶
The protocol to serialize and deserialize requests with.
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.
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: FileSystem | 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