@aws-sdk/client-kendra 3.686.0 → 3.691.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.
@@ -45,71 +45,71 @@ export declare const ScoreConfidence: {
45
45
  export type ScoreConfidence =
46
46
  (typeof ScoreConfidence)[keyof typeof ScoreConfidence];
47
47
  export interface ScoreAttributes {
48
- ScoreConfidence?: ScoreConfidence;
48
+ ScoreConfidence?: ScoreConfidence | undefined;
49
49
  }
50
50
  export interface TableCell {
51
- Value?: string;
52
- TopAnswer?: boolean;
53
- Highlighted?: boolean;
54
- Header?: boolean;
51
+ Value?: string | undefined;
52
+ TopAnswer?: boolean | undefined;
53
+ Highlighted?: boolean | undefined;
54
+ Header?: boolean | undefined;
55
55
  }
56
56
  export interface TableRow {
57
- Cells?: TableCell[];
57
+ Cells?: TableCell[] | undefined;
58
58
  }
59
59
  export interface TableExcerpt {
60
- Rows?: TableRow[];
61
- TotalNumberOfRows?: number;
60
+ Rows?: TableRow[] | undefined;
61
+ TotalNumberOfRows?: number | undefined;
62
62
  }
63
63
  export interface QueryResultItem {
64
- Id?: string;
65
- Type?: QueryResultType;
66
- Format?: QueryResultFormat;
67
- AdditionalAttributes?: AdditionalResultAttribute[];
68
- DocumentId?: string;
69
- DocumentTitle?: TextWithHighlights;
70
- DocumentExcerpt?: TextWithHighlights;
71
- DocumentURI?: string;
72
- DocumentAttributes?: DocumentAttribute[];
73
- ScoreAttributes?: ScoreAttributes;
74
- FeedbackToken?: string;
75
- TableExcerpt?: TableExcerpt;
76
- CollapsedResultDetail?: CollapsedResultDetail;
64
+ Id?: string | undefined;
65
+ Type?: QueryResultType | undefined;
66
+ Format?: QueryResultFormat | undefined;
67
+ AdditionalAttributes?: AdditionalResultAttribute[] | undefined;
68
+ DocumentId?: string | undefined;
69
+ DocumentTitle?: TextWithHighlights | undefined;
70
+ DocumentExcerpt?: TextWithHighlights | undefined;
71
+ DocumentURI?: string | undefined;
72
+ DocumentAttributes?: DocumentAttribute[] | undefined;
73
+ ScoreAttributes?: ScoreAttributes | undefined;
74
+ FeedbackToken?: string | undefined;
75
+ TableExcerpt?: TableExcerpt | undefined;
76
+ CollapsedResultDetail?: CollapsedResultDetail | undefined;
77
77
  }
78
78
  export interface Correction {
79
- BeginOffset?: number;
80
- EndOffset?: number;
81
- Term?: string;
82
- CorrectedTerm?: string;
79
+ BeginOffset?: number | undefined;
80
+ EndOffset?: number | undefined;
81
+ Term?: string | undefined;
82
+ CorrectedTerm?: string | undefined;
83
83
  }
84
84
  export interface SpellCorrectedQuery {
85
- SuggestedQueryText?: string;
86
- Corrections?: Correction[];
85
+ SuggestedQueryText?: string | undefined;
86
+ Corrections?: Correction[] | undefined;
87
87
  }
88
88
  export declare const WarningCode: {
89
89
  readonly QUERY_LANGUAGE_INVALID_SYNTAX: "QUERY_LANGUAGE_INVALID_SYNTAX";
90
90
  };
91
91
  export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode];
92
92
  export interface Warning {
93
- Message?: string;
94
- Code?: WarningCode;
93
+ Message?: string | undefined;
94
+ Code?: WarningCode | undefined;
95
95
  }
