@aws-sdk/client-transcribe-streaming 3.28.0 → 3.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/TranscribeStreaming.ts +3 -2
  3. package/commands/StartStreamTranscriptionCommand.ts +3 -2
  4. package/dist/cjs/TranscribeStreaming.js.map +1 -1
  5. package/dist/cjs/commands/StartStreamTranscriptionCommand.js +3 -2
  6. package/dist/cjs/commands/StartStreamTranscriptionCommand.js.map +1 -1
  7. package/dist/cjs/endpoints.js +22 -1
  8. package/dist/cjs/endpoints.js.map +1 -1
  9. package/dist/cjs/models/models_0.js +18 -1
  10. package/dist/cjs/models/models_0.js.map +1 -1
  11. package/dist/cjs/package.json +37 -37
  12. package/dist/cjs/protocols/Aws_restJson1.js +61 -17
  13. package/dist/cjs/protocols/Aws_restJson1.js.map +1 -1
  14. package/dist/es/TranscribeStreaming.js.map +1 -1
  15. package/dist/es/commands/StartStreamTranscriptionCommand.js +3 -2
  16. package/dist/es/commands/StartStreamTranscriptionCommand.js.map +1 -1
  17. package/dist/es/endpoints.js +23 -3
  18. package/dist/es/endpoints.js.map +1 -1
  19. package/dist/es/models/models_0.js +15 -0
  20. package/dist/es/models/models_0.js.map +1 -1
  21. package/dist/es/package.json +37 -37
  22. package/dist/es/protocols/Aws_restJson1.js +60 -19
  23. package/dist/es/protocols/Aws_restJson1.js.map +1 -1
  24. package/dist/types/TranscribeStreaming.d.ts +3 -2
  25. package/dist/types/commands/StartStreamTranscriptionCommand.d.ts +3 -2
  26. package/dist/types/models/models_0.d.ts +98 -17
  27. package/dist/types/ts3.4/TranscribeStreaming.d.ts +3 -2
  28. package/dist/types/ts3.4/commands/StartStreamTranscriptionCommand.d.ts +3 -2
  29. package/dist/types/ts3.4/models/models_0.d.ts +98 -17
  30. package/endpoints.ts +22 -1
  31. package/models/models_0.ts +116 -17
  32. package/package.json +37 -37
  33. package/protocols/Aws_restJson1.ts +67 -19
@@ -7,9 +7,9 @@ export interface StartStreamTranscriptionCommandInput extends StartStreamTranscr
7
7
  export interface StartStreamTranscriptionCommandOutput extends StartStreamTranscriptionResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Starts a bidirectional HTTP2 stream where audio is streamed to Amazon Transcribe and the transcription
10
+ * <p>Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription
11
11
  * results are streamed to your application.</p>
12
- * <p>The following are encoded as HTTP2 headers:</p>
12
+ * <p>The following are encoded as HTTP/2 headers:</p>
13
13
  * <ul>
14
14
  * <li>
15
15
  * <p>x-amzn-transcribe-language-code</p>
@@ -24,6 +24,7 @@ export interface StartStreamTranscriptionCommandOutput extends StartStreamTransc
24
24
  * <p>x-amzn-transcribe-session-id</p>
25
25
  * </li>
26
26
  * </ul>
27
+ * <p>See the <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/#TranscribeStreamingService.StartStreamTranscription"> SDK for Go API Reference</a> for more detail.</p>
27
28
  * @example
28
29
  * Use a bare-bones client and the command you need to make an API call.
