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