@aws-sdk/client-transcribe-streaming 3.29.0 → 3.33.0

package/models/models_0.ts

@@ -1,5 +1,49 @@
 import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
 
+/**
+ * <p>The entity identified as personally identifiable information (PII).</p>
+ */
+export interface Entity {
+  /**
+   * <p>The start time of speech that was identified as PII.</p>
+   */
+  StartTime?: number;
+
+  /**
+   * <p>The end time of speech that was identified as PII.</p>
+   */
+  EndTime?: number;
+
+  /**
+   * <p>The category of of information identified in this entity; for example, PII.</p>
+   */
+  Category?: string;
+
+  /**
+   * <p>The type of PII identified in this entity; for example, name or credit card number.</p>
+   */
+  Type?: string;
+
+  /**
+   * <p>The words in the transcription output that have been identified as a PII entity.</p>
+   */
+  Content?: string;
+
+  /**
+   * <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>
+   */
+  Confidence?: number;
+}
+
+export namespace Entity {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: Entity): any => ({
+    ...obj,
+  });
+}
+
 export enum ItemType {
   PRONUNCIATION = "pronunciation",
   PUNCTUATION = "punctuation",
@@ -81,6 +125,11 @@ export interface Alternative {
    * <p>One or more alternative interpretations of the input audio. </p>
    */
   Items?: Item[];
+
+  /**
+   * <p>Contains the entities identified as personally identifiable information (PII) in the transcription output.</p>
+   */
+  Entities?: Entity[];
 }
 
 export namespace Alternative {
@@ -94,8 +143,10 @@ export namespace Alternative {
 
 /**
  * <p>Provides a wrapper for the audio chunks that you are sending.</p>
- *          <p>For information on audio encoding in Amazon Transcribe, see <a>input</a>. For information
- *       on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
+ *          <p>For information on audio encoding in Amazon Transcribe, see
+ *       <a href="https://docs.aws.amazon.com/transcribe/latest/dg/input.html">Speech input</a>. For 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>
  */
 export interface AudioEvent {
   /**
@@ -123,10 +174,10 @@ export namespace AudioStream {
   /**
    * <p>A blob of audio from your application. You audio stream consists of one or more audio
    *       events.</p>
-   *          <p>For information on audio encoding formats in Amazon Transcribe, see <a>input</a>. For
-   *       information on audio encoding formats in Amazon Transcribe Medical, see <a>input-med</a>.</p>
-   *          <p>For more information on stream encoding in Amazon Transcribe, see <a>event-stream</a>. For
-   *       information on stream encoding in Amazon Transcribe Medical, see <a>event-stream-med</a>.</p>
+   *          <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
+   *       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>
+   *          <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
+   *       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>
    */
   export interface AudioEventMember {
     AudioEvent: AudioEvent;
@@ -197,6 +248,14 @@ export namespace ConflictException {
   });
 }
 
+export enum ContentIdentificationType {
+  PII = "PII",
+}
+
+export enum ContentRedactionType {
+  PII = "PII",
+}
+
 /**
  * <p>A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try
  *       your request again.</p>
@@ -742,8 +801,7 @@ export interface StartMedicalStreamTranscriptionRequest {
   LanguageCode: LanguageCode | string | undefined;
 
   /**
-   * <p>The sample rate of the input audio in Hertz. Sample rates of 16000 Hz or higher are
-   *             accepted.</p>
+   * <p>The sample rate of the input audio in Hertz.</p>
    */
   MediaSampleRateHertz: number | undefined;
 
@@ -833,7 +891,7 @@ export interface StartMedicalStreamTranscriptionResponse {
   LanguageCode?: LanguageCode | string;
 
   /**
-   * <p>The sample rate of the input audio in Hertz. Valid value: 16000 Hz.</p>
+   * <p>The sample rate of the input audio in Hertz.</p>
    */
   MediaSampleRateHertz?: number;
 
@@ -913,8 +971,8 @@ export interface StartStreamTranscriptionRequest {
   LanguageCode: LanguageCode | string | undefined;
 
   /**
-   * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low
-   *       quality audio and 16000 Hz for high quality audio.</p>
+   * <p>The sample rate, in Hertz, of the input audio. We suggest that you use 8,000 Hz for low
+   *       quality audio and 16,000 Hz for high quality audio.</p>
    */
   MediaSampleRateHertz: number | undefined;
 
@@ -936,13 +994,13 @@ export interface StartStreamTranscriptionRequest {
   SessionId?: string;
 
   /**
-   * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data
+   * <p>PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data
    *       frame.</p>
    */
   AudioStream: AsyncIterable<AudioStream> | undefined;
 
   /**
-   * <p>The name of the vocabulary filter you've created that is unique to your AWS account.
+   * <p>The name of the vocabulary filter you've created that is unique to your account.
    *       Provide the name in this field to successfully use it in a stream.</p>
    */
   VocabularyFilterName?: string;
@@ -950,7 +1008,7 @@ export interface StartStreamTranscriptionRequest {
   /**
    * <p>The manner in which you use your vocabulary filter to filter words in your transcript.
    *         <code>Remove</code> removes filtered words from your transcription results.
-   *         <code>Mask</code> masks those words with a <code>***</code> in your transcription results.
+   *         <code>Mask</code> masks filtered words with a <code>***</code> in your transcription results.
    *         <code>Tag</code> keeps the filtered words in your transcription results and tags them. The
    *       tag appears as <code>VocabularyFilterMatch</code> equal to <code>True</code>
    *          </p>
@@ -992,6 +1050,33 @@ export interface StartStreamTranscriptionRequest {
    *       stability levels can come with lower overall transcription accuracy.</p>
    */
   PartialResultsStability?: PartialResultsStability | string;
+
+  /**
+   * <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>
+   *          <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>
+   */
+  ContentIdentificationType?: ContentIdentificationType | string;
+
+  /**
+   * <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>
+   *          <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>
+   */
+  ContentRedactionType?: ContentRedactionType | string;
+
+  /**
+   * <p>List the PII entity types you want to identify or redact. In order to specify entity types, you must have
+   *       either <code>ContentIdentificationType</code> or <code>ContentRedactionType</code> enabled.</p>
+   *          <p>
+   *             <code>PIIEntityTypes</code> must be comma-separated; the available values are:
+   *       <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>,
+   *       <code>CREDIT_DEBIT_NUMBER</code>, <code>CREDIT_DEBIT_CVV</code>,
+   *       <code>CREDIT_DEBIT_EXPIRY</code>, <code>PIN</code>, <code>EMAIL</code>,
+   *       <code>ADDRESS</code>, <code>NAME</code>, <code>PHONE</code>,
+   *       <code>SSN</code>, and <code>ALL</code>.</p>
+   *          <p>
+   *             <code>PiiEntityTypes</code> is an optional parameter with a default value of <code>ALL</code>.</p>
+   */
+  PiiEntityTypes?: string;
 }
 
 export namespace StartStreamTranscriptionRequest {
@@ -1062,8 +1147,7 @@ export namespace TranscriptResultStream {
   /**
    * <p>A portion of the transcription of the audio stream. Events are sent periodically from
    *       Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio
-   *       stream, or it can be the entire transcription of that portion of the audio stream.
-   *       </p>
+   *       stream, or it can be the entire transcription of that portion of the audio stream. </p>
    */
   export interface TranscriptEventMember {
     TranscriptEvent: TranscriptEvent;
@@ -1209,7 +1293,7 @@ export interface StartStreamTranscriptionResponse {
   LanguageCode?: LanguageCode | string;
 
   /**
-   * <p>The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz
+   * <p>The sample rate for the input audio stream. Use 8,000 Hz for low quality audio and 16,000 Hz
    *       for high quality audio.</p>
    */
   MediaSampleRateHertz?: number;
@@ -1269,6 +1353,21 @@ export interface StartStreamTranscriptionResponse {
    *       level.</p>
    */
   PartialResultsStability?: PartialResultsStability | string;
+
+  /**
+   * <p>Shows whether content identification was enabled in this stream.</p>
+   */
+  ContentIdentificationType?: ContentIdentificationType | string;
+
+  /**
+   * <p>Shows whether content redaction was enabled in this stream.</p>
+   */
+  ContentRedactionType?: ContentRedactionType | string;
+
+  /**
+   * <p>Lists the PII entity types you specified in your request.</p>
+   */
+  PiiEntityTypes?: string;
 }
 
 export namespace StartStreamTranscriptionResponse {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-transcribe-streaming",
   "description": "AWS SDK for JavaScript Transcribe Streaming Client for Node.js, Browser and React Native",
-  "version": "3.29.0",
+  "version": "3.33.0",
   "scripts": {
     "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
     "build-documentation": "yarn remove-documentation && typedoc ./",
@@ -30,51 +30,51 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "^1.0.0",
     "@aws-crypto/sha256-js": "^1.0.0",
-    "@aws-sdk/client-sts": "3.29.0",
-    "@aws-sdk/config-resolver": "3.29.0",
-    "@aws-sdk/credential-provider-node": "3.29.0",
-    "@aws-sdk/eventstream-handler-node": "3.29.0",
-    "@aws-sdk/eventstream-serde-browser": "3.29.0",
-    "@aws-sdk/eventstream-serde-config-resolver": "3.29.0",
-    "@aws-sdk/eventstream-serde-node": "3.29.0",
-    "@aws-sdk/fetch-http-handler": "3.29.0",
-    "@aws-sdk/hash-node": "3.29.0",
-    "@aws-sdk/invalid-dependency": "3.29.0",
-    "@aws-sdk/middleware-content-length": "3.29.0",
-    "@aws-sdk/middleware-eventstream": "3.29.0",
-    "@aws-sdk/middleware-host-header": "3.29.0",
-    "@aws-sdk/middleware-logger": "3.29.0",
-    "@aws-sdk/middleware-retry": "3.29.0",
-    "@aws-sdk/middleware-sdk-transcribe-streaming": "3.29.0",
-    "@aws-sdk/middleware-serde": "3.29.0",
-    "@aws-sdk/middleware-signing": "3.29.0",
-    "@aws-sdk/middleware-stack": "3.29.0",
-    "@aws-sdk/middleware-user-agent": "3.29.0",
-    "@aws-sdk/node-config-provider": "3.29.0",
-    "@aws-sdk/node-http-handler": "3.29.0",
-    "@aws-sdk/protocol-http": "3.29.0",
-    "@aws-sdk/smithy-client": "3.29.0",
-    "@aws-sdk/types": "3.29.0",
-    "@aws-sdk/url-parser": "3.29.0",
-    "@aws-sdk/util-base64-browser": "3.29.0",
-    "@aws-sdk/util-base64-node": "3.29.0",
-    "@aws-sdk/util-body-length-browser": "3.29.0",
-    "@aws-sdk/util-body-length-node": "3.29.0",
-    "@aws-sdk/util-user-agent-browser": "3.29.0",
-    "@aws-sdk/util-user-agent-node": "3.29.0",
-    "@aws-sdk/util-utf8-browser": "3.29.0",
-    "@aws-sdk/util-utf8-node": "3.29.0",
+    "@aws-sdk/client-sts": "3.33.0",
+    "@aws-sdk/config-resolver": "3.33.0",
+    "@aws-sdk/credential-provider-node": "3.33.0",
+    "@aws-sdk/eventstream-handler-node": "3.32.0",
+    "@aws-sdk/eventstream-serde-browser": "3.32.0",
+    "@aws-sdk/eventstream-serde-config-resolver": "3.32.0",
+    "@aws-sdk/eventstream-serde-node": "3.32.0",
+    "@aws-sdk/fetch-http-handler": "3.32.0",
+    "@aws-sdk/hash-node": "3.32.0",
+    "@aws-sdk/invalid-dependency": "3.32.0",
+    "@aws-sdk/middleware-content-length": "3.32.0",
+    "@aws-sdk/middleware-eventstream": "3.32.0",
+    "@aws-sdk/middleware-host-header": "3.32.0",
+    "@aws-sdk/middleware-logger": "3.32.0",
+    "@aws-sdk/middleware-retry": "3.32.0",
+    "@aws-sdk/middleware-sdk-transcribe-streaming": "3.33.0",
+    "@aws-sdk/middleware-serde": "3.32.0",
+    "@aws-sdk/middleware-signing": "3.33.0",
+    "@aws-sdk/middleware-stack": "3.32.0",
+    "@aws-sdk/middleware-user-agent": "3.32.0",
+    "@aws-sdk/node-config-provider": "3.32.0",
+    "@aws-sdk/node-http-handler": "3.32.0",
+    "@aws-sdk/protocol-http": "3.32.0",
+    "@aws-sdk/smithy-client": "3.32.0",
+    "@aws-sdk/types": "3.32.0",
+    "@aws-sdk/url-parser": "3.32.0",
+    "@aws-sdk/util-base64-browser": "3.32.0",
+    "@aws-sdk/util-base64-node": "3.32.0",
+    "@aws-sdk/util-body-length-browser": "3.32.0",
+    "@aws-sdk/util-body-length-node": "3.32.0",
+    "@aws-sdk/util-user-agent-browser": "3.32.0",
+    "@aws-sdk/util-user-agent-node": "3.33.0",
+    "@aws-sdk/util-utf8-browser": "3.32.0",
+    "@aws-sdk/util-utf8-node": "3.32.0",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-documentation-generator": "3.29.0",
+    "@aws-sdk/client-documentation-generator": "3.32.0",
     "@types/node": "^12.7.5",
     "downlevel-dts": "0.7.0",
     "jest": "^26.1.0",
     "rimraf": "^3.0.0",
     "ts-jest": "^26.4.1",
     "typedoc": "^0.19.2",
-    "typescript": "~4.4.2"
+    "typescript": "~4.3.5"
   },
   "engines": {
     "node": ">=10.0.0"

package/protocols/Aws_restJson1.ts

@@ -12,6 +12,7 @@ import {
   AudioStream,
   BadRequestException,
   ConflictException,
+  Entity,
   InternalFailureException,
   Item,
   LimitExceededException,
@@ -131,6 +132,15 @@ export const serializeAws_restJson1StartStreamTranscriptionCommand = async (
     ...(isSerializableHeaderValue(input.PartialResultsStability) && {
       "x-amzn-transcribe-partial-results-stability": input.PartialResultsStability!,
     }),
+    ...(isSerializableHeaderValue(input.ContentIdentificationType) && {
+      "x-amzn-transcribe-content-identification-type": input.ContentIdentificationType!,
+    }),
+    ...(isSerializableHeaderValue(input.ContentRedactionType) && {
+      "x-amzn-transcribe-content-redaction-type": input.ContentRedactionType!,
+    }),
+    ...(isSerializableHeaderValue(input.PiiEntityTypes) && {
+      "x-amzn-transcribe-pii-entity-types": input.PiiEntityTypes!,
+    }),
   };
   let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/stream-transcription";
   let body: any;
@@ -308,6 +318,8 @@ export const deserializeAws_restJson1StartStreamTranscriptionCommand = async (
   }
   const contents: StartStreamTranscriptionCommandOutput = {
     $metadata: deserializeMetadata(output),
+    ContentIdentificationType: undefined,
+    ContentRedactionType: undefined,
     EnableChannelIdentification: undefined,
     EnablePartialResultsStabilization: undefined,
     LanguageCode: undefined,
@@ -315,6 +327,7 @@ export const deserializeAws_restJson1StartStreamTranscriptionCommand = async (
     MediaSampleRateHertz: undefined,
     NumberOfChannels: undefined,
     PartialResultsStability: undefined,
+    PiiEntityTypes: undefined,
     RequestId: undefined,
     SessionId: undefined,
     ShowSpeakerLabel: undefined,
@@ -366,6 +379,15 @@ export const deserializeAws_restJson1StartStreamTranscriptionCommand = async (
   if (output.headers["x-amzn-transcribe-partial-results-stability"] !== undefined) {
     contents.PartialResultsStability = output.headers["x-amzn-transcribe-partial-results-stability"];
   }
+  if (output.headers["x-amzn-transcribe-content-identification-type"] !== undefined) {
+    contents.ContentIdentificationType = output.headers["x-amzn-transcribe-content-identification-type"];
+  }
+  if (output.headers["x-amzn-transcribe-content-redaction-type"] !== undefined) {
+    contents.ContentRedactionType = output.headers["x-amzn-transcribe-content-redaction-type"];
+  }
+  if (output.headers["x-amzn-transcribe-pii-entity-types"] !== undefined) {
+    contents.PiiEntityTypes = output.headers["x-amzn-transcribe-pii-entity-types"];
+  }
   const data: any = context.eventStreamMarshaller.deserialize(output.body, async (event) => {
     const eventName = Object.keys(event)[0];
     const eventHeaders = Object.entries(event[eventName].headers).reduce((accummulator, curr) => {
@@ -742,6 +764,10 @@ const serializeAws_restJson1AudioStream = (input: AudioStream, context: __SerdeC
 
 const deserializeAws_restJson1Alternative = (output: any, context: __SerdeContext): Alternative => {
   return {
+    Entities:
+      output.Entities !== undefined && output.Entities !== null
+        ? deserializeAws_restJson1EntityList(output.Entities, context)
+        : undefined,
     Items:
       output.Items !== undefined && output.Items !== null
         ? deserializeAws_restJson1ItemList(output.Items, context)
@@ -773,6 +799,28 @@ const deserializeAws_restJson1ConflictException = (output: any, context: __Serde
   } as any;
 };
 
+const deserializeAws_restJson1Entity = (output: any, context: __SerdeContext): Entity => {
+  return {
+    Category: __expectString(output.Category),
+    Confidence: __limitedParseDouble(output.Confidence),
+    Content: __expectString(output.Content),
+    EndTime: __limitedParseDouble(output.EndTime),
+    StartTime: __limitedParseDouble(output.StartTime),
+    Type: __expectString(output.Type),
+  } as any;
+};
+
+const deserializeAws_restJson1EntityList = (output: any, context: __SerdeContext): Entity[] => {
+  return (output || [])
+    .filter((e: any) => e != null)
+    .map((entry: any) => {
+      if (entry === null) {
+        return null as any;
+      }
+      return deserializeAws_restJson1Entity(entry, context);
+    });
+};
+
 const deserializeAws_restJson1InternalFailureException = (
   output: any,
   context: __SerdeContext

package/tsconfig.json

@@ -13,8 +13,7 @@
     "resolveJsonModule": true,
     "esModuleInterop": true,
     "declarationDir": "./dist/types",
-    "outDir": "dist/cjs",
-    "useUnknownInCatchVariables": false
+    "outDir": "dist/cjs"
   },
   "typedocOptions": {
     "exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],