ChimeSDKMeetings / Client / start_meeting_transcription

start_meeting_transcription#

ChimeSDKMeetings.Client.start_meeting_transcription(**kwargs)#

Starts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide.

If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide.

Warning

Amazon Chime SDK live transcription is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the AWS Service Terms, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services.

Request Syntax

response = client.start_meeting_transcription(
    MeetingId='string',
    TranscriptionConfiguration={
        'EngineTranscribeSettings': {
            'LanguageCode': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'th-TH'|'hi-IN',
            'VocabularyFilterMethod': 'remove'|'mask'|'tag',
            'VocabularyFilterName': 'string',
            'VocabularyName': 'string',
            'Region': 'us-east-2'|'us-east-1'|'us-west-2'|'ap-northeast-2'|'ap-southeast-2'|'ap-northeast-1'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'sa-east-1'|'auto'|'us-gov-west-1',
            'EnablePartialResultsStabilization': True|False,
            'PartialResultsStability': 'low'|'medium'|'high',
            'ContentIdentificationType': 'PII',
            'ContentRedactionType': 'PII',
            'PiiEntityTypes': 'string',
            'LanguageModelName': 'string',
            'IdentifyLanguage': True|False,
            'LanguageOptions': 'string',
            'PreferredLanguage': 'en-US'|'en-GB'|'es-US'|'fr-CA'|'fr-FR'|'en-AU'|'it-IT'|'de-DE'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'th-TH'|'hi-IN',
            'VocabularyNames': 'string',
            'VocabularyFilterNames': 'string'
        },
        'EngineTranscribeMedicalSettings': {
            'LanguageCode': 'en-US',
            'Specialty': 'PRIMARYCARE'|'CARDIOLOGY'|'NEUROLOGY'|'ONCOLOGY'|'RADIOLOGY'|'UROLOGY',
            'Type': 'CONVERSATION'|'DICTATION',
            'VocabularyName': 'string',
            'Region': 'us-east-1'|'us-east-2'|'us-west-2'|'ap-southeast-2'|'ca-central-1'|'eu-west-1'|'auto',
            'ContentIdentificationType': 'PHI'
        }
    }
)

Parameters:

MeetingId (string) –
[REQUIRED]

The unique ID of the meeting being transcribed.
TranscriptionConfiguration (dict) –
[REQUIRED]

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings.
- EngineTranscribeSettings (dict) –
  
  The transcription configuration settings passed to Amazon Transcribe.
  - LanguageCode (string) –
    
    Specify the language code that represents the language spoken.
    
    If you’re unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
  - VocabularyFilterMethod (string) –
    
    Specify how you want your vocabulary filter applied to your transcript.
    
    To replace words with ***, choose mask.
    
    To delete words, choose remove.
    
    To flag words without changing them, choose tag.
  - VocabularyFilterName (string) –
    
    Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
    
    If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
    
    If you include IdentifyLanguage and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.
  - VocabularyName (string) –
    
    Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
    
    If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
    
    If you include IdentifyLanguage and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.
  - Region (string) –
    
    The AWS Region in which to use Amazon Transcribe.
    
    If you don’t specify a Region, then the MediaRegion of the meeting is used. However, if Amazon Transcribe is not available in the MediaRegion, then a TranscriptFailed event is sent.
    
    Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion. For more information, refer to Choosing a transcription Region in the Amazon Chime SDK Developer Guide.
  - EnablePartialResultsStabilization (boolean) –
    
    Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
  - PartialResultsStability (string) –
    
    Specify the level of stability to use when you enable partial results stabilization ( EnablePartialResultsStabilization).
    
    Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
  - ContentIdentificationType (string) –
    
    Labels all personally identifiable information (PII) identified in your transcript. If you don’t include PiiEntityTypes, all PII is identified.
    
    Note
    You can’t set ContentIdentificationType and ContentRedactionType.
  - ContentRedactionType (string) –
    
    Content redaction is performed at the segment level. If you don’t include PiiEntityTypes, all PII is redacted.
    
    Note
    You can’t set ContentRedactionType and ContentIdentificationType.
  - PiiEntityTypes (string) –
    
    Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you’d like, or you can select ALL.
    
    Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.
    
    Note that if you include PiiEntityTypes, you must also include ContentIdentificationType or ContentRedactionType.
    
    If you include ContentRedactionType or ContentIdentificationType, but do not include PiiEntityTypes, all PII is redacted or identified.
  - LanguageModelName (string) –
    
    Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
    
    The language of the specified language model must match the language code. If the languages don’t match, the custom language model isn’t applied. There are no errors or warnings associated with a language mismatch.
    
    If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.
  - IdentifyLanguage (boolean) –
    
    Enables automatic language identification for your transcription.
    
    If you include IdentifyLanguage, you can optionally use LanguageOptions to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.
    
    You can also use PreferredLanguage to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.
    
    You must include either LanguageCode or IdentifyLanguage.
    
    Language identification can’t be combined with custom language models or redaction.
  - LanguageOptions (string) –
    
    Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you’re unsure what languages are present, do not include this parameter.
    
    Including language options can improve the accuracy of language identification.
    
    If you include LanguageOptions, you must also include IdentifyLanguage.
    
    Warning
    You can only include one language dialect per language. For example, you cannot include en-US and en-AU.
  - PreferredLanguage (string) –
    
    Specify a preferred language from the subset of languages codes you specified in LanguageOptions.
    
    You can only use this parameter if you include IdentifyLanguage and LanguageOptions.
  - VocabularyNames (string) –
    
    Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
    
    If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.
    
    If you don’t include IdentifyLanguage and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.
  - VocabularyFilterNames (string) –
    
    Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
    
    If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.
    
    If you’re not including IdentifyLanguage and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.
- EngineTranscribeMedicalSettings (dict) –
  
  The transcription configuration settings passed to Amazon Transcribe Medical.
  - LanguageCode (string) – [REQUIRED]
    
    The language code specified for the Amazon Transcribe Medical engine.
  - Specialty (string) – [REQUIRED]
    
    The specialty specified for the Amazon Transcribe Medical engine.
  - Type (string) – [REQUIRED]
    
    The type of transcription.
  - VocabularyName (string) –
    
    The name of the vocabulary passed to Amazon Transcribe Medical.
  - Region (string) –
    
    The AWS Region passed to Amazon Transcribe Medical. If you don’t specify a Region, Amazon Chime uses the meeting’s Region.
  - ContentIdentificationType (string) –
    
    Set this field to PHI to identify personal health information in the transcription output.

Returns:

None

Exceptions

ChimeSDKMeetings.Client.exceptions.NotFoundException
ChimeSDKMeetings.Client.exceptions.ForbiddenException
ChimeSDKMeetings.Client.exceptions.BadRequestException
ChimeSDKMeetings.Client.exceptions.UnauthorizedException
ChimeSDKMeetings.Client.exceptions.LimitExceededException
ChimeSDKMeetings.Client.exceptions.UnprocessableEntityException
ChimeSDKMeetings.Client.exceptions.ThrottlingException
ChimeSDKMeetings.Client.exceptions.ServiceUnavailableException
ChimeSDKMeetings.Client.exceptions.ServiceFailureException