@aws-sdk/client-transcribe-streaming 3.734.0 → 3.741.0

package/dist-types/commands/GetMedicalScribeStreamCommand.d.ts

@@ -0,0 +1,128 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetMedicalScribeStreamRequest, GetMedicalScribeStreamResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetMedicalScribeStreamCommand}.
+ */
+export interface GetMedicalScribeStreamCommandInput extends GetMedicalScribeStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetMedicalScribeStreamCommand}.
+ */
+export interface GetMedicalScribeStreamCommandOutput extends GetMedicalScribeStreamResponse, __MetadataBearer {
+}
+declare const GetMedicalScribeStreamCommand_base: {
+    new (input: GetMedicalScribeStreamCommandInput): import("@smithy/smithy-client").CommandImpl<GetMedicalScribeStreamCommandInput, GetMedicalScribeStreamCommandOutput, TranscribeStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetMedicalScribeStreamCommandInput): import("@smithy/smithy-client").CommandImpl<GetMedicalScribeStreamCommandInput, GetMedicalScribeStreamCommandOutput, TranscribeStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Provides details about the specified Amazon Web Services HealthScribe streaming session.
+ *       To view the status of the streaming session, check the <code>StreamStatus</code> field in the response. To get the
+ *       details of post-stream analytics, including its status, check the <code>PostStreamAnalyticsResult</code> field in the response.
+ *     </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TranscribeStreamingClient, GetMedicalScribeStreamCommand } from "@aws-sdk/client-transcribe-streaming"; // ES Modules import
+ * // const { TranscribeStreamingClient, GetMedicalScribeStreamCommand } = require("@aws-sdk/client-transcribe-streaming"); // CommonJS import
+ * const client = new TranscribeStreamingClient(config);
+ * const input = { // GetMedicalScribeStreamRequest
+ *   SessionId: "STRING_VALUE", // required
+ * };
+ * const command = new GetMedicalScribeStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // GetMedicalScribeStreamResponse
+ * //   MedicalScribeStreamDetails: { // MedicalScribeStreamDetails
+ * //     SessionId: "STRING_VALUE",
+ * //     StreamCreatedAt: new Date("TIMESTAMP"),
+ * //     StreamEndedAt: new Date("TIMESTAMP"),
+ * //     LanguageCode: "en-US",
+ * //     MediaSampleRateHertz: Number("int"),
+ * //     MediaEncoding: "pcm" || "ogg-opus" || "flac",
+ * //     VocabularyName: "STRING_VALUE",
+ * //     VocabularyFilterName: "STRING_VALUE",
+ * //     VocabularyFilterMethod: "remove" || "mask" || "tag",
+ * //     ResourceAccessRoleArn: "STRING_VALUE",
+ * //     ChannelDefinitions: [ // MedicalScribeChannelDefinitions
+ * //       { // MedicalScribeChannelDefinition
+ * //         ChannelId: Number("int"), // required
+ * //         ParticipantRole: "PATIENT" || "CLINICIAN", // required
+ * //       },
+ * //     ],
+ * //     EncryptionSettings: { // MedicalScribeEncryptionSettings
+ * //       KmsEncryptionContext: { // KMSEncryptionContextMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       KmsKeyId: "STRING_VALUE", // required
+ * //     },
+ * //     StreamStatus: "IN_PROGRESS" || "PAUSED" || "FAILED" || "COMPLETED",
+ * //     PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
+ * //       ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
+ * //         OutputBucketName: "STRING_VALUE", // required
+ * //       },
+ * //     },
+ * //     PostStreamAnalyticsResult: { // MedicalScribePostStreamAnalyticsResult
+ * //       ClinicalNoteGenerationResult: { // ClinicalNoteGenerationResult
+ * //         ClinicalNoteOutputLocation: "STRING_VALUE",
+ * //         TranscriptOutputLocation: "STRING_VALUE",
+ * //         Status: "IN_PROGRESS" || "FAILED" || "COMPLETED",
+ * //         FailureReason: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetMedicalScribeStreamCommandInput - {@link GetMedicalScribeStreamCommandInput}
+ * @returns {@link GetMedicalScribeStreamCommandOutput}
+ * @see {@link GetMedicalScribeStreamCommandInput} for command's `input` shape.
+ * @see {@link GetMedicalScribeStreamCommandOutput} for command's `response` shape.
+ * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>One or more arguments to the <code>StartStreamTranscription</code>,
+ *       <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
+ *       operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
+ *       used unsupported values. Check the specified parameters and try your request again.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>A problem occurred while processing the audio. Amazon Transcribe terminated
+ *       processing.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
+ *       limit. Break your audio stream into smaller chunks and try your request again.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resource which doesn't exist.</p>
+ *
+ * @throws {@link TranscribeStreamingServiceException}
+ * <p>Base exception class for all service exceptions from TranscribeStreaming service.</p>
+ *
+ * @public
+ */
+export declare class GetMedicalScribeStreamCommand extends GetMedicalScribeStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetMedicalScribeStreamRequest;
+            output: GetMedicalScribeStreamResponse;
+        };
+        sdk: {
+            input: GetMedicalScribeStreamCommandInput;
+            output: GetMedicalScribeStreamCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartMedicalScribeStreamCommand.d.ts

@@ -0,0 +1,205 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { StartMedicalScribeStreamRequest, StartMedicalScribeStreamResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig } from "../TranscribeStreamingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartMedicalScribeStreamCommand}.
+ */
+export interface StartMedicalScribeStreamCommandInput extends StartMedicalScribeStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartMedicalScribeStreamCommand}.
+ */
+export interface StartMedicalScribeStreamCommandOutput extends StartMedicalScribeStreamResponse, __MetadataBearer {
+}
+declare const StartMedicalScribeStreamCommand_base: {
+    new (input: StartMedicalScribeStreamCommandInput): import("@smithy/smithy-client").CommandImpl<StartMedicalScribeStreamCommandInput, StartMedicalScribeStreamCommandOutput, TranscribeStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartMedicalScribeStreamCommandInput): import("@smithy/smithy-client").CommandImpl<StartMedicalScribeStreamCommandInput, StartMedicalScribeStreamCommandOutput, TranscribeStreamingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Starts a bidirectional HTTP/2 stream, where audio is streamed to
+ *       Amazon Web Services HealthScribe
+ *       and the transcription results are streamed to your application.</p>
+ *          <p>When you start a stream, you first specify the stream configuration in a <code>MedicalScribeConfigurationEvent</code>.
+ *       This event includes channel definitions, encryption settings, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional
+ *       streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session,
+ *       your first event must be a <code>MedicalScribeConfigurationEvent</code>. </p>
+ *          <p>
+ *       After you send a <code>MedicalScribeConfigurationEvent</code>, you start <code>AudioEvents</code> and Amazon Web Services HealthScribe
+ *       responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a <code>MedicalScribeSessionControlEvent</code> with a <code>Type</code> of
+ *       <code>END_OF_SESSION</code> and Amazon Web Services HealthScribe starts the analytics.
+ *     </p>
+ *          <p>You can pause or resume streaming.
+ *      To pause streaming, complete the input stream without sending the
+ *       <code>MedicalScribeSessionControlEvent</code>.
+ *       To resume streaming, call the <code>StartMedicalScribeStream</code> and specify the same SessionId you used to start the stream.
+ *     </p>
+ *          <p>The following parameters are required:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>language-code</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>media-encoding</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>media-sample-rate-hertz</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p></p>
+ *          <p>For more information on streaming with
+ *       Amazon Web Services HealthScribe,
+ *       see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html">Amazon Web Services HealthScribe</a>.
+ *     </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { TranscribeStreamingClient, StartMedicalScribeStreamCommand } from "@aws-sdk/client-transcribe-streaming"; // ES Modules import
+ * // const { TranscribeStreamingClient, StartMedicalScribeStreamCommand } = require("@aws-sdk/client-transcribe-streaming"); // CommonJS import
+ * const client = new TranscribeStreamingClient(config);
+ * const input = { // StartMedicalScribeStreamRequest
+ *   SessionId: "STRING_VALUE",
+ *   LanguageCode: "en-US", // required
+ *   MediaSampleRateHertz: Number("int"), // required
+ *   MediaEncoding: "pcm" || "ogg-opus" || "flac", // required
+ *   InputStream: { // MedicalScribeInputStream Union: only one key present
+ *     AudioEvent: { // MedicalScribeAudioEvent
+ *       AudioChunk: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")       // required
+ *     },
+ *     SessionControlEvent: { // MedicalScribeSessionControlEvent
+ *       Type: "END_OF_SESSION", // required
+ *     },
+ *     ConfigurationEvent: { // MedicalScribeConfigurationEvent
+ *       VocabularyName: "STRING_VALUE",
+ *       VocabularyFilterName: "STRING_VALUE",
+ *       VocabularyFilterMethod: "remove" || "mask" || "tag",
+ *       ResourceAccessRoleArn: "STRING_VALUE", // required
+ *       ChannelDefinitions: [ // MedicalScribeChannelDefinitions
+ *         { // MedicalScribeChannelDefinition
+ *           ChannelId: Number("int"), // required
+ *           ParticipantRole: "PATIENT" || "CLINICIAN", // required
+ *         },
+ *       ],
+ *       EncryptionSettings: { // MedicalScribeEncryptionSettings
+ *         KmsEncryptionContext: { // KMSEncryptionContextMap
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         KmsKeyId: "STRING_VALUE", // required
+ *       },
+ *       PostStreamAnalyticsSettings: { // MedicalScribePostStreamAnalyticsSettings
+ *         ClinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettings
+ *           OutputBucketName: "STRING_VALUE", // required
+ *         },
+ *       },
+ *     },
+ *   },
+ * };
+ * const command = new StartMedicalScribeStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // StartMedicalScribeStreamResponse
+ * //   SessionId: "STRING_VALUE",
+ * //   RequestId: "STRING_VALUE",
+ * //   LanguageCode: "en-US",
+ * //   MediaSampleRateHertz: Number("int"),
+ * //   MediaEncoding: "pcm" || "ogg-opus" || "flac",
+ * //   ResultStream: { // MedicalScribeResultStream Union: only one key present
+ * //     TranscriptEvent: { // MedicalScribeTranscriptEvent
+ * //       TranscriptSegment: { // MedicalScribeTranscriptSegment
+ * //         SegmentId: "STRING_VALUE",
+ * //         BeginAudioTime: Number("double"),
+ * //         EndAudioTime: Number("double"),
+ * //         Content: "STRING_VALUE",
+ * //         Items: [ // MedicalScribeTranscriptItemList
+ * //           { // MedicalScribeTranscriptItem
+ * //             BeginAudioTime: Number("double"),
+ * //             EndAudioTime: Number("double"),
+ * //             Type: "pronunciation" || "punctuation",
+ * //             Confidence: Number("double"),
+ * //             Content: "STRING_VALUE",
+ * //             VocabularyFilterMatch: true || false,
+ * //           },
+ * //         ],
+ * //         IsPartial: true || false,
+ * //         ChannelId: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     BadRequestException: { // BadRequestException
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //     LimitExceededException: { // LimitExceededException
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //     InternalFailureException: { // InternalFailureException
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //     ConflictException: { // ConflictException
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //     ServiceUnavailableException: { // ServiceUnavailableException
+ * //       Message: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param StartMedicalScribeStreamCommandInput - {@link StartMedicalScribeStreamCommandInput}
+ * @returns {@link StartMedicalScribeStreamCommandOutput}
+ * @see {@link StartMedicalScribeStreamCommandInput} for command's `input` shape.
+ * @see {@link StartMedicalScribeStreamCommandOutput} for command's `response` shape.
+ * @see {@link TranscribeStreamingClientResolvedConfig | config} for TranscribeStreamingClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>One or more arguments to the <code>StartStreamTranscription</code>,
+ *       <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
+ *       operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
+ *       used unsupported values. Check the specified parameters and try your request again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A new stream started with the same session ID. The current stream has been terminated.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>A problem occurred while processing the audio. Amazon Transcribe terminated
+ *       processing.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
+ *       limit. Break your audio stream into smaller chunks and try your request again.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable. Try your request later.</p>
+ *
+ * @throws {@link TranscribeStreamingServiceException}
+ * <p>Base exception class for all service exceptions from TranscribeStreaming service.</p>
+ *
+ * @public
+ */
+export declare class StartMedicalScribeStreamCommand extends StartMedicalScribeStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartMedicalScribeStreamRequest;
+            output: StartMedicalScribeStreamResponse;
+        };
+        sdk: {
+            input: StartMedicalScribeStreamCommandInput;
+            output: StartMedicalScribeStreamCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./GetMedicalScribeStreamCommand";
 export * from "./StartCallAnalyticsStreamTranscriptionCommand";
+export * from "./StartMedicalScribeStreamCommand";
 export * from "./StartMedicalStreamTranscriptionCommand";
 export * from "./StartStreamTranscriptionCommand";

package/dist-types/index.d.ts

@@ -1,7 +1,8 @@
 /**
- * <p>Amazon Transcribe streaming offers three main types of real-time transcription:
- *       <b>Standard</b>, <b>Medical</b>, and
- *       <b>Call Analytics</b>.</p>
+ * <p>Amazon Transcribe streaming offers four main types of real-time transcription:
+ *       <b>Standard</b>, <b>Medical</b>,
+ *       <b>Call Analytics</b>,
+ *       and <b>Health Scribe</b>.</p>
  *          <ul>
  *             <li>
  *                <p>
@@ -21,6 +22,12 @@
  *           center audio on two different channels; if you're looking for insight into customer service calls, use this
  *           option. Refer to  for details.</p>
  *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>HealthScribe transcriptions</b> are designed to
+ *           automatically create clinical notes from patient-clinician conversations using generative AI.
+ *           Refer to [here] for details.</p>
+ *             </li>
  *          </ul>
  *
  * @packageDocumentation