aws-sdk-transcribestreamingservice 1.43.0 → 1.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -271,61 +271,109 @@ module Aws::TranscribeStreamingService
271
271
 
272
272
  # @!group API Operations
273
273
 
274
- # Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon
275
- # Transcribe Medical and the transcription results are streamed to your
276
- # application.
274
+ # Starts a bidirectional HTTP/2 or WebSocket stream where audio is
275
+ # streamed to Amazon Transcribe Medical and the transcription results
276
+ # are streamed to your application.
277
+ #
278
+ # For more information on streaming with Amazon Transcribe Medical, see
279
+ # [Transcribing streaming audio][1].
280
+ #
281
+ #
282
+ #
283
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
277
284
  #
278
285
  # @option params [required, String] :language_code
279
- # Indicates the source language used in the input audio stream. For
280
- # Amazon Transcribe Medical, this is US English (en-US).
286
+ # Specify the language code that represents the language spoken in your
287
+ # audio.
288
+ #
289
+ # Amazon Transcribe Medical only supports US English (`en-US`).
281
290
  #
282
291
  # @option params [required, Integer] :media_sample_rate_hertz
283
- # The sample rate of the input audio (in Hertz). Amazon Transcribe
284
- # medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
292
+ # The sample rate of the input audio (in hertz). Amazon Transcribe
293
+ # Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
285
294
  # sample rate you specify must match that of your audio.
286
295
  #
287
296
  # @option params [required, String] :media_encoding
288
- # The encoding used for the input audio.
297
+ # Specify the encoding used for the input audio. Supported formats are:
298
+ #
299
+ # * FLAC
300
+ #
301
+ # * OPUS-encoded audio in an Ogg container
302
+ #
303
+ # * PCM (only signed 16-bit little-endian audio formats, which does not
304
+ # include WAV)
305
+ #
306
+ # For more information, see [Media formats][1].
307
+ #
308
+ #
309
+ #
310
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
289
311
  #
290
312
  # @option params [String] :vocabulary_name
291
- # The name of the medical custom vocabulary to use when processing the
292
- # real-time stream.
313
+ # Specify the name of the custom vocabulary that you want to use when
314
+ # processing your transcription. Note that vocabulary names are case
315
+ # sensitive.
293
316
  #
294
317
  # @option params [required, String] :specialty
295
- # The medical specialty of the clinician or provider.
318
+ # Specify the medical specialty contained in your audio.
296
319
  #
297
320
  # @option params [required, String] :type
298
- # The type of input audio. Choose `DICTATION` for a provider dictating
299
- # patient notes. Choose `CONVERSATION` for a dialogue between a patient
300
- # and one or more medical professionanls.
321
+ # Specify the type of input audio. For example, choose `DICTATION` for a
322
+ # provider dictating patient notes and `CONVERSATION` for a dialogue
323
+ # between a patient and a medical professional.
301
324
  #
302
325
  # @option params [Boolean] :show_speaker_label
303
- # When `true`, enables speaker identification in your real-time stream.
326
+ # Enables speaker partitioning (diarization) in your transcription
327
+ # output. Speaker partitioning labels the speech from individual
328
+ # speakers in your media file.
329
+ #
330
+ # For more information, see [Partitioning speakers (diarization)][1].
331
+ #
332
+ #
333
+ #
334
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
304
335
  #
305
336
  # @option params [String] :session_id
306
- # Optional. An identifier for the transcription session. If you don't
307
- # provide a session ID, Amazon Transcribe generates one for you and
308
- # returns it in the response.
337
+ # Specify a name for your transcription session. If you don't include
338
+ # this parameter in your request, Amazon Transcribe Medical generates an
339
+ # ID and returns it in the response.
340
+ #
341
+ # You can use a session ID to retry a streaming session.
309
342
  #
310
343
  # @option params [Boolean] :enable_channel_identification
