@aws-sdk/client-connect-contact-lens - npm Package Compare versions

Comparing version 3.616.0 to 3.618.0

dist-cjs/index.js

@@ -32,2 +32,4 @@ "use strict";
   ListRealtimeContactAnalysisSegmentsCommand: () => ListRealtimeContactAnalysisSegmentsCommand,
+  PostContactSummaryFailureCode: () => PostContactSummaryFailureCode,
+  PostContactSummaryStatus: () => PostContactSummaryStatus,
   ResourceNotFoundException: () => ResourceNotFoundException,
@@ -266,2 +268,13 @@ SentimentValue: () => SentimentValue,
 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 = {
@@ -486,2 +499,4 @@ NEGATIVE: "NEGATIVE",
   InvalidRequestException,
+  PostContactSummaryFailureCode,
+  PostContactSummaryStatus,
   SentimentValue,
@@ -488,0 +503,0 @@ ResourceNotFoundException,

dist-es/models/models_0.js

@@ -41,2 +41,13 @@ import { ConnectContactLensServiceException as __BaseException } from "./ConnectContactLensServiceException";
 }
+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 = {
@@ -43,0 +54,0 @@ NEGATIVE: "NEGATIVE",

dist-types/commands/ListRealtimeContactAnalysisSegmentsCommand.d.ts

@@ -80,2 +80,7 @@ import { Command as $Command } from "@smithy/smithy-client";
  * //       },
+ * //       PostContactSummary: { // PostContactSummary
+ * //         Content: "STRING_VALUE",
+ * //         Status: "FAILED" || "COMPLETED", // required
+ * //         FailureCode: "QUOTA_EXCEEDED" || "INSUFFICIENT_CONVERSATION_CONTENT" || "FAILED_SAFETY_GUIDELINES" || "INVALID_ANALYSIS_CONFIGURATION" || "INTERNAL_ERROR",
+ * //       },
  * //     },
@@ -82,0 +87,0 @@ * //   ],

dist-types/ConnectContactLens.d.ts

@@ -13,9 +13,22 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
 /**
- * <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
@@ -22,0 +35,0 @@ */

dist-types/ConnectContactLensClient.d.ts

@@ -155,9 +155,22 @@ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
 /**
- * <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
@@ -164,0 +177,0 @@ */

dist-types/index.d.ts

 /**
- * <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>
  *
@@ -10,0 +23,0 @@ * @packageDocumentation

dist-types/models/models_0.d.ts

@@ -57,3 +57,3 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
     /**
-     * <p>The maximimum number of results to return per page.</p>
+     * <p>The maximum number of results to return per page.</p>
      * @public
@@ -97,4 +97,4 @@ */
 /**
- * <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
@@ -115,5 +115,85 @@ */
 /**
- * <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 {
@@ -132,4 +212,4 @@ /**
 /**
- * <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
@@ -168,3 +248,3 @@ */
     /**
-     * <p>The identifier of the participant.</p>
+     * <p>The identifier of the participant. Valid values are CUSTOMER or AGENT.</p>
      * @public
@@ -194,3 +274,3 @@ */
     /**
-     * <p>The sentiment of the detected for this piece of transcript.</p>
+     * <p>The sentiment detected for this piece of transcript.</p>
      * @public
@@ -220,2 +300,7 @@ */
     Categories?: Categories;
+    /**
+     * <p>Information about the post-contact summary.</p>
+     * @public
+     */
+    PostContactSummary?: PostContactSummary;
 }
@@ -232,3 +317,4 @@ /**
     /**
-     * <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>
@@ -239,8 +325,9 @@ *             <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
@@ -247,0 +334,0 @@ */

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

@@ -44,2 +44,22 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 }
+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 {
@@ -72,2 +92,3 @@ BeginOffsetChar: number | undefined;
   Categories?: Categories;
+  PostContactSummary?: PostContactSummary;
 }
@@ -74,0 +95,0 @@ export interface ListRealtimeContactAnalysisSegmentsResponse {

package.json

 {
   "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.618.0",
   "scripts": {
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",

README.md

@@ -9,9 +9,22 @@ <!-- generated file, do not edit directly -->
 
-<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>
 
@@ -18,0 +31,0 @@ ## Installing

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

167097

increased by4.68%

Lines of code

3181

increased by5.93%

Number of lines in readme file

239

increased by5.75%

No dependency changes