@aws-sdk/client-kendra 3.82.0 → 3.90.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 +31 -0
- package/README.md +2 -0
- package/dist-cjs/models/models_0.js +42 -29
- 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 +190 -0
- package/dist-es/models/models_0.js +27 -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 +174 -3
- package/dist-types/models/models_0.d.ts +334 -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 +101 -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 +6 -6
|
@@ -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
|
/**
|
|
@@ -2050,6 +2048,143 @@ export declare namespace GoogleDriveConfiguration {
|
|
|
2050
2048
|
*/
|
|
2051
2049
|
const filterSensitiveLog: (obj: GoogleDriveConfiguration) => any;
|
|
2052
2050
|
}
|
|
2051
|
+
export declare enum IssueSubEntity {
|
|
2052
|
+
ATTACHMENTS = "ATTACHMENTS",
|
|
2053
|
+
COMMENTS = "COMMENTS",
|
|
2054
|
+
WORKLOGS = "WORKLOGS"
|
|
2055
|
+
}
|
|
2056
|
+
export interface JiraConfiguration {
|
|
2057
|
+
/**
|
|
2058
|
+
* <p>The URL of the Jira account. For example, company.attlassian.net or
|
|
2059
|
+
* https://jira.company.com. You can find your Jira account URL in the URL of
|
|
2060
|
+
* your profile page for Jira desktop.</p>
|
|
2061
|
+
*/
|
|
2062
|
+
JiraAccountUrl: string | undefined;
|
|
2063
|
+
/**
|
|
2064
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
2065
|
+
* contains the key-value pairs required to connect to your Jira
|
|
2066
|
+
* data source. The secret must
|
|
2067
|
+
* contain a JSON structure with the following keys:</p>
|
|
2068
|
+
* <ul>
|
|
2069
|
+
* <li>
|
|
2070
|
+
* <p>jira-id—The Active Directory user name, along with the
|
|
2071
|
+
* Domain Name System (DNS) domain name. For example,
|
|
2072
|
+
* <i>user@corp.example.com</i>.</p>
|
|
2073
|
+
* </li>
|
|
2074
|
+
* <li>
|
|
2075
|
+
* <p>jiraCredentials—The password of the Jira account user.</p>
|
|
2076
|
+
* </li>
|
|
2077
|
+
* </ul>
|
|
2078
|
+
*/
|
|
2079
|
+
SecretArn: string | undefined;
|
|
2080
|
+
/**
|
|
2081
|
+
* <p>Specify to use the change log option to update your index.</p>
|
|
2082
|
+
*/
|
|
2083
|
+
UseChangeLog?: boolean;
|
|
2084
|
+
/**
|
|
2085
|
+
* <p>Specify which projects to crawl in your Jira data source. You can specify
|
|
2086
|
+
* one or more Jira project IDs.</p>
|
|
2087
|
+
*/
|
|
2088
|
+
Project?: string[];
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>Specify which issue types to crawl in your Jira data source.
|
|
2091
|
+
* You can specify one or more of these options to crawl.</p>
|
|
2092
|
+
*/
|
|
2093
|
+
IssueType?: string[];
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>Specify which statuses to crawl in your Jira data source.
|
|
2096
|
+
* You can specify one or more of these options to crawl.</p>
|
|
2097
|
+
*/
|
|
2098
|
+
Status?: string[];
|
|
2099
|
+
/**
|
|
2100
|
+
* <p>Specify whether to crawl comments,
|
|
2101
|
+
* attachments,
|
|
2102
|
+
* and work logs. You can specify one or more of these options.</p>
|
|
2103
|
+
*/
|
|
2104
|
+
IssueSubEntityFilter?: (IssueSubEntity | string)[];
|
|
2105
|
+
/**
|
|
2106
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2107
|
+
* or field names of Jira attachments to Amazon Kendra index field names.
|
|
2108
|
+
* To create custom fields, use the UpdateIndex API before you map to Jira
|
|
2109
|
+
* fields. For
|
|
2110
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
|
|
2111
|
+
* Mapping data source fields</a>. The Jira data source field names
|
|
2112
|
+
* must exist in your Jira custom metadata.</p>
|
|
2113
|
+
*/
|
|
2114
|
+
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2115
|
+
/**
|
|
2116
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2117
|
+
* or field names of Jira comments to Amazon Kendra index field names.
|
|
2118
|
+
* To create custom fields, use the UpdateIndex API before you map to Jira
|
|
2119
|
+
* fields. For
|
|
2120
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
|
|
2121
|
+
* Mapping data source fields</a>. The Jira data source field names
|
|
2122
|
+
* must exist in your Jira custom metadata.</p>
|
|
2123
|
+
*/
|
|
2124
|
+
CommentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2125
|
+
/**
|
|
2126
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2127
|
+
* or field names of Jira issues to Amazon Kendra index field names.
|
|
2128
|
+
* To create custom fields, use the UpdateIndex API before you map to Jira
|
|
2129
|
+
* fields. For
|
|
2130
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
|
|
2131
|
+
* Mapping data source fields</a>. The Jira data source field names
|
|
2132
|
+
* must exist in your Jira custom metadata.</p>
|
|
2133
|
+
*/
|
|
2134
|
+
IssueFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2135
|
+
/**
|
|
2136
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2137
|
+
* or field names of Jira projects to Amazon Kendra index field names.
|
|
2138
|
+
* To create custom fields, use the UpdateIndex API before you map to Jira
|
|
2139
|
+
* fields. For
|
|
2140
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
|
|
2141
|
+
* Mapping data source fields</a>. The Jira data source field names
|
|
2142
|
+
* must exist in your Jira custom metadata.</p>
|
|
2143
|
+
*/
|
|
2144
|
+
ProjectFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2145
|
+
/**
|
|
2146
|
+
* <p>A list of DataSourceToIndexFieldMapping objects that map attributes
|
|
2147
|
+
* or field names of Jira work logs to Amazon Kendra index field names.
|
|
2148
|
+
* To create custom fields, use the UpdateIndex API before you map to Jira
|
|
2149
|
+
* fields. For
|
|
2150
|
+
* more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
|
|
2151
|
+
* Mapping data source fields</a>. The Jira data source field names
|
|
2152
|
+
* must exist in your Jira custom metadata.</p>
|
|
2153
|
+
*/
|
|
2154
|
+
WorkLogFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2155
|
+
/**
|
|
2156
|
+
* <p>A list of regular expression patterns to include certain file paths,
|
|
2157
|
+
* file
|
|
2158
|
+
* names, and
|
|
2159
|
+
* file types in your Jira data source. Files that match the patterns are included in the
|
|
2160
|
+
* index. Files that don't match the patterns are excluded from the index. If a file
|
|
2161
|
+
* matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes
|
|
2162
|
+
* precedence and the file isn't included in the index.</p>
|
|
2163
|
+
*/
|
|
2164
|
+
InclusionPatterns?: string[];
|
|
2165
|
+
/**
|
|
2166
|
+
* <p>A list of regular expression patterns to exclude certain file paths,
|
|
2167
|
+
* file names, and file types
|
|
2168
|
+
* in your Jira data source. Files that match the patterns
|
|
2169
|
+
* are excluded from the index. Files that don’t match the patterns are
|
|
2170
|
+
* included in the index. If a file matches both an inclusion pattern
|
|
2171
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
2172
|
+
* and the file isn't included in the index.</p>
|
|
2173
|
+
*/
|
|
2174
|
+
ExclusionPatterns?: string[];
|
|
2175
|
+
/**
|
|
2176
|
+
* <p>Configuration information for an
|
|
2177
|
+
* Amazon Virtual Private Cloud to connect to your Jira. Your Jira
|
|
2178
|
+
* account must reside inside your VPC.</p>
|
|
2179
|
+
*/
|
|
2180
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2181
|
+
}
|
|
2182
|
+
export declare namespace JiraConfiguration {
|
|
2183
|
+
/**
|
|
2184
|
+
* @internal
|
|
2185
|
+
*/
|
|
2186
|
+
const filterSensitiveLog: (obj: JiraConfiguration) => any;
|
|
2187
|
+
}
|
|
2053
2188
|
/**
|
|
2054
2189
|
* <p>User accounts whose documents should be indexed.</p>
|
|
2055
2190
|
*/
|
|
@@ -2142,44 +2277,34 @@ export declare namespace OneDriveConfiguration {
|
|
|
2142
2277
|
*/
|
|
2143
2278
|
export interface QuipConfiguration {
|
|
2144
2279
|
/**
|
|
2145
|
-
* <p>The
|
|
2280
|
+
* <p>The Quip site domain.</p>
|
|
2146
2281
|
*/
|
|
2147
2282
|
Domain: string | undefined;
|
|
2148
2283
|
/**
|
|
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>
|
|
2284
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
2285
|
+
* that contains the key-value pairs that are required to connect to your
|
|
2286
|
+
* Quip. The secret must contain a JSON structure with the following keys:</p>
|
|
2155
2287
|
* <ul>
|
|
2156
2288
|
* <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>
|
|
2289
|
+
* <p>accessToken—The token created in Quip. For more information,
|
|
2290
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication">Authentication
|
|
2291
|
+
* for a Quip data source</a>.</p>
|
|
2167
2292
|
* </li>
|
|
2168
2293
|
* </ul>
|
|
2169
2294
|
*/
|
|
2170
2295
|
SecretArn: string | undefined;
|
|
2171
2296
|
/**
|
|
2172
|
-
* <p>Specify whether to crawl file comments in
|
|
2297
|
+
* <p>Specify whether to crawl file comments in Quip.
|
|
2173
2298
|
* You can specify one or more of these options.</p>
|
|
2174
2299
|
*/
|
|
2175
2300
|
CrawlFileComments?: boolean;
|
|
2176
2301
|
/**
|
|
2177
|
-
* <p>Specify whether to crawl chat rooms in
|
|
2302
|
+
* <p>Specify whether to crawl chat rooms in Quip.
|
|
2178
2303
|
* You can specify one or more of these options.</p>
|
|
2179
2304
|
*/
|
|
2180
2305
|
CrawlChatRooms?: boolean;
|
|
2181
2306
|
/**
|
|
2182
|
-
* <p>Specify whether to crawl attachments in
|
|
2307
|
+
* <p>Specify whether to crawl attachments in Quip.
|
|
2183
2308
|
* You can specify one or more of these options.</p>
|
|
2184
2309
|
*/
|
|
2185
2310
|
CrawlAttachments?: boolean;
|
|
@@ -2188,15 +2313,33 @@ export interface QuipConfiguration {
|
|
|
2188
2313
|
*/
|
|
2189
2314
|
FolderIds?: string[];
|
|
2190
2315
|
/**
|
|
2191
|
-
* <p>A list of
|
|
2316
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2317
|
+
* attributes or field names of Quip threads to Amazon Kendra index
|
|
2318
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2319
|
+
* API before you map to Quip fields. For more information, see
|
|
2320
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2321
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2322
|
+
* Quip custom metadata.</p>
|
|
2192
2323
|
*/
|
|
2193
2324
|
ThreadFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2194
2325
|
/**
|
|
2195
|
-
* <p>A list of
|
|
2326
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2327
|
+
* attributes or field names of Quip messages to Amazon Kendra index
|
|
2328
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2329
|
+
* API before you map to Quip fields. For more information, see
|
|
2330
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2331
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2332
|
+
* Quip custom metadata.</p>
|
|
2196
2333
|
*/
|
|
2197
2334
|
MessageFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2198
2335
|
/**
|
|
2199
|
-
* <p>A list of
|
|
2336
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2337
|
+
* attributes or field names of Quip attachments to Amazon Kendra index
|
|
2338
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code>
|
|
2339
|
+
* API before you map to Quip fields. For more information, see
|
|
2340
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2341
|
+
* data source fields</a>. The Quip field names must exist in your
|
|
2342
|
+
* Quip custom metadata.</p>
|
|
2200
2343
|
*/
|
|
2201
2344
|
AttachmentFieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2202
2345
|
/**
|
|
@@ -2204,8 +2347,7 @@ export interface QuipConfiguration {
|
|
|
2204
2347
|
* system. Files that match the patterns are included in the index. Files that don't match
|
|
2205
2348
|
* the patterns are excluded from the index. If a file matches both an inclusion pattern
|
|
2206
2349
|
* and an exclusion pattern, the exclusion pattern takes
|
|
2207
|
-
* precedence,
|
|
2208
|
-
* and the file isn't included in the index.</p>
|
|
2350
|
+
* precedence, and the file isn't included in the index.</p>
|
|
2209
2351
|
*/
|
|
2210
2352
|
InclusionPatterns?: string[];
|
|
2211
2353
|
/**
|
|
@@ -2213,14 +2355,14 @@ export interface QuipConfiguration {
|
|
|
2213
2355
|
* system. Files that match the patterns are excluded from the index. Files that don’t
|
|
2214
2356
|
* match the patterns are included in the index. If a file matches both an inclusion
|
|
2215
2357
|
* pattern and an exclusion pattern, the exclusion pattern takes
|
|
2216
|
-
* precedence,
|
|
2217
|
-
* and the file isn't included in the index.</p>
|
|
2358
|
+
* precedence, and the file isn't included in the index.</p>
|
|
2218
2359
|
*/
|
|
2219
2360
|
ExclusionPatterns?: string[];
|
|
2220
2361
|
/**
|
|
2221
|
-
* <p>Configuration information for
|
|
2222
|
-
* (VPC)
|
|
2223
|
-
*
|
|
2362
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud
|
|
2363
|
+
* (VPC) to connect to your Quip. For more information, see
|
|
2364
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring
|
|
2365
|
+
* a VPC</a>.</p>
|
|
2224
2366
|
*/
|
|
2225
2367
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2226
2368
|
}
|
|
@@ -3436,6 +3578,11 @@ export interface DataSourceConfiguration {
|
|
|
3436
3578
|
* data source.</p>
|
|
3437
3579
|
*/
|
|
3438
3580
|
QuipConfiguration?: QuipConfiguration;
|
|
3581
|
+
/**
|
|
3582
|
+
* <p>Provides the configuration information to connect to Jira as your
|
|
3583
|
+
* data source.</p>
|
|
3584
|
+
*/
|
|
3585
|
+
JiraConfiguration?: JiraConfiguration;
|
|
3439
3586
|
}
|
|
3440
3587
|
export declare namespace DataSourceConfiguration {
|
|
3441
3588
|
/**
|
|
@@ -3473,6 +3620,7 @@ export declare enum DataSourceType {
|
|
|
3473
3620
|
DATABASE = "DATABASE",
|
|
3474
3621
|
FSX = "FSX",
|
|
3475
3622
|
GOOGLEDRIVE = "GOOGLEDRIVE",
|
|
3623
|
+
JIRA = "JIRA",
|
|
3476
3624
|
ONEDRIVE = "ONEDRIVE",
|
|
3477
3625
|
QUIP = "QUIP",
|
|
3478
3626
|
S3 = "S3",
|
|
@@ -6781,21 +6929,6 @@ export declare namespace DocumentRelevanceConfiguration {
|
|
|
6781
6929
|
*/
|
|
6782
6930
|
const filterSensitiveLog: (obj: DocumentRelevanceConfiguration) => any;
|
|
6783
6931
|
}
|
|
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
6932
|
export declare enum QueryResultType {
|
|
6800
6933
|
ANSWER = "ANSWER",
|
|
6801
6934
|
DOCUMENT = "DOCUMENT",
|
|
@@ -6959,54 +7092,6 @@ export declare namespace UserContext {
|
|
|
6959
7092
|
*/
|
|
6960
7093
|
const filterSensitiveLog: (obj: UserContext) => any;
|
|
6961
7094
|
}
|
|
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
7095
|
export declare enum ScoreConfidence {
|
|
7011
7096
|
HIGH = "HIGH",
|
|
7012
7097
|
LOW = "LOW",
|
|
@@ -7071,9 +7156,9 @@ export interface QueryResultItem {
|
|
|
7071
7156
|
*/
|
|
7072
7157
|
DocumentURI?: string;
|
|
7073
7158
|
/**
|
|
7074
|
-
* <p>An array of document attributes
|
|
7075
|
-
*
|
|
7076
|
-
* URI (
|
|
7159
|
+
* <p>An array of document attributes assigned to a document in
|
|
7160
|
+
* the search results. For example, the document author (<code>_author</code>)
|
|
7161
|
+
* or the source URI (<code>_source_uri</code>) of the document.</p>
|
|
7077
7162
|
*/
|
|
7078
7163
|
DocumentAttributes?: DocumentAttribute[];
|
|
7079
7164
|
/**
|
|
@@ -7172,47 +7257,6 @@ export declare namespace Warning {
|
|
|
7172
7257
|
*/
|
|
7173
7258
|
const filterSensitiveLog: (obj: Warning) => any;
|
|
7174
7259
|
}
|
|
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
7260
|
/**
|
|
7217
7261
|
* <p></p>
|
|
7218
7262
|
*/
|
|
@@ -7678,6 +7722,108 @@ export declare namespace UpdateThesaurusRequest {
|
|
|
7678
7722
|
*/
|
|
7679
7723
|
const filterSensitiveLog: (obj: UpdateThesaurusRequest) => any;
|
|
7680
7724
|
}
|
|
7725
|
+
/**
|
|
7726
|
+
* <p>Information about a document attribute. You can use document
|
|
7727
|
+
* attributes as facets.</p>
|
|
7728
|
+
* <p>For example, the document attribute or facet "Department" includes
|
|
7729
|
+
* the values "HR", "Engineering", and "Accounting". You can display these
|
|
7730
|
+
* values in the search results so that documents can be searched by department.</p>
|
|
7731
|
+
* <p>You can display up to 10 facet values per facet for a query. If you want to
|
|
7732
|
+
* increase this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7733
|
+
*/
|
|
7734
|
+
export interface Facet {
|
|
7735
|
+
/**
|
|
7736
|
+
* <p>The unique key for the document attribute.</p>
|
|
7737
|
+
*/
|
|
7738
|
+
DocumentAttributeKey?: string;
|
|
7739
|
+
/**
|
|
7740
|
+
* <p>An array of document attributes that are nested facets within a facet.</p>
|
|
7741
|
+
* <p>For example, the document attribute or facet "Department" includes a
|
|
7742
|
+
* value called "Engineering". In addition, the document attribute or
|
|
7743
|
+
* facet "SubDepartment" includes the values "Frontend" and "Backend" for documents
|
|
7744
|
+
* assigned to "Engineering". You can display nested facets in the search results
|
|
7745
|
+
* so that documents can be searched not only by department but also by a sub
|
|
7746
|
+
* department within a department. This helps your users further narrow their
|
|
7747
|
+
* search.</p>
|
|
7748
|
+
* <p>You can only have one nested facet within a facet. If you want to increase
|
|
7749
|
+
* this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7750
|
+
*/
|
|
7751
|
+
Facets?: Facet[];
|
|
7752
|
+
/**
|
|
7753
|
+
* <p>Maximum number of facet values per facet. The default is 10. You can use
|
|
7754
|
+
* this to limit the number of facet values to less than 10. If you want to
|
|
7755
|
+
* increase the default, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
7756
|
+
*/
|
|
7757
|
+
MaxResults?: number;
|
|
7758
|
+
}
|
|
7759
|
+
export declare namespace Facet {
|
|
7760
|
+
/**
|
|
7761
|
+
* @internal
|
|
7762
|
+
*/
|
|
7763
|
+
const filterSensitiveLog: (obj: Facet) => any;
|
|
7764
|
+
}
|
|
7765
|
+
/**
|
|
7766
|
+
* <p>Provides the count of documents that match a particular attribute
|
|
7767
|
+
* when doing a faceted search.</p>
|
|
7768
|
+
*/
|
|
7769
|
+
export interface DocumentAttributeValueCountPair {
|
|
7770
|
+
/**
|
|
7771
|
+
* <p>The value of the attribute. For example, "HR".</p>
|
|
7772
|
+
*/
|
|
7773
|
+
DocumentAttributeValue?: DocumentAttributeValue;
|
|
7774
|
+
/**
|
|
7775
|
+
* <p>The number of documents in the response that have the attribute
|
|
7776
|
+
* value for the key.</p>
|
|
7777
|
+
*/
|
|
7778
|
+
Count?: number;
|
|
7779
|
+
/**
|
|
7780
|
+
* <p>Contains the results of a document attribute that is a nested facet.
|
|
7781
|
+
* A <code>FacetResult</code> contains the counts for each facet nested
|
|
7782
|
+
* within a facet.</p>
|
|
7783
|
+
* <p>For example, the document attribute or facet "Department" includes a
|
|
7784
|
+
* value called "Engineering". In addition, the document attribute
|
|
7785
|
+
* or facet "SubDepartment" includes the values "Frontend" and "Backend"
|
|
7786
|
+
* for documents assigned to "Engineering". You can display nested facets
|
|
7787
|
+
* in the search results so that documents can be searched not only by
|
|
7788
|
+
* department but also by a sub department within a department. The counts
|
|
7789
|
+
* for documents that belong to "Frontend" and "Backend" within "Engineering"
|
|
7790
|
+
* are returned for a query.</p>
|
|
7791
|
+
*/
|
|
7792
|
+
FacetResults?: FacetResult[];
|
|
7793
|
+
}
|
|
7794
|
+
export declare namespace DocumentAttributeValueCountPair {
|
|
7795
|
+
/**
|
|
7796
|
+
* @internal
|
|
7797
|
+
*/
|
|
7798
|
+
const filterSensitiveLog: (obj: DocumentAttributeValueCountPair) => any;
|
|
7799
|
+
}
|
|
7800
|
+
/**
|
|
7801
|
+
* <p>The facet values for the documents in the response.</p>
|
|
7802
|
+
*/
|
|
7803
|
+
export interface FacetResult {
|
|
7804
|
+
/**
|
|
7805
|
+
* <p>The key for the facet values. This is the same as the
|
|
7806
|
+
* <code>DocumentAttributeKey</code> provided in the query.</p>
|
|
7807
|
+
*/
|
|
7808
|
+
DocumentAttributeKey?: string;
|
|
7809
|
+
/**
|
|
7810
|
+
* <p>The data type of the facet value. This is the same as the type
|
|
7811
|
+
* defined for the index field when it was created.</p>
|
|
7812
|
+
*/
|
|
7813
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | string;
|
|
7814
|
+
/**
|
|
7815
|
+
* <p>An array of key/value pairs, where the key is the value of the
|
|
7816
|
+
* attribute and the count is the number of documents that share the key
|
|
7817
|
+
* value.</p>
|
|
7818
|
+
*/
|
|
7819
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
7820
|
+
}
|
|
7821
|
+
export declare namespace FacetResult {
|
|
7822
|
+
/**
|
|
7823
|
+
* @internal
|
|
7824
|
+
*/
|
|
7825
|
+
const filterSensitiveLog: (obj: FacetResult) => any;
|
|
7826
|
+
}
|
|
7681
7827
|
/**
|
|
7682
7828
|
* <p>Provides filtering the query results based on document
|
|
7683
7829
|
* attributes.</p>
|
|
@@ -7771,6 +7917,47 @@ export declare namespace AttributeFilter {
|
|
|
7771
7917
|
*/
|
|
7772
7918
|
const filterSensitiveLog: (obj: AttributeFilter) => any;
|
|
7773
7919
|
}
|
|
7920
|
+
export interface QueryResult {
|
|
7921
|
+
/**
|
|
7922
|
+
* <p>The unique identifier for the search. You use <code>QueryId</code>
|
|
7923
|
+
* to identify the search when using the feedback API.</p>
|
|
7924
|
+
*/
|
|
7925
|
+
QueryId?: string;
|
|
7926
|
+
/**
|
|
7927
|
+
* <p>The results of the search.</p>
|
|
7928
|
+
*/
|
|
7929
|
+
ResultItems?: QueryResultItem[];
|
|
7930
|
+
/**
|
|
7931
|
+
* <p>Contains the facet results. A <code>FacetResult</code> contains the
|
|
7932
|
+
* counts for each attribute key that was specified in the
|
|
7933
|
+
* <code>Facets</code> input parameter.</p>
|
|
7934
|
+
*/
|
|
7935
|
+
FacetResults?: FacetResult[];
|
|
7936
|
+
/**
|
|
7937
|
+
* <p>The total number of items found by the search; however, you can only
|
|
7938
|
+
* retrieve up to 100 items. For example, if the search found 192 items,
|
|
7939
|
+
* you can only retrieve the first 100 of the items.</p>
|
|
7940
|
+
*/
|
|
7941
|
+
TotalNumberOfResults?: number;
|
|
7942
|
+
/**
|
|
7943
|
+
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
7944
|
+
* <p>Amazon Kendra currently only supports one type of warning, which is a warning
|
|
7945
|
+
* on invalid syntax used in the query. For examples of invalid query syntax,
|
|
7946
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
|
|
7947
|
+
* with advanced query syntax</a>.</p>
|
|
7948
|
+
*/
|
|
7949
|
+
Warnings?: Warning[];
|
|
7950
|
+
/**
|
|
7951
|
+
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
7952
|
+
*/
|
|
7953
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
7954
|
+
}
|
|
7955
|
+
export declare namespace QueryResult {
|
|
7956
|
+
/**
|
|
7957
|
+
* @internal
|
|
7958
|
+
*/
|
|
7959
|
+
const filterSensitiveLog: (obj: QueryResult) => any;
|
|
7960
|
+
}
|
|
7774
7961
|
export interface QueryRequest {
|
|
7775
7962
|
/**
|
|
7776
7963
|
* <p>The unique identifier of the index to search. The identifier is
|
|
@@ -7794,14 +7981,13 @@ export interface QueryRequest {
|
|
|
7794
7981
|
AttributeFilter?: AttributeFilter;
|
|
7795
7982
|
/**
|
|
7796
7983
|
* <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>
|
|
7984
|
+
* each attribute key specified. This helps your users narrow their search.</p>
|
|
7799
7985
|
*/
|
|
7800
7986
|
Facets?: Facet[];
|
|
7801
7987
|
/**
|
|
7802
|
-
* <p>An array of document attributes to include in the response.
|
|
7803
|
-
*
|
|
7804
|
-
* document attributes are included in the response
|
|
7988
|
+
* <p>An array of document attributes to include in the response.
|
|
7989
|
+
* You can limit the response to include certain document attributes.
|
|
7990
|
+
* By default all document attributes are included in the response.</p>
|
|
7805
7991
|
*/
|
|
7806
7992
|
RequestedDocumentAttributes?: string[];
|
|
7807
7993
|
/**
|
|
@@ -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";
|