@aws-sdk/client-kendra 3.80.0 → 3.85.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 +28 -0
- package/README.md +2 -0
- package/dist-cjs/models/models_0.js +26 -26
- package/dist-cjs/pagination/ListFaqsPaginator.js +36 -0
- package/dist-cjs/pagination/ListGroupsOlderThanOrderingIdPaginator.js +36 -0
- package/dist-cjs/pagination/ListQuerySuggestionsBlockListsPaginator.js +36 -0
- package/dist-cjs/pagination/ListThesauriPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +6 -0
- package/dist-es/models/models_0.js +16 -16
- package/dist-es/pagination/ListFaqsPaginator.js +75 -0
- package/dist-es/pagination/ListGroupsOlderThanOrderingIdPaginator.js +75 -0
- package/dist-es/pagination/ListQuerySuggestionsBlockListsPaginator.js +75 -0
- package/dist-es/pagination/ListThesauriPaginator.js +75 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +6 -2
- package/dist-types/models/models_0.d.ts +191 -148
- package/dist-types/pagination/ListFaqsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListGroupsOlderThanOrderingIdPaginator.d.ts +4 -0
- package/dist-types/pagination/ListQuerySuggestionsBlockListsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListThesauriPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +57 -51
- package/dist-types/ts3.4/pagination/ListFaqsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListGroupsOlderThanOrderingIdPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListQuerySuggestionsBlockListsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListThesauriPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/package.json +7 -7
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { __asyncGenerator, __await, __awaiter, __generator, __read, __spreadArray } from "tslib";
|
|
2
|
+
import { ListThesauriCommand, } from "../commands/ListThesauriCommand";
|
|
3
|
+
import { Kendra } from "../Kendra";
|
|
4
|
+
import { KendraClient } from "../KendraClient";
|
|
5
|
+
var makePagedClientRequest = function (client, input) {
|
|
6
|
+
var args = [];
|
|
7
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
8
|
+
args[_i - 2] = arguments[_i];
|
|
9
|
+
}
|
|
10
|
+
return __awaiter(void 0, void 0, void 0, function () {
|
|
11
|
+
return __generator(this, function (_a) {
|
|
12
|
+
switch (_a.label) {
|
|
13
|
+
case 0: return [4, client.send.apply(client, __spreadArray([new ListThesauriCommand(input)], __read(args), false))];
|
|
14
|
+
case 1: return [2, _a.sent()];
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
});
|
|
18
|
+
};
|
|
19
|
+
var makePagedRequest = function (client, input) {
|
|
20
|
+
var args = [];
|
|
21
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
22
|
+
args[_i - 2] = arguments[_i];
|
|
23
|
+
}
|
|
24
|
+
return __awaiter(void 0, void 0, void 0, function () {
|
|
25
|
+
return __generator(this, function (_a) {
|
|
26
|
+
switch (_a.label) {
|
|
27
|
+
case 0: return [4, client.listThesauri.apply(client, __spreadArray([input], __read(args), false))];
|
|
28
|
+
case 1: return [2, _a.sent()];
|
|
29
|
+
}
|
|
30
|
+
});
|
|
31
|
+
});
|
|
32
|
+
};
|
|
33
|
+
export function paginateListThesauri(config, input) {
|
|
34
|
+
var additionalArguments = [];
|
|
35
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
36
|
+
additionalArguments[_i - 2] = arguments[_i];
|
|
37
|
+
}
|
|
38
|
+
return __asyncGenerator(this, arguments, function paginateListThesauri_1() {
|
|
39
|
+
var token, hasNext, page, prevToken;
|
|
40
|
+
return __generator(this, function (_a) {
|
|
41
|
+
switch (_a.label) {
|
|
42
|
+
case 0:
|
|
43
|
+
token = config.startingToken || undefined;
|
|
44
|
+
hasNext = true;
|
|
45
|
+
_a.label = 1;
|
|
46
|
+
case 1:
|
|
47
|
+
if (!hasNext) return [3, 9];
|
|
48
|
+
input.NextToken = token;
|
|
49
|
+
input["MaxResults"] = config.pageSize;
|
|
50
|
+
if (!(config.client instanceof Kendra)) return [3, 3];
|
|
51
|
+
return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
|
|
52
|
+
case 2:
|
|
53
|
+
page = _a.sent();
|
|
54
|
+
return [3, 6];
|
|
55
|
+
case 3:
|
|
56
|
+
if (!(config.client instanceof KendraClient)) return [3, 5];
|
|
57
|
+
return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments), false)))];
|
|
58
|
+
case 4:
|
|
59
|
+
page = _a.sent();
|
|
60
|
+
return [3, 6];
|
|
61
|
+
case 5: throw new Error("Invalid client, expected Kendra | KendraClient");
|
|
62
|
+
case 6: return [4, __await(page)];
|
|
63
|
+
case 7: return [4, _a.sent()];
|
|
64
|
+
case 8:
|
|
65
|
+
_a.sent();
|
|
66
|
+
prevToken = token;
|
|
67
|
+
token = page.NextToken;
|
|
68
|
+
hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken));
|
|
69
|
+
return [3, 1];
|
|
70
|
+
case 9: return [4, __await(undefined)];
|
|
71
|
+
case 10: return [2, _a.sent()];
|
|
72
|
+
}
|
|
73
|
+
});
|
|
74
|
+
});
|
|
75
|
+
}
|
|
@@ -5,4 +5,8 @@ export * from "./ListDataSourcesPaginator";
|
|
|
5
5
|
export * from "./ListEntityPersonasPaginator";
|
|
6
6
|
export * from "./ListExperienceEntitiesPaginator";
|
|
7
7
|
export * from "./ListExperiencesPaginator";
|
|
8
|
+
export * from "./ListFaqsPaginator";
|
|
9
|
+
export * from "./ListGroupsOlderThanOrderingIdPaginator";
|
|
8
10
|
export * from "./ListIndicesPaginator";
|
|
11
|
+
export * from "./ListQuerySuggestionsBlockListsPaginator";
|
|
12
|
+
export * from "./ListThesauriPaginator";
|
|
@@ -5273,8 +5273,9 @@ var serializeAws_json1_1ExperienceConfiguration = function (input, context) {
|
|
|
5273
5273
|
}));
|
|
5274
5274
|
};
|
|
5275
5275
|
var serializeAws_json1_1Facet = function (input, context) {
|
|
5276
|
-
return __assign({}, (input.DocumentAttributeKey !== undefined &&
|
|
5277
|
-
input.DocumentAttributeKey !== null && { DocumentAttributeKey: input.DocumentAttributeKey }))
|
|
5276
|
+
return __assign(__assign(__assign({}, (input.DocumentAttributeKey !== undefined &&
|
|
5277
|
+
input.DocumentAttributeKey !== null && { DocumentAttributeKey: input.DocumentAttributeKey })), (input.Facets !== undefined &&
|
|
5278
|
+
input.Facets !== null && { Facets: serializeAws_json1_1FacetList(input.Facets, context) })), (input.MaxResults !== undefined && input.MaxResults !== null && { MaxResults: input.MaxResults }));
|
|
5278
5279
|
};
|
|
5279
5280
|
var serializeAws_json1_1FacetList = function (input, context) {
|
|
5280
5281
|
return input
|
|
@@ -7040,6 +7041,9 @@ var deserializeAws_json1_1DocumentAttributeValueCountPair = function (output, co
|
|
|
7040
7041
|
DocumentAttributeValue: output.DocumentAttributeValue !== undefined && output.DocumentAttributeValue !== null
|
|
7041
7042
|
? deserializeAws_json1_1DocumentAttributeValue(output.DocumentAttributeValue, context)
|
|
7042
7043
|
: undefined,
|
|
7044
|
+
FacetResults: output.FacetResults !== undefined && output.FacetResults !== null
|
|
7045
|
+
? deserializeAws_json1_1FacetResultList(output.FacetResults, context)
|
|
7046
|
+
: undefined,
|
|
7043
7047
|
};
|
|
7044
7048
|
};
|
|
7045
7049
|
var deserializeAws_json1_1DocumentAttributeValueCountPairList = function (output, context) {
|
|
@@ -359,8 +359,8 @@ export declare namespace AssociatePersonasToEntitiesResponse {
|
|
|
359
359
|
const filterSensitiveLog: (obj: AssociatePersonasToEntitiesResponse) => any;
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
|
-
* <p>The value of a
|
|
363
|
-
* value for a
|
|
362
|
+
* <p>The value of a document attribute. You can only provide one
|
|
363
|
+
* value for a document attribute.</p>
|
|
364
364
|
*/
|
|
365
365
|
export interface DocumentAttributeValue {
|
|
366
366
|
/**
|
|
@@ -392,10 +392,8 @@ export declare namespace DocumentAttributeValue {
|
|
|
392
392
|
const filterSensitiveLog: (obj: DocumentAttributeValue) => any;
|
|
393
393
|
}
|
|
394
394
|
/**
|
|
395
|
-
* <p>A
|
|
396
|
-
*
|
|
397
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html">Custom
|
|
398
|
-
* Attributes</a>.</p>
|
|
395
|
+
* <p>A document attribute or metadata field. To create custom document
|
|
396
|
+
* attributes, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html">Custom attributes</a>.</p>
|
|
399
397
|
*/
|
|
400
398
|
export interface DocumentAttribute {
|
|
401
399
|
/**
|
|
@@ -2142,44 +2140,34 @@ export declare namespace OneDriveConfiguration {
|
|
|
2142
2140
|
*/
|
|
2143
2141
|
export interface QuipConfiguration {
|
|
2144
2142
|
/**
|
|
2145
|
-
* <p>The
|
|
2143
|
+
* <p>The Quip site domain.</p>
|
|
2146
2144
|
*/
|
|
2147
2145
|
Domain: string | undefined;
|
|
2148
2146
|
/**
|
|
2149
|
-
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
2150
|
-
* key-value pairs
|
|
2151
|
-
*
|
|
2152
|
-
* required to connect to your Quip file system. Windows is currently the
|
|
2153
|
-
* only supported type. The secret must contain a JSON structure with the following
|
|
2154
|
-
* keys:</p>
|
|
2147
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
2148
|
+
* that contains the key-value pairs that are required to connect to your
|
|
2149
|
+
* Quip. The secret must contain a JSON structure with the following keys:</p>
|
|
2155
2150
|
* <ul>
|
|
2156
2151
|
* <li>
|
|
2157
|
-
* <p>
|
|
2158
|
-
*
|
|
2159
|
-
*
|
|
2160
|
-
* <i>user@corp.example.com</i>.
|
|
2161
|
-
* The Active Directory user account must have read and mounting access to the Quip
|
|
2162
|
-
* file system for Windows.</p>
|
|
2163
|
-
* </li>
|
|
2164
|
-
* <li>
|
|
2165
|
-
* <p>password—The password of the Active Directory user account with
|
|
2166
|
-
* read and mounting access to the Quip Windows file system.</p>
|
|
2152
|
+
* <p>accessToken—The token created in Quip. For more information,
|
|
2153
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication">Authentication
|
|
2154
|
+
* for a Quip data source</a>.</p>
|
|
2167
2155
|
* </li>
|
|
2168
2156
|
* </ul>
|
|
2169
2157
|
*/
|
|
2170
2158
|
SecretArn: string | undefined;
|
|
2171
2159
|
/**
|
|
2172
|
-
* <p>Specify whether to crawl file comments in
|
|
2160
|
+
* <p>Specify whether to crawl file comments in Quip.
|
|
2173
2161
|
* You can specify one or more of these options.</p>
|
|
2174
2162
|
*/
|
|
2175
2163
|
CrawlFileComments?: boolean;
|
|
2176
2164
|
/**
|
|
2177
|
-
* <p>Specify whether to crawl chat rooms in
|
|
2165
|
+
* <p>Specify whether to crawl chat rooms in Quip.
|
|
2178
2166
|
* You can specify one or more of these options.</p>
|
|
2179
2167
|
*/
|
|
2180
2168
|
CrawlChatRooms?: boolean;
|
|
2181
2169
|
/**
|
|
2182
|
-
* <p>Specify whether to crawl attachments in
|
|
2170
|
+
* <p>Specify whether to crawl attachments in Quip.
|
|
2183
2171
|
* You can specify one or more of these options.</p>
|
|
2184
2172
|
*/
|
|
2185
2173
|
CrawlAttachments?: boolean;
|
|
@@ -2188,15 +2176,33 @@ export interface QuipConfiguration {
|
|
|
2188
2176
|
*/
|
|
2189
2177
|
FolderIds?: string[];
|
|
2190
2178
|
/**
|
|
2191
|
-
* <p>A list of
|
|
2179
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2180
|
+
* attributes or field names of Quip threads to Amazon Kendra index
|
|
2181
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2182
|
+
* API before you map to Quip fields. For more information, see
|
|
2183
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2184
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2185
|
+
* Quip custom metadata.</p>
|
|
2192
2186
|
*/
|
|
2193
2187
|
ThreadFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2194
2188
|
/**
|
|
2195
|
-
* <p>A list of
|
|
2189
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2190
|
+
* attributes or field names of Quip messages to Amazon Kendra index
|
|
2191
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2192
|
+
* API before you map to Quip fields. For more information, see
|
|
2193
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2194
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2195
|
+
* Quip custom metadata.</p>
|
|
2196
2196
|
*/
|
|
2197
2197
|
MessageFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2198
2198
|
/**
|
|
2199
|
-
* <p>A list of
|
|
2199
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2200
|
+
* attributes or field names of Quip attachments to Amazon Kendra index
|
|
2201
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2202
|
+
* API before you map to Quip fields. For more information, see
|
|
2203
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2204
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2205
|
+
* Quip custom metadata.</p>
|
|
2200
2206
|
*/
|
|
2201
2207
|
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2202
2208
|
/**
|
|
@@ -2204,8 +2210,7 @@ export interface QuipConfiguration {
|
|
|
2204
2210
|
* system. Files that match the patterns are included in the index. Files that don't match
|
|
2205
2211
|
* the patterns are excluded from the index. If a file matches both an inclusion pattern
|
|
2206
2212
|
* and an exclusion pattern, the exclusion pattern takes
|
|
2207
|
-
* precedence,
|
|
2208
|
-
* and the file isn't included in the index.</p>
|
|
2213
|
+
* precedence, and the file isn't included in the index.</p>
|
|
2209
2214
|
*/
|
|
2210
2215
|
InclusionPatterns?: string[];
|
|
2211
2216
|
/**
|
|
@@ -2213,14 +2218,14 @@ export interface QuipConfiguration {
|
|
|
2213
2218
|
* system. Files that match the patterns are excluded from the index. Files that don’t
|
|
2214
2219
|
* match the patterns are included in the index. If a file matches both an inclusion
|
|
2215
2220
|
* pattern and an exclusion pattern, the exclusion pattern takes
|
|
2216
|
-
* precedence,
|
|
2217
|
-
* and the file isn't included in the index.</p>
|
|
2221
|
+
* precedence, and the file isn't included in the index.</p>
|
|
2218
2222
|
*/
|
|
2219
2223
|
ExclusionPatterns?: string[];
|
|
2220
2224
|
/**
|
|
2221
|
-
* <p>Configuration information for
|
|
2222
|
-
* (VPC)
|
|
2223
|
-
*
|
|
2225
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud
|
|
2226
|
+
* (VPC) to connect to your Quip. For more information, see
|
|
2227
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring
|
|
2228
|
+
* a VPC</a>.</p>
|
|
2224
2229
|
*/
|
|
2225
2230
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2226
2231
|
}
|
|
@@ -6781,21 +6786,6 @@ export declare namespace DocumentRelevanceConfiguration {
|
|
|
6781
6786
|
*/
|
|
6782
6787
|
const filterSensitiveLog: (obj: DocumentRelevanceConfiguration) => any;
|
|
6783
6788
|
}
|
|
6784
|
-
/**
|
|
6785
|
-
* <p>Information about a document attribute</p>
|
|
6786
|
-
*/
|
|
6787
|
-
export interface Facet {
|
|
6788
|
-
/**
|
|
6789
|
-
* <p>The unique key for the document attribute.</p>
|
|
6790
|
-
*/
|
|
6791
|
-
DocumentAttributeKey?: string;
|
|
6792
|
-
}
|
|
6793
|
-
export declare namespace Facet {
|
|
6794
|
-
/**
|
|
6795
|
-
* @internal
|
|
6796
|
-
*/
|
|
6797
|
-
const filterSensitiveLog: (obj: Facet) => any;
|
|
6798
|
-
}
|
|
6799
6789
|
export declare enum QueryResultType {
|
|
6800
6790
|
ANSWER = "ANSWER",
|
|
6801
6791
|
DOCUMENT = "DOCUMENT",
|
|
@@ -6959,54 +6949,6 @@ export declare namespace UserContext {
|
|
|
6959
6949
|
*/
|
|
6960
6950
|
const filterSensitiveLog: (obj: UserContext) => any;
|
|
6961
6951
|
}
|
|
6962
|
-
/**
|
|
6963
|
-
* <p>Provides the count of documents that match a particular attribute
|
|
6964
|
-
* when doing a faceted search.</p>
|
|
6965
|
-
*/
|
|
6966
|
-
export interface DocumentAttributeValueCountPair {
|
|
6967
|
-
/**
|
|
6968
|
-
* <p>The value of the attribute. For example, "HR."</p>
|
|
6969
|
-
*/
|
|
6970
|
-
DocumentAttributeValue?: DocumentAttributeValue;
|
|
6971
|
-
/**
|
|
6972
|
-
* <p>The number of documents in the response that have the attribute
|
|
6973
|
-
* value for the key.</p>
|
|
6974
|
-
*/
|
|
6975
|
-
Count?: number;
|
|
6976
|
-
}
|
|
6977
|
-
export declare namespace DocumentAttributeValueCountPair {
|
|
6978
|
-
/**
|
|
6979
|
-
* @internal
|
|
6980
|
-
*/
|
|
6981
|
-
const filterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
|
|
6982
|
-
}
|
|
6983
|
-
/**
|
|
6984
|
-
* <p>The facet values for the documents in the response.</p>
|
|
6985
|
-
*/
|
|
6986
|
-
export interface FacetResult {
|
|
6987
|
-
/**
|
|
6988
|
-
* <p>The key for the facet values. This is the same as the
|
|
6989
|
-
* <code>DocumentAttributeKey</code> provided in the query.</p>
|
|
6990
|
-
*/
|
|
6991
|
-
DocumentAttributeKey?: string;
|
|
6992
|
-
/**
|
|
6993
|
-
* <p>The data type of the facet value. This is the same as the type
|
|
6994
|
-
* defined for the index field when it was created.</p>
|
|
6995
|
-
*/
|
|
6996
|
-
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
6997
|
-
/**
|
|
6998
|
-
* <p>An array of key/value pairs, where the key is the value of the
|
|
6999
|
-
* attribute and the count is the number of documents that share the key
|
|
7000
|
-
* value.</p>
|
|
7001
|
-
*/
|
|
7002
|
-
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
7003
|
-
}
|
|
7004
|
-
export declare namespace FacetResult {
|
|
7005
|
-
/**
|
|
7006
|
-
* @internal
|
|
7007
|
-
*/
|
|
7008
|
-
const filterSensitiveLog: (obj: FacetResult) => any;
|
|
7009
|
-
}
|
|
7010
6952
|
export declare enum ScoreConfidence {
|
|
7011
6953
|
HIGH = "HIGH",
|
|
7012
6954
|
LOW = "LOW",
|
|
@@ -7071,9 +7013,9 @@ export interface QueryResultItem {
|
|
|
7071
7013
|
*/
|
|
7072
7014
|
DocumentURI?: string;
|
|
7073
7015
|
/**
|
|
7074
|
-
* <p>An array of document attributes
|
|
7075
|
-
*
|
|
7076
|
-
* URI (
|
|
7016
|
+
* <p>An array of document attributes assigned to a document in
|
|
7017
|
+
* the search results. For example, the document author (<code>_author</code>)
|
|
7018
|
+
* or the source URI (<code>_source_uri</code>) of the document.</p>
|
|
7077
7019
|
*/
|
|
7078
7020
|
DocumentAttributes?: DocumentAttribute[];
|
|
7079
7021
|
/**
|
|
@@ -7172,47 +7114,6 @@ export declare namespace Warning {
|
|
|
7172
7114
|
*/
|
|
7173
7115
|
const filterSensitiveLog: (obj: Warning) => any;
|
|
7174
7116
|
}
|
|
7175
|
-
export interface QueryResult {
|
|
7176
|
-
/**
|
|
7177
|
-
* <p>The unique identifier for the search. You use <code>QueryId</code>
|
|
7178
|
-
* to identify the search when using the feedback API.</p>
|
|
7179
|
-
*/
|
|
7180
|
-
QueryId?: string;
|
|
7181
|
-
/**
|
|
7182
|
-
* <p>The results of the search.</p>
|
|
7183
|
-
*/
|
|
7184
|
-
ResultItems?: QueryResultItem[];
|
|
7185
|
-
/**
|
|
7186
|
-
* <p>Contains the facet results. A <code>FacetResult</code> contains the
|
|
7187
|
-
* counts for each attribute key that was specified in the
|
|
7188
|
-
* <code>Facets</code> input parameter.</p>
|
|
7189
|
-
*/
|
|
7190
|
-
FacetResults?: FacetResult[];
|
|
7191
|
-
/**
|
|
7192
|
-
* <p>The total number of items found by the search; however, you can only
|
|
7193
|
-
* retrieve up to 100 items. For example, if the search found 192 items,
|
|
7194
|
-
* you can only retrieve the first 100 of the items.</p>
|
|
7195
|
-
*/
|
|
7196
|
-
TotalNumberOfResults?: number;
|
|
7197
|
-
/**
|
|
7198
|
-
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
7199
|
-
* <p>Amazon Kendra currently only supports one type of warning, which is a warning
|
|
7200
|
-
* on invalid syntax used in the query. For examples of invalid query syntax,
|
|
7201
|
-
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
|
|
7202
|
-
* with advanced query syntax</a>.</p>
|
|
7203
|
-
*/
|
|
7204
|
-
Warnings?: Warning[];
|
|
7205
|
-
/**
|
|
7206
|
-
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
7207
|
-
*/
|
|
7208
|
-
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
7209
|
-
}
|
|
7210
|
-
export declare namespace QueryResult {
|
|
7211
|
-
/**
|
|
7212
|
-
* @internal
|
|
7213
|
-
*/
|
|
7214
|
-
const filterSensitiveLog: (obj: QueryResult) => any;
|
|
7215
|
-
}
|
|
7216
7117
|
/**
|
|
7217
7118
|
* <p></p>
|
|
7218
7119
|
*/
|
|
@@ -7678,6 +7579,108 @@ export declare namespace UpdateThesaurusRequest {
|
|
|
7678
7579
|
*/
|
|
7679
7580
|
const filterSensitiveLog: (obj: UpdateThesaurusRequest) => any;
|
|
7680
7581
|
}
|
|
7582
|
+
/**
|
|
7583
|
+
* <p>Information about a document attribute. You can use document
|
|
7584
|
+
* attributes as facets.</p>
|
|
7585
|
+
* <p>For example, the document attribute or facet "Department" includes
|
|
7586
|
+
* the values "HR", "Engineering", and "Accounting". You can display these
|
|
7587
|
+
* values in the search results so that documents can be searched by department.</p>
|
|
7588
|
+
* <p>You can display up to 10 facet values per facet for a query. If you want to
|
|
7589
|
+
* increase this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7590
|
+
*/
|
|
7591
|
+
export interface Facet {
|
|
7592
|
+
/**
|
|
7593
|
+
* <p>The unique key for the document attribute.</p>
|
|
7594
|
+
*/
|
|
7595
|
+
DocumentAttributeKey?: string;
|
|
7596
|
+
/**
|
|
7597
|
+
* <p>An array of document attributes that are nested facets within a facet.</p>
|
|
7598
|
+
* <p>For example, the document attribute or facet "Department" includes a
|
|
7599
|
+
* value called "Engineering". In addition, the document attribute or
|
|
7600
|
+
* facet "SubDepartment" includes the values "Frontend" and "Backend" for documents
|
|
7601
|
+
* assigned to "Engineering". You can display nested facets in the search results
|
|
7602
|
+
* so that documents can be searched not only by department but also by a sub
|
|
7603
|
+
* department within a department. This helps your users further narrow their
|
|
7604
|
+
* search.</p>
|
|
7605
|
+
* <p>You can only have one nested facet within a facet. If you want to increase
|
|
7606
|
+
* this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7607
|
+
*/
|
|
7608
|
+
Facets?: Facet[];
|
|
7609
|
+
/**
|
|
7610
|
+
* <p>Maximum number of facet values per facet. The default is 10. You can use
|
|
7611
|
+
* this to limit the number of facet values to less than 10. If you want to
|
|
7612
|
+
* increase the default, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7613
|
+
*/
|
|
7614
|
+
MaxResults?: number;
|
|
7615
|
+
}
|
|
7616
|
+
export declare namespace Facet {
|
|
7617
|
+
/**
|
|
7618
|
+
* @internal
|
|
7619
|
+
*/
|
|
7620
|
+
const filterSensitiveLog: (obj: Facet) => any;
|
|
7621
|
+
}
|
|
7622
|
+
/**
|
|
7623
|
+
* <p>Provides the count of documents that match a particular attribute
|
|
7624
|
+
* when doing a faceted search.</p>
|
|
7625
|
+
*/
|
|
7626
|
+
export interface DocumentAttributeValueCountPair {
|
|
7627
|
+
/**
|
|
7628
|
+
* <p>The value of the attribute. For example, "HR".</p>
|
|
7629
|
+
*/
|
|
7630
|
+
DocumentAttributeValue?: DocumentAttributeValue;
|
|
7631
|
+
/**
|
|
7632
|
+
* <p>The number of documents in the response that have the attribute
|
|
7633
|
+
* value for the key.</p>
|
|
7634
|
+
*/
|
|
7635
|
+
Count?: number;
|
|
7636
|
+
/**
|
|
7637
|
+
* <p>Contains the results of a document attribute that is a nested facet.
|
|
7638
|
+
* A <code>FacetResult</code> contains the counts for each facet nested
|
|
7639
|
+
* within a facet.</p>
|
|
7640
|
+
* <p>For example, the document attribute or facet "Department" includes a
|
|
7641
|
+
* value called "Engineering". In addition, the document attribute
|
|
7642
|
+
* or facet "SubDepartment" includes the values "Frontend" and "Backend"
|
|
7643
|
+
* for documents assigned to "Engineering". You can display nested facets
|
|
7644
|
+
* in the search results so that documents can be searched not only by
|
|
7645
|
+
* department but also by a sub department within a department. The counts
|
|
7646
|
+
* for documents that belong to "Frontend" and "Backend" within "Engineering"
|
|
7647
|
+
* are returned for a query.</p>
|
|
7648
|
+
*/
|
|
7649
|
+
FacetResults?: FacetResult[];
|
|
7650
|
+
}
|
|
7651
|
+
export declare namespace DocumentAttributeValueCountPair {
|
|
7652
|
+
/**
|
|
7653
|
+
* @internal
|
|
7654
|
+
*/
|
|
7655
|
+
const filterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
|
|
7656
|
+
}
|
|
7657
|
+
/**
|
|
7658
|
+
* <p>The facet values for the documents in the response.</p>
|
|
7659
|
+
*/
|
|
7660
|
+
export interface FacetResult {
|
|
7661
|
+
/**
|
|
7662
|
+
* <p>The key for the facet values. This is the same as the
|
|
7663
|
+
* <code>DocumentAttributeKey</code> provided in the query.</p>
|
|
7664
|
+
*/
|
|
7665
|
+
DocumentAttributeKey?: string;
|
|
7666
|
+
/**
|
|
7667
|
+
* <p>The data type of the facet value. This is the same as the type
|
|
7668
|
+
* defined for the index field when it was created.</p>
|
|
7669
|
+
*/
|
|
7670
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
7671
|
+
/**
|
|
7672
|
+
* <p>An array of key/value pairs, where the key is the value of the
|
|
7673
|
+
* attribute and the count is the number of documents that share the key
|
|
7674
|
+
* value.</p>
|
|
7675
|
+
*/
|
|
7676
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
7677
|
+
}
|
|
7678
|
+
export declare namespace FacetResult {
|
|
7679
|
+
/**
|
|
7680
|
+
* @internal
|
|
7681
|
+
*/
|
|
7682
|
+
const filterSensitiveLog: (obj: FacetResult) => any;
|
|
7683
|
+
}
|
|
7681
7684
|
/**
|
|
7682
7685
|
* <p>Provides filtering the query results based on document
|
|
7683
7686
|
* attributes.</p>
|
|
@@ -7771,6 +7774,47 @@ export declare namespace AttributeFilter {
|
|
|
7771
7774
|
*/
|
|
7772
7775
|
const filterSensitiveLog: (obj: AttributeFilter) => any;
|
|
7773
7776
|
}
|
|
7777
|
+
export interface QueryResult {
|
|
7778
|
+
/**
|
|
7779
|
+
* <p>The unique identifier for the search. You use <code>QueryId</code>
|
|
7780
|
+
* to identify the search when using the feedback API.</p>
|
|
7781
|
+
*/
|
|
7782
|
+
QueryId?: string;
|
|
7783
|
+
/**
|
|
7784
|
+
* <p>The results of the search.</p>
|
|
7785
|
+
*/
|
|
7786
|
+
ResultItems?: QueryResultItem[];
|
|
7787
|
+
/**
|
|
7788
|
+
* <p>Contains the facet results. A <code>FacetResult</code> contains the
|
|
7789
|
+
* counts for each attribute key that was specified in the
|
|
7790
|
+
* <code>Facets</code> input parameter.</p>
|
|
7791
|
+
*/
|
|
7792
|
+
FacetResults?: FacetResult[];
|
|
7793
|
+
/**
|
|
7794
|
+
* <p>The total number of items found by the search; however, you can only
|
|
7795
|
+
* retrieve up to 100 items. For example, if the search found 192 items,
|
|
7796
|
+
* you can only retrieve the first 100 of the items.</p>
|
|
7797
|
+
*/
|
|
7798
|
+
TotalNumberOfResults?: number;
|
|
7799
|
+
/**
|
|
7800
|
+
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
7801
|
+
* <p>Amazon Kendra currently only supports one type of warning, which is a warning
|
|
7802
|
+
* on invalid syntax used in the query. For examples of invalid query syntax,
|
|
7803
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
|
|
7804
|
+
* with advanced query syntax</a>.</p>
|
|
7805
|
+
*/
|
|
7806
|
+
Warnings?: Warning[];
|
|
7807
|
+
/**
|
|
7808
|
+
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
7809
|
+
*/
|
|
7810
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
7811
|
+
}
|
|
7812
|
+
export declare namespace QueryResult {
|
|
7813
|
+
/**
|
|
7814
|
+
* @internal
|
|
7815
|
+
*/
|
|
7816
|
+
const filterSensitiveLog: (obj: QueryResult) => any;
|
|
7817
|
+
}
|
|
7774
7818
|
export interface QueryRequest {
|
|
7775
7819
|
/**
|
|
7776
7820
|
* <p>The unique identifier of the index to search. The identifier is
|
|
@@ -7794,14 +7838,13 @@ export interface QueryRequest {
|
|
|
7794
7838
|
AttributeFilter?: AttributeFilter;
|
|
7795
7839
|
/**
|
|
7796
7840
|
* <p>An array of documents attributes. Amazon Kendra returns a count for
|
|
7797
|
-
* each attribute key specified.
|
|
7798
|
-
* narrow the search for your user.</p>
|
|
7841
|
+
* each attribute key specified. This helps your users narrow their search.</p>
|
|
7799
7842
|
*/
|
|
7800
7843
|
Facets?: Facet[];
|
|
7801
7844
|
/**
|
|
7802
|
-
* <p>An array of document attributes to include in the response.
|
|
7803
|
-
*
|
|
7804
|
-
* document attributes are included in the response
|
|
7845
|
+
* <p>An array of document attributes to include in the response.
|
|
7846
|
+
* You can limit the response to include certain document attributes.
|
|
7847
|
+
* By default all document attributes are included in the response.</p>
|
|
7805
7848
|
*/
|
|
7806
7849
|
RequestedDocumentAttributes?: string[];
|
|
7807
7850
|
/**
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListFaqsCommandInput, ListFaqsCommandOutput } from "../commands/ListFaqsCommand";
|
|
3
|
+
import { KendraPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListFaqs(config: KendraPaginationConfiguration, input: ListFaqsCommandInput, ...additionalArguments: any): Paginator<ListFaqsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListGroupsOlderThanOrderingIdCommandInput, ListGroupsOlderThanOrderingIdCommandOutput } from "../commands/ListGroupsOlderThanOrderingIdCommand";
|
|
3
|
+
import { KendraPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListGroupsOlderThanOrderingId(config: KendraPaginationConfiguration, input: ListGroupsOlderThanOrderingIdCommandInput, ...additionalArguments: any): Paginator<ListGroupsOlderThanOrderingIdCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListQuerySuggestionsBlockListsCommandInput, ListQuerySuggestionsBlockListsCommandOutput } from "../commands/ListQuerySuggestionsBlockListsCommand";
|
|
3
|
+
import { KendraPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListQuerySuggestionsBlockLists(config: KendraPaginationConfiguration, input: ListQuerySuggestionsBlockListsCommandInput, ...additionalArguments: any): Paginator<ListQuerySuggestionsBlockListsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListThesauriCommandInput, ListThesauriCommandOutput } from "../commands/ListThesauriCommand";
|
|
3
|
+
import { KendraPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListThesauri(config: KendraPaginationConfiguration, input: ListThesauriCommandInput, ...additionalArguments: any): Paginator<ListThesauriCommandOutput>;
|
|
@@ -5,4 +5,8 @@ export * from "./ListDataSourcesPaginator";
|
|
|
5
5
|
export * from "./ListEntityPersonasPaginator";
|
|
6
6
|
export * from "./ListExperienceEntitiesPaginator";
|
|
7
7
|
export * from "./ListExperiencesPaginator";
|
|
8
|
+
export * from "./ListFaqsPaginator";
|
|
9
|
+
export * from "./ListGroupsOlderThanOrderingIdPaginator";
|
|
8
10
|
export * from "./ListIndicesPaginator";
|
|
11
|
+
export * from "./ListQuerySuggestionsBlockListsPaginator";
|
|
12
|
+
export * from "./ListThesauriPaginator";
|