@aws-sdk/client-kendra 3.145.0 → 3.154.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.
- package/CHANGELOG.md +30 -0
- package/dist-cjs/models/models_0.js +18 -16
- package/dist-cjs/models/models_1.js +9 -1
- package/dist-cjs/protocols/Aws_json1_1.js +45 -0
- package/dist-es/models/models_0.js +8 -3
- package/dist-es/models/models_1.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +45 -8
- package/dist-types/Kendra.d.ts +8 -8
- package/dist-types/commands/CreateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +184 -188
- package/dist-types/models/models_1.d.ts +117 -1
- package/dist-types/ts3.4/models/models_0.d.ts +35 -43
- package/dist-types/ts3.4/models/models_1.d.ts +37 -1
- package/package.json +4 -4
|
@@ -1,4 +1,112 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocumentAttribute, DocumentAttributeValueCountPair, DocumentAttributeValueType, DocumentRelevanceConfiguration, Facet, QueryResultItem, QueryResultType, SortingConfiguration, SpellCorrectedQuery, SpellCorrectionConfiguration, UserContext, Warning } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>The facet values for the documents in the response.</p>
|
|
4
|
+
*/
|
|
5
|
+
export interface FacetResult {
|
|
6
|
+
/**
|
|
7
|
+
* <p>The key for the facet values. This is the same as the
|
|
8
|
+
* <code>DocumentAttributeKey</code> provided in the query.</p>
|
|
9
|
+
*/
|
|
10
|
+
DocumentAttributeKey?: string;
|
|
11
|
+
/**
|
|
12
|
+
* <p>The data type of the facet value. This is the same as the type
|
|
13
|
+
* defined for the index field when it was created.</p>
|
|
14
|
+
*/
|
|
15
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
16
|
+
/**
|
|
17
|
+
* <p>An array of key/value pairs, where the key is the value of the
|
|
18
|
+
* attribute and the count is the number of documents that share the key
|
|
19
|
+
* value.</p>
|
|
20
|
+
*/
|
|
21
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* <p>Provides filtering the query results based on document
|
|
25
|
+
* attributes.</p>
|
|
26
|
+
* <p>When you use the <code>AndAllFilters</code> or
|
|
27
|
+
* <code>OrAllFilters</code>, filters you can use 2 layers under the
|
|
28
|
+
* first attribute filter. For example, you can use:</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <code><AndAllFilters></code>
|
|
31
|
+
* </p>
|
|
32
|
+
* <ol>
|
|
33
|
+
* <li>
|
|
34
|
+
* <p>
|
|
35
|
+
* <code> <OrAllFilters></code>
|
|
36
|
+
* </p>
|
|
37
|
+
* </li>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>
|
|
40
|
+
* <code> <EqualsTo></code>
|
|
41
|
+
* </p>
|
|
42
|
+
* </li>
|
|
43
|
+
* </ol>
|
|
44
|
+
* <p>If you use more than 2 layers, you receive a
|
|
45
|
+
* <code>ValidationException</code> exception with the message
|
|
46
|
+
* "<code>AttributeFilter</code> cannot have a depth of more
|
|
47
|
+
* than 2."</p>
|
|
48
|
+
* <p>If you use more than 10 attribute filters in a given list for
|
|
49
|
+
* <code>AndAllFilters</code> or <code>OrAllFilters</code>, you receive
|
|
50
|
+
* a <code>ValidationException</code> with the message
|
|
51
|
+
* "<code>AttributeFilter</code> cannot have a length of more than 10".</p>
|
|
52
|
+
*/
|
|
53
|
+
export interface AttributeFilter {
|
|
54
|
+
/**
|
|
55
|
+
* <p>Performs a logical <code>AND</code> operation on all supplied
|
|
56
|
+
* filters.</p>
|
|
57
|
+
*/
|
|
58
|
+
AndAllFilters?: AttributeFilter[];
|
|
59
|
+
/**
|
|
60
|
+
* <p>Performs a logical <code>OR</code> operation on all supplied
|
|
61
|
+
* filters.</p>
|
|
62
|
+
*/
|
|
63
|
+
OrAllFilters?: AttributeFilter[];
|
|
64
|
+
/**
|
|
65
|
+
* <p>Performs a logical <code>NOT</code> operation on all supplied
|
|
66
|
+
* filters.</p>
|
|
67
|
+
*/
|
|
68
|
+
NotFilter?: AttributeFilter;
|
|
69
|
+
/**
|
|
70
|
+
* <p>Performs an equals operation on two document attributes.</p>
|
|
71
|
+
*/
|
|
72
|
+
EqualsTo?: DocumentAttribute;
|
|
73
|
+
/**
|
|
74
|
+
* <p>Returns true when a document contains all of the specified document
|
|
75
|
+
* attributes. This filter is only applicable to
|
|
76
|
+
* <code>StringListValue</code> metadata.</p>
|
|
77
|
+
*/
|
|
78
|
+
ContainsAll?: DocumentAttribute;
|
|
79
|
+
/**
|
|
80
|
+
* <p>Returns true when a document contains any of the specified document
|
|
81
|
+
* attributes. This filter is only applicable to
|
|
82
|
+
* <code>StringListValue</code> metadata.</p>
|
|
83
|
+
*/
|
|
84
|
+
ContainsAny?: DocumentAttribute;
|
|
85
|
+
/**
|
|
86
|
+
* <p>Performs a greater than operation on two document attributes. Use
|
|
87
|
+
* with a document attribute of type <code>Date</code> or
|
|
88
|
+
* <code>Long</code>.</p>
|
|
89
|
+
*/
|
|
90
|
+
GreaterThan?: DocumentAttribute;
|
|
91
|
+
/**
|
|
92
|
+
* <p>Performs a greater or equals than operation on two document
|
|
93
|
+
* attributes. Use with a document attribute of type <code>Date</code>
|
|
94
|
+
* or <code>Long</code>.</p>
|
|
95
|
+
*/
|
|
96
|
+
GreaterThanOrEquals?: DocumentAttribute;
|
|
97
|
+
/**
|
|
98
|
+
* <p>Performs a less than operation on two document attributes. Use with
|
|
99
|
+
* a document attribute of type <code>Date</code> or
|
|
100
|
+
* <code>Long</code>.</p>
|
|
101
|
+
*/
|
|
102
|
+
LessThan?: DocumentAttribute;
|
|
103
|
+
/**
|
|
104
|
+
* <p>Performs a less than or equals operation on two document attributes.
|
|
105
|
+
* Use with a document attribute of type <code>Date</code> or
|
|
106
|
+
* <code>Long</code>.</p>
|
|
107
|
+
*/
|
|
108
|
+
LessThanOrEquals?: DocumentAttribute;
|
|
109
|
+
}
|
|
2
110
|
export interface QueryResult {
|
|
3
111
|
/**
|
|
4
112
|
* <p>The unique identifier for the search. You use <code>QueryId</code>
|
|
@@ -122,6 +230,14 @@ export interface QueryRequest {
|
|
|
122
230
|
*/
|
|
123
231
|
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
124
232
|
}
|
|
233
|
+
/**
|
|
234
|
+
* @internal
|
|
235
|
+
*/
|
|
236
|
+
export declare const FacetResultFilterSensitiveLog: (obj: FacetResult) => any;
|
|
237
|
+
/**
|
|
238
|
+
* @internal
|
|
239
|
+
*/
|
|
240
|
+
export declare const AttributeFilterFilterSensitiveLog: (obj: AttributeFilter) => any;
|
|
125
241
|
/**
|
|
126
242
|
* @internal
|
|
127
243
|
*/
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { DocumentType as __DocumentType } from "@aws-sdk/types";
|
|
2
3
|
import { KendraServiceException as __BaseException } from "./KendraServiceException";
|
|
4
|
+
import { FacetResult } from "./models_1";
|
|
3
5
|
|
|
4
6
|
export interface AccessControlConfigurationSummary {
|
|
5
7
|
|
|
@@ -554,6 +556,10 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
554
556
|
|
|
555
557
|
AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[];
|
|
556
558
|
}
|
|
559
|
+
export declare enum ConfluenceAuthenticationType {
|
|
560
|
+
HTTP_BASIC = "HTTP_BASIC",
|
|
561
|
+
PAT = "PAT"
|
|
562
|
+
}
|
|
557
563
|
export declare enum ConfluenceBlogFieldName {
|
|
558
564
|
AUTHOR = "AUTHOR",
|
|
559
565
|
DISPLAY_URL = "DISPLAY_URL",
|
|
@@ -607,6 +613,15 @@ export interface ConfluencePageConfiguration {
|
|
|
607
613
|
|
|
608
614
|
PageFieldMappings?: ConfluencePageToIndexFieldMapping[];
|
|
609
615
|
}
|
|
616
|
+
|
|
617
|
+
export interface ProxyConfiguration {
|
|
618
|
+
|
|
619
|
+
Host: string | undefined;
|
|
620
|
+
|
|
621
|
+
Port: number | undefined;
|
|
622
|
+
|
|
623
|
+
Credentials?: string;
|
|
624
|
+
}
|
|
610
625
|
export declare enum ConfluenceSpaceFieldName {
|
|
611
626
|
DISPLAY_URL = "DISPLAY_URL",
|
|
612
627
|
ITEM_TYPE = "ITEM_TYPE",
|
|
@@ -661,6 +676,10 @@ export interface ConfluenceConfiguration {
|
|
|
661
676
|
InclusionPatterns?: string[];
|
|
662
677
|
|
|
663
678
|
ExclusionPatterns?: string[];
|
|
679
|
+
|
|
680
|
+
ProxyConfiguration?: ProxyConfiguration;
|
|
681
|
+
|
|
682
|
+
AuthenticationType?: ConfluenceAuthenticationType | string;
|
|
664
683
|
}
|
|
665
684
|
|
|
666
685
|
export interface ColumnConfiguration {
|
|
@@ -1147,6 +1166,8 @@ export interface SharePointConfiguration {
|
|
|
1147
1166
|
SslCertificateS3Path?: S3Path;
|
|
1148
1167
|
|
|
1149
1168
|
AuthenticationType?: SharePointOnlineAuthenticationType | string;
|
|
1169
|
+
|
|
1170
|
+
ProxyConfiguration?: ProxyConfiguration;
|
|
1150
1171
|
}
|
|
1151
1172
|
export declare enum SlackEntity {
|
|
1152
1173
|
DIRECT_MESSAGE = "DIRECT_MESSAGE",
|
|
@@ -1186,13 +1207,9 @@ export interface SlackConfiguration {
|
|
|
1186
1207
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1187
1208
|
}
|
|
1188
1209
|
|
|
1189
|
-
export interface
|
|
1210
|
+
export interface TemplateConfiguration {
|
|
1190
1211
|
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
Port: number | undefined;
|
|
1194
|
-
|
|
1195
|
-
Credentials?: string;
|
|
1212
|
+
Template?: __DocumentType;
|
|
1196
1213
|
}
|
|
1197
1214
|
export declare enum WebCrawlerMode {
|
|
1198
1215
|
EVERYTHING = "EVERYTHING",
|
|
@@ -1290,6 +1307,8 @@ export interface DataSourceConfiguration {
|
|
|
1290
1307
|
GitHubConfiguration?: GitHubConfiguration;
|
|
1291
1308
|
|
|
1292
1309
|
AlfrescoConfiguration?: AlfrescoConfiguration;
|
|
1310
|
+
|
|
1311
|
+
TemplateConfiguration?: TemplateConfiguration;
|
|
1293
1312
|
}
|
|
1294
1313
|
|
|
1295
1314
|
export interface Tag {
|
|
@@ -1315,6 +1334,7 @@ export declare enum DataSourceType {
|
|
|
1315
1334
|
SERVICENOW = "SERVICENOW",
|
|
1316
1335
|
SHAREPOINT = "SHAREPOINT",
|
|
1317
1336
|
SLACK = "SLACK",
|
|
1337
|
+
TEMPLATE = "TEMPLATE",
|
|
1318
1338
|
WEBCRAWLER = "WEBCRAWLER",
|
|
1319
1339
|
WORKDOCS = "WORKDOCS"
|
|
1320
1340
|
}
|
|
@@ -1328,6 +1348,8 @@ export interface CreateDataSourceRequest {
|
|
|
1328
1348
|
|
|
1329
1349
|
Configuration?: DataSourceConfiguration;
|
|
1330
1350
|
|
|
1351
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1352
|
+
|
|
1331
1353
|
Description?: string;
|
|
1332
1354
|
|
|
1333
1355
|
Schedule?: string;
|
|
@@ -1634,6 +1656,8 @@ export interface DescribeDataSourceResponse {
|
|
|
1634
1656
|
|
|
1635
1657
|
Configuration?: DataSourceConfiguration;
|
|
1636
1658
|
|
|
1659
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1660
|
+
|
|
1637
1661
|
CreatedAt?: Date;
|
|
1638
1662
|
|
|
1639
1663
|
UpdatedAt?: Date;
|
|
@@ -2712,6 +2736,8 @@ export interface UpdateDataSourceRequest {
|
|
|
2712
2736
|
|
|
2713
2737
|
Configuration?: DataSourceConfiguration;
|
|
2714
2738
|
|
|
2739
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2740
|
+
|
|
2715
2741
|
Description?: string;
|
|
2716
2742
|
|
|
2717
2743
|
Schedule?: string;
|
|
@@ -2817,38 +2843,6 @@ export interface DocumentAttributeValueCountPair {
|
|
|
2817
2843
|
FacetResults?: FacetResult[];
|
|
2818
2844
|
}
|
|
2819
2845
|
|
|
2820
|
-
export interface FacetResult {
|
|
2821
|
-
|
|
2822
|
-
DocumentAttributeKey?: string;
|
|
2823
|
-
|
|
2824
|
-
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
2825
|
-
|
|
2826
|
-
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
2827
|
-
}
|
|
2828
|
-
|
|
2829
|
-
export interface AttributeFilter {
|
|
2830
|
-
|
|
2831
|
-
AndAllFilters?: AttributeFilter[];
|
|
2832
|
-
|
|
2833
|
-
OrAllFilters?: AttributeFilter[];
|
|
2834
|
-
|
|
2835
|
-
NotFilter?: AttributeFilter;
|
|
2836
|
-
|
|
2837
|
-
EqualsTo?: DocumentAttribute;
|
|
2838
|
-
|
|
2839
|
-
ContainsAll?: DocumentAttribute;
|
|
2840
|
-
|
|
2841
|
-
ContainsAny?: DocumentAttribute;
|
|
2842
|
-
|
|
2843
|
-
GreaterThan?: DocumentAttribute;
|
|
2844
|
-
|
|
2845
|
-
GreaterThanOrEquals?: DocumentAttribute;
|
|
2846
|
-
|
|
2847
|
-
LessThan?: DocumentAttribute;
|
|
2848
|
-
|
|
2849
|
-
LessThanOrEquals?: DocumentAttribute;
|
|
2850
|
-
}
|
|
2851
|
-
|
|
2852
2846
|
export declare const AccessControlConfigurationSummaryFilterSensitiveLog: (obj: AccessControlConfigurationSummary) => any;
|
|
2853
2847
|
|
|
2854
2848
|
export declare const AccessControlListConfigurationFilterSensitiveLog: (obj: AccessControlListConfiguration) => any;
|
|
@@ -2953,6 +2947,8 @@ export declare const ConfluencePageToIndexFieldMappingFilterSensitiveLog: (obj:
|
|
|
2953
2947
|
|
|
2954
2948
|
export declare const ConfluencePageConfigurationFilterSensitiveLog: (obj: ConfluencePageConfiguration) => any;
|
|
2955
2949
|
|
|
2950
|
+
export declare const ProxyConfigurationFilterSensitiveLog: (obj: ProxyConfiguration) => any;
|
|
2951
|
+
|
|
2956
2952
|
export declare const ConfluenceSpaceToIndexFieldMappingFilterSensitiveLog: (obj: ConfluenceSpaceToIndexFieldMapping) => any;
|
|
2957
2953
|
|
|
2958
2954
|
export declare const ConfluenceSpaceConfigurationFilterSensitiveLog: (obj: ConfluenceSpaceConfiguration) => any;
|
|
@@ -3015,7 +3011,7 @@ export declare const SharePointConfigurationFilterSensitiveLog: (obj: SharePoint
|
|
|
3015
3011
|
|
|
3016
3012
|
export declare const SlackConfigurationFilterSensitiveLog: (obj: SlackConfiguration) => any;
|
|
3017
3013
|
|
|
3018
|
-
export declare const
|
|
3014
|
+
export declare const TemplateConfigurationFilterSensitiveLog: (obj: TemplateConfiguration) => any;
|
|
3019
3015
|
|
|
3020
3016
|
export declare const SeedUrlConfigurationFilterSensitiveLog: (obj: SeedUrlConfiguration) => any;
|
|
3021
3017
|
|
|
@@ -3310,7 +3306,3 @@ export declare const UpdateThesaurusRequestFilterSensitiveLog: (obj: UpdateThesa
|
|
|
3310
3306
|
export declare const FacetFilterSensitiveLog: (obj: Facet) => any;
|
|
3311
3307
|
|
|
3312
3308
|
export declare const DocumentAttributeValueCountPairFilterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
|
|
3313
|
-
|
|
3314
|
-
export declare const FacetResultFilterSensitiveLog: (obj: FacetResult) => any;
|
|
3315
|
-
|
|
3316
|
-
export declare const AttributeFilterFilterSensitiveLog: (obj: AttributeFilter) => any;
|
|
@@ -1,4 +1,36 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocumentAttribute, DocumentAttributeValueCountPair, DocumentAttributeValueType, DocumentRelevanceConfiguration, Facet, QueryResultItem, QueryResultType, SortingConfiguration, SpellCorrectedQuery, SpellCorrectionConfiguration, UserContext, Warning } from "./models_0";
|
|
2
|
+
|
|
3
|
+
export interface FacetResult {
|
|
4
|
+
|
|
5
|
+
DocumentAttributeKey?: string;
|
|
6
|
+
|
|
7
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
8
|
+
|
|
9
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface AttributeFilter {
|
|
13
|
+
|
|
14
|
+
AndAllFilters?: AttributeFilter[];
|
|
15
|
+
|
|
16
|
+
OrAllFilters?: AttributeFilter[];
|
|
17
|
+
|
|
18
|
+
NotFilter?: AttributeFilter;
|
|
19
|
+
|
|
20
|
+
EqualsTo?: DocumentAttribute;
|
|
21
|
+
|
|
22
|
+
ContainsAll?: DocumentAttribute;
|
|
23
|
+
|
|
24
|
+
ContainsAny?: DocumentAttribute;
|
|
25
|
+
|
|
26
|
+
GreaterThan?: DocumentAttribute;
|
|
27
|
+
|
|
28
|
+
GreaterThanOrEquals?: DocumentAttribute;
|
|
29
|
+
|
|
30
|
+
LessThan?: DocumentAttribute;
|
|
31
|
+
|
|
32
|
+
LessThanOrEquals?: DocumentAttribute;
|
|
33
|
+
}
|
|
2
34
|
export interface QueryResult {
|
|
3
35
|
|
|
4
36
|
QueryId?: string;
|
|
@@ -42,6 +74,10 @@ export interface QueryRequest {
|
|
|
42
74
|
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
43
75
|
}
|
|
44
76
|
|
|
77
|
+
export declare const FacetResultFilterSensitiveLog: (obj: FacetResult) => any;
|
|
78
|
+
|
|
79
|
+
export declare const AttributeFilterFilterSensitiveLog: (obj: AttributeFilter) => any;
|
|
80
|
+
|
|
45
81
|
export declare const QueryResultFilterSensitiveLog: (obj: QueryResult) => any;
|
|
46
82
|
|
|
47
83
|
export declare const QueryRequestFilterSensitiveLog: (obj: QueryRequest) => any;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-kendra",
|
|
3
3
|
"description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.154.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -18,9 +18,9 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
20
20
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
21
|
-
"@aws-sdk/client-sts": "3.
|
|
21
|
+
"@aws-sdk/client-sts": "3.154.0",
|
|
22
22
|
"@aws-sdk/config-resolver": "3.130.0",
|
|
23
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/credential-provider-node": "3.154.0",
|
|
24
24
|
"@aws-sdk/fetch-http-handler": "3.131.0",
|
|
25
25
|
"@aws-sdk/hash-node": "3.127.0",
|
|
26
26
|
"@aws-sdk/invalid-dependency": "3.127.0",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"@aws-sdk/url-parser": "3.127.0",
|
|
42
42
|
"@aws-sdk/util-base64-browser": "3.109.0",
|
|
43
43
|
"@aws-sdk/util-base64-node": "3.55.0",
|
|
44
|
-
"@aws-sdk/util-body-length-browser": "3.
|
|
44
|
+
"@aws-sdk/util-body-length-browser": "3.154.0",
|
|
45
45
|
"@aws-sdk/util-body-length-node": "3.55.0",
|
|
46
46
|
"@aws-sdk/util-defaults-mode-browser": "3.142.0",
|
|
47
47
|
"@aws-sdk/util-defaults-mode-node": "3.142.0",
|