@aws-sdk/client-kendra-ranking 3.247.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/LICENSE +201 -0
- package/README.md +207 -0
- package/dist-cjs/KendraRanking.js +142 -0
- package/dist-cjs/KendraRankingClient.js +40 -0
- package/dist-cjs/commands/CreateRescoreExecutionPlanCommand.js +45 -0
- package/dist-cjs/commands/DeleteRescoreExecutionPlanCommand.js +45 -0
- package/dist-cjs/commands/DescribeRescoreExecutionPlanCommand.js +45 -0
- package/dist-cjs/commands/ListRescoreExecutionPlansCommand.js +45 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +45 -0
- package/dist-cjs/commands/RescoreCommand.js +45 -0
- package/dist-cjs/commands/TagResourceCommand.js +45 -0
- package/dist-cjs/commands/UntagResourceCommand.js +45 -0
- package/dist-cjs/commands/UpdateRescoreExecutionPlanCommand.js +45 -0
- package/dist-cjs/commands/index.js +12 -0
- package/dist-cjs/endpoint/EndpointParameters.js +11 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/KendraRankingServiceException.js +11 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +208 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListRescoreExecutionPlansPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_json1_0.js +928 -0
- package/dist-cjs/runtimeConfig.browser.js +42 -0
- package/dist-cjs/runtimeConfig.js +51 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +18 -0
- package/dist-es/KendraRanking.js +138 -0
- package/dist-es/KendraRankingClient.js +36 -0
- package/dist-es/commands/CreateRescoreExecutionPlanCommand.js +41 -0
- package/dist-es/commands/DeleteRescoreExecutionPlanCommand.js +41 -0
- package/dist-es/commands/DescribeRescoreExecutionPlanCommand.js +41 -0
- package/dist-es/commands/ListRescoreExecutionPlansCommand.js +41 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +41 -0
- package/dist-es/commands/RescoreCommand.js +41 -0
- package/dist-es/commands/TagResourceCommand.js +41 -0
- package/dist-es/commands/UntagResourceCommand.js +41 -0
- package/dist-es/commands/UpdateRescoreExecutionPlanCommand.js +41 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/endpoint/EndpointParameters.js +7 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/KendraRankingServiceException.js +7 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +176 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListRescoreExecutionPlansPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_0.js +907 -0
- package/dist-es/runtimeConfig.browser.js +37 -0
- package/dist-es/runtimeConfig.js +46 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +14 -0
- package/dist-types/KendraRanking.d.ts +104 -0
- package/dist-types/KendraRankingClient.d.ts +152 -0
- package/dist-types/commands/CreateRescoreExecutionPlanCommand.d.ts +46 -0
- package/dist-types/commands/DeleteRescoreExecutionPlanCommand.d.ts +39 -0
- package/dist-types/commands/DescribeRescoreExecutionPlanCommand.d.ts +39 -0
- package/dist-types/commands/ListRescoreExecutionPlansCommand.d.ts +39 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/commands/RescoreCommand.d.ts +40 -0
- package/dist-types/commands/TagResourceCommand.d.ts +41 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +40 -0
- package/dist-types/commands/UpdateRescoreExecutionPlanCommand.d.ts +42 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +17 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/index.d.ts +6 -0
- package/dist-types/models/KendraRankingServiceException.d.ts +10 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +600 -0
- package/dist-types/pagination/Interfaces.d.ts +6 -0
- package/dist-types/pagination/ListRescoreExecutionPlansPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +29 -0
- package/dist-types/runtimeConfig.browser.d.ts +42 -0
- package/dist-types/runtimeConfig.d.ts +42 -0
- package/dist-types/runtimeConfig.native.d.ts +41 -0
- package/dist-types/runtimeConfig.shared.d.ts +16 -0
- package/dist-types/ts3.4/KendraRanking.d.ts +157 -0
- package/dist-types/ts3.4/KendraRankingClient.d.ts +166 -0
- package/dist-types/ts3.4/commands/CreateRescoreExecutionPlanCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteRescoreExecutionPlanCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeRescoreExecutionPlanCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListRescoreExecutionPlansCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RescoreCommand.d.ts +32 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/UpdateRescoreExecutionPlanCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +32 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/KendraRankingServiceException.d.ts +7 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +224 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -0
- package/dist-types/ts3.4/pagination/ListRescoreExecutionPlansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +113 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +80 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +16 -0
- package/package.json +105 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import packageInfo from "../package.json";
|
|
2
|
+
import { Sha256 } from "@aws-crypto/sha256-browser";
|
|
3
|
+
import { DEFAULT_USE_DUALSTACK_ENDPOINT, DEFAULT_USE_FIPS_ENDPOINT } from "@aws-sdk/config-resolver";
|
|
4
|
+
import { FetchHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/fetch-http-handler";
|
|
5
|
+
import { invalidProvider } from "@aws-sdk/invalid-dependency";
|
|
6
|
+
import { calculateBodyLength } from "@aws-sdk/util-body-length-browser";
|
|
7
|
+
import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@aws-sdk/util-retry";
|
|
8
|
+
import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
|
|
9
|
+
import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
|
|
10
|
+
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
|
|
11
|
+
import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
|
|
12
|
+
import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-browser";
|
|
13
|
+
export const getRuntimeConfig = (config) => {
|
|
14
|
+
const defaultsMode = resolveDefaultsModeConfig(config);
|
|
15
|
+
const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
|
|
16
|
+
const clientSharedValues = getSharedRuntimeConfig(config);
|
|
17
|
+
return {
|
|
18
|
+
...clientSharedValues,
|
|
19
|
+
...config,
|
|
20
|
+
runtime: "browser",
|
|
21
|
+
defaultsMode,
|
|
22
|
+
bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
|
|
23
|
+
credentialDefaultProvider: config?.credentialDefaultProvider ?? ((_) => () => Promise.reject(new Error("Credential is missing"))),
|
|
24
|
+
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
|
25
|
+
defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
|
|
26
|
+
maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
|
|
27
|
+
region: config?.region ?? invalidProvider("Region is missing"),
|
|
28
|
+
requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
|
|
29
|
+
retryMode: config?.retryMode ?? (async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE),
|
|
30
|
+
sha256: config?.sha256 ?? Sha256,
|
|
31
|
+
streamCollector: config?.streamCollector ?? streamCollector,
|
|
32
|
+
useDualstackEndpoint: config?.useDualstackEndpoint ?? (() => Promise.resolve(DEFAULT_USE_DUALSTACK_ENDPOINT)),
|
|
33
|
+
useFipsEndpoint: config?.useFipsEndpoint ?? (() => Promise.resolve(DEFAULT_USE_FIPS_ENDPOINT)),
|
|
34
|
+
utf8Decoder: config?.utf8Decoder ?? fromUtf8,
|
|
35
|
+
utf8Encoder: config?.utf8Encoder ?? toUtf8,
|
|
36
|
+
};
|
|
37
|
+
};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import packageInfo from "../package.json";
|
|
2
|
+
import { decorateDefaultCredentialProvider } from "@aws-sdk/client-sts";
|
|
3
|
+
import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@aws-sdk/config-resolver";
|
|
4
|
+
import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
|
|
5
|
+
import { Hash } from "@aws-sdk/hash-node";
|
|
6
|
+
import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@aws-sdk/middleware-retry";
|
|
7
|
+
import { loadConfig as loadNodeConfig } from "@aws-sdk/node-config-provider";
|
|
8
|
+
import { NodeHttpHandler as RequestHandler, streamCollector } from "@aws-sdk/node-http-handler";
|
|
9
|
+
import { calculateBodyLength } from "@aws-sdk/util-body-length-node";
|
|
10
|
+
import { DEFAULT_RETRY_MODE } from "@aws-sdk/util-retry";
|
|
11
|
+
import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
|
|
12
|
+
import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
|
|
13
|
+
import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
|
|
14
|
+
import { loadConfigsForDefaultMode } from "@aws-sdk/smithy-client";
|
|
15
|
+
import { resolveDefaultsModeConfig } from "@aws-sdk/util-defaults-mode-node";
|
|
16
|
+
import { emitWarningIfUnsupportedVersion } from "@aws-sdk/smithy-client";
|
|
17
|
+
export const getRuntimeConfig = (config) => {
|
|
18
|
+
emitWarningIfUnsupportedVersion(process.version);
|
|
19
|
+
const defaultsMode = resolveDefaultsModeConfig(config);
|
|
20
|
+
const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
|
|
21
|
+
const clientSharedValues = getSharedRuntimeConfig(config);
|
|
22
|
+
return {
|
|
23
|
+
...clientSharedValues,
|
|
24
|
+
...config,
|
|
25
|
+
runtime: "node",
|
|
26
|
+
defaultsMode,
|
|
27
|
+
bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
|
|
28
|
+
credentialDefaultProvider: config?.credentialDefaultProvider ?? decorateDefaultCredentialProvider(credentialDefaultProvider),
|
|
29
|
+
defaultUserAgentProvider: config?.defaultUserAgentProvider ??
|
|
30
|
+
defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
|
|
31
|
+
maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
|
|
32
|
+
region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
|
|
33
|
+
requestHandler: config?.requestHandler ?? new RequestHandler(defaultConfigProvider),
|
|
34
|
+
retryMode: config?.retryMode ??
|
|
35
|
+
loadNodeConfig({
|
|
36
|
+
...NODE_RETRY_MODE_CONFIG_OPTIONS,
|
|
37
|
+
default: async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE,
|
|
38
|
+
}),
|
|
39
|
+
sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
|
|
40
|
+
streamCollector: config?.streamCollector ?? streamCollector,
|
|
41
|
+
useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
|
|
42
|
+
useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
|
|
43
|
+
utf8Decoder: config?.utf8Decoder ?? fromUtf8,
|
|
44
|
+
utf8Encoder: config?.utf8Encoder ?? toUtf8,
|
|
45
|
+
};
|
|
46
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Sha256 } from "@aws-crypto/sha256-js";
|
|
2
|
+
import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
|
|
3
|
+
export const getRuntimeConfig = (config) => {
|
|
4
|
+
const browserDefaults = getBrowserRuntimeConfig(config);
|
|
5
|
+
return {
|
|
6
|
+
...browserDefaults,
|
|
7
|
+
...config,
|
|
8
|
+
runtime: "react-native",
|
|
9
|
+
sha256: config?.sha256 ?? Sha256,
|
|
10
|
+
};
|
|
11
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { NoOpLogger } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { parseUrl } from "@aws-sdk/url-parser";
|
|
3
|
+
import { fromBase64, toBase64 } from "@aws-sdk/util-base64";
|
|
4
|
+
import { defaultEndpointResolver } from "./endpoint/endpointResolver";
|
|
5
|
+
export const getRuntimeConfig = (config) => ({
|
|
6
|
+
apiVersion: "2022-10-19",
|
|
7
|
+
base64Decoder: config?.base64Decoder ?? fromBase64,
|
|
8
|
+
base64Encoder: config?.base64Encoder ?? toBase64,
|
|
9
|
+
disableHostPrefix: config?.disableHostPrefix ?? false,
|
|
10
|
+
endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
|
|
11
|
+
logger: config?.logger ?? new NoOpLogger(),
|
|
12
|
+
serviceId: config?.serviceId ?? "Kendra Ranking",
|
|
13
|
+
urlParser: config?.urlParser ?? parseUrl,
|
|
14
|
+
});
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
|
+
import { CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput } from "./commands/CreateRescoreExecutionPlanCommand";
|
|
3
|
+
import { DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput } from "./commands/DeleteRescoreExecutionPlanCommand";
|
|
4
|
+
import { DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput } from "./commands/DescribeRescoreExecutionPlanCommand";
|
|
5
|
+
import { ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput } from "./commands/ListRescoreExecutionPlansCommand";
|
|
6
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
7
|
+
import { RescoreCommandInput, RescoreCommandOutput } from "./commands/RescoreCommand";
|
|
8
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
9
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
10
|
+
import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput } from "./commands/UpdateRescoreExecutionPlanCommand";
|
|
11
|
+
import { KendraRankingClient } from "./KendraRankingClient";
|
|
12
|
+
/**
|
|
13
|
+
* <p>Amazon Kendra Intelligent Ranking uses Amazon Kendra
|
|
14
|
+
* semantic search capabilities to intelligently re-rank a search
|
|
15
|
+
* service's results.</p>
|
|
16
|
+
*/
|
|
17
|
+
export declare class KendraRanking extends KendraRankingClient {
|
|
18
|
+
/**
|
|
19
|
+
* <p>Creates a rescore execution plan. A rescore execution
|
|
20
|
+
* plan is an Amazon Kendra Intelligent Ranking resource
|
|
21
|
+
* used for provisioning the <code>Rescore</code> API. You set
|
|
22
|
+
* the number of capacity units that you require for
|
|
23
|
+
* Amazon Kendra Intelligent Ranking to rescore or re-rank
|
|
24
|
+
* a search service's results.</p>
|
|
25
|
+
* <p>For an example of using the
|
|
26
|
+
* <code>CreateRescoreExecutionPlan</code> API, including using
|
|
27
|
+
* the Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html">Semantically
|
|
28
|
+
* ranking a search service's results</a>.</p>
|
|
29
|
+
*/
|
|
30
|
+
createRescoreExecutionPlan(args: CreateRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions): Promise<CreateRescoreExecutionPlanCommandOutput>;
|
|
31
|
+
createRescoreExecutionPlan(args: CreateRescoreExecutionPlanCommandInput, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void): void;
|
|
32
|
+
createRescoreExecutionPlan(args: CreateRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRescoreExecutionPlanCommandOutput) => void): void;
|
|
33
|
+
/**
|
|
34
|
+
* <p>Deletes a rescore execution plan. A rescore execution
|
|
35
|
+
* plan is an Amazon Kendra Intelligent Ranking resource
|
|
36
|
+
* used for provisioning the <code>Rescore</code> API.</p>
|
|
37
|
+
*/
|
|
38
|
+
deleteRescoreExecutionPlan(args: DeleteRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRescoreExecutionPlanCommandOutput>;
|
|
39
|
+
deleteRescoreExecutionPlan(args: DeleteRescoreExecutionPlanCommandInput, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void): void;
|
|
40
|
+
deleteRescoreExecutionPlan(args: DeleteRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRescoreExecutionPlanCommandOutput) => void): void;
|
|
41
|
+
/**
|
|
42
|
+
* <p>Gets information about a rescore execution plan. A rescore
|
|
43
|
+
* execution plan is an Amazon Kendra Intelligent Ranking
|
|
44
|
+
* resource used for provisioning the <code>Rescore</code> API.</p>
|
|
45
|
+
*/
|
|
46
|
+
describeRescoreExecutionPlan(args: DescribeRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRescoreExecutionPlanCommandOutput>;
|
|
47
|
+
describeRescoreExecutionPlan(args: DescribeRescoreExecutionPlanCommandInput, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void): void;
|
|
48
|
+
describeRescoreExecutionPlan(args: DescribeRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRescoreExecutionPlanCommandOutput) => void): void;
|
|
49
|
+
/**
|
|
50
|
+
* <p>Lists your rescore execution plans. A rescore execution plan
|
|
51
|
+
* is an Amazon Kendra Intelligent Ranking resource used for
|
|
52
|
+
* provisioning the <code>Rescore</code> API.</p>
|
|
53
|
+
*/
|
|
54
|
+
listRescoreExecutionPlans(args: ListRescoreExecutionPlansCommandInput, options?: __HttpHandlerOptions): Promise<ListRescoreExecutionPlansCommandOutput>;
|
|
55
|
+
listRescoreExecutionPlans(args: ListRescoreExecutionPlansCommandInput, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void): void;
|
|
56
|
+
listRescoreExecutionPlans(args: ListRescoreExecutionPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRescoreExecutionPlansCommandOutput) => void): void;
|
|
57
|
+
/**
|
|
58
|
+
* <p>Gets a list of tags associated with a specified resource.
|
|
59
|
+
* A rescore execution plan is an example of a resource that
|
|
60
|
+
* can have tags associated with it.</p>
|
|
61
|
+
*/
|
|
62
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
63
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
64
|
+
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
65
|
+
/**
|
|
66
|
+
* <p>Rescores or re-ranks search results from a search service
|
|
67
|
+
* such as OpenSearch (self managed). You use the semantic search
|
|
68
|
+
* capabilities of Amazon Kendra Intelligent Ranking to
|
|
69
|
+
* improve the search service's results.</p>
|
|
70
|
+
*/
|
|
71
|
+
rescore(args: RescoreCommandInput, options?: __HttpHandlerOptions): Promise<RescoreCommandOutput>;
|
|
72
|
+
rescore(args: RescoreCommandInput, cb: (err: any, data?: RescoreCommandOutput) => void): void;
|
|
73
|
+
rescore(args: RescoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RescoreCommandOutput) => void): void;
|
|
74
|
+
/**
|
|
75
|
+
* <p>Adds a specified tag to a specified rescore execution
|
|
76
|
+
* plan. A rescore execution plan is an Amazon Kendra
|
|
77
|
+
* Intelligent Ranking resource used for provisioning the
|
|
78
|
+
* <code>Rescore</code> API. If the tag already exists,
|
|
79
|
+
* the existing value is replaced with the new value.</p>
|
|
80
|
+
*/
|
|
81
|
+
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
82
|
+
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
83
|
+
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
84
|
+
/**
|
|
85
|
+
* <p>Removes a tag from a rescore execution plan. A rescore
|
|
86
|
+
* execution plan is an Amazon Kendra Intelligent
|
|
87
|
+
* Ranking resource used for provisioning the
|
|
88
|
+
* <code>Rescore</code> operation.</p>
|
|
89
|
+
*/
|
|
90
|
+
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
91
|
+
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
92
|
+
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
93
|
+
/**
|
|
94
|
+
* <p>Updates a rescore execution plan. A rescore execution plan
|
|
95
|
+
* is an Amazon Kendra Intelligent Ranking resource used for
|
|
96
|
+
* provisioning the <code>Rescore</code> API. You can update the
|
|
97
|
+
* number of capacity units you require for Amazon Kendra
|
|
98
|
+
* Intelligent Ranking to rescore or re-rank a search service's
|
|
99
|
+
* results.</p>
|
|
100
|
+
*/
|
|
101
|
+
updateRescoreExecutionPlan(args: UpdateRescoreExecutionPlanCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRescoreExecutionPlanCommandOutput>;
|
|
102
|
+
updateRescoreExecutionPlan(args: UpdateRescoreExecutionPlanCommandInput, cb: (err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void): void;
|
|
103
|
+
updateRescoreExecutionPlan(args: UpdateRescoreExecutionPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRescoreExecutionPlanCommandOutput) => void): void;
|
|
104
|
+
}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
|
|
2
|
+
import { EndpointInputConfig, EndpointResolvedConfig } from "@aws-sdk/middleware-endpoint";
|
|
3
|
+
import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
|
|
4
|
+
import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
|
|
5
|
+
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
6
|
+
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
7
|
+
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
8
|
+
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
9
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
10
|
+
import { CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput } from "./commands/CreateRescoreExecutionPlanCommand";
|
|
11
|
+
import { DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput } from "./commands/DeleteRescoreExecutionPlanCommand";
|
|
12
|
+
import { DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput } from "./commands/DescribeRescoreExecutionPlanCommand";
|
|
13
|
+
import { ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput } from "./commands/ListRescoreExecutionPlansCommand";
|
|
14
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
15
|
+
import { RescoreCommandInput, RescoreCommandOutput } from "./commands/RescoreCommand";
|
|
16
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
17
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
18
|
+
import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput } from "./commands/UpdateRescoreExecutionPlanCommand";
|
|
19
|
+
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
20
|
+
export declare type ServiceInputTypes = CreateRescoreExecutionPlanCommandInput | DeleteRescoreExecutionPlanCommandInput | DescribeRescoreExecutionPlanCommandInput | ListRescoreExecutionPlansCommandInput | ListTagsForResourceCommandInput | RescoreCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateRescoreExecutionPlanCommandInput;
|
|
21
|
+
export declare type ServiceOutputTypes = CreateRescoreExecutionPlanCommandOutput | DeleteRescoreExecutionPlanCommandOutput | DescribeRescoreExecutionPlanCommandOutput | ListRescoreExecutionPlansCommandOutput | ListTagsForResourceCommandOutput | RescoreCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateRescoreExecutionPlanCommandOutput;
|
|
22
|
+
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
23
|
+
/**
|
|
24
|
+
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
25
|
+
*/
|
|
26
|
+
requestHandler?: __HttpHandler;
|
|
27
|
+
/**
|
|
28
|
+
* A constructor for a class implementing the {@link __Hash} interface
|
|
29
|
+
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
sha256?: __HashConstructor;
|
|
33
|
+
/**
|
|
34
|
+
* The function that will be used to convert strings into HTTP endpoints.
|
|
35
|
+
* @internal
|
|
36
|
+
*/
|
|
37
|
+
urlParser?: __UrlParser;
|
|
38
|
+
/**
|
|
39
|
+
* A function that can calculate the length of a request body.
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
42
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
43
|
+
/**
|
|
44
|
+
* A function that converts a stream into an array of bytes.
|
|
45
|
+
* @internal
|
|
46
|
+
*/
|
|
47
|
+
streamCollector?: __StreamCollector;
|
|
48
|
+
/**
|
|
49
|
+
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
50
|
+
* @internal
|
|
51
|
+
*/
|
|
52
|
+
base64Decoder?: __Decoder;
|
|
53
|
+
/**
|
|
54
|
+
* The function that will be used to convert binary data to a base64-encoded string.
|
|
55
|
+
* @internal
|
|
56
|
+
*/
|
|
57
|
+
base64Encoder?: __Encoder;
|
|
58
|
+
/**
|
|
59
|
+
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
62
|
+
utf8Decoder?: __Decoder;
|
|
63
|
+
/**
|
|
64
|
+
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
utf8Encoder?: __Encoder;
|
|
68
|
+
/**
|
|
69
|
+
* The runtime environment.
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
runtime?: string;
|
|
73
|
+
/**
|
|
74
|
+
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
75
|
+
* trait of an operation.
|
|
76
|
+
*/
|
|
77
|
+
disableHostPrefix?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
* Value for how many times a request will be made at most in case of retry.
|
|
80
|
+
*/
|
|
81
|
+
maxAttempts?: number | __Provider<number>;
|
|
82
|
+
/**
|
|
83
|
+
* Specifies which retry algorithm to use.
|
|
84
|
+
*/
|
|
85
|
+
retryMode?: string | __Provider<string>;
|
|
86
|
+
/**
|
|
87
|
+
* Optional logger for logging debug/info/warn/error.
|
|
88
|
+
*/
|
|
89
|
+
logger?: __Logger;
|
|
90
|
+
/**
|
|
91
|
+
* Enables IPv6/IPv4 dualstack endpoint.
|
|
92
|
+
*/
|
|
93
|
+
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
94
|
+
/**
|
|
95
|
+
* Enables FIPS compatible endpoints.
|
|
96
|
+
*/
|
|
97
|
+
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
98
|
+
/**
|
|
99
|
+
* Unique service identifier.
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
serviceId?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The AWS region to which this client will send requests
|
|
105
|
+
*/
|
|
106
|
+
region?: string | __Provider<string>;
|
|
107
|
+
/**
|
|
108
|
+
* Default credentials provider; Not available in browser runtime.
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
112
|
+
/**
|
|
113
|
+
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
117
|
+
/**
|
|
118
|
+
* The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
119
|
+
*/
|
|
120
|
+
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
121
|
+
}
|
|
122
|
+
declare type KendraRankingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
123
|
+
/**
|
|
124
|
+
* The configuration interface of KendraRankingClient class constructor that set the region, credentials and other options.
|
|
125
|
+
*/
|
|
126
|
+
export interface KendraRankingClientConfig extends KendraRankingClientConfigType {
|
|
127
|
+
}
|
|
128
|
+
declare type KendraRankingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
129
|
+
/**
|
|
130
|
+
* The resolved configuration interface of KendraRankingClient class. This is resolved and normalized from the {@link KendraRankingClientConfig | constructor configuration interface}.
|
|
131
|
+
*/
|
|
132
|
+
export interface KendraRankingClientResolvedConfig extends KendraRankingClientResolvedConfigType {
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* <p>Amazon Kendra Intelligent Ranking uses Amazon Kendra
|
|
136
|
+
* semantic search capabilities to intelligently re-rank a search
|
|
137
|
+
* service's results.</p>
|
|
138
|
+
*/
|
|
139
|
+
export declare class KendraRankingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KendraRankingClientResolvedConfig> {
|
|
140
|
+
/**
|
|
141
|
+
* The resolved configuration of KendraRankingClient class. This is resolved and normalized from the {@link KendraRankingClientConfig | constructor configuration interface}.
|
|
142
|
+
*/
|
|
143
|
+
readonly config: KendraRankingClientResolvedConfig;
|
|
144
|
+
constructor(configuration: KendraRankingClientConfig);
|
|
145
|
+
/**
|
|
146
|
+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
147
|
+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
148
|
+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
149
|
+
*/
|
|
150
|
+
destroy(): void;
|
|
151
|
+
}
|
|
152
|
+
export {};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { CreateRescoreExecutionPlanRequest, CreateRescoreExecutionPlanResponse } from "../models/models_0";
|
|
6
|
+
export interface CreateRescoreExecutionPlanCommandInput extends CreateRescoreExecutionPlanRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface CreateRescoreExecutionPlanCommandOutput extends CreateRescoreExecutionPlanResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Creates a rescore execution plan. A rescore execution
|
|
12
|
+
* plan is an Amazon Kendra Intelligent Ranking resource
|
|
13
|
+
* used for provisioning the <code>Rescore</code> API. You set
|
|
14
|
+
* the number of capacity units that you require for
|
|
15
|
+
* Amazon Kendra Intelligent Ranking to rescore or re-rank
|
|
16
|
+
* a search service's results.</p>
|
|
17
|
+
* <p>For an example of using the
|
|
18
|
+
* <code>CreateRescoreExecutionPlan</code> API, including using
|
|
19
|
+
* the Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-service-rerank.html">Semantically
|
|
20
|
+
* ranking a search service's results</a>.</p>
|
|
21
|
+
* @example
|
|
22
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
23
|
+
* ```javascript
|
|
24
|
+
* import { KendraRankingClient, CreateRescoreExecutionPlanCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
25
|
+
* // const { KendraRankingClient, CreateRescoreExecutionPlanCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
26
|
+
* const client = new KendraRankingClient(config);
|
|
27
|
+
* const command = new CreateRescoreExecutionPlanCommand(input);
|
|
28
|
+
* const response = await client.send(command);
|
|
29
|
+
* ```
|
|
30
|
+
*
|
|
31
|
+
* @see {@link CreateRescoreExecutionPlanCommandInput} for command's `input` shape.
|
|
32
|
+
* @see {@link CreateRescoreExecutionPlanCommandOutput} for command's `response` shape.
|
|
33
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class CreateRescoreExecutionPlanCommand extends $Command<CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
|
|
37
|
+
readonly input: CreateRescoreExecutionPlanCommandInput;
|
|
38
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
39
|
+
constructor(input: CreateRescoreExecutionPlanCommandInput);
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput>;
|
|
44
|
+
private serialize;
|
|
45
|
+
private deserialize;
|
|
46
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { DeleteRescoreExecutionPlanRequest } from "../models/models_0";
|
|
6
|
+
export interface DeleteRescoreExecutionPlanCommandInput extends DeleteRescoreExecutionPlanRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface DeleteRescoreExecutionPlanCommandOutput extends __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Deletes a rescore execution plan. A rescore execution
|
|
12
|
+
* plan is an Amazon Kendra Intelligent Ranking resource
|
|
13
|
+
* used for provisioning the <code>Rescore</code> API.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { KendraRankingClient, DeleteRescoreExecutionPlanCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
18
|
+
* // const { KendraRankingClient, DeleteRescoreExecutionPlanCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
19
|
+
* const client = new KendraRankingClient(config);
|
|
20
|
+
* const command = new DeleteRescoreExecutionPlanCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link DeleteRescoreExecutionPlanCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link DeleteRescoreExecutionPlanCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class DeleteRescoreExecutionPlanCommand extends $Command<DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
|
|
30
|
+
readonly input: DeleteRescoreExecutionPlanCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: DeleteRescoreExecutionPlanCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { DescribeRescoreExecutionPlanRequest, DescribeRescoreExecutionPlanResponse } from "../models/models_0";
|
|
6
|
+
export interface DescribeRescoreExecutionPlanCommandInput extends DescribeRescoreExecutionPlanRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface DescribeRescoreExecutionPlanCommandOutput extends DescribeRescoreExecutionPlanResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Gets information about a rescore execution plan. A rescore
|
|
12
|
+
* execution plan is an Amazon Kendra Intelligent Ranking
|
|
13
|
+
* resource used for provisioning the <code>Rescore</code> API.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { KendraRankingClient, DescribeRescoreExecutionPlanCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
18
|
+
* // const { KendraRankingClient, DescribeRescoreExecutionPlanCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
19
|
+
* const client = new KendraRankingClient(config);
|
|
20
|
+
* const command = new DescribeRescoreExecutionPlanCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link DescribeRescoreExecutionPlanCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link DescribeRescoreExecutionPlanCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class DescribeRescoreExecutionPlanCommand extends $Command<DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput, KendraRankingClientResolvedConfig> {
|
|
30
|
+
readonly input: DescribeRescoreExecutionPlanCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: DescribeRescoreExecutionPlanCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { ListRescoreExecutionPlansRequest, ListRescoreExecutionPlansResponse } from "../models/models_0";
|
|
6
|
+
export interface ListRescoreExecutionPlansCommandInput extends ListRescoreExecutionPlansRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface ListRescoreExecutionPlansCommandOutput extends ListRescoreExecutionPlansResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Lists your rescore execution plans. A rescore execution plan
|
|
12
|
+
* is an Amazon Kendra Intelligent Ranking resource used for
|
|
13
|
+
* provisioning the <code>Rescore</code> API.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { KendraRankingClient, ListRescoreExecutionPlansCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
18
|
+
* // const { KendraRankingClient, ListRescoreExecutionPlansCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
19
|
+
* const client = new KendraRankingClient(config);
|
|
20
|
+
* const command = new ListRescoreExecutionPlansCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link ListRescoreExecutionPlansCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link ListRescoreExecutionPlansCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class ListRescoreExecutionPlansCommand extends $Command<ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput, KendraRankingClientResolvedConfig> {
|
|
30
|
+
readonly input: ListRescoreExecutionPlansCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: ListRescoreExecutionPlansCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
|
|
6
|
+
export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Gets a list of tags associated with a specified resource.
|
|
12
|
+
* A rescore execution plan is an example of a resource that
|
|
13
|
+
* can have tags associated with it.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { KendraRankingClient, ListTagsForResourceCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
18
|
+
* // const { KendraRankingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
19
|
+
* const client = new KendraRankingClient(config);
|
|
20
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, KendraRankingClientResolvedConfig> {
|
|
30
|
+
readonly input: ListTagsForResourceCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: ListTagsForResourceCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { KendraRankingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraRankingClient";
|
|
5
|
+
import { RescoreRequest, RescoreResult } from "../models/models_0";
|
|
6
|
+
export interface RescoreCommandInput extends RescoreRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface RescoreCommandOutput extends RescoreResult, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Rescores or re-ranks search results from a search service
|
|
12
|
+
* such as OpenSearch (self managed). You use the semantic search
|
|
13
|
+
* capabilities of Amazon Kendra Intelligent Ranking to
|
|
14
|
+
* improve the search service's results.</p>
|
|
15
|
+
* @example
|
|
16
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
17
|
+
* ```javascript
|
|
18
|
+
* import { KendraRankingClient, RescoreCommand } from "@aws-sdk/client-kendra-ranking"; // ES Modules import
|
|
19
|
+
* // const { KendraRankingClient, RescoreCommand } = require("@aws-sdk/client-kendra-ranking"); // CommonJS import
|
|
20
|
+
* const client = new KendraRankingClient(config);
|
|
21
|
+
* const command = new RescoreCommand(input);
|
|
22
|
+
* const response = await client.send(command);
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @see {@link RescoreCommandInput} for command's `input` shape.
|
|
26
|
+
* @see {@link RescoreCommandOutput} for command's `response` shape.
|
|
27
|
+
* @see {@link KendraRankingClientResolvedConfig | config} for KendraRankingClient's `config` shape.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
export declare class RescoreCommand extends $Command<RescoreCommandInput, RescoreCommandOutput, KendraRankingClientResolvedConfig> {
|
|
31
|
+
readonly input: RescoreCommandInput;
|
|
32
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
33
|
+
constructor(input: RescoreCommandInput);
|
|
34
|
+
/**
|
|
35
|
+
* @internal
|
|
36
|
+
*/
|
|
37
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraRankingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RescoreCommandInput, RescoreCommandOutput>;
|
|
38
|
+
private serialize;
|
|
39
|
+
private deserialize;
|
|
40
|
+
}
|