311
- # When `true`, instructs Amazon Transcribe Medical to process each audio
312
- # channel separately and then merge the transcription output of each
313
- # channel into a single transcription.
344
+ # Enables channel identification in multi-channel audio.
345
+ #
346
+ # Channel identification transcribes the audio on each channel
347
+ # independently, then appends the output for each channel into one
348
+ # transcript.
349
+ #
350
+ # If you have multi-channel audio and do not enable channel
351
+ # identification, your audio is transcribed in a continuous manner and
352
+ # your transcript is not separated by channel.
314
353
  #
315
- # Amazon Transcribe Medical also produces a transcription of each item.
316
- # An item includes the start time, end time, and any alternative
317
- # transcriptions.
354
+ # For more information, see [Transcribing multi-channel audio][1].
318
355
  #
319
- # You can't set both `ShowSpeakerLabel` and
320
- # `EnableChannelIdentification` in the same request. If you set both,
321
- # your request returns a `BadRequestException`.
356
+ #
357
+ #
358
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html
322
359
  #
323
360
  # @option params [Integer] :number_of_channels
324
- # The number of channels that are in your audio stream.
361
+ # Specify the number of channels in your audio stream. Up to two
362
+ # channels are supported.
325
363
  #
326
364
  # @option params [String] :content_identification_type
327
- # Set this field to `PHI` to identify personal health information in the
328
- # transcription output.
365
+ # Labels all personal health information (PHI) identified in your
366
+ # transcript.
367
+ #
368
+ # Content identification is performed at the segment level; PHI is
369
+ # flagged upon complete transcription of an audio segment.
370
+ #
371
+ # For more information, see [Identifying personal health information
372
+ # (PHI) in a transcription][1].
373
+ #
374
+ #
375
+ #
376
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html
329
377
  #
330
378
  # @return [Types::StartMedicalStreamTranscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
331
379
  #
@@ -438,7 +486,7 @@ module Aws::TranscribeStreamingService
438
486
  # @example Request syntax with placeholder values
439
487
  #
440
488
  # async_resp = async_client.start_medical_stream_transcription({
441
- # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
489
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
442
490
  # media_sample_rate_hertz: 1, # required
443
491
  # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
444
492
  # vocabulary_name: "VocabularyName",
@@ -459,7 +507,7 @@ module Aws::TranscribeStreamingService
459
507
  # @example Response structure
460
508
  #
461
509
  # resp.request_id #=> String
462
- # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
510
+ # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH"
463
511
  # resp.media_sample_rate_hertz #=> Integer
464
512
  # resp.media_encoding #=> String, one of "pcm", "ogg-opus", "flac"
465
513
  # resp.vocabulary_name #=> String
@@ -542,179 +590,331 @@ module Aws::TranscribeStreamingService
542
590
  req.send_request(options, &block)
543
591
  end
544
592
 
545
- # Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon
546
- # Transcribe and the transcription results are streamed to your
547
- # application.
593
+ # Starts a bidirectional HTTP/2 or WebSocket stream where audio is
594
+ # streamed to Amazon Transcribe and the transcription results are
595
+ # streamed to your application.
548
596
  #
549
- # The following are encoded as HTTP/2 headers:
597
+ # The following are encoded as headers:
550
598
  #
551
- # * x-amzn-transcribe-language-code
599
+ # * language-code
552
600
  #
553
- # * x-amzn-transcribe-media-encoding
601
+ # * media-encoding
554
602
  #
555
- # * x-amzn-transcribe-sample-rate
603
+ # * sample-rate
556
604
  #
557
- # * x-amzn-transcribe-session-id
605
+ # * session-id
558
606
  #
559
- # See the [ SDK for Go API Reference][1] for more detail.
607
+ # For more information on streaming with Amazon Transcribe, see
608
+ # [Transcribing streaming audio][1].
560
609
  #
561
610
  #
562
611
  #
563
- # [1]: https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/#TranscribeStreamingService.StartStreamTranscription
612
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
564
613
  #
565
614
  # @option params [String] :language_code
