@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.
- package/dist-types/models/models_0.d.ts +673 -673
- package/dist-types/models/models_1.d.ts +139 -139
- package/dist-types/ts3.4/models/models_0.d.ts +721 -673
- package/dist-types/ts3.4/models/models_1.d.ts +151 -139
- package/package.json +7 -7
|
@@ -26,7 +26,7 @@ export interface ScoreAttributes {
|
|
|
26
26
|
* <p>A relative ranking for how relevant the response is to the query.</p>
|
|
27
27
|
* @public
|
|
28
28
|
*/
|
|
29
|
-
ScoreConfidence?: ScoreConfidence;
|
|
29
|
+
ScoreConfidence?: ScoreConfidence | undefined;
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
32
|
* <p>Provides information about a table cell in a table excerpt.</p>
|
|
@@ -38,7 +38,7 @@ export interface TableCell {
|
|
|
38
38
|
* value of a year, or a string value of text, for example.</p>
|
|
39
39
|
* @public
|
|
40
40
|
*/
|
|
41
|
-
Value?: string;
|
|
41
|
+
Value?: string | undefined;
|
|
42
42
|
/**
|
|
43
43
|
* <p>
|
|
44
44
|
* <code>TRUE</code> if the response of the table cell is the top answer. This is the
|
|
@@ -46,20 +46,20 @@ export interface TableCell {
|
|
|
46
46
|
* query.</p>
|
|
47
47
|
* @public
|
|
48
48
|
*/
|
|
49
|
-
TopAnswer?: boolean;
|
|
49
|
+
TopAnswer?: boolean | undefined;
|
|
50
50
|
/**
|
|
51
51
|
* <p>
|
|
52
52
|
* <code>TRUE</code> means that the table cell has a high enough confidence and is
|
|
53
53
|
* relevant to the query, so the value or content should be highlighted.</p>
|
|
54
54
|
* @public
|
|
55
55
|
*/
|
|
56
|
-
Highlighted?: boolean;
|
|
56
|
+
Highlighted?: boolean | undefined;
|
|
57
57
|
/**
|
|
58
58
|
* <p>
|
|
59
59
|
* <code>TRUE</code> means that the table cell should be treated as a header.</p>
|
|
60
60
|
* @public
|
|
61
61
|
*/
|
|
62
|
-
Header?: boolean;
|
|
62
|
+
Header?: boolean | undefined;
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
65
|
* <p>Information about a row in a table excerpt.</p>
|
|
@@ -70,7 +70,7 @@ export interface TableRow {
|
|
|
70
70
|
* <p>A list of table cells in a row.</p>
|
|
71
71
|
* @public
|
|
72
72
|
*/
|
|
73
|
-
Cells?: TableCell[];
|
|
73
|
+
Cells?: TableCell[] | undefined;
|
|
74
74
|
}
|
|
75
75
|
/**
|
|
76
76
|
* <p>An excerpt from a table within a document. The table excerpt displays up to five
|
|
@@ -84,12 +84,12 @@ export interface TableExcerpt {
|
|
|
84
84
|
* <p>A list of rows in the table excerpt.</p>
|
|
85
85
|
* @public
|
|
86
86
|
*/
|
|
87
|
-
Rows?: TableRow[];
|
|
87
|
+
Rows?: TableRow[] | undefined;
|
|
88
88
|
/**
|
|
89
89
|
* <p>A count of the number of rows in the original table within the document.</p>
|
|
90
90
|
* @public
|
|
91
91
|
*/
|
|
92
|
-
TotalNumberOfRows?: number;
|
|
92
|
+
TotalNumberOfRows?: number | undefined;
|
|
93
93
|
}
|
|
94
94
|
/**
|
|
95
95
|
* <p>A single query result.</p>
|
|
@@ -105,13 +105,13 @@ export interface QueryResultItem {
|
|
|
105
105
|
* with every request, even when you have the same documents.</p>
|
|
106
106
|
* @public
|
|
107
107
|
*/
|
|
108
|
-
Id?: string;
|
|
108
|
+
Id?: string | undefined;
|
|
109
109
|
/**
|
|
110
110
|
* <p>The type of document within the response. For example, a response could include a
|
|
111
111
|
* question-answer that's relevant to the query.</p>
|
|
112
112
|
* @public
|
|
113
113
|
*/
|
|
114
|
-
Type?: QueryResultType;
|
|
114
|
+
Type?: QueryResultType | undefined;
|
|
115
115
|
/**
|
|
116
116
|
* <p>If the <code>Type</code> of document within the response is <code>ANSWER</code>, then it
|
|
117
117
|
* is either a <code>TABLE</code> answer or <code>TEXT</code> answer. If it's a table answer,
|
|
@@ -119,41 +119,41 @@ export interface QueryResultItem {
|
|
|
119
119
|
* excerpt is returned in <code>DocumentExcerpt</code>.</p>
|
|
120
120
|
* @public
|
|
121
121
|
*/
|
|
122
|
-
Format?: QueryResultFormat;
|
|
122
|
+
Format?: QueryResultFormat | undefined;
|
|
123
123
|
/**
|
|
124
124
|
* <p>One or more additional fields/attributes associated with the query result.</p>
|
|
125
125
|
* @public
|
|
126
126
|
*/
|
|
127
|
-
AdditionalAttributes?: AdditionalResultAttribute[];
|
|
127
|
+
AdditionalAttributes?: AdditionalResultAttribute[] | undefined;
|
|
128
128
|
/**
|
|
129
129
|
* <p>The identifier for the document.</p>
|
|
130
130
|
* @public
|
|
131
131
|
*/
|
|
132
|
-
DocumentId?: string;
|
|
132
|
+
DocumentId?: string | undefined;
|
|
133
133
|
/**
|
|
134
134
|
* <p>The title of the document. Contains the text of the title and information for
|
|
135
135
|
* highlighting the relevant terms in the title.</p>
|
|
136
136
|
* @public
|
|
137
137
|
*/
|
|
138
|
-
DocumentTitle?: TextWithHighlights;
|
|
138
|
+
DocumentTitle?: TextWithHighlights | undefined;
|
|
139
139
|
/**
|
|
140
140
|
* <p>An extract of the text in the document. Contains information about highlighting the
|
|
141
141
|
* relevant terms in the excerpt.</p>
|
|
142
142
|
* @public
|
|
143
143
|
*/
|
|
144
|
-
DocumentExcerpt?: TextWithHighlights;
|
|
144
|
+
DocumentExcerpt?: TextWithHighlights | undefined;
|
|
145
145
|
/**
|
|
146
146
|
* <p>The URI of the original location of the document.</p>
|
|
147
147
|
* @public
|
|
148
148
|
*/
|
|
149
|
-
DocumentURI?: string;
|
|
149
|
+
DocumentURI?: string | undefined;
|
|
150
150
|
/**
|
|
151
151
|
* <p>An array of document fields/attributes assigned to a document in the search results. For
|
|
152
152
|
* example, the document author (<code>_author</code>) or the source URI
|
|
153
153
|
* (<code>_source_uri</code>) of the document.</p>
|
|
154
154
|
* @public
|
|
155
155
|
*/
|
|
156
|
-
DocumentAttributes?: DocumentAttribute[];
|
|
156
|
+
DocumentAttributes?: DocumentAttribute[] | undefined;
|
|
157
157
|
/**
|
|
158
158
|
* <p>Indicates the confidence level of Amazon Kendra providing a relevant result for the
|
|
159
159
|
* query. Each result is placed into a bin that indicates the confidence,
|
|
@@ -165,24 +165,24 @@ export interface QueryResultItem {
|
|
|
165
165
|
* relevant to the query.</p>
|
|
166
166
|
* @public
|
|
167
167
|
*/
|
|
168
|
-
ScoreAttributes?: ScoreAttributes;
|
|
168
|
+
ScoreAttributes?: ScoreAttributes | undefined;
|
|
169
169
|
/**
|
|
170
170
|
* <p>A token that identifies a particular result from a particular query. Use this token to
|
|
171
171
|
* provide click-through feedback for the result. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html">Submitting
|
|
172
172
|
* feedback</a>.</p>
|
|
173
173
|
* @public
|
|
174
174
|
*/
|
|
175
|
-
FeedbackToken?: string;
|
|
175
|
+
FeedbackToken?: string | undefined;
|
|
176
176
|
/**
|
|
177
177
|
* <p>An excerpt from a table within a document.</p>
|
|
178
178
|
* @public
|
|
179
179
|
*/
|
|
180
|
-
TableExcerpt?: TableExcerpt;
|
|
180
|
+
TableExcerpt?: TableExcerpt | undefined;
|
|
181
181
|
/**
|
|
182
182
|
* <p>Provides details about a collapsed group of search results.</p>
|
|
183
183
|
* @public
|
|
184
184
|
*/
|
|
185
|
-
CollapsedResultDetail?: CollapsedResultDetail;
|
|
185
|
+
CollapsedResultDetail?: CollapsedResultDetail | undefined;
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
188
|
* <p>A corrected misspelled word in a query.</p>
|
|
@@ -194,23 +194,23 @@ export interface Correction {
|
|
|
194
194
|
* the corrected word starts.</p>
|
|
195
195
|
* @public
|
|
196
196
|
*/
|
|
197
|
-
BeginOffset?: number;
|
|
197
|
+
BeginOffset?: number | undefined;
|
|
198
198
|
/**
|
|
199
199
|
* <p>The zero-based location in the response string or text where
|
|
200
200
|
* the corrected word ends.</p>
|
|
201
201
|
* @public
|
|
202
202
|
*/
|
|
203
|
-
EndOffset?: number;
|
|
203
|
+
EndOffset?: number | undefined;
|
|
204
204
|
/**
|
|
205
205
|
* <p>The string or text of a misspelled word in a query.</p>
|
|
206
206
|
* @public
|
|
207
207
|
*/
|
|
208
|
-
Term?: string;
|
|
208
|
+
Term?: string | undefined;
|
|
209
209
|
/**
|
|
210
210
|
* <p>The string or text of a corrected misspelled word in a query.</p>
|
|
211
211
|
* @public
|
|
212
212
|
*/
|
|
213
|
-
CorrectedTerm?: string;
|
|
213
|
+
CorrectedTerm?: string | undefined;
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
216
|
* <p>A query with suggested spell corrections. </p>
|
|
@@ -221,12 +221,12 @@ export interface SpellCorrectedQuery {
|
|
|
221
221
|
* <p>The query with the suggested spell corrections.</p>
|
|
222
222
|
* @public
|
|
223
223
|
*/
|
|
224
|
-
SuggestedQueryText?: string;
|
|
224
|
+
SuggestedQueryText?: string | undefined;
|
|
225
225
|
/**
|
|
226
226
|
* <p>The corrected misspelled word or words in a query.</p>
|
|
227
227
|
* @public
|
|
228
228
|
*/
|
|
229
|
-
Corrections?: Correction[];
|
|
229
|
+
Corrections?: Correction[] | undefined;
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
232
|
* @public
|
|
@@ -248,12 +248,12 @@ export interface Warning {
|
|
|
248
248
|
* <p>The message that explains the problem with the query.</p>
|
|
249
249
|
* @public
|
|
250
250
|
*/
|
|
251
|
-
Message?: string;
|
|
251
|
+
Message?: string | undefined;
|
|
252
252
|
/**
|
|
253
253
|
* <p>The code used to show the type of warning for the query.</p>
|
|
254
254
|
* @public
|
|
255
255
|
*/
|
|
256
|
-
Code?: WarningCode;
|
|
256
|
+
Code?: WarningCode | undefined;
|
|
257
257
|
}
|
|
258
258
|
/**
|
|
259
259
|
* <p>A single retrieved relevant passage result.</p>
|
|
@@ -264,41 +264,41 @@ export interface RetrieveResultItem {
|
|
|
264
264
|
* <p>The identifier of the relevant passage result.</p>
|
|
265
265
|
* @public
|
|
266
266
|
*/
|
|
267
|
-
Id?: string;
|
|
267
|
+
Id?: string | undefined;
|
|
268
268
|
/**
|
|
269
269
|
* <p>The identifier of the document.</p>
|
|
270
270
|
* @public
|
|
271
271
|
*/
|
|
272
|
-
DocumentId?: string;
|
|
272
|
+
DocumentId?: string | undefined;
|
|
273
273
|
/**
|
|
274
274
|
* <p>The title of the document.</p>
|
|
275
275
|
* @public
|
|
276
276
|
*/
|
|
277
|
-
DocumentTitle?: string;
|
|
277
|
+
DocumentTitle?: string | undefined;
|
|
278
278
|
/**
|
|
279
279
|
* <p>The contents of the relevant passage.</p>
|
|
280
280
|
* @public
|
|
281
281
|
*/
|
|
282
|
-
Content?: string;
|
|
282
|
+
Content?: string | undefined;
|
|
283
283
|
/**
|
|
284
284
|
* <p>The URI of the original location of the document.</p>
|
|
285
285
|
* @public
|
|
286
286
|
*/
|
|
287
|
-
DocumentURI?: string;
|
|
287
|
+
DocumentURI?: string | undefined;
|
|
288
288
|
/**
|
|
289
289
|
* <p>An array of document fields/attributes assigned to a document in the search results.
|
|
290
290
|
* For example, the document author (<code>_author</code>) or the source URI
|
|
291
291
|
* (<code>_source_uri</code>) of the document.</p>
|
|
292
292
|
* @public
|
|
293
293
|
*/
|
|
294
|
-
DocumentAttributes?: DocumentAttribute[];
|
|
294
|
+
DocumentAttributes?: DocumentAttribute[] | undefined;
|
|
295
295
|
/**
|
|
296
296
|
* <p>The confidence score bucket for a retrieved passage result. The confidence bucket
|
|
297
297
|
* provides a relative ranking that indicates how confident Amazon Kendra is that the
|
|
298
298
|
* response is relevant to the query.</p>
|
|
299
299
|
* @public
|
|
300
300
|
*/
|
|
301
|
-
ScoreAttributes?: ScoreAttributes;
|
|
301
|
+
ScoreAttributes?: ScoreAttributes | undefined;
|
|
302
302
|
}
|
|
303
303
|
/**
|
|
304
304
|
* @public
|
|
@@ -310,12 +310,12 @@ export interface RetrieveResult {
|
|
|
310
310
|
* API.</p>
|
|
311
311
|
* @public
|
|
312
312
|
*/
|
|
313
|
-
QueryId?: string;
|
|
313
|
+
QueryId?: string | undefined;
|
|
314
314
|
/**
|
|
315
315
|
* <p>The results of the retrieved relevant passages for the search.</p>
|
|
316
316
|
* @public
|
|
317
317
|
*/
|
|
318
|
-
ResultItems?: RetrieveResultItem[];
|
|
318
|
+
ResultItems?: RetrieveResultItem[] | undefined;
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
321
|
* <p>The resource you want to use is currently in use. Please check you have provided the
|
|
@@ -325,7 +325,7 @@ export interface RetrieveResult {
|
|
|
325
325
|
export declare class ResourceInUseException extends __BaseException {
|
|
326
326
|
readonly name: "ResourceInUseException";
|
|
327
327
|
readonly $fault: "client";
|
|
328
|
-
Message?: string;
|
|
328
|
+
Message?: string | undefined;
|
|
329
329
|
/**
|
|
330
330
|
* @internal
|
|
331
331
|
*/
|
|
@@ -354,7 +354,7 @@ export interface StartDataSourceSyncJobResponse {
|
|
|
354
354
|
* <p>Identifies a particular synchronization job.</p>
|
|
355
355
|
* @public
|
|
356
356
|
*/
|
|
357
|
-
ExecutionId?: string;
|
|
357
|
+
ExecutionId?: string | undefined;
|
|
358
358
|
}
|
|
359
359
|
/**
|
|
360
360
|
* @public
|
|
@@ -441,13 +441,13 @@ export interface SubmitFeedbackRequest {
|
|
|
441
441
|
* by the user. </p>
|
|
442
442
|
* @public
|
|
443
443
|
*/
|
|
444
|
-
ClickFeedbackItems?: ClickFeedback[];
|
|
444
|
+
ClickFeedbackItems?: ClickFeedback[] | undefined;
|
|
445
445
|
/**
|
|
446
446
|
* <p>Provides Amazon Kendra with relevant or not relevant feedback for
|
|
447
447
|
* whether a particular item was relevant to the search.</p>
|
|
448
448
|
* @public
|
|
449
449
|
*/
|
|
450
|
-
RelevanceFeedbackItems?: RelevanceFeedback[];
|
|
450
|
+
RelevanceFeedbackItems?: RelevanceFeedback[] | undefined;
|
|
451
451
|
}
|
|
452
452
|
/**
|
|
453
453
|
* @public
|
|
@@ -510,25 +510,25 @@ export interface UpdateAccessControlConfigurationRequest {
|
|
|
510
510
|
* <p>A new name for the access control configuration.</p>
|
|
511
511
|
* @public
|
|
512
512
|
*/
|
|
513
|
-
Name?: string;
|
|
513
|
+
Name?: string | undefined;
|
|
514
514
|
/**
|
|
515
515
|
* <p>A new description for the access control configuration.</p>
|
|
516
516
|
* @public
|
|
517
517
|
*/
|
|
518
|
-
Description?: string;
|
|
518
|
+
Description?: string | undefined;
|
|
519
519
|
/**
|
|
520
520
|
* <p>Information you want to update on principals (users and/or groups) and which documents
|
|
521
521
|
* they should have access to. This is useful for user context filtering, where search
|
|
522
522
|
* results are filtered based on the user or their group access to documents.</p>
|
|
523
523
|
* @public
|
|
524
524
|
*/
|
|
525
|
-
AccessControlList?: Principal[];
|
|
525
|
+
AccessControlList?: Principal[] | undefined;
|
|
526
526
|
/**
|
|
527
527
|
* <p>The updated list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the
|
|
528
528
|
* hierarchy for which documents users should have access to.</p>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
|
-
HierarchicalAccessControlList?: HierarchicalPrincipal[];
|
|
531
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined;
|
|
532
532
|
}
|
|
533
533
|
/**
|
|
534
534
|
* @public
|
|
@@ -548,7 +548,7 @@ export interface UpdateDataSourceRequest {
|
|
|
548
548
|
* <p>A new name for the data source connector.</p>
|
|
549
549
|
* @public
|
|
550
550
|
*/
|
|
551
|
-
Name?: string;
|
|
551
|
+
Name?: string | undefined;
|
|
552
552
|
/**
|
|
553
553
|
* <p>The identifier of the index used with the data source connector.</p>
|
|
554
554
|
* @public
|
|
@@ -558,29 +558,29 @@ export interface UpdateDataSourceRequest {
|
|
|
558
558
|
* <p>Configuration information you want to update for the data source connector.</p>
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
|
-
Configuration?: DataSourceConfiguration;
|
|
561
|
+
Configuration?: DataSourceConfiguration | undefined;
|
|
562
562
|
/**
|
|
563
563
|
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
|
|
564
564
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
565
565
|
* @public
|
|
566
566
|
*/
|
|
567
|
-
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
567
|
+
VpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
568
568
|
/**
|
|
569
569
|
* <p>A new description for the data source connector.</p>
|
|
570
570
|
* @public
|
|
571
571
|
*/
|
|
572
|
-
Description?: string;
|
|
572
|
+
Description?: string | undefined;
|
|
573
573
|
/**
|
|
574
574
|
* <p>The sync schedule you want to update for the data source connector.</p>
|
|
575
575
|
* @public
|
|
576
576
|
*/
|
|
577
|
-
Schedule?: string;
|
|
577
|
+
Schedule?: string | undefined;
|
|
578
578
|
/**
|
|
579
579
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access the data source and
|
|
580
580
|
* required resources. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
581
581
|
* @public
|
|
582
582
|
*/
|
|
583
|
-
RoleArn?: string;
|
|
583
|
+
RoleArn?: string | undefined;
|
|
584
584
|
/**
|
|
585
585
|
* <p>The code for a language you want to update for the data source connector.
|
|
586
586
|
* This allows you to support a language for all
|
|
@@ -590,7 +590,7 @@ export interface UpdateDataSourceRequest {
|
|
|
590
590
|
* documents in languages other than English</a>.</p>
|
|
591
591
|
* @public
|
|
592
592
|
*/
|
|
593
|
-
LanguageCode?: string;
|
|
593
|
+
LanguageCode?: string | undefined;
|
|
594
594
|
/**
|
|
595
595
|
* <p>Configuration information you want to update for altering document metadata and
|
|
596
596
|
* content during the document ingestion process.</p>
|
|
@@ -598,7 +598,7 @@ export interface UpdateDataSourceRequest {
|
|
|
598
598
|
* other content alterations when you ingest documents into Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing document metadata during the ingestion process</a>.</p>
|
|
599
599
|
* @public
|
|
600
600
|
*/
|
|
601
|
-
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration;
|
|
601
|
+
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined;
|
|
602
602
|
}
|
|
603
603
|
/**
|
|
604
604
|
* @public
|
|
@@ -613,7 +613,7 @@ export interface UpdateExperienceRequest {
|
|
|
613
613
|
* <p>A new name for your Amazon Kendra experience.</p>
|
|
614
614
|
* @public
|
|
615
615
|
*/
|
|
616
|
-
Name?: string;
|
|
616
|
+
Name?: string | undefined;
|
|
617
617
|
/**
|
|
618
618
|
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
619
619
|
* @public
|
|
@@ -626,17 +626,17 @@ export interface UpdateExperienceRequest {
|
|
|
626
626
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
627
627
|
* @public
|
|
628
628
|
*/
|
|
629
|
-
RoleArn?: string;
|
|
629
|
+
RoleArn?: string | undefined;
|
|
630
630
|
/**
|
|
631
631
|
* <p>Configuration information you want to update for your Amazon Kendra experience.</p>
|
|
632
632
|
* @public
|
|
633
633
|
*/
|
|
634
|
-
Configuration?: ExperienceConfiguration;
|
|
634
|
+
Configuration?: ExperienceConfiguration | undefined;
|
|
635
635
|
/**
|
|
636
636
|
* <p>A new description for your Amazon Kendra experience.</p>
|
|
637
637
|
* @public
|
|
638
638
|
*/
|
|
639
|
-
Description?: string;
|
|
639
|
+
Description?: string | undefined;
|
|
640
640
|
}
|
|
641
641
|
/**
|
|
642
642
|
* @public
|
|
@@ -656,12 +656,12 @@ export interface UpdateFeaturedResultsSetRequest {
|
|
|
656
656
|
* <p>A new name for the set of featured results.</p>
|
|
657
657
|
* @public
|
|
658
658
|
*/
|
|
659
|
-
FeaturedResultsSetName?: string;
|
|
659
|
+
FeaturedResultsSetName?: string | undefined;
|
|
660
660
|
/**
|
|
661
661
|
* <p>A new description for the set of featured results.</p>
|
|
662
662
|
* @public
|
|
663
663
|
*/
|
|
664
|
-
Description?: string;
|
|
664
|
+
Description?: string | undefined;
|
|
665
665
|
/**
|
|
666
666
|
* <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>.
|
|
667
667
|
* When the value is <code>ACTIVE</code>, featured results are ready for
|
|
@@ -671,20 +671,20 @@ export interface UpdateFeaturedResultsSetRequest {
|
|
|
671
671
|
* status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
672
672
|
* @public
|
|
673
673
|
*/
|
|
674
|
-
Status?: FeaturedResultsSetStatus;
|
|
674
|
+
Status?: FeaturedResultsSetStatus | undefined;
|
|
675
675
|
/**
|
|
676
676
|
* <p>A list of queries for featuring results. For more information on the
|
|
677
677
|
* list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
|
|
678
678
|
* @public
|
|
679
679
|
*/
|
|
680
|
-
QueryTexts?: string[];
|
|
680
|
+
QueryTexts?: string[] | undefined;
|
|
681
681
|
/**
|
|
682
682
|
* <p>A list of document IDs for the documents you want to feature at the
|
|
683
683
|
* top of the search results page. For more information on the list of
|
|
684
684
|
* featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
|
|
685
685
|
* @public
|
|
686
686
|
*/
|
|
687
|
-
FeaturedDocuments?: FeaturedDocument[];
|
|
687
|
+
FeaturedDocuments?: FeaturedDocument[] | undefined;
|
|
688
688
|
}
|
|
689
689
|
/**
|
|
690
690
|
* @public
|
|
@@ -696,7 +696,7 @@ export interface UpdateFeaturedResultsSetResponse {
|
|
|
696
696
|
* or inactive, when the featured results set was last updated, and more.</p>
|
|
697
697
|
* @public
|
|
698
698
|
*/
|
|
699
|
-
FeaturedResultsSet?: FeaturedResultsSet;
|
|
699
|
+
FeaturedResultsSet?: FeaturedResultsSet | undefined;
|
|
700
700
|
}
|
|
701
701
|
/**
|
|
702
702
|
* @public
|
|
@@ -711,25 +711,25 @@ export interface UpdateIndexRequest {
|
|
|
711
711
|
* <p>A new name for the index.</p>
|
|
712
712
|
* @public
|
|
713
713
|
*/
|
|
714
|
-
Name?: string;
|
|
714
|
+
Name?: string | undefined;
|
|
715
715
|
/**
|
|
716
716
|
* <p>An Identity and Access Management (IAM) role that gives Amazon Kendra
|
|
717
717
|
* permission to access Amazon CloudWatch logs and metrics.</p>
|
|
718
718
|
* @public
|
|
719
719
|
*/
|
|
720
|
-
RoleArn?: string;
|
|
720
|
+
RoleArn?: string | undefined;
|
|
721
721
|
/**
|
|
722
722
|
* <p>A new description for the index.</p>
|
|
723
723
|
* @public
|
|
724
724
|
*/
|
|
725
|
-
Description?: string;
|
|
725
|
+
Description?: string | undefined;
|
|
726
726
|
/**
|
|
727
727
|
* <p>The document metadata configuration you want to update for the index. Document metadata
|
|
728
728
|
* are fields or attributes associated with your documents. For example, the company department
|
|
729
729
|
* name associated with each document.</p>
|
|
730
730
|
* @public
|
|
731
731
|
*/
|
|
732
|
-
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
732
|
+
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[] | undefined;
|
|
733
733
|
/**
|
|
734
734
|
* <p>Sets the number of additional document storage and query capacity units that should be
|
|
735
735
|
* used by the index. You can change the capacity of the index up to 5 times per day, or make 5
|
|
@@ -738,24 +738,24 @@ export interface UpdateIndexRequest {
|
|
|
738
738
|
* required to meet the storage needs for your index.</p>
|
|
739
739
|
* @public
|
|
740
740
|
*/
|
|
741
|
-
CapacityUnits?: CapacityUnitsConfiguration;
|
|
741
|
+
CapacityUnits?: CapacityUnitsConfiguration | undefined;
|
|
742
742
|
/**
|
|
743
743
|
* <p>The user token configuration.</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
UserTokenConfigurations?: UserTokenConfiguration[];
|
|
746
|
+
UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>The user context policy.</p>
|
|
749
749
|
* @public
|
|
750
750
|
*/
|
|
751
|
-
UserContextPolicy?: UserContextPolicy;
|
|
751
|
+
UserContextPolicy?: UserContextPolicy | undefined;
|
|
752
752
|
/**
|
|
753
753
|
* <p>Gets users and groups from IAM Identity Center
|
|
754
754
|
* identity source. To configure this, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering, where
|
|
755
755
|
* search results are filtered based on the user or their group access to documents.</p>
|
|
756
756
|
* @public
|
|
757
757
|
*/
|
|
758
|
-
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration;
|
|
758
|
+
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
|
|
759
759
|
}
|
|
760
760
|
/**
|
|
761
761
|
* @public
|
|
@@ -775,12 +775,12 @@ export interface UpdateQuerySuggestionsBlockListRequest {
|
|
|
775
775
|
* <p>A new name for the block list.</p>
|
|
776
776
|
* @public
|
|
777
777
|
*/
|
|
778
|
-
Name?: string;
|
|
778
|
+
Name?: string | undefined;
|
|
779
779
|
/**
|
|
780
780
|
* <p>A new description for the block list.</p>
|
|
781
781
|
* @public
|
|
782
782
|
*/
|
|
783
|
-
Description?: string;
|
|
783
|
+
Description?: string | undefined;
|
|
784
784
|
/**
|
|
785
785
|
* <p>The S3 path where your block list text file sits in S3.</p>
|
|
786
786
|
* <p>If you update your block list and provide the same path to the
|
|
@@ -793,13 +793,13 @@ export interface UpdateQuerySuggestionsBlockListRequest {
|
|
|
793
793
|
* means changes might not take effect immediately.</p>
|
|
794
794
|
* @public
|
|
795
795
|
*/
|
|
796
|
-
SourceS3Path?: S3Path;
|
|
796
|
+
SourceS3Path?: S3Path | undefined;
|
|
797
797
|
/**
|
|
798
798
|
* <p>The IAM (Identity and Access Management) role used to access the
|
|
799
799
|
* block list text file in S3.</p>
|
|
800
800
|
* @public
|
|
801
801
|
*/
|
|
802
|
-
RoleArn?: string;
|
|
802
|
+
RoleArn?: string | undefined;
|
|
803
803
|
}
|
|
804
804
|
/**
|
|
805
805
|
* @public
|
|
@@ -820,14 +820,14 @@ export interface UpdateQuerySuggestionsConfigRequest {
|
|
|
820
820
|
* switch to ENABLED mode again.</p>
|
|
821
821
|
* @public
|
|
822
822
|
*/
|
|
823
|
-
Mode?: Mode;
|
|
823
|
+
Mode?: Mode | undefined;
|
|
824
824
|
/**
|
|
825
825
|
* <p>How recent your queries are in your query log time window.</p>
|
|
826
826
|
* <p>The time window is the number of days from current day to past days.</p>
|
|
827
827
|
* <p>By default, Amazon Kendra sets this to 180.</p>
|
|
828
828
|
* @public
|
|
829
829
|
*/
|
|
830
|
-
QueryLogLookBackWindowInDays?: number;
|
|
830
|
+
QueryLogLookBackWindowInDays?: number | undefined;
|
|
831
831
|
/**
|
|
832
832
|
* <p>
|
|
833
833
|
* <code>TRUE</code> to include queries without user information (i.e. all queries,
|
|
@@ -843,7 +843,7 @@ export interface UpdateQuerySuggestionsConfigRequest {
|
|
|
843
843
|
* from all queries.</p>
|
|
844
844
|
* @public
|
|
845
845
|
*/
|
|
846
|
-
IncludeQueriesWithoutUserInformation?: boolean;
|
|
846
|
+
IncludeQueriesWithoutUserInformation?: boolean | undefined;
|
|
847
847
|
/**
|
|
848
848
|
* <p>The minimum number of unique users who must search a query in order for the query
|
|
849
849
|
* to be eligible to suggest to your users.</p>
|
|
@@ -852,7 +852,7 @@ export interface UpdateQuerySuggestionsConfigRequest {
|
|
|
852
852
|
* <p>How you tune this setting depends on your specific needs.</p>
|
|
853
853
|
* @public
|
|
854
854
|
*/
|
|
855
|
-
MinimumNumberOfQueryingUsers?: number;
|
|
855
|
+
MinimumNumberOfQueryingUsers?: number | undefined;
|
|
856
856
|
/**
|
|
857
857
|
* <p>The the minimum number of times a query must be searched in order to be
|
|
858
858
|
* eligible to suggest to your users.</p>
|
|
@@ -862,13 +862,13 @@ export interface UpdateQuerySuggestionsConfigRequest {
|
|
|
862
862
|
* <p>How you tune this setting depends on your specific needs.</p>
|
|
863
863
|
* @public
|
|
864
864
|
*/
|
|
865
|
-
MinimumQueryCount?: number;
|
|
865
|
+
MinimumQueryCount?: number | undefined;
|
|
866
866
|
/**
|
|
867
867
|
* <p>Configuration information for the document fields/attributes that you want to base
|
|
868
868
|
* query suggestions on.</p>
|
|
869
869
|
* @public
|
|
870
870
|
*/
|
|
871
|
-
AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig;
|
|
871
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig | undefined;
|
|
872
872
|
}
|
|
873
873
|
/**
|
|
874
874
|
* @public
|
|
@@ -883,7 +883,7 @@ export interface UpdateThesaurusRequest {
|
|
|
883
883
|
* <p>A new name for the thesaurus.</p>
|
|
884
884
|
* @public
|
|
885
885
|
*/
|
|
886
|
-
Name?: string;
|
|
886
|
+
Name?: string | undefined;
|
|
887
887
|
/**
|
|
888
888
|
* <p>The identifier of the index for the thesaurus.</p>
|
|
889
889
|
* @public
|
|
@@ -893,18 +893,18 @@ export interface UpdateThesaurusRequest {
|
|
|
893
893
|
* <p>A new description for the thesaurus.</p>
|
|
894
894
|
* @public
|
|
895
895
|
*/
|
|
896
|
-
Description?: string;
|
|
896
|
+
Description?: string | undefined;
|
|
897
897
|
/**
|
|
898
898
|
* <p>An IAM role that gives Amazon Kendra permissions to
|
|
899
899
|
* access thesaurus file specified in <code>SourceS3Path</code>.</p>
|
|
900
900
|
* @public
|
|
901
901
|
*/
|
|
902
|
-
RoleArn?: string;
|
|
902
|
+
RoleArn?: string | undefined;
|
|
903
903
|
/**
|
|
904
904
|
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
905
905
|
* @public
|
|
906
906
|
*/
|
|
907
|
-
SourceS3Path?: S3Path;
|
|
907
|
+
SourceS3Path?: S3Path | undefined;
|
|
908
908
|
}
|
|
909
909
|
/**
|
|
910
910
|
* <p>Information about a document attribute or field. You can use document attributes as
|
|
@@ -921,7 +921,7 @@ export interface Facet {
|
|
|
921
921
|
* <p>The unique key for the document attribute.</p>
|
|
922
922
|
* @public
|
|
923
923
|
*/
|
|
924
|
-
DocumentAttributeKey?: string;
|
|
924
|
+
DocumentAttributeKey?: string | undefined;
|
|
925
925
|
/**
|
|
926
926
|
* <p>An array of document attributes that are nested facets within a facet.</p>
|
|
927
927
|
* <p>For example, the document attribute or facet "Department" includes a value called
|
|
@@ -934,14 +934,14 @@ export interface Facet {
|
|
|
934
934
|
* contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
935
935
|
* @public
|
|
936
936
|
*/
|
|
937
|
-
Facets?: Facet[];
|
|
937
|
+
Facets?: Facet[] | undefined;
|
|
938
938
|
/**
|
|
939
939
|
* <p>Maximum number of facet values per facet. The default is 10. You can use this to limit
|
|
940
940
|
* the number of facet values to less than 10. If you want to increase the default, contact
|
|
941
941
|
* <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
942
942
|
* @public
|
|
943
943
|
*/
|
|
944
|
-
MaxResults?: number;
|
|
944
|
+
MaxResults?: number | undefined;
|
|
945
945
|
}
|
|
946
946
|
/**
|
|
947
947
|
* <p>Provides the count of documents that match a particular document attribute or field when
|
|
@@ -953,13 +953,13 @@ export interface DocumentAttributeValueCountPair {
|
|
|
953
953
|
* <p>The value of the attribute/field. For example, "HR".</p>
|
|
954
954
|
* @public
|
|
955
955
|
*/
|
|
956
|
-
DocumentAttributeValue?: DocumentAttributeValue;
|
|
956
|
+
DocumentAttributeValue?: DocumentAttributeValue | undefined;
|
|
957
957
|
/**
|
|
958
958
|
* <p>The number of documents in the response that have the attribute/field value for the
|
|
959
959
|
* key.</p>
|
|
960
960
|
* @public
|
|
961
961
|
*/
|
|
962
|
-
Count?: number;
|
|
962
|
+
Count?: number | undefined;
|
|
963
963
|
/**
|
|
964
964
|
* <p>Contains the results of a document attribute/field that is a nested facet. A
|
|
965
965
|
* <code>FacetResult</code> contains the counts for each facet nested within a
|
|
@@ -974,7 +974,7 @@ export interface DocumentAttributeValueCountPair {
|
|
|
974
974
|
* <p></p>
|
|
975
975
|
* @public
|
|
976
976
|
*/
|
|
977
|
-
FacetResults?: FacetResult[];
|
|
977
|
+
FacetResults?: FacetResult[] | undefined;
|
|
978
978
|
}
|
|
979
979
|
/**
|
|
980
980
|
* <p>The facet values for the documents in the response.</p>
|
|
@@ -986,19 +986,19 @@ export interface FacetResult {
|
|
|
986
986
|
* provided in the query.</p>
|
|
987
987
|
* @public
|
|
988
988
|
*/
|
|
989
|
-
DocumentAttributeKey?: string;
|
|
989
|
+
DocumentAttributeKey?: string | undefined;
|
|
990
990
|
/**
|
|
991
991
|
* <p>The data type of the facet value. This is the same as the type defined for the index
|
|
992
992
|
* field when it was created.</p>
|
|
993
993
|
* @public
|
|
994
994
|
*/
|
|
995
|
-
DocumentAttributeValueType?: DocumentAttributeValueType;
|
|
995
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | undefined;
|
|
996
996
|
/**
|
|
997
997
|
* <p>An array of key/value pairs, where the key is the value of the attribute and the count
|
|
998
998
|
* is the number of documents that share the key value.</p>
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[];
|
|
1001
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[] | undefined;
|
|
1002
1002
|
}
|
|
1003
1003
|
/**
|
|
1004
1004
|
* <p>Filters the search results based on document attributes or fields.</p>
|
|
@@ -1049,34 +1049,34 @@ export interface AttributeFilter {
|
|
|
1049
1049
|
* <p>Performs a logical <code>AND</code> operation on all filters that you specify.</p>
|
|
1050
1050
|
* @public
|
|
1051
1051
|
*/
|
|
1052
|
-
AndAllFilters?: AttributeFilter[];
|
|
1052
|
+
AndAllFilters?: AttributeFilter[] | undefined;
|
|
1053
1053
|
/**
|
|
1054
1054
|
* <p>Performs a logical <code>OR</code> operation on all filters that you specify.</p>
|
|
1055
1055
|
* @public
|
|
1056
1056
|
*/
|
|
1057
|
-
OrAllFilters?: AttributeFilter[];
|
|
1057
|
+
OrAllFilters?: AttributeFilter[] | undefined;
|
|
1058
1058
|
/**
|
|
1059
1059
|
* <p>Performs a logical <code>NOT</code> operation on all filters that you specify.</p>
|
|
1060
1060
|
* @public
|
|
1061
1061
|
*/
|
|
1062
|
-
NotFilter?: AttributeFilter;
|
|
1062
|
+
NotFilter?: AttributeFilter | undefined;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* <p>Performs an equals operation on document attributes/fields and their values.</p>
|
|
1065
1065
|
* @public
|
|
1066
1066
|
*/
|
|
1067
|
-
EqualsTo?: DocumentAttribute;
|
|
1067
|
+
EqualsTo?: DocumentAttribute | undefined;
|
|
1068
1068
|
/**
|
|
1069
1069
|
* <p>Returns true when a document contains all of the specified document attributes/fields.
|
|
1070
1070
|
* This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
|
|
1071
1071
|
* @public
|
|
1072
1072
|
*/
|
|
1073
|
-
ContainsAll?: DocumentAttribute;
|
|
1073
|
+
ContainsAll?: DocumentAttribute | undefined;
|
|
1074
1074
|
/**
|
|
1075
1075
|
* <p>Returns true when a document contains any of the specified document attributes/fields.
|
|
1076
1076
|
* This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
|
|
1077
1077
|
* @public
|
|
1078
1078
|
*/
|
|
1079
|
-
ContainsAny?: DocumentAttribute;
|
|
1079
|
+
ContainsAny?: DocumentAttribute | undefined;
|
|
1080
1080
|
/**
|
|
1081
1081
|
* <p>Performs a greater than operation on document attributes/fields and their values. Use
|
|
1082
1082
|
* with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
@@ -1084,7 +1084,7 @@ export interface AttributeFilter {
|
|
|
1084
1084
|
* <code>Date</code> or <code>Long</code>.</p>
|
|
1085
1085
|
* @public
|
|
1086
1086
|
*/
|
|
1087
|
-
GreaterThan?: DocumentAttribute;
|
|
1087
|
+
GreaterThan?: DocumentAttribute | undefined;
|
|
1088
1088
|
/**
|
|
1089
1089
|
* <p>Performs a greater or equals than operation on document attributes/fields and their
|
|
1090
1090
|
* values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
@@ -1092,7 +1092,7 @@ export interface AttributeFilter {
|
|
|
1092
1092
|
* <code>Date</code> or <code>Long</code>.</p>
|
|
1093
1093
|
* @public
|
|
1094
1094
|
*/
|
|
1095
|
-
GreaterThanOrEquals?: DocumentAttribute;
|
|
1095
|
+
GreaterThanOrEquals?: DocumentAttribute | undefined;
|
|
1096
1096
|
/**
|
|
1097
1097
|
* <p>Performs a less than operation on document attributes/fields and their values. Use with
|
|
1098
1098
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
@@ -1100,7 +1100,7 @@ export interface AttributeFilter {
|
|
|
1100
1100
|
* <code>Date</code> or <code>Long</code>.</p>
|
|
1101
1101
|
* @public
|
|
1102
1102
|
*/
|
|
1103
|
-
LessThan?: DocumentAttribute;
|
|
1103
|
+
LessThan?: DocumentAttribute | undefined;
|
|
1104
1104
|
/**
|
|
1105
1105
|
* <p>Performs a less than or equals operation on document attributes/fields and their values.
|
|
1106
1106
|
* Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
@@ -1108,7 +1108,7 @@ export interface AttributeFilter {
|
|
|
1108
1108
|
* <code>Date</code> or <code>Long</code>.</p>
|
|
1109
1109
|
* @public
|
|
1110
1110
|
*/
|
|
1111
|
-
LessThanOrEquals?: DocumentAttribute;
|
|
1111
|
+
LessThanOrEquals?: DocumentAttribute | undefined;
|
|
1112
1112
|
}
|
|
1113
1113
|
/**
|
|
1114
1114
|
* @public
|
|
@@ -1120,25 +1120,25 @@ export interface QueryResult {
|
|
|
1120
1120
|
* API.</p>
|
|
1121
1121
|
* @public
|
|
1122
1122
|
*/
|
|
1123
|
-
QueryId?: string;
|
|
1123
|
+
QueryId?: string | undefined;
|
|
1124
1124
|
/**
|
|
1125
1125
|
* <p>The results of the search.</p>
|
|
1126
1126
|
* @public
|
|
1127
1127
|
*/
|
|
1128
|
-
ResultItems?: QueryResultItem[];
|
|
1128
|
+
ResultItems?: QueryResultItem[] | undefined;
|
|
1129
1129
|
/**
|
|
1130
1130
|
* <p>Contains the facet results. A <code>FacetResult</code> contains the counts for each
|
|
1131
1131
|
* field/attribute key that was specified in the <code>Facets</code> input parameter.</p>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
FacetResults?: FacetResult[];
|
|
1134
|
+
FacetResults?: FacetResult[] | undefined;
|
|
1135
1135
|
/**
|
|
1136
1136
|
* <p>The total number of items found by the search. However, you can only retrieve up to 100
|
|
1137
1137
|
* items. For example, if the search found 192 items, you can only retrieve the first 100 of
|
|
1138
1138
|
* the items.</p>
|
|
1139
1139
|
* @public
|
|
1140
1140
|
*/
|
|
1141
|
-
TotalNumberOfResults?: number;
|
|
1141
|
+
TotalNumberOfResults?: number | undefined;
|
|
1142
1142
|
/**
|
|
1143
1143
|
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
1144
1144
|
* <p>Amazon Kendra currently only supports one type of warning, which is a warning on
|
|
@@ -1146,19 +1146,19 @@ export interface QueryResult {
|
|
|
1146
1146
|
* with advanced query syntax</a>.</p>
|
|
1147
1147
|
* @public
|
|
1148
1148
|
*/
|
|
1149
|
-
Warnings?: Warning[];
|
|
1149
|
+
Warnings?: Warning[] | undefined;
|
|
1150
1150
|
/**
|
|
1151
1151
|
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
1152
1152
|
* @public
|
|
1153
1153
|
*/
|
|
1154
|
-
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
1154
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[] | undefined;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* <p>The list of featured result items. Featured results are displayed at the top of the
|
|
1157
1157
|
* search results page, placed above all other results for certain queries. If there's an
|
|
1158
1158
|
* exact match of a query, then certain documents are featured in the search results.</p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
FeaturedResultsItems?: FeaturedResultsItem[];
|
|
1161
|
+
FeaturedResultsItems?: FeaturedResultsItem[] | undefined;
|
|
1162
1162
|
}
|
|
1163
1163
|
/**
|
|
1164
1164
|
* <p>Provides the configuration information for the document fields/attributes that you want
|
|
@@ -1172,25 +1172,25 @@ export interface AttributeSuggestionsGetConfig {
|
|
|
1172
1172
|
* then the field content is returned as a query suggestion.</p>
|
|
1173
1173
|
* @public
|
|
1174
1174
|
*/
|
|
1175
|
-
SuggestionAttributes?: string[];
|
|
1175
|
+
SuggestionAttributes?: string[] | undefined;
|
|
1176
1176
|
/**
|
|
1177
1177
|
* <p>The list of additional document field/attribute keys or field names to include in the
|
|
1178
1178
|
* response. You can use additional fields to provide extra information in the response.
|
|
1179
1179
|
* Additional fields are not used to based suggestions on.</p>
|
|
1180
1180
|
* @public
|
|
1181
1181
|
*/
|
|
1182
|
-
AdditionalResponseAttributes?: string[];
|
|
1182
|
+
AdditionalResponseAttributes?: string[] | undefined;
|
|
1183
1183
|
/**
|
|
1184
1184
|
* <p>Filters the search results based on document fields/attributes.</p>
|
|
1185
1185
|
* @public
|
|
1186
1186
|
*/
|
|
1187
|
-
AttributeFilter?: AttributeFilter;
|
|
1187
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
1188
1188
|
/**
|
|
1189
1189
|
* <p>Applies user context filtering so that only users who are given access to certain
|
|
1190
1190
|
* documents see these document in their search results.</p>
|
|
1191
1191
|
* @public
|
|
1192
1192
|
*/
|
|
1193
|
-
UserContext?: UserContext;
|
|
1193
|
+
UserContext?: UserContext | undefined;
|
|
1194
1194
|
}
|
|
1195
1195
|
/**
|
|
1196
1196
|
* @public
|
|
@@ -1219,14 +1219,14 @@ export interface RetrieveRequest {
|
|
|
1219
1219
|
* rules that a document must satisfy to be included in the query results.</p>
|
|
1220
1220
|
* @public
|
|
1221
1221
|
*/
|
|
1222
|
-
AttributeFilter?: AttributeFilter;
|
|
1222
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
1223
1223
|
/**
|
|
1224
1224
|
* <p>A list of document fields/attributes to include in the response. You can limit the
|
|
1225
1225
|
* response to include certain document fields. By default, all document fields are
|
|
1226
1226
|
* included in the response.</p>
|
|
1227
1227
|
* @public
|
|
1228
1228
|
*/
|
|
1229
|
-
RequestedDocumentAttributes?: string[];
|
|
1229
|
+
RequestedDocumentAttributes?: string[] | undefined;
|
|
1230
1230
|
/**
|
|
1231
1231
|
* <p>Overrides relevance tuning configurations of fields/attributes set at the index
|
|
1232
1232
|
* level.</p>
|
|
@@ -1238,26 +1238,26 @@ export interface RetrieveRequest {
|
|
|
1238
1238
|
* override, the importance is set to 1.</p>
|
|
1239
1239
|
* @public
|
|
1240
1240
|
*/
|
|
1241
|
-
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
1241
|
+
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* <p>Retrieved relevant passages are returned in pages the size of the
|
|
1244
1244
|
* <code>PageSize</code> parameter. By default, Amazon Kendra returns the first
|
|
1245
1245
|
* page of results. Use this parameter to get result pages after the first one.</p>
|
|
1246
1246
|
* @public
|
|
1247
1247
|
*/
|
|
1248
|
-
PageNumber?: number;
|
|
1248
|
+
PageNumber?: number | undefined;
|
|
1249
1249
|
/**
|
|
1250
1250
|
* <p>Sets the number of retrieved relevant passages that are returned in each page of
|
|
1251
1251
|
* results. The default page size is 10. The maximum number of results returned is 100. If
|
|
1252
1252
|
* you ask for more than 100 results, only 100 are returned.</p>
|
|
1253
1253
|
* @public
|
|
1254
1254
|
*/
|
|
1255
|
-
PageSize?: number;
|
|
1255
|
+
PageSize?: number | undefined;
|
|
1256
1256
|
/**
|
|
1257
1257
|
* <p>The user context token or user and group information.</p>
|
|
1258
1258
|
* @public
|
|
1259
1259
|
*/
|
|
1260
|
-
UserContext?: UserContext;
|
|
1260
|
+
UserContext?: UserContext | undefined;
|
|
1261
1261
|
}
|
|
1262
1262
|
/**
|
|
1263
1263
|
* @public
|
|
@@ -1284,7 +1284,7 @@ export interface GetQuerySuggestionsRequest {
|
|
|
1284
1284
|
* to your users.</p>
|
|
1285
1285
|
* @public
|
|
1286
1286
|
*/
|
|
1287
|
-
MaxSuggestionsCount?: number;
|
|
1287
|
+
MaxSuggestionsCount?: number | undefined;
|
|
1288
1288
|
/**
|
|
1289
1289
|
* <p>The suggestions type to base query suggestions on. The suggestion
|
|
1290
1290
|
* types are query history or document fields/attributes. You can set
|
|
@@ -1297,13 +1297,13 @@ export interface GetQuerySuggestionsRequest {
|
|
|
1297
1297
|
* contents of document fields.</p>
|
|
1298
1298
|
* @public
|
|
1299
1299
|
*/
|
|
1300
|
-
SuggestionTypes?: SuggestionType[];
|
|
1300
|
+
SuggestionTypes?: SuggestionType[] | undefined;
|
|
1301
1301
|
/**
|
|
1302
1302
|
* <p>Configuration information for the document fields/attributes that you
|
|
1303
1303
|
* want to base query suggestions on.</p>
|
|
1304
1304
|
* @public
|
|
1305
1305
|
*/
|
|
1306
|
-
AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig;
|
|
1306
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig | undefined;
|
|
1307
1307
|
}
|
|
1308
1308
|
/**
|
|
1309
1309
|
* @public
|
|
@@ -1322,7 +1322,7 @@ export interface QueryRequest {
|
|
|
1322
1322
|
* <code>hr</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching with advanced query syntax</a> in the Amazon Kendra Developer Guide. </p>
|
|
1323
1323
|
* @public
|
|
1324
1324
|
*/
|
|
1325
|
-
QueryText?: string;
|
|
1325
|
+
QueryText?: string | undefined;
|
|
1326
1326
|
/**
|
|
1327
1327
|
* <p>Filters search results by document fields/attributes. You can only provide one attribute
|
|
1328
1328
|
* filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>, and
|
|
@@ -1331,26 +1331,26 @@ export interface QueryRequest {
|
|
|
1331
1331
|
* that a document must satisfy to be included in the query results.</p>
|
|
1332
1332
|
* @public
|
|
1333
1333
|
*/
|
|
1334
|
-
AttributeFilter?: AttributeFilter;
|
|
1334
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
1335
1335
|
/**
|
|
1336
1336
|
* <p>An array of documents fields/attributes for faceted search. Amazon Kendra returns a
|
|
1337
1337
|
* count for each field key specified. This helps your users narrow their search.</p>
|
|
1338
1338
|
* @public
|
|
1339
1339
|
*/
|
|
1340
|
-
Facets?: Facet[];
|
|
1340
|
+
Facets?: Facet[] | undefined;
|
|
1341
1341
|
/**
|
|
1342
1342
|
* <p>An array of document fields/attributes to include in the response. You can limit the
|
|
1343
1343
|
* response to include certain document fields. By default, all document attributes are
|
|
1344
1344
|
* included in the response.</p>
|
|
1345
1345
|
* @public
|
|
1346
1346
|
*/
|
|
1347
|
-
RequestedDocumentAttributes?: string[];
|
|
1347
|
+
RequestedDocumentAttributes?: string[] | undefined;
|
|
1348
1348
|
/**
|
|
1349
1349
|
* <p>Sets the type of query result or response. Only results for the specified type are
|
|
1350
1350
|
* returned.</p>
|
|
1351
1351
|
* @public
|
|
1352
1352
|
*/
|
|
1353
|
-
QueryResultTypeFilter?: QueryResultType;
|
|
1353
|
+
QueryResultTypeFilter?: QueryResultType | undefined;
|
|
1354
1354
|
/**
|
|
1355
1355
|
* <p>Overrides relevance tuning configurations of fields/attributes set at the index
|
|
1356
1356
|
* level.</p>
|
|
@@ -1362,21 +1362,21 @@ export interface QueryRequest {
|
|
|
1362
1362
|
* importance is set to 1.</p>
|
|
1363
1363
|
* @public
|
|
1364
1364
|
*/
|
|
1365
|
-
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
1365
|
+
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined;
|
|
1366
1366
|
/**
|
|
1367
1367
|
* <p>Query results are returned in pages the size of the <code>PageSize</code> parameter. By
|
|
1368
1368
|
* default, Amazon Kendra returns the first page of results. Use this parameter to get
|
|
1369
1369
|
* result pages after the first one.</p>
|
|
1370
1370
|
* @public
|
|
1371
1371
|
*/
|
|
1372
|
-
PageNumber?: number;
|
|
1372
|
+
PageNumber?: number | undefined;
|
|
1373
1373
|
/**
|
|
1374
1374
|
* <p>Sets the number of results that are returned in each page of results. The default page
|
|
1375
1375
|
* size is 10. The maximum number of results returned is 100. If you ask for more than 100
|
|
1376
1376
|
* results, only 100 are returned.</p>
|
|
1377
1377
|
* @public
|
|
1378
1378
|
*/
|
|
1379
|
-
PageSize?: number;
|
|
1379
|
+
PageSize?: number | undefined;
|
|
1380
1380
|
/**
|
|
1381
1381
|
* <p>Provides information that determines how the results of the query are sorted. You can
|
|
1382
1382
|
* set the field that Amazon Kendra should sort the results on, and specify whether the
|
|
@@ -1386,7 +1386,7 @@ export interface QueryRequest {
|
|
|
1386
1386
|
* Amazon Kendra determines for the result.</p>
|
|
1387
1387
|
* @public
|
|
1388
1388
|
*/
|
|
1389
|
-
SortingConfiguration?: SortingConfiguration;
|
|
1389
|
+
SortingConfiguration?: SortingConfiguration | undefined;
|
|
1390
1390
|
/**
|
|
1391
1391
|
* <p>Provides configuration information to determine how the results of a query are
|
|
1392
1392
|
* sorted.</p>
|
|
@@ -1398,29 +1398,29 @@ export interface QueryRequest {
|
|
|
1398
1398
|
* results, the results are sorted by relevance. </p>
|
|
1399
1399
|
* @public
|
|
1400
1400
|
*/
|
|
1401
|
-
SortingConfigurations?: SortingConfiguration[];
|
|
1401
|
+
SortingConfigurations?: SortingConfiguration[] | undefined;
|
|
1402
1402
|
/**
|
|
1403
1403
|
* <p>The user context token or user and group information.</p>
|
|
1404
1404
|
* @public
|
|
1405
1405
|
*/
|
|
1406
|
-
UserContext?: UserContext;
|
|
1406
|
+
UserContext?: UserContext | undefined;
|
|
1407
1407
|
/**
|
|
1408
1408
|
* <p>Provides an identifier for a specific user. The <code>VisitorId</code> should be a
|
|
1409
1409
|
* unique identifier, such as a GUID. Don't use personally identifiable information, such as
|
|
1410
1410
|
* the user's email address, as the <code>VisitorId</code>.</p>
|
|
1411
1411
|
* @public
|
|
1412
1412
|
*/
|
|
1413
|
-
VisitorId?: string;
|
|
1413
|
+
VisitorId?: string | undefined;
|
|
1414
1414
|
/**
|
|
1415
1415
|
* <p>Enables suggested spell corrections for queries.</p>
|
|
1416
1416
|
* @public
|
|
1417
1417
|
*/
|
|
1418
|
-
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
1418
|
+
SpellCorrectionConfiguration?: SpellCorrectionConfiguration | undefined;
|
|
1419
1419
|
/**
|
|
1420
1420
|
* <p>Provides configuration to determine how to group results by document attribute value,
|
|
1421
1421
|
* and how to display them (collapsed or expanded) under a designated primary document for
|
|
1422
1422
|
* each group.</p>
|
|
1423
1423
|
* @public
|
|
1424
1424
|
*/
|
|
1425
|
-
CollapseConfiguration?: CollapseConfiguration;
|
|
1425
|
+
CollapseConfiguration?: CollapseConfiguration | undefined;
|
|
1426
1426
|
}
|