@aws-sdk/client-bedrock-agent 3.461.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +526 -0
- package/dist-cjs/BedrockAgent.js +91 -0
- package/dist-cjs/BedrockAgentClient.js +43 -0
- package/dist-cjs/commands/AssociateAgentKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/CreateAgentActionGroupCommand.js +52 -0
- package/dist-cjs/commands/CreateAgentAliasCommand.js +51 -0
- package/dist-cjs/commands/CreateAgentCommand.js +52 -0
- package/dist-cjs/commands/CreateDataSourceCommand.js +51 -0
- package/dist-cjs/commands/CreateKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/DeleteAgentActionGroupCommand.js +51 -0
- package/dist-cjs/commands/DeleteAgentAliasCommand.js +51 -0
- package/dist-cjs/commands/DeleteAgentCommand.js +51 -0
- package/dist-cjs/commands/DeleteAgentVersionCommand.js +51 -0
- package/dist-cjs/commands/DeleteDataSourceCommand.js +51 -0
- package/dist-cjs/commands/DeleteKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/DisassociateAgentKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/GetAgentActionGroupCommand.js +52 -0
- package/dist-cjs/commands/GetAgentAliasCommand.js +51 -0
- package/dist-cjs/commands/GetAgentCommand.js +52 -0
- package/dist-cjs/commands/GetAgentKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/GetAgentVersionCommand.js +52 -0
- package/dist-cjs/commands/GetDataSourceCommand.js +51 -0
- package/dist-cjs/commands/GetIngestionJobCommand.js +51 -0
- package/dist-cjs/commands/GetKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/ListAgentActionGroupsCommand.js +51 -0
- package/dist-cjs/commands/ListAgentAliasesCommand.js +51 -0
- package/dist-cjs/commands/ListAgentKnowledgeBasesCommand.js +51 -0
- package/dist-cjs/commands/ListAgentVersionsCommand.js +51 -0
- package/dist-cjs/commands/ListAgentsCommand.js +51 -0
- package/dist-cjs/commands/ListDataSourcesCommand.js +51 -0
- package/dist-cjs/commands/ListIngestionJobsCommand.js +51 -0
- package/dist-cjs/commands/ListKnowledgeBasesCommand.js +51 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
- package/dist-cjs/commands/PrepareAgentCommand.js +51 -0
- package/dist-cjs/commands/StartIngestionJobCommand.js +51 -0
- package/dist-cjs/commands/TagResourceCommand.js +51 -0
- package/dist-cjs/commands/UntagResourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateAgentActionGroupCommand.js +52 -0
- package/dist-cjs/commands/UpdateAgentAliasCommand.js +51 -0
- package/dist-cjs/commands/UpdateAgentCommand.js +52 -0
- package/dist-cjs/commands/UpdateAgentKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/UpdateDataSourceCommand.js +51 -0
- package/dist-cjs/commands/UpdateKnowledgeBaseCommand.js +51 -0
- package/dist-cjs/commands/index.js +43 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/BedrockAgentServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +293 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAgentActionGroupsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAgentAliasesPaginator.js +29 -0
- package/dist-cjs/pagination/ListAgentKnowledgeBasesPaginator.js +29 -0
- package/dist-cjs/pagination/ListAgentVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListAgentsPaginator.js +29 -0
- package/dist-cjs/pagination/ListDataSourcesPaginator.js +29 -0
- package/dist-cjs/pagination/ListIngestionJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListKnowledgeBasesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +12 -0
- package/dist-cjs/protocols/Aws_restJson1.js +3362 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/BedrockAgent.js +87 -0
- package/dist-es/BedrockAgentClient.js +39 -0
- package/dist-es/commands/AssociateAgentKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/CreateAgentActionGroupCommand.js +48 -0
- package/dist-es/commands/CreateAgentAliasCommand.js +47 -0
- package/dist-es/commands/CreateAgentCommand.js +48 -0
- package/dist-es/commands/CreateDataSourceCommand.js +47 -0
- package/dist-es/commands/CreateKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/DeleteAgentActionGroupCommand.js +47 -0
- package/dist-es/commands/DeleteAgentAliasCommand.js +47 -0
- package/dist-es/commands/DeleteAgentCommand.js +47 -0
- package/dist-es/commands/DeleteAgentVersionCommand.js +47 -0
- package/dist-es/commands/DeleteDataSourceCommand.js +47 -0
- package/dist-es/commands/DeleteKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/DisassociateAgentKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/GetAgentActionGroupCommand.js +48 -0
- package/dist-es/commands/GetAgentAliasCommand.js +47 -0
- package/dist-es/commands/GetAgentCommand.js +48 -0
- package/dist-es/commands/GetAgentKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/GetAgentVersionCommand.js +48 -0
- package/dist-es/commands/GetDataSourceCommand.js +47 -0
- package/dist-es/commands/GetIngestionJobCommand.js +47 -0
- package/dist-es/commands/GetKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/ListAgentActionGroupsCommand.js +47 -0
- package/dist-es/commands/ListAgentAliasesCommand.js +47 -0
- package/dist-es/commands/ListAgentKnowledgeBasesCommand.js +47 -0
- package/dist-es/commands/ListAgentVersionsCommand.js +47 -0
- package/dist-es/commands/ListAgentsCommand.js +47 -0
- package/dist-es/commands/ListDataSourcesCommand.js +47 -0
- package/dist-es/commands/ListIngestionJobsCommand.js +47 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +47 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
- package/dist-es/commands/PrepareAgentCommand.js +47 -0
- package/dist-es/commands/StartIngestionJobCommand.js +47 -0
- package/dist-es/commands/TagResourceCommand.js +47 -0
- package/dist-es/commands/UntagResourceCommand.js +47 -0
- package/dist-es/commands/UpdateAgentActionGroupCommand.js +48 -0
- package/dist-es/commands/UpdateAgentAliasCommand.js +47 -0
- package/dist-es/commands/UpdateAgentCommand.js +48 -0
- package/dist-es/commands/UpdateAgentKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/UpdateDataSourceCommand.js +47 -0
- package/dist-es/commands/UpdateKnowledgeBaseCommand.js +47 -0
- package/dist-es/commands/index.js +40 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/BedrockAgentServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +267 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAgentActionGroupsPaginator.js +25 -0
- package/dist-es/pagination/ListAgentAliasesPaginator.js +25 -0
- package/dist-es/pagination/ListAgentKnowledgeBasesPaginator.js +25 -0
- package/dist-es/pagination/ListAgentVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListAgentsPaginator.js +25 -0
- package/dist-es/pagination/ListDataSourcesPaginator.js +25 -0
- package/dist-es/pagination/ListIngestionJobsPaginator.js +25 -0
- package/dist-es/pagination/ListKnowledgeBasesPaginator.js +25 -0
- package/dist-es/pagination/index.js +9 -0
- package/dist-es/protocols/Aws_restJson1.js +3278 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/BedrockAgent.d.ts +291 -0
- package/dist-types/BedrockAgentClient.d.ts +210 -0
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +106 -0
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +131 -0
- package/dist-types/commands/CreateAgentAliasCommand.d.ts +131 -0
- package/dist-types/commands/CreateAgentCommand.d.ts +165 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +147 -0
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +183 -0
- package/dist-types/commands/DeleteAgentActionGroupCommand.d.ts +92 -0
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +91 -0
- package/dist-types/commands/DeleteAgentCommand.d.ts +93 -0
- package/dist-types/commands/DeleteAgentVersionCommand.d.ts +95 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +94 -0
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +92 -0
- package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +91 -0
- package/dist-types/commands/GetAgentActionGroupCommand.d.ts +111 -0
- package/dist-types/commands/GetAgentAliasCommand.d.ts +115 -0
- package/dist-types/commands/GetAgentCommand.d.ts +131 -0
- package/dist-types/commands/GetAgentKnowledgeBaseCommand.d.ts +98 -0
- package/dist-types/commands/GetAgentVersionCommand.d.ts +130 -0
- package/dist-types/commands/GetDataSourceCommand.d.ts +118 -0
- package/dist-types/commands/GetIngestionJobCommand.d.ts +108 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +137 -0
- package/dist-types/commands/ListAgentActionGroupsCommand.d.ts +100 -0
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +105 -0
- package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +99 -0
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +100 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +96 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +100 -0
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +122 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +95 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +90 -0
- package/dist-types/commands/PrepareAgentCommand.d.ts +97 -0
- package/dist-types/commands/StartIngestionJobCommand.d.ts +115 -0
- package/dist-types/commands/TagResourceCommand.d.ts +92 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +89 -0
- package/dist-types/commands/UpdateAgentActionGroupCommand.d.ts +131 -0
- package/dist-types/commands/UpdateAgentAliasCommand.d.ts +128 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +165 -0
- package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +103 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +144 -0
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +180 -0
- package/dist-types/commands/index.d.ts +40 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +16 -0
- package/dist-types/models/BedrockAgentServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +3256 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAgentActionGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAgentAliasesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAgentKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAgentVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAgentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDataSourcesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIngestionJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +9 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +362 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +687 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +359 -0
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateAgentActionGroupCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateAgentAliasCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateAgentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/CreateDataSourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteAgentActionGroupCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAgentAliasCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAgentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteAgentVersionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAgentActionGroupCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetAgentAliasCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetAgentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetAgentKnowledgeBaseCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetAgentVersionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetDataSourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetIngestionJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAgentActionGroupsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAgentAliasesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAgentKnowledgeBasesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListAgentVersionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAgentsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListDataSourcesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListIngestionJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/PrepareAgentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/StartIngestionJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateAgentActionGroupCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateAgentAliasCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateAgentCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateAgentKnowledgeBaseCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +40 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/BedrockAgentServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +915 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAgentActionGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAgentAliasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAgentKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAgentVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAgentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDataSourcesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListIngestionJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKnowledgeBasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +9 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +485 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +104 -0
|
@@ -0,0 +1,3256 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { BedrockAgentServiceException as __BaseException } from "./BedrockAgentServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* This exception is thrown when a request is denied per access permissions
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* Type of Executors for an Action Group
|
|
18
|
+
*/
|
|
19
|
+
export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export declare namespace ActionGroupExecutor {
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* ARN of a Lambda.
|
|
27
|
+
*/
|
|
28
|
+
interface LambdaMember {
|
|
29
|
+
lambda: string;
|
|
30
|
+
$unknown?: never;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
interface $UnknownMember {
|
|
36
|
+
lambda?: never;
|
|
37
|
+
$unknown: [string, any];
|
|
38
|
+
}
|
|
39
|
+
interface Visitor<T> {
|
|
40
|
+
lambda: (value: string) => T;
|
|
41
|
+
_: (name: string, value: any) => T;
|
|
42
|
+
}
|
|
43
|
+
const visit: <T>(value: ActionGroupExecutor, visitor: Visitor<T>) => T;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
* This exception is thrown when there is a conflict performing an operation
|
|
48
|
+
*/
|
|
49
|
+
export declare class ConflictException extends __BaseException {
|
|
50
|
+
readonly name: "ConflictException";
|
|
51
|
+
readonly $fault: "client";
|
|
52
|
+
/**
|
|
53
|
+
* @internal
|
|
54
|
+
*/
|
|
55
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
* @enum
|
|
60
|
+
*/
|
|
61
|
+
export declare const ActionGroupState: {
|
|
62
|
+
readonly DISABLED: "DISABLED";
|
|
63
|
+
readonly ENABLED: "ENABLED";
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export type ActionGroupState = (typeof ActionGroupState)[keyof typeof ActionGroupState];
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* The identifier for the S3 resource.
|
|
72
|
+
*/
|
|
73
|
+
export interface S3Identifier {
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* A bucket in S3.
|
|
77
|
+
*/
|
|
78
|
+
s3BucketName?: string;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
* A object key in S3.
|
|
82
|
+
*/
|
|
83
|
+
s3ObjectKey?: string;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* Contains information about the API Schema for the Action Group
|
|
88
|
+
*/
|
|
89
|
+
export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare namespace APISchema {
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
* The identifier for the S3 resource.
|
|
97
|
+
*/
|
|
98
|
+
interface S3Member {
|
|
99
|
+
s3: S3Identifier;
|
|
100
|
+
payload?: never;
|
|
101
|
+
$unknown?: never;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
* String OpenAPI Payload
|
|
106
|
+
*/
|
|
107
|
+
interface PayloadMember {
|
|
108
|
+
s3?: never;
|
|
109
|
+
payload: string;
|
|
110
|
+
$unknown?: never;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
interface $UnknownMember {
|
|
116
|
+
s3?: never;
|
|
117
|
+
payload?: never;
|
|
118
|
+
$unknown: [string, any];
|
|
119
|
+
}
|
|
120
|
+
interface Visitor<T> {
|
|
121
|
+
s3: (value: S3Identifier) => T;
|
|
122
|
+
payload: (value: string) => T;
|
|
123
|
+
_: (name: string, value: any) => T;
|
|
124
|
+
}
|
|
125
|
+
const visit: <T>(value: APISchema, visitor: Visitor<T>) => T;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
* @enum
|
|
130
|
+
*/
|
|
131
|
+
export declare const ActionGroupSignature: {
|
|
132
|
+
readonly AMAZON_USERINPUT: "AMAZON.UserInput";
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature];
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* Create Action Group Request
|
|
141
|
+
*/
|
|
142
|
+
export interface CreateAgentActionGroupRequest {
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* Id generated at the server side when an Agent is created
|
|
146
|
+
*/
|
|
147
|
+
agentId: string | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* Draft Version of the Agent.
|
|
151
|
+
*/
|
|
152
|
+
agentVersion: string | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* Name for a resource.
|
|
156
|
+
*/
|
|
157
|
+
actionGroupName: string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* Client specified token used for idempotency checks
|
|
161
|
+
*/
|
|
162
|
+
clientToken?: string;
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
* Description of the Resource.
|
|
166
|
+
*/
|
|
167
|
+
description?: string;
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
* Action Group Signature for a BuiltIn Action
|
|
171
|
+
*/
|
|
172
|
+
parentActionGroupSignature?: ActionGroupSignature;
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
* Type of Executors for an Action Group
|
|
176
|
+
*/
|
|
177
|
+
actionGroupExecutor?: ActionGroupExecutor;
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
* Contains information about the API Schema for the Action Group
|
|
181
|
+
*/
|
|
182
|
+
apiSchema?: APISchema;
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
* State of the action group
|
|
186
|
+
*/
|
|
187
|
+
actionGroupState?: ActionGroupState;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* @public
|
|
191
|
+
* Contains the information of an Agent Action Group
|
|
192
|
+
*/
|
|
193
|
+
export interface AgentActionGroup {
|
|
194
|
+
/**
|
|
195
|
+
* @public
|
|
196
|
+
* Identifier for a resource.
|
|
197
|
+
*/
|
|
198
|
+
agentId: string | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
* Agent Version.
|
|
202
|
+
*/
|
|
203
|
+
agentVersion: string | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* @public
|
|
206
|
+
* Identifier for a resource.
|
|
207
|
+
*/
|
|
208
|
+
actionGroupId: string | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* @public
|
|
211
|
+
* Name for a resource.
|
|
212
|
+
*/
|
|
213
|
+
actionGroupName: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* @public
|
|
216
|
+
* Client specified token used for idempotency checks
|
|
217
|
+
*/
|
|
218
|
+
clientToken?: string;
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* Description of the Resource.
|
|
222
|
+
*/
|
|
223
|
+
description?: string;
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
* Time Stamp.
|
|
227
|
+
*/
|
|
228
|
+
createdAt: Date | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* @public
|
|
231
|
+
* Time Stamp.
|
|
232
|
+
*/
|
|
233
|
+
updatedAt: Date | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* @public
|
|
236
|
+
* Action Group Signature for a BuiltIn Action
|
|
237
|
+
*/
|
|
238
|
+
parentActionSignature?: ActionGroupSignature;
|
|
239
|
+
/**
|
|
240
|
+
* @public
|
|
241
|
+
* Type of Executors for an Action Group
|
|
242
|
+
*/
|
|
243
|
+
actionGroupExecutor?: ActionGroupExecutor;
|
|
244
|
+
/**
|
|
245
|
+
* @public
|
|
246
|
+
* Contains information about the API Schema for the Action Group
|
|
247
|
+
*/
|
|
248
|
+
apiSchema?: APISchema;
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
* State of the action group
|
|
252
|
+
*/
|
|
253
|
+
actionGroupState: ActionGroupState | undefined;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* @public
|
|
257
|
+
* Create Action Group Response
|
|
258
|
+
*/
|
|
259
|
+
export interface CreateAgentActionGroupResponse {
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
* Contains the information of an Agent Action Group
|
|
263
|
+
*/
|
|
264
|
+
agentActionGroup: AgentActionGroup | undefined;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* @public
|
|
268
|
+
* This exception is thrown if there was an unexpected error during processing of request
|
|
269
|
+
*/
|
|
270
|
+
export declare class InternalServerException extends __BaseException {
|
|
271
|
+
readonly name: "InternalServerException";
|
|
272
|
+
readonly $fault: "server";
|
|
273
|
+
/**
|
|
274
|
+
* @internal
|
|
275
|
+
*/
|
|
276
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* @public
|
|
280
|
+
* This exception is thrown when a resource referenced by the operation does not exist
|
|
281
|
+
*/
|
|
282
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
283
|
+
readonly name: "ResourceNotFoundException";
|
|
284
|
+
readonly $fault: "client";
|
|
285
|
+
/**
|
|
286
|
+
* @internal
|
|
287
|
+
*/
|
|
288
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* @public
|
|
292
|
+
* This exception is thrown when a request is made beyond the service quota
|
|
293
|
+
*/
|
|
294
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
295
|
+
readonly name: "ServiceQuotaExceededException";
|
|
296
|
+
readonly $fault: "client";
|
|
297
|
+
/**
|
|
298
|
+
* @internal
|
|
299
|
+
*/
|
|
300
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* @public
|
|
304
|
+
* This exception is thrown when the number of requests exceeds the limit
|
|
305
|
+
*/
|
|
306
|
+
export declare class ThrottlingException extends __BaseException {
|
|
307
|
+
readonly name: "ThrottlingException";
|
|
308
|
+
readonly $fault: "client";
|
|
309
|
+
/**
|
|
310
|
+
* @internal
|
|
311
|
+
*/
|
|
312
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* @public
|
|
316
|
+
* Stores information about a field passed inside a request that resulted in an exception
|
|
317
|
+
*/
|
|
318
|
+
export interface ValidationExceptionField {
|
|
319
|
+
/**
|
|
320
|
+
* @public
|
|
321
|
+
* Non Blank String
|
|
322
|
+
*/
|
|
323
|
+
name: string | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
* Non Blank String
|
|
327
|
+
*/
|
|
328
|
+
message: string | undefined;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
* This exception is thrown when the request's input validation fails
|
|
333
|
+
*/
|
|
334
|
+
export declare class ValidationException extends __BaseException {
|
|
335
|
+
readonly name: "ValidationException";
|
|
336
|
+
readonly $fault: "client";
|
|
337
|
+
/**
|
|
338
|
+
* @public
|
|
339
|
+
* list of ValidationExceptionField
|
|
340
|
+
*/
|
|
341
|
+
fieldList?: ValidationExceptionField[];
|
|
342
|
+
/**
|
|
343
|
+
* @internal
|
|
344
|
+
*/
|
|
345
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* @public
|
|
349
|
+
* Delete Action Group Request
|
|
350
|
+
*/
|
|
351
|
+
export interface DeleteAgentActionGroupRequest {
|
|
352
|
+
/**
|
|
353
|
+
* @public
|
|
354
|
+
* Id generated at the server side when an Agent is created
|
|
355
|
+
*/
|
|
356
|
+
agentId: string | undefined;
|
|
357
|
+
/**
|
|
358
|
+
* @public
|
|
359
|
+
* Draft Version of the Agent.
|
|
360
|
+
*/
|
|
361
|
+
agentVersion: string | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* @public
|
|
364
|
+
* Id generated at the server side when an Agent ActionGroup is created
|
|
365
|
+
*/
|
|
366
|
+
actionGroupId: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* @public
|
|
369
|
+
* Skips checking if resource is in use when set to true. Defaults to false
|
|
370
|
+
*/
|
|
371
|
+
skipResourceInUseCheck?: boolean;
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* @public
|
|
375
|
+
* Delete Action Group Response
|
|
376
|
+
*/
|
|
377
|
+
export interface DeleteAgentActionGroupResponse {
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* @public
|
|
381
|
+
* Get Action Group Request
|
|
382
|
+
*/
|
|
383
|
+
export interface GetAgentActionGroupRequest {
|
|
384
|
+
/**
|
|
385
|
+
* @public
|
|
386
|
+
* Id generated at the server side when an Agent is created
|
|
387
|
+
*/
|
|
388
|
+
agentId: string | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* @public
|
|
391
|
+
* Version number generated when a version is created
|
|
392
|
+
*/
|
|
393
|
+
agentVersion: string | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* @public
|
|
396
|
+
* Id generated at the server side when an Agent Action Group is created
|
|
397
|
+
*/
|
|
398
|
+
actionGroupId: string | undefined;
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* @public
|
|
402
|
+
* Get Action Group Response
|
|
403
|
+
*/
|
|
404
|
+
export interface GetAgentActionGroupResponse {
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
* Contains the information of an Agent Action Group
|
|
408
|
+
*/
|
|
409
|
+
agentActionGroup: AgentActionGroup | undefined;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
* List Action Groups Request
|
|
414
|
+
*/
|
|
415
|
+
export interface ListAgentActionGroupsRequest {
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
* Id generated at the server side when an Agent is Listed
|
|
419
|
+
*/
|
|
420
|
+
agentId: string | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
* Id generated at the server side when an Agent is Listed
|
|
424
|
+
*/
|
|
425
|
+
agentVersion: string | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* @public
|
|
428
|
+
* Max Results.
|
|
429
|
+
*/
|
|
430
|
+
maxResults?: number;
|
|
431
|
+
/**
|
|
432
|
+
* @public
|
|
433
|
+
* Opaque continuation token of previous paginated response.
|
|
434
|
+
*/
|
|
435
|
+
nextToken?: string;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* @public
|
|
439
|
+
* ActionGroup Summary
|
|
440
|
+
*/
|
|
441
|
+
export interface ActionGroupSummary {
|
|
442
|
+
/**
|
|
443
|
+
* @public
|
|
444
|
+
* Identifier for a resource.
|
|
445
|
+
*/
|
|
446
|
+
actionGroupId: string | undefined;
|
|
447
|
+
/**
|
|
448
|
+
* @public
|
|
449
|
+
* Name for a resource.
|
|
450
|
+
*/
|
|
451
|
+
actionGroupName: string | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
* State of the action group
|
|
455
|
+
*/
|
|
456
|
+
actionGroupState: ActionGroupState | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* @public
|
|
459
|
+
* Description of the Resource.
|
|
460
|
+
*/
|
|
461
|
+
description?: string;
|
|
462
|
+
/**
|
|
463
|
+
* @public
|
|
464
|
+
* Time Stamp.
|
|
465
|
+
*/
|
|
466
|
+
updatedAt: Date | undefined;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
* List Action Groups Response
|
|
471
|
+
*/
|
|
472
|
+
export interface ListAgentActionGroupsResponse {
|
|
473
|
+
/**
|
|
474
|
+
* @public
|
|
475
|
+
* List of ActionGroup Summaries
|
|
476
|
+
*/
|
|
477
|
+
actionGroupSummaries: ActionGroupSummary[] | undefined;
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
* Opaque continuation token of previous paginated response.
|
|
481
|
+
*/
|
|
482
|
+
nextToken?: string;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
* Update Action Group Request
|
|
487
|
+
*/
|
|
488
|
+
export interface UpdateAgentActionGroupRequest {
|
|
489
|
+
/**
|
|
490
|
+
* @public
|
|
491
|
+
* Id generated at the server side when an Agent is created
|
|
492
|
+
*/
|
|
493
|
+
agentId: string | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* @public
|
|
496
|
+
* Draft Version of the Agent.
|
|
497
|
+
*/
|
|
498
|
+
agentVersion: string | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* @public
|
|
501
|
+
* Id generated at the server side when an Action Group is created under Agent
|
|
502
|
+
*/
|
|
503
|
+
actionGroupId: string | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* @public
|
|
506
|
+
* Name for a resource.
|
|
507
|
+
*/
|
|
508
|
+
actionGroupName: string | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* @public
|
|
511
|
+
* Description of the Resource.
|
|
512
|
+
*/
|
|
513
|
+
description?: string;
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
* Action Group Signature for a BuiltIn Action
|
|
517
|
+
*/
|
|
518
|
+
parentActionGroupSignature?: ActionGroupSignature;
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
* Type of Executors for an Action Group
|
|
522
|
+
*/
|
|
523
|
+
actionGroupExecutor?: ActionGroupExecutor;
|
|
524
|
+
/**
|
|
525
|
+
* @public
|
|
526
|
+
* State of the action group
|
|
527
|
+
*/
|
|
528
|
+
actionGroupState?: ActionGroupState;
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* Contains information about the API Schema for the Action Group
|
|
532
|
+
*/
|
|
533
|
+
apiSchema?: APISchema;
|
|
534
|
+
}
|
|
535
|
+
/**
|
|
536
|
+
* @public
|
|
537
|
+
* Update Action Group Response
|
|
538
|
+
*/
|
|
539
|
+
export interface UpdateAgentActionGroupResponse {
|
|
540
|
+
/**
|
|
541
|
+
* @public
|
|
542
|
+
* Contains the information of an Agent Action Group
|
|
543
|
+
*/
|
|
544
|
+
agentActionGroup: AgentActionGroup | undefined;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* @public
|
|
548
|
+
* @enum
|
|
549
|
+
*/
|
|
550
|
+
export declare const AgentStatus: {
|
|
551
|
+
readonly CREATING: "CREATING";
|
|
552
|
+
readonly DELETING: "DELETING";
|
|
553
|
+
readonly FAILED: "FAILED";
|
|
554
|
+
readonly NOT_PREPARED: "NOT_PREPARED";
|
|
555
|
+
readonly PREPARED: "PREPARED";
|
|
556
|
+
readonly PREPARING: "PREPARING";
|
|
557
|
+
readonly UPDATING: "UPDATING";
|
|
558
|
+
readonly VERSIONING: "VERSIONING";
|
|
559
|
+
};
|
|
560
|
+
/**
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
|
|
564
|
+
/**
|
|
565
|
+
* @public
|
|
566
|
+
* Configuration for inference in prompt configuration
|
|
567
|
+
*/
|
|
568
|
+
export interface InferenceConfiguration {
|
|
569
|
+
/**
|
|
570
|
+
* @public
|
|
571
|
+
* Controls randomness, higher values increase diversity
|
|
572
|
+
*/
|
|
573
|
+
temperature?: number;
|
|
574
|
+
/**
|
|
575
|
+
* @public
|
|
576
|
+
* Cumulative probability cutoff for token selection
|
|
577
|
+
*/
|
|
578
|
+
topP?: number;
|
|
579
|
+
/**
|
|
580
|
+
* @public
|
|
581
|
+
* Sample from the k most likely next tokens
|
|
582
|
+
*/
|
|
583
|
+
topK?: number;
|
|
584
|
+
/**
|
|
585
|
+
* @public
|
|
586
|
+
* Maximum length of output
|
|
587
|
+
*/
|
|
588
|
+
maximumLength?: number;
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
* List of stop sequences
|
|
592
|
+
*/
|
|
593
|
+
stopSequences?: string[];
|
|
594
|
+
}
|
|
595
|
+
/**
|
|
596
|
+
* @public
|
|
597
|
+
* @enum
|
|
598
|
+
*/
|
|
599
|
+
export declare const CreationMode: {
|
|
600
|
+
readonly DEFAULT: "DEFAULT";
|
|
601
|
+
readonly OVERRIDDEN: "OVERRIDDEN";
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode];
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
* @enum
|
|
610
|
+
*/
|
|
611
|
+
export declare const PromptState: {
|
|
612
|
+
readonly DISABLED: "DISABLED";
|
|
613
|
+
readonly ENABLED: "ENABLED";
|
|
614
|
+
};
|
|
615
|
+
/**
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
export type PromptState = (typeof PromptState)[keyof typeof PromptState];
|
|
619
|
+
/**
|
|
620
|
+
* @public
|
|
621
|
+
* @enum
|
|
622
|
+
*/
|
|
623
|
+
export declare const PromptType: {
|
|
624
|
+
readonly KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION";
|
|
625
|
+
readonly ORCHESTRATION: "ORCHESTRATION";
|
|
626
|
+
readonly POST_PROCESSING: "POST_PROCESSING";
|
|
627
|
+
readonly PRE_PROCESSING: "PRE_PROCESSING";
|
|
628
|
+
};
|
|
629
|
+
/**
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
export type PromptType = (typeof PromptType)[keyof typeof PromptType];
|
|
633
|
+
/**
|
|
634
|
+
* @public
|
|
635
|
+
* BasePromptConfiguration per Prompt Type.
|
|
636
|
+
*/
|
|
637
|
+
export interface PromptConfiguration {
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
* Prompt Type.
|
|
641
|
+
*/
|
|
642
|
+
promptType?: PromptType;
|
|
643
|
+
/**
|
|
644
|
+
* @public
|
|
645
|
+
* Creation Mode for Prompt Configuration.
|
|
646
|
+
*/
|
|
647
|
+
promptCreationMode?: CreationMode;
|
|
648
|
+
/**
|
|
649
|
+
* @public
|
|
650
|
+
* Prompt State.
|
|
651
|
+
*/
|
|
652
|
+
promptState?: PromptState;
|
|
653
|
+
/**
|
|
654
|
+
* @public
|
|
655
|
+
* Base Prompt Template.
|
|
656
|
+
*/
|
|
657
|
+
basePromptTemplate?: string;
|
|
658
|
+
/**
|
|
659
|
+
* @public
|
|
660
|
+
* Configuration for inference in prompt configuration
|
|
661
|
+
*/
|
|
662
|
+
inferenceConfiguration?: InferenceConfiguration;
|
|
663
|
+
/**
|
|
664
|
+
* @public
|
|
665
|
+
* Creation Mode for Prompt Configuration.
|
|
666
|
+
*/
|
|
667
|
+
parserMode?: CreationMode;
|
|
668
|
+
}
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
* Configuration for prompt override.
|
|
672
|
+
*/
|
|
673
|
+
export interface PromptOverrideConfiguration {
|
|
674
|
+
/**
|
|
675
|
+
* @public
|
|
676
|
+
* List of BasePromptConfiguration
|
|
677
|
+
*/
|
|
678
|
+
promptConfigurations: PromptConfiguration[] | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* @public
|
|
681
|
+
* ARN of a Lambda.
|
|
682
|
+
*/
|
|
683
|
+
overrideLambda?: string;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* @public
|
|
687
|
+
* Contains the information of an agent
|
|
688
|
+
*/
|
|
689
|
+
export interface Agent {
|
|
690
|
+
/**
|
|
691
|
+
* @public
|
|
692
|
+
* Identifier for a resource.
|
|
693
|
+
*/
|
|
694
|
+
agentId: string | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* @public
|
|
697
|
+
* Name for a resource.
|
|
698
|
+
*/
|
|
699
|
+
agentName: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* @public
|
|
702
|
+
* Arn representation of the Agent.
|
|
703
|
+
*/
|
|
704
|
+
agentArn: string | undefined;
|
|
705
|
+
/**
|
|
706
|
+
* @public
|
|
707
|
+
* Draft Agent Version.
|
|
708
|
+
*/
|
|
709
|
+
agentVersion: string | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* @public
|
|
712
|
+
* Client specified token used for idempotency checks
|
|
713
|
+
*/
|
|
714
|
+
clientToken?: string;
|
|
715
|
+
/**
|
|
716
|
+
* @public
|
|
717
|
+
* Instruction for the agent.
|
|
718
|
+
*/
|
|
719
|
+
instruction?: string;
|
|
720
|
+
/**
|
|
721
|
+
* @public
|
|
722
|
+
* Schema Type for Action APIs.
|
|
723
|
+
*/
|
|
724
|
+
agentStatus: AgentStatus | undefined;
|
|
725
|
+
/**
|
|
726
|
+
* @public
|
|
727
|
+
* ARN or name of a Bedrock model.
|
|
728
|
+
*/
|
|
729
|
+
foundationModel?: string;
|
|
730
|
+
/**
|
|
731
|
+
* @public
|
|
732
|
+
* Description of the Resource.
|
|
733
|
+
*/
|
|
734
|
+
description?: string;
|
|
735
|
+
/**
|
|
736
|
+
* @public
|
|
737
|
+
* Max Session Time.
|
|
738
|
+
*/
|
|
739
|
+
idleSessionTTLInSeconds: number | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* @public
|
|
742
|
+
* ARN of a IAM role.
|
|
743
|
+
*/
|
|
744
|
+
agentResourceRoleArn: string | undefined;
|
|
745
|
+
/**
|
|
746
|
+
* @public
|
|
747
|
+
* A KMS key ARN
|
|
748
|
+
*/
|
|
749
|
+
customerEncryptionKeyArn?: string;
|
|
750
|
+
/**
|
|
751
|
+
* @public
|
|
752
|
+
* Time Stamp.
|
|
753
|
+
*/
|
|
754
|
+
createdAt: Date | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
* Time Stamp.
|
|
758
|
+
*/
|
|
759
|
+
updatedAt: Date | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
* Time Stamp.
|
|
763
|
+
*/
|
|
764
|
+
preparedAt?: Date;
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
* Failure Reasons for Error.
|
|
768
|
+
*/
|
|
769
|
+
failureReasons?: string[];
|
|
770
|
+
/**
|
|
771
|
+
* @public
|
|
772
|
+
* The recommended actions users can take to resolve an error in failureReasons.
|
|
773
|
+
*/
|
|
774
|
+
recommendedActions?: string[];
|
|
775
|
+
/**
|
|
776
|
+
* @public
|
|
777
|
+
* Configuration for prompt override.
|
|
778
|
+
*/
|
|
779
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* @public
|
|
783
|
+
* Details about the routing configuration for an Agent alias.
|
|
784
|
+
*/
|
|
785
|
+
export interface AgentAliasRoutingConfigurationListItem {
|
|
786
|
+
/**
|
|
787
|
+
* @public
|
|
788
|
+
* Agent Version.
|
|
789
|
+
*/
|
|
790
|
+
agentVersion: string | undefined;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* @public
|
|
794
|
+
* History event for an alias for an Agent.
|
|
795
|
+
*/
|
|
796
|
+
export interface AgentAliasHistoryEvent {
|
|
797
|
+
/**
|
|
798
|
+
* @public
|
|
799
|
+
* Routing configuration for an Agent alias.
|
|
800
|
+
*/
|
|
801
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
802
|
+
/**
|
|
803
|
+
* @public
|
|
804
|
+
* Time Stamp.
|
|
805
|
+
*/
|
|
806
|
+
endDate?: Date;
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
* Time Stamp.
|
|
810
|
+
*/
|
|
811
|
+
startDate?: Date;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* @public
|
|
815
|
+
* @enum
|
|
816
|
+
*/
|
|
817
|
+
export declare const AgentAliasStatus: {
|
|
818
|
+
readonly CREATING: "CREATING";
|
|
819
|
+
readonly DELETING: "DELETING";
|
|
820
|
+
readonly FAILED: "FAILED";
|
|
821
|
+
readonly PREPARED: "PREPARED";
|
|
822
|
+
readonly UPDATING: "UPDATING";
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
export type AgentAliasStatus = (typeof AgentAliasStatus)[keyof typeof AgentAliasStatus];
|
|
828
|
+
/**
|
|
829
|
+
* @public
|
|
830
|
+
* Contains the information of an agent alias
|
|
831
|
+
*/
|
|
832
|
+
export interface AgentAlias {
|
|
833
|
+
/**
|
|
834
|
+
* @public
|
|
835
|
+
* Identifier for a resource.
|
|
836
|
+
*/
|
|
837
|
+
agentId: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* @public
|
|
840
|
+
* Id for an Agent Alias generated at the server side.
|
|
841
|
+
*/
|
|
842
|
+
agentAliasId: string | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* @public
|
|
845
|
+
* Name for a resource.
|
|
846
|
+
*/
|
|
847
|
+
agentAliasName: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* @public
|
|
850
|
+
* Arn representation of the Agent Alias.
|
|
851
|
+
*/
|
|
852
|
+
agentAliasArn: string | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* @public
|
|
855
|
+
* Client specified token used for idempotency checks
|
|
856
|
+
*/
|
|
857
|
+
clientToken?: string;
|
|
858
|
+
/**
|
|
859
|
+
* @public
|
|
860
|
+
* Description of the Resource.
|
|
861
|
+
*/
|
|
862
|
+
description?: string;
|
|
863
|
+
/**
|
|
864
|
+
* @public
|
|
865
|
+
* Routing configuration for an Agent alias.
|
|
866
|
+
*/
|
|
867
|
+
routingConfiguration: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* @public
|
|
870
|
+
* Time Stamp.
|
|
871
|
+
*/
|
|
872
|
+
createdAt: Date | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* @public
|
|
875
|
+
* Time Stamp.
|
|
876
|
+
*/
|
|
877
|
+
updatedAt: Date | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
* The list of history events for an alias for an Agent.
|
|
881
|
+
*/
|
|
882
|
+
agentAliasHistoryEvents?: AgentAliasHistoryEvent[];
|
|
883
|
+
/**
|
|
884
|
+
* @public
|
|
885
|
+
* The statuses an Agent Alias can be in.
|
|
886
|
+
*/
|
|
887
|
+
agentAliasStatus: AgentAliasStatus | undefined;
|
|
888
|
+
}
|
|
889
|
+
/**
|
|
890
|
+
* @public
|
|
891
|
+
* Summary of an alias for an Agent.
|
|
892
|
+
*/
|
|
893
|
+
export interface AgentAliasSummary {
|
|
894
|
+
/**
|
|
895
|
+
* @public
|
|
896
|
+
* Id for an Agent Alias generated at the server side.
|
|
897
|
+
*/
|
|
898
|
+
agentAliasId: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* @public
|
|
901
|
+
* Name for a resource.
|
|
902
|
+
*/
|
|
903
|
+
agentAliasName: string | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* @public
|
|
906
|
+
* Description of the Resource.
|
|
907
|
+
*/
|
|
908
|
+
description?: string;
|
|
909
|
+
/**
|
|
910
|
+
* @public
|
|
911
|
+
* Routing configuration for an Agent alias.
|
|
912
|
+
*/
|
|
913
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
914
|
+
/**
|
|
915
|
+
* @public
|
|
916
|
+
* The statuses an Agent Alias can be in.
|
|
917
|
+
*/
|
|
918
|
+
agentAliasStatus: AgentAliasStatus | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* @public
|
|
921
|
+
* Time Stamp.
|
|
922
|
+
*/
|
|
923
|
+
createdAt: Date | undefined;
|
|
924
|
+
/**
|
|
925
|
+
* @public
|
|
926
|
+
* Time Stamp.
|
|
927
|
+
*/
|
|
928
|
+
updatedAt: Date | undefined;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
* @enum
|
|
933
|
+
*/
|
|
934
|
+
export declare const KnowledgeBaseState: {
|
|
935
|
+
readonly DISABLED: "DISABLED";
|
|
936
|
+
readonly ENABLED: "ENABLED";
|
|
937
|
+
};
|
|
938
|
+
/**
|
|
939
|
+
* @public
|
|
940
|
+
*/
|
|
941
|
+
export type KnowledgeBaseState = (typeof KnowledgeBaseState)[keyof typeof KnowledgeBaseState];
|
|
942
|
+
/**
|
|
943
|
+
* @public
|
|
944
|
+
* Contains the information of an Agent Knowledge Base.
|
|
945
|
+
*/
|
|
946
|
+
export interface AgentKnowledgeBase {
|
|
947
|
+
/**
|
|
948
|
+
* @public
|
|
949
|
+
* Identifier for a resource.
|
|
950
|
+
*/
|
|
951
|
+
agentId: string | undefined;
|
|
952
|
+
/**
|
|
953
|
+
* @public
|
|
954
|
+
* Agent Version.
|
|
955
|
+
*/
|
|
956
|
+
agentVersion: string | undefined;
|
|
957
|
+
/**
|
|
958
|
+
* @public
|
|
959
|
+
* Identifier for a resource.
|
|
960
|
+
*/
|
|
961
|
+
knowledgeBaseId: string | undefined;
|
|
962
|
+
/**
|
|
963
|
+
* @public
|
|
964
|
+
* Description of the Resource.
|
|
965
|
+
*/
|
|
966
|
+
description: string | undefined;
|
|
967
|
+
/**
|
|
968
|
+
* @public
|
|
969
|
+
* Time Stamp.
|
|
970
|
+
*/
|
|
971
|
+
createdAt: Date | undefined;
|
|
972
|
+
/**
|
|
973
|
+
* @public
|
|
974
|
+
* Time Stamp.
|
|
975
|
+
*/
|
|
976
|
+
updatedAt: Date | undefined;
|
|
977
|
+
/**
|
|
978
|
+
* @public
|
|
979
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
980
|
+
*/
|
|
981
|
+
knowledgeBaseState: KnowledgeBaseState | undefined;
|
|
982
|
+
}
|
|
983
|
+
/**
|
|
984
|
+
* @public
|
|
985
|
+
* Agent Knowledge Base Summary
|
|
986
|
+
*/
|
|
987
|
+
export interface AgentKnowledgeBaseSummary {
|
|
988
|
+
/**
|
|
989
|
+
* @public
|
|
990
|
+
* Identifier for a resource.
|
|
991
|
+
*/
|
|
992
|
+
knowledgeBaseId: string | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* @public
|
|
995
|
+
* Description of the Resource.
|
|
996
|
+
*/
|
|
997
|
+
description?: string;
|
|
998
|
+
/**
|
|
999
|
+
* @public
|
|
1000
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
1001
|
+
*/
|
|
1002
|
+
knowledgeBaseState: KnowledgeBaseState | undefined;
|
|
1003
|
+
/**
|
|
1004
|
+
* @public
|
|
1005
|
+
* Time Stamp.
|
|
1006
|
+
*/
|
|
1007
|
+
updatedAt: Date | undefined;
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* @public
|
|
1011
|
+
* Create Agent Request
|
|
1012
|
+
*/
|
|
1013
|
+
export interface CreateAgentRequest {
|
|
1014
|
+
/**
|
|
1015
|
+
* @public
|
|
1016
|
+
* Name for a resource.
|
|
1017
|
+
*/
|
|
1018
|
+
agentName: string | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* @public
|
|
1021
|
+
* Client specified token used for idempotency checks
|
|
1022
|
+
*/
|
|
1023
|
+
clientToken?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* @public
|
|
1026
|
+
* Instruction for the agent.
|
|
1027
|
+
*/
|
|
1028
|
+
instruction?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* @public
|
|
1031
|
+
* ARN or name of a Bedrock model.
|
|
1032
|
+
*/
|
|
1033
|
+
foundationModel?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* @public
|
|
1036
|
+
* Description of the Resource.
|
|
1037
|
+
*/
|
|
1038
|
+
description?: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* @public
|
|
1041
|
+
* Max Session Time.
|
|
1042
|
+
*/
|
|
1043
|
+
idleSessionTTLInSeconds?: number;
|
|
1044
|
+
/**
|
|
1045
|
+
* @public
|
|
1046
|
+
* ARN of a IAM role.
|
|
1047
|
+
*/
|
|
1048
|
+
agentResourceRoleArn: string | undefined;
|
|
1049
|
+
/**
|
|
1050
|
+
* @public
|
|
1051
|
+
* A KMS key ARN
|
|
1052
|
+
*/
|
|
1053
|
+
customerEncryptionKeyArn?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* @public
|
|
1056
|
+
* A map of tag keys and values
|
|
1057
|
+
*/
|
|
1058
|
+
tags?: Record<string, string>;
|
|
1059
|
+
/**
|
|
1060
|
+
* @public
|
|
1061
|
+
* Configuration for prompt override.
|
|
1062
|
+
*/
|
|
1063
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1064
|
+
}
|
|
1065
|
+
/**
|
|
1066
|
+
* @public
|
|
1067
|
+
* Create Agent Response
|
|
1068
|
+
*/
|
|
1069
|
+
export interface CreateAgentResponse {
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
* Contains the information of an agent
|
|
1073
|
+
*/
|
|
1074
|
+
agent: Agent | undefined;
|
|
1075
|
+
}
|
|
1076
|
+
/**
|
|
1077
|
+
* @public
|
|
1078
|
+
* Delete Agent Request
|
|
1079
|
+
*/
|
|
1080
|
+
export interface DeleteAgentRequest {
|
|
1081
|
+
/**
|
|
1082
|
+
* @public
|
|
1083
|
+
* Id generated at the server side when an Agent is created
|
|
1084
|
+
*/
|
|
1085
|
+
agentId: string | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* @public
|
|
1088
|
+
* Skips checking if resource is in use when set to true. Defaults to false
|
|
1089
|
+
*/
|
|
1090
|
+
skipResourceInUseCheck?: boolean;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* @public
|
|
1094
|
+
* Delete Agent Response
|
|
1095
|
+
*/
|
|
1096
|
+
export interface DeleteAgentResponse {
|
|
1097
|
+
/**
|
|
1098
|
+
* @public
|
|
1099
|
+
* Identifier for a resource.
|
|
1100
|
+
*/
|
|
1101
|
+
agentId: string | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* @public
|
|
1104
|
+
* Schema Type for Action APIs.
|
|
1105
|
+
*/
|
|
1106
|
+
agentStatus: AgentStatus | undefined;
|
|
1107
|
+
}
|
|
1108
|
+
/**
|
|
1109
|
+
* @public
|
|
1110
|
+
* Get Agent Request
|
|
1111
|
+
*/
|
|
1112
|
+
export interface GetAgentRequest {
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
* Id generated at the server side when an Agent is created
|
|
1116
|
+
*/
|
|
1117
|
+
agentId: string | undefined;
|
|
1118
|
+
}
|
|
1119
|
+
/**
|
|
1120
|
+
* @public
|
|
1121
|
+
* Get Agent Response
|
|
1122
|
+
*/
|
|
1123
|
+
export interface GetAgentResponse {
|
|
1124
|
+
/**
|
|
1125
|
+
* @public
|
|
1126
|
+
* Contains the information of an agent
|
|
1127
|
+
*/
|
|
1128
|
+
agent: Agent | undefined;
|
|
1129
|
+
}
|
|
1130
|
+
/**
|
|
1131
|
+
* @public
|
|
1132
|
+
* List Agent Request
|
|
1133
|
+
*/
|
|
1134
|
+
export interface ListAgentsRequest {
|
|
1135
|
+
/**
|
|
1136
|
+
* @public
|
|
1137
|
+
* Max Results.
|
|
1138
|
+
*/
|
|
1139
|
+
maxResults?: number;
|
|
1140
|
+
/**
|
|
1141
|
+
* @public
|
|
1142
|
+
* Opaque continuation token of previous paginated response.
|
|
1143
|
+
*/
|
|
1144
|
+
nextToken?: string;
|
|
1145
|
+
}
|
|
1146
|
+
/**
|
|
1147
|
+
* @public
|
|
1148
|
+
* Summary of Agent.
|
|
1149
|
+
*/
|
|
1150
|
+
export interface AgentSummary {
|
|
1151
|
+
/**
|
|
1152
|
+
* @public
|
|
1153
|
+
* Identifier for a resource.
|
|
1154
|
+
*/
|
|
1155
|
+
agentId: string | undefined;
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
* Name for a resource.
|
|
1159
|
+
*/
|
|
1160
|
+
agentName: string | undefined;
|
|
1161
|
+
/**
|
|
1162
|
+
* @public
|
|
1163
|
+
* Schema Type for Action APIs.
|
|
1164
|
+
*/
|
|
1165
|
+
agentStatus: AgentStatus | undefined;
|
|
1166
|
+
/**
|
|
1167
|
+
* @public
|
|
1168
|
+
* Description of the Resource.
|
|
1169
|
+
*/
|
|
1170
|
+
description?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* @public
|
|
1173
|
+
* Time Stamp.
|
|
1174
|
+
*/
|
|
1175
|
+
updatedAt: Date | undefined;
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
* Agent Version.
|
|
1179
|
+
*/
|
|
1180
|
+
latestAgentVersion?: string;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* @public
|
|
1184
|
+
* List Agent Response
|
|
1185
|
+
*/
|
|
1186
|
+
export interface ListAgentsResponse {
|
|
1187
|
+
/**
|
|
1188
|
+
* @public
|
|
1189
|
+
* List of AgentSummary.
|
|
1190
|
+
*/
|
|
1191
|
+
agentSummaries: AgentSummary[] | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* @public
|
|
1194
|
+
* Opaque continuation token of previous paginated response.
|
|
1195
|
+
*/
|
|
1196
|
+
nextToken?: string;
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* @public
|
|
1200
|
+
* PrepareAgent Request
|
|
1201
|
+
*/
|
|
1202
|
+
export interface PrepareAgentRequest {
|
|
1203
|
+
/**
|
|
1204
|
+
* @public
|
|
1205
|
+
* Id generated at the server side when an Agent is created
|
|
1206
|
+
*/
|
|
1207
|
+
agentId: string | undefined;
|
|
1208
|
+
}
|
|
1209
|
+
/**
|
|
1210
|
+
* @public
|
|
1211
|
+
* PrepareAgent Response
|
|
1212
|
+
*/
|
|
1213
|
+
export interface PrepareAgentResponse {
|
|
1214
|
+
/**
|
|
1215
|
+
* @public
|
|
1216
|
+
* Identifier for a resource.
|
|
1217
|
+
*/
|
|
1218
|
+
agentId: string | undefined;
|
|
1219
|
+
/**
|
|
1220
|
+
* @public
|
|
1221
|
+
* Schema Type for Action APIs.
|
|
1222
|
+
*/
|
|
1223
|
+
agentStatus: AgentStatus | undefined;
|
|
1224
|
+
/**
|
|
1225
|
+
* @public
|
|
1226
|
+
* Agent Version.
|
|
1227
|
+
*/
|
|
1228
|
+
agentVersion: string | undefined;
|
|
1229
|
+
/**
|
|
1230
|
+
* @public
|
|
1231
|
+
* Time Stamp.
|
|
1232
|
+
*/
|
|
1233
|
+
preparedAt: Date | undefined;
|
|
1234
|
+
}
|
|
1235
|
+
/**
|
|
1236
|
+
* @public
|
|
1237
|
+
* Update Agent Request
|
|
1238
|
+
*/
|
|
1239
|
+
export interface UpdateAgentRequest {
|
|
1240
|
+
/**
|
|
1241
|
+
* @public
|
|
1242
|
+
* Id generated at the server side when an Agent is created
|
|
1243
|
+
*/
|
|
1244
|
+
agentId: string | undefined;
|
|
1245
|
+
/**
|
|
1246
|
+
* @public
|
|
1247
|
+
* Name for a resource.
|
|
1248
|
+
*/
|
|
1249
|
+
agentName: string | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* @public
|
|
1252
|
+
* Instruction for the agent.
|
|
1253
|
+
*/
|
|
1254
|
+
instruction?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
* ARN or name of a Bedrock model.
|
|
1258
|
+
*/
|
|
1259
|
+
foundationModel?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* @public
|
|
1262
|
+
* Description of the Resource.
|
|
1263
|
+
*/
|
|
1264
|
+
description?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* @public
|
|
1267
|
+
* Max Session Time.
|
|
1268
|
+
*/
|
|
1269
|
+
idleSessionTTLInSeconds?: number;
|
|
1270
|
+
/**
|
|
1271
|
+
* @public
|
|
1272
|
+
* ARN of a IAM role.
|
|
1273
|
+
*/
|
|
1274
|
+
agentResourceRoleArn: string | undefined;
|
|
1275
|
+
/**
|
|
1276
|
+
* @public
|
|
1277
|
+
* A KMS key ARN
|
|
1278
|
+
*/
|
|
1279
|
+
customerEncryptionKeyArn?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* @public
|
|
1282
|
+
* Configuration for prompt override.
|
|
1283
|
+
*/
|
|
1284
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1285
|
+
}
|
|
1286
|
+
/**
|
|
1287
|
+
* @public
|
|
1288
|
+
* Update Agent Response
|
|
1289
|
+
*/
|
|
1290
|
+
export interface UpdateAgentResponse {
|
|
1291
|
+
/**
|
|
1292
|
+
* @public
|
|
1293
|
+
* Contains the information of an agent
|
|
1294
|
+
*/
|
|
1295
|
+
agent: Agent | undefined;
|
|
1296
|
+
}
|
|
1297
|
+
/**
|
|
1298
|
+
* @public
|
|
1299
|
+
* Contains the information of an agent version.
|
|
1300
|
+
*/
|
|
1301
|
+
export interface AgentVersion {
|
|
1302
|
+
/**
|
|
1303
|
+
* @public
|
|
1304
|
+
* Identifier for a resource.
|
|
1305
|
+
*/
|
|
1306
|
+
agentId: string | undefined;
|
|
1307
|
+
/**
|
|
1308
|
+
* @public
|
|
1309
|
+
* Name for a resource.
|
|
1310
|
+
*/
|
|
1311
|
+
agentName: string | undefined;
|
|
1312
|
+
/**
|
|
1313
|
+
* @public
|
|
1314
|
+
* Arn representation of the Agent.
|
|
1315
|
+
*/
|
|
1316
|
+
agentArn: string | undefined;
|
|
1317
|
+
/**
|
|
1318
|
+
* @public
|
|
1319
|
+
* Numerical Agent Version.
|
|
1320
|
+
*/
|
|
1321
|
+
version: string | undefined;
|
|
1322
|
+
/**
|
|
1323
|
+
* @public
|
|
1324
|
+
* Instruction for the agent.
|
|
1325
|
+
*/
|
|
1326
|
+
instruction?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* @public
|
|
1329
|
+
* Schema Type for Action APIs.
|
|
1330
|
+
*/
|
|
1331
|
+
agentStatus: AgentStatus | undefined;
|
|
1332
|
+
/**
|
|
1333
|
+
* @public
|
|
1334
|
+
* ARN or name of a Bedrock model.
|
|
1335
|
+
*/
|
|
1336
|
+
foundationModel?: string;
|
|
1337
|
+
/**
|
|
1338
|
+
* @public
|
|
1339
|
+
* Description of the Resource.
|
|
1340
|
+
*/
|
|
1341
|
+
description?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* @public
|
|
1344
|
+
* Max Session Time.
|
|
1345
|
+
*/
|
|
1346
|
+
idleSessionTTLInSeconds: number | undefined;
|
|
1347
|
+
/**
|
|
1348
|
+
* @public
|
|
1349
|
+
* ARN of a IAM role.
|
|
1350
|
+
*/
|
|
1351
|
+
agentResourceRoleArn: string | undefined;
|
|
1352
|
+
/**
|
|
1353
|
+
* @public
|
|
1354
|
+
* A KMS key ARN
|
|
1355
|
+
*/
|
|
1356
|
+
customerEncryptionKeyArn?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* @public
|
|
1359
|
+
* Time Stamp.
|
|
1360
|
+
*/
|
|
1361
|
+
createdAt: Date | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* @public
|
|
1364
|
+
* Time Stamp.
|
|
1365
|
+
*/
|
|
1366
|
+
updatedAt: Date | undefined;
|
|
1367
|
+
/**
|
|
1368
|
+
* @public
|
|
1369
|
+
* Failure Reasons for Error.
|
|
1370
|
+
*/
|
|
1371
|
+
failureReasons?: string[];
|
|
1372
|
+
/**
|
|
1373
|
+
* @public
|
|
1374
|
+
* The recommended actions users can take to resolve an error in failureReasons.
|
|
1375
|
+
*/
|
|
1376
|
+
recommendedActions?: string[];
|
|
1377
|
+
/**
|
|
1378
|
+
* @public
|
|
1379
|
+
* Configuration for prompt override.
|
|
1380
|
+
*/
|
|
1381
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1382
|
+
}
|
|
1383
|
+
/**
|
|
1384
|
+
* @public
|
|
1385
|
+
* Summary of agent version.
|
|
1386
|
+
*/
|
|
1387
|
+
export interface AgentVersionSummary {
|
|
1388
|
+
/**
|
|
1389
|
+
* @public
|
|
1390
|
+
* Name for a resource.
|
|
1391
|
+
*/
|
|
1392
|
+
agentName: string | undefined;
|
|
1393
|
+
/**
|
|
1394
|
+
* @public
|
|
1395
|
+
* Schema Type for Action APIs.
|
|
1396
|
+
*/
|
|
1397
|
+
agentStatus: AgentStatus | undefined;
|
|
1398
|
+
/**
|
|
1399
|
+
* @public
|
|
1400
|
+
* Agent Version.
|
|
1401
|
+
*/
|
|
1402
|
+
agentVersion: string | undefined;
|
|
1403
|
+
/**
|
|
1404
|
+
* @public
|
|
1405
|
+
* Time Stamp.
|
|
1406
|
+
*/
|
|
1407
|
+
createdAt: Date | undefined;
|
|
1408
|
+
/**
|
|
1409
|
+
* @public
|
|
1410
|
+
* Time Stamp.
|
|
1411
|
+
*/
|
|
1412
|
+
updatedAt: Date | undefined;
|
|
1413
|
+
/**
|
|
1414
|
+
* @public
|
|
1415
|
+
* Description of the Resource.
|
|
1416
|
+
*/
|
|
1417
|
+
description?: string;
|
|
1418
|
+
}
|
|
1419
|
+
/**
|
|
1420
|
+
* @public
|
|
1421
|
+
* Create Agent Alias Request
|
|
1422
|
+
*/
|
|
1423
|
+
export interface CreateAgentAliasRequest {
|
|
1424
|
+
/**
|
|
1425
|
+
* @public
|
|
1426
|
+
* Id generated at the server side when an Agent is created
|
|
1427
|
+
*/
|
|
1428
|
+
agentId: string | undefined;
|
|
1429
|
+
/**
|
|
1430
|
+
* @public
|
|
1431
|
+
* Name for a resource.
|
|
1432
|
+
*/
|
|
1433
|
+
agentAliasName: string | undefined;
|
|
1434
|
+
/**
|
|
1435
|
+
* @public
|
|
1436
|
+
* Client specified token used for idempotency checks
|
|
1437
|
+
*/
|
|
1438
|
+
clientToken?: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* @public
|
|
1441
|
+
* Description of the Resource.
|
|
1442
|
+
*/
|
|
1443
|
+
description?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* @public
|
|
1446
|
+
* Routing configuration for an Agent alias.
|
|
1447
|
+
*/
|
|
1448
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
1449
|
+
/**
|
|
1450
|
+
* @public
|
|
1451
|
+
* A map of tag keys and values
|
|
1452
|
+
*/
|
|
1453
|
+
tags?: Record<string, string>;
|
|
1454
|
+
}
|
|
1455
|
+
/**
|
|
1456
|
+
* @public
|
|
1457
|
+
* Create Agent Alias Response
|
|
1458
|
+
*/
|
|
1459
|
+
export interface CreateAgentAliasResponse {
|
|
1460
|
+
/**
|
|
1461
|
+
* @public
|
|
1462
|
+
* Contains the information of an agent alias
|
|
1463
|
+
*/
|
|
1464
|
+
agentAlias: AgentAlias | undefined;
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* @public
|
|
1468
|
+
* Delete Agent Alias Request
|
|
1469
|
+
*/
|
|
1470
|
+
export interface DeleteAgentAliasRequest {
|
|
1471
|
+
/**
|
|
1472
|
+
* @public
|
|
1473
|
+
* Id generated at the server side when an Agent is created
|
|
1474
|
+
*/
|
|
1475
|
+
agentId: string | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* @public
|
|
1478
|
+
* Id generated at the server side when an Agent Alias is created
|
|
1479
|
+
*/
|
|
1480
|
+
agentAliasId: string | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
* Delete Agent Alias Response
|
|
1485
|
+
*/
|
|
1486
|
+
export interface DeleteAgentAliasResponse {
|
|
1487
|
+
/**
|
|
1488
|
+
* @public
|
|
1489
|
+
* Identifier for a resource.
|
|
1490
|
+
*/
|
|
1491
|
+
agentId: string | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* @public
|
|
1494
|
+
* Id for an Agent Alias generated at the server side.
|
|
1495
|
+
*/
|
|
1496
|
+
agentAliasId: string | undefined;
|
|
1497
|
+
/**
|
|
1498
|
+
* @public
|
|
1499
|
+
* The statuses an Agent Alias can be in.
|
|
1500
|
+
*/
|
|
1501
|
+
agentAliasStatus: AgentAliasStatus | undefined;
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* @public
|
|
1505
|
+
* Get Agent Alias Request
|
|
1506
|
+
*/
|
|
1507
|
+
export interface GetAgentAliasRequest {
|
|
1508
|
+
/**
|
|
1509
|
+
* @public
|
|
1510
|
+
* Id generated at the server side when an Agent is created
|
|
1511
|
+
*/
|
|
1512
|
+
agentId: string | undefined;
|
|
1513
|
+
/**
|
|
1514
|
+
* @public
|
|
1515
|
+
* Id generated at the server side when an Agent Alias is created
|
|
1516
|
+
*/
|
|
1517
|
+
agentAliasId: string | undefined;
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* @public
|
|
1521
|
+
* Get Agent Alias Response
|
|
1522
|
+
*/
|
|
1523
|
+
export interface GetAgentAliasResponse {
|
|
1524
|
+
/**
|
|
1525
|
+
* @public
|
|
1526
|
+
* Contains the information of an agent alias
|
|
1527
|
+
*/
|
|
1528
|
+
agentAlias: AgentAlias | undefined;
|
|
1529
|
+
}
|
|
1530
|
+
/**
|
|
1531
|
+
* @public
|
|
1532
|
+
* List Agent Aliases Request
|
|
1533
|
+
*/
|
|
1534
|
+
export interface ListAgentAliasesRequest {
|
|
1535
|
+
/**
|
|
1536
|
+
* @public
|
|
1537
|
+
* Id generated at the server side when an Agent is created
|
|
1538
|
+
*/
|
|
1539
|
+
agentId: string | undefined;
|
|
1540
|
+
/**
|
|
1541
|
+
* @public
|
|
1542
|
+
* Max Results.
|
|
1543
|
+
*/
|
|
1544
|
+
maxResults?: number;
|
|
1545
|
+
/**
|
|
1546
|
+
* @public
|
|
1547
|
+
* Opaque continuation token of previous paginated response.
|
|
1548
|
+
*/
|
|
1549
|
+
nextToken?: string;
|
|
1550
|
+
}
|
|
1551
|
+
/**
|
|
1552
|
+
* @public
|
|
1553
|
+
* List Agent Aliases Response
|
|
1554
|
+
*/
|
|
1555
|
+
export interface ListAgentAliasesResponse {
|
|
1556
|
+
/**
|
|
1557
|
+
* @public
|
|
1558
|
+
* The list of summaries of all the aliases for an Agent.
|
|
1559
|
+
*/
|
|
1560
|
+
agentAliasSummaries: AgentAliasSummary[] | undefined;
|
|
1561
|
+
/**
|
|
1562
|
+
* @public
|
|
1563
|
+
* Opaque continuation token of previous paginated response.
|
|
1564
|
+
*/
|
|
1565
|
+
nextToken?: string;
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* @public
|
|
1569
|
+
* Update Agent Alias Request
|
|
1570
|
+
*/
|
|
1571
|
+
export interface UpdateAgentAliasRequest {
|
|
1572
|
+
/**
|
|
1573
|
+
* @public
|
|
1574
|
+
* Id generated at the server side when an Agent is created
|
|
1575
|
+
*/
|
|
1576
|
+
agentId: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* @public
|
|
1579
|
+
* Id generated at the server side when an Agent Alias is created
|
|
1580
|
+
*/
|
|
1581
|
+
agentAliasId: string | undefined;
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
* Name for a resource.
|
|
1585
|
+
*/
|
|
1586
|
+
agentAliasName: string | undefined;
|
|
1587
|
+
/**
|
|
1588
|
+
* @public
|
|
1589
|
+
* Description of the Resource.
|
|
1590
|
+
*/
|
|
1591
|
+
description?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* @public
|
|
1594
|
+
* Routing configuration for an Agent alias.
|
|
1595
|
+
*/
|
|
1596
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* @public
|
|
1600
|
+
* Update Agent Alias Response
|
|
1601
|
+
*/
|
|
1602
|
+
export interface UpdateAgentAliasResponse {
|
|
1603
|
+
/**
|
|
1604
|
+
* @public
|
|
1605
|
+
* Contains the information of an agent alias
|
|
1606
|
+
*/
|
|
1607
|
+
agentAlias: AgentAlias | undefined;
|
|
1608
|
+
}
|
|
1609
|
+
/**
|
|
1610
|
+
* @public
|
|
1611
|
+
* Configures an S3 data source location.
|
|
1612
|
+
*/
|
|
1613
|
+
export interface S3DataSourceConfiguration {
|
|
1614
|
+
/**
|
|
1615
|
+
* @public
|
|
1616
|
+
* A S3 bucket ARN
|
|
1617
|
+
*/
|
|
1618
|
+
bucketArn: string | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* @public
|
|
1621
|
+
* A list of S3 prefixes.
|
|
1622
|
+
*/
|
|
1623
|
+
inclusionPrefixes?: string[];
|
|
1624
|
+
}
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
* @enum
|
|
1628
|
+
*/
|
|
1629
|
+
export declare const DataSourceType: {
|
|
1630
|
+
readonly S3: "S3";
|
|
1631
|
+
};
|
|
1632
|
+
/**
|
|
1633
|
+
* @public
|
|
1634
|
+
*/
|
|
1635
|
+
export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType];
|
|
1636
|
+
/**
|
|
1637
|
+
* @public
|
|
1638
|
+
* Specifies a raw data source location to ingest.
|
|
1639
|
+
*/
|
|
1640
|
+
export interface DataSourceConfiguration {
|
|
1641
|
+
/**
|
|
1642
|
+
* @public
|
|
1643
|
+
* The type of the data source location.
|
|
1644
|
+
*/
|
|
1645
|
+
type: DataSourceType | undefined;
|
|
1646
|
+
/**
|
|
1647
|
+
* @public
|
|
1648
|
+
* Configures an S3 data source location.
|
|
1649
|
+
*/
|
|
1650
|
+
s3Configuration?: S3DataSourceConfiguration;
|
|
1651
|
+
}
|
|
1652
|
+
/**
|
|
1653
|
+
* @public
|
|
1654
|
+
* Server-side encryption configuration.
|
|
1655
|
+
*/
|
|
1656
|
+
export interface ServerSideEncryptionConfiguration {
|
|
1657
|
+
/**
|
|
1658
|
+
* @public
|
|
1659
|
+
* A KMS key ARN
|
|
1660
|
+
*/
|
|
1661
|
+
kmsKeyArn?: string;
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1664
|
+
* @public
|
|
1665
|
+
* @enum
|
|
1666
|
+
*/
|
|
1667
|
+
export declare const ChunkingStrategy: {
|
|
1668
|
+
readonly FIXED_SIZE: "FIXED_SIZE";
|
|
1669
|
+
readonly NONE: "NONE";
|
|
1670
|
+
};
|
|
1671
|
+
/**
|
|
1672
|
+
* @public
|
|
1673
|
+
*/
|
|
1674
|
+
export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
* Configures fixed size chunking strategy
|
|
1678
|
+
*/
|
|
1679
|
+
export interface FixedSizeChunkingConfiguration {
|
|
1680
|
+
/**
|
|
1681
|
+
* @public
|
|
1682
|
+
* The maximum number of tokens per chunk.
|
|
1683
|
+
*/
|
|
1684
|
+
maxTokens: number | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* @public
|
|
1687
|
+
* The overlap percentage between adjacent chunks.
|
|
1688
|
+
*/
|
|
1689
|
+
overlapPercentage: number | undefined;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* @public
|
|
1693
|
+
* Configures chunking strategy
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ChunkingConfiguration {
|
|
1696
|
+
/**
|
|
1697
|
+
* @public
|
|
1698
|
+
* The type of chunking strategy
|
|
1699
|
+
*/
|
|
1700
|
+
chunkingStrategy: ChunkingStrategy | undefined;
|
|
1701
|
+
/**
|
|
1702
|
+
* @public
|
|
1703
|
+
* Configures fixed size chunking strategy
|
|
1704
|
+
*/
|
|
1705
|
+
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* @public
|
|
1709
|
+
* Configures ingestion for a vector knowledge base
|
|
1710
|
+
*/
|
|
1711
|
+
export interface VectorIngestionConfiguration {
|
|
1712
|
+
/**
|
|
1713
|
+
* @public
|
|
1714
|
+
* Configures chunking strategy
|
|
1715
|
+
*/
|
|
1716
|
+
chunkingConfiguration?: ChunkingConfiguration;
|
|
1717
|
+
}
|
|
1718
|
+
/**
|
|
1719
|
+
* @public
|
|
1720
|
+
*/
|
|
1721
|
+
export interface CreateDataSourceRequest {
|
|
1722
|
+
/**
|
|
1723
|
+
* @public
|
|
1724
|
+
* Identifier for a resource.
|
|
1725
|
+
*/
|
|
1726
|
+
knowledgeBaseId: string | undefined;
|
|
1727
|
+
/**
|
|
1728
|
+
* @public
|
|
1729
|
+
* Client specified token used for idempotency checks
|
|
1730
|
+
*/
|
|
1731
|
+
clientToken?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* @public
|
|
1734
|
+
* Name for a resource.
|
|
1735
|
+
*/
|
|
1736
|
+
name: string | undefined;
|
|
1737
|
+
/**
|
|
1738
|
+
* @public
|
|
1739
|
+
* Description of the Resource.
|
|
1740
|
+
*/
|
|
1741
|
+
description?: string;
|
|
1742
|
+
/**
|
|
1743
|
+
* @public
|
|
1744
|
+
* Specifies a raw data source location to ingest.
|
|
1745
|
+
*/
|
|
1746
|
+
dataSourceConfiguration: DataSourceConfiguration | undefined;
|
|
1747
|
+
/**
|
|
1748
|
+
* @public
|
|
1749
|
+
* Server-side encryption configuration.
|
|
1750
|
+
*/
|
|
1751
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1752
|
+
/**
|
|
1753
|
+
* @public
|
|
1754
|
+
* Configures ingestion for a vector knowledge base
|
|
1755
|
+
*/
|
|
1756
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
1757
|
+
}
|
|
1758
|
+
/**
|
|
1759
|
+
* @public
|
|
1760
|
+
* @enum
|
|
1761
|
+
*/
|
|
1762
|
+
export declare const DataSourceStatus: {
|
|
1763
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
1764
|
+
readonly DELETING: "DELETING";
|
|
1765
|
+
};
|
|
1766
|
+
/**
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
1770
|
+
/**
|
|
1771
|
+
* @public
|
|
1772
|
+
* Contains the information of a data source.
|
|
1773
|
+
*/
|
|
1774
|
+
export interface DataSource {
|
|
1775
|
+
/**
|
|
1776
|
+
* @public
|
|
1777
|
+
* Identifier for a resource.
|
|
1778
|
+
*/
|
|
1779
|
+
knowledgeBaseId: string | undefined;
|
|
1780
|
+
/**
|
|
1781
|
+
* @public
|
|
1782
|
+
* Identifier for a resource.
|
|
1783
|
+
*/
|
|
1784
|
+
dataSourceId: string | undefined;
|
|
1785
|
+
/**
|
|
1786
|
+
* @public
|
|
1787
|
+
* Name for a resource.
|
|
1788
|
+
*/
|
|
1789
|
+
name: string | undefined;
|
|
1790
|
+
/**
|
|
1791
|
+
* @public
|
|
1792
|
+
* The status of a data source.
|
|
1793
|
+
*/
|
|
1794
|
+
status: DataSourceStatus | undefined;
|
|
1795
|
+
/**
|
|
1796
|
+
* @public
|
|
1797
|
+
* Description of the Resource.
|
|
1798
|
+
*/
|
|
1799
|
+
description?: string;
|
|
1800
|
+
/**
|
|
1801
|
+
* @public
|
|
1802
|
+
* Specifies a raw data source location to ingest.
|
|
1803
|
+
*/
|
|
1804
|
+
dataSourceConfiguration: DataSourceConfiguration | undefined;
|
|
1805
|
+
/**
|
|
1806
|
+
* @public
|
|
1807
|
+
* Server-side encryption configuration.
|
|
1808
|
+
*/
|
|
1809
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1810
|
+
/**
|
|
1811
|
+
* @public
|
|
1812
|
+
* Configures ingestion for a vector knowledge base
|
|
1813
|
+
*/
|
|
1814
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
1815
|
+
/**
|
|
1816
|
+
* @public
|
|
1817
|
+
* Time Stamp.
|
|
1818
|
+
*/
|
|
1819
|
+
createdAt: Date | undefined;
|
|
1820
|
+
/**
|
|
1821
|
+
* @public
|
|
1822
|
+
* Time Stamp.
|
|
1823
|
+
*/
|
|
1824
|
+
updatedAt: Date | undefined;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1829
|
+
export interface CreateDataSourceResponse {
|
|
1830
|
+
/**
|
|
1831
|
+
* @public
|
|
1832
|
+
* Contains the information of a data source.
|
|
1833
|
+
*/
|
|
1834
|
+
dataSource: DataSource | undefined;
|
|
1835
|
+
}
|
|
1836
|
+
/**
|
|
1837
|
+
* @public
|
|
1838
|
+
*/
|
|
1839
|
+
export interface DeleteDataSourceRequest {
|
|
1840
|
+
/**
|
|
1841
|
+
* @public
|
|
1842
|
+
* Identifier for a resource.
|
|
1843
|
+
*/
|
|
1844
|
+
knowledgeBaseId: string | undefined;
|
|
1845
|
+
/**
|
|
1846
|
+
* @public
|
|
1847
|
+
* Identifier for a resource.
|
|
1848
|
+
*/
|
|
1849
|
+
dataSourceId: string | undefined;
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* @public
|
|
1853
|
+
*/
|
|
1854
|
+
export interface DeleteDataSourceResponse {
|
|
1855
|
+
/**
|
|
1856
|
+
* @public
|
|
1857
|
+
* Identifier for a resource.
|
|
1858
|
+
*/
|
|
1859
|
+
knowledgeBaseId: string | undefined;
|
|
1860
|
+
/**
|
|
1861
|
+
* @public
|
|
1862
|
+
* Identifier for a resource.
|
|
1863
|
+
*/
|
|
1864
|
+
dataSourceId: string | undefined;
|
|
1865
|
+
/**
|
|
1866
|
+
* @public
|
|
1867
|
+
* The status of a data source.
|
|
1868
|
+
*/
|
|
1869
|
+
status: DataSourceStatus | undefined;
|
|
1870
|
+
}
|
|
1871
|
+
/**
|
|
1872
|
+
* @public
|
|
1873
|
+
*/
|
|
1874
|
+
export interface GetDataSourceRequest {
|
|
1875
|
+
/**
|
|
1876
|
+
* @public
|
|
1877
|
+
* Identifier for a resource.
|
|
1878
|
+
*/
|
|
1879
|
+
knowledgeBaseId: string | undefined;
|
|
1880
|
+
/**
|
|
1881
|
+
* @public
|
|
1882
|
+
* Identifier for a resource.
|
|
1883
|
+
*/
|
|
1884
|
+
dataSourceId: string | undefined;
|
|
1885
|
+
}
|
|
1886
|
+
/**
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
export interface GetDataSourceResponse {
|
|
1890
|
+
/**
|
|
1891
|
+
* @public
|
|
1892
|
+
* Contains the information of a data source.
|
|
1893
|
+
*/
|
|
1894
|
+
dataSource: DataSource | undefined;
|
|
1895
|
+
}
|
|
1896
|
+
/**
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
export interface ListDataSourcesRequest {
|
|
1900
|
+
/**
|
|
1901
|
+
* @public
|
|
1902
|
+
* Identifier for a resource.
|
|
1903
|
+
*/
|
|
1904
|
+
knowledgeBaseId: string | undefined;
|
|
1905
|
+
/**
|
|
1906
|
+
* @public
|
|
1907
|
+
* Max Results.
|
|
1908
|
+
*/
|
|
1909
|
+
maxResults?: number;
|
|
1910
|
+
/**
|
|
1911
|
+
* @public
|
|
1912
|
+
* Opaque continuation token of previous paginated response.
|
|
1913
|
+
*/
|
|
1914
|
+
nextToken?: string;
|
|
1915
|
+
}
|
|
1916
|
+
/**
|
|
1917
|
+
* @public
|
|
1918
|
+
* Summary information of a data source.
|
|
1919
|
+
*/
|
|
1920
|
+
export interface DataSourceSummary {
|
|
1921
|
+
/**
|
|
1922
|
+
* @public
|
|
1923
|
+
* Identifier for a resource.
|
|
1924
|
+
*/
|
|
1925
|
+
knowledgeBaseId: string | undefined;
|
|
1926
|
+
/**
|
|
1927
|
+
* @public
|
|
1928
|
+
* Identifier for a resource.
|
|
1929
|
+
*/
|
|
1930
|
+
dataSourceId: string | undefined;
|
|
1931
|
+
/**
|
|
1932
|
+
* @public
|
|
1933
|
+
* Name for a resource.
|
|
1934
|
+
*/
|
|
1935
|
+
name: string | undefined;
|
|
1936
|
+
/**
|
|
1937
|
+
* @public
|
|
1938
|
+
* The status of a data source.
|
|
1939
|
+
*/
|
|
1940
|
+
status: DataSourceStatus | undefined;
|
|
1941
|
+
/**
|
|
1942
|
+
* @public
|
|
1943
|
+
* Description of the Resource.
|
|
1944
|
+
*/
|
|
1945
|
+
description?: string;
|
|
1946
|
+
/**
|
|
1947
|
+
* @public
|
|
1948
|
+
* Time Stamp.
|
|
1949
|
+
*/
|
|
1950
|
+
updatedAt: Date | undefined;
|
|
1951
|
+
}
|
|
1952
|
+
/**
|
|
1953
|
+
* @public
|
|
1954
|
+
*/
|
|
1955
|
+
export interface ListDataSourcesResponse {
|
|
1956
|
+
/**
|
|
1957
|
+
* @public
|
|
1958
|
+
* list of data source summaries
|
|
1959
|
+
*/
|
|
1960
|
+
dataSourceSummaries: DataSourceSummary[] | undefined;
|
|
1961
|
+
/**
|
|
1962
|
+
* @public
|
|
1963
|
+
* Opaque continuation token of previous paginated response.
|
|
1964
|
+
*/
|
|
1965
|
+
nextToken?: string;
|
|
1966
|
+
}
|
|
1967
|
+
/**
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
export interface UpdateDataSourceRequest {
|
|
1971
|
+
/**
|
|
1972
|
+
* @public
|
|
1973
|
+
* Identifier for a resource.
|
|
1974
|
+
*/
|
|
1975
|
+
knowledgeBaseId: string | undefined;
|
|
1976
|
+
/**
|
|
1977
|
+
* @public
|
|
1978
|
+
* Identifier for a resource.
|
|
1979
|
+
*/
|
|
1980
|
+
dataSourceId: string | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* @public
|
|
1983
|
+
* Name for a resource.
|
|
1984
|
+
*/
|
|
1985
|
+
name: string | undefined;
|
|
1986
|
+
/**
|
|
1987
|
+
* @public
|
|
1988
|
+
* Description of the Resource.
|
|
1989
|
+
*/
|
|
1990
|
+
description?: string;
|
|
1991
|
+
/**
|
|
1992
|
+
* @public
|
|
1993
|
+
* Specifies a raw data source location to ingest.
|
|
1994
|
+
*/
|
|
1995
|
+
dataSourceConfiguration: DataSourceConfiguration | undefined;
|
|
1996
|
+
/**
|
|
1997
|
+
* @public
|
|
1998
|
+
* Server-side encryption configuration.
|
|
1999
|
+
*/
|
|
2000
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2001
|
+
/**
|
|
2002
|
+
* @public
|
|
2003
|
+
* Configures ingestion for a vector knowledge base
|
|
2004
|
+
*/
|
|
2005
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
2006
|
+
}
|
|
2007
|
+
/**
|
|
2008
|
+
* @public
|
|
2009
|
+
*/
|
|
2010
|
+
export interface UpdateDataSourceResponse {
|
|
2011
|
+
/**
|
|
2012
|
+
* @public
|
|
2013
|
+
* Contains the information of a data source.
|
|
2014
|
+
*/
|
|
2015
|
+
dataSource: DataSource | undefined;
|
|
2016
|
+
}
|
|
2017
|
+
/**
|
|
2018
|
+
* @public
|
|
2019
|
+
*/
|
|
2020
|
+
export interface GetIngestionJobRequest {
|
|
2021
|
+
/**
|
|
2022
|
+
* @public
|
|
2023
|
+
* Identifier for a resource.
|
|
2024
|
+
*/
|
|
2025
|
+
knowledgeBaseId: string | undefined;
|
|
2026
|
+
/**
|
|
2027
|
+
* @public
|
|
2028
|
+
* Identifier for a resource.
|
|
2029
|
+
*/
|
|
2030
|
+
dataSourceId: string | undefined;
|
|
2031
|
+
/**
|
|
2032
|
+
* @public
|
|
2033
|
+
* Identifier for a resource.
|
|
2034
|
+
*/
|
|
2035
|
+
ingestionJobId: string | undefined;
|
|
2036
|
+
}
|
|
2037
|
+
/**
|
|
2038
|
+
* @public
|
|
2039
|
+
* The document level statistics of an ingestion job
|
|
2040
|
+
*/
|
|
2041
|
+
export interface IngestionJobStatistics {
|
|
2042
|
+
/**
|
|
2043
|
+
* @public
|
|
2044
|
+
* Number of scanned documents
|
|
2045
|
+
*/
|
|
2046
|
+
numberOfDocumentsScanned?: number;
|
|
2047
|
+
/**
|
|
2048
|
+
* @public
|
|
2049
|
+
* Number of indexed documents
|
|
2050
|
+
*/
|
|
2051
|
+
numberOfNewDocumentsIndexed?: number;
|
|
2052
|
+
/**
|
|
2053
|
+
* @public
|
|
2054
|
+
* Number of modified documents indexed
|
|
2055
|
+
*/
|
|
2056
|
+
numberOfModifiedDocumentsIndexed?: number;
|
|
2057
|
+
/**
|
|
2058
|
+
* @public
|
|
2059
|
+
* Number of deleted documents
|
|
2060
|
+
*/
|
|
2061
|
+
numberOfDocumentsDeleted?: number;
|
|
2062
|
+
/**
|
|
2063
|
+
* @public
|
|
2064
|
+
* Number of failed documents
|
|
2065
|
+
*/
|
|
2066
|
+
numberOfDocumentsFailed?: number;
|
|
2067
|
+
}
|
|
2068
|
+
/**
|
|
2069
|
+
* @public
|
|
2070
|
+
* @enum
|
|
2071
|
+
*/
|
|
2072
|
+
export declare const IngestionJobStatus: {
|
|
2073
|
+
readonly COMPLETE: "COMPLETE";
|
|
2074
|
+
readonly FAILED: "FAILED";
|
|
2075
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
2076
|
+
readonly STARTING: "STARTING";
|
|
2077
|
+
};
|
|
2078
|
+
/**
|
|
2079
|
+
* @public
|
|
2080
|
+
*/
|
|
2081
|
+
export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus];
|
|
2082
|
+
/**
|
|
2083
|
+
* @public
|
|
2084
|
+
* Contains the information of an ingestion job.
|
|
2085
|
+
*/
|
|
2086
|
+
export interface IngestionJob {
|
|
2087
|
+
/**
|
|
2088
|
+
* @public
|
|
2089
|
+
* Identifier for a resource.
|
|
2090
|
+
*/
|
|
2091
|
+
knowledgeBaseId: string | undefined;
|
|
2092
|
+
/**
|
|
2093
|
+
* @public
|
|
2094
|
+
* Identifier for a resource.
|
|
2095
|
+
*/
|
|
2096
|
+
dataSourceId: string | undefined;
|
|
2097
|
+
/**
|
|
2098
|
+
* @public
|
|
2099
|
+
* Identifier for a resource.
|
|
2100
|
+
*/
|
|
2101
|
+
ingestionJobId: string | undefined;
|
|
2102
|
+
/**
|
|
2103
|
+
* @public
|
|
2104
|
+
* Description of the Resource.
|
|
2105
|
+
*/
|
|
2106
|
+
description?: string;
|
|
2107
|
+
/**
|
|
2108
|
+
* @public
|
|
2109
|
+
* The status of an ingestion job.
|
|
2110
|
+
*/
|
|
2111
|
+
status: IngestionJobStatus | undefined;
|
|
2112
|
+
/**
|
|
2113
|
+
* @public
|
|
2114
|
+
* The document level statistics of an ingestion job
|
|
2115
|
+
*/
|
|
2116
|
+
statistics?: IngestionJobStatistics;
|
|
2117
|
+
/**
|
|
2118
|
+
* @public
|
|
2119
|
+
* Failure Reasons for Error.
|
|
2120
|
+
*/
|
|
2121
|
+
failureReasons?: string[];
|
|
2122
|
+
/**
|
|
2123
|
+
* @public
|
|
2124
|
+
* Time Stamp.
|
|
2125
|
+
*/
|
|
2126
|
+
startedAt: Date | undefined;
|
|
2127
|
+
/**
|
|
2128
|
+
* @public
|
|
2129
|
+
* Time Stamp.
|
|
2130
|
+
*/
|
|
2131
|
+
updatedAt: Date | undefined;
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
export interface GetIngestionJobResponse {
|
|
2137
|
+
/**
|
|
2138
|
+
* @public
|
|
2139
|
+
* Contains the information of an ingestion job.
|
|
2140
|
+
*/
|
|
2141
|
+
ingestionJob: IngestionJob | undefined;
|
|
2142
|
+
}
|
|
2143
|
+
/**
|
|
2144
|
+
* @public
|
|
2145
|
+
* @enum
|
|
2146
|
+
*/
|
|
2147
|
+
export declare const IngestionJobFilterAttribute: {
|
|
2148
|
+
readonly STATUS: "STATUS";
|
|
2149
|
+
};
|
|
2150
|
+
/**
|
|
2151
|
+
* @public
|
|
2152
|
+
*/
|
|
2153
|
+
export type IngestionJobFilterAttribute = (typeof IngestionJobFilterAttribute)[keyof typeof IngestionJobFilterAttribute];
|
|
2154
|
+
/**
|
|
2155
|
+
* @public
|
|
2156
|
+
* @enum
|
|
2157
|
+
*/
|
|
2158
|
+
export declare const IngestionJobFilterOperator: {
|
|
2159
|
+
readonly EQ: "EQ";
|
|
2160
|
+
};
|
|
2161
|
+
/**
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator];
|
|
2165
|
+
/**
|
|
2166
|
+
* @public
|
|
2167
|
+
* Filters the response returned by ListIngestionJobs operation.
|
|
2168
|
+
*/
|
|
2169
|
+
export interface IngestionJobFilter {
|
|
2170
|
+
/**
|
|
2171
|
+
* @public
|
|
2172
|
+
* The name of the field to filter ingestion jobs.
|
|
2173
|
+
*/
|
|
2174
|
+
attribute: IngestionJobFilterAttribute | undefined;
|
|
2175
|
+
/**
|
|
2176
|
+
* @public
|
|
2177
|
+
* The operator used to filter ingestion jobs.
|
|
2178
|
+
*/
|
|
2179
|
+
operator: IngestionJobFilterOperator | undefined;
|
|
2180
|
+
/**
|
|
2181
|
+
* @public
|
|
2182
|
+
* The list of values used to filter ingestion jobs.
|
|
2183
|
+
*/
|
|
2184
|
+
values: string[] | undefined;
|
|
2185
|
+
}
|
|
2186
|
+
/**
|
|
2187
|
+
* @public
|
|
2188
|
+
* @enum
|
|
2189
|
+
*/
|
|
2190
|
+
export declare const IngestionJobSortByAttribute: {
|
|
2191
|
+
readonly STARTED_AT: "STARTED_AT";
|
|
2192
|
+
readonly STATUS: "STATUS";
|
|
2193
|
+
};
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
*/
|
|
2197
|
+
export type IngestionJobSortByAttribute = (typeof IngestionJobSortByAttribute)[keyof typeof IngestionJobSortByAttribute];
|
|
2198
|
+
/**
|
|
2199
|
+
* @public
|
|
2200
|
+
* @enum
|
|
2201
|
+
*/
|
|
2202
|
+
export declare const SortOrder: {
|
|
2203
|
+
readonly ASCENDING: "ASCENDING";
|
|
2204
|
+
readonly DESCENDING: "DESCENDING";
|
|
2205
|
+
};
|
|
2206
|
+
/**
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
2210
|
+
/**
|
|
2211
|
+
* @public
|
|
2212
|
+
* Sorts the response returned by ListIngestionJobs operation.
|
|
2213
|
+
*/
|
|
2214
|
+
export interface IngestionJobSortBy {
|
|
2215
|
+
/**
|
|
2216
|
+
* @public
|
|
2217
|
+
* The name of the field to sort ingestion jobs.
|
|
2218
|
+
*/
|
|
2219
|
+
attribute: IngestionJobSortByAttribute | undefined;
|
|
2220
|
+
/**
|
|
2221
|
+
* @public
|
|
2222
|
+
* Order to sort results by.
|
|
2223
|
+
*/
|
|
2224
|
+
order: SortOrder | undefined;
|
|
2225
|
+
}
|
|
2226
|
+
/**
|
|
2227
|
+
* @public
|
|
2228
|
+
*/
|
|
2229
|
+
export interface ListIngestionJobsRequest {
|
|
2230
|
+
/**
|
|
2231
|
+
* @public
|
|
2232
|
+
* Identifier for a resource.
|
|
2233
|
+
*/
|
|
2234
|
+
knowledgeBaseId: string | undefined;
|
|
2235
|
+
/**
|
|
2236
|
+
* @public
|
|
2237
|
+
* Identifier for a resource.
|
|
2238
|
+
*/
|
|
2239
|
+
dataSourceId: string | undefined;
|
|
2240
|
+
/**
|
|
2241
|
+
* @public
|
|
2242
|
+
* List of IngestionJobFilters
|
|
2243
|
+
*/
|
|
2244
|
+
filters?: IngestionJobFilter[];
|
|
2245
|
+
/**
|
|
2246
|
+
* @public
|
|
2247
|
+
* Sorts the response returned by ListIngestionJobs operation.
|
|
2248
|
+
*/
|
|
2249
|
+
sortBy?: IngestionJobSortBy;
|
|
2250
|
+
/**
|
|
2251
|
+
* @public
|
|
2252
|
+
* Max Results.
|
|
2253
|
+
*/
|
|
2254
|
+
maxResults?: number;
|
|
2255
|
+
/**
|
|
2256
|
+
* @public
|
|
2257
|
+
* Opaque continuation token of previous paginated response.
|
|
2258
|
+
*/
|
|
2259
|
+
nextToken?: string;
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* @public
|
|
2263
|
+
* Summary information of an ingestion job.
|
|
2264
|
+
*/
|
|
2265
|
+
export interface IngestionJobSummary {
|
|
2266
|
+
/**
|
|
2267
|
+
* @public
|
|
2268
|
+
* Identifier for a resource.
|
|
2269
|
+
*/
|
|
2270
|
+
knowledgeBaseId: string | undefined;
|
|
2271
|
+
/**
|
|
2272
|
+
* @public
|
|
2273
|
+
* Identifier for a resource.
|
|
2274
|
+
*/
|
|
2275
|
+
dataSourceId: string | undefined;
|
|
2276
|
+
/**
|
|
2277
|
+
* @public
|
|
2278
|
+
* Identifier for a resource.
|
|
2279
|
+
*/
|
|
2280
|
+
ingestionJobId: string | undefined;
|
|
2281
|
+
/**
|
|
2282
|
+
* @public
|
|
2283
|
+
* Description of the Resource.
|
|
2284
|
+
*/
|
|
2285
|
+
description?: string;
|
|
2286
|
+
/**
|
|
2287
|
+
* @public
|
|
2288
|
+
* The status of an ingestion job.
|
|
2289
|
+
*/
|
|
2290
|
+
status: IngestionJobStatus | undefined;
|
|
2291
|
+
/**
|
|
2292
|
+
* @public
|
|
2293
|
+
* Time Stamp.
|
|
2294
|
+
*/
|
|
2295
|
+
startedAt: Date | undefined;
|
|
2296
|
+
/**
|
|
2297
|
+
* @public
|
|
2298
|
+
* Time Stamp.
|
|
2299
|
+
*/
|
|
2300
|
+
updatedAt: Date | undefined;
|
|
2301
|
+
/**
|
|
2302
|
+
* @public
|
|
2303
|
+
* The document level statistics of an ingestion job
|
|
2304
|
+
*/
|
|
2305
|
+
statistics?: IngestionJobStatistics;
|
|
2306
|
+
}
|
|
2307
|
+
/**
|
|
2308
|
+
* @public
|
|
2309
|
+
*/
|
|
2310
|
+
export interface ListIngestionJobsResponse {
|
|
2311
|
+
/**
|
|
2312
|
+
* @public
|
|
2313
|
+
* List of IngestionJobSummaries
|
|
2314
|
+
*/
|
|
2315
|
+
ingestionJobSummaries: IngestionJobSummary[] | undefined;
|
|
2316
|
+
/**
|
|
2317
|
+
* @public
|
|
2318
|
+
* Opaque continuation token of previous paginated response.
|
|
2319
|
+
*/
|
|
2320
|
+
nextToken?: string;
|
|
2321
|
+
}
|
|
2322
|
+
/**
|
|
2323
|
+
* @public
|
|
2324
|
+
*/
|
|
2325
|
+
export interface StartIngestionJobRequest {
|
|
2326
|
+
/**
|
|
2327
|
+
* @public
|
|
2328
|
+
* Identifier for a resource.
|
|
2329
|
+
*/
|
|
2330
|
+
knowledgeBaseId: string | undefined;
|
|
2331
|
+
/**
|
|
2332
|
+
* @public
|
|
2333
|
+
* Identifier for a resource.
|
|
2334
|
+
*/
|
|
2335
|
+
dataSourceId: string | undefined;
|
|
2336
|
+
/**
|
|
2337
|
+
* @public
|
|
2338
|
+
* Client specified token used for idempotency checks
|
|
2339
|
+
*/
|
|
2340
|
+
clientToken?: string;
|
|
2341
|
+
/**
|
|
2342
|
+
* @public
|
|
2343
|
+
* Description of the Resource.
|
|
2344
|
+
*/
|
|
2345
|
+
description?: string;
|
|
2346
|
+
}
|
|
2347
|
+
/**
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2350
|
+
export interface StartIngestionJobResponse {
|
|
2351
|
+
/**
|
|
2352
|
+
* @public
|
|
2353
|
+
* Contains the information of an ingestion job.
|
|
2354
|
+
*/
|
|
2355
|
+
ingestionJob: IngestionJob | undefined;
|
|
2356
|
+
}
|
|
2357
|
+
/**
|
|
2358
|
+
* @public
|
|
2359
|
+
* Associate Agent Knowledge Base Request
|
|
2360
|
+
*/
|
|
2361
|
+
export interface AssociateAgentKnowledgeBaseRequest {
|
|
2362
|
+
/**
|
|
2363
|
+
* @public
|
|
2364
|
+
* Id generated at the server side when an Agent is created
|
|
2365
|
+
*/
|
|
2366
|
+
agentId: string | undefined;
|
|
2367
|
+
/**
|
|
2368
|
+
* @public
|
|
2369
|
+
* Draft Version of the Agent.
|
|
2370
|
+
*/
|
|
2371
|
+
agentVersion: string | undefined;
|
|
2372
|
+
/**
|
|
2373
|
+
* @public
|
|
2374
|
+
* Identifier for a resource.
|
|
2375
|
+
*/
|
|
2376
|
+
knowledgeBaseId: string | undefined;
|
|
2377
|
+
/**
|
|
2378
|
+
* @public
|
|
2379
|
+
* Description of the Resource.
|
|
2380
|
+
*/
|
|
2381
|
+
description: string | undefined;
|
|
2382
|
+
/**
|
|
2383
|
+
* @public
|
|
2384
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
2385
|
+
*/
|
|
2386
|
+
knowledgeBaseState?: KnowledgeBaseState;
|
|
2387
|
+
}
|
|
2388
|
+
/**
|
|
2389
|
+
* @public
|
|
2390
|
+
* Associate Agent Knowledge Base Response
|
|
2391
|
+
*/
|
|
2392
|
+
export interface AssociateAgentKnowledgeBaseResponse {
|
|
2393
|
+
/**
|
|
2394
|
+
* @public
|
|
2395
|
+
* Contains the information of an Agent Knowledge Base.
|
|
2396
|
+
*/
|
|
2397
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
2398
|
+
}
|
|
2399
|
+
/**
|
|
2400
|
+
* @public
|
|
2401
|
+
* @enum
|
|
2402
|
+
*/
|
|
2403
|
+
export declare const KnowledgeBaseType: {
|
|
2404
|
+
readonly VECTOR: "VECTOR";
|
|
2405
|
+
};
|
|
2406
|
+
/**
|
|
2407
|
+
* @public
|
|
2408
|
+
*/
|
|
2409
|
+
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
2410
|
+
/**
|
|
2411
|
+
* @public
|
|
2412
|
+
* Configurations for a vector knowledge base.
|
|
2413
|
+
*/
|
|
2414
|
+
export interface VectorKnowledgeBaseConfiguration {
|
|
2415
|
+
/**
|
|
2416
|
+
* @public
|
|
2417
|
+
* Arn of a Bedrock model.
|
|
2418
|
+
*/
|
|
2419
|
+
embeddingModelArn: string | undefined;
|
|
2420
|
+
}
|
|
2421
|
+
/**
|
|
2422
|
+
* @public
|
|
2423
|
+
* Configures a bedrock knowledge base.
|
|
2424
|
+
*/
|
|
2425
|
+
export interface KnowledgeBaseConfiguration {
|
|
2426
|
+
/**
|
|
2427
|
+
* @public
|
|
2428
|
+
* The type of a knowledge base.
|
|
2429
|
+
*/
|
|
2430
|
+
type: KnowledgeBaseType | undefined;
|
|
2431
|
+
/**
|
|
2432
|
+
* @public
|
|
2433
|
+
* Configurations for a vector knowledge base.
|
|
2434
|
+
*/
|
|
2435
|
+
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
|
|
2436
|
+
}
|
|
2437
|
+
/**
|
|
2438
|
+
* @public
|
|
2439
|
+
* A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
|
|
2440
|
+
*/
|
|
2441
|
+
export interface OpenSearchServerlessFieldMapping {
|
|
2442
|
+
/**
|
|
2443
|
+
* @public
|
|
2444
|
+
* Name of the field
|
|
2445
|
+
*/
|
|
2446
|
+
vectorField: string | undefined;
|
|
2447
|
+
/**
|
|
2448
|
+
* @public
|
|
2449
|
+
* Name of the field
|
|
2450
|
+
*/
|
|
2451
|
+
textField: string | undefined;
|
|
2452
|
+
/**
|
|
2453
|
+
* @public
|
|
2454
|
+
* Name of the field
|
|
2455
|
+
*/
|
|
2456
|
+
metadataField: string | undefined;
|
|
2457
|
+
}
|
|
2458
|
+
/**
|
|
2459
|
+
* @public
|
|
2460
|
+
* Contains the configurations to use OpenSearch Serverless to store knowledge base data.
|
|
2461
|
+
*/
|
|
2462
|
+
export interface OpenSearchServerlessConfiguration {
|
|
2463
|
+
/**
|
|
2464
|
+
* @public
|
|
2465
|
+
* Arn of an OpenSearch Serverless collection.
|
|
2466
|
+
*/
|
|
2467
|
+
collectionArn: string | undefined;
|
|
2468
|
+
/**
|
|
2469
|
+
* @public
|
|
2470
|
+
* Arn of an OpenSearch Serverless index.
|
|
2471
|
+
*/
|
|
2472
|
+
vectorIndexName: string | undefined;
|
|
2473
|
+
/**
|
|
2474
|
+
* @public
|
|
2475
|
+
* A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
|
|
2476
|
+
*/
|
|
2477
|
+
fieldMapping: OpenSearchServerlessFieldMapping | undefined;
|
|
2478
|
+
}
|
|
2479
|
+
/**
|
|
2480
|
+
* @public
|
|
2481
|
+
* A mapping of Bedrock Knowledge Base fields to Pinecone field names
|
|
2482
|
+
*/
|
|
2483
|
+
export interface PineconeFieldMapping {
|
|
2484
|
+
/**
|
|
2485
|
+
* @public
|
|
2486
|
+
* Name of the field
|
|
2487
|
+
*/
|
|
2488
|
+
textField: string | undefined;
|
|
2489
|
+
/**
|
|
2490
|
+
* @public
|
|
2491
|
+
* Name of the field
|
|
2492
|
+
*/
|
|
2493
|
+
metadataField: string | undefined;
|
|
2494
|
+
}
|
|
2495
|
+
/**
|
|
2496
|
+
* @public
|
|
2497
|
+
* Contains the configurations to use Pinecone to store knowledge base data.
|
|
2498
|
+
*/
|
|
2499
|
+
export interface PineconeConfiguration {
|
|
2500
|
+
/**
|
|
2501
|
+
* @public
|
|
2502
|
+
* Pinecone connection string
|
|
2503
|
+
*/
|
|
2504
|
+
connectionString: string | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* @public
|
|
2507
|
+
* Arn of a SecretsManager Secret.
|
|
2508
|
+
*/
|
|
2509
|
+
credentialsSecretArn: string | undefined;
|
|
2510
|
+
/**
|
|
2511
|
+
* @public
|
|
2512
|
+
* Pinecone namespace
|
|
2513
|
+
*/
|
|
2514
|
+
namespace?: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* @public
|
|
2517
|
+
* A mapping of Bedrock Knowledge Base fields to Pinecone field names
|
|
2518
|
+
*/
|
|
2519
|
+
fieldMapping: PineconeFieldMapping | undefined;
|
|
2520
|
+
}
|
|
2521
|
+
/**
|
|
2522
|
+
* @public
|
|
2523
|
+
* A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
|
|
2524
|
+
*/
|
|
2525
|
+
export interface RedisEnterpriseCloudFieldMapping {
|
|
2526
|
+
/**
|
|
2527
|
+
* @public
|
|
2528
|
+
* Name of the field
|
|
2529
|
+
*/
|
|
2530
|
+
vectorField: string | undefined;
|
|
2531
|
+
/**
|
|
2532
|
+
* @public
|
|
2533
|
+
* Name of the field
|
|
2534
|
+
*/
|
|
2535
|
+
textField: string | undefined;
|
|
2536
|
+
/**
|
|
2537
|
+
* @public
|
|
2538
|
+
* Name of the field
|
|
2539
|
+
*/
|
|
2540
|
+
metadataField: string | undefined;
|
|
2541
|
+
}
|
|
2542
|
+
/**
|
|
2543
|
+
* @public
|
|
2544
|
+
* Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
|
|
2545
|
+
*/
|
|
2546
|
+
export interface RedisEnterpriseCloudConfiguration {
|
|
2547
|
+
/**
|
|
2548
|
+
* @public
|
|
2549
|
+
* Redis enterprise cloud endpoint
|
|
2550
|
+
*/
|
|
2551
|
+
endpoint: string | undefined;
|
|
2552
|
+
/**
|
|
2553
|
+
* @public
|
|
2554
|
+
* Name of a redis enterprise cloud index
|
|
2555
|
+
*/
|
|
2556
|
+
vectorIndexName: string | undefined;
|
|
2557
|
+
/**
|
|
2558
|
+
* @public
|
|
2559
|
+
* Arn of a SecretsManager Secret.
|
|
2560
|
+
*/
|
|
2561
|
+
credentialsSecretArn: string | undefined;
|
|
2562
|
+
/**
|
|
2563
|
+
* @public
|
|
2564
|
+
* A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
|
|
2565
|
+
*/
|
|
2566
|
+
fieldMapping: RedisEnterpriseCloudFieldMapping | undefined;
|
|
2567
|
+
}
|
|
2568
|
+
/**
|
|
2569
|
+
* @public
|
|
2570
|
+
* @enum
|
|
2571
|
+
*/
|
|
2572
|
+
export declare const KnowledgeBaseStorageType: {
|
|
2573
|
+
readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
|
|
2574
|
+
readonly PINECONE: "PINECONE";
|
|
2575
|
+
readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
|
|
2576
|
+
};
|
|
2577
|
+
/**
|
|
2578
|
+
* @public
|
|
2579
|
+
*/
|
|
2580
|
+
export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
|
|
2581
|
+
/**
|
|
2582
|
+
* @public
|
|
2583
|
+
* Configures the physical storage of ingested data in a knowledge base.
|
|
2584
|
+
*/
|
|
2585
|
+
export interface StorageConfiguration {
|
|
2586
|
+
/**
|
|
2587
|
+
* @public
|
|
2588
|
+
* The storage type of a knowledge base.
|
|
2589
|
+
*/
|
|
2590
|
+
type: KnowledgeBaseStorageType | undefined;
|
|
2591
|
+
/**
|
|
2592
|
+
* @public
|
|
2593
|
+
* Contains the configurations to use OpenSearch Serverless to store knowledge base data.
|
|
2594
|
+
*/
|
|
2595
|
+
opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
|
|
2596
|
+
/**
|
|
2597
|
+
* @public
|
|
2598
|
+
* Contains the configurations to use Pinecone to store knowledge base data.
|
|
2599
|
+
*/
|
|
2600
|
+
pineconeConfiguration?: PineconeConfiguration;
|
|
2601
|
+
/**
|
|
2602
|
+
* @public
|
|
2603
|
+
* Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
|
|
2604
|
+
*/
|
|
2605
|
+
redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
|
|
2606
|
+
}
|
|
2607
|
+
/**
|
|
2608
|
+
* @public
|
|
2609
|
+
*/
|
|
2610
|
+
export interface CreateKnowledgeBaseRequest {
|
|
2611
|
+
/**
|
|
2612
|
+
* @public
|
|
2613
|
+
* Client specified token used for idempotency checks
|
|
2614
|
+
*/
|
|
2615
|
+
clientToken?: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* @public
|
|
2618
|
+
* Name for a resource.
|
|
2619
|
+
*/
|
|
2620
|
+
name: string | undefined;
|
|
2621
|
+
/**
|
|
2622
|
+
* @public
|
|
2623
|
+
* Description of the Resource.
|
|
2624
|
+
*/
|
|
2625
|
+
description?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* @public
|
|
2628
|
+
* ARN of a IAM role.
|
|
2629
|
+
*/
|
|
2630
|
+
roleArn: string | undefined;
|
|
2631
|
+
/**
|
|
2632
|
+
* @public
|
|
2633
|
+
* Configures a bedrock knowledge base.
|
|
2634
|
+
*/
|
|
2635
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
2636
|
+
/**
|
|
2637
|
+
* @public
|
|
2638
|
+
* Configures the physical storage of ingested data in a knowledge base.
|
|
2639
|
+
*/
|
|
2640
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
2641
|
+
/**
|
|
2642
|
+
* @public
|
|
2643
|
+
* A map of tag keys and values
|
|
2644
|
+
*/
|
|
2645
|
+
tags?: Record<string, string>;
|
|
2646
|
+
}
|
|
2647
|
+
/**
|
|
2648
|
+
* @public
|
|
2649
|
+
* @enum
|
|
2650
|
+
*/
|
|
2651
|
+
export declare const KnowledgeBaseStatus: {
|
|
2652
|
+
readonly ACTIVE: "ACTIVE";
|
|
2653
|
+
readonly CREATING: "CREATING";
|
|
2654
|
+
readonly DELETING: "DELETING";
|
|
2655
|
+
readonly FAILED: "FAILED";
|
|
2656
|
+
readonly UPDATING: "UPDATING";
|
|
2657
|
+
};
|
|
2658
|
+
/**
|
|
2659
|
+
* @public
|
|
2660
|
+
*/
|
|
2661
|
+
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
2662
|
+
/**
|
|
2663
|
+
* @public
|
|
2664
|
+
* Contains the information of a knowledge base.
|
|
2665
|
+
*/
|
|
2666
|
+
export interface KnowledgeBase {
|
|
2667
|
+
/**
|
|
2668
|
+
* @public
|
|
2669
|
+
* Identifier for a resource.
|
|
2670
|
+
*/
|
|
2671
|
+
knowledgeBaseId: string | undefined;
|
|
2672
|
+
/**
|
|
2673
|
+
* @public
|
|
2674
|
+
* Name for a resource.
|
|
2675
|
+
*/
|
|
2676
|
+
name: string | undefined;
|
|
2677
|
+
/**
|
|
2678
|
+
* @public
|
|
2679
|
+
* ARN of a KnowledgeBase
|
|
2680
|
+
*/
|
|
2681
|
+
knowledgeBaseArn: string | undefined;
|
|
2682
|
+
/**
|
|
2683
|
+
* @public
|
|
2684
|
+
* Description of the Resource.
|
|
2685
|
+
*/
|
|
2686
|
+
description?: string;
|
|
2687
|
+
/**
|
|
2688
|
+
* @public
|
|
2689
|
+
* ARN of a IAM role.
|
|
2690
|
+
*/
|
|
2691
|
+
roleArn: string | undefined;
|
|
2692
|
+
/**
|
|
2693
|
+
* @public
|
|
2694
|
+
* Configures a bedrock knowledge base.
|
|
2695
|
+
*/
|
|
2696
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* @public
|
|
2699
|
+
* Configures the physical storage of ingested data in a knowledge base.
|
|
2700
|
+
*/
|
|
2701
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* @public
|
|
2704
|
+
* The status of a knowledge base.
|
|
2705
|
+
*/
|
|
2706
|
+
status: KnowledgeBaseStatus | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* @public
|
|
2709
|
+
* Time Stamp.
|
|
2710
|
+
*/
|
|
2711
|
+
createdAt: Date | undefined;
|
|
2712
|
+
/**
|
|
2713
|
+
* @public
|
|
2714
|
+
* Time Stamp.
|
|
2715
|
+
*/
|
|
2716
|
+
updatedAt: Date | undefined;
|
|
2717
|
+
/**
|
|
2718
|
+
* @public
|
|
2719
|
+
* Failure Reasons for Error.
|
|
2720
|
+
*/
|
|
2721
|
+
failureReasons?: string[];
|
|
2722
|
+
}
|
|
2723
|
+
/**
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
export interface CreateKnowledgeBaseResponse {
|
|
2727
|
+
/**
|
|
2728
|
+
* @public
|
|
2729
|
+
* Contains the information of a knowledge base.
|
|
2730
|
+
*/
|
|
2731
|
+
knowledgeBase: KnowledgeBase | undefined;
|
|
2732
|
+
}
|
|
2733
|
+
/**
|
|
2734
|
+
* @public
|
|
2735
|
+
*/
|
|
2736
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
2737
|
+
/**
|
|
2738
|
+
* @public
|
|
2739
|
+
* Identifier for a resource.
|
|
2740
|
+
*/
|
|
2741
|
+
knowledgeBaseId: string | undefined;
|
|
2742
|
+
}
|
|
2743
|
+
/**
|
|
2744
|
+
* @public
|
|
2745
|
+
*/
|
|
2746
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
2747
|
+
/**
|
|
2748
|
+
* @public
|
|
2749
|
+
* Identifier for a resource.
|
|
2750
|
+
*/
|
|
2751
|
+
knowledgeBaseId: string | undefined;
|
|
2752
|
+
/**
|
|
2753
|
+
* @public
|
|
2754
|
+
* The status of a knowledge base.
|
|
2755
|
+
*/
|
|
2756
|
+
status: KnowledgeBaseStatus | undefined;
|
|
2757
|
+
}
|
|
2758
|
+
/**
|
|
2759
|
+
* @public
|
|
2760
|
+
* Disassociate Agent Knowledge Base Request
|
|
2761
|
+
*/
|
|
2762
|
+
export interface DisassociateAgentKnowledgeBaseRequest {
|
|
2763
|
+
/**
|
|
2764
|
+
* @public
|
|
2765
|
+
* Id generated at the server side when an Agent is created
|
|
2766
|
+
*/
|
|
2767
|
+
agentId: string | undefined;
|
|
2768
|
+
/**
|
|
2769
|
+
* @public
|
|
2770
|
+
* Draft Version of the Agent.
|
|
2771
|
+
*/
|
|
2772
|
+
agentVersion: string | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* @public
|
|
2775
|
+
* Id generated at the server side when a Knowledge Base is associated to an Agent
|
|
2776
|
+
*/
|
|
2777
|
+
knowledgeBaseId: string | undefined;
|
|
2778
|
+
}
|
|
2779
|
+
/**
|
|
2780
|
+
* @public
|
|
2781
|
+
* Disassociate Agent Knowledge Base Response
|
|
2782
|
+
*/
|
|
2783
|
+
export interface DisassociateAgentKnowledgeBaseResponse {
|
|
2784
|
+
}
|
|
2785
|
+
/**
|
|
2786
|
+
* @public
|
|
2787
|
+
* Get Agent Knowledge Base Request
|
|
2788
|
+
*/
|
|
2789
|
+
export interface GetAgentKnowledgeBaseRequest {
|
|
2790
|
+
/**
|
|
2791
|
+
* @public
|
|
2792
|
+
* Id generated at the server side when an Agent is created
|
|
2793
|
+
*/
|
|
2794
|
+
agentId: string | undefined;
|
|
2795
|
+
/**
|
|
2796
|
+
* @public
|
|
2797
|
+
* Version number generated when a version is created
|
|
2798
|
+
*/
|
|
2799
|
+
agentVersion: string | undefined;
|
|
2800
|
+
/**
|
|
2801
|
+
* @public
|
|
2802
|
+
* Id generated at the server side when a Knowledge Base is associated
|
|
2803
|
+
*/
|
|
2804
|
+
knowledgeBaseId: string | undefined;
|
|
2805
|
+
}
|
|
2806
|
+
/**
|
|
2807
|
+
* @public
|
|
2808
|
+
* Get Agent Knowledge Base Response
|
|
2809
|
+
*/
|
|
2810
|
+
export interface GetAgentKnowledgeBaseResponse {
|
|
2811
|
+
/**
|
|
2812
|
+
* @public
|
|
2813
|
+
* Contains the information of an Agent Knowledge Base.
|
|
2814
|
+
*/
|
|
2815
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
2816
|
+
}
|
|
2817
|
+
/**
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
export interface GetKnowledgeBaseRequest {
|
|
2821
|
+
/**
|
|
2822
|
+
* @public
|
|
2823
|
+
* Identifier for a resource.
|
|
2824
|
+
*/
|
|
2825
|
+
knowledgeBaseId: string | undefined;
|
|
2826
|
+
}
|
|
2827
|
+
/**
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
export interface GetKnowledgeBaseResponse {
|
|
2831
|
+
/**
|
|
2832
|
+
* @public
|
|
2833
|
+
* Contains the information of a knowledge base.
|
|
2834
|
+
*/
|
|
2835
|
+
knowledgeBase: KnowledgeBase | undefined;
|
|
2836
|
+
}
|
|
2837
|
+
/**
|
|
2838
|
+
* @public
|
|
2839
|
+
* List Agent Knowledge Bases Request
|
|
2840
|
+
*/
|
|
2841
|
+
export interface ListAgentKnowledgeBasesRequest {
|
|
2842
|
+
/**
|
|
2843
|
+
* @public
|
|
2844
|
+
* Id generated at the server side when an Agent is created
|
|
2845
|
+
*/
|
|
2846
|
+
agentId: string | undefined;
|
|
2847
|
+
/**
|
|
2848
|
+
* @public
|
|
2849
|
+
* Version number generated when a version is created
|
|
2850
|
+
*/
|
|
2851
|
+
agentVersion: string | undefined;
|
|
2852
|
+
/**
|
|
2853
|
+
* @public
|
|
2854
|
+
* Max Results.
|
|
2855
|
+
*/
|
|
2856
|
+
maxResults?: number;
|
|
2857
|
+
/**
|
|
2858
|
+
* @public
|
|
2859
|
+
* Opaque continuation token of previous paginated response.
|
|
2860
|
+
*/
|
|
2861
|
+
nextToken?: string;
|
|
2862
|
+
}
|
|
2863
|
+
/**
|
|
2864
|
+
* @public
|
|
2865
|
+
* List Agent Knowledge Bases Response
|
|
2866
|
+
*/
|
|
2867
|
+
export interface ListAgentKnowledgeBasesResponse {
|
|
2868
|
+
/**
|
|
2869
|
+
* @public
|
|
2870
|
+
* List of Agent Knowledge Base Summaries
|
|
2871
|
+
*/
|
|
2872
|
+
agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummary[] | undefined;
|
|
2873
|
+
/**
|
|
2874
|
+
* @public
|
|
2875
|
+
* Opaque continuation token of previous paginated response.
|
|
2876
|
+
*/
|
|
2877
|
+
nextToken?: string;
|
|
2878
|
+
}
|
|
2879
|
+
/**
|
|
2880
|
+
* @public
|
|
2881
|
+
*/
|
|
2882
|
+
export interface ListKnowledgeBasesRequest {
|
|
2883
|
+
/**
|
|
2884
|
+
* @public
|
|
2885
|
+
* Max Results.
|
|
2886
|
+
*/
|
|
2887
|
+
maxResults?: number;
|
|
2888
|
+
/**
|
|
2889
|
+
* @public
|
|
2890
|
+
* Opaque continuation token of previous paginated response.
|
|
2891
|
+
*/
|
|
2892
|
+
nextToken?: string;
|
|
2893
|
+
}
|
|
2894
|
+
/**
|
|
2895
|
+
* @public
|
|
2896
|
+
* Summary information of a knowledge base.
|
|
2897
|
+
*/
|
|
2898
|
+
export interface KnowledgeBaseSummary {
|
|
2899
|
+
/**
|
|
2900
|
+
* @public
|
|
2901
|
+
* Identifier for a resource.
|
|
2902
|
+
*/
|
|
2903
|
+
knowledgeBaseId: string | undefined;
|
|
2904
|
+
/**
|
|
2905
|
+
* @public
|
|
2906
|
+
* Name for a resource.
|
|
2907
|
+
*/
|
|
2908
|
+
name: string | undefined;
|
|
2909
|
+
/**
|
|
2910
|
+
* @public
|
|
2911
|
+
* Description of the Resource.
|
|
2912
|
+
*/
|
|
2913
|
+
description?: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* @public
|
|
2916
|
+
* The status of a knowledge base.
|
|
2917
|
+
*/
|
|
2918
|
+
status: KnowledgeBaseStatus | undefined;
|
|
2919
|
+
/**
|
|
2920
|
+
* @public
|
|
2921
|
+
* Time Stamp.
|
|
2922
|
+
*/
|
|
2923
|
+
updatedAt: Date | undefined;
|
|
2924
|
+
}
|
|
2925
|
+
/**
|
|
2926
|
+
* @public
|
|
2927
|
+
*/
|
|
2928
|
+
export interface ListKnowledgeBasesResponse {
|
|
2929
|
+
/**
|
|
2930
|
+
* @public
|
|
2931
|
+
* List of KnowledgeBaseSummaries
|
|
2932
|
+
*/
|
|
2933
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
2934
|
+
/**
|
|
2935
|
+
* @public
|
|
2936
|
+
* Opaque continuation token of previous paginated response.
|
|
2937
|
+
*/
|
|
2938
|
+
nextToken?: string;
|
|
2939
|
+
}
|
|
2940
|
+
/**
|
|
2941
|
+
* @public
|
|
2942
|
+
* Update Agent Knowledge Base Request
|
|
2943
|
+
*/
|
|
2944
|
+
export interface UpdateAgentKnowledgeBaseRequest {
|
|
2945
|
+
/**
|
|
2946
|
+
* @public
|
|
2947
|
+
* Id generated at the server side when an Agent is created
|
|
2948
|
+
*/
|
|
2949
|
+
agentId: string | undefined;
|
|
2950
|
+
/**
|
|
2951
|
+
* @public
|
|
2952
|
+
* Draft Version of the Agent.
|
|
2953
|
+
*/
|
|
2954
|
+
agentVersion: string | undefined;
|
|
2955
|
+
/**
|
|
2956
|
+
* @public
|
|
2957
|
+
* Id generated at the server side when a Knowledge Base is associated to an Agent
|
|
2958
|
+
*/
|
|
2959
|
+
knowledgeBaseId: string | undefined;
|
|
2960
|
+
/**
|
|
2961
|
+
* @public
|
|
2962
|
+
* Description of the Resource.
|
|
2963
|
+
*/
|
|
2964
|
+
description?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* @public
|
|
2967
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
2968
|
+
*/
|
|
2969
|
+
knowledgeBaseState?: KnowledgeBaseState;
|
|
2970
|
+
}
|
|
2971
|
+
/**
|
|
2972
|
+
* @public
|
|
2973
|
+
* Update Agent Knowledge Base Response
|
|
2974
|
+
*/
|
|
2975
|
+
export interface UpdateAgentKnowledgeBaseResponse {
|
|
2976
|
+
/**
|
|
2977
|
+
* @public
|
|
2978
|
+
* Contains the information of an Agent Knowledge Base.
|
|
2979
|
+
*/
|
|
2980
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
2981
|
+
}
|
|
2982
|
+
/**
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
2985
|
+
export interface UpdateKnowledgeBaseRequest {
|
|
2986
|
+
/**
|
|
2987
|
+
* @public
|
|
2988
|
+
* Identifier for a resource.
|
|
2989
|
+
*/
|
|
2990
|
+
knowledgeBaseId: string | undefined;
|
|
2991
|
+
/**
|
|
2992
|
+
* @public
|
|
2993
|
+
* Name for a resource.
|
|
2994
|
+
*/
|
|
2995
|
+
name: string | undefined;
|
|
2996
|
+
/**
|
|
2997
|
+
* @public
|
|
2998
|
+
* Description of the Resource.
|
|
2999
|
+
*/
|
|
3000
|
+
description?: string;
|
|
3001
|
+
/**
|
|
3002
|
+
* @public
|
|
3003
|
+
* ARN of a IAM role.
|
|
3004
|
+
*/
|
|
3005
|
+
roleArn: string | undefined;
|
|
3006
|
+
/**
|
|
3007
|
+
* @public
|
|
3008
|
+
* Configures a bedrock knowledge base.
|
|
3009
|
+
*/
|
|
3010
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
3011
|
+
/**
|
|
3012
|
+
* @public
|
|
3013
|
+
* Configures the physical storage of ingested data in a knowledge base.
|
|
3014
|
+
*/
|
|
3015
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
3016
|
+
}
|
|
3017
|
+
/**
|
|
3018
|
+
* @public
|
|
3019
|
+
*/
|
|
3020
|
+
export interface UpdateKnowledgeBaseResponse {
|
|
3021
|
+
/**
|
|
3022
|
+
* @public
|
|
3023
|
+
* Contains the information of a knowledge base.
|
|
3024
|
+
*/
|
|
3025
|
+
knowledgeBase: KnowledgeBase | undefined;
|
|
3026
|
+
}
|
|
3027
|
+
/**
|
|
3028
|
+
* @public
|
|
3029
|
+
*/
|
|
3030
|
+
export interface ListTagsForResourceRequest {
|
|
3031
|
+
/**
|
|
3032
|
+
* @public
|
|
3033
|
+
* ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
|
|
3034
|
+
*/
|
|
3035
|
+
resourceArn: string | undefined;
|
|
3036
|
+
}
|
|
3037
|
+
/**
|
|
3038
|
+
* @public
|
|
3039
|
+
*/
|
|
3040
|
+
export interface ListTagsForResourceResponse {
|
|
3041
|
+
/**
|
|
3042
|
+
* @public
|
|
3043
|
+
* A map of tag keys and values
|
|
3044
|
+
*/
|
|
3045
|
+
tags?: Record<string, string>;
|
|
3046
|
+
}
|
|
3047
|
+
/**
|
|
3048
|
+
* @public
|
|
3049
|
+
*/
|
|
3050
|
+
export interface TagResourceRequest {
|
|
3051
|
+
/**
|
|
3052
|
+
* @public
|
|
3053
|
+
* ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
|
|
3054
|
+
*/
|
|
3055
|
+
resourceArn: string | undefined;
|
|
3056
|
+
/**
|
|
3057
|
+
* @public
|
|
3058
|
+
* A map of tag keys and values
|
|
3059
|
+
*/
|
|
3060
|
+
tags: Record<string, string> | undefined;
|
|
3061
|
+
}
|
|
3062
|
+
/**
|
|
3063
|
+
* @public
|
|
3064
|
+
*/
|
|
3065
|
+
export interface TagResourceResponse {
|
|
3066
|
+
}
|
|
3067
|
+
/**
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
export interface UntagResourceRequest {
|
|
3071
|
+
/**
|
|
3072
|
+
* @public
|
|
3073
|
+
* ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]
|
|
3074
|
+
*/
|
|
3075
|
+
resourceArn: string | undefined;
|
|
3076
|
+
/**
|
|
3077
|
+
* @public
|
|
3078
|
+
* List of Tag Keys
|
|
3079
|
+
*/
|
|
3080
|
+
tagKeys: string[] | undefined;
|
|
3081
|
+
}
|
|
3082
|
+
/**
|
|
3083
|
+
* @public
|
|
3084
|
+
*/
|
|
3085
|
+
export interface UntagResourceResponse {
|
|
3086
|
+
}
|
|
3087
|
+
/**
|
|
3088
|
+
* @public
|
|
3089
|
+
* Delete Agent Version Request
|
|
3090
|
+
*/
|
|
3091
|
+
export interface DeleteAgentVersionRequest {
|
|
3092
|
+
/**
|
|
3093
|
+
* @public
|
|
3094
|
+
* Id generated at the server side when an Agent is created
|
|
3095
|
+
*/
|
|
3096
|
+
agentId: string | undefined;
|
|
3097
|
+
/**
|
|
3098
|
+
* @public
|
|
3099
|
+
* Numerical Agent Version.
|
|
3100
|
+
*/
|
|
3101
|
+
agentVersion: string | undefined;
|
|
3102
|
+
/**
|
|
3103
|
+
* @public
|
|
3104
|
+
* Skips checking if resource is in use when set to true. Defaults to false
|
|
3105
|
+
*/
|
|
3106
|
+
skipResourceInUseCheck?: boolean;
|
|
3107
|
+
}
|
|
3108
|
+
/**
|
|
3109
|
+
* @public
|
|
3110
|
+
* Delete Agent Version Response
|
|
3111
|
+
*/
|
|
3112
|
+
export interface DeleteAgentVersionResponse {
|
|
3113
|
+
/**
|
|
3114
|
+
* @public
|
|
3115
|
+
* Identifier for a resource.
|
|
3116
|
+
*/
|
|
3117
|
+
agentId: string | undefined;
|
|
3118
|
+
/**
|
|
3119
|
+
* @public
|
|
3120
|
+
* Numerical Agent Version.
|
|
3121
|
+
*/
|
|
3122
|
+
agentVersion: string | undefined;
|
|
3123
|
+
/**
|
|
3124
|
+
* @public
|
|
3125
|
+
* Schema Type for Action APIs.
|
|
3126
|
+
*/
|
|
3127
|
+
agentStatus: AgentStatus | undefined;
|
|
3128
|
+
}
|
|
3129
|
+
/**
|
|
3130
|
+
* @public
|
|
3131
|
+
* Get Agent Version Request
|
|
3132
|
+
*/
|
|
3133
|
+
export interface GetAgentVersionRequest {
|
|
3134
|
+
/**
|
|
3135
|
+
* @public
|
|
3136
|
+
* Id generated at the server side when an Agent is created
|
|
3137
|
+
*/
|
|
3138
|
+
agentId: string | undefined;
|
|
3139
|
+
/**
|
|
3140
|
+
* @public
|
|
3141
|
+
* Numerical Agent Version.
|
|
3142
|
+
*/
|
|
3143
|
+
agentVersion: string | undefined;
|
|
3144
|
+
}
|
|
3145
|
+
/**
|
|
3146
|
+
* @public
|
|
3147
|
+
* Get Agent Version Response
|
|
3148
|
+
*/
|
|
3149
|
+
export interface GetAgentVersionResponse {
|
|
3150
|
+
/**
|
|
3151
|
+
* @public
|
|
3152
|
+
* Contains the information of an agent version.
|
|
3153
|
+
*/
|
|
3154
|
+
agentVersion: AgentVersion | undefined;
|
|
3155
|
+
}
|
|
3156
|
+
/**
|
|
3157
|
+
* @public
|
|
3158
|
+
* List Agent Versions Request
|
|
3159
|
+
*/
|
|
3160
|
+
export interface ListAgentVersionsRequest {
|
|
3161
|
+
/**
|
|
3162
|
+
* @public
|
|
3163
|
+
* Id generated at the server side when an Agent is created
|
|
3164
|
+
*/
|
|
3165
|
+
agentId: string | undefined;
|
|
3166
|
+
/**
|
|
3167
|
+
* @public
|
|
3168
|
+
* Max Results.
|
|
3169
|
+
*/
|
|
3170
|
+
maxResults?: number;
|
|
3171
|
+
/**
|
|
3172
|
+
* @public
|
|
3173
|
+
* Opaque continuation token of previous paginated response.
|
|
3174
|
+
*/
|
|
3175
|
+
nextToken?: string;
|
|
3176
|
+
}
|
|
3177
|
+
/**
|
|
3178
|
+
* @public
|
|
3179
|
+
* List Agent Versions Response
|
|
3180
|
+
*/
|
|
3181
|
+
export interface ListAgentVersionsResponse {
|
|
3182
|
+
/**
|
|
3183
|
+
* @public
|
|
3184
|
+
* List of AgentVersionSummary.
|
|
3185
|
+
*/
|
|
3186
|
+
agentVersionSummaries: AgentVersionSummary[] | undefined;
|
|
3187
|
+
/**
|
|
3188
|
+
* @public
|
|
3189
|
+
* Opaque continuation token of previous paginated response.
|
|
3190
|
+
*/
|
|
3191
|
+
nextToken?: string;
|
|
3192
|
+
}
|
|
3193
|
+
/**
|
|
3194
|
+
* @internal
|
|
3195
|
+
*/
|
|
3196
|
+
export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
|
|
3197
|
+
/**
|
|
3198
|
+
* @internal
|
|
3199
|
+
*/
|
|
3200
|
+
export declare const CreateAgentActionGroupRequestFilterSensitiveLog: (obj: CreateAgentActionGroupRequest) => any;
|
|
3201
|
+
/**
|
|
3202
|
+
* @internal
|
|
3203
|
+
*/
|
|
3204
|
+
export declare const AgentActionGroupFilterSensitiveLog: (obj: AgentActionGroup) => any;
|
|
3205
|
+
/**
|
|
3206
|
+
* @internal
|
|
3207
|
+
*/
|
|
3208
|
+
export declare const CreateAgentActionGroupResponseFilterSensitiveLog: (obj: CreateAgentActionGroupResponse) => any;
|
|
3209
|
+
/**
|
|
3210
|
+
* @internal
|
|
3211
|
+
*/
|
|
3212
|
+
export declare const GetAgentActionGroupResponseFilterSensitiveLog: (obj: GetAgentActionGroupResponse) => any;
|
|
3213
|
+
/**
|
|
3214
|
+
* @internal
|
|
3215
|
+
*/
|
|
3216
|
+
export declare const UpdateAgentActionGroupRequestFilterSensitiveLog: (obj: UpdateAgentActionGroupRequest) => any;
|
|
3217
|
+
/**
|
|
3218
|
+
* @internal
|
|
3219
|
+
*/
|
|
3220
|
+
export declare const UpdateAgentActionGroupResponseFilterSensitiveLog: (obj: UpdateAgentActionGroupResponse) => any;
|
|
3221
|
+
/**
|
|
3222
|
+
* @internal
|
|
3223
|
+
*/
|
|
3224
|
+
export declare const PromptOverrideConfigurationFilterSensitiveLog: (obj: PromptOverrideConfiguration) => any;
|
|
3225
|
+
/**
|
|
3226
|
+
* @internal
|
|
3227
|
+
*/
|
|
3228
|
+
export declare const AgentFilterSensitiveLog: (obj: Agent) => any;
|
|
3229
|
+
/**
|
|
3230
|
+
* @internal
|
|
3231
|
+
*/
|
|
3232
|
+
export declare const CreateAgentRequestFilterSensitiveLog: (obj: CreateAgentRequest) => any;
|
|
3233
|
+
/**
|
|
3234
|
+
* @internal
|
|
3235
|
+
*/
|
|
3236
|
+
export declare const CreateAgentResponseFilterSensitiveLog: (obj: CreateAgentResponse) => any;
|
|
3237
|
+
/**
|
|
3238
|
+
* @internal
|
|
3239
|
+
*/
|
|
3240
|
+
export declare const GetAgentResponseFilterSensitiveLog: (obj: GetAgentResponse) => any;
|
|
3241
|
+
/**
|
|
3242
|
+
* @internal
|
|
3243
|
+
*/
|
|
3244
|
+
export declare const UpdateAgentRequestFilterSensitiveLog: (obj: UpdateAgentRequest) => any;
|
|
3245
|
+
/**
|
|
3246
|
+
* @internal
|
|
3247
|
+
*/
|
|
3248
|
+
export declare const UpdateAgentResponseFilterSensitiveLog: (obj: UpdateAgentResponse) => any;
|
|
3249
|
+
/**
|
|
3250
|
+
* @internal
|
|
3251
|
+
*/
|
|
3252
|
+
export declare const AgentVersionFilterSensitiveLog: (obj: AgentVersion) => any;
|
|
3253
|
+
/**
|
|
3254
|
+
* @internal
|
|
3255
|
+
*/
|
|
3256
|
+
export declare const GetAgentVersionResponseFilterSensitiveLog: (obj: GetAgentVersionResponse) => any;
|