96
96
  export interface RetrieveResultItem {
97
- Id?: string;
98
- DocumentId?: string;
99
- DocumentTitle?: string;
100
- Content?: string;
101
- DocumentURI?: string;
102
- DocumentAttributes?: DocumentAttribute[];
103
- ScoreAttributes?: ScoreAttributes;
97
+ Id?: string | undefined;
98
+ DocumentId?: string | undefined;
99
+ DocumentTitle?: string | undefined;
100
+ Content?: string | undefined;
101
+ DocumentURI?: string | undefined;
102
+ DocumentAttributes?: DocumentAttribute[] | undefined;
103
+ ScoreAttributes?: ScoreAttributes | undefined;
104
104
  }
105
105
  export interface RetrieveResult {
106
- QueryId?: string;
107
- ResultItems?: RetrieveResultItem[];
106
+ QueryId?: string | undefined;
107
+ ResultItems?: RetrieveResultItem[] | undefined;
108
108
  }
109
109
  export declare class ResourceInUseException extends __BaseException {
110
110
  readonly name: "ResourceInUseException";
111
111
  readonly $fault: "client";
112
- Message?: string;
112
+ Message?: string | undefined;
113
113
  constructor(
114
114
  opts: __ExceptionOptionType<ResourceInUseException, __BaseException>
115
115
  );
@@ -119,7 +119,7 @@ export interface StartDataSourceSyncJobRequest {
119
119
  IndexId: string | undefined;
120
120
  }
121
121
  export interface StartDataSourceSyncJobResponse {
122
- ExecutionId?: string;
122
+ ExecutionId?: string | undefined;
123
123
  }
124
124
  export interface StopDataSourceSyncJobRequest {
125
125
  Id: string | undefined;
@@ -141,8 +141,8 @@ export interface RelevanceFeedback {
141
141
  export interface SubmitFeedbackRequest {
142
142
  IndexId: string | undefined;
143
143
  QueryId: string | undefined;
144
- ClickFeedbackItems?: ClickFeedback[];
145
- RelevanceFeedbackItems?: RelevanceFeedback[];
144
+ ClickFeedbackItems?: ClickFeedback[] | undefined;
145
+ RelevanceFeedbackItems?: RelevanceFeedback[] | undefined;
146
146
  }
147
147
  export interface TagResourceRequest {
148
148
  ResourceARN: string | undefined;
@@ -157,153 +157,165 @@ export interface UntagResourceResponse {}
157
157
  export interface UpdateAccessControlConfigurationRequest {
158
158
  IndexId: string | undefined;
159
159
  Id: string | undefined;
160
- Name?: string;
161
- Description?: string;
162
- AccessControlList?: Principal[];
163
- HierarchicalAccessControlList?: HierarchicalPrincipal[];
160
+ Name?: string | undefined;
161
+ Description?: string | undefined;
162
+ AccessControlList?: Principal[] | undefined;
163
+ HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined;
164
164
  }
165
165
  export interface UpdateAccessControlConfigurationResponse {}
166
166
  export interface UpdateDataSourceRequest {
167
167
  Id: string | undefined;
168
- Name?: string;
168
+ Name?: string | undefined;
169
169
  IndexId: string | undefined;
170
- Configuration?: DataSourceConfiguration;
171
- VpcConfiguration?: DataSourceVpcConfiguration;
172
- Description?: string;
173
- Schedule?: string;
174
- RoleArn?: string;
175
- LanguageCode?: string;
176
- CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
170
+ Configuration?: DataSourceConfiguration | undefined;
171
+ VpcConfiguration?: DataSourceVpcConfiguration | undefined;
172
+ Description?: string | undefined;
173
+ Schedule?: string | undefined;
174
+ RoleArn?: string | undefined;
175
+ LanguageCode?: string | undefined;
176
+ CustomDocumentEnrichmentConfiguration?:
177
+ | CustomDocumentEnrichmentConfiguration
178
+ | undefined;
177
179
  }
178
180
  export interface UpdateExperienceRequest {
179
181
  Id: string | undefined;
180
- Name?: string;
182
+ Name?: string | undefined;
181
183
  IndexId: string | undefined;
182
- RoleArn?: string;
183
- Configuration?: ExperienceConfiguration;
184
- Description?: string;
184
+ RoleArn?: string | undefined;
185
+ Configuration?: ExperienceConfiguration | undefined;
186
+ Description?: string | undefined;
185
187
  }
186
188
  export interface UpdateFeaturedResultsSetRequest {
187
189
  IndexId: string | undefined;
188
190
  FeaturedResultsSetId: string | undefined;
189
- FeaturedResultsSetName?: string;
190
- Description?: string;
191
- Status?: FeaturedResultsSetStatus;
192
- QueryTexts?: string[];
193
- FeaturedDocuments?: FeaturedDocument[];
191
+ FeaturedResultsSetName?: string | undefined;
192
+ Description?: string | undefined;
193
+ Status?: FeaturedResultsSetStatus | undefined;
194
+ QueryTexts?: string[] | undefined;
195
+ FeaturedDocuments?: FeaturedDocument[] | undefined;
194
196
  }
195
197
  export interface UpdateFeaturedResultsSetResponse {
196
- FeaturedResultsSet?: FeaturedResultsSet;
198
+ FeaturedResultsSet?: FeaturedResultsSet | undefined;
197
199
  }
198
200
  export interface UpdateIndexRequest {
199
201
  Id: string | undefined;
200
- Name?: string;
201
- RoleArn?: string;
202
- Description?: string;
203
- DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
204
- CapacityUnits?: CapacityUnitsConfiguration;
205
- UserTokenConfigurations?: UserTokenConfiguration[];
206
- UserContextPolicy?: UserContextPolicy;
207
- UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
202
+ Name?: string | undefined;
203
+ RoleArn?: string | undefined;
204
+ Description?: string | undefined;
205
+ DocumentMetadataConfigurationUpdates?:
206
+ | DocumentMetadataConfiguration[]
207
+ | undefined;
208
+ CapacityUnits?: CapacityUnitsConfiguration | undefined;
209
+ UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
210
+ UserContextPolicy?: UserContextPolicy | undefined;
211
+ UserGroupResolutionConfiguration?:
212
+ | UserGroupResolutionConfiguration
213
+ | undefined;
208
214
  }
209
215
  export interface UpdateQuerySuggestionsBlockListRequest {
210
216
  IndexId: string | undefined;
211
217
  Id: string | undefined;
212
- Name?: string;
213
- Description?: string;
214
- SourceS3Path?: S3Path;
215
- RoleArn?: string;
218
+ Name?: string | undefined;
219
+ Description?: string | undefined;
220
+ SourceS3Path?: S3Path | undefined;
221
+ RoleArn?: string | undefined;
216
222
  }
217
223
  export interface UpdateQuerySuggestionsConfigRequest {
218
224
  IndexId: string | undefined;
219
- Mode?: Mode;
220
- QueryLogLookBackWindowInDays?: number;
221
- IncludeQueriesWithoutUserInformation?: boolean;
222
- MinimumNumberOfQueryingUsers?: number;
223
- MinimumQueryCount?: number;
224
- AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig;
225
+ Mode?: Mode | undefined;
226
+ QueryLogLookBackWindowInDays?: number | undefined;
227
+ IncludeQueriesWithoutUserInformation?: boolean | undefined;
228
+ MinimumNumberOfQueryingUsers?: number | undefined;
229
+ MinimumQueryCount?: number | undefined;
230
+ AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig | undefined;
225
231
  }
226
232
  export interface UpdateThesaurusRequest {
227
233
  Id: string | undefined;
228
- Name?: string;
234
+ Name?: string | undefined;
229
235
  IndexId: string | undefined;
230
- Description?: string;
231
- RoleArn?: string;
232
- SourceS3Path?: S3Path;
236
+ Description?: string | undefined;
237
+ RoleArn?: string | undefined;
238
+ SourceS3Path?: S3Path | undefined;
233
239
  }
234
240
  export interface Facet {
235
- DocumentAttributeKey?: string;
236
- Facets?: Facet[];
237
- MaxResults?: number;
241
+ DocumentAttributeKey?: string | undefined;
242
+ Facets?: Facet[] | undefined;
243
+ MaxResults?: number | undefined;
238
244
  }
239
245
  export interface DocumentAttributeValueCountPair {
240
- DocumentAttributeValue?: DocumentAttributeValue;
241
- Count?: number;
242
- FacetResults?: FacetResult[];
246
+ DocumentAttributeValue?: DocumentAttributeValue | undefined;
247
+ Count?: number | undefined;
248
+ FacetResults?: FacetResult[] | undefined;
243
249
  }
244
250
  export interface FacetResult {
245
- DocumentAttributeKey?: string;
246
- DocumentAttributeValueType?: DocumentAttributeValueType;
247
- DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
251
+ DocumentAttributeKey?: string | undefined;
252
+ DocumentAttributeValueType?: DocumentAttributeValueType | undefined;
253
+ DocumentAttributeValueCountPairs?:
254
+ | DocumentAttributeValueCountPair[]
255
+ | undefined;
248
256
  }
249
257
  export interface AttributeFilter {
250
- AndAllFilters?: AttributeFilter[];
251
- OrAllFilters?: AttributeFilter[];
252
- NotFilter?: AttributeFilter;
253
- EqualsTo?: DocumentAttribute;
254
- ContainsAll?: DocumentAttribute;
255
- ContainsAny?: DocumentAttribute;
256
- GreaterThan?: DocumentAttribute;
257
- GreaterThanOrEquals?: DocumentAttribute;
258
- LessThan?: DocumentAttribute;
259
- LessThanOrEquals?: DocumentAttribute;
258
+ AndAllFilters?: AttributeFilter[] | undefined;
259
+ OrAllFilters?: AttributeFilter[] | undefined;
260
+ NotFilter?: AttributeFilter | undefined;
261
+ EqualsTo?: DocumentAttribute | undefined;
262
+ ContainsAll?: DocumentAttribute | undefined;
263
+ ContainsAny?: DocumentAttribute | undefined;
264
+ GreaterThan?: DocumentAttribute | undefined;
265
+ GreaterThanOrEquals?: DocumentAttribute | undefined;
266
+ LessThan?: DocumentAttribute | undefined;
267
+ LessThanOrEquals?: DocumentAttribute | undefined;
260
268
  }
261
269
  export interface QueryResult {
262
- QueryId?: string;
263
- ResultItems?: QueryResultItem[];
264
- FacetResults?: FacetResult[];
265
- TotalNumberOfResults?: number;
266
- Warnings?: Warning[];
267
- SpellCorrectedQueries?: SpellCorrectedQuery[];
268
- FeaturedResultsItems?: FeaturedResultsItem[];
270
+ QueryId?: string | undefined;
271
+ ResultItems?: QueryResultItem[] | undefined;
272
+ FacetResults?: FacetResult[] | undefined;
273
+ TotalNumberOfResults?: number | undefined;
274
+ Warnings?: Warning[] | undefined;
275
+ SpellCorrectedQueries?: SpellCorrectedQuery[] | undefined;
276
+ FeaturedResultsItems?: FeaturedResultsItem[] | undefined;
269
277
  }
270
278
  export interface AttributeSuggestionsGetConfig {
271
- SuggestionAttributes?: string[];
272
- AdditionalResponseAttributes?: string[];
273
- AttributeFilter?: AttributeFilter;
274
- UserContext?: UserContext;
279
+ SuggestionAttributes?: string[] | undefined;
280
+ AdditionalResponseAttributes?: string[] | undefined;
281
+ AttributeFilter?: AttributeFilter | undefined;
282
+ UserContext?: UserContext | undefined;
275
283
  }
276
284
  export interface RetrieveRequest {
277
285
  IndexId: string | undefined;
278
286
  QueryText: string | undefined;
279
- AttributeFilter?: AttributeFilter;
280
- RequestedDocumentAttributes?: string[];
281
- DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
282
- PageNumber?: number;
283
- PageSize?: number;
284
- UserContext?: UserContext;
287
+ AttributeFilter?: AttributeFilter | undefined;
288
+ RequestedDocumentAttributes?: string[] | undefined;
289
+ DocumentRelevanceOverrideConfigurations?:
290
+ | DocumentRelevanceConfiguration[]
291
+ | undefined;
292
+ PageNumber?: number | undefined;
293
+ PageSize?: number | undefined;
294
+ UserContext?: UserContext | undefined;
285
295
  }
286
296
  export interface GetQuerySuggestionsRequest {
287
297
  IndexId: string | undefined;
288
298
  QueryText: string | undefined;
289
- MaxSuggestionsCount?: number;
290
- SuggestionTypes?: SuggestionType[];
291
- AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig;
299
+ MaxSuggestionsCount?: number | undefined;
300
+ SuggestionTypes?: SuggestionType[] | undefined;
301
+ AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig | undefined;
292
302
  }
293
303
  export interface QueryRequest {
294
304
  IndexId: string | undefined;
295
- QueryText?: string;
296
- AttributeFilter?: AttributeFilter;
297
- Facets?: Facet[];
298
- RequestedDocumentAttributes?: string[];
299
- QueryResultTypeFilter?: QueryResultType;
300
- DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
301
- PageNumber?: number;
302
- PageSize?: number;
303
- SortingConfiguration?: SortingConfiguration;
304
- SortingConfigurations?: SortingConfiguration[];
305
- UserContext?: UserContext;
306
- VisitorId?: string;
307
- SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
308
- CollapseConfiguration?: CollapseConfiguration;
305
+ QueryText?: string | undefined;
306
+ AttributeFilter?: AttributeFilter | undefined;
307
+ Facets?: Facet[] | undefined;
308
+ RequestedDocumentAttributes?: string[] | undefined;
309
+ QueryResultTypeFilter?: QueryResultType | undefined;
310
+ DocumentRelevanceOverrideConfigurations?:
311
+ | DocumentRelevanceConfiguration[]
312
+ | undefined;
313
+ PageNumber?: number | undefined;
314
+ PageSize?: number | undefined;
315
+ SortingConfiguration?: SortingConfiguration | undefined;
316
+ SortingConfigurations?: SortingConfiguration[] | undefined;
317
+ UserContext?: UserContext | undefined;
318
+ VisitorId?: string | undefined;
319
+ SpellCorrectionConfiguration?: SpellCorrectionConfiguration | undefined;
320
+ CollapseConfiguration?: CollapseConfiguration | undefined;
309
321
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kendra",
3
3
  "description": "AWS SDK for JavaScript Kendra Client for Node.js, Browser and React Native",
4
- "version": "3.686.0",
4
+ "version": "3.691.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-kendra",
@@ -20,19 +20,19 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.686.0",
24
- "@aws-sdk/client-sts": "3.686.0",
25
- "@aws-sdk/core": "3.686.0",
26
- "@aws-sdk/credential-provider-node": "3.686.0",
23
+ "@aws-sdk/client-sso-oidc": "3.691.0",
24
+ "@aws-sdk/client-sts": "3.691.0",
25
+ "@aws-sdk/core": "3.691.0",
26
+ "@aws-sdk/credential-provider-node": "3.691.0",
27
27
  "@aws-sdk/middleware-host-header": "3.686.0",
28
28
  "@aws-sdk/middleware-logger": "3.686.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.686.0",
30
- "@aws-sdk/middleware-user-agent": "3.686.0",
30
+ "@aws-sdk/middleware-user-agent": "3.691.0",
31
31
  "@aws-sdk/region-config-resolver": "3.686.0",
32
32
  "@aws-sdk/types": "3.686.0",
33
33
  "@aws-sdk/util-endpoints": "3.686.0",
34
34
  "@aws-sdk/util-user-agent-browser": "3.686.0",
35
- "@aws-sdk/util-user-agent-node": "3.686.0",
35
+ "@aws-sdk/util-user-agent-node": "3.691.0",
36
36
  "@smithy/config-resolver": "^3.0.10",
37
37
  "@smithy/core": "^2.5.1",
38
38
  "@smithy/fetch-http-handler": "^4.0.0",