@aws-sdk/client-connect-contact-lens 3.616.0 → 3.620.0

package/README.md

@@ -6,13 +6,26 @@
 
 AWS SDK for JavaScript ConnectContactLens Client for Node.js, Browser and React Native.
 
-<p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
-by using speech transcription, natural language processing, and intelligent search
-capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
+<ul>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Contact_Lens.html">Contact Lens actions</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Contact_Lens.html">Contact Lens data types</a>
+</p>
+</li>
+</ul>
+<p>Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using
+speech transcription, natural language processing, and intelligent search capabilities.
+It performs sentiment analysis, detects issues, and enables you to automatically
 categorize contacts.</p>
-<p>Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent
-conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations using
-Contact Lens</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
+<p>Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent
+conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations
+using speech analytics</a> in the <i>Amazon Connect Administrator
+Guide</i>. </p>
 
 ## Installing
 

package/dist-cjs/index.js

@@ -29,6 +29,8 @@ __export(src_exports, {
   InternalServiceException: () => InternalServiceException,
   InvalidRequestException: () => InvalidRequestException,
   ListRealtimeContactAnalysisSegmentsCommand: () => ListRealtimeContactAnalysisSegmentsCommand,
+  PostContactSummaryFailureCode: () => PostContactSummaryFailureCode,
+  PostContactSummaryStatus: () => PostContactSummaryStatus,
   ResourceNotFoundException: () => ResourceNotFoundException,
   SentimentValue: () => SentimentValue,
   ThrottlingException: () => ThrottlingException,
@@ -262,6 +264,17 @@ var _InvalidRequestException = class _InvalidRequestException extends ConnectCon
 };
 __name(_InvalidRequestException, "InvalidRequestException");
 var InvalidRequestException = _InvalidRequestException;
+var PostContactSummaryFailureCode = {
+  FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
+  INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",
+  INTERNAL_ERROR: "INTERNAL_ERROR",
+  INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION",
+  QUOTA_EXCEEDED: "QUOTA_EXCEEDED"
+};
+var PostContactSummaryStatus = {
+  COMPLETED: "COMPLETED",
+  FAILED: "FAILED"
+};
 var SentimentValue = {
   NEGATIVE: "NEGATIVE",
   NEUTRAL: "NEUTRAL",
@@ -481,6 +494,8 @@ var paginateListRealtimeContactAnalysisSegments = (0, import_core.createPaginato
   AccessDeniedException,
   InternalServiceException,
   InvalidRequestException,
+  PostContactSummaryFailureCode,
+  PostContactSummaryStatus,
   SentimentValue,
   ResourceNotFoundException,
   ThrottlingException

package/dist-es/models/models_0.js

@@ -38,6 +38,17 @@ export class InvalidRequestException extends __BaseException {
         this.Message = opts.Message;
     }
 }
+export const PostContactSummaryFailureCode = {
+    FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
+    INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",
+    INTERNAL_ERROR: "INTERNAL_ERROR",
+    INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
+};
+export const PostContactSummaryStatus = {
+    COMPLETED: "COMPLETED",
+    FAILED: "FAILED",
+};
 export const SentimentValue = {
     NEGATIVE: "NEGATIVE",
     NEUTRAL: "NEUTRAL",

package/dist-types/ConnectContactLens.d.ts

@@ -10,13 +10,26 @@ export interface ConnectContactLens {
     listRealtimeContactAnalysisSegments(args: ListRealtimeContactAnalysisSegmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRealtimeContactAnalysisSegmentsCommandOutput) => void): void;
 }
 /**
- * <p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
- *       by using speech transcription, natural language processing, and intelligent search
- *       capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
- *       categorize contacts.</p>
- *          <p>Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent
- *       conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations using
- *         Contact Lens</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Contact_Lens.html">Contact Lens actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Contact_Lens.html">Contact Lens data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using
+ *             speech transcription, natural language processing, and intelligent search capabilities.
+ *             It performs sentiment analysis, detects issues, and enables you to automatically
+ *             categorize contacts.</p>
+ *          <p>Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent
+ *             conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations
+ *                 using speech analytics</a> in the <i>Amazon Connect Administrator
+ *             Guide</i>. </p>
  * @public
  */
 export declare class ConnectContactLens extends ConnectContactLensClient implements ConnectContactLens {

package/dist-types/ConnectContactLensClient.d.ts

@@ -152,13 +152,26 @@ export type ConnectContactLensClientResolvedConfigType = __SmithyResolvedConfigu
 export interface ConnectContactLensClientResolvedConfig extends ConnectContactLensClientResolvedConfigType {
 }
 /**
- * <p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
- *       by using speech transcription, natural language processing, and intelligent search
- *       capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
- *       categorize contacts.</p>
- *          <p>Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent
- *       conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations using
- *         Contact Lens</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Contact_Lens.html">Contact Lens actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Contact_Lens.html">Contact Lens data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using
+ *             speech transcription, natural language processing, and intelligent search capabilities.
+ *             It performs sentiment analysis, detects issues, and enables you to automatically
+ *             categorize contacts.</p>
+ *          <p>Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent
+ *             conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations
+ *                 using speech analytics</a> in the <i>Amazon Connect Administrator
+ *             Guide</i>. </p>
  * @public
  */
 export declare class ConnectContactLensClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectContactLensClientResolvedConfig> {

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

@@ -77,6 +77,11 @@ declare const ListRealtimeContactAnalysisSegmentsCommand_base: {
  * //           },
  * //         },
  * //       },
+ * //       PostContactSummary: { // PostContactSummary
+ * //         Content: "STRING_VALUE",
+ * //         Status: "FAILED" || "COMPLETED", // required
+ * //         FailureCode: "QUOTA_EXCEEDED" || "INSUFFICIENT_CONVERSATION_CONTENT" || "FAILED_SAFETY_GUIDELINES" || "INVALID_ANALYSIS_CONFIGURATION" || "INTERNAL_ERROR",
+ * //       },
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

package/dist-types/index.d.ts

@@ -1,11 +1,24 @@
 /**
- * <p>Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents,
- *       by using speech transcription, natural language processing, and intelligent search
- *       capabilities. It performs sentiment analysis, detects issues, and enables you to automatically
- *       categorize contacts.</p>
- *          <p>Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent
- *       conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations using
- *         Contact Lens</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Contact_Lens.html">Contact Lens actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Contact_Lens.html">Contact Lens data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect Contact Lens enables you to analyze conversations between customer and agents, by using
+ *             speech transcription, natural language processing, and intelligent search capabilities.
+ *             It performs sentiment analysis, detects issues, and enables you to automatically
+ *             categorize contacts.</p>
+ *          <p>Amazon Connect Contact Lens provides both real-time and post-call analytics of customer-agent
+ *             conversations. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/analyze-conversations.html">Analyze conversations
+ *                 using speech analytics</a> in the <i>Amazon Connect Administrator
+ *             Guide</i>. </p>
  *
  * @packageDocumentation
  */

package/dist-types/models/models_0.d.ts

@@ -54,7 +54,7 @@ export interface ListRealtimeContactAnalysisSegmentsRequest {
      */
     ContactId: string | undefined;
     /**
-     * <p>The maximimum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page.</p>
      * @public
      */
     MaxResults?: number;
@@ -93,8 +93,8 @@ export interface CategoryDetails {
     PointsOfInterest: PointOfInterest[] | undefined;
 }
 /**
- * <p>Provides the category rules that are used to automatically categorize contacts based on
- *       uttered keywords and phrases.</p>
+ * <p>Provides the category rules that are used to automatically categorize contacts based
+ *             on uttered keywords and phrases.</p>
  * @public
  */
 export interface Categories {
@@ -110,7 +110,87 @@ export interface Categories {
     MatchedDetails: Record<string, CategoryDetails> | undefined;
 }
 /**
- * <p>For characters that were detected as issues, where they occur in the transcript.</p>
+ * @public
+ * @enum
+ */
+export declare const PostContactSummaryFailureCode: {
+    readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
+    readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+    readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
+    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
+};
+/**
+ * @public
+ */
+export type PostContactSummaryFailureCode = (typeof PostContactSummaryFailureCode)[keyof typeof PostContactSummaryFailureCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const PostContactSummaryStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+};
+/**
+ * @public
+ */
+export type PostContactSummaryStatus = (typeof PostContactSummaryStatus)[keyof typeof PostContactSummaryStatus];
+/**
+ * <p>Information about the post-contact summary.</p>
+ * @public
+ */
+export interface PostContactSummary {
+    /**
+     * <p>The content of the summary.</p>
+     * @public
+     */
+    Content?: string;
+    /**
+     * <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
+     * @public
+     */
+    Status: PostContactSummaryStatus | undefined;
+    /**
+     * <p>If the summary failed to be generated, one of the following failure codes
+     *             occurs:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached
+     *                     your service quota.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have
+     *                     at least one turn from both the participants in order to generate the
+     *                     summary.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be
+     *                     provided because it failed to meet system safety guidelines.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for
+     *                     example, you're using a
+     *                     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a>
+     *                      that isn't supported by generative AI-powered post-contact summaries.
+     *                 </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INTERNAL_ERROR</code>: Internal system error.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    FailureCode?: PostContactSummaryFailureCode;
+}
+/**
+ * <p>For characters that were detected as issues, where they occur in the
+ *             transcript.</p>
  * @public
  */
 export interface CharacterOffsets {
@@ -126,8 +206,8 @@ export interface CharacterOffsets {
     EndOffsetChar: number | undefined;
 }
 /**
- * <p>Potential issues that are detected based on an artificial intelligence analysis of each
- *       turn in the conversation.</p>
+ * <p>Potential issues that are detected based on an artificial intelligence analysis of
+ *             each turn in the conversation.</p>
  * @public
  */
 export interface IssueDetected {
@@ -161,7 +241,7 @@ export interface Transcript {
      */
     Id: string | undefined;
     /**
-     * <p>The identifier of the participant.</p>
+     * <p>The identifier of the participant. Valid values are CUSTOMER or AGENT.</p>
      * @public
      */
     ParticipantId: string | undefined;
@@ -186,7 +266,7 @@ export interface Transcript {
      */
     EndOffsetMillis: number | undefined;
     /**
-     * <p>The sentiment of the detected for this piece of transcript.</p>
+     * <p>The sentiment detected for this piece of transcript.</p>
      * @public
      */
     Sentiment: SentimentValue | undefined;
@@ -211,6 +291,11 @@ export interface RealtimeContactAnalysisSegment {
      * @public
      */
     Categories?: Categories;
+    /**
+     * <p>Information about the post-contact summary.</p>
+     * @public
+     */
+    PostContactSummary?: PostContactSummary;
 }
 /**
  * @public
@@ -222,18 +307,20 @@ export interface ListRealtimeContactAnalysisSegmentsResponse {
      */
     Segments: RealtimeContactAnalysisSegment[] | undefined;
     /**
-     * <p>If there are additional results, this is the token for the next set of results. If response includes <code>nextToken</code> there are two possible scenarios:</p>
+     * <p>If there are additional results, this is the token for the next set of results. If response includes <code>nextToken</code> there are two possible
+     *             scenarios:</p>
      *          <ul>
      *             <li>
      *                <p>There are more segments so another call is required to get them.</p>
      *             </li>
      *             <li>
-     *                <p>There are no more segments at this time, but more may be available later (real-time
-     *           analysis is in progress) so the client should call the operation again to get new
-     *           segments.</p>
+     *                <p>There are no more segments at this time, but more may be available later
+     *                     (real-time analysis is in progress) so the client should call the operation
+     *                     again to get new segments.</p>
      *             </li>
      *          </ul>
-     *          <p>If response does not include <code>nextToken</code>, the analysis is completed (successfully or failed) and there are no more segments to retrieve.</p>
+     *          <p>If response does not include <code>nextToken</code>, the analysis is completed
+     *             (successfully or failed) and there are no more segments to retrieve.</p>
      * @public
      */
     NextToken?: string;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -41,6 +41,26 @@ export interface Categories {
   MatchedCategories: string[] | undefined;
   MatchedDetails: Record<string, CategoryDetails> | undefined;
 }
+export declare const PostContactSummaryFailureCode: {
+  readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
+  readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
+  readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+  readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
+  readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
+};
+export type PostContactSummaryFailureCode =
+  (typeof PostContactSummaryFailureCode)[keyof typeof PostContactSummaryFailureCode];
+export declare const PostContactSummaryStatus: {
+  readonly COMPLETED: "COMPLETED";
+  readonly FAILED: "FAILED";
+};
+export type PostContactSummaryStatus =
+  (typeof PostContactSummaryStatus)[keyof typeof PostContactSummaryStatus];
+export interface PostContactSummary {
+  Content?: string;
+  Status: PostContactSummaryStatus | undefined;
+  FailureCode?: PostContactSummaryFailureCode;
+}
 export interface CharacterOffsets {
   BeginOffsetChar: number | undefined;
   EndOffsetChar: number | undefined;
@@ -68,6 +88,7 @@ export interface Transcript {
 export interface RealtimeContactAnalysisSegment {
   Transcript?: Transcript;
   Categories?: Categories;
+  PostContactSummary?: PostContactSummary;
 }
 export interface ListRealtimeContactAnalysisSegmentsResponse {
   Segments: RealtimeContactAnalysisSegment[] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-connect-contact-lens",
   "description": "AWS SDK for JavaScript Connect Contact Lens Client for Node.js, Browser and React Native",
-  "version": "3.616.0",
+  "version": "3.620.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-connect-contact-lens",
@@ -20,40 +20,40 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.616.0",
-    "@aws-sdk/client-sts": "3.616.0",
-    "@aws-sdk/core": "3.616.0",
-    "@aws-sdk/credential-provider-node": "3.616.0",
-    "@aws-sdk/middleware-host-header": "3.616.0",
+    "@aws-sdk/client-sso-oidc": "3.620.0",
+    "@aws-sdk/client-sts": "3.620.0",
+    "@aws-sdk/core": "3.620.0",
+    "@aws-sdk/credential-provider-node": "3.620.0",
+    "@aws-sdk/middleware-host-header": "3.620.0",
     "@aws-sdk/middleware-logger": "3.609.0",
-    "@aws-sdk/middleware-recursion-detection": "3.616.0",
-    "@aws-sdk/middleware-user-agent": "3.616.0",
+    "@aws-sdk/middleware-recursion-detection": "3.620.0",
+    "@aws-sdk/middleware-user-agent": "3.620.0",
     "@aws-sdk/region-config-resolver": "3.614.0",
     "@aws-sdk/types": "3.609.0",
     "@aws-sdk/util-endpoints": "3.614.0",
     "@aws-sdk/util-user-agent-browser": "3.609.0",
     "@aws-sdk/util-user-agent-node": "3.614.0",
     "@smithy/config-resolver": "^3.0.5",
-    "@smithy/core": "^2.2.7",
-    "@smithy/fetch-http-handler": "^3.2.2",
+    "@smithy/core": "^2.3.0",
+    "@smithy/fetch-http-handler": "^3.2.3",
     "@smithy/hash-node": "^3.0.3",
     "@smithy/invalid-dependency": "^3.0.3",
-    "@smithy/middleware-content-length": "^3.0.4",
-    "@smithy/middleware-endpoint": "^3.0.5",
-    "@smithy/middleware-retry": "^3.0.10",
+    "@smithy/middleware-content-length": "^3.0.5",
+    "@smithy/middleware-endpoint": "^3.1.0",
+    "@smithy/middleware-retry": "^3.0.12",
     "@smithy/middleware-serde": "^3.0.3",
     "@smithy/middleware-stack": "^3.0.3",
     "@smithy/node-config-provider": "^3.1.4",
-    "@smithy/node-http-handler": "^3.1.3",
-    "@smithy/protocol-http": "^4.0.4",
-    "@smithy/smithy-client": "^3.1.8",
+    "@smithy/node-http-handler": "^3.1.4",
+    "@smithy/protocol-http": "^4.1.0",
+    "@smithy/smithy-client": "^3.1.10",
     "@smithy/types": "^3.3.0",
     "@smithy/url-parser": "^3.0.3",
     "@smithy/util-base64": "^3.0.0",
     "@smithy/util-body-length-browser": "^3.0.0",
     "@smithy/util-body-length-node": "^3.0.0",
-    "@smithy/util-defaults-mode-browser": "^3.0.10",
-    "@smithy/util-defaults-mode-node": "^3.0.10",
+    "@smithy/util-defaults-mode-browser": "^3.0.12",
+    "@smithy/util-defaults-mode-node": "^3.0.12",
     "@smithy/util-endpoints": "^2.0.5",
     "@smithy/util-middleware": "^3.0.3",
     "@smithy/util-retry": "^3.0.3",