566
- # The language code of the input audio stream.
615
+ # Specify the language code that represents the language spoken in your
616
+ # audio.
617
+ #
618
+ # If you're unsure of the language spoken in your audio, consider using
619
+ # `IdentifyLanguage` to enable automatic language identification.
620
+ #
621
+ # For a list of languages supported with Amazon Transcribe streaming,
622
+ # refer to the [Supported languages][1] table.
623
+ #
624
+ #
625
+ #
626
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
567
627
  #
568
628
  # @option params [required, Integer] :media_sample_rate_hertz
569
- # The sample rate of the input audio (in Hertz). Low-quality audio, such
629
+ # The sample rate of the input audio (in hertz). Low-quality audio, such
570
630
  # as telephone audio, is typically around 8,000 Hz. High-quality audio
571
631
  # typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample
572
632
  # rate you specify must match that of your audio.
573
633
  #
574
634
  # @option params [required, String] :media_encoding
575
- # The encoding used for the input audio.
635
+ # Specify the encoding used for the input audio. Supported formats are:
636
+ #
637
+ # * FLAC
638
+ #
639
+ # * OPUS-encoded audio in an Ogg container
640
+ #
641
+ # * PCM (only signed 16-bit little-endian audio formats, which does not
642
+ # include WAV)
643
+ #
644
+ # For more information, see [Media formats][1].
645
+ #
646
+ #
647
+ #
648
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
576
649
  #
577
650
  # @option params [String] :vocabulary_name
578
- # The name of the custom vocabulary you want to use with your
579
- # transcription.
651
+ # Specify the name of the custom vocabulary that you want to use when
652
+ # processing your transcription. Note that vocabulary names are case
653
+ # sensitive.
580
654
  #
581
- # This operation is not intended for use in conjunction with the
582
- # `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
583
- # your request and want to use one or more custom vocabularies with your
584
- # transcription, use the `VocabularyNames` operation instead.
655
+ # If the language of the specified custom vocabulary doesn't match the
656
+ # language identified in your media, your job fails.
657
+ #
658
+ # This parameter is **not** intended for use with the `IdentifyLanguage`
659
+ # parameter. If you're including `IdentifyLanguage` in your request and
660
+ # want to use one or more custom vocabularies with your transcription,
661
+ # use the `VocabularyNames` parameter instead.
662
+ #
663
+ # For more information, see [Custom vocabularies][1].
664
+ #
665
+ #
666
+ #
667
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
585
668
  #
586
669
  # @option params [String] :session_id
587
- # A identifier for the transcription session. Use this parameter when
588
- # you want to retry a session. If you don't provide a session ID,
589
- # Amazon Transcribe will generate one for you and return it in the
590
- # response.
670
+ # Specify a name for your transcription session. If you don't include
671
+ # this parameter in your request, Amazon Transcribe generates an ID and
672
+ # returns it in the response.
673
+ #
674
+ # You can use a session ID to retry a streaming session.
591
675
  #
592
676
  # @option params [String] :vocabulary_filter_name
593
- # The name of the vocabulary filter you want to use with your
594
- # transcription.
677
+ # Specify the name of the custom vocabulary filter that you want to use
678
+ # when processing your transcription. Note that vocabulary filter names
679
+ # are case sensitive.
595
680
  #
596
- # This operation is not intended for use in conjunction with the
597
- # `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
598
- # your request and want to use one or more vocabulary filters with your
599
- # transcription, use the `VocabularyFilterNames` operation instead.
681
+ # If the language of the specified custom vocabulary filter doesn't
682
+ # match the language identified in your media, your job fails.
683
+ #
684
+ # This parameter is **not** intended for use with the `IdentifyLanguage`
685
+ # parameter. If you're including `IdentifyLanguage` in your request and
686
+ # want to use one or more vocabulary filters with your transcription,
687
+ # use the `VocabularyFilterNames` parameter instead.
688
+ #
689
+ # For more information, see [Using vocabulary filtering with unwanted
690
+ # words][1].
691
+ #
692
+ #
693
+ #
694
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
600
695
  #
601
696
  # @option params [String] :vocabulary_filter_method
