@aws-sdk/client-wisdom 3.451.0 → 3.454.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/README.md +80 -0
  2. package/dist-cjs/Wisdom.js +20 -0
  3. package/dist-cjs/commands/CreateQuickResponseCommand.js +52 -0
  4. package/dist-cjs/commands/DeleteImportJobCommand.js +51 -0
  5. package/dist-cjs/commands/DeleteQuickResponseCommand.js +51 -0
  6. package/dist-cjs/commands/GetImportJobCommand.js +52 -0
  7. package/dist-cjs/commands/GetQuickResponseCommand.js +52 -0
  8. package/dist-cjs/commands/ListImportJobsCommand.js +51 -0
  9. package/dist-cjs/commands/ListQuickResponsesCommand.js +52 -0
  10. package/dist-cjs/commands/SearchQuickResponsesCommand.js +52 -0
  11. package/dist-cjs/commands/StartImportJobCommand.js +52 -0
  12. package/dist-cjs/commands/UpdateQuickResponseCommand.js +52 -0
  13. package/dist-cjs/commands/index.js +10 -0
  14. package/dist-cjs/models/models_0.js +200 -1
  15. package/dist-cjs/pagination/ListImportJobsPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListQuickResponsesPaginator.js +29 -0
  17. package/dist-cjs/pagination/SearchQuickResponsesPaginator.js +29 -0
  18. package/dist-cjs/pagination/index.js +3 -0
  19. package/dist-cjs/protocols/Aws_restJson1.js +816 -18
  20. package/dist-es/Wisdom.js +20 -0
  21. package/dist-es/commands/CreateQuickResponseCommand.js +48 -0
  22. package/dist-es/commands/DeleteImportJobCommand.js +47 -0
  23. package/dist-es/commands/DeleteQuickResponseCommand.js +47 -0
  24. package/dist-es/commands/GetImportJobCommand.js +48 -0
  25. package/dist-es/commands/GetQuickResponseCommand.js +48 -0
  26. package/dist-es/commands/ListImportJobsCommand.js +47 -0
  27. package/dist-es/commands/ListQuickResponsesCommand.js +48 -0
  28. package/dist-es/commands/SearchQuickResponsesCommand.js +48 -0
  29. package/dist-es/commands/StartImportJobCommand.js +48 -0
  30. package/dist-es/commands/UpdateQuickResponseCommand.js +48 -0
  31. package/dist-es/commands/index.js +10 -0
  32. package/dist-es/models/models_0.js +179 -0
  33. package/dist-es/pagination/ListImportJobsPaginator.js +25 -0
  34. package/dist-es/pagination/ListQuickResponsesPaginator.js +25 -0
  35. package/dist-es/pagination/SearchQuickResponsesPaginator.js +25 -0
  36. package/dist-es/pagination/index.js +3 -0
  37. package/dist-es/protocols/Aws_restJson1.js +794 -16
  38. package/dist-types/Wisdom.d.ts +70 -0
  39. package/dist-types/WisdomClient.d.ts +12 -2
  40. package/dist-types/commands/CreateQuickResponseCommand.d.ts +149 -0
  41. package/dist-types/commands/DeleteImportJobCommand.d.ts +87 -0
  42. package/dist-types/commands/DeleteQuickResponseCommand.d.ts +81 -0
  43. package/dist-types/commands/GetImportJobCommand.d.ts +106 -0
  44. package/dist-types/commands/GetQuickResponseCommand.d.ts +118 -0
  45. package/dist-types/commands/ListImportJobsCommand.d.ts +104 -0
  46. package/dist-types/commands/ListQuickResponsesCommand.d.ts +106 -0
  47. package/dist-types/commands/QueryAssistantCommand.d.ts +5 -0
  48. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +163 -0
  49. package/dist-types/commands/StartContentUploadCommand.d.ts +1 -0
  50. package/dist-types/commands/StartImportJobCommand.d.ts +135 -0
  51. package/dist-types/commands/UpdateQuickResponseCommand.d.ts +149 -0
  52. package/dist-types/commands/index.d.ts +10 -0
  53. package/dist-types/models/models_0.d.ts +1631 -167
  54. package/dist-types/pagination/ListImportJobsPaginator.d.ts +7 -0
  55. package/dist-types/pagination/ListQuickResponsesPaginator.d.ts +7 -0
  56. package/dist-types/pagination/SearchQuickResponsesPaginator.d.ts +7 -0
  57. package/dist-types/pagination/index.d.ts +3 -0
  58. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  59. package/dist-types/ts3.4/Wisdom.d.ts +170 -0
  60. package/dist-types/ts3.4/WisdomClient.d.ts +62 -2
  61. package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +39 -0
  62. package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +38 -0
  63. package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +39 -0
  64. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +35 -0
  65. package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +38 -0
  66. package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +38 -0
  67. package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +39 -0
  68. package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +42 -0
  69. package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +38 -0
  70. package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +39 -0
  71. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  72. package/dist-types/ts3.4/models/models_0.d.ts +397 -0
  73. package/dist-types/ts3.4/pagination/ListImportJobsPaginator.d.ts +11 -0
  74. package/dist-types/ts3.4/pagination/ListQuickResponsesPaginator.d.ts +11 -0
  75. package/dist-types/ts3.4/pagination/SearchQuickResponsesPaginator.d.ts +11 -0
  76. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  77. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  78. package/package.json +2 -2
