Connect Health

{'inputStream': {'binaryAudioEvent': {'audioChunk': 'blob'}}}

Starts a new Medical Scribe listening session for real-time audio transcription

See also: AWS API Documentation

Request Syntax

client.start_medical_scribe_listening_session(
    sessionId='string',
    domainId='string',
    subscriptionId='string',
    languageCode='en-US',
    mediaSampleRateHertz=123,
    mediaEncoding='pcm'|'flac',
    inputStream={...}
)

type sessionId:

string

param sessionId:

[REQUIRED]

The Session identifier

type domainId:

string

param domainId:

[REQUIRED]

The Domain identifier

type subscriptionId:

string

param subscriptionId:

[REQUIRED]

The Subscription identifier

type languageCode:

string

param languageCode:

[REQUIRED]

The Language Code for the audio in the session

type mediaSampleRateHertz:

integer

param mediaSampleRateHertz:

[REQUIRED]

The sample rate of the input audio

type mediaEncoding:

string

param mediaEncoding:

[REQUIRED]

The encoding for the input audio

type inputStream:

dict

param inputStream:

rtype:

dict

returns:

The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.

Response Syntax

{
    'sessionId': 'string',
    'domainId': 'string',
    'subscriptionId': 'string',
    'requestId': 'string',
    'languageCode': 'en-US',
    'mediaSampleRateHertz': 123,
    'mediaEncoding': 'pcm'|'flac',
    'responseStream': EventStream({
        'transcriptEvent': {
            'transcriptSegment': {
                'segmentId': 'string',
                'audioBeginOffset': 123.0,
                'audioEndOffset': 123.0,
                'isPartial': True|False,
                'channelId': 'string',
                'content': 'string'
            }
        },
        'internalFailureException': {
            'message': 'string'
        },
        'validationException': {
            'message': 'string'
        }
    })
}

Response Structure

• (dict) --

  • sessionId (string) --

    The Session identifier

  • domainId (string) --

    The Domain identifier

  • subscriptionId (string) --

    The Subscription identifier

  • requestId (string) --

    The Request identifier

  • languageCode (string) --

    The Language Code for the audio in the session

  • mediaSampleRateHertz (integer) --

    The sample rate of the input audio

  • mediaEncoding (string) --

    The encoding for the input audio

  • responseStream (:class:`.EventStream`) --

    The output stream containing transcript events

    • transcriptEvent (dict) --

      • transcriptSegment (dict) --

        A segment of the transcript

        • segmentId (string) --

          The unique identifier for this segment

        • audioBeginOffset (float) --

          The offset from audio start when the audio for this segment begins

        • audioEndOffset (float) --

          The offset from audio start when the audio for this segment ends

        • isPartial (boolean) --

          Indicates whether this is a partial or final transcript

        • channelId (string) --

          The channel identifier for this segment

        • content (string) --

          The transcript text content

    • internalFailureException (dict) --

      • message (string) --

    • validationException (dict) --

      • message (string) --