602
- # The manner in which you use your vocabulary filter to filter words in
603
- # your transcript. `Remove` removes filtered words from your
604
- # transcription results. `Mask` masks filtered words with a `***` in
605
- # your transcription results. `Tag` keeps the filtered words in your
606
- # transcription results and tags them. The tag appears as
607
- # `VocabularyFilterMatch` equal to `True`.
697
+ # Specify how you want your vocabulary filter applied to your
698
+ # transcript.
699
+ #
700
+ # To replace words with `***`, choose `mask`.
701
+ #
702
+ # To delete words, choose `remove`.
703
+ #
704
+ # To flag words without changing them, choose `tag`.
608
705
  #
609
706
  # @option params [Boolean] :show_speaker_label
610
- # When `true`, enables speaker identification in your media stream.
707
+ # Enables speaker partitioning (diarization) in your transcription
708
+ # output. Speaker partitioning labels the speech from individual
709
+ # speakers in your media file.
710
+ #
711
+ # For more information, see [Partitioning speakers (diarization)][1].
712
+ #
713
+ #
714
+ #
715
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
611
716
  #
612
717
  # @option params [Boolean] :enable_channel_identification
613
- # When `true`, instructs Amazon Transcribe to process each audio channel
614
- # separately, then merges the transcription output of each channel into
615
- # a single transcription.
718
+ # Enables channel identification in multi-channel audio.
719
+ #
720
+ # Channel identification transcribes the audio on each channel
721
+ # independently, then appends the output for each channel into one
722
+ # transcript.
616
723
  #
617
- # Amazon Transcribe also produces a transcription of each item. An item
618
- # includes the start time, end time, and any alternative transcriptions.
724
+ # If you have multi-channel audio and do not enable channel
725
+ # identification, your audio is transcribed in a continuous manner and
726
+ # your transcript is not separated by channel.
727
+ #
728
+ # For more information, see [Transcribing multi-channel audio][1].
729
+ #
730
+ #
731
+ #
732
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html
619
733
  #
620
734
  # @option params [Integer] :number_of_channels
621
- # The number of channels that are in your audio stream.
735
+ # Specify the number of channels in your audio stream. Up to two
736
+ # channels are supported.
622
737
  #
623
738
  # @option params [Boolean] :enable_partial_results_stabilization
624
- # When `true`, instructs Amazon Transcribe to present transcription
625
- # results that have the partial results stabilized. Normally, any word
626
- # or phrase from one partial result can change in a subsequent partial
627
- # result. With partial results stabilization enabled, only the last few
628
- # words of one partial result can change in another partial result.
739
+ # Enables partial result stabilization for your transcription. Partial
740
+ # result stabilization can reduce latency in your output, but may impact
741
+ # accuracy. For more information, see [Partial-result stabilization][1].
742
+ #
743
+ #
744
+ #
745
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
629
746
  #
630
747
  # @option params [String] :partial_results_stability
631
- # You can use this field to set the stability level of the transcription
632
- # results. A higher stability level means that the transcription results
633
- # are less likely to change. Higher stability levels can come with lower
634
- # overall transcription accuracy.
748
+ # Specify the level of stability to use when you enable partial results
749
+ # stabilization (`EnablePartialResultsStabilization`).
750
+ #
751
+ # Low stability provides the highest accuracy. High stability
752
+ # transcribes faster, but with slightly lower accuracy.
753
+ #
754
+ # For more information, see [Partial-result stabilization][1].
755
+ #
756
+ #
757
+ #
758
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
635
759
  #
636
760
  # @option params [String] :content_identification_type
637
- # Set this field to PII to identify personally identifiable information
638
- # (PII) in the transcription output. Content identification is performed
639
- # only upon complete transcription of the audio segments.
761
+ # Labels all personally identifiable information (PII) identified in
762
+ # your transcript.
763
+ #
764
+ # Content identification is performed at the segment level; PII
765
+ # specified in `PiiEntityTypes` is flagged upon complete transcription
766
+ # of an audio segment.
767
+ #
768
+ # You can’t set `ContentIdentificationType` and `ContentRedactionType`
769
+ # in the same request. If you set both, your request returns a
770
+ # `BadRequestException`.
640
771
  #