29
30
  * ```javascript
@@ -1,4 +1,39 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
+ /**
3
+ * <p>The entity identified as personally identifiable information (PII).</p>
4
+ */
5
+ export interface Entity {
6
+ /**
7
+ * <p>The start time of speech that was identified as PII.</p>
8
+ */
9
+ StartTime?: number;
10
+ /**
11
+ * <p>The end time of speech that was identified as PII.</p>
12
+ */
13
+ EndTime?: number;
14
+ /**
15
+ * <p>The category of of information identified in this entity; for example, PII.</p>
16
+ */
17
+ Category?: string;
18
+ /**
19
+ * <p>The type of PII identified in this entity; for example, name or credit card number.</p>
20
+ */
21
+ Type?: string;
22
+ /**
23
+ * <p>The words in the transcription output that have been identified as a PII entity.</p>
24
+ */
25
+ Content?: string;
26
+ /**
27
+ * <p>A value between zero and one that Amazon Transcribe assigns to PII identified in the source audio. Larger values indicate a higher confidence in PII identification.</p>
28
+ */
29
+ Confidence?: number;
30
+ }
31
+ export declare namespace Entity {
32
+ /**
33
+ * @internal
34
+ */
35
+ const filterSensitiveLog: (obj: Entity) => any;
36
+ }
2
37
  export declare enum ItemType {
3
38
  PRONUNCIATION = "pronunciation",
4
39
  PUNCTUATION = "punctuation"
@@ -67,6 +102,10 @@ export interface Alternative {
67
102
  * <p>One or more alternative interpretations of the input audio. </p>
68
103
  */
69
104
  Items?: Item[];
105
+ /**
106
+ * <p>Contains the entities identified as personally identifiable information (PII) in the transcription output.</p>
107
+ */
108
+ Entities?: Entity[];
70
109
  }
71
110
  export declare namespace Alternative {
72
111
  /**
@@ -76,8 +115,10 @@ export declare namespace Alternative {
76
115
  }
77
116
  /**
78
117
  * <p>Provides a wrapper for the audio chunks that you are sending.</p>
79
- * <p>For information on audio encoding in Amazon Transcribe, see <a>input</a>. For information
80
- * on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
118
+ * <p>For information on audio encoding in Amazon Transcribe, see
119
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input.html">Speech input</a>. For information
120
+ * on audio encoding formats in Amazon Transcribe Medical, see
121
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
81
122
  */
82
123
  export interface AudioEvent {
83
124
  /**
@@ -100,10 +141,10 @@ export declare namespace AudioStream {
100
141
  /**
101
142
  * <p>A blob of audio from your application. You audio stream consists of one or more audio
102
143
  * events.</p>
103
- * <p>For information on audio encoding formats in Amazon Transcribe, see <a>input</a>. For
104
- * information on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
105
- * <p>For more information on stream encoding in Amazon Transcribe, see <a>event-stream</a>. For
106
- * information on stream encoding in Amazon Transcribe Medical, see <a>event-stream-med</a>.</p>
144
+ * <p>For information on audio encoding formats in Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input.html">Speech input</a>. For
145
+ * information on audio encoding formats in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
146
+ * <p>For more information on stream encoding in Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>. For
147
+ * information on stream encoding in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream-med.html">Event stream encoding</a>.</p>
107
148
  */
108
149
  interface AudioEventMember {
109
150
  AudioEvent: AudioEvent;
@@ -158,6 +199,12 @@ export declare namespace ConflictException {
158
199
  */
159
200
  const filterSensitiveLog: (obj: ConflictException) => any;
160
201
  }
202
+ export declare enum ContentIdentificationType {
203
+ PII = "PII"
204
+ }
205
+ export declare enum ContentRedactionType {
206
+ PII = "PII"
207
+ }
161
208
  /**
162
209
  * <p>A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try
163
210
  * your request again.</p>
@@ -594,8 +641,7 @@ export interface StartMedicalStreamTranscriptionRequest {
594
641
  */
595
642
  LanguageCode: LanguageCode | string | undefined;
596
643
  /**
597
- * <p>The sample rate of the input audio in Hertz. Sample rates of 16000 Hz or higher are
598
- * accepted.</p>
644
+ * <p>The sample rate of the input audio in Hertz.</p>
599
645
  */
600
646
  MediaSampleRateHertz: number | undefined;
601
647
  /**
@@ -668,7 +714,7 @@ export interface StartMedicalStreamTranscriptionResponse {
668
714
  */
669
715
  LanguageCode?: LanguageCode | string;
670
716
  /**
671
- * <p>The sample rate of the input audio in Hertz. Valid value: 16000 Hz.</p>
717
+ * <p>The sample rate of the input audio in Hertz.</p>
672
718
  */
673
719
  MediaSampleRateHertz?: number;
674
720
  /**
@@ -731,8 +777,8 @@ export interface StartStreamTranscriptionRequest {
731
777
  */
732
778
  LanguageCode: LanguageCode | string | undefined;
733
779
  /**
734
- * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low
735
- * quality audio and 16000 Hz for high quality audio.</p>
780
+ * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8,000 Hz for low
781
+ * quality audio and 16,000 Hz for high quality audio.</p>
736
782
  */
737
783
  MediaSampleRateHertz: number | undefined;
738
784
  /**
@@ -750,19 +796,19 @@ export interface StartStreamTranscriptionRequest {
750
796
  */
751
797
  SessionId?: string;
752
798
  /**
753
- * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data
799
+ * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data
754
800
  * frame.</p>
755
801
  */
756
802
  AudioStream: AsyncIterable<AudioStream> | undefined;
757
803
  /**
758
- * <p>The name of the vocabulary filter you've created that is unique to your AWS account.
804
+ * <p>The name of the vocabulary filter you've created that is unique to your account.
759
805
  * Provide the name in this field to successfully use it in a stream.</p>
760
806
  */
761
807
  VocabularyFilterName?: string;
762
808
  /**
763
809
  * <p>The manner in which you use your vocabulary filter to filter words in your transcript.
764
810
  * <code>Remove</code> removes filtered words from your transcription results.
765
- * <code>Mask</code> masks those words with a <code>***</code> in your transcription results.
811
+ * <code>Mask</code> masks filtered words with a <code>***</code> in your transcription results.
766
812
  * <code>Tag</code> keeps the filtered words in your transcription results and tags them. The
767
813
  * tag appears as <code>VocabularyFilterMatch</code> equal to <code>True</code>
768
814
  * </p>
@@ -799,6 +845,30 @@ export interface StartStreamTranscriptionRequest {
799
845
  * stability levels can come with lower overall transcription accuracy.</p>
800
846
  */
801
847
  PartialResultsStability?: PartialResultsStability | string;
848
+ /**
849
+ * <p>Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.</p>
850
+ * <p>You can’t set both <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
851
+ */
852
+ ContentIdentificationType?: ContentIdentificationType | string;
853
+ /**
854
+ * <p>Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.</p>
855
+ * <p>You can’t set both <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
856
+ */
857
+ ContentRedactionType?: ContentRedactionType | string;
858
+ /**
859
+ * <p>List the PII entity types you want to identify or redact. In order to specify entity types, you must have
860
+ * either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code> enabled.</p>
861
+ * <p>
862
+ * <code>PIIEntityTypes</code> must be comma-separated; the available values are:
863
+ * <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>,
864
+ * <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>,
865
+ * <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
866
+ * <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
867
+ * <code>SSN</code>, and <code>ALL</code>.</p>
868
+ * <p>
869
+ * <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>
870
+ */
871
+ PiiEntityTypes?: string;
802
872
  }
803
873
  export declare namespace StartStreamTranscriptionRequest {
804
874
  /**
@@ -848,8 +918,7 @@ export declare namespace TranscriptResultStream {
848
918
  /**
849
919
  * <p>A portion of the transcription of the audio stream. Events are sent periodically from
850
920
  * Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio
851
- * stream, or it can be the entire transcription of that portion of the audio stream.
852
- * </p>
921
+ * stream, or it can be the entire transcription of that portion of the audio stream. </p>
853
922
  */
854
923
  interface TranscriptEventMember {
855
924
  TranscriptEvent: TranscriptEvent;
@@ -960,7 +1029,7 @@ export interface StartStreamTranscriptionResponse {
960
1029
  */
961
1030
  LanguageCode?: LanguageCode | string;
962
1031
  /**
963
- * <p>The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz
1032
+ * <p>The sample rate for the input audio stream. Use 8,000 Hz for low quality audio and 16,000 Hz
964
1033
  * for high quality audio.</p>
965
1034
  */
966
1035
  MediaSampleRateHertz?: number;
@@ -1009,6 +1078,18 @@ export interface StartStreamTranscriptionResponse {
1009
1078
  * level.</p>
1010
1079
  */
1011
1080
  PartialResultsStability?: PartialResultsStability | string;
1081
+ /**
1082
+ * <p>Shows whether content identification was enabled in this stream.</p>
1083
+ */
1084
+ ContentIdentificationType?: ContentIdentificationType | string;
1085
+ /**
1086
+ * <p>Shows whether content redaction was enabled in this stream.</p>
1087
+ */
1088
+ ContentRedactionType?: ContentRedactionType | string;
1089
+ /**
1090
+ * <p>Lists the PII entity types you specified in your request.</p>
1091
+ */
1092
+ PiiEntityTypes?: string;
1012
1093
  }
1013
1094
  export declare namespace StartStreamTranscriptionResponse {
1014
1095
  /**
package/endpoints.ts CHANGED
@@ -1,7 +1,24 @@
1
1
  import { PartitionHash, RegionHash, getRegionInfo } from "@aws-sdk/config-resolver";
2
2
  import { RegionInfoProvider } from "@aws-sdk/types";
3
3
 
4
- const regionHash: RegionHash = {};
4
+ const regionHash: RegionHash = {
5
+ "transcribestreaming-fips-ca-central-1": {
6
+ hostname: "transcribestreaming-fips.ca-central-1.amazonaws.com",
7
+ signingRegion: "ca-central-1",
8
+ },
9
+ "transcribestreaming-fips-us-east-1": {
10
+ hostname: "transcribestreaming-fips.us-east-1.amazonaws.com",
11
+ signingRegion: "us-east-1",
12
+ },
13
+ "transcribestreaming-fips-us-east-2": {
14
+ hostname: "transcribestreaming-fips.us-east-2.amazonaws.com",
15
+ signingRegion: "us-east-2",
16
+ },
17
+ "transcribestreaming-fips-us-west-2": {
18
+ hostname: "transcribestreaming-fips.us-west-2.amazonaws.com",
19
+ signingRegion: "us-west-2",
20
+ },
21
+ };
5
22
 
6
23
  const partitionHash: PartitionHash = {
7
24
  aws: {
@@ -23,6 +40,10 @@ const partitionHash: PartitionHash = {
23
40
  "eu-west-3",
24
41
  "me-south-1",
25
42
  "sa-east-1",
43
+ "transcribestreaming-fips-ca-central-1",
44
+ "transcribestreaming-fips-us-east-1",
45
+ "transcribestreaming-fips-us-east-2",
46
+ "transcribestreaming-fips-us-west-2",
26
47
  "us-east-1",
27
48
  "us-east-2",
28
49
  "us-west-1",
@@ -1,5 +1,49 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
2
 
3
+ /**
4
+ * <p>The entity identified as personally identifiable information (PII).</p>
5
+ */
6
+ export interface Entity {
7
+ /**
8
+ * <p>The start time of speech that was identified as PII.</p>
9
+ */
10
+ StartTime?: number;
11
+
12
+ /**
13
+ * <p>The end time of speech that was identified as PII.</p>
14
+ */
15
+ EndTime?: number;
16
+
17
+ /**
18
+ * <p>The category of of information identified in this entity; for example, PII.</p>
19
+ */
20
+ Category?: string;
21
+
22
+ /**
23
+ * <p>The type of PII identified in this entity; for example, name or credit card number.</p>
24
+ */
25
+ Type?: string;
26
+
27
+ /**
28
+ * <p>The words in the transcription output that have been identified as a PII entity.</p>
29
+ */
30
+ Content?: string;
31
+
32
+ /**
33
+ * <p>A value between zero and one that Amazon Transcribe assigns to PII identified in the source audio. Larger values indicate a higher confidence in PII identification.</p>
34
+ */
35
+ Confidence?: number;
36
+ }
37
+
38
+ export namespace Entity {
39
+ /**
40
+ * @internal
41
+ */
42
+ export const filterSensitiveLog = (obj: Entity): any => ({
43
+ ...obj,
44
+ });
45
+ }
46
+
3
47
  export enum ItemType {
4
48
  PRONUNCIATION = "pronunciation",
5
49
  PUNCTUATION = "punctuation",
@@ -81,6 +125,11 @@ export interface Alternative {
81
125
  * <p>One or more alternative interpretations of the input audio. </p>
82
126
  */
83
127
  Items?: Item[];
128
+
129
+ /**
130
+ * <p>Contains the entities identified as personally identifiable information (PII) in the transcription output.</p>
131
+ */
132
+ Entities?: Entity[];
84
133
  }
85
134
 
86
135
  export namespace Alternative {
@@ -94,8 +143,10 @@ export namespace Alternative {
94
143
 
95
144
  /**
96
145
  * <p>Provides a wrapper for the audio chunks that you are sending.</p>
97
- * <p>For information on audio encoding in Amazon Transcribe, see <a>input</a>. For information
98
- * on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
146
+ * <p>For information on audio encoding in Amazon Transcribe, see
147
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input.html">Speech input</a>. For information
148
+ * on audio encoding formats in Amazon Transcribe Medical, see
149
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
99
150
  */
100
151
  export interface AudioEvent {
101
152
  /**
@@ -123,10 +174,10 @@ export namespace AudioStream {
123
174
  /**
124
175
  * <p>A blob of audio from your application. You audio stream consists of one or more audio
125
176
  * events.</p>
126
- * <p>For information on audio encoding formats in Amazon Transcribe, see <a>input</a>. For
127
- * information on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
128
- * <p>For more information on stream encoding in Amazon Transcribe, see <a>event-stream</a>. For
129
- * information on stream encoding in Amazon Transcribe Medical, see <a>event-stream-med</a>.</p>
177
+ * <p>For information on audio encoding formats in Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input.html">Speech input</a>. For
178
+ * information on audio encoding formats in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html">Speech input</a>.</p>
179
+ * <p>For more information on stream encoding in Amazon Transcribe, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>. For
180
+ * information on stream encoding in Amazon Transcribe Medical, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream-med.html">Event stream encoding</a>.</p>
130
181
  */
131
182
  export interface AudioEventMember {
132
183
  AudioEvent: AudioEvent;
@@ -197,6 +248,14 @@ export namespace ConflictException {
197
248
  });
198
249
  }
199
250
 
251
+ export enum ContentIdentificationType {
252
+ PII = "PII",
253
+ }
254
+
255
+ export enum ContentRedactionType {
256
+ PII = "PII",
257
+ }
258
+
200
259
  /**
201
260
  * <p>A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try
202
261
  * your request again.</p>
@@ -742,8 +801,7 @@ export interface StartMedicalStreamTranscriptionRequest {
742
801
  LanguageCode: LanguageCode | string | undefined;
743
802
 
744
803
  /**
745
- * <p>The sample rate of the input audio in Hertz. Sample rates of 16000 Hz or higher are
746
- * accepted.</p>
804
+ * <p>The sample rate of the input audio in Hertz.</p>
747
805
  */
748
806
  MediaSampleRateHertz: number | undefined;
749
807
 
@@ -833,7 +891,7 @@ export interface StartMedicalStreamTranscriptionResponse {
833
891
  LanguageCode?: LanguageCode | string;
834
892
 
835
893
  /**
836
- * <p>The sample rate of the input audio in Hertz. Valid value: 16000 Hz.</p>
894
+ * <p>The sample rate of the input audio in Hertz.</p>
837
895
  */
838
896
  MediaSampleRateHertz?: number;
839
897
 
@@ -913,8 +971,8 @@ export interface StartStreamTranscriptionRequest {
913
971
  LanguageCode: LanguageCode | string | undefined;
914
972
 
915
973
  /**
916
- * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low
917
- * quality audio and 16000 Hz for high quality audio.</p>
974
+ * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8,000 Hz for low
975
+ * quality audio and 16,000 Hz for high quality audio.</p>
918
976
  */
919
977
  MediaSampleRateHertz: number | undefined;
920
978
 
@@ -936,13 +994,13 @@ export interface StartStreamTranscriptionRequest {
936
994
  SessionId?: string;
937
995
 
938
996
  /**
939
- * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data
997
+ * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data
940
998
  * frame.</p>
941
999
  */
942
1000
  AudioStream: AsyncIterable<AudioStream> | undefined;
943
1001
 
944
1002
  /**
945
- * <p>The name of the vocabulary filter you've created that is unique to your AWS account.
1003
+ * <p>The name of the vocabulary filter you've created that is unique to your account.
946
1004
  * Provide the name in this field to successfully use it in a stream.</p>
947
1005
  */
948
1006
  VocabularyFilterName?: string;
@@ -950,7 +1008,7 @@ export interface StartStreamTranscriptionRequest {
950
1008
  /**
951
1009
  * <p>The manner in which you use your vocabulary filter to filter words in your transcript.
952
1010
  * <code>Remove</code> removes filtered words from your transcription results.
953
- * <code>Mask</code> masks those words with a <code>***</code> in your transcription results.
1011
+ * <code>Mask</code> masks filtered words with a <code>***</code> in your transcription results.
954
1012
  * <code>Tag</code> keeps the filtered words in your transcription results and tags them. The
955
1013
  * tag appears as <code>VocabularyFilterMatch</code> equal to <code>True</code>
956
1014
  * </p>
@@ -992,6 +1050,33 @@ export interface StartStreamTranscriptionRequest {
992
1050
  * stability levels can come with lower overall transcription accuracy.</p>
993
1051
  */
994
1052
  PartialResultsStability?: PartialResultsStability | string;
1053
+
1054
+ /**
1055
+ * <p>Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.</p>
1056
+ * <p>You can’t set both <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
1057
+ */
1058
+ ContentIdentificationType?: ContentIdentificationType | string;
1059
+
1060
+ /**
1061
+ * <p>Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.</p>
1062
+ * <p>You can’t set both <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
1063
+ */
1064
+ ContentRedactionType?: ContentRedactionType | string;
1065
+
1066
+ /**
1067
+ * <p>List the PII entity types you want to identify or redact. In order to specify entity types, you must have
1068
+ * either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code> enabled.</p>
1069
+ * <p>
1070
+ * <code>PIIEntityTypes</code> must be comma-separated; the available values are:
1071
+ * <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>,
1072
+ * <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>,
1073
+ * <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
1074
+ * <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
1075
+ * <code>SSN</code>, and <code>ALL</code>.</p>
1076
+ * <p>
1077
+ * <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>
1078
+ */
1079
+ PiiEntityTypes?: string;
995
1080
  }
996
1081
 
997
1082
  export namespace StartStreamTranscriptionRequest {
@@ -1062,8 +1147,7 @@ export namespace TranscriptResultStream {
1062
1147
  /**
1063
1148
  * <p>A portion of the transcription of the audio stream. Events are sent periodically from
1064
1149
  * Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio
1065
- * stream, or it can be the entire transcription of that portion of the audio stream.
1066
- * </p>
1150
+ * stream, or it can be the entire transcription of that portion of the audio stream. </p>
1067
1151
  */
1068
1152
  export interface TranscriptEventMember {
1069
1153
  TranscriptEvent: TranscriptEvent;
@@ -1209,7 +1293,7 @@ export interface StartStreamTranscriptionResponse {
1209
1293
  LanguageCode?: LanguageCode | string;
1210
1294
 
1211
1295
  /**
1212
- * <p>The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz
1296
+ * <p>The sample rate for the input audio stream. Use 8,000 Hz for low quality audio and 16,000 Hz
1213
1297
  * for high quality audio.</p>
1214
1298
  */
1215
1299
  MediaSampleRateHertz?: number;
@@ -1269,6 +1353,21 @@ export interface StartStreamTranscriptionResponse {
1269
1353
  * level.</p>
1270
1354
  */
1271
1355
  PartialResultsStability?: PartialResultsStability | string;
1356
+
1357
+ /**
1358
+ * <p>Shows whether content identification was enabled in this stream.</p>
1359
+ */
1360
+ ContentIdentificationType?: ContentIdentificationType | string;
1361
+
1362
+ /**
1363
+ * <p>Shows whether content redaction was enabled in this stream.</p>
1364
+ */
1365
+ ContentRedactionType?: ContentRedactionType | string;
1366
+
1367
+ /**
1368
+ * <p>Lists the PII entity types you specified in your request.</p>
1369
+ */
1370
+ PiiEntityTypes?: string;
1272
1371
  }
1273
1372
 
1274
1373
  export namespace StartStreamTranscriptionResponse {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-transcribe-streaming",
3
3
  "description": "AWS SDK for JavaScript Transcribe Streaming Client for Node.js, Browser and React Native",
4
- "version": "3.28.0",
4
+ "version": "3.32.0",
5
5
  "scripts": {
6
6
  "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
7
7
  "build-documentation": "yarn remove-documentation && typedoc ./",
@@ -30,51 +30,51 @@
30
30
  "dependencies": {
31
31
  "@aws-crypto/sha256-browser": "^1.0.0",
32
32
  "@aws-crypto/sha256-js": "^1.0.0",
33
- "@aws-sdk/client-sts": "3.28.0",
34
- "@aws-sdk/config-resolver": "3.28.0",
35
- "@aws-sdk/credential-provider-node": "3.28.0",
36
- "@aws-sdk/eventstream-handler-node": "3.25.0",
37
- "@aws-sdk/eventstream-serde-browser": "3.25.0",
38
- "@aws-sdk/eventstream-serde-config-resolver": "3.25.0",
39
- "@aws-sdk/eventstream-serde-node": "3.25.0",
40
- "@aws-sdk/fetch-http-handler": "3.25.0",
41
- "@aws-sdk/hash-node": "3.25.0",
42
- "@aws-sdk/invalid-dependency": "3.25.0",
43
- "@aws-sdk/middleware-content-length": "3.25.0",
44
- "@aws-sdk/middleware-eventstream": "3.25.0",
45
- "@aws-sdk/middleware-host-header": "3.25.0",
46
- "@aws-sdk/middleware-logger": "3.25.0",
47
- "@aws-sdk/middleware-retry": "3.28.0",
48
- "@aws-sdk/middleware-sdk-transcribe-streaming": "3.28.0",
49
- "@aws-sdk/middleware-serde": "3.25.0",
50
- "@aws-sdk/middleware-signing": "3.28.0",
51
- "@aws-sdk/middleware-stack": "3.25.0",
52
- "@aws-sdk/middleware-user-agent": "3.25.0",
53
- "@aws-sdk/node-config-provider": "3.28.0",
54
- "@aws-sdk/node-http-handler": "3.25.0",
55
- "@aws-sdk/protocol-http": "3.25.0",
56
- "@aws-sdk/smithy-client": "3.28.0",
57
- "@aws-sdk/types": "3.25.0",
58
- "@aws-sdk/url-parser": "3.25.0",
59
- "@aws-sdk/util-base64-browser": "3.23.0",
60
- "@aws-sdk/util-base64-node": "3.23.0",
61
- "@aws-sdk/util-body-length-browser": "3.23.0",
62
- "@aws-sdk/util-body-length-node": "3.23.0",
63
- "@aws-sdk/util-user-agent-browser": "3.25.0",
64
- "@aws-sdk/util-user-agent-node": "3.28.0",
65
- "@aws-sdk/util-utf8-browser": "3.23.0",
66
- "@aws-sdk/util-utf8-node": "3.23.0",
33
+ "@aws-sdk/client-sts": "3.32.0",
34
+ "@aws-sdk/config-resolver": "3.32.0",
35
+ "@aws-sdk/credential-provider-node": "3.32.0",
36
+ "@aws-sdk/eventstream-handler-node": "3.32.0",
37
+ "@aws-sdk/eventstream-serde-browser": "3.32.0",
38
+ "@aws-sdk/eventstream-serde-config-resolver": "3.32.0",
39
+ "@aws-sdk/eventstream-serde-node": "3.32.0",
40
+ "@aws-sdk/fetch-http-handler": "3.32.0",
41
+ "@aws-sdk/hash-node": "3.32.0",
42
+ "@aws-sdk/invalid-dependency": "3.32.0",
43
+ "@aws-sdk/middleware-content-length": "3.32.0",
44
+ "@aws-sdk/middleware-eventstream": "3.32.0",
45
+ "@aws-sdk/middleware-host-header": "3.32.0",
46
+ "@aws-sdk/middleware-logger": "3.32.0",
47
+ "@aws-sdk/middleware-retry": "3.32.0",
48
+ "@aws-sdk/middleware-sdk-transcribe-streaming": "3.32.0",
49
+ "@aws-sdk/middleware-serde": "3.32.0",
50
+ "@aws-sdk/middleware-signing": "3.32.0",
51
+ "@aws-sdk/middleware-stack": "3.32.0",
52
+ "@aws-sdk/middleware-user-agent": "3.32.0",
53
+ "@aws-sdk/node-config-provider": "3.32.0",
54
+ "@aws-sdk/node-http-handler": "3.32.0",
55
+ "@aws-sdk/protocol-http": "3.32.0",
56
+ "@aws-sdk/smithy-client": "3.32.0",
57
+ "@aws-sdk/types": "3.32.0",
58
+ "@aws-sdk/url-parser": "3.32.0",
59
+ "@aws-sdk/util-base64-browser": "3.32.0",
60
+ "@aws-sdk/util-base64-node": "3.32.0",
61
+ "@aws-sdk/util-body-length-browser": "3.32.0",
62
+ "@aws-sdk/util-body-length-node": "3.32.0",
63
+ "@aws-sdk/util-user-agent-browser": "3.32.0",
64
+ "@aws-sdk/util-user-agent-node": "3.32.0",
65
+ "@aws-sdk/util-utf8-browser": "3.32.0",
66
+ "@aws-sdk/util-utf8-node": "3.32.0",
67
67
  "tslib": "^2.3.0"
68
68
  },
69
69
  "devDependencies": {
70
- "@aws-sdk/client-documentation-generator": "3.23.0",
70
+ "@aws-sdk/client-documentation-generator": "3.32.0",
71
71
  "@types/node": "^12.7.5",
72
72
  "downlevel-dts": "0.7.0",
73
73
  "jest": "^26.1.0",
74
74
  "rimraf": "^3.0.0",
75
75
  "ts-jest": "^26.4.1",
76
76
  "typedoc": "^0.19.2",
77
- "typescript": "~4.3.2"
77
+ "typescript": "~4.3.5"
78
78
  },
79
79
  "engines": {
80
80
  "node": ">=10.0.0"