@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
|
@@ -10,21 +10,21 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Maps users to their groups so that you only need to provide
|
|
12
12
|
* the user ID when you issue the query.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>You can also map sub groups to groups.
|
|
14
14
|
* For example, the group "Company Intellectual Property Teams" includes
|
|
15
15
|
* sub groups "Research" and "Engineering". These sub groups include their
|
|
16
16
|
* own list of users or people who work in these teams. Only users who work
|
|
17
17
|
* in research and engineering, and therefore belong in the intellectual
|
|
18
18
|
* property group, can see top-secret company documents in their search
|
|
19
19
|
* results.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>This is useful for user context filtering, where search results are
|
|
21
21
|
* filtered based on the user or their group access to documents. For more
|
|
22
22
|
* information, see
|
|
23
23
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
|
|
24
24
|
* on user context</a>.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>If more than five <code>PUT</code> actions for a group are currently
|
|
26
26
|
* processing, a validation exception is thrown.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>
|
|
28
28
|
* <code>PutPrincipalMapping</code> is currently not supported in the
|
|
29
29
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
30
30
|
* @example
|
|
@@ -8,14 +8,13 @@ export interface QueryCommandInput extends QueryRequest {
|
|
|
8
8
|
export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Searches an active index. Use this API to search your documents
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* <p>It also enables you to provide user context that Amazon Kendra uses
|
|
15
|
-
*
|
|
16
|
-
* <p>Amazon Kendra searches your index for text content and question and
|
|
17
|
-
*
|
|
18
|
-
* results.</p>
|
|
11
|
+
* <p>Searches an active index. Use this API to search your documents using query. The
|
|
12
|
+
* <code>Query</code> API enables to do faceted search and to filter results based on
|
|
13
|
+
* document attributes.</p>
|
|
14
|
+
* <p>It also enables you to provide user context that Amazon Kendra uses to enforce
|
|
15
|
+
* document access control in the search results.</p>
|
|
16
|
+
* <p>Amazon Kendra searches your index for text content and question and answer (FAQ)
|
|
17
|
+
* content. By default the response contains three types of results.</p>
|
|
19
18
|
* <ul>
|
|
20
19
|
* <li>
|
|
21
20
|
* <p>Relevant passages</p>
|
|
@@ -27,8 +26,8 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
|
|
|
27
26
|
* <p>Relevant documents</p>
|
|
28
27
|
* </li>
|
|
29
28
|
* </ul>
|
|
30
|
-
* <p>You can specify that the query return only one type of result using
|
|
31
|
-
*
|
|
29
|
+
* <p>You can specify that the query return only one type of result using the
|
|
30
|
+
* <code>QueryResultTypeConfig</code> parameter.</p>
|
|
32
31
|
* <p>Each query returns the 100 most relevant results. </p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Enables you to provide feedback to Amazon Kendra to improve the
|
|
12
12
|
* performance of your index.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* <code>SubmitFeedback</code> is currently not supported in the
|
|
15
15
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
16
16
|
* @example
|
|
@@ -12,7 +12,7 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
|
|
|
12
12
|
* includes user and group access information for your documents. This is useful
|
|
13
13
|
* for user context filtering, where search results are filtered based on the user
|
|
14
14
|
* or their group access to documents.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You can update an access control configuration you created without indexing all
|
|
16
16
|
* of your documents again. For example, your index contains top-secret company
|
|
17
17
|
* documents that only certain employees or users should access. You created an 'allow'
|
|
18
18
|
* access control configuration for one user who recently joined the 'top-secret' team,
|
|
@@ -20,7 +20,7 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
|
|
|
20
20
|
* suddenly returns to their previous team and should no longer have access to top secret
|
|
21
21
|
* documents. You can update the access control configuration to re-configure access
|
|
22
22
|
* control for your documents as circumstances change.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
|
|
24
24
|
* apply the updated access control configuration, with the
|
|
25
25
|
* <code>AccessControlConfigurationId</code> included in the
|
|
26
26
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
@@ -9,14 +9,14 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates a block list used for query suggestions for an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Updates to a block list might not take effect right away. Amazon Kendra
|
|
13
13
|
* needs to refresh the entire suggestions list to apply any updates to the
|
|
14
14
|
* block list. Other changes not related to the block list apply immediately.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If a block list is updating, then you need to wait for the first update to
|
|
16
16
|
* finish before submitting another update.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>Amazon Kendra supports partial updates, so you only need to provide the fields
|
|
18
18
|
* you want to update.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* <code>UpdateQuerySuggestionsBlockList</code> is currently not supported in the
|
|
21
21
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
22
22
|
* @example
|
|
@@ -2,22 +2,22 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
|
|
5
|
-
import { UpdateQuerySuggestionsConfigRequest } from "../models/
|
|
5
|
+
import { UpdateQuerySuggestionsConfigRequest } from "../models/models_1";
|
|
6
6
|
export interface UpdateQuerySuggestionsConfigCommandInput extends UpdateQuerySuggestionsConfigRequest {
|
|
7
7
|
}
|
|
8
8
|
export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the settings of query suggestions for an index.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Amazon Kendra supports partial updates, so you only need to provide
|
|
13
13
|
* the fields you want to update.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If an update is currently processing (i.e. 'happening'), you
|
|
15
15
|
* need to wait for the update to finish before making another update.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>Updates to query suggestions settings might not take effect right away.
|
|
17
17
|
* The time for your updated settings to take effect depends on the updates
|
|
18
18
|
* made and the number of search queries in your index.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* <p>You can still enable/disable query suggestions at any time.</p>
|
|
20
|
+
* <p>
|
|
21
21
|
* <code>UpdateQuerySuggestionsConfig</code> is currently not supported in the
|
|
22
22
|
* Amazon Web Services GovCloud (US-West) region.</p>
|
|
23
23
|
* @example
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
|
|
5
|
-
import { UpdateThesaurusRequest } from "../models/
|
|
5
|
+
import { UpdateThesaurusRequest } from "../models/models_1";
|
|
6
6
|
export interface UpdateThesaurusCommandInput extends UpdateThesaurusRequest {
|
|
7
7
|
}
|
|
8
8
|
export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|