641
- # You can’t set both `ContentIdentificationType` and
642
- # `ContentRedactionType` in the same request. If you set both, your
643
- # request returns a `BadRequestException`.
772
+ # For more information, see [Redacting or identifying personally
773
+ # identifiable information][1].
774
+ #
775
+ #
776
+ #
777
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
644
778
  #
645
779
  # @option params [String] :content_redaction_type
646
- # Set this field to PII to redact personally identifiable information
647
- # (PII) in the transcription output. Content redaction is performed only
648
- # upon complete transcription of the audio segments.
780
+ # Redacts all personally identifiable information (PII) identified in
781
+ # your transcript.
782
+ #
783
+ # Content redaction is performed at the segment level; PII specified in
784
+ # `PiiEntityTypes` is redacted upon complete transcription of an audio
785
+ # segment.
786
+ #
787
+ # You can’t set `ContentRedactionType` and `ContentIdentificationType`
788
+ # in the same request. If you set both, your request returns a
789
+ # `BadRequestException`.
790
+ #
791
+ # For more information, see [Redacting or identifying personally
792
+ # identifiable information][1].
649
793
  #
650
- # You can’t set both `ContentRedactionType` and
651
- # `ContentIdentificationType` in the same request. If you set both, your
652
- # request returns a `BadRequestException`.
794
+ #
795
+ #
796
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
653
797
  #
654
798
  # @option params [String] :pii_entity_types
655
- # List the PII entity types you want to identify or redact. In order to
656
- # specify entity types, you must have either `ContentIdentificationType`
657
- # or `ContentRedactionType` enabled.
799
+ # Specify which types of personally identifiable information (PII) you
800
+ # want to redact in your transcript. You can include as many types as
801
+ # you'd like, or you can select `ALL`.
658
802
  #
659
- # `PIIEntityTypes` must be comma-separated; the available values are:
660
- # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`,
661
- # `CREDIT_DEBIT_CVV`, `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, `ADDRESS`,
662
- # `NAME`, `PHONE`, `SSN`, and `ALL`.
803
+ # To include `PiiEntityTypes` in your request, you must also include
804
+ # either `ContentIdentificationType` or `ContentRedactionType`.
663
805
  #
664
- # `PiiEntityTypes` is an optional parameter with a default value of
665
- # `ALL`.
806
+ # Values must be comma-separated and can include: `BANK_ACCOUNT_NUMBER`,
807
+ # `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, `CREDIT_DEBIT_CVV`,
808
+ # `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, `ADDRESS`, `NAME`, `PHONE`,
809
+ # `SSN`, or `ALL`.
666
810
  #
667
811
  # @option params [String] :language_model_name
668
- # The name of the language model you want to use.
812
+ # Specify the name of the custom language model that you want to use
813
+ # when processing your transcription. Note that language model names are
814
+ # case sensitive.
815
+ #
816
+ # The language of the specified language model must match the language
817
+ # code you specify in your transcription request. If the languages
818
+ # don't match, the language model isn't applied. There are no errors
819
+ # or warnings associated with a language mismatch.
820
+ #
821
+ # For more information, see [Custom language models][1].
822
+ #
823
+ #
824
+ #
825
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
669
826
  #
670
827
  # @option params [Boolean] :identify_language
671
- # Optional. Set this value to `true` to enable language identification
672
- # for your media stream.
828
+ # Enables automatic language identification for your transcription.
829
+ #
830
+ # If you include `IdentifyLanguage`, you can optionally include a list
831
+ # of language codes, using `LanguageOptions`, that you think may be
832
+ # present in your audio stream. Including language options can improve
833
+ # transcription accuracy.
834
+ #
835
+ # You can also include a preferred language using `PreferredLanguage`.
836
+ # Adding a preferred language can help Amazon Transcribe identify the
837
+ # language faster than if you omit this parameter.
838
+ #
839
+ # If you have multi-channel audio that contains different languages on
840
+ # each channel, and you've enabled channel identification, automatic
841
+ # language identification identifies the dominant language on each audio
842
+ # channel.
843
+ #
844
+ # Note that you must include either `LanguageCode` or `IdentifyLanguage`
845
+ # in your request. If you include both parameters, your request fails.
846
+ #
847
+ # Streaming language identification can't be combined with custom
848
+ # language models or redaction.
673
849
  #
