@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,600 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { KendraRankingServiceException as __BaseException } from "./KendraRankingServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>You don’t have sufficient access to perform this action.
|
|
5
|
+
* Please ensure you have the required permission policies
|
|
6
|
+
* and user accounts and try again.</p>
|
|
7
|
+
*/
|
|
8
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
+
readonly name: "AccessDeniedException";
|
|
10
|
+
readonly $fault: "client";
|
|
11
|
+
Message?: string;
|
|
12
|
+
/**
|
|
13
|
+
* @internal
|
|
14
|
+
*/
|
|
15
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* <p>A conflict occurred with the request. Please fix any
|
|
19
|
+
* inconsistencies with your resources and try again.</p>
|
|
20
|
+
*/
|
|
21
|
+
export declare class ConflictException extends __BaseException {
|
|
22
|
+
readonly name: "ConflictException";
|
|
23
|
+
readonly $fault: "client";
|
|
24
|
+
Message?: string;
|
|
25
|
+
/**
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* <p>Sets additional capacity units configured for your
|
|
32
|
+
* rescore execution plan. A rescore execution plan is an
|
|
33
|
+
* Amazon Kendra Intelligent Ranking resource used for
|
|
34
|
+
* provisioning the <code>Rescore</code> API. You can add and
|
|
35
|
+
* remove capacity units to fit your usage requirements.</p>
|
|
36
|
+
*/
|
|
37
|
+
export interface CapacityUnitsConfiguration {
|
|
38
|
+
/**
|
|
39
|
+
* <p>The amount of extra capacity for your rescore execution
|
|
40
|
+
* plan.</p>
|
|
41
|
+
* <p>A single extra capacity unit for a rescore execution
|
|
42
|
+
* plan provides 0.01 rescore requests per second. You can add
|
|
43
|
+
* up to 1000 extra capacity units.</p>
|
|
44
|
+
*/
|
|
45
|
+
RescoreCapacityUnits: number | undefined;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* <p>A key-value pair that identifies or categorizes a rescore
|
|
49
|
+
* execution plan. A rescore execution plan is an
|
|
50
|
+
* Amazon Kendra Intelligent Ranking resource used for
|
|
51
|
+
* provisioning the <code>Rescore</code> API. You can also use
|
|
52
|
+
* a tag to help control access to a rescore execution plan.
|
|
53
|
+
* A tag key and value can consist of Unicode letters, digits,
|
|
54
|
+
* white space, and any of the following symbols: _ . : / = + - @.</p>
|
|
55
|
+
*/
|
|
56
|
+
export interface Tag {
|
|
57
|
+
/**
|
|
58
|
+
* <p>The key for the tag. Keys are not case sensitive and must
|
|
59
|
+
* be unique.</p>
|
|
60
|
+
*/
|
|
61
|
+
Key: string | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* <p>The value associated with the tag. The value can be an
|
|
64
|
+
* empty string but it can't be null.</p>
|
|
65
|
+
*/
|
|
66
|
+
Value: string | undefined;
|
|
67
|
+
}
|
|
68
|
+
export interface CreateRescoreExecutionPlanRequest {
|
|
69
|
+
/**
|
|
70
|
+
* <p>A name for the rescore execution plan.</p>
|
|
71
|
+
*/
|
|
72
|
+
Name: string | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>A description for the rescore execution plan.</p>
|
|
75
|
+
*/
|
|
76
|
+
Description?: string;
|
|
77
|
+
/**
|
|
78
|
+
* <p>You can set additional capacity units to meet the
|
|
79
|
+
* needs of your rescore execution plan. You are given a single
|
|
80
|
+
* capacity unit by default. If you want to use the default
|
|
81
|
+
* capacity, you don't set additional capacity units. For more
|
|
82
|
+
* information on the default capacity and additional capacity
|
|
83
|
+
* units, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
|
|
84
|
+
* capacity</a>.</p>
|
|
85
|
+
*/
|
|
86
|
+
CapacityUnits?: CapacityUnitsConfiguration;
|
|
87
|
+
/**
|
|
88
|
+
* <p>A list of key-value pairs that identify or categorize your
|
|
89
|
+
* rescore execution plan. You can also use tags to help control
|
|
90
|
+
* access to the rescore execution plan. Tag keys and values can
|
|
91
|
+
* consist of Unicode letters, digits, white space, and any of
|
|
92
|
+
* the following symbols: _ . : / = + - @.</p>
|
|
93
|
+
*/
|
|
94
|
+
Tags?: Tag[];
|
|
95
|
+
/**
|
|
96
|
+
* <p>A token that you provide to identify the request to create
|
|
97
|
+
* a rescore execution plan. Multiple calls to the
|
|
98
|
+
* <code>CreateRescoreExecutionPlanRequest</code> API with the
|
|
99
|
+
* same client token will create only one rescore execution plan.</p>
|
|
100
|
+
*/
|
|
101
|
+
ClientToken?: string;
|
|
102
|
+
}
|
|
103
|
+
export interface CreateRescoreExecutionPlanResponse {
|
|
104
|
+
/**
|
|
105
|
+
* <p>The identifier of the rescore execution plan.</p>
|
|
106
|
+
*/
|
|
107
|
+
Id: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The Amazon Resource Name (ARN) of the rescore
|
|
110
|
+
* execution plan.</p>
|
|
111
|
+
*/
|
|
112
|
+
Arn: string | undefined;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* <p>An issue occurred with the internal server used for
|
|
116
|
+
* your Amazon Kendra Intelligent Ranking service.
|
|
117
|
+
* Please wait a few minutes and try again, or contact
|
|
118
|
+
* <a href="http://aws.amazon.com/contact-us/">Support</a>
|
|
119
|
+
* for help.</p>
|
|
120
|
+
*/
|
|
121
|
+
export declare class InternalServerException extends __BaseException {
|
|
122
|
+
readonly name: "InternalServerException";
|
|
123
|
+
readonly $fault: "server";
|
|
124
|
+
Message?: string;
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
*/
|
|
128
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* <p>You have exceeded the set limits for your
|
|
132
|
+
* Amazon Kendra Intelligent Ranking service. Please
|
|
133
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a>
|
|
134
|
+
* for more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
|
|
135
|
+
* an increase of limits.</p>
|
|
136
|
+
*/
|
|
137
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
138
|
+
readonly name: "ServiceQuotaExceededException";
|
|
139
|
+
readonly $fault: "client";
|
|
140
|
+
Message?: string;
|
|
141
|
+
/**
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
144
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* <p>The request was denied due to request throttling.
|
|
148
|
+
* Please reduce the number of requests and try again.</p>
|
|
149
|
+
*/
|
|
150
|
+
export declare class ThrottlingException extends __BaseException {
|
|
151
|
+
readonly name: "ThrottlingException";
|
|
152
|
+
readonly $fault: "client";
|
|
153
|
+
Message?: string;
|
|
154
|
+
/**
|
|
155
|
+
* @internal
|
|
156
|
+
*/
|
|
157
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* <p>The input fails to satisfy the constraints set by
|
|
161
|
+
* the Amazon Kendra Intelligent Ranking service.
|
|
162
|
+
* Please provide the correct input and try again.</p>
|
|
163
|
+
*/
|
|
164
|
+
export declare class ValidationException extends __BaseException {
|
|
165
|
+
readonly name: "ValidationException";
|
|
166
|
+
readonly $fault: "client";
|
|
167
|
+
Message?: string;
|
|
168
|
+
/**
|
|
169
|
+
* @internal
|
|
170
|
+
*/
|
|
171
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
172
|
+
}
|
|
173
|
+
export interface DeleteRescoreExecutionPlanRequest {
|
|
174
|
+
/**
|
|
175
|
+
* <p>The identifier of the rescore execution plan that you
|
|
176
|
+
* want to delete.</p>
|
|
177
|
+
*/
|
|
178
|
+
Id: string | undefined;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* <p>The resource you want to use doesn't exist. Please
|
|
182
|
+
* check you have provided the correct resource and try
|
|
183
|
+
* again.</p>
|
|
184
|
+
*/
|
|
185
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
186
|
+
readonly name: "ResourceNotFoundException";
|
|
187
|
+
readonly $fault: "client";
|
|
188
|
+
Message?: string;
|
|
189
|
+
/**
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
193
|
+
}
|
|
194
|
+
export interface DescribeRescoreExecutionPlanRequest {
|
|
195
|
+
/**
|
|
196
|
+
* <p>The identifier of the rescore execution plan that you want
|
|
197
|
+
* to get information on.</p>
|
|
198
|
+
*/
|
|
199
|
+
Id: string | undefined;
|
|
200
|
+
}
|
|
201
|
+
export declare enum RescoreExecutionPlanStatus {
|
|
202
|
+
ACTIVE = "ACTIVE",
|
|
203
|
+
CREATING = "CREATING",
|
|
204
|
+
DELETING = "DELETING",
|
|
205
|
+
FAILED = "FAILED",
|
|
206
|
+
UPDATING = "UPDATING"
|
|
207
|
+
}
|
|
208
|
+
export interface DescribeRescoreExecutionPlanResponse {
|
|
209
|
+
/**
|
|
210
|
+
* <p>The identifier of the rescore execution plan.</p>
|
|
211
|
+
*/
|
|
212
|
+
Id?: string;
|
|
213
|
+
/**
|
|
214
|
+
* <p>The Amazon Resource Name (ARN) of the rescore execution
|
|
215
|
+
* plan.</p>
|
|
216
|
+
*/
|
|
217
|
+
Arn?: string;
|
|
218
|
+
/**
|
|
219
|
+
* <p>The name for the rescore execution plan.</p>
|
|
220
|
+
*/
|
|
221
|
+
Name?: string;
|
|
222
|
+
/**
|
|
223
|
+
* <p>The description for the rescore execution plan.</p>
|
|
224
|
+
*/
|
|
225
|
+
Description?: string;
|
|
226
|
+
/**
|
|
227
|
+
* <p>The capacity units set for the rescore execution plan.
|
|
228
|
+
* A capacity of zero indicates that the rescore execution
|
|
229
|
+
* plan is using the default capacity. For more information on the
|
|
230
|
+
* default capacity and additional capacity units, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
|
|
231
|
+
* capacity</a>.</p>
|
|
232
|
+
*/
|
|
233
|
+
CapacityUnits?: CapacityUnitsConfiguration;
|
|
234
|
+
/**
|
|
235
|
+
* <p>The Unix timestamp of when the rescore execution plan was
|
|
236
|
+
* created.</p>
|
|
237
|
+
*/
|
|
238
|
+
CreatedAt?: Date;
|
|
239
|
+
/**
|
|
240
|
+
* <p>The Unix timestamp of when the rescore execution plan was
|
|
241
|
+
* last updated.</p>
|
|
242
|
+
*/
|
|
243
|
+
UpdatedAt?: Date;
|
|
244
|
+
/**
|
|
245
|
+
* <p>The current status of the rescore execution plan. When the
|
|
246
|
+
* value is <code>ACTIVE</code>, the rescore execution plan is
|
|
247
|
+
* ready for use. If the <code>Status</code> field value is
|
|
248
|
+
* <code>FAILED</code>, the <code>ErrorMessage</code> field
|
|
249
|
+
* contains a message that explains why.</p>
|
|
250
|
+
*/
|
|
251
|
+
Status?: RescoreExecutionPlanStatus | string;
|
|
252
|
+
/**
|
|
253
|
+
* <p>When the <code>Status</code> field value is
|
|
254
|
+
* <code>FAILED</code>, the <code>ErrorMessage</code> field
|
|
255
|
+
* contains a message that explains why.</p>
|
|
256
|
+
*/
|
|
257
|
+
ErrorMessage?: string;
|
|
258
|
+
}
|
|
259
|
+
export interface ListRescoreExecutionPlansRequest {
|
|
260
|
+
/**
|
|
261
|
+
* <p>If the response is truncated, Amazon Kendra Intelligent
|
|
262
|
+
* Ranking returns a pagination token in the response. You can use
|
|
263
|
+
* this pagination token to retrieve the next set of rescore
|
|
264
|
+
* execution plans.</p>
|
|
265
|
+
*/
|
|
266
|
+
NextToken?: string;
|
|
267
|
+
/**
|
|
268
|
+
* <p>The maximum number of rescore execution plans to return.</p>
|
|
269
|
+
*/
|
|
270
|
+
MaxResults?: number;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* <p>Summary information for a rescore execution plan. A rescore
|
|
274
|
+
* execution plan is an Amazon Kendra Intelligent Ranking
|
|
275
|
+
* resource used for provisioning the <code>Rescore</code> API.</p>
|
|
276
|
+
*/
|
|
277
|
+
export interface RescoreExecutionPlanSummary {
|
|
278
|
+
/**
|
|
279
|
+
* <p>The name of the rescore execution plan.</p>
|
|
280
|
+
*/
|
|
281
|
+
Name?: string;
|
|
282
|
+
/**
|
|
283
|
+
* <p>The identifier of the rescore execution plan.</p>
|
|
284
|
+
*/
|
|
285
|
+
Id?: string;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The Unix timestamp when the rescore execution plan
|
|
288
|
+
* was created.</p>
|
|
289
|
+
*/
|
|
290
|
+
CreatedAt?: Date;
|
|
291
|
+
/**
|
|
292
|
+
* <p>The Unix timestamp when the rescore execution plan
|
|
293
|
+
* was last updated.</p>
|
|
294
|
+
*/
|
|
295
|
+
UpdatedAt?: Date;
|
|
296
|
+
/**
|
|
297
|
+
* <p>The current status of the rescore execution plan. When
|
|
298
|
+
* the value is <code>ACTIVE</code>, the rescore execution
|
|
299
|
+
* plan is ready for use.</p>
|
|
300
|
+
*/
|
|
301
|
+
Status?: RescoreExecutionPlanStatus | string;
|
|
302
|
+
}
|
|
303
|
+
export interface ListRescoreExecutionPlansResponse {
|
|
304
|
+
/**
|
|
305
|
+
* <p>An array of summary information for one or more rescore
|
|
306
|
+
* execution plans.</p>
|
|
307
|
+
*/
|
|
308
|
+
SummaryItems?: RescoreExecutionPlanSummary[];
|
|
309
|
+
/**
|
|
310
|
+
* <p>If the response is truncated, Amazon Kendra Intelligent
|
|
311
|
+
* Ranking returns a pagination token in the response.</p>
|
|
312
|
+
*/
|
|
313
|
+
NextToken?: string;
|
|
314
|
+
}
|
|
315
|
+
/**
|
|
316
|
+
* <p>The request information for listing tags associated with
|
|
317
|
+
* a rescore execution plan. A rescore execution plan is an
|
|
318
|
+
* Amazon Kendra Intelligent Ranking resource used for
|
|
319
|
+
* provisioning the <code>Rescore</code> API.</p>
|
|
320
|
+
*/
|
|
321
|
+
export interface ListTagsForResourceRequest {
|
|
322
|
+
/**
|
|
323
|
+
* <p>The Amazon Resource Name (ARN) of the rescore execution
|
|
324
|
+
* plan to get a list of tags for.</p>
|
|
325
|
+
*/
|
|
326
|
+
ResourceARN: string | undefined;
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* <p>If the action is successful, the service sends back an
|
|
330
|
+
* HTTP 200 response.</p>
|
|
331
|
+
*/
|
|
332
|
+
export interface ListTagsForResourceResponse {
|
|
333
|
+
/**
|
|
334
|
+
* <p>A list of tags associated with the rescore execution
|
|
335
|
+
* plan.</p>
|
|
336
|
+
*/
|
|
337
|
+
Tags?: Tag[];
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* <p>The resource you want to use is unavailable. Please
|
|
341
|
+
* check you have provided the correct resource
|
|
342
|
+
* information and try again.</p>
|
|
343
|
+
*/
|
|
344
|
+
export declare class ResourceUnavailableException extends __BaseException {
|
|
345
|
+
readonly name: "ResourceUnavailableException";
|
|
346
|
+
readonly $fault: "client";
|
|
347
|
+
Message?: string;
|
|
348
|
+
/**
|
|
349
|
+
* @internal
|
|
350
|
+
*/
|
|
351
|
+
constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* <p>Information about a document from a search service such
|
|
355
|
+
* as OpenSearch (self managed). Amazon Kendra Intelligent
|
|
356
|
+
* Ranking uses this information to rank and score on.</p>
|
|
357
|
+
*/
|
|
358
|
+
export interface Document {
|
|
359
|
+
/**
|
|
360
|
+
* <p>The identifier of the document from the search service.</p>
|
|
361
|
+
*/
|
|
362
|
+
Id: string | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* <p>The optional group identifier of the document from the search
|
|
365
|
+
* service. Documents with the same group identifier are grouped
|
|
366
|
+
* together and processed as one document within the service.</p>
|
|
367
|
+
*/
|
|
368
|
+
GroupId?: string;
|
|
369
|
+
/**
|
|
370
|
+
* <p>The title of the search service's document.</p>
|
|
371
|
+
*/
|
|
372
|
+
Title?: string;
|
|
373
|
+
/**
|
|
374
|
+
* <p>The body text of the search service's document.</p>
|
|
375
|
+
*/
|
|
376
|
+
Body?: string;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The title of the search service's document represented as
|
|
379
|
+
* a list of tokens or words. You must choose to provide
|
|
380
|
+
* <code>Title</code> or <code>TokenizedTitle</code>. You cannot
|
|
381
|
+
* provide both.</p>
|
|
382
|
+
*/
|
|
383
|
+
TokenizedTitle?: string[];
|
|
384
|
+
/**
|
|
385
|
+
* <p>The body text of the search service's document represented
|
|
386
|
+
* as a list of tokens or words. You must choose to provide
|
|
387
|
+
* <code>Body</code> or <code>TokenizedBody</code>. You cannot
|
|
388
|
+
* provide both.</p>
|
|
389
|
+
*/
|
|
390
|
+
TokenizedBody?: string[];
|
|
391
|
+
/**
|
|
392
|
+
* <p>The original document score or rank from the search service.
|
|
393
|
+
* Amazon Kendra Intelligent Ranking gives the document a new
|
|
394
|
+
* score or rank based on its intelligent search algorithms.</p>
|
|
395
|
+
*/
|
|
396
|
+
OriginalScore: number | undefined;
|
|
397
|
+
}
|
|
398
|
+
export interface RescoreRequest {
|
|
399
|
+
/**
|
|
400
|
+
* <p>The identifier of the rescore execution plan. A rescore
|
|
401
|
+
* execution plan is an Amazon Kendra Intelligent Ranking
|
|
402
|
+
* resource used for provisioning the <code>Rescore</code> API.</p>
|
|
403
|
+
*/
|
|
404
|
+
RescoreExecutionPlanId: string | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>The input query from the search service.</p>
|
|
407
|
+
*/
|
|
408
|
+
SearchQuery: string | undefined;
|
|
409
|
+
/**
|
|
410
|
+
* <p>The list of documents for Amazon Kendra Intelligent
|
|
411
|
+
* Ranking to rescore or rank on.</p>
|
|
412
|
+
*/
|
|
413
|
+
Documents: Document[] | undefined;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* <p>A result item for a document with a new relevancy score.</p>
|
|
417
|
+
*/
|
|
418
|
+
export interface RescoreResultItem {
|
|
419
|
+
/**
|
|
420
|
+
* <p>The identifier of the document from the search service.</p>
|
|
421
|
+
*/
|
|
422
|
+
DocumentId?: string;
|
|
423
|
+
/**
|
|
424
|
+
* <p>The relevancy score or rank that Amazon Kendra
|
|
425
|
+
* Intelligent Ranking gives to the result.</p>
|
|
426
|
+
*/
|
|
427
|
+
Score?: number;
|
|
428
|
+
}
|
|
429
|
+
export interface RescoreResult {
|
|
430
|
+
/**
|
|
431
|
+
* <p>The identifier associated with the scores that
|
|
432
|
+
* Amazon Kendra Intelligent Ranking gives to the
|
|
433
|
+
* results. Amazon Kendra Intelligent Ranking
|
|
434
|
+
* rescores or re-ranks the results for the search service.</p>
|
|
435
|
+
*/
|
|
436
|
+
RescoreId?: string;
|
|
437
|
+
/**
|
|
438
|
+
* <p>A list of result items for documents with new relevancy
|
|
439
|
+
* scores. The results are in descending order.</p>
|
|
440
|
+
*/
|
|
441
|
+
ResultItems?: RescoreResultItem[];
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* <p>The request information for tagging a rescore execution
|
|
445
|
+
* plan. A rescore execution plan is an Amazon Kendra
|
|
446
|
+
* Intelligent Ranking resource used for provisioning the
|
|
447
|
+
* <code>Rescore</code> API.</p>
|
|
448
|
+
*/
|
|
449
|
+
export interface TagResourceRequest {
|
|
450
|
+
/**
|
|
451
|
+
* <p>The Amazon Resource Name (ARN) of the rescore execution
|
|
452
|
+
* plan to tag.</p>
|
|
453
|
+
*/
|
|
454
|
+
ResourceARN: string | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* <p>A list of tag keys to add to a rescore execution plan.
|
|
457
|
+
* If a tag already exists, the existing value is replaced
|
|
458
|
+
* with the new value.</p>
|
|
459
|
+
*/
|
|
460
|
+
Tags: Tag[] | undefined;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* <p>If the action is successful, the service sends back an
|
|
464
|
+
* HTTP 200 response with an empty HTTP body.</p>
|
|
465
|
+
*/
|
|
466
|
+
export interface TagResourceResponse {
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* <p>The request information to remove a tag from a rescore
|
|
470
|
+
* execution plan. A rescore execution plan is an
|
|
471
|
+
* Amazon Kendra Intelligent Ranking resource used for
|
|
472
|
+
* provisioning the <code>Rescore</code> API.</p>
|
|
473
|
+
*/
|
|
474
|
+
export interface UntagResourceRequest {
|
|
475
|
+
/**
|
|
476
|
+
* <p>The Amazon Resource Name (ARN) of the rescore execution
|
|
477
|
+
* plan to remove the tag.</p>
|
|
478
|
+
*/
|
|
479
|
+
ResourceARN: string | undefined;
|
|
480
|
+
/**
|
|
481
|
+
* <p>A list of tag keys to remove from the rescore execution
|
|
482
|
+
* plan. If a tag key does not exist on the resource, it is
|
|
483
|
+
* ignored.</p>
|
|
484
|
+
*/
|
|
485
|
+
TagKeys: string[] | undefined;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* <p>If the action is successful, the service sends back an
|
|
489
|
+
* HTTP 200 response with an empty HTTP body.</p>
|
|
490
|
+
*/
|
|
491
|
+
export interface UntagResourceResponse {
|
|
492
|
+
}
|
|
493
|
+
export interface UpdateRescoreExecutionPlanRequest {
|
|
494
|
+
/**
|
|
495
|
+
* <p>The identifier of the rescore execution plan that you want
|
|
496
|
+
* to update.</p>
|
|
497
|
+
*/
|
|
498
|
+
Id: string | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>A new name for the rescore execution plan.</p>
|
|
501
|
+
*/
|
|
502
|
+
Name?: string;
|
|
503
|
+
/**
|
|
504
|
+
* <p>A new description for the rescore execution plan.</p>
|
|
505
|
+
*/
|
|
506
|
+
Description?: string;
|
|
507
|
+
/**
|
|
508
|
+
* <p>You can set additional capacity units to meet the needs
|
|
509
|
+
* of your rescore execution plan. You are given a single capacity
|
|
510
|
+
* unit by default. If you want to use the default capacity, you
|
|
511
|
+
* don't set additional capacity units. For more information on the
|
|
512
|
+
* default capacity and additional capacity units, see
|
|
513
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting capacity</a>.</p>
|
|
514
|
+
*/
|
|
515
|
+
CapacityUnits?: CapacityUnitsConfiguration;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* @internal
|
|
519
|
+
*/
|
|
520
|
+
export declare const CapacityUnitsConfigurationFilterSensitiveLog: (obj: CapacityUnitsConfiguration) => any;
|
|
521
|
+
/**
|
|
522
|
+
* @internal
|
|
523
|
+
*/
|
|
524
|
+
export declare const TagFilterSensitiveLog: (obj: Tag) => any;
|
|
525
|
+
/**
|
|
526
|
+
* @internal
|
|
527
|
+
*/
|
|
528
|
+
export declare const CreateRescoreExecutionPlanRequestFilterSensitiveLog: (obj: CreateRescoreExecutionPlanRequest) => any;
|
|
529
|
+
/**
|
|
530
|
+
* @internal
|
|
531
|
+
*/
|
|
532
|
+
export declare const CreateRescoreExecutionPlanResponseFilterSensitiveLog: (obj: CreateRescoreExecutionPlanResponse) => any;
|
|
533
|
+
/**
|
|
534
|
+
* @internal
|
|
535
|
+
*/
|
|
536
|
+
export declare const DeleteRescoreExecutionPlanRequestFilterSensitiveLog: (obj: DeleteRescoreExecutionPlanRequest) => any;
|
|
537
|
+
/**
|
|
538
|
+
* @internal
|
|
539
|
+
*/
|
|
540
|
+
export declare const DescribeRescoreExecutionPlanRequestFilterSensitiveLog: (obj: DescribeRescoreExecutionPlanRequest) => any;
|
|
541
|
+
/**
|
|
542
|
+
* @internal
|
|
543
|
+
*/
|
|
544
|
+
export declare const DescribeRescoreExecutionPlanResponseFilterSensitiveLog: (obj: DescribeRescoreExecutionPlanResponse) => any;
|
|
545
|
+
/**
|
|
546
|
+
* @internal
|
|
547
|
+
*/
|
|
548
|
+
export declare const ListRescoreExecutionPlansRequestFilterSensitiveLog: (obj: ListRescoreExecutionPlansRequest) => any;
|
|
549
|
+
/**
|
|
550
|
+
* @internal
|
|
551
|
+
*/
|
|
552
|
+
export declare const RescoreExecutionPlanSummaryFilterSensitiveLog: (obj: RescoreExecutionPlanSummary) => any;
|
|
553
|
+
/**
|
|
554
|
+
* @internal
|
|
555
|
+
*/
|
|
556
|
+
export declare const ListRescoreExecutionPlansResponseFilterSensitiveLog: (obj: ListRescoreExecutionPlansResponse) => any;
|
|
557
|
+
/**
|
|
558
|
+
* @internal
|
|
559
|
+
*/
|
|
560
|
+
export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
|
|
561
|
+
/**
|
|
562
|
+
* @internal
|
|
563
|
+
*/
|
|
564
|
+
export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
565
|
+
/**
|
|
566
|
+
* @internal
|
|
567
|
+
*/
|
|
568
|
+
export declare const DocumentFilterSensitiveLog: (obj: Document) => any;
|
|
569
|
+
/**
|
|
570
|
+
* @internal
|
|
571
|
+
*/
|
|
572
|
+
export declare const RescoreRequestFilterSensitiveLog: (obj: RescoreRequest) => any;
|
|
573
|
+
/**
|
|
574
|
+
* @internal
|
|
575
|
+
*/
|
|
576
|
+
export declare const RescoreResultItemFilterSensitiveLog: (obj: RescoreResultItem) => any;
|
|
577
|
+
/**
|
|
578
|
+
* @internal
|
|
579
|
+
*/
|
|
580
|
+
export declare const RescoreResultFilterSensitiveLog: (obj: RescoreResult) => any;
|
|
581
|
+
/**
|
|
582
|
+
* @internal
|
|
583
|
+
*/
|
|
584
|
+
export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
585
|
+
/**
|
|
586
|
+
* @internal
|
|
587
|
+
*/
|
|
588
|
+
export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
|
|
589
|
+
/**
|
|
590
|
+
* @internal
|
|
591
|
+
*/
|
|
592
|
+
export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
|
|
593
|
+
/**
|
|
594
|
+
* @internal
|
|
595
|
+
*/
|
|
596
|
+
export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
597
|
+
/**
|
|
598
|
+
* @internal
|
|
599
|
+
*/
|
|
600
|
+
export declare const UpdateRescoreExecutionPlanRequestFilterSensitiveLog: (obj: UpdateRescoreExecutionPlanRequest) => any;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { PaginationConfiguration } from "@aws-sdk/types";
|
|
2
|
+
import { KendraRanking } from "../KendraRanking";
|
|
3
|
+
import { KendraRankingClient } from "../KendraRankingClient";
|
|
4
|
+
export interface KendraRankingPaginationConfiguration extends PaginationConfiguration {
|
|
5
|
+
client: KendraRanking | KendraRankingClient;
|
|
6
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput } from "../commands/ListRescoreExecutionPlansCommand";
|
|
3
|
+
import { KendraRankingPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListRescoreExecutionPlans(config: KendraRankingPaginationConfiguration, input: ListRescoreExecutionPlansCommandInput, ...additionalArguments: any): Paginator<ListRescoreExecutionPlansCommandOutput>;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
|
|
2
|
+
import { SerdeContext as __SerdeContext } from "@aws-sdk/types";
|
|
3
|
+
import { CreateRescoreExecutionPlanCommandInput, CreateRescoreExecutionPlanCommandOutput } from "../commands/CreateRescoreExecutionPlanCommand";
|
|
4
|
+
import { DeleteRescoreExecutionPlanCommandInput, DeleteRescoreExecutionPlanCommandOutput } from "../commands/DeleteRescoreExecutionPlanCommand";
|
|
5
|
+
import { DescribeRescoreExecutionPlanCommandInput, DescribeRescoreExecutionPlanCommandOutput } from "../commands/DescribeRescoreExecutionPlanCommand";
|
|
6
|
+
import { ListRescoreExecutionPlansCommandInput, ListRescoreExecutionPlansCommandOutput } from "../commands/ListRescoreExecutionPlansCommand";
|
|
7
|
+
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
8
|
+
import { RescoreCommandInput, RescoreCommandOutput } from "../commands/RescoreCommand";
|
|
9
|
+
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
10
|
+
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
11
|
+
import { UpdateRescoreExecutionPlanCommandInput, UpdateRescoreExecutionPlanCommandOutput } from "../commands/UpdateRescoreExecutionPlanCommand";
|
|
12
|
+
export declare const serializeAws_json1_0CreateRescoreExecutionPlanCommand: (input: CreateRescoreExecutionPlanCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
13
|
+
export declare const serializeAws_json1_0DeleteRescoreExecutionPlanCommand: (input: DeleteRescoreExecutionPlanCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
14
|
+
export declare const serializeAws_json1_0DescribeRescoreExecutionPlanCommand: (input: DescribeRescoreExecutionPlanCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
15
|
+
export declare const serializeAws_json1_0ListRescoreExecutionPlansCommand: (input: ListRescoreExecutionPlansCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
16
|
+
export declare const serializeAws_json1_0ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
17
|
+
export declare const serializeAws_json1_0RescoreCommand: (input: RescoreCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
18
|
+
export declare const serializeAws_json1_0TagResourceCommand: (input: TagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
19
|
+
export declare const serializeAws_json1_0UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
20
|
+
export declare const serializeAws_json1_0UpdateRescoreExecutionPlanCommand: (input: UpdateRescoreExecutionPlanCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
21
|
+
export declare const deserializeAws_json1_0CreateRescoreExecutionPlanCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateRescoreExecutionPlanCommandOutput>;
|
|
22
|
+
export declare const deserializeAws_json1_0DeleteRescoreExecutionPlanCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteRescoreExecutionPlanCommandOutput>;
|
|
23
|
+
export declare const deserializeAws_json1_0DescribeRescoreExecutionPlanCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeRescoreExecutionPlanCommandOutput>;
|
|
24
|
+
export declare const deserializeAws_json1_0ListRescoreExecutionPlansCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListRescoreExecutionPlansCommandOutput>;
|
|
25
|
+
export declare const deserializeAws_json1_0ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
|
|
26
|
+
export declare const deserializeAws_json1_0RescoreCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RescoreCommandOutput>;
|
|
27
|
+
export declare const deserializeAws_json1_0TagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TagResourceCommandOutput>;
|
|
28
|
+
export declare const deserializeAws_json1_0UntagResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagResourceCommandOutput>;
|
|
29
|
+
export declare const deserializeAws_json1_0UpdateRescoreExecutionPlanCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateRescoreExecutionPlanCommandOutput>;
|