@@ -113,7 +113,8 @@ export type AssistantAssociationInputData = AssistantAssociationInputData.Knowle
113
113
  export declare namespace AssistantAssociationInputData {
114
114
  /**
115
115
  * @public
116
- * <p>The identifier of the knowledge base.</p>
116
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
117
+ * base if you're storing Wisdom Content resource to it.</p>
117
118
  */
118
119
  interface KnowledgeBaseIdMember {
119
120
  knowledgeBaseId: string;
@@ -183,7 +184,8 @@ export interface CreateAssistantAssociationRequest {
183
184
  export interface KnowledgeBaseAssociationData {
184
185
  /**
185
186
  * @public
186
- * <p>The identifier of the knowledge base.</p>
187
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
188
+ * base if you're storing Wisdom Content resource to it.</p>
187
189
  */
188
190
  knowledgeBaseId?: string;
189
191
  /**
@@ -496,8 +498,8 @@ export interface CreateAssistantRequest {
496
498
  /**
497
499
  * @public
498
500
  * <p>The configuration information for the customer managed key used for encryption. </p>
499
- * <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>
500
- * and <code> kms:DescribeKey</code> permissions to the IAM identity using the key
501
+ * <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
502
+ * <code> kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
501
503
  * to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
502
504
  * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
503
505
  * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
@@ -577,11 +579,11 @@ export interface AssistantData {
577
579
  /**
578
580
  * @public
579
581
  * <p>The configuration information for the customer managed key used for encryption. </p>
580
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
581
- * and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
582
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
583
+ * <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
582
584
  * to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
583
- * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
584
- * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
585
+ * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and <code>kms:DescribeKey</code>
586
+ * permissions to the <code>connect.amazonaws.com</code> service
585
587
  * principal. </p>
586
588
  * <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
587
589
  * for your instance</a>.</p>
@@ -678,7 +680,8 @@ export interface ContentReference {
678
680
  knowledgeBaseArn?: string;
679
681
  /**
680
682
  * @public
681
- * <p>The identifier of the knowledge base.</p>
683
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
684
+ * base if you're storing Wisdom Content resource to it.</p>
682
685
  */
683
686
  knowledgeBaseId?: string;
684
687
  /**
@@ -983,8 +986,8 @@ export interface AssistantSummary {
983
986
  /**
984
987
  * @public
985
988
  * <p>The configuration information for the customer managed key used for encryption. </p>
986
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
987
- * and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
989
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
990
+ * <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
988
991
  * to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
989
992
  * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
990
993
  * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
@@ -1127,6 +1130,21 @@ export interface QueryAssistantResponse {
1127
1130
  */
1128
1131
  nextToken?: string;
1129
1132
  }
1133
+ /**
1134
+ * @public
1135
+ * <p>The request reached the service more than 15 minutes after the date stamp on the request
1136
+ * or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
1137
+ * the date stamp on the request is more than 15 minutes in the future.</p>
1138
+ */
1139
+ export declare class RequestTimeoutException extends __BaseException {
1140
+ readonly name: "RequestTimeoutException";
1141
+ readonly $fault: "client";
1142
+ $retryable: {};
1143
+ /**
1144
+ * @internal
1145
+ */
1146
+ constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>);
1147
+ }
1130
1148
  /**
1131
1149
  * @public
1132
1150
  * @enum
@@ -1363,13 +1381,55 @@ export interface GetSessionResponse {
1363
1381
  */
1364
1382
  session?: SessionData;
1365
1383
  }
1384
+ /**
1385
+ * @public
1386
+ * <p>The configuration information of the Amazon Connect data source.</p>
1387
+ */
1388
+ export interface ConnectConfiguration {
1389
+ /**
1390
+ * @public
1391
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
1392
+ */
1393
+ instanceId?: string;
1394
+ }
1395
+ /**
1396
+ * @public
1397
+ * <p>The configuration information of the external data source.</p>
1398
+ */
1399
+ export type Configuration = Configuration.ConnectConfigurationMember | Configuration.$UnknownMember;
1400
+ /**
1401
+ * @public
1402
+ */
1403
+ export declare namespace Configuration {
1404
+ /**
1405
+ * @public
1406
+ * <p>The configuration information of the Amazon Connect data source.</p>
1407
+ */
1408
+ interface ConnectConfigurationMember {
1409
+ connectConfiguration: ConnectConfiguration;
1410
+ $unknown?: never;
1411
+ }
1412
+ /**
1413
+ * @public
1414
+ */
1415
+ interface $UnknownMember {
1416
+ connectConfiguration?: never;
1417
+ $unknown: [string, any];
1418
+ }
1419
+ interface Visitor<T> {
1420
+ connectConfiguration: (value: ConnectConfiguration) => T;
1421
+ _: (name: string, value: any) => T;
1422
+ }
1423
+ const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
1424
+ }
1366
1425
  /**
1367
1426
  * @public
1368
1427
  */
1369
1428
  export interface CreateContentRequest {
1370
1429
  /**
1371
1430
  * @public
1372
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1431
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1432
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1373
1433
  */
1374
1434
  knowledgeBaseId: string | undefined;
1375
1435
  /**
@@ -1454,7 +1514,8 @@ export interface ContentData {
1454
1514
  knowledgeBaseArn: string | undefined;
1455
1515
  /**
1456
1516
  * @public
1457
- * <p>The identifier of the knowledge base.</p>
1517
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1518
+ * base if you're storing Wisdom Content resource to it.</p>
1458
1519
  */
1459
1520
  knowledgeBaseId: string | undefined;
1460
1521
  /**
@@ -1525,7 +1586,8 @@ export interface CreateContentResponse {
1525
1586
  export interface DeleteContentRequest {
1526
1587
  /**
1527
1588
  * @public
1528
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1589
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1590
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1529
1591
  */
1530
1592
  knowledgeBaseId: string | undefined;
1531
1593
  /**
@@ -1550,7 +1612,8 @@ export interface GetContentRequest {
1550
1612
  contentId: string | undefined;
1551
1613
  /**
1552
1614
  * @public
1553
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1615
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1616
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1554
1617
  */
1555
1618
  knowledgeBaseId: string | undefined;
1556
1619
  }
@@ -1575,7 +1638,8 @@ export interface GetContentSummaryRequest {
1575
1638
  contentId: string | undefined;
1576
1639
  /**
1577
1640
  * @public
1578
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1641
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1642
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1579
1643
  */
1580
1644
  knowledgeBaseId: string | undefined;
1581
1645
  }
@@ -1601,7 +1665,8 @@ export interface ContentSummary {
1601
1665
  knowledgeBaseArn: string | undefined;
1602
1666
  /**
1603
1667
  * @public
1604
- * <p>The identifier of the knowledge base.</p>
1668
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1669
+ * base if you're storing Wisdom Content resource to it.</p>
1605
1670
  */
1606
1671
  knowledgeBaseId: string | undefined;
1607
1672
  /**
@@ -1668,7 +1733,8 @@ export interface ListContentsRequest {
1668
1733
  maxResults?: number;
1669
1734
  /**
1670
1735
  * @public
1671
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1736
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1737
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1672
1738
  */
1673
1739
  knowledgeBaseId: string | undefined;
1674
1740
  }
@@ -1706,7 +1772,8 @@ export declare class PreconditionFailedException extends __BaseException {
1706
1772
  export interface UpdateContentRequest {
1707
1773
  /**
1708
1774
  * @public
1709
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN</p>
1775
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1776
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN</p>
1710
1777
  */
1711
1778
  knowledgeBaseId: string | undefined;
1712
1779
  /**
@@ -1771,6 +1838,7 @@ export interface UpdateContentResponse {
1771
1838
  export declare const KnowledgeBaseType: {
1772
1839
  readonly CUSTOM: "CUSTOM";
1773
1840
  readonly EXTERNAL: "EXTERNAL";
1841
+ readonly QUICK_RESPONSES: "QUICK_RESPONSES";
1774
1842
  };
1775
1843
  /**
1776
1844
  * @public
@@ -1875,8 +1943,8 @@ export interface CreateKnowledgeBaseRequest {
1875
1943
  /**
1876
1944
  * @public
1877
1945
  * <p>The configuration information for the customer managed key used for encryption. </p>
1878
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
1879
- * and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
1946
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
1947
+ * <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
1880
1948
  * to invoke Wisdom.</p>
1881
1949
  * <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
1882
1950
  * for your instance</a>.</p>
@@ -1916,7 +1984,8 @@ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof Know
1916
1984
  export interface KnowledgeBaseData {
1917
1985
  /**
1918
1986
  * @public
1919
- * <p>The identifier of the knowledge base.</p>
1987
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1988
+ * base if you're storing Wisdom Content resource to it.</p>
1920
1989
  */
1921
1990
  knowledgeBaseId: string | undefined;
1922
1991
  /**
@@ -1958,8 +2027,8 @@ export interface KnowledgeBaseData {
1958
2027
  /**
1959
2028
  * @public
1960
2029
  * <p>The configuration information for the customer managed key used for encryption. </p>
1961
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
1962
- * and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
2030
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
2031
+ * <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
1963
2032
  * to invoke Wisdom. </p>
1964
2033
  * <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
1965
2034
  * for your instance</a>.</p>
@@ -1988,110 +2057,140 @@ export interface CreateKnowledgeBaseResponse {
1988
2057
  }
1989
2058
  /**
1990
2059
  * @public
2060
+ * <p>The container of quick response data.</p>
1991
2061
  */
1992
- export interface DeleteKnowledgeBaseRequest {
1993
- /**
1994
- * @public
1995
- * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1996
- */
1997
- knowledgeBaseId: string | undefined;
1998
- }
1999
- /**
2000
- * @public
2001
- */
2002
- export interface DeleteKnowledgeBaseResponse {
2003
- }
2062
+ export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
2004
2063
  /**
2005
2064
  * @public
2006
2065
  */
2007
- export interface GetKnowledgeBaseRequest {
2066
+ export declare namespace QuickResponseDataProvider {
2008
2067
  /**
2009
2068
  * @public
2010
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2069
+ * <p>The content of the quick response.</p>
2011
2070
  */
2012
- knowledgeBaseId: string | undefined;
2013
- }
2014
- /**
2015
- * @public
2016
- */
2017
- export interface GetKnowledgeBaseResponse {
2071
+ interface ContentMember {
2072
+ content: string;
2073
+ $unknown?: never;
2074
+ }
2018
2075
  /**
2019
2076
  * @public
2020
- * <p>The knowledge base.</p>
2021
2077
  */
2022
- knowledgeBase?: KnowledgeBaseData;
2078
+ interface $UnknownMember {
2079
+ content?: never;
2080
+ $unknown: [string, any];
2081
+ }
2082
+ interface Visitor<T> {
2083
+ content: (value: string) => T;
2084
+ _: (name: string, value: any) => T;
2085
+ }
2086
+ const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
2023
2087
  }
2024
2088
  /**
2025
2089
  * @public
2090
+ * <p>The configuration information of the grouping of Wisdom users.</p>
2026
2091
  */
2027
- export interface ListKnowledgeBasesRequest {
2092
+ export interface GroupingConfiguration {
2028
2093
  /**
2029
2094
  * @public
2030
- * <p>The token for the next set of results. Use the value returned in the previous
2031
- * response in the next request to retrieve the next set of results.</p>
2095
+ * <p>The criteria used for grouping Wisdom users.</p>
2096
+ * <p>The following is the list of supported criteria values.</p>
2097
+ * <ul>
2098
+ * <li>
2099
+ * <p>
2100
+ * <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and
2101
+ * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
2102
+ * </li>
2103
+ * </ul>
2032
2104
  */
2033
- nextToken?: string;
2105
+ criteria?: string;
2034
2106
  /**
2035
2107
  * @public
2036
- * <p>The maximum number of results to return per page.</p>
2108
+ * <p>The list of values that define different groups of Wisdom users.</p>
2109
+ * <ul>
2110
+ * <li>
2111
+ * <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of
2112
+ * ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p>
2113
+ * </li>
2114
+ * </ul>
2037
2115
  */
2038
- maxResults?: number;
2116
+ values?: string[];
2039
2117
  }
2040
2118
  /**
2041
2119
  * @public
2042
- * <p>Summary information about the knowledge base.</p>
2043
2120
  */
2044
- export interface KnowledgeBaseSummary {
2121
+ export interface CreateQuickResponseRequest {
2045
2122
  /**
2046
2123
  * @public
2047
- * <p>The identifier of the knowledge base.</p>
2124
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2125
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2048
2126
  */
2049
2127
  knowledgeBaseId: string | undefined;
2050
2128
  /**
2051
2129
  * @public
2052
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2130
+ * <p>The name of the quick response.</p>
2053
2131
  */
2054
- knowledgeBaseArn: string | undefined;
2132
+ name: string | undefined;
2055
2133
  /**
2056
2134
  * @public
2057
- * <p>The name of the knowledge base.</p>
2135
+ * <p>The content of the quick response.</p>
2058
2136
  */
2059
- name: string | undefined;
2137
+ content: QuickResponseDataProvider | undefined;
2060
2138
  /**
2061
2139
  * @public
2062
- * <p>The type of knowledge base.</p>
2140
+ * <p>The media type of the quick response content.</p>
2141
+ * <ul>
2142
+ * <li>
2143
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p>
2144
+ * </li>
2145
+ * <li>
2146
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p>
2147
+ * </li>
2148
+ * </ul>
2063
2149
  */
2064
- knowledgeBaseType: KnowledgeBaseType | undefined;
2150
+ contentType?: string;
2065
2151
  /**
2066
2152
  * @public
2067
- * <p>The status of the knowledge base summary.</p>
2153
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
2068
2154
  */
2069
- status: KnowledgeBaseStatus | undefined;
2155
+ groupingConfiguration?: GroupingConfiguration;
2070
2156
  /**
2071
2157
  * @public
2072
- * <p>Configuration information about the external data source.</p>
2158
+ * <p>The description of the quick response.</p>
2073
2159
  */
2074
- sourceConfiguration?: SourceConfiguration;
2160
+ description?: string;
2075
2161
  /**
2076
2162
  * @public
2077
- * <p>Information about how to render the content.</p>
2163
+ * <p>The shortcut key of the quick response. The value should be unique across the
2164
+ * knowledge base.
2165
+ * </p>
2078
2166
  */
2079
- renderingConfiguration?: RenderingConfiguration;
2167
+ shortcutKey?: string;
2080
2168
  /**
2081
2169
  * @public
2082
- * <p>The configuration information for the customer managed key used for encryption. </p>
2083
- * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>
2084
- * and <code>kms:DescribeKey</code> permissions to the IAM identity using the key
2085
- * to invoke Wisdom. </p>
2086
- * <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
2087
- * for your instance</a>.</p>
2170
+ * <p>Whether the quick response is active.</p>
2088
2171
  */
2089
- serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2172
+ isActive?: boolean;
2090
2173
  /**
2091
2174
  * @public
2092
- * <p>The description of the knowledge base.</p>
2175
+ * <p>The Amazon Connect channels this quick response applies to.</p>
2093
2176
  */
2094
- description?: string;
2177
+ channels?: string[];
2178
+ /**
2179
+ * @public
2180
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
2181
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
2182
+ * <code>zh_CN</code>, <code>zh_TW</code>
2183
+ * </p>
2184
+ */
2185
+ language?: string;
2186
+ /**
2187
+ * @public
2188
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2189
+ * request. If not provided, the Amazon Web Services
2190
+ * SDK populates this field. For more information about idempotency, see
2191
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2192
+ */
2193
+ clientToken?: string;
2095
2194
  /**
2096
2195
  * @public
2097
2196
  * <p>The tags used to organize, track, or control access for this resource.</p>
@@ -2100,194 +2199,1487 @@ export interface KnowledgeBaseSummary {
2100
2199
  }
2101
2200
  /**
2102
2201
  * @public
2202
+ * <p>The container quick response content.</p>
2103
2203
  */
2104
- export interface ListKnowledgeBasesResponse {
2204
+ export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
2205
+ /**
2206
+ * @public
2207
+ */
2208
+ export declare namespace QuickResponseContentProvider {
2105
2209
  /**
2106
2210
  * @public
2107
- * <p>Information about the knowledge bases.</p>
2211
+ * <p>The content of the quick response.</p>
2108
2212
  */
2109
- knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
2213
+ interface ContentMember {
2214
+ content: string;
2215
+ $unknown?: never;
2216
+ }
2110
2217
  /**
2111
2218
  * @public
2112
- * <p>If there are additional results, this is the token for the next set of results.</p>
2113
2219
  */
2114
- nextToken?: string;
2220
+ interface $UnknownMember {
2221
+ content?: never;
2222
+ $unknown: [string, any];
2223
+ }
2224
+ interface Visitor<T> {
2225
+ content: (value: string) => T;
2226
+ _: (name: string, value: any) => T;
2227
+ }
2228
+ const visit: <T>(value: QuickResponseContentProvider, visitor: Visitor<T>) => T;
2115
2229
  }
2116
2230
  /**
2117
2231
  * @public
2232
+ * <p>The content of the quick response stored in different media types.</p>
2118
2233
  */
2119
- export interface RemoveKnowledgeBaseTemplateUriRequest {
2234
+ export interface QuickResponseContents {
2120
2235
  /**
2121
2236
  * @public
2122
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2237
+ * <p>The container quick response content.</p>
2123
2238
  */
2124
- knowledgeBaseId: string | undefined;
2239
+ plainText?: QuickResponseContentProvider;
2240
+ /**
2241
+ * @public
2242
+ * <p>The container quick response content.</p>
2243
+ */
2244
+ markdown?: QuickResponseContentProvider;
2125
2245
  }
2246
+ /**
2247
+ * @public
2248
+ * @enum
2249
+ */
2250
+ export declare const QuickResponseStatus: {
2251
+ readonly CREATED: "CREATED";
2252
+ readonly CREATE_FAILED: "CREATE_FAILED";
2253
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
2254
+ readonly DELETED: "DELETED";
2255
+ readonly DELETE_FAILED: "DELETE_FAILED";
2256
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
2257
+ readonly UPDATE_FAILED: "UPDATE_FAILED";
2258
+ readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
2259
+ };
2126
2260
  /**
2127
2261
  * @public
2128
2262
  */
2129
- export interface RemoveKnowledgeBaseTemplateUriResponse {
2130
- }
2263
+ export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
2131
2264
  /**
2132
2265
  * @public
2266
+ * <p>Information about the quick response.</p>
2133
2267
  */
2134
- export interface SearchContentRequest {
2268
+ export interface QuickResponseData {
2135
2269
  /**
2136
2270
  * @public
2137
- * <p>The token for the next set of results. Use the value returned in the previous
2138
- * response in the next request to retrieve the next set of results.</p>
2271
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
2139
2272
  */
2140
- nextToken?: string;
2273
+ quickResponseArn: string | undefined;
2141
2274
  /**
2142
2275
  * @public
2143
- * <p>The maximum number of results to return per page.</p>
2276
+ * <p>The identifier of the quick response.</p>
2144
2277
  */
2145
- maxResults?: number;
2278
+ quickResponseId: string | undefined;
2279
+ /**
2280
+ * @public
2281
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2282
+ */
2283
+ knowledgeBaseArn: string | undefined;
2146
2284
  /**
2147
2285
  * @public
2148
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2286
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2287
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2149
2288
  */
2150
2289
  knowledgeBaseId: string | undefined;
2151
2290
  /**
2152
2291
  * @public
2153
- * <p>The search expression to filter results.</p>
2292
+ * <p>The name of the quick response.</p>
2154
2293
  */
2155
- searchExpression: SearchExpression | undefined;
2156
- }
2157
- /**
2158
- * @public
2159
- */
2160
- export interface SearchContentResponse {
2294
+ name: string | undefined;
2161
2295
  /**
2162
2296
  * @public
2163
- * <p>Summary information about the content.</p>
2297
+ * <p>The media type of the quick response content.</p>
2298
+ * <ul>
2299
+ * <li>
2300
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
2301
+ * </li>
2302
+ * <li>
2303
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
2304
+ * </li>
2305
+ * </ul>
2164
2306
  */
2165
- contentSummaries: ContentSummary[] | undefined;
2307
+ contentType: string | undefined;
2166
2308
  /**
2167
2309
  * @public
2168
- * <p>If there are additional results, this is the token for the next set of results.</p>
2310
+ * <p>The status of the quick response data.</p>
2169
2311
  */
2170
- nextToken?: string;
2171
- }
2172
- /**
2173
- * @public
2174
- */
2175
- export interface StartContentUploadRequest {
2312
+ status: QuickResponseStatus | undefined;
2176
2313
  /**
2177
2314
  * @public
2178
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2315
+ * <p>The timestamp when the quick response was created.</p>
2179
2316
  */
2180
- knowledgeBaseId: string | undefined;
2317
+ createdTime: Date | undefined;
2181
2318
  /**
2182
2319
  * @public
2183
- * <p>The type of content to upload.</p>
2320
+ * <p>The timestamp when the quick response data was last modified.</p>
2184
2321
  */
2185
- contentType: string | undefined;
2186
- }
2187
- /**
2188
- * @public
2189
- */
2190
- export interface StartContentUploadResponse {
2322
+ lastModifiedTime: Date | undefined;
2191
2323
  /**
2192
2324
  * @public
2193
- * <p>The identifier of the upload.</p>
2325
+ * <p>The contents of the quick response.</p>
2194
2326
  */
2195
- uploadId: string | undefined;
2327
+ contents?: QuickResponseContents;
2196
2328
  /**
2197
2329
  * @public
2198
- * <p>The URL of the upload.</p>
2330
+ * <p>The description of the quick response.</p>
2199
2331
  */
2200
- url: string | undefined;
2332
+ description?: string;
2201
2333
  /**
2202
2334
  * @public
2203
- * <p>The expiration time of the URL as an epoch timestamp.</p>
2335
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
2204
2336
  */
2205
- urlExpiry: Date | undefined;
2337
+ groupingConfiguration?: GroupingConfiguration;
2206
2338
  /**
2207
2339
  * @public
2208
- * <p>The headers to include in the upload.</p>
2340
+ * <p>The shortcut key of the quick response. The value should be unique across the
2341
+ * knowledge base.</p>
2209
2342
  */
2210
- headersToInclude: Record<string, string> | undefined;
2211
- }
2212
- /**
2213
- * @public
2214
- */
2215
- export interface UpdateKnowledgeBaseTemplateUriRequest {
2343
+ shortcutKey?: string;
2216
2344
  /**
2217
2345
  * @public
2218
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2346
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
2219
2347
  */
2220
- knowledgeBaseId: string | undefined;
2348
+ lastModifiedBy?: string;
2221
2349
  /**
2222
2350
  * @public
2223
- * <p>The template URI to update.</p>
2351
+ * <p>Whether the quick response is active.</p>
2224
2352
  */
2225
- templateUri: string | undefined;
2226
- }
2227
- /**
2228
- * @public
2229
- */
2230
- export interface UpdateKnowledgeBaseTemplateUriResponse {
2353
+ isActive?: boolean;
2231
2354
  /**
2232
2355
  * @public
2233
- * <p>The knowledge base to update.</p>
2356
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
2234
2357
  */
2235
- knowledgeBase?: KnowledgeBaseData;
2236
- }
2237
- /**
2238
- * @public
2239
- */
2240
- export interface ListTagsForResourceRequest {
2358
+ channels?: string[];
2241
2359
  /**
2242
2360
  * @public
2243
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
2361
+ * <p>The language code value for the language in which the quick response is written.</p>
2244
2362
  */
2245
- resourceArn: string | undefined;
2363
+ language?: string;
2364
+ /**
2365
+ * @public
2366
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2367
+ */
2368
+ tags?: Record<string, string>;
2246
2369
  }
2247
2370
  /**
2248
2371
  * @public
2249
2372
  */
2250
- export interface ListTagsForResourceResponse {
2373
+ export interface CreateQuickResponseResponse {
2251
2374
  /**
2252
2375
  * @public
2253
- * <p>The tags used to organize, track, or control access for this resource.</p>
2376
+ * <p>The quick response.</p>
2254
2377
  */
2255
- tags?: Record<string, string>;
2378
+ quickResponse?: QuickResponseData;
2256
2379
  }
2257
2380
  /**
2258
2381
  * @public
2259
2382
  */
2260
- export interface TagResourceRequest {
2383
+ export interface DeleteImportJobRequest {
2261
2384
  /**
2262
2385
  * @public
2263
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
2386
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2387
+ * base if you're storing Wisdom Content resource to it.</p>
2264
2388
  */
2265
- resourceArn: string | undefined;
2389
+ knowledgeBaseId: string | undefined;
2266
2390
  /**
2267
2391
  * @public
2268
- * <p>The tags used to organize, track, or control access for this resource.</p>
2392
+ * <p>The identifier of the import job to be deleted.</p>
2269
2393
  */
2270
- tags: Record<string, string> | undefined;
2394
+ importJobId: string | undefined;
2271
2395
  }
2272
2396
  /**
2273
2397
  * @public
2274
2398
  */
2275
- export interface TagResourceResponse {
2399
+ export interface DeleteImportJobResponse {
2276
2400
  }
2277
2401
  /**
2278
2402
  * @public
2279
- * <p>Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.</p>
2280
2403
  */
2281
- export declare class TooManyTagsException extends __BaseException {
2282
- readonly name: "TooManyTagsException";
2283
- readonly $fault: "client";
2404
+ export interface DeleteKnowledgeBaseRequest {
2284
2405
  /**
2285
2406
  * @public
2286
- * <p>The specified resource name.</p>
2287
- */
2288
- resourceName?: string;
2289
- /**
2290
- * @internal
2407
+ * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2408
+ */
2409
+ knowledgeBaseId: string | undefined;
2410
+ }
2411
+ /**
2412
+ * @public
2413
+ */
2414
+ export interface DeleteKnowledgeBaseResponse {
2415
+ }
2416
+ /**
2417
+ * @public
2418
+ */
2419
+ export interface DeleteQuickResponseRequest {
2420
+ /**
2421
+ * @public
2422
+ * <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2423
+ * base if you're storing Wisdom Content resource to it.</p>
2424
+ */
2425
+ knowledgeBaseId: string | undefined;
2426
+ /**
2427
+ * @public
2428
+ * <p>The identifier of the quick response to delete.</p>
2429
+ */
2430
+ quickResponseId: string | undefined;
2431
+ }
2432
+ /**
2433
+ * @public
2434
+ */
2435
+ export interface DeleteQuickResponseResponse {
2436
+ }
2437
+ /**
2438
+ * @public
2439
+ * @enum
2440
+ */
2441
+ export declare const ExternalSource: {
2442
+ readonly AMAZON_CONNECT: "AMAZON_CONNECT";
2443
+ };
2444
+ /**
2445
+ * @public
2446
+ */
2447
+ export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
2448
+ /**
2449
+ * @public
2450
+ * <p>The configuration information of the external data source.</p>
2451
+ */
2452
+ export interface ExternalSourceConfiguration {
2453
+ /**
2454
+ * @public
2455
+ * <p>The type of the external data source.</p>
2456
+ */
2457
+ source: ExternalSource | undefined;
2458
+ /**
2459
+ * @public
2460
+ * <p>The configuration information of the external data source.</p>
2461
+ */
2462
+ configuration: Configuration | undefined;
2463
+ }
2464
+ /**
2465
+ * @public
2466
+ */
2467
+ export interface GetImportJobRequest {
2468
+ /**
2469
+ * @public
2470
+ * <p>The identifier of the import job to retrieve.</p>
2471
+ */
2472
+ importJobId: string | undefined;
2473
+ /**
2474
+ * @public
2475
+ * <p>The identifier of the knowledge base that the import job belongs to.</p>
2476
+ */
2477
+ knowledgeBaseId: string | undefined;
2478
+ }
2479
+ /**
2480
+ * @public
2481
+ * @enum
2482
+ */
2483
+ export declare const ImportJobType: {
2484
+ readonly QUICK_RESPONSES: "QUICK_RESPONSES";
2485
+ };
2486
+ /**
2487
+ * @public
2488
+ */
2489
+ export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
2490
+ /**
2491
+ * @public
2492
+ * @enum
2493
+ */
2494
+ export declare const ImportJobStatus: {
2495
+ readonly COMPLETE: "COMPLETE";
2496
+ readonly DELETED: "DELETED";
2497
+ readonly DELETE_FAILED: "DELETE_FAILED";
2498
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
2499
+ readonly FAILED: "FAILED";
2500
+ readonly START_IN_PROGRESS: "START_IN_PROGRESS";
2501
+ };
2502
+ /**
2503
+ * @public
2504
+ */
2505
+ export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
2506
+ /**
2507
+ * @public
2508
+ * <p>Summary information about the import job.</p>
2509
+ */
2510
+ export interface ImportJobData {
2511
+ /**
2512
+ * @public
2513
+ * <p>The identifier of the import job.</p>
2514
+ */
2515
+ importJobId: string | undefined;
2516
+ /**
2517
+ * @public
2518
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2519
+ * base if you're storing Wisdom Content resource to it.</p>
2520
+ */
2521
+ knowledgeBaseId: string | undefined;
2522
+ /**
2523
+ * @public
2524
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
2525
+ */
2526
+ uploadId: string | undefined;
2527
+ /**
2528
+ * @public
2529
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2530
+ */
2531
+ knowledgeBaseArn: string | undefined;
2532
+ /**
2533
+ * @public
2534
+ * <p>The type of the import job.</p>
2535
+ */
2536
+ importJobType: ImportJobType | undefined;
2537
+ /**
2538
+ * @public
2539
+ * <p>The status of the import job.</p>
2540
+ */
2541
+ status: ImportJobStatus | undefined;
2542
+ /**
2543
+ * @public
2544
+ * <p>The download link to the resource file that is uploaded to the import job.</p>
2545
+ */
2546
+ url: string | undefined;
2547
+ /**
2548
+ * @public
2549
+ * <p>The link to donwload the information of resource data that failed to be imported.</p>
2550
+ */
2551
+ failedRecordReport?: string;
2552
+ /**
2553
+ * @public
2554
+ * <p>The expiration time of the URL as an epoch timestamp.</p>
2555
+ */
2556
+ urlExpiry: Date | undefined;
2557
+ /**
2558
+ * @public
2559
+ * <p>The timestamp when the import job was created.</p>
2560
+ */
2561
+ createdTime: Date | undefined;
2562
+ /**
2563
+ * @public
2564
+ * <p>The timestamp when the import job data was last modified.</p>
2565
+ */
2566
+ lastModifiedTime: Date | undefined;
2567
+ /**
2568
+ * @public
2569
+ * <p>The metadata fields of the imported Wisdom resources.</p>
2570
+ */
2571
+ metadata?: Record<string, string>;
2572
+ /**
2573
+ * @public
2574
+ * <p>The configuration information of the external data source.</p>
2575
+ */
2576
+ externalSourceConfiguration?: ExternalSourceConfiguration;
2577
+ }
2578
+ /**
2579
+ * @public
2580
+ */
2581
+ export interface GetImportJobResponse {
2582
+ /**
2583
+ * @public
2584
+ * <p>The import job.</p>
2585
+ */
2586
+ importJob?: ImportJobData;
2587
+ }
2588
+ /**
2589
+ * @public
2590
+ */
2591
+ export interface GetKnowledgeBaseRequest {
2592
+ /**
2593
+ * @public
2594
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2595
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2596
+ */
2597
+ knowledgeBaseId: string | undefined;
2598
+ }
2599
+ /**
2600
+ * @public
2601
+ */
2602
+ export interface GetKnowledgeBaseResponse {
2603
+ /**
2604
+ * @public
2605
+ * <p>The knowledge base.</p>
2606
+ */
2607
+ knowledgeBase?: KnowledgeBaseData;
2608
+ }
2609
+ /**
2610
+ * @public
2611
+ */
2612
+ export interface GetQuickResponseRequest {
2613
+ /**
2614
+ * @public
2615
+ * <p>The identifier of the quick response.</p>
2616
+ */
2617
+ quickResponseId: string | undefined;
2618
+ /**
2619
+ * @public
2620
+ * <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
2621
+ */
2622
+ knowledgeBaseId: string | undefined;
2623
+ }
2624
+ /**
2625
+ * @public
2626
+ */
2627
+ export interface GetQuickResponseResponse {
2628
+ /**
2629
+ * @public
2630
+ * <p>The quick response.</p>
2631
+ */
2632
+ quickResponse?: QuickResponseData;
2633
+ }
2634
+ /**
2635
+ * @public
2636
+ * <p>Summary information about the import job.</p>
2637
+ */
2638
+ export interface ImportJobSummary {
2639
+ /**
2640
+ * @public
2641
+ * <p>The identifier of the import job.</p>
2642
+ */
2643
+ importJobId: string | undefined;
2644
+ /**
2645
+ * @public
2646
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2647
+ * base if you're storing Wisdom Content resource to it.</p>
2648
+ */
2649
+ knowledgeBaseId: string | undefined;
2650
+ /**
2651
+ * @public
2652
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
2653
+ */
2654
+ uploadId: string | undefined;
2655
+ /**
2656
+ * @public
2657
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2658
+ */
2659
+ knowledgeBaseArn: string | undefined;
2660
+ /**
2661
+ * @public
2662
+ * <p>The type of import job.</p>
2663
+ */
2664
+ importJobType: ImportJobType | undefined;
2665
+ /**
2666
+ * @public
2667
+ * <p>The status of the import job.</p>
2668
+ */
2669
+ status: ImportJobStatus | undefined;
2670
+ /**
2671
+ * @public
2672
+ * <p>The timestamp when the import job was created.</p>
2673
+ */
2674
+ createdTime: Date | undefined;
2675
+ /**
2676
+ * @public
2677
+ * <p>The timestamp when the import job was last modified.</p>
2678
+ */
2679
+ lastModifiedTime: Date | undefined;
2680
+ /**
2681
+ * @public
2682
+ * <p>The metadata fields of the imported Wisdom resources.</p>
2683
+ */
2684
+ metadata?: Record<string, string>;
2685
+ /**
2686
+ * @public
2687
+ * <p>The configuration information of the external source that the resource data are imported from.</p>
2688
+ */
2689
+ externalSourceConfiguration?: ExternalSourceConfiguration;
2690
+ }
2691
+ /**
2692
+ * @public
2693
+ */
2694
+ export interface ListImportJobsRequest {
2695
+ /**
2696
+ * @public
2697
+ * <p>The token for the next set of results. Use the value returned in the previous
2698
+ * response in the next request to retrieve the next set of results.</p>
2699
+ */
2700
+ nextToken?: string;
2701
+ /**
2702
+ * @public
2703
+ * <p>The maximum number of results to return per page.</p>
2704
+ */
2705
+ maxResults?: number;
2706
+ /**
2707
+ * @public
2708
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2709
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2710
+ */
2711
+ knowledgeBaseId: string | undefined;
2712
+ }
2713
+ /**
2714
+ * @public
2715
+ */
2716
+ export interface ListImportJobsResponse {
2717
+ /**
2718
+ * @public
2719
+ * <p>Summary information about the import jobs.</p>
2720
+ */
2721
+ importJobSummaries: ImportJobSummary[] | undefined;
2722
+ /**
2723
+ * @public
2724
+ * <p>The token for the next set of results. Use the value returned in the previous
2725
+ * response in the next request to retrieve the next set of results.</p>
2726
+ */
2727
+ nextToken?: string;
2728
+ }
2729
+ /**
2730
+ * @public
2731
+ */
2732
+ export interface ListKnowledgeBasesRequest {
2733
+ /**
2734
+ * @public
2735
+ * <p>The token for the next set of results. Use the value returned in the previous
2736
+ * response in the next request to retrieve the next set of results.</p>
2737
+ */
2738
+ nextToken?: string;
2739
+ /**
2740
+ * @public
2741
+ * <p>The maximum number of results to return per page.</p>
2742
+ */
2743
+ maxResults?: number;
2744
+ }
2745
+ /**
2746
+ * @public
2747
+ * <p>Summary information about the knowledge base.</p>
2748
+ */
2749
+ export interface KnowledgeBaseSummary {
2750
+ /**
2751
+ * @public
2752
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2753
+ * base if you're storing Wisdom Content resource to it.</p>
2754
+ */
2755
+ knowledgeBaseId: string | undefined;
2756
+ /**
2757
+ * @public
2758
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2759
+ */
2760
+ knowledgeBaseArn: string | undefined;
2761
+ /**
2762
+ * @public
2763
+ * <p>The name of the knowledge base.</p>
2764
+ */
2765
+ name: string | undefined;
2766
+ /**
2767
+ * @public
2768
+ * <p>The type of knowledge base.</p>
2769
+ */
2770
+ knowledgeBaseType: KnowledgeBaseType | undefined;
2771
+ /**
2772
+ * @public
2773
+ * <p>The status of the knowledge base summary.</p>
2774
+ */
2775
+ status: KnowledgeBaseStatus | undefined;
2776
+ /**
2777
+ * @public
2778
+ * <p>Configuration information about the external data source.</p>
2779
+ */
2780
+ sourceConfiguration?: SourceConfiguration;
2781
+ /**
2782
+ * @public
2783
+ * <p>Information about how to render the content.</p>
2784
+ */
2785
+ renderingConfiguration?: RenderingConfiguration;
2786
+ /**
2787
+ * @public
2788
+ * <p>The configuration information for the customer managed key used for encryption. </p>
2789
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
2790
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
2791
+ * to invoke Wisdom. </p>
2792
+ * <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
2793
+ * for your instance</a>.</p>
2794
+ */
2795
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2796
+ /**
2797
+ * @public
2798
+ * <p>The description of the knowledge base.</p>
2799
+ */
2800
+ description?: string;
2801
+ /**
2802
+ * @public
2803
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2804
+ */
2805
+ tags?: Record<string, string>;
2806
+ }
2807
+ /**
2808
+ * @public
2809
+ */
2810
+ export interface ListKnowledgeBasesResponse {
2811
+ /**
2812
+ * @public
2813
+ * <p>Information about the knowledge bases.</p>
2814
+ */
2815
+ knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
2816
+ /**
2817
+ * @public
2818
+ * <p>If there are additional results, this is the token for the next set of results.</p>
2819
+ */
2820
+ nextToken?: string;
2821
+ }
2822
+ /**
2823
+ * @public
2824
+ */
2825
+ export interface ListQuickResponsesRequest {
2826
+ /**
2827
+ * @public
2828
+ * <p>The token for the next set of results. Use the value returned in the previous
2829
+ * response in the next request to retrieve the next set of results.</p>
2830
+ */
2831
+ nextToken?: string;
2832
+ /**
2833
+ * @public
2834
+ * <p>The maximum number of results to return per page.</p>
2835
+ */
2836
+ maxResults?: number;
2837
+ /**
2838
+ * @public
2839
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2840
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2841
+ */
2842
+ knowledgeBaseId: string | undefined;
2843
+ }
2844
+ /**
2845
+ * @public
2846
+ * <p>The summary information about the quick response.</p>
2847
+ */
2848
+ export interface QuickResponseSummary {
2849
+ /**
2850
+ * @public
2851
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
2852
+ */
2853
+ quickResponseArn: string | undefined;
2854
+ /**
2855
+ * @public
2856
+ * <p>The identifier of the quick response.</p>
2857
+ */
2858
+ quickResponseId: string | undefined;
2859
+ /**
2860
+ * @public
2861
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2862
+ */
2863
+ knowledgeBaseArn: string | undefined;
2864
+ /**
2865
+ * @public
2866
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2867
+ * base if you're storing Wisdom Content resource to it.</p>
2868
+ */
2869
+ knowledgeBaseId: string | undefined;
2870
+ /**
2871
+ * @public
2872
+ * <p>The name of the quick response.</p>
2873
+ */
2874
+ name: string | undefined;
2875
+ /**
2876
+ * @public
2877
+ * <p>The media type of the quick response content.</p>
2878
+ * <ul>
2879
+ * <li>
2880
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
2881
+ * </li>
2882
+ * <li>
2883
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
2884
+ * </li>
2885
+ * </ul>
2886
+ */
2887
+ contentType: string | undefined;
2888
+ /**
2889
+ * @public
2890
+ * <p>The resource status of the quick response.</p>
2891
+ */
2892
+ status: QuickResponseStatus | undefined;
2893
+ /**
2894
+ * @public
2895
+ * <p>The timestamp when the quick response was created.</p>
2896
+ */
2897
+ createdTime: Date | undefined;
2898
+ /**
2899
+ * @public
2900
+ * <p>The timestamp when the quick response summary was last modified.</p>
2901
+ */
2902
+ lastModifiedTime: Date | undefined;
2903
+ /**
2904
+ * @public
2905
+ * <p>The description of the quick response.</p>
2906
+ */
2907
+ description?: string;
2908
+ /**
2909
+ * @public
2910
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
2911
+ */
2912
+ lastModifiedBy?: string;
2913
+ /**
2914
+ * @public
2915
+ * <p>Whether the quick response is active.</p>
2916
+ */
2917
+ isActive?: boolean;
2918
+ /**
2919
+ * @public
2920
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
2921
+ */
2922
+ channels?: string[];
2923
+ /**
2924
+ * @public
2925
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2926
+ */
2927
+ tags?: Record<string, string>;
2928
+ }
2929
+ /**
2930
+ * @public
2931
+ */
2932
+ export interface ListQuickResponsesResponse {
2933
+ /**
2934
+ * @public
2935
+ * <p>Summary information about the quick responses.</p>
2936
+ */
2937
+ quickResponseSummaries: QuickResponseSummary[] | undefined;
2938
+ /**
2939
+ * @public
2940
+ * <p>The token for the next set of results. Use the value returned in the previous
2941
+ * response in the next request to retrieve the next set of results.</p>
2942
+ */
2943
+ nextToken?: string;
2944
+ }
2945
+ /**
2946
+ * @public
2947
+ */
2948
+ export interface UpdateQuickResponseRequest {
2949
+ /**
2950
+ * @public
2951
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2952
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2953
+ */
2954
+ knowledgeBaseId: string | undefined;
2955
+ /**
2956
+ * @public
2957
+ * <p>The identifier of the quick response.</p>
2958
+ */
2959
+ quickResponseId: string | undefined;
2960
+ /**
2961
+ * @public
2962
+ * <p>The name of the quick response.</p>
2963
+ */
2964
+ name?: string;
2965
+ /**
2966
+ * @public
2967
+ * <p>The updated content of the quick response.</p>
2968
+ */
2969
+ content?: QuickResponseDataProvider;
2970
+ /**
2971
+ * @public
2972
+ * <p>The media type of the quick response content.</p>
2973
+ * <ul>
2974
+ * <li>
2975
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
2976
+ * </li>
2977
+ * <li>
2978
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
2979
+ * </li>
2980
+ * </ul>
2981
+ */
2982
+ contentType?: string;
2983
+ /**
2984
+ * @public
2985
+ * <p>The updated grouping configuration of the quick response.</p>
2986
+ */
2987
+ groupingConfiguration?: GroupingConfiguration;
2988
+ /**
2989
+ * @public
2990
+ * <p>Whether to remove the grouping configuration of the quick response.</p>
2991
+ */
2992
+ removeGroupingConfiguration?: boolean;
2993
+ /**
2994
+ * @public
2995
+ * <p>The updated description of the quick response.</p>
2996
+ */
2997
+ description?: string;
2998
+ /**
2999
+ * @public
3000
+ * <p>Whether to remove the description from the quick response.</p>
3001
+ */
3002
+ removeDescription?: boolean;
3003
+ /**
3004
+ * @public
3005
+ * <p>The shortcut key of the quick response. The value should be unique across the
3006
+ * knowledge base.</p>
3007
+ */
3008
+ shortcutKey?: string;
3009
+ /**
3010
+ * @public
3011
+ * <p>Whether to remove the shortcut key of the quick response.</p>
3012
+ */
3013
+ removeShortcutKey?: boolean;
3014
+ /**
3015
+ * @public
3016
+ * <p>Whether the quick response is active. </p>
3017
+ */
3018
+ isActive?: boolean;
3019
+ /**
3020
+ * @public
3021
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
3022
+ */
3023
+ channels?: string[];
3024
+ /**
3025
+ * @public
3026
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
3027
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
3028
+ * <code>zh_CN</code>, <code>zh_TW</code>
3029
+ * </p>
3030
+ */
3031
+ language?: string;
3032
+ }
3033
+ /**
3034
+ * @public
3035
+ */
3036
+ export interface UpdateQuickResponseResponse {
3037
+ /**
3038
+ * @public
3039
+ * <p>The quick response.</p>
3040
+ */
3041
+ quickResponse?: QuickResponseData;
3042
+ }
3043
+ /**
3044
+ * @public
3045
+ */
3046
+ export interface RemoveKnowledgeBaseTemplateUriRequest {
3047
+ /**
3048
+ * @public
3049
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3050
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3051
+ */
3052
+ knowledgeBaseId: string | undefined;
3053
+ }
3054
+ /**
3055
+ * @public
3056
+ */
3057
+ export interface RemoveKnowledgeBaseTemplateUriResponse {
3058
+ }
3059
+ /**
3060
+ * @public
3061
+ */
3062
+ export interface SearchContentRequest {
3063
+ /**
3064
+ * @public
3065
+ * <p>The token for the next set of results. Use the value returned in the previous
3066
+ * response in the next request to retrieve the next set of results.</p>
3067
+ */
3068
+ nextToken?: string;
3069
+ /**
3070
+ * @public
3071
+ * <p>The maximum number of results to return per page.</p>
3072
+ */
3073
+ maxResults?: number;
3074
+ /**
3075
+ * @public
3076
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3077
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3078
+ */
3079
+ knowledgeBaseId: string | undefined;
3080
+ /**
3081
+ * @public
3082
+ * <p>The search expression to filter results.</p>
3083
+ */
3084
+ searchExpression: SearchExpression | undefined;
3085
+ }
3086
+ /**
3087
+ * @public
3088
+ */
3089
+ export interface SearchContentResponse {
3090
+ /**
3091
+ * @public
3092
+ * <p>Summary information about the content.</p>
3093
+ */
3094
+ contentSummaries: ContentSummary[] | undefined;
3095
+ /**
3096
+ * @public
3097
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3098
+ */
3099
+ nextToken?: string;
3100
+ }
3101
+ /**
3102
+ * @public
3103
+ * @enum
3104
+ */
3105
+ export declare const QuickResponseFilterOperator: {
3106
+ readonly EQUALS: "EQUALS";
3107
+ readonly PREFIX: "PREFIX";
3108
+ };
3109
+ /**
3110
+ * @public
3111
+ */
3112
+ export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
3113
+ /**
3114
+ * @public
3115
+ * <p>The quick response fields to filter the quick response query results by.</p>
3116
+ * <p>The following is the list of supported field names.</p>
3117
+ * <ul>
3118
+ * <li>
3119
+ * <p>name</p>
3120
+ * </li>
3121
+ * <li>
3122
+ * <p>description</p>
3123
+ * </li>
3124
+ * <li>
3125
+ * <p>shortcutKey</p>
3126
+ * </li>
3127
+ * <li>
3128
+ * <p>isActive</p>
3129
+ * </li>
3130
+ * <li>
3131
+ * <p>channels</p>
3132
+ * </li>
3133
+ * <li>
3134
+ * <p>language</p>
3135
+ * </li>
3136
+ * <li>
3137
+ * <p>contentType</p>
3138
+ * </li>
3139
+ * <li>
3140
+ * <p>createdTime</p>
3141
+ * </li>
3142
+ * <li>
3143
+ * <p>lastModifiedTime</p>
3144
+ * </li>
3145
+ * <li>
3146
+ * <p>lastModifiedBy</p>
3147
+ * </li>
3148
+ * <li>
3149
+ * <p>groupingConfiguration.criteria</p>
3150
+ * </li>
3151
+ * <li>
3152
+ * <p>groupingConfiguration.values</p>
3153
+ * </li>
3154
+ * </ul>
3155
+ */
3156
+ export interface QuickResponseFilterField {
3157
+ /**
3158
+ * @public
3159
+ * <p>The name of the attribute field to filter the quick responses by.</p>
3160
+ */
3161
+ name: string | undefined;
3162
+ /**
3163
+ * @public
3164
+ * <p>The values of attribute field to filter the quick response by.</p>
3165
+ */
3166
+ values?: string[];
3167
+ /**
3168
+ * @public
3169
+ * <p>The operator to use for filtering.</p>
3170
+ */
3171
+ operator: QuickResponseFilterOperator | undefined;
3172
+ /**
3173
+ * @public
3174
+ * <p>Whether to treat null value as a match for the attribute field.</p>
3175
+ */
3176
+ includeNoExistence?: boolean;
3177
+ }
3178
+ /**
3179
+ * @public
3180
+ * @enum
3181
+ */
3182
+ export declare const Order: {
3183
+ readonly ASC: "ASC";
3184
+ readonly DESC: "DESC";
3185
+ };
3186
+ /**
3187
+ * @public
3188
+ */
3189
+ export type Order = (typeof Order)[keyof typeof Order];
3190
+ /**
3191
+ * @public
3192
+ * <p>The quick response fields to order the quick response query results by.</p>
3193
+ * <p>The following is the list of supported field names.</p>
3194
+ * <ul>
3195
+ * <li>
3196
+ * <p>name</p>
3197
+ * </li>
3198
+ * <li>
3199
+ * <p>description</p>
3200
+ * </li>
3201
+ * <li>
3202
+ * <p>shortcutKey</p>
3203
+ * </li>
3204
+ * <li>
3205
+ * <p>isActive</p>
3206
+ * </li>
3207
+ * <li>
3208
+ * <p>channels</p>
3209
+ * </li>
3210
+ * <li>
3211
+ * <p>language</p>
3212
+ * </li>
3213
+ * <li>
3214
+ * <p>contentType</p>
3215
+ * </li>
3216
+ * <li>
3217
+ * <p>createdTime</p>
3218
+ * </li>
3219
+ * <li>
3220
+ * <p>lastModifiedTime</p>
3221
+ * </li>
3222
+ * <li>
3223
+ * <p>lastModifiedBy</p>
3224
+ * </li>
3225
+ * <li>
3226
+ * <p>groupingConfiguration.criteria</p>
3227
+ * </li>
3228
+ * <li>
3229
+ * <p>groupingConfiguration.values</p>
3230
+ * </li>
3231
+ * </ul>
3232
+ */
3233
+ export interface QuickResponseOrderField {
3234
+ /**
3235
+ * @public
3236
+ * <p>The name of the attribute to order the quick response query results by.</p>
3237
+ */
3238
+ name: string | undefined;
3239
+ /**
3240
+ * @public
3241
+ * <p>The order at which the quick responses are sorted by.</p>
3242
+ */
3243
+ order?: Order;
3244
+ }
3245
+ /**
3246
+ * @public
3247
+ * @enum
3248
+ */
3249
+ export declare const QuickResponseQueryOperator: {
3250
+ readonly CONTAINS: "CONTAINS";
3251
+ readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
3252
+ };
3253
+ /**
3254
+ * @public
3255
+ */
3256
+ export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
3257
+ /**
3258
+ * @public
3259
+ * @enum
3260
+ */
3261
+ export declare const Priority: {
3262
+ readonly HIGH: "HIGH";
3263
+ readonly LOW: "LOW";
3264
+ readonly MEDIUM: "MEDIUM";
3265
+ };
3266
+ /**
3267
+ * @public
3268
+ */
3269
+ export type Priority = (typeof Priority)[keyof typeof Priority];
3270
+ /**
3271
+ * @public
3272
+ * <p>The quick response fields to query quick responses by.</p>
3273
+ * <p>The following is the list of supported field names.</p>
3274
+ * <ul>
3275
+ * <li>
3276
+ * <p>content</p>
3277
+ * </li>
3278
+ * <li>
3279
+ * <p>name</p>
3280
+ * </li>
3281
+ * <li>
3282
+ * <p>description</p>
3283
+ * </li>
3284
+ * <li>
3285
+ * <p>shortcutKey</p>
3286
+ * </li>
3287
+ * </ul>
3288
+ */
3289
+ export interface QuickResponseQueryField {
3290
+ /**
3291
+ * @public
3292
+ * <p>The name of the attribute to query the quick responses by.</p>
3293
+ */
3294
+ name: string | undefined;
3295
+ /**
3296
+ * @public
3297
+ * <p>The values of the attribute to query the quick responses by.</p>
3298
+ */
3299
+ values: string[] | undefined;
3300
+ /**
3301
+ * @public
3302
+ * <p>The operator to use for matching attribute field values in the query.</p>
3303
+ */
3304
+ operator: QuickResponseQueryOperator | undefined;
3305
+ /**
3306
+ * @public
3307
+ * <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
3308
+ */
3309
+ allowFuzziness?: boolean;
3310
+ /**
3311
+ * @public
3312
+ * <p>The importance of the attribute field when calculating query result relevancy scores.
3313
+ * The value set for this parameter affects the ordering of search results.</p>
3314
+ */
3315
+ priority?: Priority;
3316
+ }
3317
+ /**
3318
+ * @public
3319
+ * <p>Information about the import job.</p>
3320
+ */
3321
+ export interface QuickResponseSearchExpression {
3322
+ /**
3323
+ * @public
3324
+ * <p>The quick response query expressions.</p>
3325
+ */
3326
+ queries?: QuickResponseQueryField[];
3327
+ /**
3328
+ * @public
3329
+ * <p>The configuration of filtering rules applied to quick response query results.</p>
3330
+ */
3331
+ filters?: QuickResponseFilterField[];
3332
+ /**
3333
+ * @public
3334
+ * <p>The quick response attribute fields on which the query results are ordered.</p>
3335
+ */
3336
+ orderOnField?: QuickResponseOrderField;
3337
+ }
3338
+ /**
3339
+ * @public
3340
+ */
3341
+ export interface SearchQuickResponsesRequest {
3342
+ /**
3343
+ * @public
3344
+ * <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3345
+ */
3346
+ knowledgeBaseId: string | undefined;
3347
+ /**
3348
+ * @public
3349
+ * <p>The search expression for querying the quick response.</p>
3350
+ */
3351
+ searchExpression: QuickResponseSearchExpression | undefined;
3352
+ /**
3353
+ * @public
3354
+ * <p>The token for the next set of results. Use the value returned in the previous
3355
+ * response in the next request to retrieve the next set of results.</p>
3356
+ */
3357
+ nextToken?: string;
3358
+ /**
3359
+ * @public
3360
+ * <p>The maximum number of results to return per page.</p>
3361
+ */
3362
+ maxResults?: number;
3363
+ /**
3364
+ * @public
3365
+ * <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>
3366
+ */
3367
+ attributes?: Record<string, string>;
3368
+ }
3369
+ /**
3370
+ * @public
3371
+ * <p>The result of quick response search.</p>
3372
+ */
3373
+ export interface QuickResponseSearchResultData {
3374
+ /**
3375
+ * @public
3376
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
3377
+ */
3378
+ quickResponseArn: string | undefined;
3379
+ /**
3380
+ * @public
3381
+ * <p>The identifier of the quick response.</p>
3382
+ */
3383
+ quickResponseId: string | undefined;
3384
+ /**
3385
+ * @public
3386
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
3387
+ */
3388
+ knowledgeBaseArn: string | undefined;
3389
+ /**
3390
+ * @public
3391
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3392
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3393
+ */
3394
+ knowledgeBaseId: string | undefined;
3395
+ /**
3396
+ * @public
3397
+ * <p>The name of the quick response.</p>
3398
+ */
3399
+ name: string | undefined;
3400
+ /**
3401
+ * @public
3402
+ * <p>The media type of the quick response content.</p>
3403
+ * <ul>
3404
+ * <li>
3405
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
3406
+ * </li>
3407
+ * <li>
3408
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
3409
+ * </li>
3410
+ * </ul>
3411
+ */
3412
+ contentType: string | undefined;
3413
+ /**
3414
+ * @public
3415
+ * <p>The resource status of the quick response.</p>
3416
+ */
3417
+ status: QuickResponseStatus | undefined;
3418
+ /**
3419
+ * @public
3420
+ * <p>The contents of the quick response.</p>
3421
+ */
3422
+ contents: QuickResponseContents | undefined;
3423
+ /**
3424
+ * @public
3425
+ * <p>The timestamp when the quick response was created.</p>
3426
+ */
3427
+ createdTime: Date | undefined;
3428
+ /**
3429
+ * @public
3430
+ * <p>The timestamp when the quick response search result data was last modified.</p>
3431
+ */
3432
+ lastModifiedTime: Date | undefined;
3433
+ /**
3434
+ * @public
3435
+ * <p>Whether the quick response is active.</p>
3436
+ */
3437
+ isActive: boolean | undefined;
3438
+ /**
3439
+ * @public
3440
+ * <p>The description of the quick response.</p>
3441
+ */
3442
+ description?: string;
3443
+ /**
3444
+ * @public
3445
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
3446
+ */
3447
+ groupingConfiguration?: GroupingConfiguration;
3448
+ /**
3449
+ * @public
3450
+ * <p>The shortcut key of the quick response. The value should be unique across the
3451
+ * knowledge base.</p>
3452
+ */
3453
+ shortcutKey?: string;
3454
+ /**
3455
+ * @public
3456
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>
3457
+ */
3458
+ lastModifiedBy?: string;
3459
+ /**
3460
+ * @public
3461
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
3462
+ */
3463
+ channels?: string[];
3464
+ /**
3465
+ * @public
3466
+ * <p>The language code value for the language in which the quick response is written.</p>
3467
+ */
3468
+ language?: string;
3469
+ /**
3470
+ * @public
3471
+ * <p>The user defined contact attributes that are not resolved when the search result is returned.</p>
3472
+ */
3473
+ attributesNotInterpolated?: string[];
3474
+ /**
3475
+ * @public
3476
+ * <p>The user defined contact attributes that are resolved when the search result is returned.</p>
3477
+ */
3478
+ attributesInterpolated?: string[];
3479
+ /**
3480
+ * @public
3481
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3482
+ */
3483
+ tags?: Record<string, string>;
3484
+ }
3485
+ /**
3486
+ * @public
3487
+ */
3488
+ export interface SearchQuickResponsesResponse {
3489
+ /**
3490
+ * @public
3491
+ * <p>The results of the quick response search.</p>
3492
+ */
3493
+ results: QuickResponseSearchResultData[] | undefined;
3494
+ /**
3495
+ * @public
3496
+ * <p>The token for the next set of results. Use the value returned in the previous
3497
+ * response in the next request to retrieve the next set of results.</p>
3498
+ */
3499
+ nextToken?: string;
3500
+ }
3501
+ /**
3502
+ * @public
3503
+ */
3504
+ export interface StartContentUploadRequest {
3505
+ /**
3506
+ * @public
3507
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3508
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3509
+ */
3510
+ knowledgeBaseId: string | undefined;
3511
+ /**
3512
+ * @public
3513
+ * <p>The type of content to upload.</p>
3514
+ */
3515
+ contentType: string | undefined;
3516
+ /**
3517
+ * @public
3518
+ * <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
3519
+ */
3520
+ presignedUrlTimeToLive?: number;
3521
+ }
3522
+ /**
3523
+ * @public
3524
+ */
3525
+ export interface StartContentUploadResponse {
3526
+ /**
3527
+ * @public
3528
+ * <p>The identifier of the upload.</p>
3529
+ */
3530
+ uploadId: string | undefined;
3531
+ /**
3532
+ * @public
3533
+ * <p>The URL of the upload.</p>
3534
+ */
3535
+ url: string | undefined;
3536
+ /**
3537
+ * @public
3538
+ * <p>The expiration time of the URL as an epoch timestamp.</p>
3539
+ */
3540
+ urlExpiry: Date | undefined;
3541
+ /**
3542
+ * @public
3543
+ * <p>The headers to include in the upload.</p>
3544
+ */
3545
+ headersToInclude: Record<string, string> | undefined;
3546
+ }
3547
+ /**
3548
+ * @public
3549
+ */
3550
+ export interface StartImportJobRequest {
3551
+ /**
3552
+ * @public
3553
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3554
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3555
+ * <ul>
3556
+ * <li>
3557
+ * <p>For importing Wisdom quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p>
3558
+ * </li>
3559
+ * </ul>
3560
+ */
3561
+ knowledgeBaseId: string | undefined;
3562
+ /**
3563
+ * @public
3564
+ * <p>The type of the import job.</p>
3565
+ * <ul>
3566
+ * <li>
3567
+ * <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p>
3568
+ * </li>
3569
+ * </ul>
3570
+ */
3571
+ importJobType: ImportJobType | undefined;
3572
+ /**
3573
+ * @public
3574
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
3575
+ */
3576
+ uploadId: string | undefined;
3577
+ /**
3578
+ * @public
3579
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3580
+ */
3581
+ clientToken?: string;
3582
+ /**
3583
+ * @public
3584
+ * <p>The metadata fields of the imported Wisdom resources.</p>
3585
+ */
3586
+ metadata?: Record<string, string>;
3587
+ /**
3588
+ * @public
3589
+ * <p>The configuration information of the external source that the resource data are imported from.</p>
3590
+ */
3591
+ externalSourceConfiguration?: ExternalSourceConfiguration;
3592
+ }
3593
+ /**
3594
+ * @public
3595
+ */
3596
+ export interface StartImportJobResponse {
3597
+ /**
3598
+ * @public
3599
+ * <p>The import job.</p>
3600
+ */
3601
+ importJob?: ImportJobData;
3602
+ }
3603
+ /**
3604
+ * @public
3605
+ */
3606
+ export interface UpdateKnowledgeBaseTemplateUriRequest {
3607
+ /**
3608
+ * @public
3609
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3610
+ * base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3611
+ */
3612
+ knowledgeBaseId: string | undefined;
3613
+ /**
3614
+ * @public
3615
+ * <p>The template URI to update.</p>
3616
+ */
3617
+ templateUri: string | undefined;
3618
+ }
3619
+ /**
3620
+ * @public
3621
+ */
3622
+ export interface UpdateKnowledgeBaseTemplateUriResponse {
3623
+ /**
3624
+ * @public
3625
+ * <p>The knowledge base to update.</p>
3626
+ */
3627
+ knowledgeBase?: KnowledgeBaseData;
3628
+ }
3629
+ /**
3630
+ * @public
3631
+ */
3632
+ export interface ListTagsForResourceRequest {
3633
+ /**
3634
+ * @public
3635
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3636
+ */
3637
+ resourceArn: string | undefined;
3638
+ }
3639
+ /**
3640
+ * @public
3641
+ */
3642
+ export interface ListTagsForResourceResponse {
3643
+ /**
3644
+ * @public
3645
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3646
+ */
3647
+ tags?: Record<string, string>;
3648
+ }
3649
+ /**
3650
+ * @public
3651
+ */
3652
+ export interface TagResourceRequest {
3653
+ /**
3654
+ * @public
3655
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3656
+ */
3657
+ resourceArn: string | undefined;
3658
+ /**
3659
+ * @public
3660
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3661
+ */
3662
+ tags: Record<string, string> | undefined;
3663
+ }
3664
+ /**
3665
+ * @public
3666
+ */
3667
+ export interface TagResourceResponse {
3668
+ }
3669
+ /**
3670
+ * @public
3671
+ * <p>Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.</p>
3672
+ */
3673
+ export declare class TooManyTagsException extends __BaseException {
3674
+ readonly name: "TooManyTagsException";
3675
+ readonly $fault: "client";
3676
+ /**
3677
+ * @public
3678
+ * <p>The specified resource name.</p>
3679
+ */
3680
+ resourceName?: string;
3681
+ /**
3682
+ * @internal
2291
3683
  */
2292
3684
  constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
2293
3685
  }
@@ -2367,7 +3759,79 @@ export declare const GetContentResponseFilterSensitiveLog: (obj: GetContentRespo
2367
3759
  * @internal
2368
3760
  */
2369
3761
  export declare const UpdateContentResponseFilterSensitiveLog: (obj: UpdateContentResponse) => any;
3762
+ /**
3763
+ * @internal
3764
+ */
3765
+ export declare const QuickResponseDataProviderFilterSensitiveLog: (obj: QuickResponseDataProvider) => any;
3766
+ /**
3767
+ * @internal
3768
+ */
3769
+ export declare const GroupingConfigurationFilterSensitiveLog: (obj: GroupingConfiguration) => any;
3770
+ /**
3771
+ * @internal
3772
+ */
3773
+ export declare const CreateQuickResponseRequestFilterSensitiveLog: (obj: CreateQuickResponseRequest) => any;
3774
+ /**
3775
+ * @internal
3776
+ */
3777
+ export declare const QuickResponseContentProviderFilterSensitiveLog: (obj: QuickResponseContentProvider) => any;
3778
+ /**
3779
+ * @internal
3780
+ */
3781
+ export declare const QuickResponseContentsFilterSensitiveLog: (obj: QuickResponseContents) => any;
3782
+ /**
3783
+ * @internal
3784
+ */
3785
+ export declare const QuickResponseDataFilterSensitiveLog: (obj: QuickResponseData) => any;
3786
+ /**
3787
+ * @internal
3788
+ */
3789
+ export declare const CreateQuickResponseResponseFilterSensitiveLog: (obj: CreateQuickResponseResponse) => any;
3790
+ /**
3791
+ * @internal
3792
+ */
3793
+ export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => any;
3794
+ /**
3795
+ * @internal
3796
+ */
3797
+ export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
3798
+ /**
3799
+ * @internal
3800
+ */
3801
+ export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
3802
+ /**
3803
+ * @internal
3804
+ */
3805
+ export declare const QuickResponseSummaryFilterSensitiveLog: (obj: QuickResponseSummary) => any;
3806
+ /**
3807
+ * @internal
3808
+ */
3809
+ export declare const ListQuickResponsesResponseFilterSensitiveLog: (obj: ListQuickResponsesResponse) => any;
3810
+ /**
3811
+ * @internal
3812
+ */
3813
+ export declare const UpdateQuickResponseRequestFilterSensitiveLog: (obj: UpdateQuickResponseRequest) => any;
3814
+ /**
3815
+ * @internal
3816
+ */
3817
+ export declare const UpdateQuickResponseResponseFilterSensitiveLog: (obj: UpdateQuickResponseResponse) => any;
3818
+ /**
3819
+ * @internal
3820
+ */
3821
+ export declare const SearchQuickResponsesRequestFilterSensitiveLog: (obj: SearchQuickResponsesRequest) => any;
3822
+ /**
3823
+ * @internal
3824
+ */
3825
+ export declare const QuickResponseSearchResultDataFilterSensitiveLog: (obj: QuickResponseSearchResultData) => any;
3826
+ /**
3827
+ * @internal
3828
+ */
3829
+ export declare const SearchQuickResponsesResponseFilterSensitiveLog: (obj: SearchQuickResponsesResponse) => any;
2370
3830
  /**
2371
3831
  * @internal
2372
3832
  */
2373
3833
  export declare const StartContentUploadResponseFilterSensitiveLog: (obj: StartContentUploadResponse) => any;
3834
+ /**
3835
+ * @internal
3836
+ */
3837
+ export declare const StartImportJobResponseFilterSensitiveLog: (obj: StartImportJobResponse) => any;