674
850
  # @option params [String] :language_options
675
- # An object containing a list of languages that might be present in your
676
- # audio.
851
+ # Specify two or more language codes that represent the languages you
852
+ # think may be present in your media; including more than five is not
853
+ # recommended. If you're unsure what languages are present, do not
854
+ # include this parameter.
677
855
  #
678
- # You must provide two or more language codes to help Amazon Transcribe
679
- # identify the correct language of your media stream with the highest
680
- # possible accuracy. You can only select one variant per language; for
681
- # example, you can't include both `en-US` and `en-UK` in the same
682
- # request.
856
+ # Including language options can improve the accuracy of language
857
+ # identification.
683
858
  #
684
- # You can only use this parameter if you've set `IdentifyLanguage` to
685
- # `true`in your request.
859
+ # If you include `LanguageOptions` in your request, you must also
860
+ # include `IdentifyLanguage`.
861
+ #
862
+ # For a list of languages supported with Amazon Transcribe streaming,
863
+ # refer to the [Supported languages][1] table.
864
+ #
865
+ # You can only include one language dialect per language per stream. For
866
+ # example, you cannot include `en-US` and `en-AU` in the same request.
867
+ #
868
+ #
869
+ #
870
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
686
871
  #
687
872
  # @option params [String] :preferred_language
688
- # Optional. From the subset of languages codes you provided for
689
- # `LanguageOptions`, you can select one preferred language for your
690
- # transcription.
873
+ # Specify a preferred language from the subset of languages codes you
874
+ # specified in `LanguageOptions`.
691
875
  #
692
- # You can only use this parameter if you've set `IdentifyLanguage` to
693
- # `true`in your request.
876
+ # You can only use this parameter if you've included `IdentifyLanguage`
877
+ # and `LanguageOptions` in your request.
694
878
  #
695
879
  # @option params [String] :vocabulary_names
696
- # The names of the custom vocabularies you want to use with your
697
- # transcription.
880
+ # Specify the names of the custom vocabularies that you want to use when
881
+ # processing your transcription. Note that vocabulary names are case
882
+ # sensitive.
883
+ #
884
+ # If none of the languages of the specified custom vocabularies match
885
+ # the language identified in your media, your job fails.
886
+ #
887
+ # This parameter is only intended for use **with** the
888
+ # `IdentifyLanguage` parameter. If you're **not** including
889
+ # `IdentifyLanguage` in your request and want to use a custom vocabulary
890
+ # with your transcription, use the `VocabularyName` parameter instead.
698
891
  #
699
- # Note that if the custom vocabularies you specify are in languages that
700
- # don't match the language identified in your media, your job fails.
892
+ # For more information, see [Custom vocabularies][1].
701
893
  #
702
- # This operation is only intended for use in conjunction with the
703
- # `IdentifyLanguage` operation. If you're not using `IdentifyLanguage`
704
- # in your request and want to use a custom vocabulary with your
705
- # transcription, use the `VocabularyName` operation instead.
894
+ #
895
+ #
896
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
706
897
  #
707
898
  # @option params [String] :vocabulary_filter_names
