@aws-sdk/client-kendra 3.216.0 → 3.218.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/dist-cjs/commands/UpdateQuerySuggestionsConfigCommand.js +2 -2
- package/dist-cjs/commands/UpdateThesaurusCommand.js +2 -2
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +22 -21
- package/dist-cjs/models/models_1.js +17 -1
- package/dist-cjs/protocols/Aws_json1_1.js +43 -0
- package/dist-es/commands/UpdateQuerySuggestionsConfigCommand.js +1 -1
- package/dist-es/commands/UpdateThesaurusCommand.js +1 -1
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +14 -12
- package/dist-es/models/models_1.js +12 -0
- package/dist-es/protocols/Aws_json1_1.js +43 -0
- package/dist-types/Kendra.d.ts +64 -68
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +2 -2
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/CreateFaqCommand.d.ts +2 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +9 -11
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +5 -5
- package/dist-types/commands/DeleteIndexCommand.d.ts +3 -4
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +3 -3
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -2
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +2 -2
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +1 -1
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +2 -2
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +4 -4
- package/dist-types/commands/QueryCommand.d.ts +9 -10
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +4 -4
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +6 -6
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +708 -827
- package/dist-types/models/models_1.d.ts +210 -56
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +22 -37
- package/dist-types/ts3.4/models/models_1.d.ts +39 -2
- package/package.json +3 -3
package/dist-types/Kendra.d.ts
CHANGED
|
@@ -98,12 +98,12 @@ export declare class Kendra extends KendraClient {
|
|
|
98
98
|
* <p>Returns the indexing status for one or more documents submitted
|
|
99
99
|
* with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
|
|
100
100
|
* BatchPutDocument</a> API.</p>
|
|
101
|
-
*
|
|
101
|
+
* <p>When you use the <code>BatchPutDocument</code> API,
|
|
102
102
|
* documents are indexed asynchronously. You can use the
|
|
103
103
|
* <code>BatchGetDocumentStatus</code> API to get the current
|
|
104
104
|
* status of a list of documents so that you can determine if they have
|
|
105
105
|
* been successfully indexed.</p>
|
|
106
|
-
*
|
|
106
|
+
* <p>You can also use the <code>BatchGetDocumentStatus</code> API
|
|
107
107
|
* to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
|
|
108
108
|
* BatchDeleteDocument</a> API. When a document is
|
|
109
109
|
* deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
|
|
@@ -131,13 +131,13 @@ export declare class Kendra extends KendraClient {
|
|
|
131
131
|
batchPutDocument(args: BatchPutDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void): void;
|
|
132
132
|
/**
|
|
133
133
|
* <p>Clears existing query suggestions from an index.</p>
|
|
134
|
-
*
|
|
134
|
+
* <p>This deletes existing suggestions only, not the queries
|
|
135
135
|
* in the query log. After you clear suggestions, Amazon Kendra learns
|
|
136
136
|
* new suggestions based on new queries added to the query log
|
|
137
137
|
* from the time you cleared suggestions. If you do not see any
|
|
138
138
|
* new suggestions, then please allow Amazon Kendra to collect
|
|
139
139
|
* enough queries to learn new suggestions.</p>
|
|
140
|
-
*
|
|
140
|
+
* <p>
|
|
141
141
|
* <code>ClearQuerySuggestions</code> is currently not supported in the
|
|
142
142
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
143
143
|
*/
|
|
@@ -149,7 +149,7 @@ export declare class Kendra extends KendraClient {
|
|
|
149
149
|
* user and group access information for your documents. This is useful
|
|
150
150
|
* for user context filtering, where search results are filtered based
|
|
151
151
|
* on the user or their group access to documents.</p>
|
|
152
|
-
*
|
|
152
|
+
* <p>You can use this to re-configure your existing document level access control without
|
|
153
153
|
* indexing all of your documents again. For example, your index contains top-secret
|
|
154
154
|
* company documents that only certain employees or users should access. One of these users
|
|
155
155
|
* leaves the company or switches to a team that should be blocked from accessing
|
|
@@ -159,7 +159,7 @@ export declare class Kendra extends KendraClient {
|
|
|
159
159
|
* access. You can later update the access control configuration to allow access if the
|
|
160
160
|
* user returns to the company and re-joins the 'top-secret' team. You can re-configure
|
|
161
161
|
* access control for your documents as circumstances change.</p>
|
|
162
|
-
*
|
|
162
|
+
* <p>To apply your access control configuration to certain documents, you call
|
|
163
163
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
|
|
164
164
|
* API with the <code>AccessControlConfigurationId</code> included in the
|
|
165
165
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
@@ -201,8 +201,8 @@ export declare class Kendra extends KendraClient {
|
|
|
201
201
|
createExperience(args: CreateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperienceCommandOutput) => void): void;
|
|
202
202
|
/**
|
|
203
203
|
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
|
|
204
|
-
*
|
|
205
|
-
*
|
|
204
|
+
* <p>Adding FAQs to an index is an asynchronous operation.</p>
|
|
205
|
+
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
|
|
206
206
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
|
|
207
207
|
* FAQ file</a>.</p>
|
|
208
208
|
*/
|
|
@@ -210,36 +210,34 @@ export declare class Kendra extends KendraClient {
|
|
|
210
210
|
createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
211
211
|
createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
212
212
|
/**
|
|
213
|
-
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous
|
|
214
|
-
*
|
|
215
|
-
* <code>Status</code> field
|
|
216
|
-
*
|
|
217
|
-
* <code>ACTIVE</code> when the index is ready to use.</p>
|
|
213
|
+
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
|
|
214
|
+
* if index creation has completed, check the <code>Status</code> field returned from a call to
|
|
215
|
+
* <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
|
|
216
|
+
* the index is ready to use.</p>
|
|
218
217
|
* <p>Once the index is active you can index your documents using the
|
|
219
|
-
* <code>BatchPutDocument</code> API or using one of the supported
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
* source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
|
|
218
|
+
* <code>BatchPutDocument</code> API or using one of the supported data sources.</p>
|
|
219
|
+
* <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python
|
|
220
|
+
* SDK</a>. For an example of creating an index and data source using the Java SDK, see
|
|
221
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
|
|
222
|
+
* SDK</a>.</p>
|
|
225
223
|
*/
|
|
226
224
|
createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
|
|
227
225
|
createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
228
226
|
createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
229
227
|
/**
|
|
230
228
|
* <p>Creates a block list to exlcude certain queries from suggestions.</p>
|
|
231
|
-
*
|
|
229
|
+
* <p>Any query that contains words or phrases specified in the block
|
|
232
230
|
* list is blocked or filtered out from being shown as a suggestion.</p>
|
|
233
|
-
*
|
|
231
|
+
* <p>You need to provide the file location of your block list text file
|
|
234
232
|
* in your S3 bucket. In your text file, enter each block word or phrase
|
|
235
233
|
* on a separate line.</p>
|
|
236
|
-
*
|
|
234
|
+
* <p>For information on the current quota limits for block lists, see
|
|
237
235
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
238
236
|
* for Amazon Kendra</a>.</p>
|
|
239
|
-
*
|
|
237
|
+
* <p>
|
|
240
238
|
* <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
|
|
241
239
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
242
|
-
*
|
|
240
|
+
* <p>For an example of creating a block list for query suggestions using the
|
|
243
241
|
* Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
|
|
244
242
|
* suggestions block list</a>.</p>
|
|
245
243
|
*/
|
|
@@ -289,10 +287,9 @@ export declare class Kendra extends KendraClient {
|
|
|
289
287
|
deleteFaq(args: DeleteFaqCommandInput, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void;
|
|
290
288
|
deleteFaq(args: DeleteFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void;
|
|
291
289
|
/**
|
|
292
|
-
* <p>Deletes an existing Amazon Kendra index. An exception is not thrown if
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
* <code>DescribeIndex</code> API is set to
|
|
290
|
+
* <p>Deletes an existing Amazon Kendra index. An exception is not thrown if the index is
|
|
291
|
+
* already being deleted. While the index is being deleted, the <code>Status</code> field
|
|
292
|
+
* returned by a call to the <code>DescribeIndex</code> API is set to
|
|
296
293
|
* <code>DELETING</code>.</p>
|
|
297
294
|
*/
|
|
298
295
|
deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexCommandOutput>;
|
|
@@ -301,17 +298,17 @@ export declare class Kendra extends KendraClient {
|
|
|
301
298
|
/**
|
|
302
299
|
* <p>Deletes a group so that all users and sub groups that belong to the group can
|
|
303
300
|
* no longer access documents only available to that group.</p>
|
|
304
|
-
*
|
|
301
|
+
* <p>For example, after deleting the group "Summer Interns", all interns who
|
|
305
302
|
* belonged to that group no longer see intern-only documents in their search
|
|
306
303
|
* results.</p>
|
|
307
|
-
*
|
|
304
|
+
* <p>If you want to delete or replace users or sub groups of a group, you need to
|
|
308
305
|
* use the <code>PutPrincipalMapping</code> operation. For example, if a user in
|
|
309
306
|
* the group "Engineering" leaves the engineering team and another user takes
|
|
310
307
|
* their place, you provide an updated list of users or sub groups that belong
|
|
311
308
|
* to the "Engineering" group when calling <code>PutPrincipalMapping</code>. You
|
|
312
309
|
* can update your internal list of users or sub groups and input this list
|
|
313
310
|
* when calling <code>PutPrincipalMapping</code>.</p>
|
|
314
|
-
*
|
|
311
|
+
* <p>
|
|
315
312
|
* <code>DeletePrincipalMapping</code> is currently not supported in the
|
|
316
313
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
317
314
|
*/
|
|
@@ -320,10 +317,10 @@ export declare class Kendra extends KendraClient {
|
|
|
320
317
|
deletePrincipalMapping(args: DeletePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void): void;
|
|
321
318
|
/**
|
|
322
319
|
* <p>Deletes a block list used for query suggestions for an index.</p>
|
|
323
|
-
*
|
|
320
|
+
* <p>A deleted block list might not take effect right away. Amazon Kendra
|
|
324
321
|
* needs to refresh the entire suggestions list to add back the
|
|
325
322
|
* queries that were previously blocked.</p>
|
|
326
|
-
*
|
|
323
|
+
* <p>
|
|
327
324
|
* <code>DeleteQuerySuggestionsBlockList</code> is currently not supported in the
|
|
328
325
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
329
326
|
*/
|
|
@@ -380,7 +377,7 @@ export declare class Kendra extends KendraClient {
|
|
|
380
377
|
* when actions were received by Amazon Kendra, the latest action that should process
|
|
381
378
|
* and apply after other actions, and useful error messages if an action could
|
|
382
379
|
* not be processed.</p>
|
|
383
|
-
*
|
|
380
|
+
* <p>
|
|
384
381
|
* <code>DescribePrincipalMapping</code> is currently not supported in the
|
|
385
382
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
386
383
|
*/
|
|
@@ -390,9 +387,9 @@ export declare class Kendra extends KendraClient {
|
|
|
390
387
|
/**
|
|
391
388
|
* <p>Gets information about a block list used for query suggestions for
|
|
392
389
|
* an index.</p>
|
|
393
|
-
*
|
|
390
|
+
* <p>This is used to check the current settings that are applied to a
|
|
394
391
|
* block list.</p>
|
|
395
|
-
*
|
|
392
|
+
* <p>
|
|
396
393
|
* <code>DescribeQuerySuggestionsBlockList</code> is currently not supported in the
|
|
397
394
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
398
395
|
*/
|
|
@@ -401,9 +398,9 @@ export declare class Kendra extends KendraClient {
|
|
|
401
398
|
describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
402
399
|
/**
|
|
403
400
|
* <p>Gets information on the settings of query suggestions for an index.</p>
|
|
404
|
-
*
|
|
401
|
+
* <p>This is used to check the current settings applied
|
|
405
402
|
* to query suggestions.</p>
|
|
406
|
-
*
|
|
403
|
+
* <p>
|
|
407
404
|
* <code>DescribeQuerySuggestionsConfig</code> is currently not supported in the
|
|
408
405
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
409
406
|
*/
|
|
@@ -438,7 +435,7 @@ export declare class Kendra extends KendraClient {
|
|
|
438
435
|
disassociatePersonasFromEntities(args: DisassociatePersonasFromEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void): void;
|
|
439
436
|
/**
|
|
440
437
|
* <p>Fetches the queries that are suggested to your users.</p>
|
|
441
|
-
*
|
|
438
|
+
* <p>
|
|
442
439
|
* <code>GetQuerySuggestions</code> is currently not supported in the
|
|
443
440
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
444
441
|
*/
|
|
@@ -509,7 +506,7 @@ export declare class Kendra extends KendraClient {
|
|
|
509
506
|
/**
|
|
510
507
|
* <p>Provides a list of groups that are mapped to users before a
|
|
511
508
|
* given ordering or timestamp identifier.</p>
|
|
512
|
-
*
|
|
509
|
+
* <p>
|
|
513
510
|
* <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the
|
|
514
511
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
515
512
|
*/
|
|
@@ -524,10 +521,10 @@ export declare class Kendra extends KendraClient {
|
|
|
524
521
|
listIndices(args: ListIndicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndicesCommandOutput) => void): void;
|
|
525
522
|
/**
|
|
526
523
|
* <p>Lists the block lists used for query suggestions for an index.</p>
|
|
527
|
-
*
|
|
524
|
+
* <p>For information on the current quota limits for block lists, see
|
|
528
525
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
529
526
|
* for Amazon Kendra</a>.</p>
|
|
530
|
-
*
|
|
527
|
+
* <p>
|
|
531
528
|
* <code>ListQuerySuggestionsBlockLists</code> is currently not supported in the
|
|
532
529
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
533
530
|
*/
|
|
@@ -550,21 +547,21 @@ export declare class Kendra extends KendraClient {
|
|
|
550
547
|
/**
|
|
551
548
|
* <p>Maps users to their groups so that you only need to provide
|
|
552
549
|
* the user ID when you issue the query.</p>
|
|
553
|
-
*
|
|
550
|
+
* <p>You can also map sub groups to groups.
|
|
554
551
|
* For example, the group "Company Intellectual Property Teams" includes
|
|
555
552
|
* sub groups "Research" and "Engineering". These sub groups include their
|
|
556
553
|
* own list of users or people who work in these teams. Only users who work
|
|
557
554
|
* in research and engineering, and therefore belong in the intellectual
|
|
558
555
|
* property group, can see top-secret company documents in their search
|
|
559
556
|
* results.</p>
|
|
560
|
-
*
|
|
557
|
+
* <p>This is useful for user context filtering, where search results are
|
|
561
558
|
* filtered based on the user or their group access to documents. For more
|
|
562
559
|
* information, see
|
|
563
560
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
|
|
564
561
|
* on user context</a>.</p>
|
|
565
|
-
*
|
|
562
|
+
* <p>If more than five <code>PUT</code> actions for a group are currently
|
|
566
563
|
* processing, a validation exception is thrown.</p>
|
|
567
|
-
*
|
|
564
|
+
* <p>
|
|
568
565
|
* <code>PutPrincipalMapping</code> is currently not supported in the
|
|
569
566
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
570
567
|
*/
|
|
@@ -572,14 +569,13 @@ export declare class Kendra extends KendraClient {
|
|
|
572
569
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
|
|
573
570
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
|
|
574
571
|
/**
|
|
575
|
-
* <p>Searches an active index. Use this API to search your documents
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
* <p>It also enables you to provide user context that Amazon Kendra uses
|
|
579
|
-
*
|
|
580
|
-
* <p>Amazon Kendra searches your index for text content and question and
|
|
581
|
-
*
|
|
582
|
-
* results.</p>
|
|
572
|
+
* <p>Searches an active index. Use this API to search your documents using query. The
|
|
573
|
+
* <code>Query</code> API enables to do faceted search and to filter results based on
|
|
574
|
+
* document attributes.</p>
|
|
575
|
+
* <p>It also enables you to provide user context that Amazon Kendra uses to enforce
|
|
576
|
+
* document access control in the search results.</p>
|
|
577
|
+
* <p>Amazon Kendra searches your index for text content and question and answer (FAQ)
|
|
578
|
+
* content. By default the response contains three types of results.</p>
|
|
583
579
|
* <ul>
|
|
584
580
|
* <li>
|
|
585
581
|
* <p>Relevant passages</p>
|
|
@@ -591,8 +587,8 @@ export declare class Kendra extends KendraClient {
|
|
|
591
587
|
* <p>Relevant documents</p>
|
|
592
588
|
* </li>
|
|
593
589
|
* </ul>
|
|
594
|
-
* <p>You can specify that the query return only one type of result using
|
|
595
|
-
*
|
|
590
|
+
* <p>You can specify that the query return only one type of result using the
|
|
591
|
+
* <code>QueryResultTypeConfig</code> parameter.</p>
|
|
596
592
|
* <p>Each query returns the 100 most relevant results. </p>
|
|
597
593
|
*/
|
|
598
594
|
query(args: QueryCommandInput, options?: __HttpHandlerOptions): Promise<QueryCommandOutput>;
|
|
@@ -616,7 +612,7 @@ export declare class Kendra extends KendraClient {
|
|
|
616
612
|
/**
|
|
617
613
|
* <p>Enables you to provide feedback to Amazon Kendra to improve the
|
|
618
614
|
* performance of your index.</p>
|
|
619
|
-
*
|
|
615
|
+
* <p>
|
|
620
616
|
* <code>SubmitFeedback</code> is currently not supported in the
|
|
621
617
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
622
618
|
*/
|
|
@@ -642,7 +638,7 @@ export declare class Kendra extends KendraClient {
|
|
|
642
638
|
* includes user and group access information for your documents. This is useful
|
|
643
639
|
* for user context filtering, where search results are filtered based on the user
|
|
644
640
|
* or their group access to documents.</p>
|
|
645
|
-
*
|
|
641
|
+
* <p>You can update an access control configuration you created without indexing all
|
|
646
642
|
* of your documents again. For example, your index contains top-secret company
|
|
647
643
|
* documents that only certain employees or users should access. You created an 'allow'
|
|
648
644
|
* access control configuration for one user who recently joined the 'top-secret' team,
|
|
@@ -650,7 +646,7 @@ export declare class Kendra extends KendraClient {
|
|
|
650
646
|
* suddenly returns to their previous team and should no longer have access to top secret
|
|
651
647
|
* documents. You can update the access control configuration to re-configure access
|
|
652
648
|
* control for your documents as circumstances change.</p>
|
|
653
|
-
*
|
|
649
|
+
* <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
|
|
654
650
|
* apply the updated access control configuration, with the
|
|
655
651
|
* <code>AccessControlConfigurationId</code> included in the
|
|
656
652
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
@@ -684,14 +680,14 @@ export declare class Kendra extends KendraClient {
|
|
|
684
680
|
updateIndex(args: UpdateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void;
|
|
685
681
|
/**
|
|
686
682
|
* <p>Updates a block list used for query suggestions for an index.</p>
|
|
687
|
-
*
|
|
683
|
+
* <p>Updates to a block list might not take effect right away. Amazon Kendra
|
|
688
684
|
* needs to refresh the entire suggestions list to apply any updates to the
|
|
689
685
|
* block list. Other changes not related to the block list apply immediately.</p>
|
|
690
|
-
*
|
|
686
|
+
* <p>If a block list is updating, then you need to wait for the first update to
|
|
691
687
|
* finish before submitting another update.</p>
|
|
692
|
-
*
|
|
688
|
+
* <p>Amazon Kendra supports partial updates, so you only need to provide the fields
|
|
693
689
|
* you want to update.</p>
|
|
694
|
-
*
|
|
690
|
+
* <p>
|
|
695
691
|
* <code>UpdateQuerySuggestionsBlockList</code> is currently not supported in the
|
|
696
692
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
697
693
|
*/
|
|
@@ -700,15 +696,15 @@ export declare class Kendra extends KendraClient {
|
|
|
700
696
|
updateQuerySuggestionsBlockList(args: UpdateQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
701
697
|
/**
|
|
702
698
|
* <p>Updates the settings of query suggestions for an index.</p>
|
|
703
|
-
*
|
|
699
|
+
* <p>Amazon Kendra supports partial updates, so you only need to provide
|
|
704
700
|
* the fields you want to update.</p>
|
|
705
|
-
*
|
|
701
|
+
* <p>If an update is currently processing (i.e. 'happening'), you
|
|
706
702
|
* need to wait for the update to finish before making another update.</p>
|
|
707
|
-
*
|
|
703
|
+
* <p>Updates to query suggestions settings might not take effect right away.
|
|
708
704
|
* The time for your updated settings to take effect depends on the updates
|
|
709
705
|
* made and the number of search queries in your index.</p>
|
|
710
|
-
*
|
|
711
|
-
*
|
|
706
|
+
* <p>You can still enable/disable query suggestions at any time.</p>
|
|
707
|
+
* <p>
|
|
712
708
|
* <code>UpdateQuerySuggestionsConfig</code> is currently not supported in the
|
|
713
709
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
714
710
|
*/
|
|
@@ -11,12 +11,12 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
|
|
|
11
11
|
* <p>Returns the indexing status for one or more documents submitted
|
|
12
12
|
* with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
|
|
13
13
|
* BatchPutDocument</a> API.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>When you use the <code>BatchPutDocument</code> API,
|
|
15
15
|
* documents are indexed asynchronously. You can use the
|
|
16
16
|
* <code>BatchGetDocumentStatus</code> API to get the current
|
|
17
17
|
* status of a list of documents so that you can determine if they have
|
|
18
18
|
* been successfully indexed.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>You can also use the <code>BatchGetDocumentStatus</code> API
|
|
20
20
|
* to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
|
|
21
21
|
* BatchDeleteDocument</a> API. When a document is
|
|
22
22
|
* deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
|
|
@@ -9,13 +9,13 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Clears existing query suggestions from an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>This deletes existing suggestions only, not the queries
|
|
13
13
|
* in the query log. After you clear suggestions, Amazon Kendra learns
|
|
14
14
|
* new suggestions based on new queries added to the query log
|
|
15
15
|
* from the time you cleared suggestions. If you do not see any
|
|
16
16
|
* new suggestions, then please allow Amazon Kendra to collect
|
|
17
17
|
* enough queries to learn new suggestions.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>
|
|
19
19
|
* <code>ClearQuerySuggestions</code> is currently not supported in the
|
|
20
20
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
21
21
|
* @example
|
|
@@ -12,7 +12,7 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
|
|
|
12
12
|
* user and group access information for your documents. This is useful
|
|
13
13
|
* for user context filtering, where search results are filtered based
|
|
14
14
|
* on the user or their group access to documents.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can use this to re-configure your existing document level access control without
|
|
16
16
|
* indexing all of your documents again. For example, your index contains top-secret
|
|
17
17
|
* company documents that only certain employees or users should access. One of these users
|
|
18
18
|
* leaves the company or switches to a team that should be blocked from accessing
|
|
@@ -22,7 +22,7 @@ export interface CreateAccessControlConfigurationCommandOutput extends CreateAcc
|
|
|
22
22
|
* access. You can later update the access control configuration to allow access if the
|
|
23
23
|
* user returns to the company and re-joins the 'top-secret' team. You can re-configure
|
|
24
24
|
* access control for your documents as circumstances change.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>To apply your access control configuration to certain documents, you call
|
|
26
26
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
|
|
27
27
|
* API with the <code>AccessControlConfigurationId</code> included in the
|
|
28
28
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
@@ -9,8 +9,8 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <p>Adding FAQs to an index is an asynchronous operation.</p>
|
|
13
|
+
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
|
|
14
14
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
|
|
15
15
|
* FAQ file</a>.</p>
|
|
16
16
|
* @example
|
|
@@ -8,18 +8,16 @@ export interface CreateIndexCommandInput extends CreateIndexRequest {
|
|
|
8
8
|
export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous
|
|
12
|
-
*
|
|
13
|
-
* <code>Status</code> field
|
|
14
|
-
*
|
|
15
|
-
* <code>ACTIVE</code> when the index is ready to use.</p>
|
|
11
|
+
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
|
|
12
|
+
* if index creation has completed, check the <code>Status</code> field returned from a call to
|
|
13
|
+
* <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
|
|
14
|
+
* the index is ready to use.</p>
|
|
16
15
|
* <p>Once the index is active you can index your documents using the
|
|
17
|
-
* <code>BatchPutDocument</code> API or using one of the supported
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
|
|
16
|
+
* <code>BatchPutDocument</code> API or using one of the supported data sources.</p>
|
|
17
|
+
* <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python
|
|
18
|
+
* SDK</a>. For an example of creating an index and data source using the Java SDK, see
|
|
19
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
|
|
20
|
+
* SDK</a>.</p>
|
|
23
21
|
* @example
|
|
24
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
23
|
* ```javascript
|
|
@@ -9,18 +9,18 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a block list to exlcude certain queries from suggestions.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Any query that contains words or phrases specified in the block
|
|
13
13
|
* list is blocked or filtered out from being shown as a suggestion.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>You need to provide the file location of your block list text file
|
|
15
15
|
* in your S3 bucket. In your text file, enter each block word or phrase
|
|
16
16
|
* on a separate line.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>For information on the current quota limits for block lists, see
|
|
18
18
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
19
19
|
* for Amazon Kendra</a>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>
|
|
21
21
|
* <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
|
|
22
22
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>For an example of creating a block list for query suggestions using the
|
|
24
24
|
* Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
|
|
25
25
|
* suggestions block list</a>.</p>
|
|
26
26
|
* @example
|
|
@@ -8,10 +8,9 @@ export interface DeleteIndexCommandInput extends DeleteIndexRequest {
|
|
|
8
8
|
export interface DeleteIndexCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Deletes an existing Amazon Kendra index. An exception is not thrown if
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* <code>DescribeIndex</code> API is set to
|
|
11
|
+
* <p>Deletes an existing Amazon Kendra index. An exception is not thrown if the index is
|
|
12
|
+
* already being deleted. While the index is being deleted, the <code>Status</code> field
|
|
13
|
+
* returned by a call to the <code>DescribeIndex</code> API is set to
|
|
15
14
|
* <code>DELETING</code>.</p>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,17 +10,17 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a group so that all users and sub groups that belong to the group can
|
|
12
12
|
* no longer access documents only available to that group.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For example, after deleting the group "Summer Interns", all interns who
|
|
14
14
|
* belonged to that group no longer see intern-only documents in their search
|
|
15
15
|
* results.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>If you want to delete or replace users or sub groups of a group, you need to
|
|
17
17
|
* use the <code>PutPrincipalMapping</code> operation. For example, if a user in
|
|
18
18
|
* the group "Engineering" leaves the engineering team and another user takes
|
|
19
19
|
* their place, you provide an updated list of users or sub groups that belong
|
|
20
20
|
* to the "Engineering" group when calling <code>PutPrincipalMapping</code>. You
|
|
21
21
|
* can update your internal list of users or sub groups and input this list
|
|
22
22
|
* when calling <code>PutPrincipalMapping</code>.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>
|
|
24
24
|
* <code>DeletePrincipalMapping</code> is currently not supported in the
|
|
25
25
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
26
26
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a block list used for query suggestions for an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>A deleted block list might not take effect right away. Amazon Kendra
|
|
13
13
|
* needs to refresh the entire suggestions list to add back the
|
|
14
14
|
* queries that were previously blocked.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>
|
|
16
16
|
* <code>DeleteQuerySuggestionsBlockList</code> is currently not supported in the
|
|
17
17
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
18
18
|
* @example
|
|
@@ -14,7 +14,7 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
|
|
|
14
14
|
* when actions were received by Amazon Kendra, the latest action that should process
|
|
15
15
|
* and apply after other actions, and useful error messages if an action could
|
|
16
16
|
* not be processed.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>
|
|
18
18
|
* <code>DescribePrincipalMapping</code> is currently not supported in the
|
|
19
19
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
20
20
|
* @example
|
|
@@ -10,9 +10,9 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput extends Describe
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information about a block list used for query suggestions for
|
|
12
12
|
* an index.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This is used to check the current settings that are applied to a
|
|
14
14
|
* block list.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>
|
|
16
16
|
* <code>DescribeQuerySuggestionsBlockList</code> is currently not supported in the
|
|
17
17
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
18
18
|
* @example
|
|
@@ -9,9 +9,9 @@ export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQue
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets information on the settings of query suggestions for an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>This is used to check the current settings applied
|
|
13
13
|
* to query suggestions.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>
|
|
15
15
|
* <code>DescribeQuerySuggestionsConfig</code> is currently not supported in the
|
|
16
16
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
17
17
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Fetches the queries that are suggested to your users.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>
|
|
13
13
|
* <code>GetQuerySuggestions</code> is currently not supported in the
|
|
14
14
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
15
15
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput extends ListGroupsOl
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of groups that are mapped to users before a
|
|
12
12
|
* given ordering or timestamp identifier.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the
|
|
15
15
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
16
16
|
* @example
|
|
@@ -9,10 +9,10 @@ export interface ListQuerySuggestionsBlockListsCommandOutput extends ListQuerySu
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists the block lists used for query suggestions for an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>For information on the current quota limits for block lists, see
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
14
14
|
* for Amazon Kendra</a>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>
|
|
16
16
|
* <code>ListQuerySuggestionsBlockLists</code> is currently not supported in the
|
|
17
17
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
18
18
|
* @example
|