AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe and the transcription results are streamed to your application.

When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent.

After you send a MedicalScribeConfigurationEvent, you start AudioEvents and Amazon Web Services HealthScribe responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of END_OF_SESSION and Amazon Web Services HealthScribe starts the analytics.

You can pause or resume streaming. To pause streaming, complete the input stream without sending the MedicalScribeSessionControlEvent. To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream.

The following parameters are required:

For more information on streaming with Amazon Web Services HealthScribe, see Amazon Web Services HealthScribe.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

Namespace: Amazon.TranscribeStreaming
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<StartMedicalScribeStreamResponse> StartMedicalScribeStreamAsync(
         StartMedicalScribeStreamRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.TranscribeStreaming.Model.StartMedicalScribeStreamRequest

Container for the necessary parameters to execute the StartMedicalScribeStream service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StartMedicalScribeStream service method, as returned by TranscribeStreaming.

Exceptions

ExceptionCondition
BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the specified parameters and try your request again.
ConflictException A new stream started with the same session ID. The current stream has been terminated.
InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
ServiceUnavailableException The service is currently unavailable. Try your request later.

Version Information

.NET:
Supported in: 8.0 and newer

See Also