708
- # The names of the vocabulary filters you want to use with your
709
- # transcription.
899
+ # Specify the names of the custom vocabulary filters that you want to
900
+ # use when processing your transcription. Note that vocabulary filter
901
+ # names are case sensitive.
902
+ #
903
+ # If none of the languages of the specified custom vocabulary filters
904
+ # match the language identified in your media, your job fails.
905
+ #
906
+ # This parameter is only intended for use **with** the
907
+ # `IdentifyLanguage` parameter. If you're **not** including
908
+ # `IdentifyLanguage` in your request and want to use a custom vocabulary
909
+ # filter with your transcription, use the `VocabularyFilterName`
910
+ # parameter instead.
911
+ #
912
+ # For more information, see [Using vocabulary filtering with unwanted
913
+ # words][1].
914
+ #
710
915
  #
711
- # Note that if the vocabulary filters you specify are in languages that
712
- # don't match the language identified in your media, your job fails.
713
916
  #
714
- # This operation is only intended for use in conjunction with the
715
- # `IdentifyLanguage` operation. If you're not using `IdentifyLanguage`
716
- # in your request and want to use a vocabulary filter with your
717
- # transcription, use the `VocabularyFilterName` operation instead.
917
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
718
918
  #
719
919
  # @return [Types::StartStreamTranscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
720
920
  #
@@ -837,7 +1037,7 @@ module Aws::TranscribeStreamingService
837
1037
  # @example Request syntax with placeholder values
838
1038
  #
839
1039
  # async_resp = async_client.start_stream_transcription({
840
- # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
1040
+ # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
841
1041
  # media_sample_rate_hertz: 1, # required
842
1042
  # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
843
1043
  # vocabulary_name: "VocabularyName",
@@ -856,7 +1056,7 @@ module Aws::TranscribeStreamingService
856
1056
  # language_model_name: "ModelName",
857
1057
  # identify_language: false,
858
1058
  # language_options: "LanguageOptions",
859
- # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
1059
+ # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
860
1060
  # vocabulary_names: "VocabularyNames",
861
1061
  # vocabulary_filter_names: "VocabularyFilterNames",
862
1062
  # })
@@ -868,7 +1068,7 @@ module Aws::TranscribeStreamingService
868
1068
  # @example Response structure
869
1069
  #
870
1070
  # resp.request_id #=> String
871
- # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
1071
+ # resp.language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH"
872
1072
  # resp.media_sample_rate_hertz #=> Integer
873
1073
  # resp.media_encoding #=> String, one of "pcm", "ogg-opus", "flac"
874
1074
  # resp.vocabulary_name #=> String
@@ -902,9 +1102,9 @@ module Aws::TranscribeStreamingService
902
1102
  # event.transcript.results[0].alternatives[0].entities[0].content #=> String
903
1103
  # event.transcript.results[0].alternatives[0].entities[0].confidence #=> Float
904
1104
  # event.transcript.results[0].channel_id #=> String
905
- # event.transcript.results[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
1105
+ # event.transcript.results[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH"
906
1106
  # event.transcript.results[0].language_identification #=> Array
907
- # event.transcript.results[0].language_identification[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
1107
+ # event.transcript.results[0].language_identification[0].language_code #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH"
908
1108
  # event.transcript.results[0].language_identification[0].score #=> Float
909
1109
  #
910
1110
  # For :bad_request_exception event available at #on_bad_request_exception_event callback and response eventstream enumerator:
@@ -935,7 +1135,7 @@ module Aws::TranscribeStreamingService
935
1135
  # resp.language_model_name #=> String
936
1136
  # resp.identify_language #=> Boolean
937
1137
  # resp.language_options #=> String
938
- # resp.preferred_language #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
1138
+ # resp.preferred_language #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "hi-IN", "th-TH"
939
1139
  # resp.vocabulary_names #=> String
940
1140
  # resp.vocabulary_filter_names #=> String
941
1141
  #
@@ -982,7 +1182,7 @@ module Aws::TranscribeStreamingService
982
1182
  http_response: Seahorse::Client::Http::AsyncResponse.new,
983
1183
  config: config)
984
1184
  context[:gem_name] = 'aws-sdk-transcribestreamingservice'
985
- context[:gem_version] = '1.43.0'
1185
+ context[:gem_version] = '1.44.0'
986
1186
  Seahorse::Client::Request.new(handlers, context)
987
1187
  end
988
1188