@aws-sdk/client-bedrock-agent 3.554.0 → 3.560.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +35 -3
- package/dist-es/models/models_0.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +33 -1
- package/dist-types/commands/CreateAgentAliasCommand.d.ts +1 -1
- package/dist-types/commands/CreateAgentCommand.d.ts +3 -3
- package/dist-types/commands/CreateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgentActionGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAgentVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentActionGroupCommand.d.ts +17 -1
- package/dist-types/commands/GetAgentAliasCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/GetIngestionJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentActionGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PrepareAgentCommand.d.ts +1 -1
- package/dist-types/commands/StartIngestionJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentActionGroupCommand.d.ts +33 -1
- package/dist-types/commands/UpdateAgentAliasCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +243 -34
- package/dist-types/ts3.4/models/models_0.d.ts +54 -1
- package/package.json +4 -4
|
@@ -58,7 +58,7 @@ declare const UntagResourceCommand_base: {
|
|
|
58
58
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
61
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
64
64
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
@@ -42,6 +42,7 @@ declare const UpdateAgentActionGroupCommand_base: {
|
|
|
42
42
|
* parentActionGroupSignature: "AMAZON.UserInput",
|
|
43
43
|
* actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
|
|
44
44
|
* lambda: "STRING_VALUE",
|
|
45
|
+
* customControl: "RETURN_CONTROL",
|
|
45
46
|
* },
|
|
46
47
|
* actionGroupState: "ENABLED" || "DISABLED",
|
|
47
48
|
* apiSchema: { // APISchema Union: only one key present
|
|
@@ -51,6 +52,21 @@ declare const UpdateAgentActionGroupCommand_base: {
|
|
|
51
52
|
* },
|
|
52
53
|
* payload: "STRING_VALUE",
|
|
53
54
|
* },
|
|
55
|
+
* functionSchema: { // FunctionSchema Union: only one key present
|
|
56
|
+
* functions: [ // Functions
|
|
57
|
+
* { // Function
|
|
58
|
+
* name: "STRING_VALUE", // required
|
|
59
|
+
* description: "STRING_VALUE",
|
|
60
|
+
* parameters: { // ParameterMap
|
|
61
|
+
* "<keys>": { // ParameterDetail
|
|
62
|
+
* description: "STRING_VALUE",
|
|
63
|
+
* type: "string" || "number" || "integer" || "boolean" || "array", // required
|
|
64
|
+
* required: true || false,
|
|
65
|
+
* },
|
|
66
|
+
* },
|
|
67
|
+
* },
|
|
68
|
+
* ],
|
|
69
|
+
* },
|
|
54
70
|
* };
|
|
55
71
|
* const command = new UpdateAgentActionGroupCommand(input);
|
|
56
72
|
* const response = await client.send(command);
|
|
@@ -67,6 +83,7 @@ declare const UpdateAgentActionGroupCommand_base: {
|
|
|
67
83
|
* // parentActionSignature: "AMAZON.UserInput",
|
|
68
84
|
* // actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
|
|
69
85
|
* // lambda: "STRING_VALUE",
|
|
86
|
+
* // customControl: "RETURN_CONTROL",
|
|
70
87
|
* // },
|
|
71
88
|
* // apiSchema: { // APISchema Union: only one key present
|
|
72
89
|
* // s3: { // S3Identifier
|
|
@@ -75,6 +92,21 @@ declare const UpdateAgentActionGroupCommand_base: {
|
|
|
75
92
|
* // },
|
|
76
93
|
* // payload: "STRING_VALUE",
|
|
77
94
|
* // },
|
|
95
|
+
* // functionSchema: { // FunctionSchema Union: only one key present
|
|
96
|
+
* // functions: [ // Functions
|
|
97
|
+
* // { // Function
|
|
98
|
+
* // name: "STRING_VALUE", // required
|
|
99
|
+
* // description: "STRING_VALUE",
|
|
100
|
+
* // parameters: { // ParameterMap
|
|
101
|
+
* // "<keys>": { // ParameterDetail
|
|
102
|
+
* // description: "STRING_VALUE",
|
|
103
|
+
* // type: "string" || "number" || "integer" || "boolean" || "array", // required
|
|
104
|
+
* // required: true || false,
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // ],
|
|
109
|
+
* // },
|
|
78
110
|
* // actionGroupState: "ENABLED" || "DISABLED", // required
|
|
79
111
|
* // },
|
|
80
112
|
* // };
|
|
@@ -97,7 +129,7 @@ declare const UpdateAgentActionGroupCommand_base: {
|
|
|
97
129
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
98
130
|
*
|
|
99
131
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
132
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
101
133
|
*
|
|
102
134
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
103
135
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
@@ -94,7 +94,7 @@ declare const UpdateAgentAliasCommand_base: {
|
|
|
94
94
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
95
95
|
*
|
|
96
96
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
97
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
97
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
98
98
|
*
|
|
99
99
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
100
100
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
@@ -131,7 +131,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
131
131
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
132
132
|
*
|
|
133
133
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
134
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
134
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
135
135
|
*
|
|
136
136
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
137
137
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
@@ -72,7 +72,7 @@ declare const UpdateAgentKnowledgeBaseCommand_base: {
|
|
|
72
72
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
75
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ThrottlingException} (client fault)
|
|
78
78
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
@@ -116,7 +116,7 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
116
116
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
117
117
|
*
|
|
118
118
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
119
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
119
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
120
120
|
*
|
|
121
121
|
* @throws {@link ThrottlingException} (client fault)
|
|
122
122
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
@@ -192,7 +192,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
192
192
|
* <p>An internal server error occurred. Retry your request.</p>
|
|
193
193
|
*
|
|
194
194
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
195
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
195
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
196
196
|
*
|
|
197
197
|
* @throws {@link ThrottlingException} (client fault)
|
|
198
198
|
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
@@ -12,21 +12,42 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* @enum
|
|
18
|
+
*/
|
|
19
|
+
export declare const CustomControlMethod: {
|
|
20
|
+
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
export type CustomControlMethod = (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
|
|
15
26
|
/**
|
|
16
27
|
* <p>Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
17
28
|
* @public
|
|
18
29
|
*/
|
|
19
|
-
export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
|
|
30
|
+
export type ActionGroupExecutor = ActionGroupExecutor.CustomControlMember | ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
|
|
20
31
|
/**
|
|
21
32
|
* @public
|
|
22
33
|
*/
|
|
23
34
|
export declare namespace ActionGroupExecutor {
|
|
24
35
|
/**
|
|
25
|
-
* <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
36
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
26
37
|
* @public
|
|
27
38
|
*/
|
|
28
39
|
interface LambdaMember {
|
|
29
40
|
lambda: string;
|
|
41
|
+
customControl?: never;
|
|
42
|
+
$unknown?: never;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* <p>To return the action group invocation results directly in the <code>InvokeAgent</code> response, specify <code>RETURN_CONTROL</code>.</p>
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
interface CustomControlMember {
|
|
49
|
+
lambda?: never;
|
|
50
|
+
customControl: CustomControlMethod;
|
|
30
51
|
$unknown?: never;
|
|
31
52
|
}
|
|
32
53
|
/**
|
|
@@ -34,10 +55,12 @@ export declare namespace ActionGroupExecutor {
|
|
|
34
55
|
*/
|
|
35
56
|
interface $UnknownMember {
|
|
36
57
|
lambda?: never;
|
|
58
|
+
customControl?: never;
|
|
37
59
|
$unknown: [string, any];
|
|
38
60
|
}
|
|
39
61
|
interface Visitor<T> {
|
|
40
62
|
lambda: (value: string) => T;
|
|
63
|
+
customControl: (value: CustomControlMethod) => T;
|
|
41
64
|
_: (name: string, value: any) => T;
|
|
42
65
|
}
|
|
43
66
|
const visit: <T>(value: ActionGroupExecutor, visitor: Visitor<T>) => T;
|
|
@@ -124,6 +147,177 @@ export declare namespace APISchema {
|
|
|
124
147
|
}
|
|
125
148
|
const visit: <T>(value: APISchema, visitor: Visitor<T>) => T;
|
|
126
149
|
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* @enum
|
|
153
|
+
*/
|
|
154
|
+
export declare const Type: {
|
|
155
|
+
readonly ARRAY: "array";
|
|
156
|
+
readonly BOOLEAN: "boolean";
|
|
157
|
+
readonly INTEGER: "integer";
|
|
158
|
+
readonly NUMBER: "number";
|
|
159
|
+
readonly STRING: "string";
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export type Type = (typeof Type)[keyof typeof Type];
|
|
165
|
+
/**
|
|
166
|
+
* <p>Contains details about a parameter in a function for an action group.</p>
|
|
167
|
+
* <p>This data type is used in the following API operations:</p>
|
|
168
|
+
* <ul>
|
|
169
|
+
* <li>
|
|
170
|
+
* <p>
|
|
171
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
172
|
+
* </p>
|
|
173
|
+
* </li>
|
|
174
|
+
* <li>
|
|
175
|
+
* <p>
|
|
176
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
177
|
+
* </p>
|
|
178
|
+
* </li>
|
|
179
|
+
* <li>
|
|
180
|
+
* <p>
|
|
181
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
182
|
+
* </p>
|
|
183
|
+
* </li>
|
|
184
|
+
* <li>
|
|
185
|
+
* <p>
|
|
186
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
187
|
+
* </p>
|
|
188
|
+
* </li>
|
|
189
|
+
* <li>
|
|
190
|
+
* <p>
|
|
191
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
192
|
+
* </p>
|
|
193
|
+
* </li>
|
|
194
|
+
* </ul>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
export interface ParameterDetail {
|
|
198
|
+
/**
|
|
199
|
+
* <p>A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
description?: string;
|
|
203
|
+
/**
|
|
204
|
+
* <p>The data type of the parameter.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
type: Type | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>Whether the parameter is required for the agent to complete the function for action group invocation.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
required?: boolean;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* <p>Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.</p>
|
|
216
|
+
* <p>This data type is used in the following API operations:</p>
|
|
217
|
+
* <ul>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p>
|
|
220
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
221
|
+
* </p>
|
|
222
|
+
* </li>
|
|
223
|
+
* <li>
|
|
224
|
+
* <p>
|
|
225
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
226
|
+
* </p>
|
|
227
|
+
* </li>
|
|
228
|
+
* <li>
|
|
229
|
+
* <p>
|
|
230
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
231
|
+
* </p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p>
|
|
235
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
236
|
+
* </p>
|
|
237
|
+
* </li>
|
|
238
|
+
* <li>
|
|
239
|
+
* <p>
|
|
240
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
241
|
+
* </p>
|
|
242
|
+
* </li>
|
|
243
|
+
* </ul>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
export interface Function {
|
|
247
|
+
/**
|
|
248
|
+
* <p>A name for the function.</p>
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
name: string | undefined;
|
|
252
|
+
/**
|
|
253
|
+
* <p>A description of the function and its purpose.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
description?: string;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The parameters that the agent elicits from the user to fulfill the function.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
parameters?: Record<string, ParameterDetail>;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
|
|
265
|
+
* <p>This data type is used in the following API operations:</p>
|
|
266
|
+
* <ul>
|
|
267
|
+
* <li>
|
|
268
|
+
* <p>
|
|
269
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
|
|
270
|
+
* </p>
|
|
271
|
+
* </li>
|
|
272
|
+
* <li>
|
|
273
|
+
* <p>
|
|
274
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
|
|
275
|
+
* </p>
|
|
276
|
+
* </li>
|
|
277
|
+
* <li>
|
|
278
|
+
* <p>
|
|
279
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
|
|
280
|
+
* </p>
|
|
281
|
+
* </li>
|
|
282
|
+
* <li>
|
|
283
|
+
* <p>
|
|
284
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
|
|
285
|
+
* </p>
|
|
286
|
+
* </li>
|
|
287
|
+
* <li>
|
|
288
|
+
* <p>
|
|
289
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
|
|
290
|
+
* </p>
|
|
291
|
+
* </li>
|
|
292
|
+
* </ul>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$UnknownMember;
|
|
296
|
+
/**
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
export declare namespace FunctionSchema {
|
|
300
|
+
/**
|
|
301
|
+
* <p>A list of functions that each define an action in the action group.</p>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
interface FunctionsMember {
|
|
305
|
+
functions: Function[];
|
|
306
|
+
$unknown?: never;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
interface $UnknownMember {
|
|
312
|
+
functions?: never;
|
|
313
|
+
$unknown: [string, any];
|
|
314
|
+
}
|
|
315
|
+
interface Visitor<T> {
|
|
316
|
+
functions: (value: Function[]) => T;
|
|
317
|
+
_: (name: string, value: any) => T;
|
|
318
|
+
}
|
|
319
|
+
const visit: <T>(value: FunctionSchema, visitor: Visitor<T>) => T;
|
|
320
|
+
}
|
|
127
321
|
/**
|
|
128
322
|
* @public
|
|
129
323
|
* @enum
|
|
@@ -172,7 +366,7 @@ export interface CreateAgentActionGroupRequest {
|
|
|
172
366
|
*/
|
|
173
367
|
parentActionGroupSignature?: ActionGroupSignature;
|
|
174
368
|
/**
|
|
175
|
-
* <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
369
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
176
370
|
* @public
|
|
177
371
|
*/
|
|
178
372
|
actionGroupExecutor?: ActionGroupExecutor;
|
|
@@ -186,6 +380,11 @@ export interface CreateAgentActionGroupRequest {
|
|
|
186
380
|
* @public
|
|
187
381
|
*/
|
|
188
382
|
actionGroupState?: ActionGroupState;
|
|
383
|
+
/**
|
|
384
|
+
* <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
functionSchema?: FunctionSchema;
|
|
189
388
|
}
|
|
190
389
|
/**
|
|
191
390
|
* <p>Contains details about an action group.</p>
|
|
@@ -240,7 +439,7 @@ export interface AgentActionGroup {
|
|
|
240
439
|
*/
|
|
241
440
|
parentActionSignature?: ActionGroupSignature;
|
|
242
441
|
/**
|
|
243
|
-
* <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
442
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
244
443
|
* @public
|
|
245
444
|
*/
|
|
246
445
|
actionGroupExecutor?: ActionGroupExecutor;
|
|
@@ -249,6 +448,11 @@ export interface AgentActionGroup {
|
|
|
249
448
|
* @public
|
|
250
449
|
*/
|
|
251
450
|
apiSchema?: APISchema;
|
|
451
|
+
/**
|
|
452
|
+
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
functionSchema?: FunctionSchema;
|
|
252
456
|
/**
|
|
253
457
|
* <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
254
458
|
* @public
|
|
@@ -278,7 +482,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
278
482
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
279
483
|
}
|
|
280
484
|
/**
|
|
281
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
485
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
282
486
|
* @public
|
|
283
487
|
*/
|
|
284
488
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -515,7 +719,7 @@ export interface UpdateAgentActionGroupRequest {
|
|
|
515
719
|
*/
|
|
516
720
|
parentActionGroupSignature?: ActionGroupSignature;
|
|
517
721
|
/**
|
|
518
|
-
* <p>The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
722
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
519
723
|
* @public
|
|
520
724
|
*/
|
|
521
725
|
actionGroupExecutor?: ActionGroupExecutor;
|
|
@@ -529,6 +733,11 @@ export interface UpdateAgentActionGroupRequest {
|
|
|
529
733
|
* @public
|
|
530
734
|
*/
|
|
531
735
|
apiSchema?: APISchema;
|
|
736
|
+
/**
|
|
737
|
+
* <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
functionSchema?: FunctionSchema;
|
|
532
741
|
}
|
|
533
742
|
/**
|
|
534
743
|
* @public
|
|
@@ -717,7 +926,7 @@ export interface Agent {
|
|
|
717
926
|
*/
|
|
718
927
|
agentName: string | undefined;
|
|
719
928
|
/**
|
|
720
|
-
* <p>The ARN of the agent.</p>
|
|
929
|
+
* <p>The Amazon Resource Name (ARN) of the agent.</p>
|
|
721
930
|
* @public
|
|
722
931
|
*/
|
|
723
932
|
agentArn: string | undefined;
|
|
@@ -782,12 +991,12 @@ export interface Agent {
|
|
|
782
991
|
*/
|
|
783
992
|
idleSessionTTLInSeconds: number | undefined;
|
|
784
993
|
/**
|
|
785
|
-
* <p>The ARN of the IAM role with permissions to
|
|
994
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
786
995
|
* @public
|
|
787
996
|
*/
|
|
788
997
|
agentResourceRoleArn: string | undefined;
|
|
789
998
|
/**
|
|
790
|
-
* <p>The ARN of the KMS key that encrypts the agent.</p>
|
|
999
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.</p>
|
|
791
1000
|
* @public
|
|
792
1001
|
*/
|
|
793
1002
|
customerEncryptionKeyArn?: string;
|
|
@@ -890,7 +1099,7 @@ export interface AgentAlias {
|
|
|
890
1099
|
*/
|
|
891
1100
|
agentAliasName: string | undefined;
|
|
892
1101
|
/**
|
|
893
|
-
* <p>The ARN of the alias of the agent.</p>
|
|
1102
|
+
* <p>The Amazon Resource Name (ARN) of the alias of the agent.</p>
|
|
894
1103
|
* @public
|
|
895
1104
|
*/
|
|
896
1105
|
agentAliasArn: string | undefined;
|
|
@@ -1105,12 +1314,12 @@ export interface CreateAgentRequest {
|
|
|
1105
1314
|
*/
|
|
1106
1315
|
idleSessionTTLInSeconds?: number;
|
|
1107
1316
|
/**
|
|
1108
|
-
* <p>The ARN of the IAM role with permissions to
|
|
1317
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
1109
1318
|
* @public
|
|
1110
1319
|
*/
|
|
1111
|
-
agentResourceRoleArn
|
|
1320
|
+
agentResourceRoleArn?: string;
|
|
1112
1321
|
/**
|
|
1113
|
-
* <p>The ARN of the KMS key with which to encrypt the agent.</p>
|
|
1322
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</p>
|
|
1114
1323
|
* @public
|
|
1115
1324
|
*/
|
|
1116
1325
|
customerEncryptionKeyArn?: string;
|
|
@@ -1322,12 +1531,12 @@ export interface UpdateAgentRequest {
|
|
|
1322
1531
|
*/
|
|
1323
1532
|
idleSessionTTLInSeconds?: number;
|
|
1324
1533
|
/**
|
|
1325
|
-
* <p>The ARN of the IAM role with permissions to
|
|
1534
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
1326
1535
|
* @public
|
|
1327
1536
|
*/
|
|
1328
1537
|
agentResourceRoleArn: string | undefined;
|
|
1329
1538
|
/**
|
|
1330
|
-
* <p>The ARN of the KMS key with which to encrypt the agent.</p>
|
|
1539
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</p>
|
|
1331
1540
|
* @public
|
|
1332
1541
|
*/
|
|
1333
1542
|
customerEncryptionKeyArn?: string;
|
|
@@ -1363,7 +1572,7 @@ export interface AgentVersion {
|
|
|
1363
1572
|
*/
|
|
1364
1573
|
agentName: string | undefined;
|
|
1365
1574
|
/**
|
|
1366
|
-
* <p>The ARN of the agent that the version belongs to.</p>
|
|
1575
|
+
* <p>The Amazon Resource Name (ARN) of the agent that the version belongs to.</p>
|
|
1367
1576
|
* @public
|
|
1368
1577
|
*/
|
|
1369
1578
|
agentArn: string | undefined;
|
|
@@ -1399,12 +1608,12 @@ export interface AgentVersion {
|
|
|
1399
1608
|
*/
|
|
1400
1609
|
idleSessionTTLInSeconds: number | undefined;
|
|
1401
1610
|
/**
|
|
1402
|
-
* <p>The ARN of the IAM role with permissions to invoke API operations on the agent
|
|
1611
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
1403
1612
|
* @public
|
|
1404
1613
|
*/
|
|
1405
1614
|
agentResourceRoleArn: string | undefined;
|
|
1406
1615
|
/**
|
|
1407
|
-
* <p>The ARN of the KMS key that encrypts the agent.</p>
|
|
1616
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.</p>
|
|
1408
1617
|
* @public
|
|
1409
1618
|
*/
|
|
1410
1619
|
customerEncryptionKeyArn?: string;
|
|
@@ -1657,7 +1866,7 @@ export interface UpdateAgentAliasResponse {
|
|
|
1657
1866
|
*/
|
|
1658
1867
|
export interface S3DataSourceConfiguration {
|
|
1659
1868
|
/**
|
|
1660
|
-
* <p>The ARN of the bucket that contains the data source.</p>
|
|
1869
|
+
* <p>The Amazon Resource Name (ARN) of the bucket that contains the data source.</p>
|
|
1661
1870
|
* @public
|
|
1662
1871
|
*/
|
|
1663
1872
|
bucketArn: string | undefined;
|
|
@@ -1700,7 +1909,7 @@ export interface DataSourceConfiguration {
|
|
|
1700
1909
|
*/
|
|
1701
1910
|
export interface ServerSideEncryptionConfiguration {
|
|
1702
1911
|
/**
|
|
1703
|
-
* <p>The ARN of the KMS key used to encrypt the resource.</p>
|
|
1912
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.</p>
|
|
1704
1913
|
* @public
|
|
1705
1914
|
*/
|
|
1706
1915
|
kmsKeyArn?: string;
|
|
@@ -2169,7 +2378,7 @@ export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof Ingest
|
|
|
2169
2378
|
* </li>
|
|
2170
2379
|
* <li>
|
|
2171
2380
|
* <p>
|
|
2172
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/
|
|
2381
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a>
|
|
2173
2382
|
* </p>
|
|
2174
2383
|
* </li>
|
|
2175
2384
|
* </ul>
|
|
@@ -2504,7 +2713,7 @@ export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof Knowledg
|
|
|
2504
2713
|
*/
|
|
2505
2714
|
export interface VectorKnowledgeBaseConfiguration {
|
|
2506
2715
|
/**
|
|
2507
|
-
* <p>The ARN of the model used to create vector embeddings for the knowledge base.</p>
|
|
2716
|
+
* <p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>
|
|
2508
2717
|
* @public
|
|
2509
2718
|
*/
|
|
2510
2719
|
embeddingModelArn: string | undefined;
|
|
@@ -2552,7 +2761,7 @@ export interface OpenSearchServerlessFieldMapping {
|
|
|
2552
2761
|
*/
|
|
2553
2762
|
export interface OpenSearchServerlessConfiguration {
|
|
2554
2763
|
/**
|
|
2555
|
-
* <p>The ARN of the OpenSearch Service vector store.</p>
|
|
2764
|
+
* <p>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</p>
|
|
2556
2765
|
* @public
|
|
2557
2766
|
*/
|
|
2558
2767
|
collectionArn: string | undefined;
|
|
@@ -2594,7 +2803,7 @@ export interface PineconeConfiguration {
|
|
|
2594
2803
|
*/
|
|
2595
2804
|
connectionString: string | undefined;
|
|
2596
2805
|
/**
|
|
2597
|
-
* <p>The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
|
|
2806
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
|
|
2598
2807
|
* @public
|
|
2599
2808
|
*/
|
|
2600
2809
|
credentialsSecretArn: string | undefined;
|
|
@@ -2641,12 +2850,12 @@ export interface RdsFieldMapping {
|
|
|
2641
2850
|
*/
|
|
2642
2851
|
export interface RdsConfiguration {
|
|
2643
2852
|
/**
|
|
2644
|
-
* <p>The ARN of the vector store.</p>
|
|
2853
|
+
* <p>The Amazon Resource Name (ARN) of the vector store.</p>
|
|
2645
2854
|
* @public
|
|
2646
2855
|
*/
|
|
2647
2856
|
resourceArn: string | undefined;
|
|
2648
2857
|
/**
|
|
2649
|
-
* <p>The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
|
|
2858
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
|
|
2650
2859
|
* @public
|
|
2651
2860
|
*/
|
|
2652
2861
|
credentialsSecretArn: string | undefined;
|
|
@@ -2703,7 +2912,7 @@ export interface RedisEnterpriseCloudConfiguration {
|
|
|
2703
2912
|
*/
|
|
2704
2913
|
vectorIndexName: string | undefined;
|
|
2705
2914
|
/**
|
|
2706
|
-
* <p>The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
|
|
2915
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
|
|
2707
2916
|
* @public
|
|
2708
2917
|
*/
|
|
2709
2918
|
credentialsSecretArn: string | undefined;
|
|
@@ -2779,7 +2988,7 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
2779
2988
|
*/
|
|
2780
2989
|
description?: string;
|
|
2781
2990
|
/**
|
|
2782
|
-
* <p>The ARN of the IAM role with permissions to
|
|
2991
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
2783
2992
|
* @public
|
|
2784
2993
|
*/
|
|
2785
2994
|
roleArn: string | undefined;
|
|
@@ -2830,7 +3039,7 @@ export interface KnowledgeBase {
|
|
|
2830
3039
|
*/
|
|
2831
3040
|
name: string | undefined;
|
|
2832
3041
|
/**
|
|
2833
|
-
* <p>The ARN of the knowledge base.</p>
|
|
3042
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2834
3043
|
* @public
|
|
2835
3044
|
*/
|
|
2836
3045
|
knowledgeBaseArn: string | undefined;
|
|
@@ -2840,7 +3049,7 @@ export interface KnowledgeBase {
|
|
|
2840
3049
|
*/
|
|
2841
3050
|
description?: string;
|
|
2842
3051
|
/**
|
|
2843
|
-
* <p>The ARN of the IAM role with permissions to invoke API operations on the knowledge base
|
|
3052
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
2844
3053
|
* @public
|
|
2845
3054
|
*/
|
|
2846
3055
|
roleArn: string | undefined;
|
|
@@ -3163,7 +3372,7 @@ export interface UpdateKnowledgeBaseRequest {
|
|
|
3163
3372
|
*/
|
|
3164
3373
|
description?: string;
|
|
3165
3374
|
/**
|
|
3166
|
-
* <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to
|
|
3375
|
+
* <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
3167
3376
|
* @public
|
|
3168
3377
|
*/
|
|
3169
3378
|
roleArn: string | undefined;
|
|
@@ -3193,7 +3402,7 @@ export interface UpdateKnowledgeBaseResponse {
|
|
|
3193
3402
|
*/
|
|
3194
3403
|
export interface ListTagsForResourceRequest {
|
|
3195
3404
|
/**
|
|
3196
|
-
* <p>The ARN of the resource for which to list tags.</p>
|
|
3405
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
|
|
3197
3406
|
* @public
|
|
3198
3407
|
*/
|
|
3199
3408
|
resourceArn: string | undefined;
|
|
@@ -3213,7 +3422,7 @@ export interface ListTagsForResourceResponse {
|
|
|
3213
3422
|
*/
|
|
3214
3423
|
export interface TagResourceRequest {
|
|
3215
3424
|
/**
|
|
3216
|
-
* <p>The ARN of the resource to tag.</p>
|
|
3425
|
+
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
3217
3426
|
* @public
|
|
3218
3427
|
*/
|
|
3219
3428
|
resourceArn: string | undefined;
|
|
@@ -3233,7 +3442,7 @@ export interface TagResourceResponse {
|
|
|
3233
3442
|
*/
|
|
3234
3443
|
export interface UntagResourceRequest {
|
|
3235
3444
|
/**
|
|
3236
|
-
* <p>The ARN of the resource from which to remove tags.</p>
|
|
3445
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
|
|
3237
3446
|
* @public
|
|
3238
3447
|
*/
|
|
3239
3448
|
resourceArn: string | undefined;
|