@aws-sdk/client-bedrock-agent 3.934.0 → 3.936.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 +373 -373
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +372 -0
- package/dist-es/models/errors.js +87 -0
- package/dist-es/models/models_0.js +1 -347
- package/dist-es/models/models_1.js +1 -112
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/GetIngestionJobCommand.d.ts +1 -2
- package/dist-types/commands/GetKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/StartIngestionJobCommand.d.ts +1 -1
- package/dist-types/commands/StopIngestionJobCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +938 -0
- package/dist-types/models/errors.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +1045 -742
- package/dist-types/models/models_1.d.ts +2 -1332
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIngestionJobCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIngestionJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartIngestionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopIngestionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +501 -0
- package/dist-types/ts3.4/models/errors.d.ts +51 -0
- package/dist-types/ts3.4/models/models_0.d.ts +330 -396
- package/dist-types/ts3.4/models/models_1.d.ts +14 -424
- package/package.json +19 -19
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,29 +1,5 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import {
|
|
4
|
-
/**
|
|
5
|
-
* <p>The request is denied because of missing access permissions.</p>
|
|
6
|
-
* @public
|
|
7
|
-
*/
|
|
8
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
-
readonly name: "AccessDeniedException";
|
|
10
|
-
readonly $fault: "client";
|
|
11
|
-
/**
|
|
12
|
-
* @internal
|
|
13
|
-
*/
|
|
14
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* @public
|
|
18
|
-
* @enum
|
|
19
|
-
*/
|
|
20
|
-
export declare const CustomControlMethod: {
|
|
21
|
-
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* @public
|
|
25
|
-
*/
|
|
26
|
-
export type CustomControlMethod = (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
|
|
2
|
+
import { ActionGroupSignature, ActionGroupState, AgentAliasStatus, AgentCollaboration, AgentStatus, AliasInvocationState, CachePointType, ChunkingStrategy, ConcurrencyType, ConfluenceAuthType, ConfluenceHostType, ContentDataSourceType, ContextEnrichmentType, ConversationRole, CrawlFilterConfigurationType, CreationMode, CustomControlMethod, CustomSourceType, DataDeletionPolicy, DataSourceStatus, DataSourceType, DocumentStatus, EmbeddingDataType, EnrichmentStrategyMethod, FlowConnectionType, FlowNodeInputCategory, FlowNodeIODataType, FlowStatus, FlowValidationSeverity, FlowValidationType, IncludeExclude, IncompatibleLoopNodeType, IngestionJobFilterAttribute, IngestionJobFilterOperator, IngestionJobSortByAttribute, IngestionJobStatus, InlineContentType, KnowledgeBaseState, MemoryType, MetadataSourceType, MetadataValueType, OrchestrationType, ParsingModality, ParsingStrategy, PerformanceConfigLatency, PromptState, PromptTemplateType, PromptType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, RelayConversationHistory, RequireConfirmation, RerankingMetadataSelectionMode, SalesforceAuthType, SharePointAuthType, SharePointHostType, SortOrder, StepType, SupplementalDataStorageLocationType, SupportedLanguages, Type, VectorSearchRerankingConfigurationType, WebScopeType } from "./enums";
|
|
27
3
|
/**
|
|
28
4
|
* <p>Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.</p>
|
|
29
5
|
* @public
|
|
@@ -69,30 +45,6 @@ export declare namespace ActionGroupExecutor {
|
|
|
69
45
|
_: (name: string, value: any) => T;
|
|
70
46
|
}
|
|
71
47
|
}
|
|
72
|
-
/**
|
|
73
|
-
* <p>There was a conflict performing an operation.</p>
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
export declare class ConflictException extends __BaseException {
|
|
77
|
-
readonly name: "ConflictException";
|
|
78
|
-
readonly $fault: "client";
|
|
79
|
-
/**
|
|
80
|
-
* @internal
|
|
81
|
-
*/
|
|
82
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* @public
|
|
86
|
-
* @enum
|
|
87
|
-
*/
|
|
88
|
-
export declare const ActionGroupState: {
|
|
89
|
-
readonly DISABLED: "DISABLED";
|
|
90
|
-
readonly ENABLED: "ENABLED";
|
|
91
|
-
};
|
|
92
|
-
/**
|
|
93
|
-
* @public
|
|
94
|
-
*/
|
|
95
|
-
export type ActionGroupState = (typeof ActionGroupState)[keyof typeof ActionGroupState];
|
|
96
48
|
/**
|
|
97
49
|
* <p>The identifier information for an Amazon S3 bucket.</p>
|
|
98
50
|
* @public
|
|
@@ -154,21 +106,6 @@ export declare namespace APISchema {
|
|
|
154
106
|
_: (name: string, value: any) => T;
|
|
155
107
|
}
|
|
156
108
|
}
|
|
157
|
-
/**
|
|
158
|
-
* @public
|
|
159
|
-
* @enum
|
|
160
|
-
*/
|
|
161
|
-
export declare const Type: {
|
|
162
|
-
readonly ARRAY: "array";
|
|
163
|
-
readonly BOOLEAN: "boolean";
|
|
164
|
-
readonly INTEGER: "integer";
|
|
165
|
-
readonly NUMBER: "number";
|
|
166
|
-
readonly STRING: "string";
|
|
167
|
-
};
|
|
168
|
-
/**
|
|
169
|
-
* @public
|
|
170
|
-
*/
|
|
171
|
-
export type Type = (typeof Type)[keyof typeof Type];
|
|
172
109
|
/**
|
|
173
110
|
* <p>Contains details about a parameter in a function for an action group.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a> </p> </li> </ul>
|
|
174
111
|
* @public
|
|
@@ -190,18 +127,6 @@ export interface ParameterDetail {
|
|
|
190
127
|
*/
|
|
191
128
|
required?: boolean | undefined;
|
|
192
129
|
}
|
|
193
|
-
/**
|
|
194
|
-
* @public
|
|
195
|
-
* @enum
|
|
196
|
-
*/
|
|
197
|
-
export declare const RequireConfirmation: {
|
|
198
|
-
readonly DISABLED: "DISABLED";
|
|
199
|
-
readonly ENABLED: "ENABLED";
|
|
200
|
-
};
|
|
201
|
-
/**
|
|
202
|
-
* @public
|
|
203
|
-
*/
|
|
204
|
-
export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
|
|
205
130
|
/**
|
|
206
131
|
* <p>Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a> </p> </li> </ul>
|
|
207
132
|
* @public
|
|
@@ -261,21 +186,6 @@ export declare namespace FunctionSchema {
|
|
|
261
186
|
_: (name: string, value: any) => T;
|
|
262
187
|
}
|
|
263
188
|
}
|
|
264
|
-
/**
|
|
265
|
-
* @public
|
|
266
|
-
* @enum
|
|
267
|
-
*/
|
|
268
|
-
export declare const ActionGroupSignature: {
|
|
269
|
-
readonly AMAZON_CODEINTERPRETER: "AMAZON.CodeInterpreter";
|
|
270
|
-
readonly AMAZON_USERINPUT: "AMAZON.UserInput";
|
|
271
|
-
readonly ANTHROPIC_BASH: "ANTHROPIC.Bash";
|
|
272
|
-
readonly ANTHROPIC_COMPUTER: "ANTHROPIC.Computer";
|
|
273
|
-
readonly ANTHROPIC_TEXTEDITOR: "ANTHROPIC.TextEditor";
|
|
274
|
-
};
|
|
275
|
-
/**
|
|
276
|
-
* @public
|
|
277
|
-
*/
|
|
278
|
-
export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature];
|
|
279
189
|
/**
|
|
280
190
|
* @public
|
|
281
191
|
*/
|
|
@@ -422,54 +332,6 @@ export interface CreateAgentActionGroupResponse {
|
|
|
422
332
|
*/
|
|
423
333
|
agentActionGroup: AgentActionGroup | undefined;
|
|
424
334
|
}
|
|
425
|
-
/**
|
|
426
|
-
* <p>An internal server error occurred. Retry your request.</p>
|
|
427
|
-
* @public
|
|
428
|
-
*/
|
|
429
|
-
export declare class InternalServerException extends __BaseException {
|
|
430
|
-
readonly name: "InternalServerException";
|
|
431
|
-
readonly $fault: "server";
|
|
432
|
-
/**
|
|
433
|
-
* @internal
|
|
434
|
-
*/
|
|
435
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
436
|
-
}
|
|
437
|
-
/**
|
|
438
|
-
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
439
|
-
* @public
|
|
440
|
-
*/
|
|
441
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
442
|
-
readonly name: "ResourceNotFoundException";
|
|
443
|
-
readonly $fault: "client";
|
|
444
|
-
/**
|
|
445
|
-
* @internal
|
|
446
|
-
*/
|
|
447
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
448
|
-
}
|
|
449
|
-
/**
|
|
450
|
-
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
451
|
-
* @public
|
|
452
|
-
*/
|
|
453
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
454
|
-
readonly name: "ServiceQuotaExceededException";
|
|
455
|
-
readonly $fault: "client";
|
|
456
|
-
/**
|
|
457
|
-
* @internal
|
|
458
|
-
*/
|
|
459
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
460
|
-
}
|
|
461
|
-
/**
|
|
462
|
-
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
463
|
-
* @public
|
|
464
|
-
*/
|
|
465
|
-
export declare class ThrottlingException extends __BaseException {
|
|
466
|
-
readonly name: "ThrottlingException";
|
|
467
|
-
readonly $fault: "client";
|
|
468
|
-
/**
|
|
469
|
-
* @internal
|
|
470
|
-
*/
|
|
471
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
472
|
-
}
|
|
473
335
|
/**
|
|
474
336
|
* <p>Stores information about a field passed inside a request that resulted in an validation error.</p>
|
|
475
337
|
* @public
|
|
@@ -486,23 +348,6 @@ export interface ValidationExceptionField {
|
|
|
486
348
|
*/
|
|
487
349
|
message: string | undefined;
|
|
488
350
|
}
|
|
489
|
-
/**
|
|
490
|
-
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
491
|
-
* @public
|
|
492
|
-
*/
|
|
493
|
-
export declare class ValidationException extends __BaseException {
|
|
494
|
-
readonly name: "ValidationException";
|
|
495
|
-
readonly $fault: "client";
|
|
496
|
-
/**
|
|
497
|
-
* <p>A list of objects containing fields that caused validation errors and their corresponding validation error messages.</p>
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
fieldList?: ValidationExceptionField[] | undefined;
|
|
501
|
-
/**
|
|
502
|
-
* @internal
|
|
503
|
-
*/
|
|
504
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
505
|
-
}
|
|
506
351
|
/**
|
|
507
352
|
* @public
|
|
508
353
|
*/
|
|
@@ -704,37 +549,6 @@ export interface UpdateAgentActionGroupResponse {
|
|
|
704
549
|
*/
|
|
705
550
|
agentActionGroup: AgentActionGroup | undefined;
|
|
706
551
|
}
|
|
707
|
-
/**
|
|
708
|
-
* @public
|
|
709
|
-
* @enum
|
|
710
|
-
*/
|
|
711
|
-
export declare const AgentCollaboration: {
|
|
712
|
-
readonly DISABLED: "DISABLED";
|
|
713
|
-
readonly SUPERVISOR: "SUPERVISOR";
|
|
714
|
-
readonly SUPERVISOR_ROUTER: "SUPERVISOR_ROUTER";
|
|
715
|
-
};
|
|
716
|
-
/**
|
|
717
|
-
* @public
|
|
718
|
-
*/
|
|
719
|
-
export type AgentCollaboration = (typeof AgentCollaboration)[keyof typeof AgentCollaboration];
|
|
720
|
-
/**
|
|
721
|
-
* @public
|
|
722
|
-
* @enum
|
|
723
|
-
*/
|
|
724
|
-
export declare const AgentStatus: {
|
|
725
|
-
readonly CREATING: "CREATING";
|
|
726
|
-
readonly DELETING: "DELETING";
|
|
727
|
-
readonly FAILED: "FAILED";
|
|
728
|
-
readonly NOT_PREPARED: "NOT_PREPARED";
|
|
729
|
-
readonly PREPARED: "PREPARED";
|
|
730
|
-
readonly PREPARING: "PREPARING";
|
|
731
|
-
readonly UPDATING: "UPDATING";
|
|
732
|
-
readonly VERSIONING: "VERSIONING";
|
|
733
|
-
};
|
|
734
|
-
/**
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
|
|
738
552
|
/**
|
|
739
553
|
* <p> Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration. </p>
|
|
740
554
|
* @public
|
|
@@ -795,17 +609,6 @@ export interface GuardrailConfiguration {
|
|
|
795
609
|
*/
|
|
796
610
|
guardrailVersion?: string | undefined;
|
|
797
611
|
}
|
|
798
|
-
/**
|
|
799
|
-
* @public
|
|
800
|
-
* @enum
|
|
801
|
-
*/
|
|
802
|
-
export declare const MemoryType: {
|
|
803
|
-
readonly SESSION_SUMMARY: "SESSION_SUMMARY";
|
|
804
|
-
};
|
|
805
|
-
/**
|
|
806
|
-
* @public
|
|
807
|
-
*/
|
|
808
|
-
export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType];
|
|
809
612
|
/**
|
|
810
613
|
* <p>Configuration for SESSION_SUMMARY memory type enabled for the agent.</p>
|
|
811
614
|
* @public
|
|
@@ -838,18 +641,6 @@ export interface MemoryConfiguration {
|
|
|
838
641
|
*/
|
|
839
642
|
sessionSummaryConfiguration?: SessionSummaryConfiguration | undefined;
|
|
840
643
|
}
|
|
841
|
-
/**
|
|
842
|
-
* @public
|
|
843
|
-
* @enum
|
|
844
|
-
*/
|
|
845
|
-
export declare const OrchestrationType: {
|
|
846
|
-
readonly CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION";
|
|
847
|
-
readonly DEFAULT: "DEFAULT";
|
|
848
|
-
};
|
|
849
|
-
/**
|
|
850
|
-
* @public
|
|
851
|
-
*/
|
|
852
|
-
export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType];
|
|
853
644
|
/**
|
|
854
645
|
* <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
855
646
|
* @public
|
|
@@ -881,45 +672,6 @@ export interface InferenceConfiguration {
|
|
|
881
672
|
*/
|
|
882
673
|
stopSequences?: string[] | undefined;
|
|
883
674
|
}
|
|
884
|
-
/**
|
|
885
|
-
* @public
|
|
886
|
-
* @enum
|
|
887
|
-
*/
|
|
888
|
-
export declare const CreationMode: {
|
|
889
|
-
readonly DEFAULT: "DEFAULT";
|
|
890
|
-
readonly OVERRIDDEN: "OVERRIDDEN";
|
|
891
|
-
};
|
|
892
|
-
/**
|
|
893
|
-
* @public
|
|
894
|
-
*/
|
|
895
|
-
export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode];
|
|
896
|
-
/**
|
|
897
|
-
* @public
|
|
898
|
-
* @enum
|
|
899
|
-
*/
|
|
900
|
-
export declare const PromptState: {
|
|
901
|
-
readonly DISABLED: "DISABLED";
|
|
902
|
-
readonly ENABLED: "ENABLED";
|
|
903
|
-
};
|
|
904
|
-
/**
|
|
905
|
-
* @public
|
|
906
|
-
*/
|
|
907
|
-
export type PromptState = (typeof PromptState)[keyof typeof PromptState];
|
|
908
|
-
/**
|
|
909
|
-
* @public
|
|
910
|
-
* @enum
|
|
911
|
-
*/
|
|
912
|
-
export declare const PromptType: {
|
|
913
|
-
readonly KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION";
|
|
914
|
-
readonly MEMORY_SUMMARIZATION: "MEMORY_SUMMARIZATION";
|
|
915
|
-
readonly ORCHESTRATION: "ORCHESTRATION";
|
|
916
|
-
readonly POST_PROCESSING: "POST_PROCESSING";
|
|
917
|
-
readonly PRE_PROCESSING: "PRE_PROCESSING";
|
|
918
|
-
};
|
|
919
|
-
/**
|
|
920
|
-
* @public
|
|
921
|
-
*/
|
|
922
|
-
export type PromptType = (typeof PromptType)[keyof typeof PromptType];
|
|
923
675
|
/**
|
|
924
676
|
* <p>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
925
677
|
* @public
|
|
@@ -1140,40 +892,6 @@ export interface AgentAliasHistoryEvent {
|
|
|
1140
892
|
*/
|
|
1141
893
|
startDate?: Date | undefined;
|
|
1142
894
|
}
|
|
1143
|
-
/**
|
|
1144
|
-
* @public
|
|
1145
|
-
* @enum
|
|
1146
|
-
*/
|
|
1147
|
-
export declare const AgentAliasStatus: {
|
|
1148
|
-
readonly CREATING: "CREATING";
|
|
1149
|
-
readonly DELETING: "DELETING";
|
|
1150
|
-
readonly DISSOCIATED: "DISSOCIATED";
|
|
1151
|
-
readonly FAILED: "FAILED";
|
|
1152
|
-
readonly PREPARED: "PREPARED";
|
|
1153
|
-
readonly UPDATING: "UPDATING";
|
|
1154
|
-
};
|
|
1155
|
-
/**
|
|
1156
|
-
* @public
|
|
1157
|
-
*/
|
|
1158
|
-
export type AgentAliasStatus = (typeof AgentAliasStatus)[keyof typeof AgentAliasStatus];
|
|
1159
|
-
/**
|
|
1160
|
-
* @public
|
|
1161
|
-
* @enum
|
|
1162
|
-
*/
|
|
1163
|
-
export declare const AliasInvocationState: {
|
|
1164
|
-
/**
|
|
1165
|
-
* Agent is actively processing requests
|
|
1166
|
-
*/
|
|
1167
|
-
readonly ACCEPT_INVOCATIONS: "ACCEPT_INVOCATIONS";
|
|
1168
|
-
/**
|
|
1169
|
-
* Agent is paused and will not accept new requests
|
|
1170
|
-
*/
|
|
1171
|
-
readonly REJECT_INVOCATIONS: "REJECT_INVOCATIONS";
|
|
1172
|
-
};
|
|
1173
|
-
/**
|
|
1174
|
-
* @public
|
|
1175
|
-
*/
|
|
1176
|
-
export type AliasInvocationState = (typeof AliasInvocationState)[keyof typeof AliasInvocationState];
|
|
1177
895
|
/**
|
|
1178
896
|
* <p>Contains details about an alias of an agent.</p>
|
|
1179
897
|
* @public
|
|
@@ -1302,18 +1020,6 @@ export interface AgentDescriptor {
|
|
|
1302
1020
|
*/
|
|
1303
1021
|
aliasArn?: string | undefined;
|
|
1304
1022
|
}
|
|
1305
|
-
/**
|
|
1306
|
-
* @public
|
|
1307
|
-
* @enum
|
|
1308
|
-
*/
|
|
1309
|
-
export declare const RelayConversationHistory: {
|
|
1310
|
-
readonly DISABLED: "DISABLED";
|
|
1311
|
-
readonly TO_COLLABORATOR: "TO_COLLABORATOR";
|
|
1312
|
-
};
|
|
1313
|
-
/**
|
|
1314
|
-
* @public
|
|
1315
|
-
*/
|
|
1316
|
-
export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory];
|
|
1317
1023
|
/**
|
|
1318
1024
|
* <p>An agent collaborator.</p>
|
|
1319
1025
|
* @public
|
|
@@ -1627,18 +1333,6 @@ export interface AgentFlowNodeConfiguration {
|
|
|
1627
1333
|
*/
|
|
1628
1334
|
agentAliasArn: string | undefined;
|
|
1629
1335
|
}
|
|
1630
|
-
/**
|
|
1631
|
-
* @public
|
|
1632
|
-
* @enum
|
|
1633
|
-
*/
|
|
1634
|
-
export declare const KnowledgeBaseState: {
|
|
1635
|
-
readonly DISABLED: "DISABLED";
|
|
1636
|
-
readonly ENABLED: "ENABLED";
|
|
1637
|
-
};
|
|
1638
|
-
/**
|
|
1639
|
-
* @public
|
|
1640
|
-
*/
|
|
1641
|
-
export type KnowledgeBaseState = (typeof KnowledgeBaseState)[keyof typeof KnowledgeBaseState];
|
|
1642
1336
|
/**
|
|
1643
1337
|
* <p>Contains details about a knowledge base that is associated with an agent.</p>
|
|
1644
1338
|
* @public
|
|
@@ -2364,18 +2058,6 @@ export interface UpdateAgentAliasResponse {
|
|
|
2364
2058
|
*/
|
|
2365
2059
|
agentAlias: AgentAlias | undefined;
|
|
2366
2060
|
}
|
|
2367
|
-
/**
|
|
2368
|
-
* @public
|
|
2369
|
-
* @enum
|
|
2370
|
-
*/
|
|
2371
|
-
export declare const DataDeletionPolicy: {
|
|
2372
|
-
readonly DELETE: "DELETE";
|
|
2373
|
-
readonly RETAIN: "RETAIN";
|
|
2374
|
-
};
|
|
2375
|
-
/**
|
|
2376
|
-
* @public
|
|
2377
|
-
*/
|
|
2378
|
-
export type DataDeletionPolicy = (typeof DataDeletionPolicy)[keyof typeof DataDeletionPolicy];
|
|
2379
2061
|
/**
|
|
2380
2062
|
* <p>The specific filters applied to your data source content. You can filter out or include certain content.</p>
|
|
2381
2063
|
* @public
|
|
@@ -2408,17 +2090,6 @@ export interface PatternObjectFilterConfiguration {
|
|
|
2408
2090
|
*/
|
|
2409
2091
|
filters: PatternObjectFilter[] | undefined;
|
|
2410
2092
|
}
|
|
2411
|
-
/**
|
|
2412
|
-
* @public
|
|
2413
|
-
* @enum
|
|
2414
|
-
*/
|
|
2415
|
-
export declare const CrawlFilterConfigurationType: {
|
|
2416
|
-
readonly PATTERN: "PATTERN";
|
|
2417
|
-
};
|
|
2418
|
-
/**
|
|
2419
|
-
* @public
|
|
2420
|
-
*/
|
|
2421
|
-
export type CrawlFilterConfigurationType = (typeof CrawlFilterConfigurationType)[keyof typeof CrawlFilterConfigurationType];
|
|
2422
2093
|
/**
|
|
2423
2094
|
* <p>The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.</p>
|
|
2424
2095
|
* @public
|
|
@@ -2446,29 +2117,6 @@ export interface ConfluenceCrawlerConfiguration {
|
|
|
2446
2117
|
*/
|
|
2447
2118
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2448
2119
|
}
|
|
2449
|
-
/**
|
|
2450
|
-
* @public
|
|
2451
|
-
* @enum
|
|
2452
|
-
*/
|
|
2453
|
-
export declare const ConfluenceAuthType: {
|
|
2454
|
-
readonly BASIC: "BASIC";
|
|
2455
|
-
readonly OAUTH2_CLIENT_CREDENTIALS: "OAUTH2_CLIENT_CREDENTIALS";
|
|
2456
|
-
};
|
|
2457
|
-
/**
|
|
2458
|
-
* @public
|
|
2459
|
-
*/
|
|
2460
|
-
export type ConfluenceAuthType = (typeof ConfluenceAuthType)[keyof typeof ConfluenceAuthType];
|
|
2461
|
-
/**
|
|
2462
|
-
* @public
|
|
2463
|
-
* @enum
|
|
2464
|
-
*/
|
|
2465
|
-
export declare const ConfluenceHostType: {
|
|
2466
|
-
readonly SAAS: "SAAS";
|
|
2467
|
-
};
|
|
2468
|
-
/**
|
|
2469
|
-
* @public
|
|
2470
|
-
*/
|
|
2471
|
-
export type ConfluenceHostType = (typeof ConfluenceHostType)[keyof typeof ConfluenceHostType];
|
|
2472
2120
|
/**
|
|
2473
2121
|
* <p>The endpoint information to connect to your Confluence data source.</p>
|
|
2474
2122
|
* @public
|
|
@@ -2543,17 +2191,6 @@ export interface SalesforceCrawlerConfiguration {
|
|
|
2543
2191
|
*/
|
|
2544
2192
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2545
2193
|
}
|
|
2546
|
-
/**
|
|
2547
|
-
* @public
|
|
2548
|
-
* @enum
|
|
2549
|
-
*/
|
|
2550
|
-
export declare const SalesforceAuthType: {
|
|
2551
|
-
readonly OAUTH2_CLIENT_CREDENTIALS: "OAUTH2_CLIENT_CREDENTIALS";
|
|
2552
|
-
};
|
|
2553
|
-
/**
|
|
2554
|
-
* @public
|
|
2555
|
-
*/
|
|
2556
|
-
export type SalesforceAuthType = (typeof SalesforceAuthType)[keyof typeof SalesforceAuthType];
|
|
2557
2194
|
/**
|
|
2558
2195
|
* <p>The endpoint information to connect to your Salesforce data source.</p>
|
|
2559
2196
|
* @public
|
|
@@ -2602,29 +2239,6 @@ export interface SharePointCrawlerConfiguration {
|
|
|
2602
2239
|
*/
|
|
2603
2240
|
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2604
2241
|
}
|
|
2605
|
-
/**
|
|
2606
|
-
* @public
|
|
2607
|
-
* @enum
|
|
2608
|
-
*/
|
|
2609
|
-
export declare const SharePointAuthType: {
|
|
2610
|
-
readonly OAUTH2_CLIENT_CREDENTIALS: "OAUTH2_CLIENT_CREDENTIALS";
|
|
2611
|
-
readonly OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS: "OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS";
|
|
2612
|
-
};
|
|
2613
|
-
/**
|
|
2614
|
-
* @public
|
|
2615
|
-
*/
|
|
2616
|
-
export type SharePointAuthType = (typeof SharePointAuthType)[keyof typeof SharePointAuthType];
|
|
2617
|
-
/**
|
|
2618
|
-
* @public
|
|
2619
|
-
* @enum
|
|
2620
|
-
*/
|
|
2621
|
-
export declare const SharePointHostType: {
|
|
2622
|
-
readonly ONLINE: "ONLINE";
|
|
2623
|
-
};
|
|
2624
|
-
/**
|
|
2625
|
-
* @public
|
|
2626
|
-
*/
|
|
2627
|
-
export type SharePointHostType = (typeof SharePointHostType)[keyof typeof SharePointHostType];
|
|
2628
2242
|
/**
|
|
2629
2243
|
* <p>The endpoint information to connect to your SharePoint data source.</p>
|
|
2630
2244
|
* @public
|
|
@@ -2677,23 +2291,6 @@ export interface SharePointDataSourceConfiguration {
|
|
|
2677
2291
|
*/
|
|
2678
2292
|
crawlerConfiguration?: SharePointCrawlerConfiguration | undefined;
|
|
2679
2293
|
}
|
|
2680
|
-
/**
|
|
2681
|
-
* @public
|
|
2682
|
-
* @enum
|
|
2683
|
-
*/
|
|
2684
|
-
export declare const DataSourceType: {
|
|
2685
|
-
readonly CONFLUENCE: "CONFLUENCE";
|
|
2686
|
-
readonly CUSTOM: "CUSTOM";
|
|
2687
|
-
readonly REDSHIFT_METADATA: "REDSHIFT_METADATA";
|
|
2688
|
-
readonly S3: "S3";
|
|
2689
|
-
readonly SALESFORCE: "SALESFORCE";
|
|
2690
|
-
readonly SHAREPOINT: "SHAREPOINT";
|
|
2691
|
-
readonly WEB: "WEB";
|
|
2692
|
-
};
|
|
2693
|
-
/**
|
|
2694
|
-
* @public
|
|
2695
|
-
*/
|
|
2696
|
-
export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
2697
2294
|
/**
|
|
2698
2295
|
* <p>The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
2699
2296
|
* @public
|
|
@@ -2710,18 +2307,6 @@ export interface WebCrawlerLimits {
|
|
|
2710
2307
|
*/
|
|
2711
2308
|
maxPages?: number | undefined;
|
|
2712
2309
|
}
|
|
2713
|
-
/**
|
|
2714
|
-
* @public
|
|
2715
|
-
* @enum
|
|
2716
|
-
*/
|
|
2717
|
-
export declare const WebScopeType: {
|
|
2718
|
-
readonly HOST_ONLY: "HOST_ONLY";
|
|
2719
|
-
readonly SUBDOMAINS: "SUBDOMAINS";
|
|
2720
|
-
};
|
|
2721
|
-
/**
|
|
2722
|
-
* @public
|
|
2723
|
-
*/
|
|
2724
|
-
export type WebScopeType = (typeof WebScopeType)[keyof typeof WebScopeType];
|
|
2725
2310
|
/**
|
|
2726
2311
|
* <p>The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.</p>
|
|
2727
2312
|
* @public
|
|
@@ -2854,20 +2439,6 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
2854
2439
|
*/
|
|
2855
2440
|
kmsKeyArn?: string | undefined;
|
|
2856
2441
|
}
|
|
2857
|
-
/**
|
|
2858
|
-
* @public
|
|
2859
|
-
* @enum
|
|
2860
|
-
*/
|
|
2861
|
-
export declare const ChunkingStrategy: {
|
|
2862
|
-
readonly FIXED_SIZE: "FIXED_SIZE";
|
|
2863
|
-
readonly HIERARCHICAL: "HIERARCHICAL";
|
|
2864
|
-
readonly NONE: "NONE";
|
|
2865
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
2866
|
-
};
|
|
2867
|
-
/**
|
|
2868
|
-
* @public
|
|
2869
|
-
*/
|
|
2870
|
-
export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
|
|
2871
2442
|
/**
|
|
2872
2443
|
* <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
2873
2444
|
* @public
|
|
@@ -2958,17 +2529,6 @@ export interface ChunkingConfiguration {
|
|
|
2958
2529
|
*/
|
|
2959
2530
|
semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
|
|
2960
2531
|
}
|
|
2961
|
-
/**
|
|
2962
|
-
* @public
|
|
2963
|
-
* @enum
|
|
2964
|
-
*/
|
|
2965
|
-
export declare const EnrichmentStrategyMethod: {
|
|
2966
|
-
readonly CHUNK_ENTITY_EXTRACTION: "CHUNK_ENTITY_EXTRACTION";
|
|
2967
|
-
};
|
|
2968
|
-
/**
|
|
2969
|
-
* @public
|
|
2970
|
-
*/
|
|
2971
|
-
export type EnrichmentStrategyMethod = (typeof EnrichmentStrategyMethod)[keyof typeof EnrichmentStrategyMethod];
|
|
2972
2532
|
/**
|
|
2973
2533
|
* <p>The strategy used for performing context enrichment.</p>
|
|
2974
2534
|
* @public
|
|
@@ -2996,17 +2556,6 @@ export interface BedrockFoundationModelContextEnrichmentConfiguration {
|
|
|
2996
2556
|
*/
|
|
2997
2557
|
modelArn: string | undefined;
|
|
2998
2558
|
}
|
|
2999
|
-
/**
|
|
3000
|
-
* @public
|
|
3001
|
-
* @enum
|
|
3002
|
-
*/
|
|
3003
|
-
export declare const ContextEnrichmentType: {
|
|
3004
|
-
readonly BEDROCK_FOUNDATION_MODEL: "BEDROCK_FOUNDATION_MODEL";
|
|
3005
|
-
};
|
|
3006
|
-
/**
|
|
3007
|
-
* @public
|
|
3008
|
-
*/
|
|
3009
|
-
export type ContextEnrichmentType = (typeof ContextEnrichmentType)[keyof typeof ContextEnrichmentType];
|
|
3010
2559
|
/**
|
|
3011
2560
|
* <p>Context enrichment configuration is used to provide additional context to the RAG application.</p>
|
|
3012
2561
|
* @public
|
|
@@ -3045,17 +2594,6 @@ export interface IntermediateStorage {
|
|
|
3045
2594
|
*/
|
|
3046
2595
|
s3Location: S3Location | undefined;
|
|
3047
2596
|
}
|
|
3048
|
-
/**
|
|
3049
|
-
* @public
|
|
3050
|
-
* @enum
|
|
3051
|
-
*/
|
|
3052
|
-
export declare const StepType: {
|
|
3053
|
-
readonly POST_CHUNKING: "POST_CHUNKING";
|
|
3054
|
-
};
|
|
3055
|
-
/**
|
|
3056
|
-
* @public
|
|
3057
|
-
*/
|
|
3058
|
-
export type StepType = (typeof StepType)[keyof typeof StepType];
|
|
3059
2597
|
/**
|
|
3060
2598
|
* <p>A Lambda function that processes documents.</p>
|
|
3061
2599
|
* @public
|
|
@@ -3110,17 +2648,6 @@ export interface CustomTransformationConfiguration {
|
|
|
3110
2648
|
*/
|
|
3111
2649
|
transformations: Transformation[] | undefined;
|
|
3112
2650
|
}
|
|
3113
|
-
/**
|
|
3114
|
-
* @public
|
|
3115
|
-
* @enum
|
|
3116
|
-
*/
|
|
3117
|
-
export declare const ParsingModality: {
|
|
3118
|
-
readonly MULTIMODAL: "MULTIMODAL";
|
|
3119
|
-
};
|
|
3120
|
-
/**
|
|
3121
|
-
* @public
|
|
3122
|
-
*/
|
|
3123
|
-
export type ParsingModality = (typeof ParsingModality)[keyof typeof ParsingModality];
|
|
3124
2651
|
/**
|
|
3125
2652
|
* <p>Contains configurations for using Amazon Bedrock Data Automation as the parser for ingesting your data sources.</p>
|
|
3126
2653
|
* @public
|
|
@@ -3164,18 +2691,6 @@ export interface BedrockFoundationModelConfiguration {
|
|
|
3164
2691
|
*/
|
|
3165
2692
|
parsingModality?: ParsingModality | undefined;
|
|
3166
2693
|
}
|
|
3167
|
-
/**
|
|
3168
|
-
* @public
|
|
3169
|
-
* @enum
|
|
3170
|
-
*/
|
|
3171
|
-
export declare const ParsingStrategy: {
|
|
3172
|
-
readonly BEDROCK_DATA_AUTOMATION: "BEDROCK_DATA_AUTOMATION";
|
|
3173
|
-
readonly BEDROCK_FOUNDATION_MODEL: "BEDROCK_FOUNDATION_MODEL";
|
|
3174
|
-
};
|
|
3175
|
-
/**
|
|
3176
|
-
* @public
|
|
3177
|
-
*/
|
|
3178
|
-
export type ParsingStrategy = (typeof ParsingStrategy)[keyof typeof ParsingStrategy];
|
|
3179
2694
|
/**
|
|
3180
2695
|
* <p>Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the <code>parsingStrategy</code> field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html">Parsing options for your data source</a>.</p> <note> <p>If you specify <code>BEDROCK_DATA_AUTOMATION</code> or <code>BEDROCK_FOUNDATION_MODEL</code> and it fails to parse a file, the Amazon Bedrock default parser will be used instead.</p> </note>
|
|
3181
2696
|
* @public
|
|
@@ -3268,19 +2783,6 @@ export interface CreateDataSourceRequest {
|
|
|
3268
2783
|
*/
|
|
3269
2784
|
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
3270
2785
|
}
|
|
3271
|
-
/**
|
|
3272
|
-
* @public
|
|
3273
|
-
* @enum
|
|
3274
|
-
*/
|
|
3275
|
-
export declare const DataSourceStatus: {
|
|
3276
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
3277
|
-
readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
|
|
3278
|
-
readonly DELETING: "DELETING";
|
|
3279
|
-
};
|
|
3280
|
-
/**
|
|
3281
|
-
* @public
|
|
3282
|
-
*/
|
|
3283
|
-
export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
3284
2786
|
/**
|
|
3285
2787
|
* <p>Contains details about a data source.</p>
|
|
3286
2788
|
* @public
|
|
@@ -3615,18 +3117,6 @@ export declare namespace FlowConnectionConfiguration {
|
|
|
3615
3117
|
_: (name: string, value: any) => T;
|
|
3616
3118
|
}
|
|
3617
3119
|
}
|
|
3618
|
-
/**
|
|
3619
|
-
* @public
|
|
3620
|
-
* @enum
|
|
3621
|
-
*/
|
|
3622
|
-
export declare const FlowConnectionType: {
|
|
3623
|
-
readonly CONDITIONAL: "Conditional";
|
|
3624
|
-
readonly DATA: "Data";
|
|
3625
|
-
};
|
|
3626
|
-
/**
|
|
3627
|
-
* @public
|
|
3628
|
-
*/
|
|
3629
|
-
export type FlowConnectionType = (typeof FlowConnectionType)[keyof typeof FlowConnectionType];
|
|
3630
3120
|
/**
|
|
3631
3121
|
* <p>Contains information about a connection between two nodes in the flow.</p>
|
|
3632
3122
|
* @public
|
|
@@ -3691,17 +3181,6 @@ export interface ConditionFlowNodeConfiguration {
|
|
|
3691
3181
|
*/
|
|
3692
3182
|
conditions: FlowCondition[] | undefined;
|
|
3693
3183
|
}
|
|
3694
|
-
/**
|
|
3695
|
-
* @public
|
|
3696
|
-
* @enum
|
|
3697
|
-
*/
|
|
3698
|
-
export declare const SupportedLanguages: {
|
|
3699
|
-
readonly PYTHON_3: "Python_3";
|
|
3700
|
-
};
|
|
3701
|
-
/**
|
|
3702
|
-
* @public
|
|
3703
|
-
*/
|
|
3704
|
-
export type SupportedLanguages = (typeof SupportedLanguages)[keyof typeof SupportedLanguages];
|
|
3705
3184
|
/**
|
|
3706
3185
|
* <p>Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.</p>
|
|
3707
3186
|
* @public
|
|
@@ -3790,19 +3269,7 @@ export declare namespace PromptInferenceConfiguration {
|
|
|
3790
3269
|
}
|
|
3791
3270
|
}
|
|
3792
3271
|
/**
|
|
3793
|
-
*
|
|
3794
|
-
* @enum
|
|
3795
|
-
*/
|
|
3796
|
-
export declare const PerformanceConfigLatency: {
|
|
3797
|
-
readonly OPTIMIZED: "optimized";
|
|
3798
|
-
readonly STANDARD: "standard";
|
|
3799
|
-
};
|
|
3800
|
-
/**
|
|
3801
|
-
* @public
|
|
3802
|
-
*/
|
|
3803
|
-
export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency];
|
|
3804
|
-
/**
|
|
3805
|
-
* <p>The performance-related configuration options for the knowledge base retrieval and generation process.</p>
|
|
3272
|
+
* <p>The performance-related configuration options for the knowledge base retrieval and generation process.</p>
|
|
3806
3273
|
* @public
|
|
3807
3274
|
*/
|
|
3808
3275
|
export interface PerformanceConfiguration {
|
|
@@ -3849,18 +3316,6 @@ export interface KnowledgeBaseOrchestrationConfiguration {
|
|
|
3849
3316
|
*/
|
|
3850
3317
|
performanceConfig?: PerformanceConfiguration | undefined;
|
|
3851
3318
|
}
|
|
3852
|
-
/**
|
|
3853
|
-
* @public
|
|
3854
|
-
* @enum
|
|
3855
|
-
*/
|
|
3856
|
-
export declare const RerankingMetadataSelectionMode: {
|
|
3857
|
-
readonly ALL: "ALL";
|
|
3858
|
-
readonly SELECTIVE: "SELECTIVE";
|
|
3859
|
-
};
|
|
3860
|
-
/**
|
|
3861
|
-
* @public
|
|
3862
|
-
*/
|
|
3863
|
-
export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
3864
3319
|
/**
|
|
3865
3320
|
* <p>Specifies a metadata field to include or exclude during the reranking process.</p>
|
|
3866
3321
|
* @public
|
|
@@ -3970,17 +3425,6 @@ export interface VectorSearchBedrockRerankingConfiguration {
|
|
|
3970
3425
|
*/
|
|
3971
3426
|
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
3972
3427
|
}
|
|
3973
|
-
/**
|
|
3974
|
-
* @public
|
|
3975
|
-
* @enum
|
|
3976
|
-
*/
|
|
3977
|
-
export declare const VectorSearchRerankingConfigurationType: {
|
|
3978
|
-
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
3979
|
-
};
|
|
3980
|
-
/**
|
|
3981
|
-
* @public
|
|
3982
|
-
*/
|
|
3983
|
-
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
3984
3428
|
/**
|
|
3985
3429
|
* <p>Specifies how retrieved results from a knowledge base are reranked to improve relevance.</p>
|
|
3986
3430
|
* @public
|
|
@@ -4109,17 +3553,6 @@ export interface PromptInputVariable {
|
|
|
4109
3553
|
*/
|
|
4110
3554
|
name?: string | undefined;
|
|
4111
3555
|
}
|
|
4112
|
-
/**
|
|
4113
|
-
* @public
|
|
4114
|
-
* @enum
|
|
4115
|
-
*/
|
|
4116
|
-
export declare const CachePointType: {
|
|
4117
|
-
readonly DEFAULT: "default";
|
|
4118
|
-
};
|
|
4119
|
-
/**
|
|
4120
|
-
* @public
|
|
4121
|
-
*/
|
|
4122
|
-
export type CachePointType = (typeof CachePointType)[keyof typeof CachePointType];
|
|
4123
3556
|
/**
|
|
4124
3557
|
* <p>Indicates where a cache checkpoint is located. All information before this checkpoint is cached to be accessed on subsequent requests.</p>
|
|
4125
3558
|
* @public
|
|
@@ -4176,18 +3609,6 @@ export declare namespace ContentBlock {
|
|
|
4176
3609
|
_: (name: string, value: any) => T;
|
|
4177
3610
|
}
|
|
4178
3611
|
}
|
|
4179
|
-
/**
|
|
4180
|
-
* @public
|
|
4181
|
-
* @enum
|
|
4182
|
-
*/
|
|
4183
|
-
export declare const ConversationRole: {
|
|
4184
|
-
readonly ASSISTANT: "assistant";
|
|
4185
|
-
readonly USER: "user";
|
|
4186
|
-
};
|
|
4187
|
-
/**
|
|
4188
|
-
* @public
|
|
4189
|
-
*/
|
|
4190
|
-
export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
|
|
4191
3612
|
/**
|
|
4192
3613
|
* <p>A message input or response from a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
|
|
4193
3614
|
* @public
|
|
@@ -4538,18 +3959,6 @@ export declare namespace PromptTemplateConfiguration {
|
|
|
4538
3959
|
_: (name: string, value: any) => T;
|
|
4539
3960
|
}
|
|
4540
3961
|
}
|
|
4541
|
-
/**
|
|
4542
|
-
* @public
|
|
4543
|
-
* @enum
|
|
4544
|
-
*/
|
|
4545
|
-
export declare const PromptTemplateType: {
|
|
4546
|
-
readonly CHAT: "CHAT";
|
|
4547
|
-
readonly TEXT: "TEXT";
|
|
4548
|
-
};
|
|
4549
|
-
/**
|
|
4550
|
-
* @public
|
|
4551
|
-
*/
|
|
4552
|
-
export type PromptTemplateType = (typeof PromptTemplateType)[keyof typeof PromptTemplateType];
|
|
4553
3962
|
/**
|
|
4554
3963
|
* <p>Contains configurations for a prompt defined inline in the node.</p>
|
|
4555
3964
|
* @public
|
|
@@ -4763,34 +4172,6 @@ export interface StorageFlowNodeConfiguration {
|
|
|
4763
4172
|
*/
|
|
4764
4173
|
serviceConfiguration: StorageFlowNodeServiceConfiguration | undefined;
|
|
4765
4174
|
}
|
|
4766
|
-
/**
|
|
4767
|
-
* @public
|
|
4768
|
-
* @enum
|
|
4769
|
-
*/
|
|
4770
|
-
export declare const FlowNodeInputCategory: {
|
|
4771
|
-
readonly EXIT_LOOP: "ExitLoop";
|
|
4772
|
-
readonly LOOP_CONDITION: "LoopCondition";
|
|
4773
|
-
readonly RETURN_VALUE_TO_LOOP_START: "ReturnValueToLoopStart";
|
|
4774
|
-
};
|
|
4775
|
-
/**
|
|
4776
|
-
* @public
|
|
4777
|
-
*/
|
|
4778
|
-
export type FlowNodeInputCategory = (typeof FlowNodeInputCategory)[keyof typeof FlowNodeInputCategory];
|
|
4779
|
-
/**
|
|
4780
|
-
* @public
|
|
4781
|
-
* @enum
|
|
4782
|
-
*/
|
|
4783
|
-
export declare const FlowNodeIODataType: {
|
|
4784
|
-
readonly ARRAY: "Array";
|
|
4785
|
-
readonly BOOLEAN: "Boolean";
|
|
4786
|
-
readonly NUMBER: "Number";
|
|
4787
|
-
readonly OBJECT: "Object";
|
|
4788
|
-
readonly STRING: "String";
|
|
4789
|
-
};
|
|
4790
|
-
/**
|
|
4791
|
-
* @public
|
|
4792
|
-
*/
|
|
4793
|
-
export type FlowNodeIODataType = (typeof FlowNodeIODataType)[keyof typeof FlowNodeIODataType];
|
|
4794
4175
|
/**
|
|
4795
4176
|
* <p>Contains configurations for an input in an Amazon Bedrock Flows node.</p>
|
|
4796
4177
|
* @public
|
|
@@ -4833,46 +4214,6 @@ export interface FlowNodeOutput {
|
|
|
4833
4214
|
*/
|
|
4834
4215
|
type: FlowNodeIODataType | undefined;
|
|
4835
4216
|
}
|
|
4836
|
-
/**
|
|
4837
|
-
* @public
|
|
4838
|
-
* @enum
|
|
4839
|
-
*/
|
|
4840
|
-
export declare const FlowNodeType: {
|
|
4841
|
-
readonly AGENT: "Agent";
|
|
4842
|
-
readonly COLLECTOR: "Collector";
|
|
4843
|
-
readonly CONDITION: "Condition";
|
|
4844
|
-
readonly INLINE_CODE: "InlineCode";
|
|
4845
|
-
readonly INPUT: "Input";
|
|
4846
|
-
readonly ITERATOR: "Iterator";
|
|
4847
|
-
readonly KNOWLEDGE_BASE: "KnowledgeBase";
|
|
4848
|
-
readonly LAMBDA_FUNCTION: "LambdaFunction";
|
|
4849
|
-
readonly LEX: "Lex";
|
|
4850
|
-
readonly LOOP: "Loop";
|
|
4851
|
-
readonly LOOP_CONTROLLER: "LoopController";
|
|
4852
|
-
readonly LOOP_INPUT: "LoopInput";
|
|
4853
|
-
readonly OUTPUT: "Output";
|
|
4854
|
-
readonly PROMPT: "Prompt";
|
|
4855
|
-
readonly RETRIEVAL: "Retrieval";
|
|
4856
|
-
readonly STORAGE: "Storage";
|
|
4857
|
-
};
|
|
4858
|
-
/**
|
|
4859
|
-
* @public
|
|
4860
|
-
*/
|
|
4861
|
-
export type FlowNodeType = (typeof FlowNodeType)[keyof typeof FlowNodeType];
|
|
4862
|
-
/**
|
|
4863
|
-
* @public
|
|
4864
|
-
* @enum
|
|
4865
|
-
*/
|
|
4866
|
-
export declare const FlowStatus: {
|
|
4867
|
-
readonly FAILED: "Failed";
|
|
4868
|
-
readonly NOT_PREPARED: "NotPrepared";
|
|
4869
|
-
readonly PREPARED: "Prepared";
|
|
4870
|
-
readonly PREPARING: "Preparing";
|
|
4871
|
-
};
|
|
4872
|
-
/**
|
|
4873
|
-
* @public
|
|
4874
|
-
*/
|
|
4875
|
-
export type FlowStatus = (typeof FlowStatus)[keyof typeof FlowStatus];
|
|
4876
4217
|
/**
|
|
4877
4218
|
* @public
|
|
4878
4219
|
*/
|
|
@@ -4898,18 +4239,6 @@ export interface DeleteFlowResponse {
|
|
|
4898
4239
|
*/
|
|
4899
4240
|
id: string | undefined;
|
|
4900
4241
|
}
|
|
4901
|
-
/**
|
|
4902
|
-
* @public
|
|
4903
|
-
* @enum
|
|
4904
|
-
*/
|
|
4905
|
-
export declare const ConcurrencyType: {
|
|
4906
|
-
readonly AUTOMATIC: "Automatic";
|
|
4907
|
-
readonly MANUAL: "Manual";
|
|
4908
|
-
};
|
|
4909
|
-
/**
|
|
4910
|
-
* @public
|
|
4911
|
-
*/
|
|
4912
|
-
export type ConcurrencyType = (typeof ConcurrencyType)[keyof typeof ConcurrencyType];
|
|
4913
4242
|
/**
|
|
4914
4243
|
* <p>Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.</p>
|
|
4915
4244
|
* @public
|
|
@@ -5514,20 +4843,6 @@ export interface InvalidLoopBoundaryFlowValidationDetails {
|
|
|
5514
4843
|
*/
|
|
5515
4844
|
target: string | undefined;
|
|
5516
4845
|
}
|
|
5517
|
-
/**
|
|
5518
|
-
* @public
|
|
5519
|
-
* @enum
|
|
5520
|
-
*/
|
|
5521
|
-
export declare const IncompatibleLoopNodeType: {
|
|
5522
|
-
readonly COLLECTOR: "Collector";
|
|
5523
|
-
readonly CONDITION: "Condition";
|
|
5524
|
-
readonly INPUT: "Input";
|
|
5525
|
-
readonly ITERATOR: "Iterator";
|
|
5526
|
-
};
|
|
5527
|
-
/**
|
|
5528
|
-
* @public
|
|
5529
|
-
*/
|
|
5530
|
-
export type IncompatibleLoopNodeType = (typeof IncompatibleLoopNodeType)[keyof typeof IncompatibleLoopNodeType];
|
|
5531
4846
|
/**
|
|
5532
4847
|
* <p>Details about a flow that contains an incompatible node in a DoWhile loop.</p>
|
|
5533
4848
|
* @public
|
|
@@ -7310,61 +6625,6 @@ export declare namespace FlowValidationDetails {
|
|
|
7310
6625
|
_: (name: string, value: any) => T;
|
|
7311
6626
|
}
|
|
7312
6627
|
}
|
|
7313
|
-
/**
|
|
7314
|
-
* @public
|
|
7315
|
-
* @enum
|
|
7316
|
-
*/
|
|
7317
|
-
export declare const FlowValidationSeverity: {
|
|
7318
|
-
readonly ERROR: "Error";
|
|
7319
|
-
readonly WARNING: "Warning";
|
|
7320
|
-
};
|
|
7321
|
-
/**
|
|
7322
|
-
* @public
|
|
7323
|
-
*/
|
|
7324
|
-
export type FlowValidationSeverity = (typeof FlowValidationSeverity)[keyof typeof FlowValidationSeverity];
|
|
7325
|
-
/**
|
|
7326
|
-
* @public
|
|
7327
|
-
* @enum
|
|
7328
|
-
*/
|
|
7329
|
-
export declare const FlowValidationType: {
|
|
7330
|
-
readonly CYCLIC_CONNECTION: "CyclicConnection";
|
|
7331
|
-
readonly DUPLICATE_CONDITION_EXPRESSION: "DuplicateConditionExpression";
|
|
7332
|
-
readonly DUPLICATE_CONNECTIONS: "DuplicateConnections";
|
|
7333
|
-
readonly INCOMPATIBLE_CONNECTION_DATA_TYPE: "IncompatibleConnectionDataType";
|
|
7334
|
-
readonly INVALID_LOOP_BOUNDARY: "InvalidLoopBoundary";
|
|
7335
|
-
readonly LOOP_INCOMPATIBLE_NODE_TYPE: "LoopIncompatibleNodeType";
|
|
7336
|
-
readonly MALFORMED_CONDITION_EXPRESSION: "MalformedConditionExpression";
|
|
7337
|
-
readonly MALFORMED_NODE_INPUT_EXPRESSION: "MalformedNodeInputExpression";
|
|
7338
|
-
readonly MISMATCHED_NODE_INPUT_TYPE: "MismatchedNodeInputType";
|
|
7339
|
-
readonly MISMATCHED_NODE_OUTPUT_TYPE: "MismatchedNodeOutputType";
|
|
7340
|
-
readonly MISSING_CONNECTION_CONFIGURATION: "MissingConnectionConfiguration";
|
|
7341
|
-
readonly MISSING_DEFAULT_CONDITION: "MissingDefaultCondition";
|
|
7342
|
-
readonly MISSING_ENDING_NODES: "MissingEndingNodes";
|
|
7343
|
-
readonly MISSING_LOOP_CONTROLLER_NODE: "MissingLoopControllerNode";
|
|
7344
|
-
readonly MISSING_LOOP_INPUT_NODE: "MissingLoopInputNode";
|
|
7345
|
-
readonly MISSING_NODE_CONFIGURATION: "MissingNodeConfiguration";
|
|
7346
|
-
readonly MISSING_NODE_INPUT: "MissingNodeInput";
|
|
7347
|
-
readonly MISSING_NODE_OUTPUT: "MissingNodeOutput";
|
|
7348
|
-
readonly MISSING_STARTING_NODES: "MissingStartingNodes";
|
|
7349
|
-
readonly MULTIPLE_LOOP_CONTROLLER_NODES: "MultipleLoopControllerNodes";
|
|
7350
|
-
readonly MULTIPLE_LOOP_INPUT_NODES: "MultipleLoopInputNodes";
|
|
7351
|
-
readonly MULTIPLE_NODE_INPUT_CONNECTIONS: "MultipleNodeInputConnections";
|
|
7352
|
-
readonly UNFULFILLED_NODE_INPUT: "UnfulfilledNodeInput";
|
|
7353
|
-
readonly UNKNOWN_CONNECTION_CONDITION: "UnknownConnectionCondition";
|
|
7354
|
-
readonly UNKNOWN_CONNECTION_SOURCE: "UnknownConnectionSource";
|
|
7355
|
-
readonly UNKNOWN_CONNECTION_SOURCE_OUTPUT: "UnknownConnectionSourceOutput";
|
|
7356
|
-
readonly UNKNOWN_CONNECTION_TARGET: "UnknownConnectionTarget";
|
|
7357
|
-
readonly UNKNOWN_CONNECTION_TARGET_INPUT: "UnknownConnectionTargetInput";
|
|
7358
|
-
readonly UNKNOWN_NODE_INPUT: "UnknownNodeInput";
|
|
7359
|
-
readonly UNKNOWN_NODE_OUTPUT: "UnknownNodeOutput";
|
|
7360
|
-
readonly UNREACHABLE_NODE: "UnreachableNode";
|
|
7361
|
-
readonly UNSATISFIED_CONNECTION_CONDITIONS: "UnsatisfiedConnectionConditions";
|
|
7362
|
-
readonly UNSPECIFIED: "Unspecified";
|
|
7363
|
-
};
|
|
7364
|
-
/**
|
|
7365
|
-
* @public
|
|
7366
|
-
*/
|
|
7367
|
-
export type FlowValidationType = (typeof FlowValidationType)[keyof typeof FlowValidationType];
|
|
7368
6628
|
/**
|
|
7369
6629
|
* <p>Contains information about validation of the flow.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax">GetFlow response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax">GetFlowVersion response</a> </p> </li> </ul>
|
|
7370
6630
|
* @public
|
|
@@ -7553,3 +6813,1046 @@ export interface IngestionJobStatistics {
|
|
|
7553
6813
|
*/
|
|
7554
6814
|
numberOfDocumentsFailed?: number | undefined;
|
|
7555
6815
|
}
|
|
6816
|
+
/**
|
|
6817
|
+
* <p>Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a> </p> </li> </ul>
|
|
6818
|
+
* @public
|
|
6819
|
+
*/
|
|
6820
|
+
export interface IngestionJob {
|
|
6821
|
+
/**
|
|
6822
|
+
* <p>The unique identifier of the knowledge for the data ingestion job.</p>
|
|
6823
|
+
* @public
|
|
6824
|
+
*/
|
|
6825
|
+
knowledgeBaseId: string | undefined;
|
|
6826
|
+
/**
|
|
6827
|
+
* <p>The unique identifier of the data source for the data ingestion job.</p>
|
|
6828
|
+
* @public
|
|
6829
|
+
*/
|
|
6830
|
+
dataSourceId: string | undefined;
|
|
6831
|
+
/**
|
|
6832
|
+
* <p>The unique identifier of the data ingestion job.</p>
|
|
6833
|
+
* @public
|
|
6834
|
+
*/
|
|
6835
|
+
ingestionJobId: string | undefined;
|
|
6836
|
+
/**
|
|
6837
|
+
* <p>The description of the data ingestion job.</p>
|
|
6838
|
+
* @public
|
|
6839
|
+
*/
|
|
6840
|
+
description?: string | undefined;
|
|
6841
|
+
/**
|
|
6842
|
+
* <p>The status of the data ingestion job.</p>
|
|
6843
|
+
* @public
|
|
6844
|
+
*/
|
|
6845
|
+
status: IngestionJobStatus | undefined;
|
|
6846
|
+
/**
|
|
6847
|
+
* <p>Contains statistics about the data ingestion job.</p>
|
|
6848
|
+
* @public
|
|
6849
|
+
*/
|
|
6850
|
+
statistics?: IngestionJobStatistics | undefined;
|
|
6851
|
+
/**
|
|
6852
|
+
* <p>A list of reasons that the data ingestion job failed.</p>
|
|
6853
|
+
* @public
|
|
6854
|
+
*/
|
|
6855
|
+
failureReasons?: string[] | undefined;
|
|
6856
|
+
/**
|
|
6857
|
+
* <p>The time the data ingestion job started.</p> <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>
|
|
6858
|
+
* @public
|
|
6859
|
+
*/
|
|
6860
|
+
startedAt: Date | undefined;
|
|
6861
|
+
/**
|
|
6862
|
+
* <p>The time the data ingestion job was last updated.</p> <p>If you stop a data ingestion job, the <code>updatedAt</code> time is the time the job was stopped.</p>
|
|
6863
|
+
* @public
|
|
6864
|
+
*/
|
|
6865
|
+
updatedAt: Date | undefined;
|
|
6866
|
+
}
|
|
6867
|
+
/**
|
|
6868
|
+
* @public
|
|
6869
|
+
*/
|
|
6870
|
+
export interface GetIngestionJobResponse {
|
|
6871
|
+
/**
|
|
6872
|
+
* <p>Contains details about the data ingestion job.</p>
|
|
6873
|
+
* @public
|
|
6874
|
+
*/
|
|
6875
|
+
ingestionJob: IngestionJob | undefined;
|
|
6876
|
+
}
|
|
6877
|
+
/**
|
|
6878
|
+
* <p>The definition of a filter to filter the data.</p>
|
|
6879
|
+
* @public
|
|
6880
|
+
*/
|
|
6881
|
+
export interface IngestionJobFilter {
|
|
6882
|
+
/**
|
|
6883
|
+
* <p>The name of field or attribute to apply the filter.</p>
|
|
6884
|
+
* @public
|
|
6885
|
+
*/
|
|
6886
|
+
attribute: IngestionJobFilterAttribute | undefined;
|
|
6887
|
+
/**
|
|
6888
|
+
* <p>The operation to apply to the field or attribute.</p>
|
|
6889
|
+
* @public
|
|
6890
|
+
*/
|
|
6891
|
+
operator: IngestionJobFilterOperator | undefined;
|
|
6892
|
+
/**
|
|
6893
|
+
* <p>A list of values that belong to the field or attribute.</p>
|
|
6894
|
+
* @public
|
|
6895
|
+
*/
|
|
6896
|
+
values: string[] | undefined;
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
* <p>The parameters of sorting the data.</p>
|
|
6900
|
+
* @public
|
|
6901
|
+
*/
|
|
6902
|
+
export interface IngestionJobSortBy {
|
|
6903
|
+
/**
|
|
6904
|
+
* <p>The name of field or attribute to apply sorting of data.</p>
|
|
6905
|
+
* @public
|
|
6906
|
+
*/
|
|
6907
|
+
attribute: IngestionJobSortByAttribute | undefined;
|
|
6908
|
+
/**
|
|
6909
|
+
* <p>The order for sorting the data.</p>
|
|
6910
|
+
* @public
|
|
6911
|
+
*/
|
|
6912
|
+
order: SortOrder | undefined;
|
|
6913
|
+
}
|
|
6914
|
+
/**
|
|
6915
|
+
* @public
|
|
6916
|
+
*/
|
|
6917
|
+
export interface ListIngestionJobsRequest {
|
|
6918
|
+
/**
|
|
6919
|
+
* <p>The unique identifier of the knowledge base for the list of data ingestion jobs.</p>
|
|
6920
|
+
* @public
|
|
6921
|
+
*/
|
|
6922
|
+
knowledgeBaseId: string | undefined;
|
|
6923
|
+
/**
|
|
6924
|
+
* <p>The unique identifier of the data source for the list of data ingestion jobs.</p>
|
|
6925
|
+
* @public
|
|
6926
|
+
*/
|
|
6927
|
+
dataSourceId: string | undefined;
|
|
6928
|
+
/**
|
|
6929
|
+
* <p>Contains information about the filters for filtering the data.</p>
|
|
6930
|
+
* @public
|
|
6931
|
+
*/
|
|
6932
|
+
filters?: IngestionJobFilter[] | undefined;
|
|
6933
|
+
/**
|
|
6934
|
+
* <p>Contains details about how to sort the data.</p>
|
|
6935
|
+
* @public
|
|
6936
|
+
*/
|
|
6937
|
+
sortBy?: IngestionJobSortBy | undefined;
|
|
6938
|
+
/**
|
|
6939
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
6940
|
+
* @public
|
|
6941
|
+
*/
|
|
6942
|
+
maxResults?: number | undefined;
|
|
6943
|
+
/**
|
|
6944
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
6945
|
+
* @public
|
|
6946
|
+
*/
|
|
6947
|
+
nextToken?: string | undefined;
|
|
6948
|
+
}
|
|
6949
|
+
/**
|
|
6950
|
+
* <p>Contains details about a data ingestion job.</p>
|
|
6951
|
+
* @public
|
|
6952
|
+
*/
|
|
6953
|
+
export interface IngestionJobSummary {
|
|
6954
|
+
/**
|
|
6955
|
+
* <p>The unique identifier of the knowledge base for the data ingestion job.</p>
|
|
6956
|
+
* @public
|
|
6957
|
+
*/
|
|
6958
|
+
knowledgeBaseId: string | undefined;
|
|
6959
|
+
/**
|
|
6960
|
+
* <p>The unique identifier of the data source for the data ingestion job.</p>
|
|
6961
|
+
* @public
|
|
6962
|
+
*/
|
|
6963
|
+
dataSourceId: string | undefined;
|
|
6964
|
+
/**
|
|
6965
|
+
* <p>The unique identifier of the data ingestion job.</p>
|
|
6966
|
+
* @public
|
|
6967
|
+
*/
|
|
6968
|
+
ingestionJobId: string | undefined;
|
|
6969
|
+
/**
|
|
6970
|
+
* <p>The description of the data ingestion job.</p>
|
|
6971
|
+
* @public
|
|
6972
|
+
*/
|
|
6973
|
+
description?: string | undefined;
|
|
6974
|
+
/**
|
|
6975
|
+
* <p>The status of the data ingestion job.</p>
|
|
6976
|
+
* @public
|
|
6977
|
+
*/
|
|
6978
|
+
status: IngestionJobStatus | undefined;
|
|
6979
|
+
/**
|
|
6980
|
+
* <p>The time the data ingestion job started.</p>
|
|
6981
|
+
* @public
|
|
6982
|
+
*/
|
|
6983
|
+
startedAt: Date | undefined;
|
|
6984
|
+
/**
|
|
6985
|
+
* <p>The time the data ingestion job was last updated.</p>
|
|
6986
|
+
* @public
|
|
6987
|
+
*/
|
|
6988
|
+
updatedAt: Date | undefined;
|
|
6989
|
+
/**
|
|
6990
|
+
* <p>Contains statistics for the data ingestion job.</p>
|
|
6991
|
+
* @public
|
|
6992
|
+
*/
|
|
6993
|
+
statistics?: IngestionJobStatistics | undefined;
|
|
6994
|
+
}
|
|
6995
|
+
/**
|
|
6996
|
+
* @public
|
|
6997
|
+
*/
|
|
6998
|
+
export interface ListIngestionJobsResponse {
|
|
6999
|
+
/**
|
|
7000
|
+
* <p>A list of data ingestion jobs with information about each job.</p>
|
|
7001
|
+
* @public
|
|
7002
|
+
*/
|
|
7003
|
+
ingestionJobSummaries: IngestionJobSummary[] | undefined;
|
|
7004
|
+
/**
|
|
7005
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7006
|
+
* @public
|
|
7007
|
+
*/
|
|
7008
|
+
nextToken?: string | undefined;
|
|
7009
|
+
}
|
|
7010
|
+
/**
|
|
7011
|
+
* @public
|
|
7012
|
+
*/
|
|
7013
|
+
export interface StartIngestionJobRequest {
|
|
7014
|
+
/**
|
|
7015
|
+
* <p>The unique identifier of the knowledge base for the data ingestion job.</p>
|
|
7016
|
+
* @public
|
|
7017
|
+
*/
|
|
7018
|
+
knowledgeBaseId: string | undefined;
|
|
7019
|
+
/**
|
|
7020
|
+
* <p>The unique identifier of the data source you want to ingest into your knowledge base.</p>
|
|
7021
|
+
* @public
|
|
7022
|
+
*/
|
|
7023
|
+
dataSourceId: string | undefined;
|
|
7024
|
+
/**
|
|
7025
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7026
|
+
* @public
|
|
7027
|
+
*/
|
|
7028
|
+
clientToken?: string | undefined;
|
|
7029
|
+
/**
|
|
7030
|
+
* <p>A description of the data ingestion job.</p>
|
|
7031
|
+
* @public
|
|
7032
|
+
*/
|
|
7033
|
+
description?: string | undefined;
|
|
7034
|
+
}
|
|
7035
|
+
/**
|
|
7036
|
+
* @public
|
|
7037
|
+
*/
|
|
7038
|
+
export interface StartIngestionJobResponse {
|
|
7039
|
+
/**
|
|
7040
|
+
* <p>Contains information about the data ingestion job.</p>
|
|
7041
|
+
* @public
|
|
7042
|
+
*/
|
|
7043
|
+
ingestionJob: IngestionJob | undefined;
|
|
7044
|
+
}
|
|
7045
|
+
/**
|
|
7046
|
+
* @public
|
|
7047
|
+
*/
|
|
7048
|
+
export interface StopIngestionJobRequest {
|
|
7049
|
+
/**
|
|
7050
|
+
* <p>The unique identifier of the knowledge base for the data ingestion job you want to stop.</p>
|
|
7051
|
+
* @public
|
|
7052
|
+
*/
|
|
7053
|
+
knowledgeBaseId: string | undefined;
|
|
7054
|
+
/**
|
|
7055
|
+
* <p>The unique identifier of the data source for the data ingestion job you want to stop.</p>
|
|
7056
|
+
* @public
|
|
7057
|
+
*/
|
|
7058
|
+
dataSourceId: string | undefined;
|
|
7059
|
+
/**
|
|
7060
|
+
* <p>The unique identifier of the data ingestion job you want to stop.</p>
|
|
7061
|
+
* @public
|
|
7062
|
+
*/
|
|
7063
|
+
ingestionJobId: string | undefined;
|
|
7064
|
+
}
|
|
7065
|
+
/**
|
|
7066
|
+
* @public
|
|
7067
|
+
*/
|
|
7068
|
+
export interface StopIngestionJobResponse {
|
|
7069
|
+
/**
|
|
7070
|
+
* <p>Contains information about the stopped data ingestion job.</p>
|
|
7071
|
+
* @public
|
|
7072
|
+
*/
|
|
7073
|
+
ingestionJob: IngestionJob | undefined;
|
|
7074
|
+
}
|
|
7075
|
+
/**
|
|
7076
|
+
* <p>Contains information about the identifier of the document to ingest into a custom data source.</p>
|
|
7077
|
+
* @public
|
|
7078
|
+
*/
|
|
7079
|
+
export interface CustomDocumentIdentifier {
|
|
7080
|
+
/**
|
|
7081
|
+
* <p>The identifier of the document to ingest into a custom data source.</p>
|
|
7082
|
+
* @public
|
|
7083
|
+
*/
|
|
7084
|
+
id: string | undefined;
|
|
7085
|
+
}
|
|
7086
|
+
/**
|
|
7087
|
+
* <p>Contains information that identifies the document.</p>
|
|
7088
|
+
* @public
|
|
7089
|
+
*/
|
|
7090
|
+
export interface DocumentIdentifier {
|
|
7091
|
+
/**
|
|
7092
|
+
* <p>The type of data source connected to the knowledge base that contains the document.</p>
|
|
7093
|
+
* @public
|
|
7094
|
+
*/
|
|
7095
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
7096
|
+
/**
|
|
7097
|
+
* <p>Contains information that identifies the document in an S3 data source.</p>
|
|
7098
|
+
* @public
|
|
7099
|
+
*/
|
|
7100
|
+
s3?: S3Location | undefined;
|
|
7101
|
+
/**
|
|
7102
|
+
* <p>Contains information that identifies the document in a custom data source.</p>
|
|
7103
|
+
* @public
|
|
7104
|
+
*/
|
|
7105
|
+
custom?: CustomDocumentIdentifier | undefined;
|
|
7106
|
+
}
|
|
7107
|
+
/**
|
|
7108
|
+
* @public
|
|
7109
|
+
*/
|
|
7110
|
+
export interface DeleteKnowledgeBaseDocumentsRequest {
|
|
7111
|
+
/**
|
|
7112
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7113
|
+
* @public
|
|
7114
|
+
*/
|
|
7115
|
+
knowledgeBaseId: string | undefined;
|
|
7116
|
+
/**
|
|
7117
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7118
|
+
* @public
|
|
7119
|
+
*/
|
|
7120
|
+
dataSourceId: string | undefined;
|
|
7121
|
+
/**
|
|
7122
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7123
|
+
* @public
|
|
7124
|
+
*/
|
|
7125
|
+
clientToken?: string | undefined;
|
|
7126
|
+
/**
|
|
7127
|
+
* <p>A list of objects, each of which contains information to identify a document to delete.</p>
|
|
7128
|
+
* @public
|
|
7129
|
+
*/
|
|
7130
|
+
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
7131
|
+
}
|
|
7132
|
+
/**
|
|
7133
|
+
* <p>Contains the details for a document that was ingested or deleted.</p>
|
|
7134
|
+
* @public
|
|
7135
|
+
*/
|
|
7136
|
+
export interface KnowledgeBaseDocumentDetail {
|
|
7137
|
+
/**
|
|
7138
|
+
* <p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>
|
|
7139
|
+
* @public
|
|
7140
|
+
*/
|
|
7141
|
+
knowledgeBaseId: string | undefined;
|
|
7142
|
+
/**
|
|
7143
|
+
* <p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>
|
|
7144
|
+
* @public
|
|
7145
|
+
*/
|
|
7146
|
+
dataSourceId: string | undefined;
|
|
7147
|
+
/**
|
|
7148
|
+
* <p>The ingestion status of the document. The following statuses are possible:</p> <ul> <li> <p>STARTED – You submitted the ingestion job containing the document.</p> </li> <li> <p>PENDING – The document is waiting to be ingested.</p> </li> <li> <p>IN_PROGRESS – The document is being ingested.</p> </li> <li> <p>INDEXED – The document was successfully indexed.</p> </li> <li> <p>PARTIALLY_INDEXED – The document was partially indexed.</p> </li> <li> <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p> </li> <li> <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p> </li> <li> <p>FAILED – The document failed to be ingested.</p> </li> <li> <p>NOT_FOUND – The document wasn't found.</p> </li> <li> <p>IGNORED – The document was ignored during ingestion.</p> </li> <li> <p>DELETING – You submitted the delete job containing the document.</p> </li> <li> <p>DELETE_IN_PROGRESS – The document is being deleted.</p> </li> </ul>
|
|
7149
|
+
* @public
|
|
7150
|
+
*/
|
|
7151
|
+
status: DocumentStatus | undefined;
|
|
7152
|
+
/**
|
|
7153
|
+
* <p>Contains information that identifies the document.</p>
|
|
7154
|
+
* @public
|
|
7155
|
+
*/
|
|
7156
|
+
identifier: DocumentIdentifier | undefined;
|
|
7157
|
+
/**
|
|
7158
|
+
* <p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>
|
|
7159
|
+
* @public
|
|
7160
|
+
*/
|
|
7161
|
+
statusReason?: string | undefined;
|
|
7162
|
+
/**
|
|
7163
|
+
* <p>The date and time at which the document was last updated.</p>
|
|
7164
|
+
* @public
|
|
7165
|
+
*/
|
|
7166
|
+
updatedAt?: Date | undefined;
|
|
7167
|
+
}
|
|
7168
|
+
/**
|
|
7169
|
+
* @public
|
|
7170
|
+
*/
|
|
7171
|
+
export interface DeleteKnowledgeBaseDocumentsResponse {
|
|
7172
|
+
/**
|
|
7173
|
+
* <p>A list of objects, each of which contains information about the documents that were deleted.</p>
|
|
7174
|
+
* @public
|
|
7175
|
+
*/
|
|
7176
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7177
|
+
}
|
|
7178
|
+
/**
|
|
7179
|
+
* @public
|
|
7180
|
+
*/
|
|
7181
|
+
export interface GetKnowledgeBaseDocumentsRequest {
|
|
7182
|
+
/**
|
|
7183
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7184
|
+
* @public
|
|
7185
|
+
*/
|
|
7186
|
+
knowledgeBaseId: string | undefined;
|
|
7187
|
+
/**
|
|
7188
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7189
|
+
* @public
|
|
7190
|
+
*/
|
|
7191
|
+
dataSourceId: string | undefined;
|
|
7192
|
+
/**
|
|
7193
|
+
* <p>A list of objects, each of which contains information to identify a document for which to retrieve information.</p>
|
|
7194
|
+
* @public
|
|
7195
|
+
*/
|
|
7196
|
+
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
7197
|
+
}
|
|
7198
|
+
/**
|
|
7199
|
+
* @public
|
|
7200
|
+
*/
|
|
7201
|
+
export interface GetKnowledgeBaseDocumentsResponse {
|
|
7202
|
+
/**
|
|
7203
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
7204
|
+
* @public
|
|
7205
|
+
*/
|
|
7206
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7207
|
+
}
|
|
7208
|
+
/**
|
|
7209
|
+
* <p>Contains information about content defined inline in bytes.</p>
|
|
7210
|
+
* @public
|
|
7211
|
+
*/
|
|
7212
|
+
export interface ByteContentDoc {
|
|
7213
|
+
/**
|
|
7214
|
+
* <p>The MIME type of the content. For a list of MIME types, see <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">Media Types</a>. The following MIME types are supported:</p> <ul> <li> <p>text/plain</p> </li> <li> <p>text/html</p> </li> <li> <p>text/csv</p> </li> <li> <p>text/vtt</p> </li> <li> <p>message/rfc822</p> </li> <li> <p>application/xhtml+xml</p> </li> <li> <p>application/pdf</p> </li> <li> <p>application/msword</p> </li> <li> <p>application/vnd.ms-word.document.macroenabled.12</p> </li> <li> <p>application/vnd.ms-word.template.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel</p> </li> <li> <p>application/vnd.ms-excel.addin.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.sheet.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.template.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.sheet.binary.macroenabled.12</p> </li> <li> <p>application/vnd.ms-spreadsheetml</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.spreadsheetml.template</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.wordprocessingml.document</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.wordprocessingml.template</p> </li> </ul>
|
|
7215
|
+
* @public
|
|
7216
|
+
*/
|
|
7217
|
+
mimeType: string | undefined;
|
|
7218
|
+
/**
|
|
7219
|
+
* <p>The base64-encoded string of the content.</p>
|
|
7220
|
+
* @public
|
|
7221
|
+
*/
|
|
7222
|
+
data: Uint8Array | undefined;
|
|
7223
|
+
}
|
|
7224
|
+
/**
|
|
7225
|
+
* <p>Contains information about content defined inline in text.</p>
|
|
7226
|
+
* @public
|
|
7227
|
+
*/
|
|
7228
|
+
export interface TextContentDoc {
|
|
7229
|
+
/**
|
|
7230
|
+
* <p>The text of the content.</p>
|
|
7231
|
+
* @public
|
|
7232
|
+
*/
|
|
7233
|
+
data: string | undefined;
|
|
7234
|
+
}
|
|
7235
|
+
/**
|
|
7236
|
+
* <p>Contains information about content defined inline to ingest into a data source. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7237
|
+
* @public
|
|
7238
|
+
*/
|
|
7239
|
+
export interface InlineContent {
|
|
7240
|
+
/**
|
|
7241
|
+
* <p>The type of inline content to define.</p>
|
|
7242
|
+
* @public
|
|
7243
|
+
*/
|
|
7244
|
+
type: InlineContentType | undefined;
|
|
7245
|
+
/**
|
|
7246
|
+
* <p>Contains information about content defined inline in bytes.</p>
|
|
7247
|
+
* @public
|
|
7248
|
+
*/
|
|
7249
|
+
byteContent?: ByteContentDoc | undefined;
|
|
7250
|
+
/**
|
|
7251
|
+
* <p>Contains information about content defined inline in text.</p>
|
|
7252
|
+
* @public
|
|
7253
|
+
*/
|
|
7254
|
+
textContent?: TextContentDoc | undefined;
|
|
7255
|
+
}
|
|
7256
|
+
/**
|
|
7257
|
+
* <p>Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
7258
|
+
* @public
|
|
7259
|
+
*/
|
|
7260
|
+
export interface CustomS3Location {
|
|
7261
|
+
/**
|
|
7262
|
+
* <p>The S3 URI of the file containing the content to ingest.</p>
|
|
7263
|
+
* @public
|
|
7264
|
+
*/
|
|
7265
|
+
uri: string | undefined;
|
|
7266
|
+
/**
|
|
7267
|
+
* <p>The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.</p>
|
|
7268
|
+
* @public
|
|
7269
|
+
*/
|
|
7270
|
+
bucketOwnerAccountId?: string | undefined;
|
|
7271
|
+
}
|
|
7272
|
+
/**
|
|
7273
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a <code>sourceType</code> and include the field that corresponds to it.</p>
|
|
7274
|
+
* @public
|
|
7275
|
+
*/
|
|
7276
|
+
export interface CustomContent {
|
|
7277
|
+
/**
|
|
7278
|
+
* <p>A unique identifier for the document.</p>
|
|
7279
|
+
* @public
|
|
7280
|
+
*/
|
|
7281
|
+
customDocumentIdentifier: CustomDocumentIdentifier | undefined;
|
|
7282
|
+
/**
|
|
7283
|
+
* <p>The source of the data to ingest.</p>
|
|
7284
|
+
* @public
|
|
7285
|
+
*/
|
|
7286
|
+
sourceType: CustomSourceType | undefined;
|
|
7287
|
+
/**
|
|
7288
|
+
* <p>Contains information about the Amazon S3 location of the file from which to ingest data.</p>
|
|
7289
|
+
* @public
|
|
7290
|
+
*/
|
|
7291
|
+
s3Location?: CustomS3Location | undefined;
|
|
7292
|
+
/**
|
|
7293
|
+
* <p>Contains information about content defined inline to ingest into a knowledge base.</p>
|
|
7294
|
+
* @public
|
|
7295
|
+
*/
|
|
7296
|
+
inlineContent?: InlineContent | undefined;
|
|
7297
|
+
}
|
|
7298
|
+
/**
|
|
7299
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.</p>
|
|
7300
|
+
* @public
|
|
7301
|
+
*/
|
|
7302
|
+
export interface S3Content {
|
|
7303
|
+
/**
|
|
7304
|
+
* <p>The S3 location of the file containing the content to ingest.</p>
|
|
7305
|
+
* @public
|
|
7306
|
+
*/
|
|
7307
|
+
s3Location: S3Location | undefined;
|
|
7308
|
+
}
|
|
7309
|
+
/**
|
|
7310
|
+
* <p>Contains information about the content of a document. Choose a <code>dataSourceType</code> and include the field that corresponds to it.</p>
|
|
7311
|
+
* @public
|
|
7312
|
+
*/
|
|
7313
|
+
export interface DocumentContent {
|
|
7314
|
+
/**
|
|
7315
|
+
* <p>The type of data source that is connected to the knowledge base to which to ingest this document.</p>
|
|
7316
|
+
* @public
|
|
7317
|
+
*/
|
|
7318
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
7319
|
+
/**
|
|
7320
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
7321
|
+
* @public
|
|
7322
|
+
*/
|
|
7323
|
+
custom?: CustomContent | undefined;
|
|
7324
|
+
/**
|
|
7325
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source</p>
|
|
7326
|
+
* @public
|
|
7327
|
+
*/
|
|
7328
|
+
s3?: S3Content | undefined;
|
|
7329
|
+
}
|
|
7330
|
+
/**
|
|
7331
|
+
* <p>Contains the value of the metadata attribute. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7332
|
+
* @public
|
|
7333
|
+
*/
|
|
7334
|
+
export interface MetadataAttributeValue {
|
|
7335
|
+
/**
|
|
7336
|
+
* <p>The type of the metadata attribute.</p>
|
|
7337
|
+
* @public
|
|
7338
|
+
*/
|
|
7339
|
+
type: MetadataValueType | undefined;
|
|
7340
|
+
/**
|
|
7341
|
+
* <p>The value of the numeric metadata attribute.</p>
|
|
7342
|
+
* @public
|
|
7343
|
+
*/
|
|
7344
|
+
numberValue?: number | undefined;
|
|
7345
|
+
/**
|
|
7346
|
+
* <p>The value of the Boolean metadata attribute.</p>
|
|
7347
|
+
* @public
|
|
7348
|
+
*/
|
|
7349
|
+
booleanValue?: boolean | undefined;
|
|
7350
|
+
/**
|
|
7351
|
+
* <p>The value of the string metadata attribute.</p>
|
|
7352
|
+
* @public
|
|
7353
|
+
*/
|
|
7354
|
+
stringValue?: string | undefined;
|
|
7355
|
+
/**
|
|
7356
|
+
* <p>An array of strings that define the value of the metadata attribute.</p>
|
|
7357
|
+
* @public
|
|
7358
|
+
*/
|
|
7359
|
+
stringListValue?: string[] | undefined;
|
|
7360
|
+
}
|
|
7361
|
+
/**
|
|
7362
|
+
* <p>Contains information about a metadata attribute.</p>
|
|
7363
|
+
* @public
|
|
7364
|
+
*/
|
|
7365
|
+
export interface MetadataAttribute {
|
|
7366
|
+
/**
|
|
7367
|
+
* <p>The key of the metadata attribute.</p>
|
|
7368
|
+
* @public
|
|
7369
|
+
*/
|
|
7370
|
+
key: string | undefined;
|
|
7371
|
+
/**
|
|
7372
|
+
* <p>Contains the value of the metadata attribute.</p>
|
|
7373
|
+
* @public
|
|
7374
|
+
*/
|
|
7375
|
+
value: MetadataAttributeValue | undefined;
|
|
7376
|
+
}
|
|
7377
|
+
/**
|
|
7378
|
+
* <p>Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7379
|
+
* @public
|
|
7380
|
+
*/
|
|
7381
|
+
export interface DocumentMetadata {
|
|
7382
|
+
/**
|
|
7383
|
+
* <p>The type of the source source from which to add metadata.</p>
|
|
7384
|
+
* @public
|
|
7385
|
+
*/
|
|
7386
|
+
type: MetadataSourceType | undefined;
|
|
7387
|
+
/**
|
|
7388
|
+
* <p>An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.</p>
|
|
7389
|
+
* @public
|
|
7390
|
+
*/
|
|
7391
|
+
inlineAttributes?: MetadataAttribute[] | undefined;
|
|
7392
|
+
/**
|
|
7393
|
+
* <p>The Amazon S3 location of the file containing metadata to associate with the content to ingest.</p>
|
|
7394
|
+
* @public
|
|
7395
|
+
*/
|
|
7396
|
+
s3Location?: CustomS3Location | undefined;
|
|
7397
|
+
}
|
|
7398
|
+
/**
|
|
7399
|
+
* <p>Contains information about a document to ingest into a knowledge base and metadata to associate with it.</p>
|
|
7400
|
+
* @public
|
|
7401
|
+
*/
|
|
7402
|
+
export interface KnowledgeBaseDocument {
|
|
7403
|
+
/**
|
|
7404
|
+
* <p>Contains the metadata to associate with the document.</p>
|
|
7405
|
+
* @public
|
|
7406
|
+
*/
|
|
7407
|
+
metadata?: DocumentMetadata | undefined;
|
|
7408
|
+
/**
|
|
7409
|
+
* <p>Contains the content of the document.</p>
|
|
7410
|
+
* @public
|
|
7411
|
+
*/
|
|
7412
|
+
content: DocumentContent | undefined;
|
|
7413
|
+
}
|
|
7414
|
+
/**
|
|
7415
|
+
* @public
|
|
7416
|
+
*/
|
|
7417
|
+
export interface IngestKnowledgeBaseDocumentsRequest {
|
|
7418
|
+
/**
|
|
7419
|
+
* <p>The unique identifier of the knowledge base to ingest the documents into.</p>
|
|
7420
|
+
* @public
|
|
7421
|
+
*/
|
|
7422
|
+
knowledgeBaseId: string | undefined;
|
|
7423
|
+
/**
|
|
7424
|
+
* <p>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</p>
|
|
7425
|
+
* @public
|
|
7426
|
+
*/
|
|
7427
|
+
dataSourceId: string | undefined;
|
|
7428
|
+
/**
|
|
7429
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7430
|
+
* @public
|
|
7431
|
+
*/
|
|
7432
|
+
clientToken?: string | undefined;
|
|
7433
|
+
/**
|
|
7434
|
+
* <p>A list of objects, each of which contains information about the documents to add.</p>
|
|
7435
|
+
* @public
|
|
7436
|
+
*/
|
|
7437
|
+
documents: KnowledgeBaseDocument[] | undefined;
|
|
7438
|
+
}
|
|
7439
|
+
/**
|
|
7440
|
+
* @public
|
|
7441
|
+
*/
|
|
7442
|
+
export interface IngestKnowledgeBaseDocumentsResponse {
|
|
7443
|
+
/**
|
|
7444
|
+
* <p>A list of objects, each of which contains information about the documents that were ingested.</p>
|
|
7445
|
+
* @public
|
|
7446
|
+
*/
|
|
7447
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7448
|
+
}
|
|
7449
|
+
/**
|
|
7450
|
+
* @public
|
|
7451
|
+
*/
|
|
7452
|
+
export interface ListKnowledgeBaseDocumentsRequest {
|
|
7453
|
+
/**
|
|
7454
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7455
|
+
* @public
|
|
7456
|
+
*/
|
|
7457
|
+
knowledgeBaseId: string | undefined;
|
|
7458
|
+
/**
|
|
7459
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7460
|
+
* @public
|
|
7461
|
+
*/
|
|
7462
|
+
dataSourceId: string | undefined;
|
|
7463
|
+
/**
|
|
7464
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7465
|
+
* @public
|
|
7466
|
+
*/
|
|
7467
|
+
maxResults?: number | undefined;
|
|
7468
|
+
/**
|
|
7469
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
7470
|
+
* @public
|
|
7471
|
+
*/
|
|
7472
|
+
nextToken?: string | undefined;
|
|
7473
|
+
}
|
|
7474
|
+
/**
|
|
7475
|
+
* @public
|
|
7476
|
+
*/
|
|
7477
|
+
export interface ListKnowledgeBaseDocumentsResponse {
|
|
7478
|
+
/**
|
|
7479
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
7480
|
+
* @public
|
|
7481
|
+
*/
|
|
7482
|
+
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7483
|
+
/**
|
|
7484
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7485
|
+
* @public
|
|
7486
|
+
*/
|
|
7487
|
+
nextToken?: string | undefined;
|
|
7488
|
+
}
|
|
7489
|
+
/**
|
|
7490
|
+
* @public
|
|
7491
|
+
*/
|
|
7492
|
+
export interface AssociateAgentKnowledgeBaseRequest {
|
|
7493
|
+
/**
|
|
7494
|
+
* <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
|
|
7495
|
+
* @public
|
|
7496
|
+
*/
|
|
7497
|
+
agentId: string | undefined;
|
|
7498
|
+
/**
|
|
7499
|
+
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
7500
|
+
* @public
|
|
7501
|
+
*/
|
|
7502
|
+
agentVersion: string | undefined;
|
|
7503
|
+
/**
|
|
7504
|
+
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
7505
|
+
* @public
|
|
7506
|
+
*/
|
|
7507
|
+
knowledgeBaseId: string | undefined;
|
|
7508
|
+
/**
|
|
7509
|
+
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
7510
|
+
* @public
|
|
7511
|
+
*/
|
|
7512
|
+
description: string | undefined;
|
|
7513
|
+
/**
|
|
7514
|
+
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
7515
|
+
* @public
|
|
7516
|
+
*/
|
|
7517
|
+
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
7518
|
+
}
|
|
7519
|
+
/**
|
|
7520
|
+
* @public
|
|
7521
|
+
*/
|
|
7522
|
+
export interface AssociateAgentKnowledgeBaseResponse {
|
|
7523
|
+
/**
|
|
7524
|
+
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
7525
|
+
* @public
|
|
7526
|
+
*/
|
|
7527
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
7528
|
+
}
|
|
7529
|
+
/**
|
|
7530
|
+
* <p>Settings for an Amazon Kendra knowledge base.</p>
|
|
7531
|
+
* @public
|
|
7532
|
+
*/
|
|
7533
|
+
export interface KendraKnowledgeBaseConfiguration {
|
|
7534
|
+
/**
|
|
7535
|
+
* <p>The ARN of the Amazon Kendra index.</p>
|
|
7536
|
+
* @public
|
|
7537
|
+
*/
|
|
7538
|
+
kendraIndexArn: string | undefined;
|
|
7539
|
+
}
|
|
7540
|
+
/**
|
|
7541
|
+
* <p>Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
|
|
7542
|
+
* @public
|
|
7543
|
+
*/
|
|
7544
|
+
export interface RedshiftProvisionedAuthConfiguration {
|
|
7545
|
+
/**
|
|
7546
|
+
* <p>The type of authentication to use.</p>
|
|
7547
|
+
* @public
|
|
7548
|
+
*/
|
|
7549
|
+
type: RedshiftProvisionedAuthType | undefined;
|
|
7550
|
+
/**
|
|
7551
|
+
* <p>The database username for authentication to an Amazon Redshift provisioned data warehouse.</p>
|
|
7552
|
+
* @public
|
|
7553
|
+
*/
|
|
7554
|
+
databaseUser?: string | undefined;
|
|
7555
|
+
/**
|
|
7556
|
+
* <p>The ARN of an Secrets Manager secret for authentication.</p>
|
|
7557
|
+
* @public
|
|
7558
|
+
*/
|
|
7559
|
+
usernamePasswordSecretArn?: string | undefined;
|
|
7560
|
+
}
|
|
7561
|
+
/**
|
|
7562
|
+
* <p>Contains configurations for a provisioned Amazon Redshift query engine.</p>
|
|
7563
|
+
* @public
|
|
7564
|
+
*/
|
|
7565
|
+
export interface RedshiftProvisionedConfiguration {
|
|
7566
|
+
/**
|
|
7567
|
+
* <p>The ID of the Amazon Redshift cluster.</p>
|
|
7568
|
+
* @public
|
|
7569
|
+
*/
|
|
7570
|
+
clusterIdentifier: string | undefined;
|
|
7571
|
+
/**
|
|
7572
|
+
* <p>Specifies configurations for authentication to Amazon Redshift.</p>
|
|
7573
|
+
* @public
|
|
7574
|
+
*/
|
|
7575
|
+
authConfiguration: RedshiftProvisionedAuthConfiguration | undefined;
|
|
7576
|
+
}
|
|
7577
|
+
/**
|
|
7578
|
+
* <p>Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
|
|
7579
|
+
* @public
|
|
7580
|
+
*/
|
|
7581
|
+
export interface RedshiftServerlessAuthConfiguration {
|
|
7582
|
+
/**
|
|
7583
|
+
* <p>The type of authentication to use.</p>
|
|
7584
|
+
* @public
|
|
7585
|
+
*/
|
|
7586
|
+
type: RedshiftServerlessAuthType | undefined;
|
|
7587
|
+
/**
|
|
7588
|
+
* <p>The ARN of an Secrets Manager secret for authentication.</p>
|
|
7589
|
+
* @public
|
|
7590
|
+
*/
|
|
7591
|
+
usernamePasswordSecretArn?: string | undefined;
|
|
7592
|
+
}
|
|
7593
|
+
/**
|
|
7594
|
+
* <p>Contains configurations for authentication to Amazon Redshift Serverless.</p>
|
|
7595
|
+
* @public
|
|
7596
|
+
*/
|
|
7597
|
+
export interface RedshiftServerlessConfiguration {
|
|
7598
|
+
/**
|
|
7599
|
+
* <p>The ARN of the Amazon Redshift workgroup.</p>
|
|
7600
|
+
* @public
|
|
7601
|
+
*/
|
|
7602
|
+
workgroupArn: string | undefined;
|
|
7603
|
+
/**
|
|
7604
|
+
* <p>Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.</p>
|
|
7605
|
+
* @public
|
|
7606
|
+
*/
|
|
7607
|
+
authConfiguration: RedshiftServerlessAuthConfiguration | undefined;
|
|
7608
|
+
}
|
|
7609
|
+
/**
|
|
7610
|
+
* <p>Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in <code>type</code> and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
7611
|
+
* @public
|
|
7612
|
+
*/
|
|
7613
|
+
export interface RedshiftQueryEngineConfiguration {
|
|
7614
|
+
/**
|
|
7615
|
+
* <p>The type of query engine.</p>
|
|
7616
|
+
* @public
|
|
7617
|
+
*/
|
|
7618
|
+
type: RedshiftQueryEngineType | undefined;
|
|
7619
|
+
/**
|
|
7620
|
+
* <p>Specifies configurations for a serverless Amazon Redshift query engine.</p>
|
|
7621
|
+
* @public
|
|
7622
|
+
*/
|
|
7623
|
+
serverlessConfiguration?: RedshiftServerlessConfiguration | undefined;
|
|
7624
|
+
/**
|
|
7625
|
+
* <p>Specifies configurations for a provisioned Amazon Redshift query engine.</p>
|
|
7626
|
+
* @public
|
|
7627
|
+
*/
|
|
7628
|
+
provisionedConfiguration?: RedshiftProvisionedConfiguration | undefined;
|
|
7629
|
+
}
|
|
7630
|
+
/**
|
|
7631
|
+
* <p>Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
|
|
7632
|
+
* @public
|
|
7633
|
+
*/
|
|
7634
|
+
export interface CuratedQuery {
|
|
7635
|
+
/**
|
|
7636
|
+
* <p>An example natural language query.</p>
|
|
7637
|
+
* @public
|
|
7638
|
+
*/
|
|
7639
|
+
naturalLanguage: string | undefined;
|
|
7640
|
+
/**
|
|
7641
|
+
* <p>The SQL equivalent of the natural language query.</p>
|
|
7642
|
+
* @public
|
|
7643
|
+
*/
|
|
7644
|
+
sql: string | undefined;
|
|
7645
|
+
}
|
|
7646
|
+
/**
|
|
7647
|
+
* <p>Contains information about a column in the current table for the query engine to consider.</p>
|
|
7648
|
+
* @public
|
|
7649
|
+
*/
|
|
7650
|
+
export interface QueryGenerationColumn {
|
|
7651
|
+
/**
|
|
7652
|
+
* <p>The name of the column for which the other fields in this object apply.</p>
|
|
7653
|
+
* @public
|
|
7654
|
+
*/
|
|
7655
|
+
name?: string | undefined;
|
|
7656
|
+
/**
|
|
7657
|
+
* <p>A description of the column that helps the query engine understand the contents of the column.</p>
|
|
7658
|
+
* @public
|
|
7659
|
+
*/
|
|
7660
|
+
description?: string | undefined;
|
|
7661
|
+
/**
|
|
7662
|
+
* <p>Specifies whether to include or exclude the column during query generation. If you specify <code>EXCLUDE</code>, the column will be ignored. If you specify <code>INCLUDE</code>, all other columns in the table will be ignored.</p>
|
|
7663
|
+
* @public
|
|
7664
|
+
*/
|
|
7665
|
+
inclusion?: IncludeExclude | undefined;
|
|
7666
|
+
}
|
|
7667
|
+
/**
|
|
7668
|
+
* <p>Contains information about a table for the query engine to consider.</p>
|
|
7669
|
+
* @public
|
|
7670
|
+
*/
|
|
7671
|
+
export interface QueryGenerationTable {
|
|
7672
|
+
/**
|
|
7673
|
+
* <p>The name of the table for which the other fields in this object apply.</p>
|
|
7674
|
+
* @public
|
|
7675
|
+
*/
|
|
7676
|
+
name: string | undefined;
|
|
7677
|
+
/**
|
|
7678
|
+
* <p>A description of the table that helps the query engine understand the contents of the table.</p>
|
|
7679
|
+
* @public
|
|
7680
|
+
*/
|
|
7681
|
+
description?: string | undefined;
|
|
7682
|
+
/**
|
|
7683
|
+
* <p>Specifies whether to include or exclude the table during query generation. If you specify <code>EXCLUDE</code>, the table will be ignored. If you specify <code>INCLUDE</code>, all other tables will be ignored.</p>
|
|
7684
|
+
* @public
|
|
7685
|
+
*/
|
|
7686
|
+
inclusion?: IncludeExclude | undefined;
|
|
7687
|
+
/**
|
|
7688
|
+
* <p>An array of objects, each of which defines information about a column in the table.</p>
|
|
7689
|
+
* @public
|
|
7690
|
+
*/
|
|
7691
|
+
columns?: QueryGenerationColumn[] | undefined;
|
|
7692
|
+
}
|
|
7693
|
+
/**
|
|
7694
|
+
* <p>>Contains configurations for context to use during query generation.</p>
|
|
7695
|
+
* @public
|
|
7696
|
+
*/
|
|
7697
|
+
export interface QueryGenerationContext {
|
|
7698
|
+
/**
|
|
7699
|
+
* <p>An array of objects, each of which defines information about a table in the database.</p>
|
|
7700
|
+
* @public
|
|
7701
|
+
*/
|
|
7702
|
+
tables?: QueryGenerationTable[] | undefined;
|
|
7703
|
+
/**
|
|
7704
|
+
* <p>An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
|
|
7705
|
+
* @public
|
|
7706
|
+
*/
|
|
7707
|
+
curatedQueries?: CuratedQuery[] | undefined;
|
|
7708
|
+
}
|
|
7709
|
+
/**
|
|
7710
|
+
* <p>Contains configurations for query generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide..</p>
|
|
7711
|
+
* @public
|
|
7712
|
+
*/
|
|
7713
|
+
export interface QueryGenerationConfiguration {
|
|
7714
|
+
/**
|
|
7715
|
+
* <p>The time after which query generation will time out.</p>
|
|
7716
|
+
* @public
|
|
7717
|
+
*/
|
|
7718
|
+
executionTimeoutSeconds?: number | undefined;
|
|
7719
|
+
/**
|
|
7720
|
+
* <p>Specifies configurations for context to use during query generation.</p>
|
|
7721
|
+
* @public
|
|
7722
|
+
*/
|
|
7723
|
+
generationContext?: QueryGenerationContext | undefined;
|
|
7724
|
+
}
|
|
7725
|
+
/**
|
|
7726
|
+
* <p>Contains configurations for storage in Glue Data Catalog.</p>
|
|
7727
|
+
* @public
|
|
7728
|
+
*/
|
|
7729
|
+
export interface RedshiftQueryEngineAwsDataCatalogStorageConfiguration {
|
|
7730
|
+
/**
|
|
7731
|
+
* <p>A list of names of the tables to use.</p>
|
|
7732
|
+
* @public
|
|
7733
|
+
*/
|
|
7734
|
+
tableNames: string[] | undefined;
|
|
7735
|
+
}
|
|
7736
|
+
/**
|
|
7737
|
+
* <p>Contains configurations for storage in Amazon Redshift.</p>
|
|
7738
|
+
* @public
|
|
7739
|
+
*/
|
|
7740
|
+
export interface RedshiftQueryEngineRedshiftStorageConfiguration {
|
|
7741
|
+
/**
|
|
7742
|
+
* <p>The name of the Amazon Redshift database.</p>
|
|
7743
|
+
* @public
|
|
7744
|
+
*/
|
|
7745
|
+
databaseName: string | undefined;
|
|
7746
|
+
}
|
|
7747
|
+
/**
|
|
7748
|
+
* <p>Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
7749
|
+
* @public
|
|
7750
|
+
*/
|
|
7751
|
+
export interface RedshiftQueryEngineStorageConfiguration {
|
|
7752
|
+
/**
|
|
7753
|
+
* <p>The data storage service to use.</p>
|
|
7754
|
+
* @public
|
|
7755
|
+
*/
|
|
7756
|
+
type: RedshiftQueryEngineStorageType | undefined;
|
|
7757
|
+
/**
|
|
7758
|
+
* <p>Specifies configurations for storage in Glue Data Catalog.</p>
|
|
7759
|
+
* @public
|
|
7760
|
+
*/
|
|
7761
|
+
awsDataCatalogConfiguration?: RedshiftQueryEngineAwsDataCatalogStorageConfiguration | undefined;
|
|
7762
|
+
/**
|
|
7763
|
+
* <p>Specifies configurations for storage in Amazon Redshift.</p>
|
|
7764
|
+
* @public
|
|
7765
|
+
*/
|
|
7766
|
+
redshiftConfiguration?: RedshiftQueryEngineRedshiftStorageConfiguration | undefined;
|
|
7767
|
+
}
|
|
7768
|
+
/**
|
|
7769
|
+
* <p>Contains configurations for an Amazon Redshift database. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
7770
|
+
* @public
|
|
7771
|
+
*/
|
|
7772
|
+
export interface RedshiftConfiguration {
|
|
7773
|
+
/**
|
|
7774
|
+
* <p>Specifies configurations for Amazon Redshift database storage.</p>
|
|
7775
|
+
* @public
|
|
7776
|
+
*/
|
|
7777
|
+
storageConfigurations: RedshiftQueryEngineStorageConfiguration[] | undefined;
|
|
7778
|
+
/**
|
|
7779
|
+
* <p>Specifies configurations for an Amazon Redshift query engine.</p>
|
|
7780
|
+
* @public
|
|
7781
|
+
*/
|
|
7782
|
+
queryEngineConfiguration: RedshiftQueryEngineConfiguration | undefined;
|
|
7783
|
+
/**
|
|
7784
|
+
* <p>Specifies configurations for generating queries.</p>
|
|
7785
|
+
* @public
|
|
7786
|
+
*/
|
|
7787
|
+
queryGenerationConfiguration?: QueryGenerationConfiguration | undefined;
|
|
7788
|
+
}
|
|
7789
|
+
/**
|
|
7790
|
+
* <p>Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
7791
|
+
* @public
|
|
7792
|
+
*/
|
|
7793
|
+
export interface SqlKnowledgeBaseConfiguration {
|
|
7794
|
+
/**
|
|
7795
|
+
* <p>The type of SQL database to connect to the knowledge base.</p>
|
|
7796
|
+
* @public
|
|
7797
|
+
*/
|
|
7798
|
+
type: QueryEngineType | undefined;
|
|
7799
|
+
/**
|
|
7800
|
+
* <p>Specifies configurations for a knowledge base connected to an Amazon Redshift database.</p>
|
|
7801
|
+
* @public
|
|
7802
|
+
*/
|
|
7803
|
+
redshiftConfiguration?: RedshiftConfiguration | undefined;
|
|
7804
|
+
}
|
|
7805
|
+
/**
|
|
7806
|
+
* <p>The vector configuration details for the Bedrock embeddings model.</p>
|
|
7807
|
+
* @public
|
|
7808
|
+
*/
|
|
7809
|
+
export interface BedrockEmbeddingModelConfiguration {
|
|
7810
|
+
/**
|
|
7811
|
+
* <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
|
|
7812
|
+
* @public
|
|
7813
|
+
*/
|
|
7814
|
+
dimensions?: number | undefined;
|
|
7815
|
+
/**
|
|
7816
|
+
* <p>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</p>
|
|
7817
|
+
* @public
|
|
7818
|
+
*/
|
|
7819
|
+
embeddingDataType?: EmbeddingDataType | undefined;
|
|
7820
|
+
}
|
|
7821
|
+
/**
|
|
7822
|
+
* <p>The configuration details for the embeddings model.</p>
|
|
7823
|
+
* @public
|
|
7824
|
+
*/
|
|
7825
|
+
export interface EmbeddingModelConfiguration {
|
|
7826
|
+
/**
|
|
7827
|
+
* <p>The vector configuration details on the Bedrock embeddings model.</p>
|
|
7828
|
+
* @public
|
|
7829
|
+
*/
|
|
7830
|
+
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
|
|
7831
|
+
}
|
|
7832
|
+
/**
|
|
7833
|
+
* <p>Contains information about a storage location for images extracted from multimodal documents in your data source.</p>
|
|
7834
|
+
* @public
|
|
7835
|
+
*/
|
|
7836
|
+
export interface SupplementalDataStorageLocation {
|
|
7837
|
+
/**
|
|
7838
|
+
* <p>Specifies the storage service used for this location.</p>
|
|
7839
|
+
* @public
|
|
7840
|
+
*/
|
|
7841
|
+
type: SupplementalDataStorageLocationType | undefined;
|
|
7842
|
+
/**
|
|
7843
|
+
* <p>Contains information about the Amazon S3 location for the extracted images.</p>
|
|
7844
|
+
* @public
|
|
7845
|
+
*/
|
|
7846
|
+
s3Location?: S3Location | undefined;
|
|
7847
|
+
}
|
|
7848
|
+
/**
|
|
7849
|
+
* <p>Specifies configurations for the storage location of the images extracted from multimodal documents in your data source. These images can be retrieved and returned to the end user.</p>
|
|
7850
|
+
* @public
|
|
7851
|
+
*/
|
|
7852
|
+
export interface SupplementalDataStorageConfiguration {
|
|
7853
|
+
/**
|
|
7854
|
+
* <p>A list of objects specifying storage locations for images extracted from multimodal documents in your data source.</p>
|
|
7855
|
+
* @public
|
|
7856
|
+
*/
|
|
7857
|
+
storageLocations: SupplementalDataStorageLocation[] | undefined;
|
|
7858
|
+
}
|