@aws-sdk/client-kendra 3.933.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +396 -396
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +382 -0
- package/dist-es/models/errors.js +171 -0
- package/dist-es/models/models_0.js +1 -525
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +1 -2
- package/dist-types/commands/QueryCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveCommand.d.ts +1 -1
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateExperienceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +878 -0
- package/dist-types/models/errors.d.ts +185 -0
- package/dist-types/models/models_0.d.ts +1402 -1004
- package/dist-types/ts3.4/commands/GetQuerySuggestionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/QueryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SubmitFeedbackCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateExperienceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFeaturedResultsSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIndexCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +485 -0
- package/dist-types/ts3.4/models/errors.d.ts +101 -0
- package/dist-types/ts3.4/models/models_0.d.ts +322 -559
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-es/models/models_1.js +0 -29
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/models/models_1.d.ts +0 -1462
- package/dist-types/ts3.4/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/models_1.d.ts +0 -321
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import {
|
|
2
|
+
import { AdditionalResultAttributeValueType, AlfrescoEntity, AttributeSuggestionsMode, ConditionOperator, ConfluenceAttachmentFieldName, ConfluenceAuthenticationType, ConfluenceBlogFieldName, ConfluencePageFieldName, ConfluenceSpaceFieldName, ConfluenceVersion, ContentType, DatabaseEngineType, DataSourceStatus, DataSourceSyncJobStatus, DataSourceType, DocumentAttributeValueType, DocumentStatus, EndpointType, EntityType, ErrorCode, ExperienceStatus, FaqFileFormat, FaqStatus, FeaturedResultsSetStatus, FsxFileSystemType, HighlightType, IndexEdition, IndexStatus, Interval, IssueSubEntity, KeyLocation, MetricType, MissingAttributeKeyStrategy, Mode, Order, Persona, PrincipalMappingStatus, PrincipalType, QueryIdentifiersEnclosingOption, QueryResultFormat, QueryResultType, QuerySuggestionsBlockListStatus, QuerySuggestionsStatus, ReadAccessType, RelevanceType, SalesforceChatterFeedIncludeFilterType, SalesforceKnowledgeArticleState, SalesforceStandardObjectName, ScoreConfidence, ServiceNowAuthenticationType, ServiceNowBuildVersionType, SharePointOnlineAuthenticationType, SharePointVersion, SlackEntity, SortOrder, SuggestionType, ThesaurusStatus, Type, UserContextPolicy, UserGroupResolutionMode, WarningCode, WebCrawlerMode } from "./enums";
|
|
4
3
|
/**
|
|
5
4
|
* <p>Summary information on an access control configuration that you created for your
|
|
6
5
|
* documents in an index.</p>
|
|
@@ -26,20 +25,6 @@ export interface AccessControlListConfiguration {
|
|
|
26
25
|
*/
|
|
27
26
|
KeyPath?: string | undefined;
|
|
28
27
|
}
|
|
29
|
-
/**
|
|
30
|
-
* <p>You don't have sufficient access to perform this action. Please ensure you have the
|
|
31
|
-
* required permission policies and user accounts and try again.</p>
|
|
32
|
-
* @public
|
|
33
|
-
*/
|
|
34
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
35
|
-
readonly name: "AccessDeniedException";
|
|
36
|
-
readonly $fault: "client";
|
|
37
|
-
Message?: string | undefined;
|
|
38
|
-
/**
|
|
39
|
-
* @internal
|
|
40
|
-
*/
|
|
41
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
42
|
-
}
|
|
43
28
|
/**
|
|
44
29
|
* <p>Provides information about the column that should be used for filtering the query
|
|
45
30
|
* response by groups.</p>
|
|
@@ -54,18 +39,6 @@ export interface AclConfiguration {
|
|
|
54
39
|
*/
|
|
55
40
|
AllowedGroupsColumnName: string | undefined;
|
|
56
41
|
}
|
|
57
|
-
/**
|
|
58
|
-
* @public
|
|
59
|
-
* @enum
|
|
60
|
-
*/
|
|
61
|
-
export declare const HighlightType: {
|
|
62
|
-
readonly STANDARD: "STANDARD";
|
|
63
|
-
readonly THESAURUS_SYNONYM: "THESAURUS_SYNONYM";
|
|
64
|
-
};
|
|
65
|
-
/**
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
export type HighlightType = (typeof HighlightType)[keyof typeof HighlightType];
|
|
69
42
|
/**
|
|
70
43
|
* <p>Provides information that you can use to highlight a search result so that your users
|
|
71
44
|
* can quickly identify terms in the response.</p>
|
|
@@ -122,17 +95,6 @@ export interface AdditionalResultAttributeValue {
|
|
|
122
95
|
*/
|
|
123
96
|
TextWithHighlightsValue?: TextWithHighlights | undefined;
|
|
124
97
|
}
|
|
125
|
-
/**
|
|
126
|
-
* @public
|
|
127
|
-
* @enum
|
|
128
|
-
*/
|
|
129
|
-
export declare const AdditionalResultAttributeValueType: {
|
|
130
|
-
readonly TEXT_WITH_HIGHLIGHTS_VALUE: "TEXT_WITH_HIGHLIGHTS_VALUE";
|
|
131
|
-
};
|
|
132
|
-
/**
|
|
133
|
-
* @public
|
|
134
|
-
*/
|
|
135
|
-
export type AdditionalResultAttributeValueType = (typeof AdditionalResultAttributeValueType)[keyof typeof AdditionalResultAttributeValueType];
|
|
136
98
|
/**
|
|
137
99
|
* <p>An attribute returned from an index query.</p>
|
|
138
100
|
* @public
|
|
@@ -184,19 +146,6 @@ export interface DataSourceToIndexFieldMapping {
|
|
|
184
146
|
*/
|
|
185
147
|
IndexFieldName: string | undefined;
|
|
186
148
|
}
|
|
187
|
-
/**
|
|
188
|
-
* @public
|
|
189
|
-
* @enum
|
|
190
|
-
*/
|
|
191
|
-
export declare const AlfrescoEntity: {
|
|
192
|
-
readonly blog: "blog";
|
|
193
|
-
readonly documentLibrary: "documentLibrary";
|
|
194
|
-
readonly wiki: "wiki";
|
|
195
|
-
};
|
|
196
|
-
/**
|
|
197
|
-
* @public
|
|
198
|
-
*/
|
|
199
|
-
export type AlfrescoEntity = (typeof AlfrescoEntity)[keyof typeof AlfrescoEntity];
|
|
200
149
|
/**
|
|
201
150
|
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
202
151
|
* @public
|
|
@@ -349,18 +298,6 @@ export interface AlfrescoConfiguration {
|
|
|
349
298
|
*/
|
|
350
299
|
VpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
351
300
|
}
|
|
352
|
-
/**
|
|
353
|
-
* @public
|
|
354
|
-
* @enum
|
|
355
|
-
*/
|
|
356
|
-
export declare const EntityType: {
|
|
357
|
-
readonly GROUP: "GROUP";
|
|
358
|
-
readonly USER: "USER";
|
|
359
|
-
};
|
|
360
|
-
/**
|
|
361
|
-
* @public
|
|
362
|
-
*/
|
|
363
|
-
export type EntityType = (typeof EntityType)[keyof typeof EntityType];
|
|
364
301
|
/**
|
|
365
302
|
* <p>Provides the configuration information for users or groups in
|
|
366
303
|
* your IAM Identity Center identity source to grant access your Amazon Kendra
|
|
@@ -431,88 +368,6 @@ export interface AssociateEntitiesToExperienceResponse {
|
|
|
431
368
|
*/
|
|
432
369
|
FailedEntityList?: FailedEntity[] | undefined;
|
|
433
370
|
}
|
|
434
|
-
/**
|
|
435
|
-
* <p>An issue occurred with the internal server used for your Amazon Kendra service.
|
|
436
|
-
* Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
437
|
-
* @public
|
|
438
|
-
*/
|
|
439
|
-
export declare class InternalServerException extends __BaseException {
|
|
440
|
-
readonly name: "InternalServerException";
|
|
441
|
-
readonly $fault: "server";
|
|
442
|
-
Message?: string | undefined;
|
|
443
|
-
/**
|
|
444
|
-
* @internal
|
|
445
|
-
*/
|
|
446
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
447
|
-
}
|
|
448
|
-
/**
|
|
449
|
-
* <p>The resource you want to use already exists. Please check you have provided the
|
|
450
|
-
* correct resource and try again.</p>
|
|
451
|
-
* @public
|
|
452
|
-
*/
|
|
453
|
-
export declare class ResourceAlreadyExistException extends __BaseException {
|
|
454
|
-
readonly name: "ResourceAlreadyExistException";
|
|
455
|
-
readonly $fault: "client";
|
|
456
|
-
Message?: string | undefined;
|
|
457
|
-
/**
|
|
458
|
-
* @internal
|
|
459
|
-
*/
|
|
460
|
-
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistException, __BaseException>);
|
|
461
|
-
}
|
|
462
|
-
/**
|
|
463
|
-
* <p>The resource you want to use doesn’t exist. Please check you have provided the correct
|
|
464
|
-
* resource and try again.</p>
|
|
465
|
-
* @public
|
|
466
|
-
*/
|
|
467
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
468
|
-
readonly name: "ResourceNotFoundException";
|
|
469
|
-
readonly $fault: "client";
|
|
470
|
-
Message?: string | undefined;
|
|
471
|
-
/**
|
|
472
|
-
* @internal
|
|
473
|
-
*/
|
|
474
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
475
|
-
}
|
|
476
|
-
/**
|
|
477
|
-
* <p>The request was denied due to request throttling. Please reduce the number of requests
|
|
478
|
-
* and try again.</p>
|
|
479
|
-
* @public
|
|
480
|
-
*/
|
|
481
|
-
export declare class ThrottlingException extends __BaseException {
|
|
482
|
-
readonly name: "ThrottlingException";
|
|
483
|
-
readonly $fault: "client";
|
|
484
|
-
Message?: string | undefined;
|
|
485
|
-
/**
|
|
486
|
-
* @internal
|
|
487
|
-
*/
|
|
488
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
489
|
-
}
|
|
490
|
-
/**
|
|
491
|
-
* <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
|
|
492
|
-
* Please provide the correct input and try again.</p>
|
|
493
|
-
* @public
|
|
494
|
-
*/
|
|
495
|
-
export declare class ValidationException extends __BaseException {
|
|
496
|
-
readonly name: "ValidationException";
|
|
497
|
-
readonly $fault: "client";
|
|
498
|
-
Message?: string | undefined;
|
|
499
|
-
/**
|
|
500
|
-
* @internal
|
|
501
|
-
*/
|
|
502
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
503
|
-
}
|
|
504
|
-
/**
|
|
505
|
-
* @public
|
|
506
|
-
* @enum
|
|
507
|
-
*/
|
|
508
|
-
export declare const Persona: {
|
|
509
|
-
readonly OWNER: "OWNER";
|
|
510
|
-
readonly VIEWER: "VIEWER";
|
|
511
|
-
};
|
|
512
|
-
/**
|
|
513
|
-
* @public
|
|
514
|
-
*/
|
|
515
|
-
export type Persona = (typeof Persona)[keyof typeof Persona];
|
|
516
371
|
/**
|
|
517
372
|
* <p>Provides the configuration information for users or groups in your
|
|
518
373
|
* IAM Identity Center identity source for access to your Amazon Kendra experience.
|
|
@@ -620,18 +475,6 @@ export interface DocumentAttribute {
|
|
|
620
475
|
*/
|
|
621
476
|
Value: DocumentAttributeValue | undefined;
|
|
622
477
|
}
|
|
623
|
-
/**
|
|
624
|
-
* @public
|
|
625
|
-
* @enum
|
|
626
|
-
*/
|
|
627
|
-
export declare const AttributeSuggestionsMode: {
|
|
628
|
-
readonly ACTIVE: "ACTIVE";
|
|
629
|
-
readonly INACTIVE: "INACTIVE";
|
|
630
|
-
};
|
|
631
|
-
/**
|
|
632
|
-
* @public
|
|
633
|
-
*/
|
|
634
|
-
export type AttributeSuggestionsMode = (typeof AttributeSuggestionsMode)[keyof typeof AttributeSuggestionsMode];
|
|
635
478
|
/**
|
|
636
479
|
* <p>Provides the configuration information for a document field/attribute that you want to base query
|
|
637
480
|
* suggestions on.</p>
|
|
@@ -864,18 +707,6 @@ export interface BatchDeleteDocumentRequest {
|
|
|
864
707
|
*/
|
|
865
708
|
DataSourceSyncJobMetricTarget?: DataSourceSyncJobMetricTarget | undefined;
|
|
866
709
|
}
|
|
867
|
-
/**
|
|
868
|
-
* @public
|
|
869
|
-
* @enum
|
|
870
|
-
*/
|
|
871
|
-
export declare const ErrorCode: {
|
|
872
|
-
readonly INTERNAL_ERROR: "InternalError";
|
|
873
|
-
readonly INVALID_REQUEST: "InvalidRequest";
|
|
874
|
-
};
|
|
875
|
-
/**
|
|
876
|
-
* @public
|
|
877
|
-
*/
|
|
878
|
-
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
879
710
|
/**
|
|
880
711
|
* <p>Provides information about documents that could not be removed from an index by the
|
|
881
712
|
* <code>BatchDeleteDocument</code> API.</p>
|
|
@@ -914,20 +745,6 @@ export interface BatchDeleteDocumentResponse {
|
|
|
914
745
|
*/
|
|
915
746
|
FailedDocuments?: BatchDeleteDocumentResponseFailedDocument[] | undefined;
|
|
916
747
|
}
|
|
917
|
-
/**
|
|
918
|
-
* <p>A conflict occurred with the request. Please fix any inconsistences with your
|
|
919
|
-
* resources and try again.</p>
|
|
920
|
-
* @public
|
|
921
|
-
*/
|
|
922
|
-
export declare class ConflictException extends __BaseException {
|
|
923
|
-
readonly name: "ConflictException";
|
|
924
|
-
readonly $fault: "client";
|
|
925
|
-
Message?: string | undefined;
|
|
926
|
-
/**
|
|
927
|
-
* @internal
|
|
928
|
-
*/
|
|
929
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
930
|
-
}
|
|
931
748
|
/**
|
|
932
749
|
* @public
|
|
933
750
|
*/
|
|
@@ -1043,22 +860,6 @@ export interface BatchGetDocumentStatusRequest {
|
|
|
1043
860
|
*/
|
|
1044
861
|
DocumentInfoList: DocumentInfo[] | undefined;
|
|
1045
862
|
}
|
|
1046
|
-
/**
|
|
1047
|
-
* @public
|
|
1048
|
-
* @enum
|
|
1049
|
-
*/
|
|
1050
|
-
export declare const DocumentStatus: {
|
|
1051
|
-
readonly FAILED: "FAILED";
|
|
1052
|
-
readonly INDEXED: "INDEXED";
|
|
1053
|
-
readonly NOT_FOUND: "NOT_FOUND";
|
|
1054
|
-
readonly PROCESSING: "PROCESSING";
|
|
1055
|
-
readonly UPDATED: "UPDATED";
|
|
1056
|
-
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
1057
|
-
};
|
|
1058
|
-
/**
|
|
1059
|
-
* @public
|
|
1060
|
-
*/
|
|
1061
|
-
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
1062
863
|
/**
|
|
1063
864
|
* <p>Provides information about the status of documents submitted for indexing.</p>
|
|
1064
865
|
* @public
|
|
@@ -1134,27 +935,6 @@ export interface BatchGetDocumentStatusResponse {
|
|
|
1134
935
|
*/
|
|
1135
936
|
DocumentStatusList?: Status[] | undefined;
|
|
1136
937
|
}
|
|
1137
|
-
/**
|
|
1138
|
-
* @public
|
|
1139
|
-
* @enum
|
|
1140
|
-
*/
|
|
1141
|
-
export declare const ConditionOperator: {
|
|
1142
|
-
readonly BeginsWith: "BeginsWith";
|
|
1143
|
-
readonly Contains: "Contains";
|
|
1144
|
-
readonly Equals: "Equals";
|
|
1145
|
-
readonly Exists: "Exists";
|
|
1146
|
-
readonly GreaterThan: "GreaterThan";
|
|
1147
|
-
readonly GreaterThanOrEquals: "GreaterThanOrEquals";
|
|
1148
|
-
readonly LessThan: "LessThan";
|
|
1149
|
-
readonly LessThanOrEquals: "LessThanOrEquals";
|
|
1150
|
-
readonly NotContains: "NotContains";
|
|
1151
|
-
readonly NotEquals: "NotEquals";
|
|
1152
|
-
readonly NotExists: "NotExists";
|
|
1153
|
-
};
|
|
1154
|
-
/**
|
|
1155
|
-
* @public
|
|
1156
|
-
*/
|
|
1157
|
-
export type ConditionOperator = (typeof ConditionOperator)[keyof typeof ConditionOperator];
|
|
1158
938
|
/**
|
|
1159
939
|
* <p>The condition used for the target document attribute or metadata field when ingesting
|
|
1160
940
|
* documents into Amazon Kendra. You use this with <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html">DocumentAttributeTarget to
|
|
@@ -1334,30 +1114,6 @@ export interface CustomDocumentEnrichmentConfiguration {
|
|
|
1334
1114
|
*/
|
|
1335
1115
|
RoleArn?: string | undefined;
|
|
1336
1116
|
}
|
|
1337
|
-
/**
|
|
1338
|
-
* @public
|
|
1339
|
-
* @enum
|
|
1340
|
-
*/
|
|
1341
|
-
export declare const ReadAccessType: {
|
|
1342
|
-
readonly ALLOW: "ALLOW";
|
|
1343
|
-
readonly DENY: "DENY";
|
|
1344
|
-
};
|
|
1345
|
-
/**
|
|
1346
|
-
* @public
|
|
1347
|
-
*/
|
|
1348
|
-
export type ReadAccessType = (typeof ReadAccessType)[keyof typeof ReadAccessType];
|
|
1349
|
-
/**
|
|
1350
|
-
* @public
|
|
1351
|
-
* @enum
|
|
1352
|
-
*/
|
|
1353
|
-
export declare const PrincipalType: {
|
|
1354
|
-
readonly GROUP: "GROUP";
|
|
1355
|
-
readonly USER: "USER";
|
|
1356
|
-
};
|
|
1357
|
-
/**
|
|
1358
|
-
* @public
|
|
1359
|
-
*/
|
|
1360
|
-
export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
|
|
1361
1117
|
/**
|
|
1362
1118
|
* <p>Provides user and group information for <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">user context
|
|
1363
1119
|
* filtering</a>.</p>
|
|
@@ -1385,28 +1141,6 @@ export interface Principal {
|
|
|
1385
1141
|
*/
|
|
1386
1142
|
DataSourceId?: string | undefined;
|
|
1387
1143
|
}
|
|
1388
|
-
/**
|
|
1389
|
-
* @public
|
|
1390
|
-
* @enum
|
|
1391
|
-
*/
|
|
1392
|
-
export declare const ContentType: {
|
|
1393
|
-
readonly CSV: "CSV";
|
|
1394
|
-
readonly HTML: "HTML";
|
|
1395
|
-
readonly JSON: "JSON";
|
|
1396
|
-
readonly MD: "MD";
|
|
1397
|
-
readonly MS_EXCEL: "MS_EXCEL";
|
|
1398
|
-
readonly MS_WORD: "MS_WORD";
|
|
1399
|
-
readonly PDF: "PDF";
|
|
1400
|
-
readonly PLAIN_TEXT: "PLAIN_TEXT";
|
|
1401
|
-
readonly PPT: "PPT";
|
|
1402
|
-
readonly RTF: "RTF";
|
|
1403
|
-
readonly XML: "XML";
|
|
1404
|
-
readonly XSLT: "XSLT";
|
|
1405
|
-
};
|
|
1406
|
-
/**
|
|
1407
|
-
* @public
|
|
1408
|
-
*/
|
|
1409
|
-
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
1410
1144
|
/**
|
|
1411
1145
|
* <p> Information to define the hierarchy for which documents users should have access to.
|
|
1412
1146
|
* </p>
|
|
@@ -1575,22 +1309,6 @@ export interface BatchPutDocumentResponse {
|
|
|
1575
1309
|
*/
|
|
1576
1310
|
FailedDocuments?: BatchPutDocumentResponseFailedDocument[] | undefined;
|
|
1577
1311
|
}
|
|
1578
|
-
/**
|
|
1579
|
-
* <p>You have exceeded the set limits for your Amazon Kendra service. Please see
|
|
1580
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
|
|
1581
|
-
* more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
|
|
1582
|
-
* an increase of limits.</p>
|
|
1583
|
-
* @public
|
|
1584
|
-
*/
|
|
1585
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1586
|
-
readonly name: "ServiceQuotaExceededException";
|
|
1587
|
-
readonly $fault: "client";
|
|
1588
|
-
Message?: string | undefined;
|
|
1589
|
-
/**
|
|
1590
|
-
* @internal
|
|
1591
|
-
*/
|
|
1592
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1593
|
-
}
|
|
1594
1312
|
/**
|
|
1595
1313
|
* @public
|
|
1596
1314
|
*/
|
|
@@ -1784,27 +1502,6 @@ export interface BoxConfiguration {
|
|
|
1784
1502
|
*/
|
|
1785
1503
|
VpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
1786
1504
|
}
|
|
1787
|
-
/**
|
|
1788
|
-
* @public
|
|
1789
|
-
* @enum
|
|
1790
|
-
*/
|
|
1791
|
-
export declare const ConfluenceAttachmentFieldName: {
|
|
1792
|
-
readonly AUTHOR: "AUTHOR";
|
|
1793
|
-
readonly CONTENT_TYPE: "CONTENT_TYPE";
|
|
1794
|
-
readonly CREATED_DATE: "CREATED_DATE";
|
|
1795
|
-
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
1796
|
-
readonly FILE_SIZE: "FILE_SIZE";
|
|
1797
|
-
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
1798
|
-
readonly PARENT_ID: "PARENT_ID";
|
|
1799
|
-
readonly SPACE_KEY: "SPACE_KEY";
|
|
1800
|
-
readonly SPACE_NAME: "SPACE_NAME";
|
|
1801
|
-
readonly URL: "URL";
|
|
1802
|
-
readonly VERSION: "VERSION";
|
|
1803
|
-
};
|
|
1804
|
-
/**
|
|
1805
|
-
* @public
|
|
1806
|
-
*/
|
|
1807
|
-
export type ConfluenceAttachmentFieldName = (typeof ConfluenceAttachmentFieldName)[keyof typeof ConfluenceAttachmentFieldName];
|
|
1808
1505
|
/**
|
|
1809
1506
|
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index
|
|
1810
1507
|
* field names. To create custom fields, use the <code>UpdateIndex</code> API before you
|
|
@@ -1857,37 +1554,6 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1857
1554
|
*/
|
|
1858
1555
|
AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[] | undefined;
|
|
1859
1556
|
}
|
|
1860
|
-
/**
|
|
1861
|
-
* @public
|
|
1862
|
-
* @enum
|
|
1863
|
-
*/
|
|
1864
|
-
export declare const ConfluenceAuthenticationType: {
|
|
1865
|
-
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
1866
|
-
readonly PAT: "PAT";
|
|
1867
|
-
};
|
|
1868
|
-
/**
|
|
1869
|
-
* @public
|
|
1870
|
-
*/
|
|
1871
|
-
export type ConfluenceAuthenticationType = (typeof ConfluenceAuthenticationType)[keyof typeof ConfluenceAuthenticationType];
|
|
1872
|
-
/**
|
|
1873
|
-
* @public
|
|
1874
|
-
* @enum
|
|
1875
|
-
*/
|
|
1876
|
-
export declare const ConfluenceBlogFieldName: {
|
|
1877
|
-
readonly AUTHOR: "AUTHOR";
|
|
1878
|
-
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
1879
|
-
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
1880
|
-
readonly LABELS: "LABELS";
|
|
1881
|
-
readonly PUBLISH_DATE: "PUBLISH_DATE";
|
|
1882
|
-
readonly SPACE_KEY: "SPACE_KEY";
|
|
1883
|
-
readonly SPACE_NAME: "SPACE_NAME";
|
|
1884
|
-
readonly URL: "URL";
|
|
1885
|
-
readonly VERSION: "VERSION";
|
|
1886
|
-
};
|
|
1887
|
-
/**
|
|
1888
|
-
* @public
|
|
1889
|
-
*/
|
|
1890
|
-
export type ConfluenceBlogFieldName = (typeof ConfluenceBlogFieldName)[keyof typeof ConfluenceBlogFieldName];
|
|
1891
1557
|
/**
|
|
1892
1558
|
* <p>Maps attributes or field names of Confluence blog to Amazon Kendra index field
|
|
1893
1559
|
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
@@ -1934,28 +1600,6 @@ export interface ConfluenceBlogConfiguration {
|
|
|
1934
1600
|
*/
|
|
1935
1601
|
BlogFieldMappings?: ConfluenceBlogToIndexFieldMapping[] | undefined;
|
|
1936
1602
|
}
|
|
1937
|
-
/**
|
|
1938
|
-
* @public
|
|
1939
|
-
* @enum
|
|
1940
|
-
*/
|
|
1941
|
-
export declare const ConfluencePageFieldName: {
|
|
1942
|
-
readonly AUTHOR: "AUTHOR";
|
|
1943
|
-
readonly CONTENT_STATUS: "CONTENT_STATUS";
|
|
1944
|
-
readonly CREATED_DATE: "CREATED_DATE";
|
|
1945
|
-
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
1946
|
-
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
1947
|
-
readonly LABELS: "LABELS";
|
|
1948
|
-
readonly MODIFIED_DATE: "MODIFIED_DATE";
|
|
1949
|
-
readonly PARENT_ID: "PARENT_ID";
|
|
1950
|
-
readonly SPACE_KEY: "SPACE_KEY";
|
|
1951
|
-
readonly SPACE_NAME: "SPACE_NAME";
|
|
1952
|
-
readonly URL: "URL";
|
|
1953
|
-
readonly VERSION: "VERSION";
|
|
1954
|
-
};
|
|
1955
|
-
/**
|
|
1956
|
-
* @public
|
|
1957
|
-
*/
|
|
1958
|
-
export type ConfluencePageFieldName = (typeof ConfluencePageFieldName)[keyof typeof ConfluencePageFieldName];
|
|
1959
1603
|
/**
|
|
1960
1604
|
* <p>Maps attributes or field names of Confluence pages to Amazon Kendra index field
|
|
1961
1605
|
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
@@ -2030,20 +1674,6 @@ export interface ProxyConfiguration {
|
|
|
2030
1674
|
*/
|
|
2031
1675
|
Credentials?: string | undefined;
|
|
2032
1676
|
}
|
|
2033
|
-
/**
|
|
2034
|
-
* @public
|
|
2035
|
-
* @enum
|
|
2036
|
-
*/
|
|
2037
|
-
export declare const ConfluenceSpaceFieldName: {
|
|
2038
|
-
readonly DISPLAY_URL: "DISPLAY_URL";
|
|
2039
|
-
readonly ITEM_TYPE: "ITEM_TYPE";
|
|
2040
|
-
readonly SPACE_KEY: "SPACE_KEY";
|
|
2041
|
-
readonly URL: "URL";
|
|
2042
|
-
};
|
|
2043
|
-
/**
|
|
2044
|
-
* @public
|
|
2045
|
-
*/
|
|
2046
|
-
export type ConfluenceSpaceFieldName = (typeof ConfluenceSpaceFieldName)[keyof typeof ConfluenceSpaceFieldName];
|
|
2047
1677
|
/**
|
|
2048
1678
|
* <p>Maps attributes or field names of Confluence spaces to Amazon Kendra index field
|
|
2049
1679
|
* names. To create custom fields, use the <code>UpdateIndex</code> API before you map to
|
|
@@ -2121,18 +1751,6 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
2121
1751
|
*/
|
|
2122
1752
|
SpaceFieldMappings?: ConfluenceSpaceToIndexFieldMapping[] | undefined;
|
|
2123
1753
|
}
|
|
2124
|
-
/**
|
|
2125
|
-
* @public
|
|
2126
|
-
* @enum
|
|
2127
|
-
*/
|
|
2128
|
-
export declare const ConfluenceVersion: {
|
|
2129
|
-
readonly CLOUD: "CLOUD";
|
|
2130
|
-
readonly SERVER: "SERVER";
|
|
2131
|
-
};
|
|
2132
|
-
/**
|
|
2133
|
-
* @public
|
|
2134
|
-
*/
|
|
2135
|
-
export type ConfluenceVersion = (typeof ConfluenceVersion)[keyof typeof ConfluenceVersion];
|
|
2136
1754
|
/**
|
|
2137
1755
|
* <p>Provides the configuration information to connect to Confluence as your data
|
|
2138
1756
|
* source.</p>
|
|
@@ -2304,32 +1922,6 @@ export interface ConnectionConfiguration {
|
|
|
2304
1922
|
*/
|
|
2305
1923
|
SecretArn: string | undefined;
|
|
2306
1924
|
}
|
|
2307
|
-
/**
|
|
2308
|
-
* @public
|
|
2309
|
-
* @enum
|
|
2310
|
-
*/
|
|
2311
|
-
export declare const DatabaseEngineType: {
|
|
2312
|
-
readonly RDS_AURORA_MYSQL: "RDS_AURORA_MYSQL";
|
|
2313
|
-
readonly RDS_AURORA_POSTGRESQL: "RDS_AURORA_POSTGRESQL";
|
|
2314
|
-
readonly RDS_MYSQL: "RDS_MYSQL";
|
|
2315
|
-
readonly RDS_POSTGRESQL: "RDS_POSTGRESQL";
|
|
2316
|
-
};
|
|
2317
|
-
/**
|
|
2318
|
-
* @public
|
|
2319
|
-
*/
|
|
2320
|
-
export type DatabaseEngineType = (typeof DatabaseEngineType)[keyof typeof DatabaseEngineType];
|
|
2321
|
-
/**
|
|
2322
|
-
* @public
|
|
2323
|
-
* @enum
|
|
2324
|
-
*/
|
|
2325
|
-
export declare const QueryIdentifiersEnclosingOption: {
|
|
2326
|
-
readonly DOUBLE_QUOTES: "DOUBLE_QUOTES";
|
|
2327
|
-
readonly NONE: "NONE";
|
|
2328
|
-
};
|
|
2329
|
-
/**
|
|
2330
|
-
* @public
|
|
2331
|
-
*/
|
|
2332
|
-
export type QueryIdentifiersEnclosingOption = (typeof QueryIdentifiersEnclosingOption)[keyof typeof QueryIdentifiersEnclosingOption];
|
|
2333
1925
|
/**
|
|
2334
1926
|
* <p>Provides the configuration information to use a SQL database.</p>
|
|
2335
1927
|
* @public
|
|
@@ -2390,17 +1982,6 @@ export interface DatabaseConfiguration {
|
|
|
2390
1982
|
*/
|
|
2391
1983
|
SqlConfiguration?: SqlConfiguration | undefined;
|
|
2392
1984
|
}
|
|
2393
|
-
/**
|
|
2394
|
-
* @public
|
|
2395
|
-
* @enum
|
|
2396
|
-
*/
|
|
2397
|
-
export declare const FsxFileSystemType: {
|
|
2398
|
-
readonly WINDOWS: "WINDOWS";
|
|
2399
|
-
};
|
|
2400
|
-
/**
|
|
2401
|
-
* @public
|
|
2402
|
-
*/
|
|
2403
|
-
export type FsxFileSystemType = (typeof FsxFileSystemType)[keyof typeof FsxFileSystemType];
|
|
2404
1985
|
/**
|
|
2405
1986
|
* <p>Provides the configuration information to connect to Amazon FSx as your data
|
|
2406
1987
|
* source.</p>
|
|
@@ -2583,18 +2164,6 @@ export interface SaaSConfiguration {
|
|
|
2583
2164
|
*/
|
|
2584
2165
|
HostUrl: string | undefined;
|
|
2585
2166
|
}
|
|
2586
|
-
/**
|
|
2587
|
-
* @public
|
|
2588
|
-
* @enum
|
|
2589
|
-
*/
|
|
2590
|
-
export declare const Type: {
|
|
2591
|
-
readonly ON_PREMISE: "ON_PREMISE";
|
|
2592
|
-
readonly SAAS: "SAAS";
|
|
2593
|
-
};
|
|
2594
|
-
/**
|
|
2595
|
-
* @public
|
|
2596
|
-
*/
|
|
2597
|
-
export type Type = (typeof Type)[keyof typeof Type];
|
|
2598
2167
|
/**
|
|
2599
2168
|
* <p>Provides the configuration information to connect to GitHub as your data
|
|
2600
2169
|
* source.</p>
|
|
@@ -2859,19 +2428,6 @@ export interface GoogleDriveConfiguration {
|
|
|
2859
2428
|
*/
|
|
2860
2429
|
ExcludeSharedDrives?: string[] | undefined;
|
|
2861
2430
|
}
|
|
2862
|
-
/**
|
|
2863
|
-
* @public
|
|
2864
|
-
* @enum
|
|
2865
|
-
*/
|
|
2866
|
-
export declare const IssueSubEntity: {
|
|
2867
|
-
readonly ATTACHMENTS: "ATTACHMENTS";
|
|
2868
|
-
readonly COMMENTS: "COMMENTS";
|
|
2869
|
-
readonly WORKLOGS: "WORKLOGS";
|
|
2870
|
-
};
|
|
2871
|
-
/**
|
|
2872
|
-
* @public
|
|
2873
|
-
*/
|
|
2874
|
-
export type IssueSubEntity = (typeof IssueSubEntity)[keyof typeof IssueSubEntity];
|
|
2875
2431
|
/**
|
|
2876
2432
|
* <p>Provides the configuration information to connect to Jira as your data source.</p>
|
|
2877
2433
|
* @public
|
|
@@ -3347,18 +2903,6 @@ export interface S3DataSourceConfiguration {
|
|
|
3347
2903
|
*/
|
|
3348
2904
|
AccessControlListConfiguration?: AccessControlListConfiguration | undefined;
|
|
3349
2905
|
}
|
|
3350
|
-
/**
|
|
3351
|
-
* @public
|
|
3352
|
-
* @enum
|
|
3353
|
-
*/
|
|
3354
|
-
export declare const SalesforceChatterFeedIncludeFilterType: {
|
|
3355
|
-
readonly ACTIVE_USER: "ACTIVE_USER";
|
|
3356
|
-
readonly STANDARD_USER: "STANDARD_USER";
|
|
3357
|
-
};
|
|
3358
|
-
/**
|
|
3359
|
-
* @public
|
|
3360
|
-
*/
|
|
3361
|
-
export type SalesforceChatterFeedIncludeFilterType = (typeof SalesforceChatterFeedIncludeFilterType)[keyof typeof SalesforceChatterFeedIncludeFilterType];
|
|
3362
2906
|
/**
|
|
3363
2907
|
* <p>The configuration information for syncing a Salesforce chatter feed. The contents of
|
|
3364
2908
|
* the object comes from the Salesforce FeedItem table.</p>
|
|
@@ -3423,19 +2967,6 @@ export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
|
3423
2967
|
*/
|
|
3424
2968
|
FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
|
|
3425
2969
|
}
|
|
3426
|
-
/**
|
|
3427
|
-
* @public
|
|
3428
|
-
* @enum
|
|
3429
|
-
*/
|
|
3430
|
-
export declare const SalesforceKnowledgeArticleState: {
|
|
3431
|
-
readonly ARCHIVED: "ARCHIVED";
|
|
3432
|
-
readonly DRAFT: "DRAFT";
|
|
3433
|
-
readonly PUBLISHED: "PUBLISHED";
|
|
3434
|
-
};
|
|
3435
|
-
/**
|
|
3436
|
-
* @public
|
|
3437
|
-
*/
|
|
3438
|
-
export type SalesforceKnowledgeArticleState = (typeof SalesforceKnowledgeArticleState)[keyof typeof SalesforceKnowledgeArticleState];
|
|
3439
2970
|
/**
|
|
3440
2971
|
* <p>Provides the configuration information for standard Salesforce knowledge
|
|
3441
2972
|
* articles.</p>
|
|
@@ -3503,33 +3034,6 @@ export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
|
3503
3034
|
*/
|
|
3504
3035
|
FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
|
|
3505
3036
|
}
|
|
3506
|
-
/**
|
|
3507
|
-
* @public
|
|
3508
|
-
* @enum
|
|
3509
|
-
*/
|
|
3510
|
-
export declare const SalesforceStandardObjectName: {
|
|
3511
|
-
readonly ACCOUNT: "ACCOUNT";
|
|
3512
|
-
readonly CAMPAIGN: "CAMPAIGN";
|
|
3513
|
-
readonly CASE: "CASE";
|
|
3514
|
-
readonly CONTACT: "CONTACT";
|
|
3515
|
-
readonly CONTRACT: "CONTRACT";
|
|
3516
|
-
readonly DOCUMENT: "DOCUMENT";
|
|
3517
|
-
readonly GROUP: "GROUP";
|
|
3518
|
-
readonly IDEA: "IDEA";
|
|
3519
|
-
readonly LEAD: "LEAD";
|
|
3520
|
-
readonly OPPORTUNITY: "OPPORTUNITY";
|
|
3521
|
-
readonly PARTNER: "PARTNER";
|
|
3522
|
-
readonly PRICEBOOK: "PRICEBOOK";
|
|
3523
|
-
readonly PRODUCT: "PRODUCT";
|
|
3524
|
-
readonly PROFILE: "PROFILE";
|
|
3525
|
-
readonly SOLUTION: "SOLUTION";
|
|
3526
|
-
readonly TASK: "TASK";
|
|
3527
|
-
readonly USER: "USER";
|
|
3528
|
-
};
|
|
3529
|
-
/**
|
|
3530
|
-
* @public
|
|
3531
|
-
*/
|
|
3532
|
-
export type SalesforceStandardObjectName = (typeof SalesforceStandardObjectName)[keyof typeof SalesforceStandardObjectName];
|
|
3533
3037
|
/**
|
|
3534
3038
|
* <p>Provides the configuration information for indexing a single standard object.</p>
|
|
3535
3039
|
* @public
|
|
@@ -3657,18 +3161,6 @@ export interface SalesforceConfiguration {
|
|
|
3657
3161
|
*/
|
|
3658
3162
|
ExcludeAttachmentFilePatterns?: string[] | undefined;
|
|
3659
3163
|
}
|
|
3660
|
-
/**
|
|
3661
|
-
* @public
|
|
3662
|
-
* @enum
|
|
3663
|
-
*/
|
|
3664
|
-
export declare const ServiceNowAuthenticationType: {
|
|
3665
|
-
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
3666
|
-
readonly OAUTH2: "OAUTH2";
|
|
3667
|
-
};
|
|
3668
|
-
/**
|
|
3669
|
-
* @public
|
|
3670
|
-
*/
|
|
3671
|
-
export type ServiceNowAuthenticationType = (typeof ServiceNowAuthenticationType)[keyof typeof ServiceNowAuthenticationType];
|
|
3672
3164
|
/**
|
|
3673
3165
|
* <p>Provides the configuration information for crawling knowledge articles in the
|
|
3674
3166
|
* ServiceNow site.</p>
|
|
@@ -3782,18 +3274,6 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
3782
3274
|
*/
|
|
3783
3275
|
FieldMappings?: DataSourceToIndexFieldMapping[] | undefined;
|
|
3784
3276
|
}
|
|
3785
|
-
/**
|
|
3786
|
-
* @public
|
|
3787
|
-
* @enum
|
|
3788
|
-
*/
|
|
3789
|
-
export declare const ServiceNowBuildVersionType: {
|
|
3790
|
-
readonly LONDON: "LONDON";
|
|
3791
|
-
readonly OTHERS: "OTHERS";
|
|
3792
|
-
};
|
|
3793
|
-
/**
|
|
3794
|
-
* @public
|
|
3795
|
-
*/
|
|
3796
|
-
export type ServiceNowBuildVersionType = (typeof ServiceNowBuildVersionType)[keyof typeof ServiceNowBuildVersionType];
|
|
3797
3277
|
/**
|
|
3798
3278
|
* <p>Provides the configuration information to connect to ServiceNow as your data
|
|
3799
3279
|
* source.</p>
|
|
@@ -3846,32 +3326,6 @@ export interface ServiceNowConfiguration {
|
|
|
3846
3326
|
*/
|
|
3847
3327
|
AuthenticationType?: ServiceNowAuthenticationType | undefined;
|
|
3848
3328
|
}
|
|
3849
|
-
/**
|
|
3850
|
-
* @public
|
|
3851
|
-
* @enum
|
|
3852
|
-
*/
|
|
3853
|
-
export declare const SharePointOnlineAuthenticationType: {
|
|
3854
|
-
readonly HTTP_BASIC: "HTTP_BASIC";
|
|
3855
|
-
readonly OAUTH2: "OAUTH2";
|
|
3856
|
-
};
|
|
3857
|
-
/**
|
|
3858
|
-
* @public
|
|
3859
|
-
*/
|
|
3860
|
-
export type SharePointOnlineAuthenticationType = (typeof SharePointOnlineAuthenticationType)[keyof typeof SharePointOnlineAuthenticationType];
|
|
3861
|
-
/**
|
|
3862
|
-
* @public
|
|
3863
|
-
* @enum
|
|
3864
|
-
*/
|
|
3865
|
-
export declare const SharePointVersion: {
|
|
3866
|
-
readonly SHAREPOINT_2013: "SHAREPOINT_2013";
|
|
3867
|
-
readonly SHAREPOINT_2016: "SHAREPOINT_2016";
|
|
3868
|
-
readonly SHAREPOINT_2019: "SHAREPOINT_2019";
|
|
3869
|
-
readonly SHAREPOINT_ONLINE: "SHAREPOINT_ONLINE";
|
|
3870
|
-
};
|
|
3871
|
-
/**
|
|
3872
|
-
* @public
|
|
3873
|
-
*/
|
|
3874
|
-
export type SharePointVersion = (typeof SharePointVersion)[keyof typeof SharePointVersion];
|
|
3875
3329
|
/**
|
|
3876
3330
|
* <p>Provides the configuration information to connect to Microsoft SharePoint as your data
|
|
3877
3331
|
* source.</p>
|
|
@@ -3993,20 +3447,6 @@ export interface SharePointConfiguration {
|
|
|
3993
3447
|
*/
|
|
3994
3448
|
ProxyConfiguration?: ProxyConfiguration | undefined;
|
|
3995
3449
|
}
|
|
3996
|
-
/**
|
|
3997
|
-
* @public
|
|
3998
|
-
* @enum
|
|
3999
|
-
*/
|
|
4000
|
-
export declare const SlackEntity: {
|
|
4001
|
-
readonly DIRECT_MESSAGE: "DIRECT_MESSAGE";
|
|
4002
|
-
readonly GROUP_MESSAGE: "GROUP_MESSAGE";
|
|
4003
|
-
readonly PRIVATE_CHANNEL: "PRIVATE_CHANNEL";
|
|
4004
|
-
readonly PUBLIC_CHANNEL: "PUBLIC_CHANNEL";
|
|
4005
|
-
};
|
|
4006
|
-
/**
|
|
4007
|
-
* @public
|
|
4008
|
-
*/
|
|
4009
|
-
export type SlackEntity = (typeof SlackEntity)[keyof typeof SlackEntity];
|
|
4010
3450
|
/**
|
|
4011
3451
|
* <p>Provides the configuration information to connect to Slack as your data source.</p>
|
|
4012
3452
|
* <note>
|
|
@@ -4152,19 +3592,6 @@ export interface TemplateConfiguration {
|
|
|
4152
3592
|
*/
|
|
4153
3593
|
Template?: __DocumentType | undefined;
|
|
4154
3594
|
}
|
|
4155
|
-
/**
|
|
4156
|
-
* @public
|
|
4157
|
-
* @enum
|
|
4158
|
-
*/
|
|
4159
|
-
export declare const WebCrawlerMode: {
|
|
4160
|
-
readonly EVERYTHING: "EVERYTHING";
|
|
4161
|
-
readonly HOST_ONLY: "HOST_ONLY";
|
|
4162
|
-
readonly SUBDOMAINS: "SUBDOMAINS";
|
|
4163
|
-
};
|
|
4164
|
-
/**
|
|
4165
|
-
* @public
|
|
4166
|
-
*/
|
|
4167
|
-
export type WebCrawlerMode = (typeof WebCrawlerMode)[keyof typeof WebCrawlerMode];
|
|
4168
3595
|
/**
|
|
4169
3596
|
* <p>Provides the configuration information for the seed or starting point URLs to
|
|
4170
3597
|
* crawl.</p>
|
|
@@ -4600,35 +4027,6 @@ export interface Tag {
|
|
|
4600
4027
|
*/
|
|
4601
4028
|
Value: string | undefined;
|
|
4602
4029
|
}
|
|
4603
|
-
/**
|
|
4604
|
-
* @public
|
|
4605
|
-
* @enum
|
|
4606
|
-
*/
|
|
4607
|
-
export declare const DataSourceType: {
|
|
4608
|
-
readonly ALFRESCO: "ALFRESCO";
|
|
4609
|
-
readonly BOX: "BOX";
|
|
4610
|
-
readonly CONFLUENCE: "CONFLUENCE";
|
|
4611
|
-
readonly CUSTOM: "CUSTOM";
|
|
4612
|
-
readonly DATABASE: "DATABASE";
|
|
4613
|
-
readonly FSX: "FSX";
|
|
4614
|
-
readonly GITHUB: "GITHUB";
|
|
4615
|
-
readonly GOOGLEDRIVE: "GOOGLEDRIVE";
|
|
4616
|
-
readonly JIRA: "JIRA";
|
|
4617
|
-
readonly ONEDRIVE: "ONEDRIVE";
|
|
4618
|
-
readonly QUIP: "QUIP";
|
|
4619
|
-
readonly S3: "S3";
|
|
4620
|
-
readonly SALESFORCE: "SALESFORCE";
|
|
4621
|
-
readonly SERVICENOW: "SERVICENOW";
|
|
4622
|
-
readonly SHAREPOINT: "SHAREPOINT";
|
|
4623
|
-
readonly SLACK: "SLACK";
|
|
4624
|
-
readonly TEMPLATE: "TEMPLATE";
|
|
4625
|
-
readonly WEBCRAWLER: "WEBCRAWLER";
|
|
4626
|
-
readonly WORKDOCS: "WORKDOCS";
|
|
4627
|
-
};
|
|
4628
|
-
/**
|
|
4629
|
-
* @public
|
|
4630
|
-
*/
|
|
4631
|
-
export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
4632
4030
|
/**
|
|
4633
4031
|
* @public
|
|
4634
4032
|
*/
|
|
@@ -4849,19 +4247,6 @@ export interface CreateExperienceResponse {
|
|
|
4849
4247
|
*/
|
|
4850
4248
|
Id: string | undefined;
|
|
4851
4249
|
}
|
|
4852
|
-
/**
|
|
4853
|
-
* @public
|
|
4854
|
-
* @enum
|
|
4855
|
-
*/
|
|
4856
|
-
export declare const FaqFileFormat: {
|
|
4857
|
-
readonly CSV: "CSV";
|
|
4858
|
-
readonly CSV_WITH_HEADER: "CSV_WITH_HEADER";
|
|
4859
|
-
readonly JSON: "JSON";
|
|
4860
|
-
};
|
|
4861
|
-
/**
|
|
4862
|
-
* @public
|
|
4863
|
-
*/
|
|
4864
|
-
export type FaqFileFormat = (typeof FaqFileFormat)[keyof typeof FaqFileFormat];
|
|
4865
4250
|
/**
|
|
4866
4251
|
* @public
|
|
4867
4252
|
*/
|
|
@@ -4954,18 +4339,6 @@ export interface FeaturedDocument {
|
|
|
4954
4339
|
*/
|
|
4955
4340
|
Id?: string | undefined;
|
|
4956
4341
|
}
|
|
4957
|
-
/**
|
|
4958
|
-
* @public
|
|
4959
|
-
* @enum
|
|
4960
|
-
*/
|
|
4961
|
-
export declare const FeaturedResultsSetStatus: {
|
|
4962
|
-
readonly ACTIVE: "ACTIVE";
|
|
4963
|
-
readonly INACTIVE: "INACTIVE";
|
|
4964
|
-
};
|
|
4965
|
-
/**
|
|
4966
|
-
* @public
|
|
4967
|
-
*/
|
|
4968
|
-
export type FeaturedResultsSetStatus = (typeof FeaturedResultsSetStatus)[keyof typeof FeaturedResultsSetStatus];
|
|
4969
4342
|
/**
|
|
4970
4343
|
* @public
|
|
4971
4344
|
*/
|
|
@@ -5136,45 +4509,6 @@ export interface ConflictingItem {
|
|
|
5136
4509
|
*/
|
|
5137
4510
|
SetId?: string | undefined;
|
|
5138
4511
|
}
|
|
5139
|
-
/**
|
|
5140
|
-
* <p>An error message with a list of conflicting queries used across different sets
|
|
5141
|
-
* of featured results. This occurred with the request for a new featured results set.
|
|
5142
|
-
* Check that the queries you specified for featured results are unique per featured
|
|
5143
|
-
* results set for each index.</p>
|
|
5144
|
-
* @public
|
|
5145
|
-
*/
|
|
5146
|
-
export declare class FeaturedResultsConflictException extends __BaseException {
|
|
5147
|
-
readonly name: "FeaturedResultsConflictException";
|
|
5148
|
-
readonly $fault: "client";
|
|
5149
|
-
/**
|
|
5150
|
-
* <p>An explanation for the conflicting queries.</p>
|
|
5151
|
-
* @public
|
|
5152
|
-
*/
|
|
5153
|
-
Message?: string | undefined;
|
|
5154
|
-
/**
|
|
5155
|
-
* <p>A list of the conflicting queries, including the query text, the name for
|
|
5156
|
-
* the featured results set, and the identifier of the featured results set.</p>
|
|
5157
|
-
* @public
|
|
5158
|
-
*/
|
|
5159
|
-
ConflictingItems?: ConflictingItem[] | undefined;
|
|
5160
|
-
/**
|
|
5161
|
-
* @internal
|
|
5162
|
-
*/
|
|
5163
|
-
constructor(opts: __ExceptionOptionType<FeaturedResultsConflictException, __BaseException>);
|
|
5164
|
-
}
|
|
5165
|
-
/**
|
|
5166
|
-
* @public
|
|
5167
|
-
* @enum
|
|
5168
|
-
*/
|
|
5169
|
-
export declare const IndexEdition: {
|
|
5170
|
-
readonly DEVELOPER_EDITION: "DEVELOPER_EDITION";
|
|
5171
|
-
readonly ENTERPRISE_EDITION: "ENTERPRISE_EDITION";
|
|
5172
|
-
readonly GEN_AI_ENTERPRISE_EDITION: "GEN_AI_ENTERPRISE_EDITION";
|
|
5173
|
-
};
|
|
5174
|
-
/**
|
|
5175
|
-
* @public
|
|
5176
|
-
*/
|
|
5177
|
-
export type IndexEdition = (typeof IndexEdition)[keyof typeof IndexEdition];
|
|
5178
4512
|
/**
|
|
5179
4513
|
* <p>Provides the identifier of the KMS key used to encrypt data
|
|
5180
4514
|
* indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric
|
|
@@ -5189,30 +4523,6 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
5189
4523
|
*/
|
|
5190
4524
|
KmsKeyId?: string | undefined;
|
|
5191
4525
|
}
|
|
5192
|
-
/**
|
|
5193
|
-
* @public
|
|
5194
|
-
* @enum
|
|
5195
|
-
*/
|
|
5196
|
-
export declare const UserContextPolicy: {
|
|
5197
|
-
readonly ATTRIBUTE_FILTER: "ATTRIBUTE_FILTER";
|
|
5198
|
-
readonly USER_TOKEN: "USER_TOKEN";
|
|
5199
|
-
};
|
|
5200
|
-
/**
|
|
5201
|
-
* @public
|
|
5202
|
-
*/
|
|
5203
|
-
export type UserContextPolicy = (typeof UserContextPolicy)[keyof typeof UserContextPolicy];
|
|
5204
|
-
/**
|
|
5205
|
-
* @public
|
|
5206
|
-
* @enum
|
|
5207
|
-
*/
|
|
5208
|
-
export declare const UserGroupResolutionMode: {
|
|
5209
|
-
readonly AWS_SSO: "AWS_SSO";
|
|
5210
|
-
readonly NONE: "NONE";
|
|
5211
|
-
};
|
|
5212
|
-
/**
|
|
5213
|
-
* @public
|
|
5214
|
-
*/
|
|
5215
|
-
export type UserGroupResolutionMode = (typeof UserGroupResolutionMode)[keyof typeof UserGroupResolutionMode];
|
|
5216
4526
|
/**
|
|
5217
4527
|
* <p>Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search
|
|
5218
4528
|
* results are filtered based on the user or their group access to documents. You can also use
|
|
@@ -5255,18 +4565,6 @@ export interface JsonTokenTypeConfiguration {
|
|
|
5255
4565
|
*/
|
|
5256
4566
|
GroupAttributeField: string | undefined;
|
|
5257
4567
|
}
|
|
5258
|
-
/**
|
|
5259
|
-
* @public
|
|
5260
|
-
* @enum
|
|
5261
|
-
*/
|
|
5262
|
-
export declare const KeyLocation: {
|
|
5263
|
-
readonly SECRET_MANAGER: "SECRET_MANAGER";
|
|
5264
|
-
readonly URL: "URL";
|
|
5265
|
-
};
|
|
5266
|
-
/**
|
|
5267
|
-
* @public
|
|
5268
|
-
*/
|
|
5269
|
-
export type KeyLocation = (typeof KeyLocation)[keyof typeof KeyLocation];
|
|
5270
4568
|
/**
|
|
5271
4569
|
* <p>Provides the configuration information for the JWT token type.</p>
|
|
5272
4570
|
* @public
|
|
@@ -5786,21 +5084,6 @@ export interface DescribeDataSourceRequest {
|
|
|
5786
5084
|
*/
|
|
5787
5085
|
IndexId: string | undefined;
|
|
5788
5086
|
}
|
|
5789
|
-
/**
|
|
5790
|
-
* @public
|
|
5791
|
-
* @enum
|
|
5792
|
-
*/
|
|
5793
|
-
export declare const DataSourceStatus: {
|
|
5794
|
-
readonly ACTIVE: "ACTIVE";
|
|
5795
|
-
readonly CREATING: "CREATING";
|
|
5796
|
-
readonly DELETING: "DELETING";
|
|
5797
|
-
readonly FAILED: "FAILED";
|
|
5798
|
-
readonly UPDATING: "UPDATING";
|
|
5799
|
-
};
|
|
5800
|
-
/**
|
|
5801
|
-
* @public
|
|
5802
|
-
*/
|
|
5803
|
-
export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
5804
5087
|
/**
|
|
5805
5088
|
* @public
|
|
5806
5089
|
*/
|
|
@@ -5911,17 +5194,6 @@ export interface DescribeExperienceRequest {
|
|
|
5911
5194
|
*/
|
|
5912
5195
|
IndexId: string | undefined;
|
|
5913
5196
|
}
|
|
5914
|
-
/**
|
|
5915
|
-
* @public
|
|
5916
|
-
* @enum
|
|
5917
|
-
*/
|
|
5918
|
-
export declare const EndpointType: {
|
|
5919
|
-
readonly HOME: "HOME";
|
|
5920
|
-
};
|
|
5921
|
-
/**
|
|
5922
|
-
* @public
|
|
5923
|
-
*/
|
|
5924
|
-
export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType];
|
|
5925
5197
|
/**
|
|
5926
5198
|
* <p>Provides the configuration information for the endpoint for your Amazon Kendra
|
|
5927
5199
|
* experience.</p>
|
|
@@ -5941,20 +5213,6 @@ export interface ExperienceEndpoint {
|
|
|
5941
5213
|
*/
|
|
5942
5214
|
Endpoint?: string | undefined;
|
|
5943
5215
|
}
|
|
5944
|
-
/**
|
|
5945
|
-
* @public
|
|
5946
|
-
* @enum
|
|
5947
|
-
*/
|
|
5948
|
-
export declare const ExperienceStatus: {
|
|
5949
|
-
readonly ACTIVE: "ACTIVE";
|
|
5950
|
-
readonly CREATING: "CREATING";
|
|
5951
|
-
readonly DELETING: "DELETING";
|
|
5952
|
-
readonly FAILED: "FAILED";
|
|
5953
|
-
};
|
|
5954
|
-
/**
|
|
5955
|
-
* @public
|
|
5956
|
-
*/
|
|
5957
|
-
export type ExperienceStatus = (typeof ExperienceStatus)[keyof typeof ExperienceStatus];
|
|
5958
5216
|
/**
|
|
5959
5217
|
* @public
|
|
5960
5218
|
*/
|
|
@@ -6040,21 +5298,6 @@ export interface DescribeFaqRequest {
|
|
|
6040
5298
|
*/
|
|
6041
5299
|
IndexId: string | undefined;
|
|
6042
5300
|
}
|
|
6043
|
-
/**
|
|
6044
|
-
* @public
|
|
6045
|
-
* @enum
|
|
6046
|
-
*/
|
|
6047
|
-
export declare const FaqStatus: {
|
|
6048
|
-
readonly ACTIVE: "ACTIVE";
|
|
6049
|
-
readonly CREATING: "CREATING";
|
|
6050
|
-
readonly DELETING: "DELETING";
|
|
6051
|
-
readonly FAILED: "FAILED";
|
|
6052
|
-
readonly UPDATING: "UPDATING";
|
|
6053
|
-
};
|
|
6054
|
-
/**
|
|
6055
|
-
* @public
|
|
6056
|
-
*/
|
|
6057
|
-
export type FaqStatus = (typeof FaqStatus)[keyof typeof FaqStatus];
|
|
6058
5301
|
/**
|
|
6059
5302
|
* @public
|
|
6060
5303
|
*/
|
|
@@ -6287,18 +5530,6 @@ export interface CapacityUnitsConfiguration {
|
|
|
6287
5530
|
*/
|
|
6288
5531
|
QueryCapacityUnits: number | undefined;
|
|
6289
5532
|
}
|
|
6290
|
-
/**
|
|
6291
|
-
* @public
|
|
6292
|
-
* @enum
|
|
6293
|
-
*/
|
|
6294
|
-
export declare const Order: {
|
|
6295
|
-
readonly ASCENDING: "ASCENDING";
|
|
6296
|
-
readonly DESCENDING: "DESCENDING";
|
|
6297
|
-
};
|
|
6298
|
-
/**
|
|
6299
|
-
* @public
|
|
6300
|
-
*/
|
|
6301
|
-
export type Order = (typeof Order)[keyof typeof Order];
|
|
6302
5533
|
/**
|
|
6303
5534
|
* <p>Provides information for tuning the relevance of a field in a search. When a query
|
|
6304
5535
|
* includes terms that match the field, the results are given a boost in the response based
|
|
@@ -6388,20 +5619,6 @@ export interface Search {
|
|
|
6388
5619
|
*/
|
|
6389
5620
|
Sortable?: boolean | undefined;
|
|
6390
5621
|
}
|
|
6391
|
-
/**
|
|
6392
|
-
* @public
|
|
6393
|
-
* @enum
|
|
6394
|
-
*/
|
|
6395
|
-
export declare const DocumentAttributeValueType: {
|
|
6396
|
-
readonly DATE_VALUE: "DATE_VALUE";
|
|
6397
|
-
readonly LONG_VALUE: "LONG_VALUE";
|
|
6398
|
-
readonly STRING_LIST_VALUE: "STRING_LIST_VALUE";
|
|
6399
|
-
readonly STRING_VALUE: "STRING_VALUE";
|
|
6400
|
-
};
|
|
6401
|
-
/**
|
|
6402
|
-
* @public
|
|
6403
|
-
*/
|
|
6404
|
-
export type DocumentAttributeValueType = (typeof DocumentAttributeValueType)[keyof typeof DocumentAttributeValueType];
|
|
6405
5622
|
/**
|
|
6406
5623
|
* <p>Specifies the properties, such as relevance tuning and searchability, of an index
|
|
6407
5624
|
* field.</p>
|
|
@@ -6475,22 +5692,6 @@ export interface IndexStatistics {
|
|
|
6475
5692
|
*/
|
|
6476
5693
|
TextDocumentStatistics: TextDocumentStatistics | undefined;
|
|
6477
5694
|
}
|
|
6478
|
-
/**
|
|
6479
|
-
* @public
|
|
6480
|
-
* @enum
|
|
6481
|
-
*/
|
|
6482
|
-
export declare const IndexStatus: {
|
|
6483
|
-
readonly ACTIVE: "ACTIVE";
|
|
6484
|
-
readonly CREATING: "CREATING";
|
|
6485
|
-
readonly DELETING: "DELETING";
|
|
6486
|
-
readonly FAILED: "FAILED";
|
|
6487
|
-
readonly SYSTEM_UPDATING: "SYSTEM_UPDATING";
|
|
6488
|
-
readonly UPDATING: "UPDATING";
|
|
6489
|
-
};
|
|
6490
|
-
/**
|
|
6491
|
-
* @public
|
|
6492
|
-
*/
|
|
6493
|
-
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
6494
5695
|
/**
|
|
6495
5696
|
* @public
|
|
6496
5697
|
*/
|
|
@@ -6613,21 +5814,6 @@ export interface DescribePrincipalMappingRequest {
|
|
|
6613
5814
|
*/
|
|
6614
5815
|
GroupId: string | undefined;
|
|
6615
5816
|
}
|
|
6616
|
-
/**
|
|
6617
|
-
* @public
|
|
6618
|
-
* @enum
|
|
6619
|
-
*/
|
|
6620
|
-
export declare const PrincipalMappingStatus: {
|
|
6621
|
-
readonly DELETED: "DELETED";
|
|
6622
|
-
readonly DELETING: "DELETING";
|
|
6623
|
-
readonly FAILED: "FAILED";
|
|
6624
|
-
readonly PROCESSING: "PROCESSING";
|
|
6625
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
6626
|
-
};
|
|
6627
|
-
/**
|
|
6628
|
-
* @public
|
|
6629
|
-
*/
|
|
6630
|
-
export type PrincipalMappingStatus = (typeof PrincipalMappingStatus)[keyof typeof PrincipalMappingStatus];
|
|
6631
5817
|
/**
|
|
6632
5818
|
* <p>Summary information on the processing of <code>PUT</code> and <code>DELETE</code>
|
|
6633
5819
|
* actions for mapping users to their groups.</p>
|
|
@@ -6735,22 +5921,6 @@ export interface DescribeQuerySuggestionsBlockListRequest {
|
|
|
6735
5921
|
*/
|
|
6736
5922
|
Id: string | undefined;
|
|
6737
5923
|
}
|
|
6738
|
-
/**
|
|
6739
|
-
* @public
|
|
6740
|
-
* @enum
|
|
6741
|
-
*/
|
|
6742
|
-
export declare const QuerySuggestionsBlockListStatus: {
|
|
6743
|
-
readonly ACTIVE: "ACTIVE";
|
|
6744
|
-
readonly ACTIVE_BUT_UPDATE_FAILED: "ACTIVE_BUT_UPDATE_FAILED";
|
|
6745
|
-
readonly CREATING: "CREATING";
|
|
6746
|
-
readonly DELETING: "DELETING";
|
|
6747
|
-
readonly FAILED: "FAILED";
|
|
6748
|
-
readonly UPDATING: "UPDATING";
|
|
6749
|
-
};
|
|
6750
|
-
/**
|
|
6751
|
-
* @public
|
|
6752
|
-
*/
|
|
6753
|
-
export type QuerySuggestionsBlockListStatus = (typeof QuerySuggestionsBlockListStatus)[keyof typeof QuerySuggestionsBlockListStatus];
|
|
6754
5924
|
/**
|
|
6755
5925
|
* @public
|
|
6756
5926
|
*/
|
|
@@ -6838,30 +6008,6 @@ export interface DescribeQuerySuggestionsConfigRequest {
|
|
|
6838
6008
|
*/
|
|
6839
6009
|
IndexId: string | undefined;
|
|
6840
6010
|
}
|
|
6841
|
-
/**
|
|
6842
|
-
* @public
|
|
6843
|
-
* @enum
|
|
6844
|
-
*/
|
|
6845
|
-
export declare const Mode: {
|
|
6846
|
-
readonly ENABLED: "ENABLED";
|
|
6847
|
-
readonly LEARN_ONLY: "LEARN_ONLY";
|
|
6848
|
-
};
|
|
6849
|
-
/**
|
|
6850
|
-
* @public
|
|
6851
|
-
*/
|
|
6852
|
-
export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
6853
|
-
/**
|
|
6854
|
-
* @public
|
|
6855
|
-
* @enum
|
|
6856
|
-
*/
|
|
6857
|
-
export declare const QuerySuggestionsStatus: {
|
|
6858
|
-
readonly ACTIVE: "ACTIVE";
|
|
6859
|
-
readonly UPDATING: "UPDATING";
|
|
6860
|
-
};
|
|
6861
|
-
/**
|
|
6862
|
-
* @public
|
|
6863
|
-
*/
|
|
6864
|
-
export type QuerySuggestionsStatus = (typeof QuerySuggestionsStatus)[keyof typeof QuerySuggestionsStatus];
|
|
6865
6011
|
/**
|
|
6866
6012
|
* @public
|
|
6867
6013
|
*/
|
|
@@ -6958,22 +6104,6 @@ export interface DescribeThesaurusRequest {
|
|
|
6958
6104
|
*/
|
|
6959
6105
|
IndexId: string | undefined;
|
|
6960
6106
|
}
|
|
6961
|
-
/**
|
|
6962
|
-
* @public
|
|
6963
|
-
* @enum
|
|
6964
|
-
*/
|
|
6965
|
-
export declare const ThesaurusStatus: {
|
|
6966
|
-
readonly ACTIVE: "ACTIVE";
|
|
6967
|
-
readonly ACTIVE_BUT_UPDATE_FAILED: "ACTIVE_BUT_UPDATE_FAILED";
|
|
6968
|
-
readonly CREATING: "CREATING";
|
|
6969
|
-
readonly DELETING: "DELETING";
|
|
6970
|
-
readonly FAILED: "FAILED";
|
|
6971
|
-
readonly UPDATING: "UPDATING";
|
|
6972
|
-
};
|
|
6973
|
-
/**
|
|
6974
|
-
* @public
|
|
6975
|
-
*/
|
|
6976
|
-
export type ThesaurusStatus = (typeof ThesaurusStatus)[keyof typeof ThesaurusStatus];
|
|
6977
6107
|
/**
|
|
6978
6108
|
* @public
|
|
6979
6109
|
*/
|
|
@@ -7122,18 +6252,6 @@ export interface DisassociatePersonasFromEntitiesResponse {
|
|
|
7122
6252
|
*/
|
|
7123
6253
|
FailedEntityList?: FailedEntity[] | undefined;
|
|
7124
6254
|
}
|
|
7125
|
-
/**
|
|
7126
|
-
* @public
|
|
7127
|
-
* @enum
|
|
7128
|
-
*/
|
|
7129
|
-
export declare const SuggestionType: {
|
|
7130
|
-
readonly DOCUMENT_ATTRIBUTES: "DOCUMENT_ATTRIBUTES";
|
|
7131
|
-
readonly QUERY: "QUERY";
|
|
7132
|
-
};
|
|
7133
|
-
/**
|
|
7134
|
-
* @public
|
|
7135
|
-
*/
|
|
7136
|
-
export type SuggestionType = (typeof SuggestionType)[keyof typeof SuggestionType];
|
|
7137
6255
|
/**
|
|
7138
6256
|
* <p>The document ID and its fields/attributes that are used for a query suggestion, if
|
|
7139
6257
|
* document fields set to use for query suggestions.</p>
|
|
@@ -7242,38 +6360,6 @@ export interface GetQuerySuggestionsResponse {
|
|
|
7242
6360
|
*/
|
|
7243
6361
|
Suggestions?: Suggestion[] | undefined;
|
|
7244
6362
|
}
|
|
7245
|
-
/**
|
|
7246
|
-
* @public
|
|
7247
|
-
* @enum
|
|
7248
|
-
*/
|
|
7249
|
-
export declare const Interval: {
|
|
7250
|
-
readonly ONE_MONTH_AGO: "ONE_MONTH_AGO";
|
|
7251
|
-
readonly ONE_WEEK_AGO: "ONE_WEEK_AGO";
|
|
7252
|
-
readonly THIS_MONTH: "THIS_MONTH";
|
|
7253
|
-
readonly THIS_WEEK: "THIS_WEEK";
|
|
7254
|
-
readonly TWO_MONTHS_AGO: "TWO_MONTHS_AGO";
|
|
7255
|
-
readonly TWO_WEEKS_AGO: "TWO_WEEKS_AGO";
|
|
7256
|
-
};
|
|
7257
|
-
/**
|
|
7258
|
-
* @public
|
|
7259
|
-
*/
|
|
7260
|
-
export type Interval = (typeof Interval)[keyof typeof Interval];
|
|
7261
|
-
/**
|
|
7262
|
-
* @public
|
|
7263
|
-
* @enum
|
|
7264
|
-
*/
|
|
7265
|
-
export declare const MetricType: {
|
|
7266
|
-
readonly AGG_QUERY_DOC_METRICS: "AGG_QUERY_DOC_METRICS";
|
|
7267
|
-
readonly DOCS_BY_CLICK_COUNT: "DOCS_BY_CLICK_COUNT";
|
|
7268
|
-
readonly QUERIES_BY_COUNT: "QUERIES_BY_COUNT";
|
|
7269
|
-
readonly QUERIES_BY_ZERO_CLICK_RATE: "QUERIES_BY_ZERO_CLICK_RATE";
|
|
7270
|
-
readonly QUERIES_BY_ZERO_RESULT_RATE: "QUERIES_BY_ZERO_RESULT_RATE";
|
|
7271
|
-
readonly TREND_QUERY_DOC_METRICS: "TREND_QUERY_DOC_METRICS";
|
|
7272
|
-
};
|
|
7273
|
-
/**
|
|
7274
|
-
* @public
|
|
7275
|
-
*/
|
|
7276
|
-
export type MetricType = (typeof MetricType)[keyof typeof MetricType];
|
|
7277
6363
|
/**
|
|
7278
6364
|
* @public
|
|
7279
6365
|
*/
|
|
@@ -7385,20 +6471,6 @@ export interface GetSnapshotsResponse {
|
|
|
7385
6471
|
*/
|
|
7386
6472
|
NextToken?: string | undefined;
|
|
7387
6473
|
}
|
|
7388
|
-
/**
|
|
7389
|
-
* <p>The input to the request is not valid. Please provide the correct input and try
|
|
7390
|
-
* again.</p>
|
|
7391
|
-
* @public
|
|
7392
|
-
*/
|
|
7393
|
-
export declare class InvalidRequestException extends __BaseException {
|
|
7394
|
-
readonly name: "InvalidRequestException";
|
|
7395
|
-
readonly $fault: "client";
|
|
7396
|
-
Message?: string | undefined;
|
|
7397
|
-
/**
|
|
7398
|
-
* @internal
|
|
7399
|
-
*/
|
|
7400
|
-
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
7401
|
-
}
|
|
7402
6474
|
/**
|
|
7403
6475
|
* @public
|
|
7404
6476
|
*/
|
|
@@ -7521,23 +6593,6 @@ export interface ListDataSourcesResponse {
|
|
|
7521
6593
|
*/
|
|
7522
6594
|
NextToken?: string | undefined;
|
|
7523
6595
|
}
|
|
7524
|
-
/**
|
|
7525
|
-
* @public
|
|
7526
|
-
* @enum
|
|
7527
|
-
*/
|
|
7528
|
-
export declare const DataSourceSyncJobStatus: {
|
|
7529
|
-
readonly ABORTED: "ABORTED";
|
|
7530
|
-
readonly FAILED: "FAILED";
|
|
7531
|
-
readonly INCOMPLETE: "INCOMPLETE";
|
|
7532
|
-
readonly STOPPING: "STOPPING";
|
|
7533
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
7534
|
-
readonly SYNCING: "SYNCING";
|
|
7535
|
-
readonly SYNCING_INDEXING: "SYNCING_INDEXING";
|
|
7536
|
-
};
|
|
7537
|
-
/**
|
|
7538
|
-
* @public
|
|
7539
|
-
*/
|
|
7540
|
-
export type DataSourceSyncJobStatus = (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
7541
6596
|
/**
|
|
7542
6597
|
* @public
|
|
7543
6598
|
*/
|
|
@@ -8352,20 +7407,6 @@ export interface ListTagsForResourceResponse {
|
|
|
8352
7407
|
*/
|
|
8353
7408
|
Tags?: Tag[] | undefined;
|
|
8354
7409
|
}
|
|
8355
|
-
/**
|
|
8356
|
-
* <p>The resource you want to use isn't available. Please check you have provided the
|
|
8357
|
-
* correct resource and try again.</p>
|
|
8358
|
-
* @public
|
|
8359
|
-
*/
|
|
8360
|
-
export declare class ResourceUnavailableException extends __BaseException {
|
|
8361
|
-
readonly name: "ResourceUnavailableException";
|
|
8362
|
-
readonly $fault: "client";
|
|
8363
|
-
Message?: string | undefined;
|
|
8364
|
-
/**
|
|
8365
|
-
* @internal
|
|
8366
|
-
*/
|
|
8367
|
-
constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
|
|
8368
|
-
}
|
|
8369
7410
|
/**
|
|
8370
7411
|
* @public
|
|
8371
7412
|
*/
|
|
@@ -8580,31 +7621,6 @@ export interface ExpandConfiguration {
|
|
|
8580
7621
|
*/
|
|
8581
7622
|
MaxExpandedResultsPerItem?: number | undefined;
|
|
8582
7623
|
}
|
|
8583
|
-
/**
|
|
8584
|
-
* @public
|
|
8585
|
-
* @enum
|
|
8586
|
-
*/
|
|
8587
|
-
export declare const MissingAttributeKeyStrategy: {
|
|
8588
|
-
readonly COLLAPSE: "COLLAPSE";
|
|
8589
|
-
readonly EXPAND: "EXPAND";
|
|
8590
|
-
readonly IGNORE: "IGNORE";
|
|
8591
|
-
};
|
|
8592
|
-
/**
|
|
8593
|
-
* @public
|
|
8594
|
-
*/
|
|
8595
|
-
export type MissingAttributeKeyStrategy = (typeof MissingAttributeKeyStrategy)[keyof typeof MissingAttributeKeyStrategy];
|
|
8596
|
-
/**
|
|
8597
|
-
* @public
|
|
8598
|
-
* @enum
|
|
8599
|
-
*/
|
|
8600
|
-
export declare const SortOrder: {
|
|
8601
|
-
readonly ASC: "ASC";
|
|
8602
|
-
readonly DESC: "DESC";
|
|
8603
|
-
};
|
|
8604
|
-
/**
|
|
8605
|
-
* @public
|
|
8606
|
-
*/
|
|
8607
|
-
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
8608
7624
|
/**
|
|
8609
7625
|
* <p>Specifies the document attribute to use to sort the response to a Amazon Kendra
|
|
8610
7626
|
* query. You can specify a single attribute for sorting. The attribute must have the
|
|
@@ -8733,19 +7749,6 @@ export interface DocumentRelevanceConfiguration {
|
|
|
8733
7749
|
*/
|
|
8734
7750
|
Relevance: Relevance | undefined;
|
|
8735
7751
|
}
|
|
8736
|
-
/**
|
|
8737
|
-
* @public
|
|
8738
|
-
* @enum
|
|
8739
|
-
*/
|
|
8740
|
-
export declare const QueryResultType: {
|
|
8741
|
-
readonly ANSWER: "ANSWER";
|
|
8742
|
-
readonly DOCUMENT: "DOCUMENT";
|
|
8743
|
-
readonly QUESTION_ANSWER: "QUESTION_ANSWER";
|
|
8744
|
-
};
|
|
8745
|
-
/**
|
|
8746
|
-
* @public
|
|
8747
|
-
*/
|
|
8748
|
-
export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
|
|
8749
7752
|
/**
|
|
8750
7753
|
* <p>Provides the configuration information for suggested query spell corrections.</p>
|
|
8751
7754
|
* <p>Suggested spell corrections are based on words that appear in your indexed documents
|
|
@@ -8883,14 +7886,1409 @@ export interface CollapsedResultDetail {
|
|
|
8883
7886
|
ExpandedResults?: ExpandedResultItem[] | undefined;
|
|
8884
7887
|
}
|
|
8885
7888
|
/**
|
|
7889
|
+
* <p>Provides a relative ranking that indicates how confident Amazon Kendra is that the
|
|
7890
|
+
* response is relevant to the query.</p>
|
|
7891
|
+
* @public
|
|
7892
|
+
*/
|
|
7893
|
+
export interface ScoreAttributes {
|
|
7894
|
+
/**
|
|
7895
|
+
* <p>A relative ranking for how relevant the response is to the query.</p>
|
|
7896
|
+
* @public
|
|
7897
|
+
*/
|
|
7898
|
+
ScoreConfidence?: ScoreConfidence | undefined;
|
|
7899
|
+
}
|
|
7900
|
+
/**
|
|
7901
|
+
* <p>Provides information about a table cell in a table excerpt.</p>
|
|
7902
|
+
* @public
|
|
7903
|
+
*/
|
|
7904
|
+
export interface TableCell {
|
|
7905
|
+
/**
|
|
7906
|
+
* <p>The actual value or content within a table cell. A table cell could contain a date
|
|
7907
|
+
* value of a year, or a string value of text, for example.</p>
|
|
7908
|
+
* @public
|
|
7909
|
+
*/
|
|
7910
|
+
Value?: string | undefined;
|
|
7911
|
+
/**
|
|
7912
|
+
* <p>
|
|
7913
|
+
* <code>TRUE</code> if the response of the table cell is the top answer. This is the
|
|
7914
|
+
* cell value or content with the highest confidence score or is the most relevant to the
|
|
7915
|
+
* query.</p>
|
|
7916
|
+
* @public
|
|
7917
|
+
*/
|
|
7918
|
+
TopAnswer?: boolean | undefined;
|
|
7919
|
+
/**
|
|
7920
|
+
* <p>
|
|
7921
|
+
* <code>TRUE</code> means that the table cell has a high enough confidence and is
|
|
7922
|
+
* relevant to the query, so the value or content should be highlighted.</p>
|
|
7923
|
+
* @public
|
|
7924
|
+
*/
|
|
7925
|
+
Highlighted?: boolean | undefined;
|
|
7926
|
+
/**
|
|
7927
|
+
* <p>
|
|
7928
|
+
* <code>TRUE</code> means that the table cell should be treated as a header.</p>
|
|
7929
|
+
* @public
|
|
7930
|
+
*/
|
|
7931
|
+
Header?: boolean | undefined;
|
|
7932
|
+
}
|
|
7933
|
+
/**
|
|
7934
|
+
* <p>Information about a row in a table excerpt.</p>
|
|
7935
|
+
* @public
|
|
7936
|
+
*/
|
|
7937
|
+
export interface TableRow {
|
|
7938
|
+
/**
|
|
7939
|
+
* <p>A list of table cells in a row.</p>
|
|
7940
|
+
* @public
|
|
7941
|
+
*/
|
|
7942
|
+
Cells?: TableCell[] | undefined;
|
|
7943
|
+
}
|
|
7944
|
+
/**
|
|
7945
|
+
* <p>An excerpt from a table within a document. The table excerpt displays up to five
|
|
7946
|
+
* columns and three rows, depending on how many table cells are relevant to the query and
|
|
7947
|
+
* how many columns are available in the original table. The top most relevant cell is
|
|
7948
|
+
* displayed in the table excerpt, along with the next most relevant cells.</p>
|
|
8886
7949
|
* @public
|
|
8887
|
-
* @enum
|
|
8888
7950
|
*/
|
|
8889
|
-
export
|
|
8890
|
-
|
|
8891
|
-
|
|
8892
|
-
|
|
7951
|
+
export interface TableExcerpt {
|
|
7952
|
+
/**
|
|
7953
|
+
* <p>A list of rows in the table excerpt.</p>
|
|
7954
|
+
* @public
|
|
7955
|
+
*/
|
|
7956
|
+
Rows?: TableRow[] | undefined;
|
|
7957
|
+
/**
|
|
7958
|
+
* <p>A count of the number of rows in the original table within the document.</p>
|
|
7959
|
+
* @public
|
|
7960
|
+
*/
|
|
7961
|
+
TotalNumberOfRows?: number | undefined;
|
|
7962
|
+
}
|
|
8893
7963
|
/**
|
|
7964
|
+
* <p>A single query result.</p>
|
|
7965
|
+
* <p>A query result contains information about a document returned by the query. This
|
|
7966
|
+
* includes the original location of the document, a list of attributes assigned to the
|
|
7967
|
+
* document, and relevant text from the document that satisfies the query.</p>
|
|
8894
7968
|
* @public
|
|
8895
7969
|
*/
|
|
8896
|
-
export
|
|
7970
|
+
export interface QueryResultItem {
|
|
7971
|
+
/**
|
|
7972
|
+
* <p>The unique identifier for the query result item id (<code>Id</code>) and the query
|
|
7973
|
+
* result item document id (<code>DocumentId</code>) combined. The value of this field changes
|
|
7974
|
+
* with every request, even when you have the same documents.</p>
|
|
7975
|
+
* @public
|
|
7976
|
+
*/
|
|
7977
|
+
Id?: string | undefined;
|
|
7978
|
+
/**
|
|
7979
|
+
* <p>The type of document within the response. For example, a response could include a
|
|
7980
|
+
* question-answer that's relevant to the query.</p>
|
|
7981
|
+
* @public
|
|
7982
|
+
*/
|
|
7983
|
+
Type?: QueryResultType | undefined;
|
|
7984
|
+
/**
|
|
7985
|
+
* <p>If the <code>Type</code> of document within the response is <code>ANSWER</code>, then it
|
|
7986
|
+
* is either a <code>TABLE</code> answer or <code>TEXT</code> answer. If it's a table answer,
|
|
7987
|
+
* a table excerpt is returned in <code>TableExcerpt</code>. If it's a text answer, a text
|
|
7988
|
+
* excerpt is returned in <code>DocumentExcerpt</code>.</p>
|
|
7989
|
+
* @public
|
|
7990
|
+
*/
|
|
7991
|
+
Format?: QueryResultFormat | undefined;
|
|
7992
|
+
/**
|
|
7993
|
+
* <p>One or more additional fields/attributes associated with the query result.</p>
|
|
7994
|
+
* @public
|
|
7995
|
+
*/
|
|
7996
|
+
AdditionalAttributes?: AdditionalResultAttribute[] | undefined;
|
|
7997
|
+
/**
|
|
7998
|
+
* <p>The identifier for the document.</p>
|
|
7999
|
+
* @public
|
|
8000
|
+
*/
|
|
8001
|
+
DocumentId?: string | undefined;
|
|
8002
|
+
/**
|
|
8003
|
+
* <p>The title of the document. Contains the text of the title and information for
|
|
8004
|
+
* highlighting the relevant terms in the title.</p>
|
|
8005
|
+
* @public
|
|
8006
|
+
*/
|
|
8007
|
+
DocumentTitle?: TextWithHighlights | undefined;
|
|
8008
|
+
/**
|
|
8009
|
+
* <p>An extract of the text in the document. Contains information about highlighting the
|
|
8010
|
+
* relevant terms in the excerpt.</p>
|
|
8011
|
+
* @public
|
|
8012
|
+
*/
|
|
8013
|
+
DocumentExcerpt?: TextWithHighlights | undefined;
|
|
8014
|
+
/**
|
|
8015
|
+
* <p>The URI of the original location of the document.</p>
|
|
8016
|
+
* @public
|
|
8017
|
+
*/
|
|
8018
|
+
DocumentURI?: string | undefined;
|
|
8019
|
+
/**
|
|
8020
|
+
* <p>An array of document fields/attributes assigned to a document in the search results. For
|
|
8021
|
+
* example, the document author (<code>_author</code>) or the source URI
|
|
8022
|
+
* (<code>_source_uri</code>) of the document.</p>
|
|
8023
|
+
* @public
|
|
8024
|
+
*/
|
|
8025
|
+
DocumentAttributes?: DocumentAttribute[] | undefined;
|
|
8026
|
+
/**
|
|
8027
|
+
* <p>Indicates the confidence level of Amazon Kendra providing a relevant result for the
|
|
8028
|
+
* query. Each result is placed into a bin that indicates the confidence,
|
|
8029
|
+
* <code>VERY_HIGH</code>, <code>HIGH</code>, <code>MEDIUM</code> and <code>LOW</code>. You
|
|
8030
|
+
* can use the score to determine if a response meets the confidence needed for your
|
|
8031
|
+
* application.</p>
|
|
8032
|
+
* <p>The field is only set to <code>LOW</code> when the <code>Type</code> field is set to
|
|
8033
|
+
* <code>DOCUMENT</code> and Amazon Kendra is not confident that the result is
|
|
8034
|
+
* relevant to the query.</p>
|
|
8035
|
+
* @public
|
|
8036
|
+
*/
|
|
8037
|
+
ScoreAttributes?: ScoreAttributes | undefined;
|
|
8038
|
+
/**
|
|
8039
|
+
* <p>A token that identifies a particular result from a particular query. Use this token to
|
|
8040
|
+
* 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
|
|
8041
|
+
* feedback</a>.</p>
|
|
8042
|
+
* @public
|
|
8043
|
+
*/
|
|
8044
|
+
FeedbackToken?: string | undefined;
|
|
8045
|
+
/**
|
|
8046
|
+
* <p>An excerpt from a table within a document.</p>
|
|
8047
|
+
* @public
|
|
8048
|
+
*/
|
|
8049
|
+
TableExcerpt?: TableExcerpt | undefined;
|
|
8050
|
+
/**
|
|
8051
|
+
* <p>Provides details about a collapsed group of search results.</p>
|
|
8052
|
+
* @public
|
|
8053
|
+
*/
|
|
8054
|
+
CollapsedResultDetail?: CollapsedResultDetail | undefined;
|
|
8055
|
+
}
|
|
8056
|
+
/**
|
|
8057
|
+
* <p>A corrected misspelled word in a query.</p>
|
|
8058
|
+
* @public
|
|
8059
|
+
*/
|
|
8060
|
+
export interface Correction {
|
|
8061
|
+
/**
|
|
8062
|
+
* <p>The zero-based location in the response string or text where
|
|
8063
|
+
* the corrected word starts.</p>
|
|
8064
|
+
* @public
|
|
8065
|
+
*/
|
|
8066
|
+
BeginOffset?: number | undefined;
|
|
8067
|
+
/**
|
|
8068
|
+
* <p>The zero-based location in the response string or text where
|
|
8069
|
+
* the corrected word ends.</p>
|
|
8070
|
+
* @public
|
|
8071
|
+
*/
|
|
8072
|
+
EndOffset?: number | undefined;
|
|
8073
|
+
/**
|
|
8074
|
+
* <p>The string or text of a misspelled word in a query.</p>
|
|
8075
|
+
* @public
|
|
8076
|
+
*/
|
|
8077
|
+
Term?: string | undefined;
|
|
8078
|
+
/**
|
|
8079
|
+
* <p>The string or text of a corrected misspelled word in a query.</p>
|
|
8080
|
+
* @public
|
|
8081
|
+
*/
|
|
8082
|
+
CorrectedTerm?: string | undefined;
|
|
8083
|
+
}
|
|
8084
|
+
/**
|
|
8085
|
+
* <p>A query with suggested spell corrections. </p>
|
|
8086
|
+
* @public
|
|
8087
|
+
*/
|
|
8088
|
+
export interface SpellCorrectedQuery {
|
|
8089
|
+
/**
|
|
8090
|
+
* <p>The query with the suggested spell corrections.</p>
|
|
8091
|
+
* @public
|
|
8092
|
+
*/
|
|
8093
|
+
SuggestedQueryText?: string | undefined;
|
|
8094
|
+
/**
|
|
8095
|
+
* <p>The corrected misspelled word or words in a query.</p>
|
|
8096
|
+
* @public
|
|
8097
|
+
*/
|
|
8098
|
+
Corrections?: Correction[] | undefined;
|
|
8099
|
+
}
|
|
8100
|
+
/**
|
|
8101
|
+
* <p>The warning code and message that explains a problem with a query.</p>
|
|
8102
|
+
* @public
|
|
8103
|
+
*/
|
|
8104
|
+
export interface Warning {
|
|
8105
|
+
/**
|
|
8106
|
+
* <p>The message that explains the problem with the query.</p>
|
|
8107
|
+
* @public
|
|
8108
|
+
*/
|
|
8109
|
+
Message?: string | undefined;
|
|
8110
|
+
/**
|
|
8111
|
+
* <p>The code used to show the type of warning for the query.</p>
|
|
8112
|
+
* @public
|
|
8113
|
+
*/
|
|
8114
|
+
Code?: WarningCode | undefined;
|
|
8115
|
+
}
|
|
8116
|
+
/**
|
|
8117
|
+
* <p>A single retrieved relevant passage result.</p>
|
|
8118
|
+
* @public
|
|
8119
|
+
*/
|
|
8120
|
+
export interface RetrieveResultItem {
|
|
8121
|
+
/**
|
|
8122
|
+
* <p>The identifier of the relevant passage result.</p>
|
|
8123
|
+
* @public
|
|
8124
|
+
*/
|
|
8125
|
+
Id?: string | undefined;
|
|
8126
|
+
/**
|
|
8127
|
+
* <p>The identifier of the document.</p>
|
|
8128
|
+
* @public
|
|
8129
|
+
*/
|
|
8130
|
+
DocumentId?: string | undefined;
|
|
8131
|
+
/**
|
|
8132
|
+
* <p>The title of the document.</p>
|
|
8133
|
+
* @public
|
|
8134
|
+
*/
|
|
8135
|
+
DocumentTitle?: string | undefined;
|
|
8136
|
+
/**
|
|
8137
|
+
* <p>The contents of the relevant passage.</p>
|
|
8138
|
+
* @public
|
|
8139
|
+
*/
|
|
8140
|
+
Content?: string | undefined;
|
|
8141
|
+
/**
|
|
8142
|
+
* <p>The URI of the original location of the document.</p>
|
|
8143
|
+
* @public
|
|
8144
|
+
*/
|
|
8145
|
+
DocumentURI?: string | undefined;
|
|
8146
|
+
/**
|
|
8147
|
+
* <p>An array of document fields/attributes assigned to a document in the search results.
|
|
8148
|
+
* For example, the document author (<code>_author</code>) or the source URI
|
|
8149
|
+
* (<code>_source_uri</code>) of the document.</p>
|
|
8150
|
+
* @public
|
|
8151
|
+
*/
|
|
8152
|
+
DocumentAttributes?: DocumentAttribute[] | undefined;
|
|
8153
|
+
/**
|
|
8154
|
+
* <p>The confidence score bucket for a retrieved passage result. The confidence bucket
|
|
8155
|
+
* provides a relative ranking that indicates how confident Amazon Kendra is that the
|
|
8156
|
+
* response is relevant to the query.</p>
|
|
8157
|
+
* @public
|
|
8158
|
+
*/
|
|
8159
|
+
ScoreAttributes?: ScoreAttributes | undefined;
|
|
8160
|
+
}
|
|
8161
|
+
/**
|
|
8162
|
+
* @public
|
|
8163
|
+
*/
|
|
8164
|
+
export interface RetrieveResult {
|
|
8165
|
+
/**
|
|
8166
|
+
* <p>The identifier of query used for the search. You also use <code>QueryId</code> to
|
|
8167
|
+
* identify the search when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">Submitfeedback</a>
|
|
8168
|
+
* API.</p>
|
|
8169
|
+
* @public
|
|
8170
|
+
*/
|
|
8171
|
+
QueryId?: string | undefined;
|
|
8172
|
+
/**
|
|
8173
|
+
* <p>The results of the retrieved relevant passages for the search.</p>
|
|
8174
|
+
* @public
|
|
8175
|
+
*/
|
|
8176
|
+
ResultItems?: RetrieveResultItem[] | undefined;
|
|
8177
|
+
}
|
|
8178
|
+
/**
|
|
8179
|
+
* @public
|
|
8180
|
+
*/
|
|
8181
|
+
export interface StartDataSourceSyncJobRequest {
|
|
8182
|
+
/**
|
|
8183
|
+
* <p>The identifier of the data source connector to synchronize.</p>
|
|
8184
|
+
* @public
|
|
8185
|
+
*/
|
|
8186
|
+
Id: string | undefined;
|
|
8187
|
+
/**
|
|
8188
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
8189
|
+
* @public
|
|
8190
|
+
*/
|
|
8191
|
+
IndexId: string | undefined;
|
|
8192
|
+
}
|
|
8193
|
+
/**
|
|
8194
|
+
* @public
|
|
8195
|
+
*/
|
|
8196
|
+
export interface StartDataSourceSyncJobResponse {
|
|
8197
|
+
/**
|
|
8198
|
+
* <p>Identifies a particular synchronization job.</p>
|
|
8199
|
+
* @public
|
|
8200
|
+
*/
|
|
8201
|
+
ExecutionId?: string | undefined;
|
|
8202
|
+
}
|
|
8203
|
+
/**
|
|
8204
|
+
* @public
|
|
8205
|
+
*/
|
|
8206
|
+
export interface StopDataSourceSyncJobRequest {
|
|
8207
|
+
/**
|
|
8208
|
+
* <p>The identifier of the data source connector for which to stop the synchronization
|
|
8209
|
+
* jobs.</p>
|
|
8210
|
+
* @public
|
|
8211
|
+
*/
|
|
8212
|
+
Id: string | undefined;
|
|
8213
|
+
/**
|
|
8214
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
8215
|
+
* @public
|
|
8216
|
+
*/
|
|
8217
|
+
IndexId: string | undefined;
|
|
8218
|
+
}
|
|
8219
|
+
/**
|
|
8220
|
+
* <p>Gathers information about when a particular result was clicked by a user. Your
|
|
8221
|
+
* application uses the <code>SubmitFeedback</code> API to provide click
|
|
8222
|
+
* information.</p>
|
|
8223
|
+
* @public
|
|
8224
|
+
*/
|
|
8225
|
+
export interface ClickFeedback {
|
|
8226
|
+
/**
|
|
8227
|
+
* <p>The identifier of the search result that was clicked.</p>
|
|
8228
|
+
* @public
|
|
8229
|
+
*/
|
|
8230
|
+
ResultId: string | undefined;
|
|
8231
|
+
/**
|
|
8232
|
+
* <p>The Unix timestamp when the result was clicked.</p>
|
|
8233
|
+
* @public
|
|
8234
|
+
*/
|
|
8235
|
+
ClickTime: Date | undefined;
|
|
8236
|
+
}
|
|
8237
|
+
/**
|
|
8238
|
+
* <p>Provides feedback on how relevant a document is to a search. Your application uses the
|
|
8239
|
+
* <code>SubmitFeedback</code> API to provide relevance information.</p>
|
|
8240
|
+
* @public
|
|
8241
|
+
*/
|
|
8242
|
+
export interface RelevanceFeedback {
|
|
8243
|
+
/**
|
|
8244
|
+
* <p>The identifier of the search result that the user provided relevance feedback
|
|
8245
|
+
* for.</p>
|
|
8246
|
+
* @public
|
|
8247
|
+
*/
|
|
8248
|
+
ResultId: string | undefined;
|
|
8249
|
+
/**
|
|
8250
|
+
* <p>Whether the document was relevant or not relevant to the search.</p>
|
|
8251
|
+
* @public
|
|
8252
|
+
*/
|
|
8253
|
+
RelevanceValue: RelevanceType | undefined;
|
|
8254
|
+
}
|
|
8255
|
+
/**
|
|
8256
|
+
* @public
|
|
8257
|
+
*/
|
|
8258
|
+
export interface SubmitFeedbackRequest {
|
|
8259
|
+
/**
|
|
8260
|
+
* <p>The identifier of the index that was queried.</p>
|
|
8261
|
+
* @public
|
|
8262
|
+
*/
|
|
8263
|
+
IndexId: string | undefined;
|
|
8264
|
+
/**
|
|
8265
|
+
* <p>The identifier of the specific query for which you are submitting
|
|
8266
|
+
* feedback. The query ID is returned in the response to the
|
|
8267
|
+
* <code>Query</code> API.</p>
|
|
8268
|
+
* @public
|
|
8269
|
+
*/
|
|
8270
|
+
QueryId: string | undefined;
|
|
8271
|
+
/**
|
|
8272
|
+
* <p>Tells Amazon Kendra that a particular search result link was chosen
|
|
8273
|
+
* by the user. </p>
|
|
8274
|
+
* @public
|
|
8275
|
+
*/
|
|
8276
|
+
ClickFeedbackItems?: ClickFeedback[] | undefined;
|
|
8277
|
+
/**
|
|
8278
|
+
* <p>Provides Amazon Kendra with relevant or not relevant feedback for
|
|
8279
|
+
* whether a particular item was relevant to the search.</p>
|
|
8280
|
+
* @public
|
|
8281
|
+
*/
|
|
8282
|
+
RelevanceFeedbackItems?: RelevanceFeedback[] | undefined;
|
|
8283
|
+
}
|
|
8284
|
+
/**
|
|
8285
|
+
* @public
|
|
8286
|
+
*/
|
|
8287
|
+
export interface TagResourceRequest {
|
|
8288
|
+
/**
|
|
8289
|
+
* <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag.
|
|
8290
|
+
* For example, the ARN of an index is constructed as follows:
|
|
8291
|
+
* <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
|
|
8292
|
+
* For information on how to construct an ARN for all types of Amazon Kendra resources, see
|
|
8293
|
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
|
|
8294
|
+
* types</a>.</p>
|
|
8295
|
+
* @public
|
|
8296
|
+
*/
|
|
8297
|
+
ResourceARN: string | undefined;
|
|
8298
|
+
/**
|
|
8299
|
+
* <p>A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already
|
|
8300
|
+
* exists, the existing value is replaced with the new value.</p>
|
|
8301
|
+
* @public
|
|
8302
|
+
*/
|
|
8303
|
+
Tags: Tag[] | undefined;
|
|
8304
|
+
}
|
|
8305
|
+
/**
|
|
8306
|
+
* @public
|
|
8307
|
+
*/
|
|
8308
|
+
export interface TagResourceResponse {
|
|
8309
|
+
}
|
|
8310
|
+
/**
|
|
8311
|
+
* @public
|
|
8312
|
+
*/
|
|
8313
|
+
export interface UntagResourceRequest {
|
|
8314
|
+
/**
|
|
8315
|
+
* <p>The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag.
|
|
8316
|
+
* For example, the ARN of an index is constructed as follows:
|
|
8317
|
+
* <i>arn:aws:kendra:your-region:your-account-id:index/index-id</i>
|
|
8318
|
+
* For information on how to construct an ARN for all types of Amazon Kendra resources, see
|
|
8319
|
+
* <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies">Resource
|
|
8320
|
+
* types</a>.</p>
|
|
8321
|
+
* @public
|
|
8322
|
+
*/
|
|
8323
|
+
ResourceARN: string | undefined;
|
|
8324
|
+
/**
|
|
8325
|
+
* <p>A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag
|
|
8326
|
+
* key doesn't exist for the resource, it is ignored.</p>
|
|
8327
|
+
* @public
|
|
8328
|
+
*/
|
|
8329
|
+
TagKeys: string[] | undefined;
|
|
8330
|
+
}
|
|
8331
|
+
/**
|
|
8332
|
+
* @public
|
|
8333
|
+
*/
|
|
8334
|
+
export interface UntagResourceResponse {
|
|
8335
|
+
}
|
|
8336
|
+
/**
|
|
8337
|
+
* @public
|
|
8338
|
+
*/
|
|
8339
|
+
export interface UpdateAccessControlConfigurationRequest {
|
|
8340
|
+
/**
|
|
8341
|
+
* <p>The identifier of the index for an access control configuration.</p>
|
|
8342
|
+
* @public
|
|
8343
|
+
*/
|
|
8344
|
+
IndexId: string | undefined;
|
|
8345
|
+
/**
|
|
8346
|
+
* <p>The identifier of the access control configuration you want to update.</p>
|
|
8347
|
+
* @public
|
|
8348
|
+
*/
|
|
8349
|
+
Id: string | undefined;
|
|
8350
|
+
/**
|
|
8351
|
+
* <p>A new name for the access control configuration.</p>
|
|
8352
|
+
* @public
|
|
8353
|
+
*/
|
|
8354
|
+
Name?: string | undefined;
|
|
8355
|
+
/**
|
|
8356
|
+
* <p>A new description for the access control configuration.</p>
|
|
8357
|
+
* @public
|
|
8358
|
+
*/
|
|
8359
|
+
Description?: string | undefined;
|
|
8360
|
+
/**
|
|
8361
|
+
* <p>Information you want to update on principals (users and/or groups) and which documents
|
|
8362
|
+
* they should have access to. This is useful for user context filtering, where search
|
|
8363
|
+
* results are filtered based on the user or their group access to documents.</p>
|
|
8364
|
+
* @public
|
|
8365
|
+
*/
|
|
8366
|
+
AccessControlList?: Principal[] | undefined;
|
|
8367
|
+
/**
|
|
8368
|
+
* <p>The updated list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the
|
|
8369
|
+
* hierarchy for which documents users should have access to.</p>
|
|
8370
|
+
* @public
|
|
8371
|
+
*/
|
|
8372
|
+
HierarchicalAccessControlList?: HierarchicalPrincipal[] | undefined;
|
|
8373
|
+
}
|
|
8374
|
+
/**
|
|
8375
|
+
* @public
|
|
8376
|
+
*/
|
|
8377
|
+
export interface UpdateAccessControlConfigurationResponse {
|
|
8378
|
+
}
|
|
8379
|
+
/**
|
|
8380
|
+
* @public
|
|
8381
|
+
*/
|
|
8382
|
+
export interface UpdateDataSourceRequest {
|
|
8383
|
+
/**
|
|
8384
|
+
* <p>The identifier of the data source connector you want to update.</p>
|
|
8385
|
+
* @public
|
|
8386
|
+
*/
|
|
8387
|
+
Id: string | undefined;
|
|
8388
|
+
/**
|
|
8389
|
+
* <p>A new name for the data source connector.</p>
|
|
8390
|
+
* @public
|
|
8391
|
+
*/
|
|
8392
|
+
Name?: string | undefined;
|
|
8393
|
+
/**
|
|
8394
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
8395
|
+
* @public
|
|
8396
|
+
*/
|
|
8397
|
+
IndexId: string | undefined;
|
|
8398
|
+
/**
|
|
8399
|
+
* <p>Configuration information you want to update for the data source connector.</p>
|
|
8400
|
+
* @public
|
|
8401
|
+
*/
|
|
8402
|
+
Configuration?: DataSourceConfiguration | undefined;
|
|
8403
|
+
/**
|
|
8404
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
|
|
8405
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
8406
|
+
* @public
|
|
8407
|
+
*/
|
|
8408
|
+
VpcConfiguration?: DataSourceVpcConfiguration | undefined;
|
|
8409
|
+
/**
|
|
8410
|
+
* <p>A new description for the data source connector.</p>
|
|
8411
|
+
* @public
|
|
8412
|
+
*/
|
|
8413
|
+
Description?: string | undefined;
|
|
8414
|
+
/**
|
|
8415
|
+
* <p>The sync schedule you want to update for the data source connector.</p>
|
|
8416
|
+
* @public
|
|
8417
|
+
*/
|
|
8418
|
+
Schedule?: string | undefined;
|
|
8419
|
+
/**
|
|
8420
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
8421
|
+
* the data source and 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>
|
|
8422
|
+
* @public
|
|
8423
|
+
*/
|
|
8424
|
+
RoleArn?: string | undefined;
|
|
8425
|
+
/**
|
|
8426
|
+
* <p>The code for a language you want to update for the data source connector.
|
|
8427
|
+
* This allows you to support a language for all
|
|
8428
|
+
* documents when updating the data source. English is supported
|
|
8429
|
+
* by default. For more information on supported languages, including their codes,
|
|
8430
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html">Adding
|
|
8431
|
+
* documents in languages other than English</a>.</p>
|
|
8432
|
+
* @public
|
|
8433
|
+
*/
|
|
8434
|
+
LanguageCode?: string | undefined;
|
|
8435
|
+
/**
|
|
8436
|
+
* <p>Configuration information you want to update for altering document metadata and
|
|
8437
|
+
* content during the document ingestion process.</p>
|
|
8438
|
+
* <p>For more information on how to create, modify and delete document metadata, or make
|
|
8439
|
+
* 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>
|
|
8440
|
+
* @public
|
|
8441
|
+
*/
|
|
8442
|
+
CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | undefined;
|
|
8443
|
+
}
|
|
8444
|
+
/**
|
|
8445
|
+
* @public
|
|
8446
|
+
*/
|
|
8447
|
+
export interface UpdateExperienceRequest {
|
|
8448
|
+
/**
|
|
8449
|
+
* <p>The identifier of your Amazon Kendra experience you want to update.</p>
|
|
8450
|
+
* @public
|
|
8451
|
+
*/
|
|
8452
|
+
Id: string | undefined;
|
|
8453
|
+
/**
|
|
8454
|
+
* <p>A new name for your Amazon Kendra experience.</p>
|
|
8455
|
+
* @public
|
|
8456
|
+
*/
|
|
8457
|
+
Name?: string | undefined;
|
|
8458
|
+
/**
|
|
8459
|
+
* <p>The identifier of the index for your Amazon Kendra experience.</p>
|
|
8460
|
+
* @public
|
|
8461
|
+
*/
|
|
8462
|
+
IndexId: string | undefined;
|
|
8463
|
+
/**
|
|
8464
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role with permission to access
|
|
8465
|
+
* the <code>Query</code> API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
8466
|
+
* API, and IAM Identity Center that stores your users and groups information.
|
|
8467
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
8468
|
+
* @public
|
|
8469
|
+
*/
|
|
8470
|
+
RoleArn?: string | undefined;
|
|
8471
|
+
/**
|
|
8472
|
+
* <p>Configuration information you want to update for your Amazon Kendra experience.</p>
|
|
8473
|
+
* @public
|
|
8474
|
+
*/
|
|
8475
|
+
Configuration?: ExperienceConfiguration | undefined;
|
|
8476
|
+
/**
|
|
8477
|
+
* <p>A new description for your Amazon Kendra experience.</p>
|
|
8478
|
+
* @public
|
|
8479
|
+
*/
|
|
8480
|
+
Description?: string | undefined;
|
|
8481
|
+
}
|
|
8482
|
+
/**
|
|
8483
|
+
* @public
|
|
8484
|
+
*/
|
|
8485
|
+
export interface UpdateFeaturedResultsSetRequest {
|
|
8486
|
+
/**
|
|
8487
|
+
* <p>The identifier of the index used for featuring results.</p>
|
|
8488
|
+
* @public
|
|
8489
|
+
*/
|
|
8490
|
+
IndexId: string | undefined;
|
|
8491
|
+
/**
|
|
8492
|
+
* <p>The identifier of the set of featured results that you want to update.</p>
|
|
8493
|
+
* @public
|
|
8494
|
+
*/
|
|
8495
|
+
FeaturedResultsSetId: string | undefined;
|
|
8496
|
+
/**
|
|
8497
|
+
* <p>A new name for the set of featured results.</p>
|
|
8498
|
+
* @public
|
|
8499
|
+
*/
|
|
8500
|
+
FeaturedResultsSetName?: string | undefined;
|
|
8501
|
+
/**
|
|
8502
|
+
* <p>A new description for the set of featured results.</p>
|
|
8503
|
+
* @public
|
|
8504
|
+
*/
|
|
8505
|
+
Description?: string | undefined;
|
|
8506
|
+
/**
|
|
8507
|
+
* <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>.
|
|
8508
|
+
* When the value is <code>ACTIVE</code>, featured results are ready for
|
|
8509
|
+
* use. You can still configure your settings before setting the status
|
|
8510
|
+
* to <code>ACTIVE</code>. The queries you specify for featured results
|
|
8511
|
+
* must be unique per featured results set for each index, whether the
|
|
8512
|
+
* status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>
|
|
8513
|
+
* @public
|
|
8514
|
+
*/
|
|
8515
|
+
Status?: FeaturedResultsSetStatus | undefined;
|
|
8516
|
+
/**
|
|
8517
|
+
* <p>A list of queries for featuring results. For more information on the
|
|
8518
|
+
* list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
|
|
8519
|
+
* @public
|
|
8520
|
+
*/
|
|
8521
|
+
QueryTexts?: string[] | undefined;
|
|
8522
|
+
/**
|
|
8523
|
+
* <p>A list of document IDs for the documents you want to feature at the
|
|
8524
|
+
* top of the search results page. For more information on the list of
|
|
8525
|
+
* featured documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
|
|
8526
|
+
* @public
|
|
8527
|
+
*/
|
|
8528
|
+
FeaturedDocuments?: FeaturedDocument[] | undefined;
|
|
8529
|
+
}
|
|
8530
|
+
/**
|
|
8531
|
+
* @public
|
|
8532
|
+
*/
|
|
8533
|
+
export interface UpdateFeaturedResultsSetResponse {
|
|
8534
|
+
/**
|
|
8535
|
+
* <p>Information on the set of featured results. This includes the identifier
|
|
8536
|
+
* of the featured results set, whether the featured results set is active
|
|
8537
|
+
* or inactive, when the featured results set was last updated, and more.</p>
|
|
8538
|
+
* @public
|
|
8539
|
+
*/
|
|
8540
|
+
FeaturedResultsSet?: FeaturedResultsSet | undefined;
|
|
8541
|
+
}
|
|
8542
|
+
/**
|
|
8543
|
+
* @public
|
|
8544
|
+
*/
|
|
8545
|
+
export interface UpdateIndexRequest {
|
|
8546
|
+
/**
|
|
8547
|
+
* <p>The identifier of the index you want to update.</p>
|
|
8548
|
+
* @public
|
|
8549
|
+
*/
|
|
8550
|
+
Id: string | undefined;
|
|
8551
|
+
/**
|
|
8552
|
+
* <p>A new name for the index.</p>
|
|
8553
|
+
* @public
|
|
8554
|
+
*/
|
|
8555
|
+
Name?: string | undefined;
|
|
8556
|
+
/**
|
|
8557
|
+
* <p>An Identity and Access Management (IAM) role that gives Amazon Kendra
|
|
8558
|
+
* permission to access Amazon CloudWatch logs and metrics.</p>
|
|
8559
|
+
* @public
|
|
8560
|
+
*/
|
|
8561
|
+
RoleArn?: string | undefined;
|
|
8562
|
+
/**
|
|
8563
|
+
* <p>A new description for the index.</p>
|
|
8564
|
+
* @public
|
|
8565
|
+
*/
|
|
8566
|
+
Description?: string | undefined;
|
|
8567
|
+
/**
|
|
8568
|
+
* <p>The document metadata configuration you want to update for the index. Document metadata
|
|
8569
|
+
* are fields or attributes associated with your documents. For example, the company department
|
|
8570
|
+
* name associated with each document.</p>
|
|
8571
|
+
* @public
|
|
8572
|
+
*/
|
|
8573
|
+
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[] | undefined;
|
|
8574
|
+
/**
|
|
8575
|
+
* <p>Sets the number of additional document storage and query capacity units that should be
|
|
8576
|
+
* used by the index. You can change the capacity of the index up to 5 times per day, or make 5
|
|
8577
|
+
* API calls.</p>
|
|
8578
|
+
* <p>If you are using extra storage units, you can't reduce the storage capacity below what is
|
|
8579
|
+
* required to meet the storage needs for your index.</p>
|
|
8580
|
+
* @public
|
|
8581
|
+
*/
|
|
8582
|
+
CapacityUnits?: CapacityUnitsConfiguration | undefined;
|
|
8583
|
+
/**
|
|
8584
|
+
* <p>The user token configuration.</p>
|
|
8585
|
+
* <important>
|
|
8586
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
8587
|
+
* <code>UserTokenConfigurations</code> to configure user context policy, Amazon Kendra returns
|
|
8588
|
+
* a <code>ValidationException</code> error.</p>
|
|
8589
|
+
* </important>
|
|
8590
|
+
* @public
|
|
8591
|
+
*/
|
|
8592
|
+
UserTokenConfigurations?: UserTokenConfiguration[] | undefined;
|
|
8593
|
+
/**
|
|
8594
|
+
* <p>The user context policy.</p>
|
|
8595
|
+
* <important>
|
|
8596
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use
|
|
8597
|
+
* <code>ATTRIBUTE_FILTER</code> to filter search results by user context. If you're
|
|
8598
|
+
* using an Amazon Kendra Gen AI Enterprise Edition index and you try to use
|
|
8599
|
+
* <code>USER_TOKEN</code> to configure user context policy, Amazon Kendra returns a
|
|
8600
|
+
* <code>ValidationException</code> error.</p>
|
|
8601
|
+
* </important>
|
|
8602
|
+
* @public
|
|
8603
|
+
*/
|
|
8604
|
+
UserContextPolicy?: UserContextPolicy | undefined;
|
|
8605
|
+
/**
|
|
8606
|
+
* <p>Gets users and groups from IAM Identity Center identity source. To configure this,
|
|
8607
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html">UserGroupResolutionConfiguration</a>. This is useful for user context filtering,
|
|
8608
|
+
* where search results are filtered based on the user or their group access to
|
|
8609
|
+
* documents.</p>
|
|
8610
|
+
* <important>
|
|
8611
|
+
* <p>If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
|
8612
|
+
* <code>UserGroupResolutionConfiguration</code> isn't supported.</p>
|
|
8613
|
+
* </important>
|
|
8614
|
+
* @public
|
|
8615
|
+
*/
|
|
8616
|
+
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | undefined;
|
|
8617
|
+
}
|
|
8618
|
+
/**
|
|
8619
|
+
* @public
|
|
8620
|
+
*/
|
|
8621
|
+
export interface UpdateQuerySuggestionsBlockListRequest {
|
|
8622
|
+
/**
|
|
8623
|
+
* <p>The identifier of the index for the block list.</p>
|
|
8624
|
+
* @public
|
|
8625
|
+
*/
|
|
8626
|
+
IndexId: string | undefined;
|
|
8627
|
+
/**
|
|
8628
|
+
* <p>The identifier of the block list you want to update.</p>
|
|
8629
|
+
* @public
|
|
8630
|
+
*/
|
|
8631
|
+
Id: string | undefined;
|
|
8632
|
+
/**
|
|
8633
|
+
* <p>A new name for the block list.</p>
|
|
8634
|
+
* @public
|
|
8635
|
+
*/
|
|
8636
|
+
Name?: string | undefined;
|
|
8637
|
+
/**
|
|
8638
|
+
* <p>A new description for the block list.</p>
|
|
8639
|
+
* @public
|
|
8640
|
+
*/
|
|
8641
|
+
Description?: string | undefined;
|
|
8642
|
+
/**
|
|
8643
|
+
* <p>The S3 path where your block list text file sits in S3.</p>
|
|
8644
|
+
* <p>If you update your block list and provide the same path to the
|
|
8645
|
+
* block list text file in S3, then Amazon Kendra reloads the file to refresh
|
|
8646
|
+
* the block list. Amazon Kendra does not automatically refresh your block list.
|
|
8647
|
+
* You need to call the <code>UpdateQuerySuggestionsBlockList</code> API
|
|
8648
|
+
* to refresh you block list.</p>
|
|
8649
|
+
* <p>If you update your block list, then Amazon Kendra asynchronously refreshes
|
|
8650
|
+
* all query suggestions with the latest content in the S3 file. This
|
|
8651
|
+
* means changes might not take effect immediately.</p>
|
|
8652
|
+
* @public
|
|
8653
|
+
*/
|
|
8654
|
+
SourceS3Path?: S3Path | undefined;
|
|
8655
|
+
/**
|
|
8656
|
+
* <p>The IAM (Identity and Access Management) role used to access the
|
|
8657
|
+
* block list text file in S3.</p>
|
|
8658
|
+
* @public
|
|
8659
|
+
*/
|
|
8660
|
+
RoleArn?: string | undefined;
|
|
8661
|
+
}
|
|
8662
|
+
/**
|
|
8663
|
+
* @public
|
|
8664
|
+
*/
|
|
8665
|
+
export interface UpdateQuerySuggestionsConfigRequest {
|
|
8666
|
+
/**
|
|
8667
|
+
* <p> The identifier of the index with query suggestions you want to update.</p>
|
|
8668
|
+
* @public
|
|
8669
|
+
*/
|
|
8670
|
+
IndexId: string | undefined;
|
|
8671
|
+
/**
|
|
8672
|
+
* <p>Set the mode to <code>ENABLED</code> or <code>LEARN_ONLY</code>.</p>
|
|
8673
|
+
* <p>By default, Amazon Kendra enables query suggestions.
|
|
8674
|
+
* <code>LEARN_ONLY</code> mode allows you to turn off query suggestions.
|
|
8675
|
+
* You can to update this at any time.</p>
|
|
8676
|
+
* <p>In <code>LEARN_ONLY</code> mode, Amazon Kendra continues to learn from new
|
|
8677
|
+
* queries to keep suggestions up to date for when you are ready to
|
|
8678
|
+
* switch to ENABLED mode again.</p>
|
|
8679
|
+
* @public
|
|
8680
|
+
*/
|
|
8681
|
+
Mode?: Mode | undefined;
|
|
8682
|
+
/**
|
|
8683
|
+
* <p>How recent your queries are in your query log time window.</p>
|
|
8684
|
+
* <p>The time window is the number of days from current day to past days.</p>
|
|
8685
|
+
* <p>By default, Amazon Kendra sets this to 180.</p>
|
|
8686
|
+
* @public
|
|
8687
|
+
*/
|
|
8688
|
+
QueryLogLookBackWindowInDays?: number | undefined;
|
|
8689
|
+
/**
|
|
8690
|
+
* <p>
|
|
8691
|
+
* <code>TRUE</code> to include queries without user information (i.e. all queries,
|
|
8692
|
+
* irrespective of the user), otherwise <code>FALSE</code> to only include queries
|
|
8693
|
+
* with user information.</p>
|
|
8694
|
+
* <p>If you pass user information to Amazon Kendra along with the queries, you can set this
|
|
8695
|
+
* flag to <code>FALSE</code> and instruct Amazon Kendra to only consider queries with user
|
|
8696
|
+
* information.</p>
|
|
8697
|
+
* <p>If you set to <code>FALSE</code>, Amazon Kendra only considers queries searched at least
|
|
8698
|
+
* <code>MinimumQueryCount</code> times across <code>MinimumNumberOfQueryingUsers</code>
|
|
8699
|
+
* unique users for suggestions.</p>
|
|
8700
|
+
* <p>If you set to <code>TRUE</code>, Amazon Kendra ignores all user information and learns
|
|
8701
|
+
* from all queries.</p>
|
|
8702
|
+
* @public
|
|
8703
|
+
*/
|
|
8704
|
+
IncludeQueriesWithoutUserInformation?: boolean | undefined;
|
|
8705
|
+
/**
|
|
8706
|
+
* <p>The minimum number of unique users who must search a query in order for the query
|
|
8707
|
+
* to be eligible to suggest to your users.</p>
|
|
8708
|
+
* <p>Increasing this number might decrease the number of suggestions. However, this
|
|
8709
|
+
* ensures a query is searched by many users and is truly popular to suggest to users.</p>
|
|
8710
|
+
* <p>How you tune this setting depends on your specific needs.</p>
|
|
8711
|
+
* @public
|
|
8712
|
+
*/
|
|
8713
|
+
MinimumNumberOfQueryingUsers?: number | undefined;
|
|
8714
|
+
/**
|
|
8715
|
+
* <p>The the minimum number of times a query must be searched in order to be
|
|
8716
|
+
* eligible to suggest to your users.</p>
|
|
8717
|
+
* <p>Decreasing this number increases the number of suggestions. However, this
|
|
8718
|
+
* affects the quality of suggestions as it sets a low bar for a query to be
|
|
8719
|
+
* considered popular to suggest to users.</p>
|
|
8720
|
+
* <p>How you tune this setting depends on your specific needs.</p>
|
|
8721
|
+
* @public
|
|
8722
|
+
*/
|
|
8723
|
+
MinimumQueryCount?: number | undefined;
|
|
8724
|
+
/**
|
|
8725
|
+
* <p>Configuration information for the document fields/attributes that you want to base
|
|
8726
|
+
* query suggestions on.</p>
|
|
8727
|
+
* @public
|
|
8728
|
+
*/
|
|
8729
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig | undefined;
|
|
8730
|
+
}
|
|
8731
|
+
/**
|
|
8732
|
+
* @public
|
|
8733
|
+
*/
|
|
8734
|
+
export interface UpdateThesaurusRequest {
|
|
8735
|
+
/**
|
|
8736
|
+
* <p>The identifier of the thesaurus you want to update.</p>
|
|
8737
|
+
* @public
|
|
8738
|
+
*/
|
|
8739
|
+
Id: string | undefined;
|
|
8740
|
+
/**
|
|
8741
|
+
* <p>A new name for the thesaurus.</p>
|
|
8742
|
+
* @public
|
|
8743
|
+
*/
|
|
8744
|
+
Name?: string | undefined;
|
|
8745
|
+
/**
|
|
8746
|
+
* <p>The identifier of the index for the thesaurus.</p>
|
|
8747
|
+
* @public
|
|
8748
|
+
*/
|
|
8749
|
+
IndexId: string | undefined;
|
|
8750
|
+
/**
|
|
8751
|
+
* <p>A new description for the thesaurus.</p>
|
|
8752
|
+
* @public
|
|
8753
|
+
*/
|
|
8754
|
+
Description?: string | undefined;
|
|
8755
|
+
/**
|
|
8756
|
+
* <p>An IAM role that gives Amazon Kendra permissions to
|
|
8757
|
+
* access thesaurus file specified in <code>SourceS3Path</code>.</p>
|
|
8758
|
+
* @public
|
|
8759
|
+
*/
|
|
8760
|
+
RoleArn?: string | undefined;
|
|
8761
|
+
/**
|
|
8762
|
+
* <p>Information required to find a specific file in an Amazon S3 bucket.</p>
|
|
8763
|
+
* @public
|
|
8764
|
+
*/
|
|
8765
|
+
SourceS3Path?: S3Path | undefined;
|
|
8766
|
+
}
|
|
8767
|
+
/**
|
|
8768
|
+
* <p>Information about a document attribute or field. You can use document attributes as
|
|
8769
|
+
* facets.</p>
|
|
8770
|
+
* <p>For example, the document attribute or facet "Department" includes the values "HR",
|
|
8771
|
+
* "Engineering", and "Accounting". You can display these values in the search results so that
|
|
8772
|
+
* documents can be searched by department.</p>
|
|
8773
|
+
* <p>You can display up to 10 facet values per facet for a query. If you want to increase
|
|
8774
|
+
* this limit, contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
8775
|
+
* @public
|
|
8776
|
+
*/
|
|
8777
|
+
export interface Facet {
|
|
8778
|
+
/**
|
|
8779
|
+
* <p>The unique key for the document attribute.</p>
|
|
8780
|
+
* @public
|
|
8781
|
+
*/
|
|
8782
|
+
DocumentAttributeKey?: string | undefined;
|
|
8783
|
+
/**
|
|
8784
|
+
* <p>An array of document attributes that are nested facets within a facet.</p>
|
|
8785
|
+
* <p>For example, the document attribute or facet "Department" includes a value called
|
|
8786
|
+
* "Engineering". In addition, the document attribute or facet "SubDepartment" includes the
|
|
8787
|
+
* values "Frontend" and "Backend" for documents assigned to "Engineering". You can display
|
|
8788
|
+
* nested facets in the search results so that documents can be searched not only by
|
|
8789
|
+
* department but also by a sub department within a department. This helps your users further
|
|
8790
|
+
* narrow their search.</p>
|
|
8791
|
+
* <p>You can only have one nested facet within a facet. If you want to increase this limit,
|
|
8792
|
+
* contact <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
8793
|
+
* @public
|
|
8794
|
+
*/
|
|
8795
|
+
Facets?: Facet[] | undefined;
|
|
8796
|
+
/**
|
|
8797
|
+
* <p>Maximum number of facet values per facet. The default is 10. You can use this to limit
|
|
8798
|
+
* the number of facet values to less than 10. If you want to increase the default, contact
|
|
8799
|
+
* <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>
|
|
8800
|
+
* @public
|
|
8801
|
+
*/
|
|
8802
|
+
MaxResults?: number | undefined;
|
|
8803
|
+
}
|
|
8804
|
+
/**
|
|
8805
|
+
* <p>Provides the count of documents that match a particular document attribute or field when
|
|
8806
|
+
* doing a faceted search.</p>
|
|
8807
|
+
* @public
|
|
8808
|
+
*/
|
|
8809
|
+
export interface DocumentAttributeValueCountPair {
|
|
8810
|
+
/**
|
|
8811
|
+
* <p>The value of the attribute/field. For example, "HR".</p>
|
|
8812
|
+
* @public
|
|
8813
|
+
*/
|
|
8814
|
+
DocumentAttributeValue?: DocumentAttributeValue | undefined;
|
|
8815
|
+
/**
|
|
8816
|
+
* <p>The number of documents in the response that have the attribute/field value for the
|
|
8817
|
+
* key.</p>
|
|
8818
|
+
* @public
|
|
8819
|
+
*/
|
|
8820
|
+
Count?: number | undefined;
|
|
8821
|
+
/**
|
|
8822
|
+
* <p>Contains the results of a document attribute/field that is a nested facet. A
|
|
8823
|
+
* <code>FacetResult</code> contains the counts for each facet nested within a
|
|
8824
|
+
* facet.</p>
|
|
8825
|
+
* <p>For example, the document attribute or facet "Department" includes a value called
|
|
8826
|
+
* "Engineering". In addition, the document attribute or facet "SubDepartment" includes the
|
|
8827
|
+
* values "Frontend" and "Backend" for documents assigned to "Engineering". You can display
|
|
8828
|
+
* nested facets in the search results so that documents can be searched not only by
|
|
8829
|
+
* department but also by a sub department within a department. The counts for documents that
|
|
8830
|
+
* belong to "Frontend" and "Backend" within "Engineering" are returned for a query.</p>
|
|
8831
|
+
* <p></p>
|
|
8832
|
+
* <p></p>
|
|
8833
|
+
* @public
|
|
8834
|
+
*/
|
|
8835
|
+
FacetResults?: FacetResult[] | undefined;
|
|
8836
|
+
}
|
|
8837
|
+
/**
|
|
8838
|
+
* <p>The facet values for the documents in the response.</p>
|
|
8839
|
+
* @public
|
|
8840
|
+
*/
|
|
8841
|
+
export interface FacetResult {
|
|
8842
|
+
/**
|
|
8843
|
+
* <p>The key for the facet values. This is the same as the <code>DocumentAttributeKey</code>
|
|
8844
|
+
* provided in the query.</p>
|
|
8845
|
+
* @public
|
|
8846
|
+
*/
|
|
8847
|
+
DocumentAttributeKey?: string | undefined;
|
|
8848
|
+
/**
|
|
8849
|
+
* <p>The data type of the facet value. This is the same as the type defined for the index
|
|
8850
|
+
* field when it was created.</p>
|
|
8851
|
+
* @public
|
|
8852
|
+
*/
|
|
8853
|
+
DocumentAttributeValueType?: DocumentAttributeValueType | undefined;
|
|
8854
|
+
/**
|
|
8855
|
+
* <p>An array of key/value pairs, where the key is the value of the attribute and the count
|
|
8856
|
+
* is the number of documents that share the key value.</p>
|
|
8857
|
+
* @public
|
|
8858
|
+
*/
|
|
8859
|
+
DocumentAttributeValueCountPairs?: DocumentAttributeValueCountPair[] | undefined;
|
|
8860
|
+
}
|
|
8861
|
+
/**
|
|
8862
|
+
* <p>Filters the search results based on document attributes or fields.</p>
|
|
8863
|
+
* <p>You can filter results using attributes for your particular documents. The attributes
|
|
8864
|
+
* must exist in your index. For example, if your documents include the custom attribute
|
|
8865
|
+
* "Department", you can filter documents that belong to the "HR" department. You would use
|
|
8866
|
+
* the <code>EqualsTo</code> operation to filter results or documents with "Department" equals
|
|
8867
|
+
* to "HR".</p>
|
|
8868
|
+
* <p>You can use <code>AndAllFilters</code> and <code>OrAllFilters</code> in combination with
|
|
8869
|
+
* each other or with other operations such as <code>EqualsTo</code>. For example:</p>
|
|
8870
|
+
* <p>
|
|
8871
|
+
* <code>AndAllFilters</code>
|
|
8872
|
+
* </p>
|
|
8873
|
+
* <ul>
|
|
8874
|
+
* <li>
|
|
8875
|
+
* <p>
|
|
8876
|
+
* <code>EqualsTo</code>: "Department", "HR"</p>
|
|
8877
|
+
* </li>
|
|
8878
|
+
* <li>
|
|
8879
|
+
* <p>
|
|
8880
|
+
* <code>OrAllFilters</code>
|
|
8881
|
+
* </p>
|
|
8882
|
+
* <ul>
|
|
8883
|
+
* <li>
|
|
8884
|
+
* <p>
|
|
8885
|
+
* <code>ContainsAny</code>: "Project Name", ["new hires", "new hiring"]</p>
|
|
8886
|
+
* </li>
|
|
8887
|
+
* </ul>
|
|
8888
|
+
* </li>
|
|
8889
|
+
* </ul>
|
|
8890
|
+
* <p>This example filters results or documents that belong to the HR department
|
|
8891
|
+
* <code>AND</code> belong to projects that contain "new hires"
|
|
8892
|
+
* <code>OR</code> "new hiring" in the project name (must use
|
|
8893
|
+
* <code>ContainAny</code> with <code>StringListValue</code>). This example is filtering
|
|
8894
|
+
* with a depth of 2.</p>
|
|
8895
|
+
* <p>You cannot filter more than a depth of 2, otherwise you receive a
|
|
8896
|
+
* <code>ValidationException</code> exception with the message "AttributeFilter cannot have
|
|
8897
|
+
* a depth of more than 2." Also, if you use more than 10 attribute filters in a given list
|
|
8898
|
+
* for <code>AndAllFilters</code> or <code>OrAllFilters</code>, you receive a
|
|
8899
|
+
* <code>ValidationException</code> with the message "AttributeFilter cannot have a length
|
|
8900
|
+
* of more than 10".</p>
|
|
8901
|
+
* <p>For examples of using <code>AttributeFilter</code>, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using document attributes to
|
|
8902
|
+
* filter search results</a>.</p>
|
|
8903
|
+
* @public
|
|
8904
|
+
*/
|
|
8905
|
+
export interface AttributeFilter {
|
|
8906
|
+
/**
|
|
8907
|
+
* <p>Performs a logical <code>AND</code> operation on all filters that you specify.</p>
|
|
8908
|
+
* @public
|
|
8909
|
+
*/
|
|
8910
|
+
AndAllFilters?: AttributeFilter[] | undefined;
|
|
8911
|
+
/**
|
|
8912
|
+
* <p>Performs a logical <code>OR</code> operation on all filters that you specify.</p>
|
|
8913
|
+
* @public
|
|
8914
|
+
*/
|
|
8915
|
+
OrAllFilters?: AttributeFilter[] | undefined;
|
|
8916
|
+
/**
|
|
8917
|
+
* <p>Performs a logical <code>NOT</code> operation on all filters that you specify.</p>
|
|
8918
|
+
* @public
|
|
8919
|
+
*/
|
|
8920
|
+
NotFilter?: AttributeFilter | undefined;
|
|
8921
|
+
/**
|
|
8922
|
+
* <p>Performs an equals operation on document attributes/fields and their values.</p>
|
|
8923
|
+
* @public
|
|
8924
|
+
*/
|
|
8925
|
+
EqualsTo?: DocumentAttribute | undefined;
|
|
8926
|
+
/**
|
|
8927
|
+
* <p>Returns true when a document contains all of the specified document attributes/fields.
|
|
8928
|
+
* This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
|
|
8929
|
+
* @public
|
|
8930
|
+
*/
|
|
8931
|
+
ContainsAll?: DocumentAttribute | undefined;
|
|
8932
|
+
/**
|
|
8933
|
+
* <p>Returns true when a document contains any of the specified document attributes/fields.
|
|
8934
|
+
* This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
|
|
8935
|
+
* @public
|
|
8936
|
+
*/
|
|
8937
|
+
ContainsAny?: DocumentAttribute | undefined;
|
|
8938
|
+
/**
|
|
8939
|
+
* <p>Performs a greater than operation on document attributes/fields and their values. Use
|
|
8940
|
+
* with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
8941
|
+
* type</a>
|
|
8942
|
+
* <code>Date</code> or <code>Long</code>.</p>
|
|
8943
|
+
* @public
|
|
8944
|
+
*/
|
|
8945
|
+
GreaterThan?: DocumentAttribute | undefined;
|
|
8946
|
+
/**
|
|
8947
|
+
* <p>Performs a greater or equals than operation on document attributes/fields and their
|
|
8948
|
+
* values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
8949
|
+
* type</a>
|
|
8950
|
+
* <code>Date</code> or <code>Long</code>.</p>
|
|
8951
|
+
* @public
|
|
8952
|
+
*/
|
|
8953
|
+
GreaterThanOrEquals?: DocumentAttribute | undefined;
|
|
8954
|
+
/**
|
|
8955
|
+
* <p>Performs a less than operation on document attributes/fields and their values. Use with
|
|
8956
|
+
* the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
8957
|
+
* type</a>
|
|
8958
|
+
* <code>Date</code> or <code>Long</code>.</p>
|
|
8959
|
+
* @public
|
|
8960
|
+
*/
|
|
8961
|
+
LessThan?: DocumentAttribute | undefined;
|
|
8962
|
+
/**
|
|
8963
|
+
* <p>Performs a less than or equals operation on document attributes/fields and their values.
|
|
8964
|
+
* Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
|
|
8965
|
+
* type</a>
|
|
8966
|
+
* <code>Date</code> or <code>Long</code>.</p>
|
|
8967
|
+
* @public
|
|
8968
|
+
*/
|
|
8969
|
+
LessThanOrEquals?: DocumentAttribute | undefined;
|
|
8970
|
+
}
|
|
8971
|
+
/**
|
|
8972
|
+
* @public
|
|
8973
|
+
*/
|
|
8974
|
+
export interface QueryResult {
|
|
8975
|
+
/**
|
|
8976
|
+
* <p>The identifier for the search. You also use <code>QueryId</code> to identify the search
|
|
8977
|
+
* when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">SubmitFeedback</a>
|
|
8978
|
+
* API.</p>
|
|
8979
|
+
* @public
|
|
8980
|
+
*/
|
|
8981
|
+
QueryId?: string | undefined;
|
|
8982
|
+
/**
|
|
8983
|
+
* <p>The results of the search.</p>
|
|
8984
|
+
* @public
|
|
8985
|
+
*/
|
|
8986
|
+
ResultItems?: QueryResultItem[] | undefined;
|
|
8987
|
+
/**
|
|
8988
|
+
* <p>Contains the facet results. A <code>FacetResult</code> contains the counts for each
|
|
8989
|
+
* field/attribute key that was specified in the <code>Facets</code> input parameter.</p>
|
|
8990
|
+
* @public
|
|
8991
|
+
*/
|
|
8992
|
+
FacetResults?: FacetResult[] | undefined;
|
|
8993
|
+
/**
|
|
8994
|
+
* <p>The total number of items found by the search. However, you can only retrieve up to 100
|
|
8995
|
+
* items. For example, if the search found 192 items, you can only retrieve the first 100 of
|
|
8996
|
+
* the items.</p>
|
|
8997
|
+
* @public
|
|
8998
|
+
*/
|
|
8999
|
+
TotalNumberOfResults?: number | undefined;
|
|
9000
|
+
/**
|
|
9001
|
+
* <p>A list of warning codes and their messages on problems with your query.</p>
|
|
9002
|
+
* <p>Amazon Kendra currently only supports one type of warning, which is a warning on
|
|
9003
|
+
* invalid syntax used in the query. For examples of invalid query syntax, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
|
|
9004
|
+
* with advanced query syntax</a>.</p>
|
|
9005
|
+
* @public
|
|
9006
|
+
*/
|
|
9007
|
+
Warnings?: Warning[] | undefined;
|
|
9008
|
+
/**
|
|
9009
|
+
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
9010
|
+
* @public
|
|
9011
|
+
*/
|
|
9012
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[] | undefined;
|
|
9013
|
+
/**
|
|
9014
|
+
* <p>The list of featured result items. Featured results are displayed at the top of the
|
|
9015
|
+
* search results page, placed above all other results for certain queries. If there's an
|
|
9016
|
+
* exact match of a query, then certain documents are featured in the search results.</p>
|
|
9017
|
+
* @public
|
|
9018
|
+
*/
|
|
9019
|
+
FeaturedResultsItems?: FeaturedResultsItem[] | undefined;
|
|
9020
|
+
}
|
|
9021
|
+
/**
|
|
9022
|
+
* <p>Provides the configuration information for the document fields/attributes that you want
|
|
9023
|
+
* to base query suggestions on.</p>
|
|
9024
|
+
* @public
|
|
9025
|
+
*/
|
|
9026
|
+
export interface AttributeSuggestionsGetConfig {
|
|
9027
|
+
/**
|
|
9028
|
+
* <p>The list of document field/attribute keys or field names to use for query suggestions.
|
|
9029
|
+
* If the content within any of the fields match what your user starts typing as their query,
|
|
9030
|
+
* then the field content is returned as a query suggestion.</p>
|
|
9031
|
+
* @public
|
|
9032
|
+
*/
|
|
9033
|
+
SuggestionAttributes?: string[] | undefined;
|
|
9034
|
+
/**
|
|
9035
|
+
* <p>The list of additional document field/attribute keys or field names to include in the
|
|
9036
|
+
* response. You can use additional fields to provide extra information in the response.
|
|
9037
|
+
* Additional fields are not used to based suggestions on.</p>
|
|
9038
|
+
* @public
|
|
9039
|
+
*/
|
|
9040
|
+
AdditionalResponseAttributes?: string[] | undefined;
|
|
9041
|
+
/**
|
|
9042
|
+
* <p>Filters the search results based on document fields/attributes.</p>
|
|
9043
|
+
* @public
|
|
9044
|
+
*/
|
|
9045
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
9046
|
+
/**
|
|
9047
|
+
* <p>Applies user context filtering so that only users who are given access to certain
|
|
9048
|
+
* documents see these document in their search results.</p>
|
|
9049
|
+
* @public
|
|
9050
|
+
*/
|
|
9051
|
+
UserContext?: UserContext | undefined;
|
|
9052
|
+
}
|
|
9053
|
+
/**
|
|
9054
|
+
* @public
|
|
9055
|
+
*/
|
|
9056
|
+
export interface RetrieveRequest {
|
|
9057
|
+
/**
|
|
9058
|
+
* <p>The identifier of the index to retrieve relevant passages for the search.</p>
|
|
9059
|
+
* @public
|
|
9060
|
+
*/
|
|
9061
|
+
IndexId: string | undefined;
|
|
9062
|
+
/**
|
|
9063
|
+
* <p>The input query text to retrieve relevant passages for the search. Amazon Kendra
|
|
9064
|
+
* truncates queries at 30 token words, which excludes punctuation and stop words.
|
|
9065
|
+
* Truncation still applies if you use Boolean or more advanced, complex queries. For
|
|
9066
|
+
* example, <code>Timeoff AND October AND Category:HR</code> is counted as 3 tokens:
|
|
9067
|
+
* <code>timeoff</code>, <code>october</code>, <code>hr</code>. For more information,
|
|
9068
|
+
* 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>
|
|
9069
|
+
* @public
|
|
9070
|
+
*/
|
|
9071
|
+
QueryText: string | undefined;
|
|
9072
|
+
/**
|
|
9073
|
+
* <p>Filters search results by document fields/attributes. You can only provide one
|
|
9074
|
+
* attribute filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>, and
|
|
9075
|
+
* <code>OrAllFilters</code> parameters contain a list of other filters.</p>
|
|
9076
|
+
* <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering
|
|
9077
|
+
* rules that a document must satisfy to be included in the query results.</p>
|
|
9078
|
+
* <note>
|
|
9079
|
+
* <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
|
|
9080
|
+
* enable document filtering for end users using <code>_email_id</code> or include
|
|
9081
|
+
* public documents (<code>_email_id=null</code>).</p>
|
|
9082
|
+
* </note>
|
|
9083
|
+
* @public
|
|
9084
|
+
*/
|
|
9085
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
9086
|
+
/**
|
|
9087
|
+
* <p>A list of document fields/attributes to include in the response. You can limit the
|
|
9088
|
+
* response to include certain document fields. By default, all document fields are
|
|
9089
|
+
* included in the response.</p>
|
|
9090
|
+
* @public
|
|
9091
|
+
*/
|
|
9092
|
+
RequestedDocumentAttributes?: string[] | undefined;
|
|
9093
|
+
/**
|
|
9094
|
+
* <p>Overrides relevance tuning configurations of fields/attributes set at the index
|
|
9095
|
+
* level.</p>
|
|
9096
|
+
* <p>If you use this API to override the relevance tuning configured at the index level,
|
|
9097
|
+
* but there is no relevance tuning configured at the index level, then Amazon Kendra
|
|
9098
|
+
* does not apply any relevance tuning.</p>
|
|
9099
|
+
* <p>If there is relevance tuning configured for fields at the index level, and you use
|
|
9100
|
+
* this API to override only some of these fields, then for the fields you did not
|
|
9101
|
+
* override, the importance is set to 1.</p>
|
|
9102
|
+
* @public
|
|
9103
|
+
*/
|
|
9104
|
+
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined;
|
|
9105
|
+
/**
|
|
9106
|
+
* <p>Retrieved relevant passages are returned in pages the size of the
|
|
9107
|
+
* <code>PageSize</code> parameter. By default, Amazon Kendra returns the first
|
|
9108
|
+
* page of results. Use this parameter to get result pages after the first one.</p>
|
|
9109
|
+
* @public
|
|
9110
|
+
*/
|
|
9111
|
+
PageNumber?: number | undefined;
|
|
9112
|
+
/**
|
|
9113
|
+
* <p>Sets the number of retrieved relevant passages that are returned in each page of
|
|
9114
|
+
* results. The default page size is 10. The maximum number of results returned is 100. If
|
|
9115
|
+
* you ask for more than 100 results, only 100 are returned.</p>
|
|
9116
|
+
* @public
|
|
9117
|
+
*/
|
|
9118
|
+
PageSize?: number | undefined;
|
|
9119
|
+
/**
|
|
9120
|
+
* <p>The user context token or user and group information.</p>
|
|
9121
|
+
* @public
|
|
9122
|
+
*/
|
|
9123
|
+
UserContext?: UserContext | undefined;
|
|
9124
|
+
}
|
|
9125
|
+
/**
|
|
9126
|
+
* @public
|
|
9127
|
+
*/
|
|
9128
|
+
export interface GetQuerySuggestionsRequest {
|
|
9129
|
+
/**
|
|
9130
|
+
* <p>The identifier of the index you want to get query suggestions from.</p>
|
|
9131
|
+
* @public
|
|
9132
|
+
*/
|
|
9133
|
+
IndexId: string | undefined;
|
|
9134
|
+
/**
|
|
9135
|
+
* <p>The text of a user's query to generate query suggestions.</p>
|
|
9136
|
+
* <p>A query is suggested if the query prefix matches
|
|
9137
|
+
* what a user starts to type as their query.</p>
|
|
9138
|
+
* <p>Amazon Kendra does not show any suggestions if a user
|
|
9139
|
+
* types fewer than two characters or more than 60 characters.
|
|
9140
|
+
* A query must also have at least one search result and contain
|
|
9141
|
+
* at least one word of more than four characters.</p>
|
|
9142
|
+
* @public
|
|
9143
|
+
*/
|
|
9144
|
+
QueryText: string | undefined;
|
|
9145
|
+
/**
|
|
9146
|
+
* <p>The maximum number of query suggestions you want to show
|
|
9147
|
+
* to your users.</p>
|
|
9148
|
+
* @public
|
|
9149
|
+
*/
|
|
9150
|
+
MaxSuggestionsCount?: number | undefined;
|
|
9151
|
+
/**
|
|
9152
|
+
* <p>The suggestions type to base query suggestions on. The suggestion
|
|
9153
|
+
* types are query history or document fields/attributes. You can set
|
|
9154
|
+
* one type or the other.</p>
|
|
9155
|
+
* <p>If you set query history as your suggestions type, Amazon Kendra
|
|
9156
|
+
* suggests queries relevant to your users based on popular queries in
|
|
9157
|
+
* the query history.</p>
|
|
9158
|
+
* <p>If you set document fields/attributes as your suggestions type,
|
|
9159
|
+
* Amazon Kendra suggests queries relevant to your users based on the
|
|
9160
|
+
* contents of document fields.</p>
|
|
9161
|
+
* @public
|
|
9162
|
+
*/
|
|
9163
|
+
SuggestionTypes?: SuggestionType[] | undefined;
|
|
9164
|
+
/**
|
|
9165
|
+
* <p>Configuration information for the document fields/attributes that you
|
|
9166
|
+
* want to base query suggestions on.</p>
|
|
9167
|
+
* @public
|
|
9168
|
+
*/
|
|
9169
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig | undefined;
|
|
9170
|
+
}
|
|
9171
|
+
/**
|
|
9172
|
+
* @public
|
|
9173
|
+
*/
|
|
9174
|
+
export interface QueryRequest {
|
|
9175
|
+
/**
|
|
9176
|
+
* <p>The identifier of the index for the search.</p>
|
|
9177
|
+
* @public
|
|
9178
|
+
*/
|
|
9179
|
+
IndexId: string | undefined;
|
|
9180
|
+
/**
|
|
9181
|
+
* <p>The input query text for the search. Amazon Kendra truncates queries at 30 token
|
|
9182
|
+
* words, which excludes punctuation and stop words. Truncation still applies if you use
|
|
9183
|
+
* Boolean or more advanced, complex queries. For example, <code>Timeoff AND October AND
|
|
9184
|
+
* Category:HR</code> is counted as 3 tokens: <code>timeoff</code>, <code>october</code>,
|
|
9185
|
+
* <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>
|
|
9186
|
+
* @public
|
|
9187
|
+
*/
|
|
9188
|
+
QueryText?: string | undefined;
|
|
9189
|
+
/**
|
|
9190
|
+
* <p>Filters search results by document fields/attributes. You can only provide one attribute
|
|
9191
|
+
* filter; however, the <code>AndAllFilters</code>, <code>NotFilter</code>, and
|
|
9192
|
+
* <code>OrAllFilters</code> parameters contain a list of other filters.</p>
|
|
9193
|
+
* <p>The <code>AttributeFilter</code> parameter means you can create a set of filtering rules
|
|
9194
|
+
* that a document must satisfy to be included in the query results.</p>
|
|
9195
|
+
* <note>
|
|
9196
|
+
* <p>For Amazon Kendra Gen AI Enterprise Edition indices use <code>AttributeFilter</code> to
|
|
9197
|
+
* enable document filtering for end users using <code>_email_id</code> or include public
|
|
9198
|
+
* documents (<code>_email_id=null</code>).</p>
|
|
9199
|
+
* </note>
|
|
9200
|
+
* @public
|
|
9201
|
+
*/
|
|
9202
|
+
AttributeFilter?: AttributeFilter | undefined;
|
|
9203
|
+
/**
|
|
9204
|
+
* <p>An array of documents fields/attributes for faceted search. Amazon Kendra returns a
|
|
9205
|
+
* count for each field key specified. This helps your users narrow their search.</p>
|
|
9206
|
+
* @public
|
|
9207
|
+
*/
|
|
9208
|
+
Facets?: Facet[] | undefined;
|
|
9209
|
+
/**
|
|
9210
|
+
* <p>An array of document fields/attributes to include in the response. You can limit the
|
|
9211
|
+
* response to include certain document fields. By default, all document attributes are
|
|
9212
|
+
* included in the response.</p>
|
|
9213
|
+
* @public
|
|
9214
|
+
*/
|
|
9215
|
+
RequestedDocumentAttributes?: string[] | undefined;
|
|
9216
|
+
/**
|
|
9217
|
+
* <p>Sets the type of query result or response. Only results for the specified type are
|
|
9218
|
+
* returned.</p>
|
|
9219
|
+
* @public
|
|
9220
|
+
*/
|
|
9221
|
+
QueryResultTypeFilter?: QueryResultType | undefined;
|
|
9222
|
+
/**
|
|
9223
|
+
* <p>Overrides relevance tuning configurations of fields/attributes set at the index
|
|
9224
|
+
* level.</p>
|
|
9225
|
+
* <p>If you use this API to override the relevance tuning configured at the index level, but
|
|
9226
|
+
* there is no relevance tuning configured at the index level, then Amazon Kendra does
|
|
9227
|
+
* not apply any relevance tuning.</p>
|
|
9228
|
+
* <p>If there is relevance tuning configured for fields at the index level, and you use this
|
|
9229
|
+
* API to override only some of these fields, then for the fields you did not override, the
|
|
9230
|
+
* importance is set to 1.</p>
|
|
9231
|
+
* @public
|
|
9232
|
+
*/
|
|
9233
|
+
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[] | undefined;
|
|
9234
|
+
/**
|
|
9235
|
+
* <p>Query results are returned in pages the size of the <code>PageSize</code> parameter. By
|
|
9236
|
+
* default, Amazon Kendra returns the first page of results. Use this parameter to get
|
|
9237
|
+
* result pages after the first one.</p>
|
|
9238
|
+
* @public
|
|
9239
|
+
*/
|
|
9240
|
+
PageNumber?: number | undefined;
|
|
9241
|
+
/**
|
|
9242
|
+
* <p>Sets the number of results that are returned in each page of results. The default page
|
|
9243
|
+
* size is 10. The maximum number of results returned is 100. If you ask for more than 100
|
|
9244
|
+
* results, only 100 are returned.</p>
|
|
9245
|
+
* @public
|
|
9246
|
+
*/
|
|
9247
|
+
PageSize?: number | undefined;
|
|
9248
|
+
/**
|
|
9249
|
+
* <p>Provides information that determines how the results of the query are sorted. You can
|
|
9250
|
+
* set the field that Amazon Kendra should sort the results on, and specify whether the
|
|
9251
|
+
* results should be sorted in ascending or descending order. In the case of ties in sorting
|
|
9252
|
+
* the results, the results are sorted by relevance.</p>
|
|
9253
|
+
* <p>If you don't provide sorting configuration, the results are sorted by the relevance that
|
|
9254
|
+
* Amazon Kendra determines for the result.</p>
|
|
9255
|
+
* @public
|
|
9256
|
+
*/
|
|
9257
|
+
SortingConfiguration?: SortingConfiguration | undefined;
|
|
9258
|
+
/**
|
|
9259
|
+
* <p>Provides configuration information to determine how the results of a query are
|
|
9260
|
+
* sorted.</p>
|
|
9261
|
+
* <p>You can set upto 3 fields that Amazon Kendra should sort the results on, and
|
|
9262
|
+
* specify whether the results should be sorted in ascending or descending order. The sort
|
|
9263
|
+
* field quota can be increased.</p>
|
|
9264
|
+
* <p>If you don't provide a sorting configuration, the results are sorted by the relevance
|
|
9265
|
+
* that Amazon Kendra determines for the result. In the case of ties in sorting the
|
|
9266
|
+
* results, the results are sorted by relevance. </p>
|
|
9267
|
+
* @public
|
|
9268
|
+
*/
|
|
9269
|
+
SortingConfigurations?: SortingConfiguration[] | undefined;
|
|
9270
|
+
/**
|
|
9271
|
+
* <p>The user context token or user and group information.</p>
|
|
9272
|
+
* @public
|
|
9273
|
+
*/
|
|
9274
|
+
UserContext?: UserContext | undefined;
|
|
9275
|
+
/**
|
|
9276
|
+
* <p>Provides an identifier for a specific user. The <code>VisitorId</code> should be a
|
|
9277
|
+
* unique identifier, such as a GUID. Don't use personally identifiable information, such as
|
|
9278
|
+
* the user's email address, as the <code>VisitorId</code>.</p>
|
|
9279
|
+
* @public
|
|
9280
|
+
*/
|
|
9281
|
+
VisitorId?: string | undefined;
|
|
9282
|
+
/**
|
|
9283
|
+
* <p>Enables suggested spell corrections for queries.</p>
|
|
9284
|
+
* @public
|
|
9285
|
+
*/
|
|
9286
|
+
SpellCorrectionConfiguration?: SpellCorrectionConfiguration | undefined;
|
|
9287
|
+
/**
|
|
9288
|
+
* <p>Provides configuration to determine how to group results by document attribute value,
|
|
9289
|
+
* and how to display them (collapsed or expanded) under a designated primary document for
|
|
9290
|
+
* each group.</p>
|
|
9291
|
+
* @public
|
|
9292
|
+
*/
|
|
9293
|
+
CollapseConfiguration?: CollapseConfiguration | undefined;
|
|
9294
|
+
}
|