@aws-sdk/client-connect-contact-lens 3.1116.0 → 3.1117.0

package/dist-cjs/index.js

@@ -69,7 +69,7 @@ const commonParams = {
     UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
 };
 
-var version = "3.1115.0";
+var version = "3.1116.0";
 var packageInfo = {
 	version: version};
 
@@ -217,8 +217,15 @@ const _CD = "CategoryDetails";
 const _CI = "ContactId";
 const _CO = "CharacterOffsets";
 const _Co = "Content";
+const _EDDL = "ExtractionDefinitionDisplayLabel";
+const _EDI = "ExtractionDefinitionId";
+const _EDN = "ExtractionDefinitionName";
+const _EI = "ExtractedInformation";
+const _EIV = "ExtractedInformationValue";
+const _EIVx = "ExtractedInformationValues";
 const _EOC = "EndOffsetChar";
 const _EOM = "EndOffsetMillis";
+const _EV = "ExtractedValues";
 const _FC = "FailureCode";
 const _I = "Id";
 const _ID = "IssueDetected";
@@ -307,6 +314,16 @@ var CharacterOffsets$ = [3, n0, _CO,
     [_BOC, _EOC],
     [1, 1], 2
 ];
+var ExtractedInformation$ = [3, n0, _EI,
+    0,
+    [_EDI, _EDN, _EDDL, _EV, _FC],
+    [0, 0, 0, () => ExtractedInformationValues, 0], 2
+];
+var ExtractedInformationValue$ = [3, n0, _EIV,
+    0,
+    [_Co, _POI],
+    [0, () => PointsOfInterest], 2
+];
 var IssueDetected$ = [3, n0, _ID,
     0,
     [_CO],
@@ -334,14 +351,17 @@ var PostContactSummary$ = [3, n0, _PCS,
 ];
 var RealtimeContactAnalysisSegment$ = [3, n0, _RCAS,
     0,
-    [_T, _C, _PCS],
-    [() => Transcript$, () => Categories$, () => PostContactSummary$]
+    [_T, _C, _PCS, _EI],
+    [() => Transcript$, () => Categories$, () => PostContactSummary$, () => ExtractedInformation$]
 ];
 var Transcript$ = [3, n0, _T,
     0,
     [_I, _PI, _PR, _Co, _BOM, _EOM, _Se, _IDs],
     [0, 0, 0, 0, 1, 1, 0, () => IssuesDetected], 6
 ];
+var ExtractedInformationValues = [1, n0, _EIVx,
+    0, () => ExtractedInformationValue$
+];
 var IssuesDetected = [1, n0, _IDs,
     0, () => IssueDetected$
 ];
@@ -523,6 +543,13 @@ class ConnectContactLens extends ConnectContactLensClient {
 }
 createAggregatedClient(commands, ConnectContactLens, { paginators });
 
+const ExtractedInformationFailureCode = {
+    FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
+    INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",
+    INTERNAL_ERROR: "INTERNAL_ERROR",
+    MAX_PACKAGE_FEATURE_ONLY: "MAX_PACKAGE_FEATURE_ONLY",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
+};
 const PostContactSummaryFailureCode = {
     FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
     INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",
@@ -549,6 +576,9 @@ exports.ConnectContactLens = ConnectContactLens;
 exports.ConnectContactLensClient = ConnectContactLensClient;
 exports.ConnectContactLensServiceException = ConnectContactLensServiceException;
 exports.ConnectContactLensServiceException$ = ConnectContactLensServiceException$;
+exports.ExtractedInformation$ = ExtractedInformation$;
+exports.ExtractedInformationFailureCode = ExtractedInformationFailureCode;
+exports.ExtractedInformationValue$ = ExtractedInformationValue$;
 exports.InternalServiceException = InternalServiceException;
 exports.InternalServiceException$ = InternalServiceException$;
 exports.InvalidRequestException = InvalidRequestException;

package/dist-es/models/enums.js

@@ -1,3 +1,10 @@
+export const ExtractedInformationFailureCode = {
+    FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
+    INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",
+    INTERNAL_ERROR: "INTERNAL_ERROR",
+    MAX_PACKAGE_FEATURE_ONLY: "MAX_PACKAGE_FEATURE_ONLY",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
+};
 export const PostContactSummaryFailureCode = {
     FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES",
     INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT",

package/dist-es/schemas/schemas_0.js

@@ -6,8 +6,15 @@ const _CD = "CategoryDetails";
 const _CI = "ContactId";
 const _CO = "CharacterOffsets";
 const _Co = "Content";
+const _EDDL = "ExtractionDefinitionDisplayLabel";
+const _EDI = "ExtractionDefinitionId";
+const _EDN = "ExtractionDefinitionName";
+const _EI = "ExtractedInformation";
+const _EIV = "ExtractedInformationValue";
+const _EIVx = "ExtractedInformationValues";
 const _EOC = "EndOffsetChar";
 const _EOM = "EndOffsetMillis";
+const _EV = "ExtractedValues";
 const _FC = "FailureCode";
 const _I = "Id";
 const _ID = "IssueDetected";
@@ -99,6 +106,16 @@ export var CharacterOffsets$ = [3, n0, _CO,
     [_BOC, _EOC],
     [1, 1], 2
 ];
+export var ExtractedInformation$ = [3, n0, _EI,
+    0,
+    [_EDI, _EDN, _EDDL, _EV, _FC],
+    [0, 0, 0, () => ExtractedInformationValues, 0], 2
+];
+export var ExtractedInformationValue$ = [3, n0, _EIV,
+    0,
+    [_Co, _POI],
+    [0, () => PointsOfInterest], 2
+];
 export var IssueDetected$ = [3, n0, _ID,
     0,
     [_CO],
@@ -126,14 +143,17 @@ export var PostContactSummary$ = [3, n0, _PCS,
 ];
 export var RealtimeContactAnalysisSegment$ = [3, n0, _RCAS,
     0,
-    [_T, _C, _PCS],
-    [() => Transcript$, () => Categories$, () => PostContactSummary$]
+    [_T, _C, _PCS, _EI],
+    [() => Transcript$, () => Categories$, () => PostContactSummary$, () => ExtractedInformation$]
 ];
 export var Transcript$ = [3, n0, _T,
     0,
     [_I, _PI, _PR, _Co, _BOM, _EOM, _Se, _IDs],
     [0, 0, 0, 0, 1, 1, 0, () => IssuesDetected], 6
 ];
+var ExtractedInformationValues = [1, n0, _EIVx,
+    0, () => ExtractedInformationValue$
+];
 var IssuesDetected = [1, n0, _IDs,
     0, () => IssueDetected$
 ];

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

@@ -24,7 +24,12 @@ declare const ListRealtimeContactAnalysisSegmentsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Provides a list of analysis segments for a real-time analysis session.</p>
+ * <p>Provides a list of analysis segments for a real-time analysis session for
+ *             voice.</p>
+ *          <note>
+ *             <p>Voice data is retained for 24 hours. You must invoke this API during that
+ *                 time.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -81,6 +86,23 @@ declare const ListRealtimeContactAnalysisSegmentsCommand_base: {
  * //         Status: "FAILED" || "COMPLETED", // required
  * //         FailureCode: "QUOTA_EXCEEDED" || "INSUFFICIENT_CONVERSATION_CONTENT" || "FAILED_SAFETY_GUIDELINES" || "INVALID_ANALYSIS_CONFIGURATION" || "INTERNAL_ERROR",
  * //       },
+ * //       ExtractedInformation: { // ExtractedInformation
+ * //         ExtractionDefinitionId: "STRING_VALUE", // required
+ * //         ExtractionDefinitionName: "STRING_VALUE", // required
+ * //         ExtractionDefinitionDisplayLabel: "STRING_VALUE",
+ * //         ExtractedValues: [ // ExtractedInformationValues
+ * //           { // ExtractedInformationValue
+ * //             Content: "STRING_VALUE", // required
+ * //             PointsOfInterest: [ // required
+ * //               {
+ * //                 BeginOffsetMillis: Number("int"), // required
+ * //                 EndOffsetMillis: Number("int"), // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         ],
+ * //         FailureCode: "QUOTA_EXCEEDED" || "INSUFFICIENT_CONVERSATION_CONTENT" || "FAILED_SAFETY_GUIDELINES" || "INTERNAL_ERROR" || "MAX_PACKAGE_FEATURE_ONLY",
+ * //       },
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

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

@@ -1,3 +1,18 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ExtractedInformationFailureCode: {
+    readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
+    readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+    readonly MAX_PACKAGE_FEATURE_ONLY: "MAX_PACKAGE_FEATURE_ONLY";
+    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
+};
+/**
+ * @public
+ */
+export type ExtractedInformationFailureCode = (typeof ExtractedInformationFailureCode)[keyof typeof ExtractedInformationFailureCode];
 /**
  * @public
  * @enum

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

@@ -1,4 +1,4 @@
-import type { PostContactSummaryFailureCode, PostContactSummaryStatus, SentimentValue } from "./enums";
+import type { ExtractedInformationFailureCode, PostContactSummaryFailureCode, PostContactSummaryStatus, SentimentValue } from "./enums";
 /**
  * @public
  */
@@ -26,17 +26,17 @@ export interface ListRealtimeContactAnalysisSegmentsRequest {
     NextToken?: string | undefined;
 }
 /**
- * <p>The section of the contact audio where that category rule was detected.</p>
+ * <p>The section of the contact audio where a match was detected.</p>
  * @public
  */
 export interface PointOfInterest {
     /**
-     * <p>The beginning offset in milliseconds where the category rule was detected.</p>
+     * <p>The beginning offset (in milliseconds) where the match was detected.</p>
      * @public
      */
     BeginOffsetMillis: number | undefined;
     /**
-     * <p>The ending offset in milliseconds where the category rule was detected.</p>
+     * <p>The ending offset (in milliseconds) where the match was detected.</p>
      * @public
      */
     EndOffsetMillis: number | undefined;
@@ -69,6 +69,84 @@ export interface Categories {
      */
     MatchedDetails: Record<string, CategoryDetails> | undefined;
 }
+/**
+ * <p>An individual value extracted from the conversation, including its content and the
+ *             locations where it was found.</p>
+ * @public
+ */
+export interface ExtractedInformationValue {
+    /**
+     * <p>The text content of the extracted value.</p>
+     * @public
+     */
+    Content: string | undefined;
+    /**
+     * <p>The sections in the conversation that indicate where the extracted value was
+     *             found.</p>
+     * @public
+     */
+    PointsOfInterest: PointOfInterest[] | undefined;
+}
+/**
+ * <p>Segment containing information extracted from the conversation. Each segment
+ *             represents the results for a single extraction definition.</p>
+ * @public
+ */
+export interface ExtractedInformation {
+    /**
+     * <p>The identifier of the extraction definition that produced this result.</p>
+     * @public
+     */
+    ExtractionDefinitionId: string | undefined;
+    /**
+     * <p>The name of the extraction definition that produced this result.</p>
+     * @public
+     */
+    ExtractionDefinitionName: string | undefined;
+    /**
+     * <p>The display label of the extraction definition that produced this result.</p>
+     * @public
+     */
+    ExtractionDefinitionDisplayLabel?: string | undefined;
+    /**
+     * <p>The list of values extracted from the conversation for this extraction definition.
+     *             This field is empty when a <code>FailureCode</code> is present.</p>
+     * @public
+     */
+    ExtractedValues?: ExtractedInformationValue[] | undefined;
+    /**
+     * <p>If the information failed to be extracted, 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>: Information extraction requires a
+     *                     conversation with at least one turn from each participant.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FAILED_SAFETY_GUIDELINES</code>: The extracted information cannot be
+     *                     provided because it failed to meet system safety guidelines.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INTERNAL_ERROR</code>: Internal system error.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>MAX_PACKAGE_FEATURE_ONLY</code>: Information extraction is only available
+     *                     in Amazon Connect Customer instances.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    FailureCode?: ExtractedInformationFailureCode | undefined;
+}
 /**
  * <p>Information about the post-contact summary.</p>
  * @public
@@ -107,10 +185,8 @@ export interface PostContactSummary {
      *             <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>
+     *                     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>
@@ -216,6 +292,11 @@ export interface RealtimeContactAnalysisSegment {
      * @public
      */
     PostContactSummary?: PostContactSummary | undefined;
+    /**
+     * <p>The extracted information from the conversation.</p>
+     * @public
+     */
+    ExtractedInformation?: ExtractedInformation | undefined;
 }
 /**
  * @public

package/dist-types/schemas/schemas_0.d.ts

@@ -15,6 +15,8 @@ export declare const errorTypeRegistries: TypeRegistry[];
 export declare var Categories$: StaticStructureSchema;
 export declare var CategoryDetails$: StaticStructureSchema;
 export declare var CharacterOffsets$: StaticStructureSchema;
+export declare var ExtractedInformation$: StaticStructureSchema;
+export declare var ExtractedInformationValue$: StaticStructureSchema;
 export declare var IssueDetected$: StaticStructureSchema;
 export declare var ListRealtimeContactAnalysisSegmentsRequest$: StaticStructureSchema;
 export declare var ListRealtimeContactAnalysisSegmentsResponse$: StaticStructureSchema;

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

@@ -1,3 +1,12 @@
+export declare const ExtractedInformationFailureCode: {
+  readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
+  readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
+  readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+  readonly MAX_PACKAGE_FEATURE_ONLY: "MAX_PACKAGE_FEATURE_ONLY";
+  readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
+};
+export type ExtractedInformationFailureCode =
+  (typeof ExtractedInformationFailureCode)[keyof typeof ExtractedInformationFailureCode];
 export declare const PostContactSummaryFailureCode: {
   readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
   readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";

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

@@ -1,4 +1,9 @@
-import { PostContactSummaryFailureCode, PostContactSummaryStatus, SentimentValue } from "./enums";
+import {
+  ExtractedInformationFailureCode,
+  PostContactSummaryFailureCode,
+  PostContactSummaryStatus,
+  SentimentValue,
+} from "./enums";
 export interface ListRealtimeContactAnalysisSegmentsRequest {
   InstanceId: string | undefined;
   ContactId: string | undefined;
@@ -16,6 +21,17 @@ export interface Categories {
   MatchedCategories: string[] | undefined;
   MatchedDetails: Record<string, CategoryDetails> | undefined;
 }
+export interface ExtractedInformationValue {
+  Content: string | undefined;
+  PointsOfInterest: PointOfInterest[] | undefined;
+}
+export interface ExtractedInformation {
+  ExtractionDefinitionId: string | undefined;
+  ExtractionDefinitionName: string | undefined;
+  ExtractionDefinitionDisplayLabel?: string | undefined;
+  ExtractedValues?: ExtractedInformationValue[] | undefined;
+  FailureCode?: ExtractedInformationFailureCode | undefined;
+}
 export interface PostContactSummary {
   Content?: string | undefined;
   Status: PostContactSummaryStatus | undefined;
@@ -42,6 +58,7 @@ export interface RealtimeContactAnalysisSegment {
   Transcript?: Transcript | undefined;
   Categories?: Categories | undefined;
   PostContactSummary?: PostContactSummary | undefined;
+  ExtractedInformation?: ExtractedInformation | undefined;
 }
 export interface ListRealtimeContactAnalysisSegmentsResponse {
   Segments: RealtimeContactAnalysisSegment[] | undefined;

package/dist-types/ts3.4/schemas/schemas_0.d.ts

@@ -10,6 +10,8 @@ export declare const errorTypeRegistries: TypeRegistry[];
 export declare var Categories$: StaticStructureSchema;
 export declare var CategoryDetails$: StaticStructureSchema;
 export declare var CharacterOffsets$: StaticStructureSchema;
+export declare var ExtractedInformation$: StaticStructureSchema;
+export declare var ExtractedInformationValue$: StaticStructureSchema;
 export declare var IssueDetected$: StaticStructureSchema;
 export declare var ListRealtimeContactAnalysisSegmentsRequest$: StaticStructureSchema;
 export declare var ListRealtimeContactAnalysisSegmentsResponse$: StaticStructureSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/client-connect-contact-lens",
-  "version": "3.1116.0",
+  "version": "3.1117.0",
   "description": "AWS SDK for JavaScript Connect Contact Lens Client for Node.js, Browser and React Native",
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-connect-contact-lens",
   "license": "Apache-2.0",