@aws-sdk/client-bedrock-agent 3.933.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +373 -373
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +372 -0
- package/dist-es/models/errors.js +87 -0
- package/dist-es/models/models_0.js +1 -347
- package/dist-es/models/models_1.js +1 -112
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/GetIngestionJobCommand.d.ts +1 -2
- package/dist-types/commands/GetKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/StartIngestionJobCommand.d.ts +1 -1
- package/dist-types/commands/StopIngestionJobCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +938 -0
- package/dist-types/models/errors.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +1045 -742
- package/dist-types/models/models_1.d.ts +2 -1332
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIngestionJobCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIngestionJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartIngestionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopIngestionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +501 -0
- package/dist-types/ts3.4/models/errors.d.ts +51 -0
- package/dist-types/ts3.4/models/models_0.d.ts +330 -396
- package/dist-types/ts3.4/models/models_1.d.ts +14 -424
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,1302 +1,6 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
* @public
|
|
5
|
-
* @enum
|
|
6
|
-
*/
|
|
7
|
-
export declare const IngestionJobStatus: {
|
|
8
|
-
readonly COMPLETE: "COMPLETE";
|
|
9
|
-
readonly FAILED: "FAILED";
|
|
10
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
11
|
-
readonly STARTING: "STARTING";
|
|
12
|
-
readonly STOPPED: "STOPPED";
|
|
13
|
-
readonly STOPPING: "STOPPING";
|
|
14
|
-
};
|
|
15
|
-
/**
|
|
16
|
-
* @public
|
|
17
|
-
*/
|
|
18
|
-
export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus];
|
|
19
|
-
/**
|
|
20
|
-
* <p>Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax">StartIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax">GetIngestionJob response</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a> </p> </li> </ul>
|
|
21
|
-
* @public
|
|
22
|
-
*/
|
|
23
|
-
export interface IngestionJob {
|
|
24
|
-
/**
|
|
25
|
-
* <p>The unique identifier of the knowledge for the data ingestion job.</p>
|
|
26
|
-
* @public
|
|
27
|
-
*/
|
|
28
|
-
knowledgeBaseId: string | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* <p>The unique identifier of the data source for the data ingestion job.</p>
|
|
31
|
-
* @public
|
|
32
|
-
*/
|
|
33
|
-
dataSourceId: string | undefined;
|
|
34
|
-
/**
|
|
35
|
-
* <p>The unique identifier of the data ingestion job.</p>
|
|
36
|
-
* @public
|
|
37
|
-
*/
|
|
38
|
-
ingestionJobId: string | undefined;
|
|
39
|
-
/**
|
|
40
|
-
* <p>The description of the data ingestion job.</p>
|
|
41
|
-
* @public
|
|
42
|
-
*/
|
|
43
|
-
description?: string | undefined;
|
|
44
|
-
/**
|
|
45
|
-
* <p>The status of the data ingestion job.</p>
|
|
46
|
-
* @public
|
|
47
|
-
*/
|
|
48
|
-
status: IngestionJobStatus | undefined;
|
|
49
|
-
/**
|
|
50
|
-
* <p>Contains statistics about the data ingestion job.</p>
|
|
51
|
-
* @public
|
|
52
|
-
*/
|
|
53
|
-
statistics?: IngestionJobStatistics | undefined;
|
|
54
|
-
/**
|
|
55
|
-
* <p>A list of reasons that the data ingestion job failed.</p>
|
|
56
|
-
* @public
|
|
57
|
-
*/
|
|
58
|
-
failureReasons?: string[] | undefined;
|
|
59
|
-
/**
|
|
60
|
-
* <p>The time the data ingestion job started.</p> <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>
|
|
61
|
-
* @public
|
|
62
|
-
*/
|
|
63
|
-
startedAt: Date | undefined;
|
|
64
|
-
/**
|
|
65
|
-
* <p>The time the data ingestion job was last updated.</p> <p>If you stop a data ingestion job, the <code>updatedAt</code> time is the time the job was stopped.</p>
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
updatedAt: Date | undefined;
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* @public
|
|
72
|
-
*/
|
|
73
|
-
export interface GetIngestionJobResponse {
|
|
74
|
-
/**
|
|
75
|
-
* <p>Contains details about the data ingestion job.</p>
|
|
76
|
-
* @public
|
|
77
|
-
*/
|
|
78
|
-
ingestionJob: IngestionJob | undefined;
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* @public
|
|
82
|
-
* @enum
|
|
83
|
-
*/
|
|
84
|
-
export declare const IngestionJobFilterAttribute: {
|
|
85
|
-
readonly STATUS: "STATUS";
|
|
86
|
-
};
|
|
87
|
-
/**
|
|
88
|
-
* @public
|
|
89
|
-
*/
|
|
90
|
-
export type IngestionJobFilterAttribute = (typeof IngestionJobFilterAttribute)[keyof typeof IngestionJobFilterAttribute];
|
|
91
|
-
/**
|
|
92
|
-
* @public
|
|
93
|
-
* @enum
|
|
94
|
-
*/
|
|
95
|
-
export declare const IngestionJobFilterOperator: {
|
|
96
|
-
readonly EQ: "EQ";
|
|
97
|
-
};
|
|
98
|
-
/**
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator];
|
|
102
|
-
/**
|
|
103
|
-
* <p>The definition of a filter to filter the data.</p>
|
|
104
|
-
* @public
|
|
105
|
-
*/
|
|
106
|
-
export interface IngestionJobFilter {
|
|
107
|
-
/**
|
|
108
|
-
* <p>The name of field or attribute to apply the filter.</p>
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
attribute: IngestionJobFilterAttribute | undefined;
|
|
112
|
-
/**
|
|
113
|
-
* <p>The operation to apply to the field or attribute.</p>
|
|
114
|
-
* @public
|
|
115
|
-
*/
|
|
116
|
-
operator: IngestionJobFilterOperator | undefined;
|
|
117
|
-
/**
|
|
118
|
-
* <p>A list of values that belong to the field or attribute.</p>
|
|
119
|
-
* @public
|
|
120
|
-
*/
|
|
121
|
-
values: string[] | undefined;
|
|
122
|
-
}
|
|
123
|
-
/**
|
|
124
|
-
* @public
|
|
125
|
-
* @enum
|
|
126
|
-
*/
|
|
127
|
-
export declare const IngestionJobSortByAttribute: {
|
|
128
|
-
readonly STARTED_AT: "STARTED_AT";
|
|
129
|
-
readonly STATUS: "STATUS";
|
|
130
|
-
};
|
|
131
|
-
/**
|
|
132
|
-
* @public
|
|
133
|
-
*/
|
|
134
|
-
export type IngestionJobSortByAttribute = (typeof IngestionJobSortByAttribute)[keyof typeof IngestionJobSortByAttribute];
|
|
135
|
-
/**
|
|
136
|
-
* @public
|
|
137
|
-
* @enum
|
|
138
|
-
*/
|
|
139
|
-
export declare const SortOrder: {
|
|
140
|
-
readonly ASCENDING: "ASCENDING";
|
|
141
|
-
readonly DESCENDING: "DESCENDING";
|
|
142
|
-
};
|
|
143
|
-
/**
|
|
144
|
-
* @public
|
|
145
|
-
*/
|
|
146
|
-
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
147
|
-
/**
|
|
148
|
-
* <p>The parameters of sorting the data.</p>
|
|
149
|
-
* @public
|
|
150
|
-
*/
|
|
151
|
-
export interface IngestionJobSortBy {
|
|
152
|
-
/**
|
|
153
|
-
* <p>The name of field or attribute to apply sorting of data.</p>
|
|
154
|
-
* @public
|
|
155
|
-
*/
|
|
156
|
-
attribute: IngestionJobSortByAttribute | undefined;
|
|
157
|
-
/**
|
|
158
|
-
* <p>The order for sorting the data.</p>
|
|
159
|
-
* @public
|
|
160
|
-
*/
|
|
161
|
-
order: SortOrder | undefined;
|
|
162
|
-
}
|
|
163
|
-
/**
|
|
164
|
-
* @public
|
|
165
|
-
*/
|
|
166
|
-
export interface ListIngestionJobsRequest {
|
|
167
|
-
/**
|
|
168
|
-
* <p>The unique identifier of the knowledge base for the list of data ingestion jobs.</p>
|
|
169
|
-
* @public
|
|
170
|
-
*/
|
|
171
|
-
knowledgeBaseId: string | undefined;
|
|
172
|
-
/**
|
|
173
|
-
* <p>The unique identifier of the data source for the list of data ingestion jobs.</p>
|
|
174
|
-
* @public
|
|
175
|
-
*/
|
|
176
|
-
dataSourceId: string | undefined;
|
|
177
|
-
/**
|
|
178
|
-
* <p>Contains information about the filters for filtering the data.</p>
|
|
179
|
-
* @public
|
|
180
|
-
*/
|
|
181
|
-
filters?: IngestionJobFilter[] | undefined;
|
|
182
|
-
/**
|
|
183
|
-
* <p>Contains details about how to sort the data.</p>
|
|
184
|
-
* @public
|
|
185
|
-
*/
|
|
186
|
-
sortBy?: IngestionJobSortBy | undefined;
|
|
187
|
-
/**
|
|
188
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
189
|
-
* @public
|
|
190
|
-
*/
|
|
191
|
-
maxResults?: number | undefined;
|
|
192
|
-
/**
|
|
193
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
194
|
-
* @public
|
|
195
|
-
*/
|
|
196
|
-
nextToken?: string | undefined;
|
|
197
|
-
}
|
|
198
|
-
/**
|
|
199
|
-
* <p>Contains details about a data ingestion job.</p>
|
|
200
|
-
* @public
|
|
201
|
-
*/
|
|
202
|
-
export interface IngestionJobSummary {
|
|
203
|
-
/**
|
|
204
|
-
* <p>The unique identifier of the knowledge base for the data ingestion job.</p>
|
|
205
|
-
* @public
|
|
206
|
-
*/
|
|
207
|
-
knowledgeBaseId: string | undefined;
|
|
208
|
-
/**
|
|
209
|
-
* <p>The unique identifier of the data source for the data ingestion job.</p>
|
|
210
|
-
* @public
|
|
211
|
-
*/
|
|
212
|
-
dataSourceId: string | undefined;
|
|
213
|
-
/**
|
|
214
|
-
* <p>The unique identifier of the data ingestion job.</p>
|
|
215
|
-
* @public
|
|
216
|
-
*/
|
|
217
|
-
ingestionJobId: string | undefined;
|
|
218
|
-
/**
|
|
219
|
-
* <p>The description of the data ingestion job.</p>
|
|
220
|
-
* @public
|
|
221
|
-
*/
|
|
222
|
-
description?: string | undefined;
|
|
223
|
-
/**
|
|
224
|
-
* <p>The status of the data ingestion job.</p>
|
|
225
|
-
* @public
|
|
226
|
-
*/
|
|
227
|
-
status: IngestionJobStatus | undefined;
|
|
228
|
-
/**
|
|
229
|
-
* <p>The time the data ingestion job started.</p>
|
|
230
|
-
* @public
|
|
231
|
-
*/
|
|
232
|
-
startedAt: Date | undefined;
|
|
233
|
-
/**
|
|
234
|
-
* <p>The time the data ingestion job was last updated.</p>
|
|
235
|
-
* @public
|
|
236
|
-
*/
|
|
237
|
-
updatedAt: Date | undefined;
|
|
238
|
-
/**
|
|
239
|
-
* <p>Contains statistics for the data ingestion job.</p>
|
|
240
|
-
* @public
|
|
241
|
-
*/
|
|
242
|
-
statistics?: IngestionJobStatistics | undefined;
|
|
243
|
-
}
|
|
244
|
-
/**
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
export interface ListIngestionJobsResponse {
|
|
248
|
-
/**
|
|
249
|
-
* <p>A list of data ingestion jobs with information about each job.</p>
|
|
250
|
-
* @public
|
|
251
|
-
*/
|
|
252
|
-
ingestionJobSummaries: IngestionJobSummary[] | undefined;
|
|
253
|
-
/**
|
|
254
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
255
|
-
* @public
|
|
256
|
-
*/
|
|
257
|
-
nextToken?: string | undefined;
|
|
258
|
-
}
|
|
259
|
-
/**
|
|
260
|
-
* @public
|
|
261
|
-
*/
|
|
262
|
-
export interface StartIngestionJobRequest {
|
|
263
|
-
/**
|
|
264
|
-
* <p>The unique identifier of the knowledge base for the data ingestion job.</p>
|
|
265
|
-
* @public
|
|
266
|
-
*/
|
|
267
|
-
knowledgeBaseId: string | undefined;
|
|
268
|
-
/**
|
|
269
|
-
* <p>The unique identifier of the data source you want to ingest into your knowledge base.</p>
|
|
270
|
-
* @public
|
|
271
|
-
*/
|
|
272
|
-
dataSourceId: string | undefined;
|
|
273
|
-
/**
|
|
274
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
275
|
-
* @public
|
|
276
|
-
*/
|
|
277
|
-
clientToken?: string | undefined;
|
|
278
|
-
/**
|
|
279
|
-
* <p>A description of the data ingestion job.</p>
|
|
280
|
-
* @public
|
|
281
|
-
*/
|
|
282
|
-
description?: string | undefined;
|
|
283
|
-
}
|
|
284
|
-
/**
|
|
285
|
-
* @public
|
|
286
|
-
*/
|
|
287
|
-
export interface StartIngestionJobResponse {
|
|
288
|
-
/**
|
|
289
|
-
* <p>Contains information about the data ingestion job.</p>
|
|
290
|
-
* @public
|
|
291
|
-
*/
|
|
292
|
-
ingestionJob: IngestionJob | undefined;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* @public
|
|
296
|
-
*/
|
|
297
|
-
export interface StopIngestionJobRequest {
|
|
298
|
-
/**
|
|
299
|
-
* <p>The unique identifier of the knowledge base for the data ingestion job you want to stop.</p>
|
|
300
|
-
* @public
|
|
301
|
-
*/
|
|
302
|
-
knowledgeBaseId: string | undefined;
|
|
303
|
-
/**
|
|
304
|
-
* <p>The unique identifier of the data source for the data ingestion job you want to stop.</p>
|
|
305
|
-
* @public
|
|
306
|
-
*/
|
|
307
|
-
dataSourceId: string | undefined;
|
|
308
|
-
/**
|
|
309
|
-
* <p>The unique identifier of the data ingestion job you want to stop.</p>
|
|
310
|
-
* @public
|
|
311
|
-
*/
|
|
312
|
-
ingestionJobId: string | undefined;
|
|
313
|
-
}
|
|
314
|
-
/**
|
|
315
|
-
* @public
|
|
316
|
-
*/
|
|
317
|
-
export interface StopIngestionJobResponse {
|
|
318
|
-
/**
|
|
319
|
-
* <p>Contains information about the stopped data ingestion job.</p>
|
|
320
|
-
* @public
|
|
321
|
-
*/
|
|
322
|
-
ingestionJob: IngestionJob | undefined;
|
|
323
|
-
}
|
|
324
|
-
/**
|
|
325
|
-
* <p>Contains information about the identifier of the document to ingest into a custom data source.</p>
|
|
326
|
-
* @public
|
|
327
|
-
*/
|
|
328
|
-
export interface CustomDocumentIdentifier {
|
|
329
|
-
/**
|
|
330
|
-
* <p>The identifier of the document to ingest into a custom data source.</p>
|
|
331
|
-
* @public
|
|
332
|
-
*/
|
|
333
|
-
id: string | undefined;
|
|
334
|
-
}
|
|
335
|
-
/**
|
|
336
|
-
* @public
|
|
337
|
-
* @enum
|
|
338
|
-
*/
|
|
339
|
-
export declare const ContentDataSourceType: {
|
|
340
|
-
readonly CUSTOM: "CUSTOM";
|
|
341
|
-
readonly S3: "S3";
|
|
342
|
-
};
|
|
343
|
-
/**
|
|
344
|
-
* @public
|
|
345
|
-
*/
|
|
346
|
-
export type ContentDataSourceType = (typeof ContentDataSourceType)[keyof typeof ContentDataSourceType];
|
|
347
|
-
/**
|
|
348
|
-
* <p>Contains information that identifies the document.</p>
|
|
349
|
-
* @public
|
|
350
|
-
*/
|
|
351
|
-
export interface DocumentIdentifier {
|
|
352
|
-
/**
|
|
353
|
-
* <p>The type of data source connected to the knowledge base that contains the document.</p>
|
|
354
|
-
* @public
|
|
355
|
-
*/
|
|
356
|
-
dataSourceType: ContentDataSourceType | undefined;
|
|
357
|
-
/**
|
|
358
|
-
* <p>Contains information that identifies the document in an S3 data source.</p>
|
|
359
|
-
* @public
|
|
360
|
-
*/
|
|
361
|
-
s3?: S3Location | undefined;
|
|
362
|
-
/**
|
|
363
|
-
* <p>Contains information that identifies the document in a custom data source.</p>
|
|
364
|
-
* @public
|
|
365
|
-
*/
|
|
366
|
-
custom?: CustomDocumentIdentifier | undefined;
|
|
367
|
-
}
|
|
368
|
-
/**
|
|
369
|
-
* @public
|
|
370
|
-
*/
|
|
371
|
-
export interface DeleteKnowledgeBaseDocumentsRequest {
|
|
372
|
-
/**
|
|
373
|
-
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
374
|
-
* @public
|
|
375
|
-
*/
|
|
376
|
-
knowledgeBaseId: string | undefined;
|
|
377
|
-
/**
|
|
378
|
-
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
379
|
-
* @public
|
|
380
|
-
*/
|
|
381
|
-
dataSourceId: string | undefined;
|
|
382
|
-
/**
|
|
383
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
384
|
-
* @public
|
|
385
|
-
*/
|
|
386
|
-
clientToken?: string | undefined;
|
|
387
|
-
/**
|
|
388
|
-
* <p>A list of objects, each of which contains information to identify a document to delete.</p>
|
|
389
|
-
* @public
|
|
390
|
-
*/
|
|
391
|
-
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
392
|
-
}
|
|
393
|
-
/**
|
|
394
|
-
* @public
|
|
395
|
-
* @enum
|
|
396
|
-
*/
|
|
397
|
-
export declare const DocumentStatus: {
|
|
398
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
399
|
-
readonly DELETING: "DELETING";
|
|
400
|
-
readonly FAILED: "FAILED";
|
|
401
|
-
readonly IGNORED: "IGNORED";
|
|
402
|
-
readonly INDEXED: "INDEXED";
|
|
403
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
404
|
-
readonly METADATA_PARTIALLY_INDEXED: "METADATA_PARTIALLY_INDEXED";
|
|
405
|
-
readonly METADATA_UPDATE_FAILED: "METADATA_UPDATE_FAILED";
|
|
406
|
-
readonly NOT_FOUND: "NOT_FOUND";
|
|
407
|
-
readonly PARTIALLY_INDEXED: "PARTIALLY_INDEXED";
|
|
408
|
-
readonly PENDING: "PENDING";
|
|
409
|
-
readonly STARTING: "STARTING";
|
|
410
|
-
};
|
|
411
|
-
/**
|
|
412
|
-
* @public
|
|
413
|
-
*/
|
|
414
|
-
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
415
|
-
/**
|
|
416
|
-
* <p>Contains the details for a document that was ingested or deleted.</p>
|
|
417
|
-
* @public
|
|
418
|
-
*/
|
|
419
|
-
export interface KnowledgeBaseDocumentDetail {
|
|
420
|
-
/**
|
|
421
|
-
* <p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>
|
|
422
|
-
* @public
|
|
423
|
-
*/
|
|
424
|
-
knowledgeBaseId: string | undefined;
|
|
425
|
-
/**
|
|
426
|
-
* <p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>
|
|
427
|
-
* @public
|
|
428
|
-
*/
|
|
429
|
-
dataSourceId: string | undefined;
|
|
430
|
-
/**
|
|
431
|
-
* <p>The ingestion status of the document. The following statuses are possible:</p> <ul> <li> <p>STARTED – You submitted the ingestion job containing the document.</p> </li> <li> <p>PENDING – The document is waiting to be ingested.</p> </li> <li> <p>IN_PROGRESS – The document is being ingested.</p> </li> <li> <p>INDEXED – The document was successfully indexed.</p> </li> <li> <p>PARTIALLY_INDEXED – The document was partially indexed.</p> </li> <li> <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p> </li> <li> <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p> </li> <li> <p>FAILED – The document failed to be ingested.</p> </li> <li> <p>NOT_FOUND – The document wasn't found.</p> </li> <li> <p>IGNORED – The document was ignored during ingestion.</p> </li> <li> <p>DELETING – You submitted the delete job containing the document.</p> </li> <li> <p>DELETE_IN_PROGRESS – The document is being deleted.</p> </li> </ul>
|
|
432
|
-
* @public
|
|
433
|
-
*/
|
|
434
|
-
status: DocumentStatus | undefined;
|
|
435
|
-
/**
|
|
436
|
-
* <p>Contains information that identifies the document.</p>
|
|
437
|
-
* @public
|
|
438
|
-
*/
|
|
439
|
-
identifier: DocumentIdentifier | undefined;
|
|
440
|
-
/**
|
|
441
|
-
* <p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>
|
|
442
|
-
* @public
|
|
443
|
-
*/
|
|
444
|
-
statusReason?: string | undefined;
|
|
445
|
-
/**
|
|
446
|
-
* <p>The date and time at which the document was last updated.</p>
|
|
447
|
-
* @public
|
|
448
|
-
*/
|
|
449
|
-
updatedAt?: Date | undefined;
|
|
450
|
-
}
|
|
451
|
-
/**
|
|
452
|
-
* @public
|
|
453
|
-
*/
|
|
454
|
-
export interface DeleteKnowledgeBaseDocumentsResponse {
|
|
455
|
-
/**
|
|
456
|
-
* <p>A list of objects, each of which contains information about the documents that were deleted.</p>
|
|
457
|
-
* @public
|
|
458
|
-
*/
|
|
459
|
-
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
460
|
-
}
|
|
461
|
-
/**
|
|
462
|
-
* @public
|
|
463
|
-
*/
|
|
464
|
-
export interface GetKnowledgeBaseDocumentsRequest {
|
|
465
|
-
/**
|
|
466
|
-
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
467
|
-
* @public
|
|
468
|
-
*/
|
|
469
|
-
knowledgeBaseId: string | undefined;
|
|
470
|
-
/**
|
|
471
|
-
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
472
|
-
* @public
|
|
473
|
-
*/
|
|
474
|
-
dataSourceId: string | undefined;
|
|
475
|
-
/**
|
|
476
|
-
* <p>A list of objects, each of which contains information to identify a document for which to retrieve information.</p>
|
|
477
|
-
* @public
|
|
478
|
-
*/
|
|
479
|
-
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
480
|
-
}
|
|
481
|
-
/**
|
|
482
|
-
* @public
|
|
483
|
-
*/
|
|
484
|
-
export interface GetKnowledgeBaseDocumentsResponse {
|
|
485
|
-
/**
|
|
486
|
-
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
487
|
-
* @public
|
|
488
|
-
*/
|
|
489
|
-
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
490
|
-
}
|
|
491
|
-
/**
|
|
492
|
-
* <p>Contains information about content defined inline in bytes.</p>
|
|
493
|
-
* @public
|
|
494
|
-
*/
|
|
495
|
-
export interface ByteContentDoc {
|
|
496
|
-
/**
|
|
497
|
-
* <p>The MIME type of the content. For a list of MIME types, see <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">Media Types</a>. The following MIME types are supported:</p> <ul> <li> <p>text/plain</p> </li> <li> <p>text/html</p> </li> <li> <p>text/csv</p> </li> <li> <p>text/vtt</p> </li> <li> <p>message/rfc822</p> </li> <li> <p>application/xhtml+xml</p> </li> <li> <p>application/pdf</p> </li> <li> <p>application/msword</p> </li> <li> <p>application/vnd.ms-word.document.macroenabled.12</p> </li> <li> <p>application/vnd.ms-word.template.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel</p> </li> <li> <p>application/vnd.ms-excel.addin.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.sheet.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.template.macroenabled.12</p> </li> <li> <p>application/vnd.ms-excel.sheet.binary.macroenabled.12</p> </li> <li> <p>application/vnd.ms-spreadsheetml</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.spreadsheetml.template</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.wordprocessingml.document</p> </li> <li> <p>application/vnd.openxmlformats-officedocument.wordprocessingml.template</p> </li> </ul>
|
|
498
|
-
* @public
|
|
499
|
-
*/
|
|
500
|
-
mimeType: string | undefined;
|
|
501
|
-
/**
|
|
502
|
-
* <p>The base64-encoded string of the content.</p>
|
|
503
|
-
* @public
|
|
504
|
-
*/
|
|
505
|
-
data: Uint8Array | undefined;
|
|
506
|
-
}
|
|
507
|
-
/**
|
|
508
|
-
* <p>Contains information about content defined inline in text.</p>
|
|
509
|
-
* @public
|
|
510
|
-
*/
|
|
511
|
-
export interface TextContentDoc {
|
|
512
|
-
/**
|
|
513
|
-
* <p>The text of the content.</p>
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
data: string | undefined;
|
|
517
|
-
}
|
|
518
|
-
/**
|
|
519
|
-
* @public
|
|
520
|
-
* @enum
|
|
521
|
-
*/
|
|
522
|
-
export declare const InlineContentType: {
|
|
523
|
-
readonly BYTE: "BYTE";
|
|
524
|
-
readonly TEXT: "TEXT";
|
|
525
|
-
};
|
|
526
|
-
/**
|
|
527
|
-
* @public
|
|
528
|
-
*/
|
|
529
|
-
export type InlineContentType = (typeof InlineContentType)[keyof typeof InlineContentType];
|
|
530
|
-
/**
|
|
531
|
-
* <p>Contains information about content defined inline to ingest into a data source. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
532
|
-
* @public
|
|
533
|
-
*/
|
|
534
|
-
export interface InlineContent {
|
|
535
|
-
/**
|
|
536
|
-
* <p>The type of inline content to define.</p>
|
|
537
|
-
* @public
|
|
538
|
-
*/
|
|
539
|
-
type: InlineContentType | undefined;
|
|
540
|
-
/**
|
|
541
|
-
* <p>Contains information about content defined inline in bytes.</p>
|
|
542
|
-
* @public
|
|
543
|
-
*/
|
|
544
|
-
byteContent?: ByteContentDoc | undefined;
|
|
545
|
-
/**
|
|
546
|
-
* <p>Contains information about content defined inline in text.</p>
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
textContent?: TextContentDoc | undefined;
|
|
550
|
-
}
|
|
551
|
-
/**
|
|
552
|
-
* <p>Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
553
|
-
* @public
|
|
554
|
-
*/
|
|
555
|
-
export interface CustomS3Location {
|
|
556
|
-
/**
|
|
557
|
-
* <p>The S3 URI of the file containing the content to ingest.</p>
|
|
558
|
-
* @public
|
|
559
|
-
*/
|
|
560
|
-
uri: string | undefined;
|
|
561
|
-
/**
|
|
562
|
-
* <p>The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.</p>
|
|
563
|
-
* @public
|
|
564
|
-
*/
|
|
565
|
-
bucketOwnerAccountId?: string | undefined;
|
|
566
|
-
}
|
|
567
|
-
/**
|
|
568
|
-
* @public
|
|
569
|
-
* @enum
|
|
570
|
-
*/
|
|
571
|
-
export declare const CustomSourceType: {
|
|
572
|
-
readonly IN_LINE: "IN_LINE";
|
|
573
|
-
readonly S3_LOCATION: "S3_LOCATION";
|
|
574
|
-
};
|
|
575
|
-
/**
|
|
576
|
-
* @public
|
|
577
|
-
*/
|
|
578
|
-
export type CustomSourceType = (typeof CustomSourceType)[keyof typeof CustomSourceType];
|
|
579
|
-
/**
|
|
580
|
-
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a <code>sourceType</code> and include the field that corresponds to it.</p>
|
|
581
|
-
* @public
|
|
582
|
-
*/
|
|
583
|
-
export interface CustomContent {
|
|
584
|
-
/**
|
|
585
|
-
* <p>A unique identifier for the document.</p>
|
|
586
|
-
* @public
|
|
587
|
-
*/
|
|
588
|
-
customDocumentIdentifier: CustomDocumentIdentifier | undefined;
|
|
589
|
-
/**
|
|
590
|
-
* <p>The source of the data to ingest.</p>
|
|
591
|
-
* @public
|
|
592
|
-
*/
|
|
593
|
-
sourceType: CustomSourceType | undefined;
|
|
594
|
-
/**
|
|
595
|
-
* <p>Contains information about the Amazon S3 location of the file from which to ingest data.</p>
|
|
596
|
-
* @public
|
|
597
|
-
*/
|
|
598
|
-
s3Location?: CustomS3Location | undefined;
|
|
599
|
-
/**
|
|
600
|
-
* <p>Contains information about content defined inline to ingest into a knowledge base.</p>
|
|
601
|
-
* @public
|
|
602
|
-
*/
|
|
603
|
-
inlineContent?: InlineContent | undefined;
|
|
604
|
-
}
|
|
605
|
-
/**
|
|
606
|
-
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.</p>
|
|
607
|
-
* @public
|
|
608
|
-
*/
|
|
609
|
-
export interface S3Content {
|
|
610
|
-
/**
|
|
611
|
-
* <p>The S3 location of the file containing the content to ingest.</p>
|
|
612
|
-
* @public
|
|
613
|
-
*/
|
|
614
|
-
s3Location: S3Location | undefined;
|
|
615
|
-
}
|
|
616
|
-
/**
|
|
617
|
-
* <p>Contains information about the content of a document. Choose a <code>dataSourceType</code> and include the field that corresponds to it.</p>
|
|
618
|
-
* @public
|
|
619
|
-
*/
|
|
620
|
-
export interface DocumentContent {
|
|
621
|
-
/**
|
|
622
|
-
* <p>The type of data source that is connected to the knowledge base to which to ingest this document.</p>
|
|
623
|
-
* @public
|
|
624
|
-
*/
|
|
625
|
-
dataSourceType: ContentDataSourceType | undefined;
|
|
626
|
-
/**
|
|
627
|
-
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
628
|
-
* @public
|
|
629
|
-
*/
|
|
630
|
-
custom?: CustomContent | undefined;
|
|
631
|
-
/**
|
|
632
|
-
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source</p>
|
|
633
|
-
* @public
|
|
634
|
-
*/
|
|
635
|
-
s3?: S3Content | undefined;
|
|
636
|
-
}
|
|
637
|
-
/**
|
|
638
|
-
* @public
|
|
639
|
-
* @enum
|
|
640
|
-
*/
|
|
641
|
-
export declare const MetadataValueType: {
|
|
642
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
643
|
-
readonly NUMBER: "NUMBER";
|
|
644
|
-
readonly STRING: "STRING";
|
|
645
|
-
readonly STRING_LIST: "STRING_LIST";
|
|
646
|
-
};
|
|
647
|
-
/**
|
|
648
|
-
* @public
|
|
649
|
-
*/
|
|
650
|
-
export type MetadataValueType = (typeof MetadataValueType)[keyof typeof MetadataValueType];
|
|
651
|
-
/**
|
|
652
|
-
* <p>Contains the value of the metadata attribute. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
653
|
-
* @public
|
|
654
|
-
*/
|
|
655
|
-
export interface MetadataAttributeValue {
|
|
656
|
-
/**
|
|
657
|
-
* <p>The type of the metadata attribute.</p>
|
|
658
|
-
* @public
|
|
659
|
-
*/
|
|
660
|
-
type: MetadataValueType | undefined;
|
|
661
|
-
/**
|
|
662
|
-
* <p>The value of the numeric metadata attribute.</p>
|
|
663
|
-
* @public
|
|
664
|
-
*/
|
|
665
|
-
numberValue?: number | undefined;
|
|
666
|
-
/**
|
|
667
|
-
* <p>The value of the Boolean metadata attribute.</p>
|
|
668
|
-
* @public
|
|
669
|
-
*/
|
|
670
|
-
booleanValue?: boolean | undefined;
|
|
671
|
-
/**
|
|
672
|
-
* <p>The value of the string metadata attribute.</p>
|
|
673
|
-
* @public
|
|
674
|
-
*/
|
|
675
|
-
stringValue?: string | undefined;
|
|
676
|
-
/**
|
|
677
|
-
* <p>An array of strings that define the value of the metadata attribute.</p>
|
|
678
|
-
* @public
|
|
679
|
-
*/
|
|
680
|
-
stringListValue?: string[] | undefined;
|
|
681
|
-
}
|
|
682
|
-
/**
|
|
683
|
-
* <p>Contains information about a metadata attribute.</p>
|
|
684
|
-
* @public
|
|
685
|
-
*/
|
|
686
|
-
export interface MetadataAttribute {
|
|
687
|
-
/**
|
|
688
|
-
* <p>The key of the metadata attribute.</p>
|
|
689
|
-
* @public
|
|
690
|
-
*/
|
|
691
|
-
key: string | undefined;
|
|
692
|
-
/**
|
|
693
|
-
* <p>Contains the value of the metadata attribute.</p>
|
|
694
|
-
* @public
|
|
695
|
-
*/
|
|
696
|
-
value: MetadataAttributeValue | undefined;
|
|
697
|
-
}
|
|
698
|
-
/**
|
|
699
|
-
* @public
|
|
700
|
-
* @enum
|
|
701
|
-
*/
|
|
702
|
-
export declare const MetadataSourceType: {
|
|
703
|
-
readonly IN_LINE_ATTRIBUTE: "IN_LINE_ATTRIBUTE";
|
|
704
|
-
readonly S3_LOCATION: "S3_LOCATION";
|
|
705
|
-
};
|
|
706
|
-
/**
|
|
707
|
-
* @public
|
|
708
|
-
*/
|
|
709
|
-
export type MetadataSourceType = (typeof MetadataSourceType)[keyof typeof MetadataSourceType];
|
|
710
|
-
/**
|
|
711
|
-
* <p>Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
712
|
-
* @public
|
|
713
|
-
*/
|
|
714
|
-
export interface DocumentMetadata {
|
|
715
|
-
/**
|
|
716
|
-
* <p>The type of the source source from which to add metadata.</p>
|
|
717
|
-
* @public
|
|
718
|
-
*/
|
|
719
|
-
type: MetadataSourceType | undefined;
|
|
720
|
-
/**
|
|
721
|
-
* <p>An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.</p>
|
|
722
|
-
* @public
|
|
723
|
-
*/
|
|
724
|
-
inlineAttributes?: MetadataAttribute[] | undefined;
|
|
725
|
-
/**
|
|
726
|
-
* <p>The Amazon S3 location of the file containing metadata to associate with the content to ingest.</p>
|
|
727
|
-
* @public
|
|
728
|
-
*/
|
|
729
|
-
s3Location?: CustomS3Location | undefined;
|
|
730
|
-
}
|
|
731
|
-
/**
|
|
732
|
-
* <p>Contains information about a document to ingest into a knowledge base and metadata to associate with it.</p>
|
|
733
|
-
* @public
|
|
734
|
-
*/
|
|
735
|
-
export interface KnowledgeBaseDocument {
|
|
736
|
-
/**
|
|
737
|
-
* <p>Contains the metadata to associate with the document.</p>
|
|
738
|
-
* @public
|
|
739
|
-
*/
|
|
740
|
-
metadata?: DocumentMetadata | undefined;
|
|
741
|
-
/**
|
|
742
|
-
* <p>Contains the content of the document.</p>
|
|
743
|
-
* @public
|
|
744
|
-
*/
|
|
745
|
-
content: DocumentContent | undefined;
|
|
746
|
-
}
|
|
747
|
-
/**
|
|
748
|
-
* @public
|
|
749
|
-
*/
|
|
750
|
-
export interface IngestKnowledgeBaseDocumentsRequest {
|
|
751
|
-
/**
|
|
752
|
-
* <p>The unique identifier of the knowledge base to ingest the documents into.</p>
|
|
753
|
-
* @public
|
|
754
|
-
*/
|
|
755
|
-
knowledgeBaseId: string | undefined;
|
|
756
|
-
/**
|
|
757
|
-
* <p>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</p>
|
|
758
|
-
* @public
|
|
759
|
-
*/
|
|
760
|
-
dataSourceId: string | undefined;
|
|
761
|
-
/**
|
|
762
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
763
|
-
* @public
|
|
764
|
-
*/
|
|
765
|
-
clientToken?: string | undefined;
|
|
766
|
-
/**
|
|
767
|
-
* <p>A list of objects, each of which contains information about the documents to add.</p>
|
|
768
|
-
* @public
|
|
769
|
-
*/
|
|
770
|
-
documents: KnowledgeBaseDocument[] | undefined;
|
|
771
|
-
}
|
|
772
|
-
/**
|
|
773
|
-
* @public
|
|
774
|
-
*/
|
|
775
|
-
export interface IngestKnowledgeBaseDocumentsResponse {
|
|
776
|
-
/**
|
|
777
|
-
* <p>A list of objects, each of which contains information about the documents that were ingested.</p>
|
|
778
|
-
* @public
|
|
779
|
-
*/
|
|
780
|
-
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
781
|
-
}
|
|
782
|
-
/**
|
|
783
|
-
* @public
|
|
784
|
-
*/
|
|
785
|
-
export interface ListKnowledgeBaseDocumentsRequest {
|
|
786
|
-
/**
|
|
787
|
-
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
788
|
-
* @public
|
|
789
|
-
*/
|
|
790
|
-
knowledgeBaseId: string | undefined;
|
|
791
|
-
/**
|
|
792
|
-
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
793
|
-
* @public
|
|
794
|
-
*/
|
|
795
|
-
dataSourceId: string | undefined;
|
|
796
|
-
/**
|
|
797
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
798
|
-
* @public
|
|
799
|
-
*/
|
|
800
|
-
maxResults?: number | undefined;
|
|
801
|
-
/**
|
|
802
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
803
|
-
* @public
|
|
804
|
-
*/
|
|
805
|
-
nextToken?: string | undefined;
|
|
806
|
-
}
|
|
807
|
-
/**
|
|
808
|
-
* @public
|
|
809
|
-
*/
|
|
810
|
-
export interface ListKnowledgeBaseDocumentsResponse {
|
|
811
|
-
/**
|
|
812
|
-
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
813
|
-
* @public
|
|
814
|
-
*/
|
|
815
|
-
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
816
|
-
/**
|
|
817
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
818
|
-
* @public
|
|
819
|
-
*/
|
|
820
|
-
nextToken?: string | undefined;
|
|
821
|
-
}
|
|
822
|
-
/**
|
|
823
|
-
* @public
|
|
824
|
-
*/
|
|
825
|
-
export interface AssociateAgentKnowledgeBaseRequest {
|
|
826
|
-
/**
|
|
827
|
-
* <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
|
|
828
|
-
* @public
|
|
829
|
-
*/
|
|
830
|
-
agentId: string | undefined;
|
|
831
|
-
/**
|
|
832
|
-
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
833
|
-
* @public
|
|
834
|
-
*/
|
|
835
|
-
agentVersion: string | undefined;
|
|
836
|
-
/**
|
|
837
|
-
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
838
|
-
* @public
|
|
839
|
-
*/
|
|
840
|
-
knowledgeBaseId: string | undefined;
|
|
841
|
-
/**
|
|
842
|
-
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
843
|
-
* @public
|
|
844
|
-
*/
|
|
845
|
-
description: string | undefined;
|
|
846
|
-
/**
|
|
847
|
-
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
848
|
-
* @public
|
|
849
|
-
*/
|
|
850
|
-
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
851
|
-
}
|
|
852
|
-
/**
|
|
853
|
-
* @public
|
|
854
|
-
*/
|
|
855
|
-
export interface AssociateAgentKnowledgeBaseResponse {
|
|
856
|
-
/**
|
|
857
|
-
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
858
|
-
* @public
|
|
859
|
-
*/
|
|
860
|
-
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
861
|
-
}
|
|
862
|
-
/**
|
|
863
|
-
* <p>Settings for an Amazon Kendra knowledge base.</p>
|
|
864
|
-
* @public
|
|
865
|
-
*/
|
|
866
|
-
export interface KendraKnowledgeBaseConfiguration {
|
|
867
|
-
/**
|
|
868
|
-
* <p>The ARN of the Amazon Kendra index.</p>
|
|
869
|
-
* @public
|
|
870
|
-
*/
|
|
871
|
-
kendraIndexArn: string | undefined;
|
|
872
|
-
}
|
|
873
|
-
/**
|
|
874
|
-
* @public
|
|
875
|
-
* @enum
|
|
876
|
-
*/
|
|
877
|
-
export declare const RedshiftProvisionedAuthType: {
|
|
878
|
-
readonly IAM: "IAM";
|
|
879
|
-
readonly USERNAME: "USERNAME";
|
|
880
|
-
readonly USERNAME_PASSWORD: "USERNAME_PASSWORD";
|
|
881
|
-
};
|
|
882
|
-
/**
|
|
883
|
-
* @public
|
|
884
|
-
*/
|
|
885
|
-
export type RedshiftProvisionedAuthType = (typeof RedshiftProvisionedAuthType)[keyof typeof RedshiftProvisionedAuthType];
|
|
886
|
-
/**
|
|
887
|
-
* <p>Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
|
|
888
|
-
* @public
|
|
889
|
-
*/
|
|
890
|
-
export interface RedshiftProvisionedAuthConfiguration {
|
|
891
|
-
/**
|
|
892
|
-
* <p>The type of authentication to use.</p>
|
|
893
|
-
* @public
|
|
894
|
-
*/
|
|
895
|
-
type: RedshiftProvisionedAuthType | undefined;
|
|
896
|
-
/**
|
|
897
|
-
* <p>The database username for authentication to an Amazon Redshift provisioned data warehouse.</p>
|
|
898
|
-
* @public
|
|
899
|
-
*/
|
|
900
|
-
databaseUser?: string | undefined;
|
|
901
|
-
/**
|
|
902
|
-
* <p>The ARN of an Secrets Manager secret for authentication.</p>
|
|
903
|
-
* @public
|
|
904
|
-
*/
|
|
905
|
-
usernamePasswordSecretArn?: string | undefined;
|
|
906
|
-
}
|
|
907
|
-
/**
|
|
908
|
-
* <p>Contains configurations for a provisioned Amazon Redshift query engine.</p>
|
|
909
|
-
* @public
|
|
910
|
-
*/
|
|
911
|
-
export interface RedshiftProvisionedConfiguration {
|
|
912
|
-
/**
|
|
913
|
-
* <p>The ID of the Amazon Redshift cluster.</p>
|
|
914
|
-
* @public
|
|
915
|
-
*/
|
|
916
|
-
clusterIdentifier: string | undefined;
|
|
917
|
-
/**
|
|
918
|
-
* <p>Specifies configurations for authentication to Amazon Redshift.</p>
|
|
919
|
-
* @public
|
|
920
|
-
*/
|
|
921
|
-
authConfiguration: RedshiftProvisionedAuthConfiguration | undefined;
|
|
922
|
-
}
|
|
923
|
-
/**
|
|
924
|
-
* @public
|
|
925
|
-
* @enum
|
|
926
|
-
*/
|
|
927
|
-
export declare const RedshiftServerlessAuthType: {
|
|
928
|
-
readonly IAM: "IAM";
|
|
929
|
-
readonly USERNAME_PASSWORD: "USERNAME_PASSWORD";
|
|
930
|
-
};
|
|
931
|
-
/**
|
|
932
|
-
* @public
|
|
933
|
-
*/
|
|
934
|
-
export type RedshiftServerlessAuthType = (typeof RedshiftServerlessAuthType)[keyof typeof RedshiftServerlessAuthType];
|
|
935
|
-
/**
|
|
936
|
-
* <p>Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the <code>type</code> field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.</p>
|
|
937
|
-
* @public
|
|
938
|
-
*/
|
|
939
|
-
export interface RedshiftServerlessAuthConfiguration {
|
|
940
|
-
/**
|
|
941
|
-
* <p>The type of authentication to use.</p>
|
|
942
|
-
* @public
|
|
943
|
-
*/
|
|
944
|
-
type: RedshiftServerlessAuthType | undefined;
|
|
945
|
-
/**
|
|
946
|
-
* <p>The ARN of an Secrets Manager secret for authentication.</p>
|
|
947
|
-
* @public
|
|
948
|
-
*/
|
|
949
|
-
usernamePasswordSecretArn?: string | undefined;
|
|
950
|
-
}
|
|
951
|
-
/**
|
|
952
|
-
* <p>Contains configurations for authentication to Amazon Redshift Serverless.</p>
|
|
953
|
-
* @public
|
|
954
|
-
*/
|
|
955
|
-
export interface RedshiftServerlessConfiguration {
|
|
956
|
-
/**
|
|
957
|
-
* <p>The ARN of the Amazon Redshift workgroup.</p>
|
|
958
|
-
* @public
|
|
959
|
-
*/
|
|
960
|
-
workgroupArn: string | undefined;
|
|
961
|
-
/**
|
|
962
|
-
* <p>Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.</p>
|
|
963
|
-
* @public
|
|
964
|
-
*/
|
|
965
|
-
authConfiguration: RedshiftServerlessAuthConfiguration | undefined;
|
|
966
|
-
}
|
|
967
|
-
/**
|
|
968
|
-
* @public
|
|
969
|
-
* @enum
|
|
970
|
-
*/
|
|
971
|
-
export declare const RedshiftQueryEngineType: {
|
|
972
|
-
readonly PROVISIONED: "PROVISIONED";
|
|
973
|
-
readonly SERVERLESS: "SERVERLESS";
|
|
974
|
-
};
|
|
975
|
-
/**
|
|
976
|
-
* @public
|
|
977
|
-
*/
|
|
978
|
-
export type RedshiftQueryEngineType = (typeof RedshiftQueryEngineType)[keyof typeof RedshiftQueryEngineType];
|
|
979
|
-
/**
|
|
980
|
-
* <p>Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in <code>type</code> and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
981
|
-
* @public
|
|
982
|
-
*/
|
|
983
|
-
export interface RedshiftQueryEngineConfiguration {
|
|
984
|
-
/**
|
|
985
|
-
* <p>The type of query engine.</p>
|
|
986
|
-
* @public
|
|
987
|
-
*/
|
|
988
|
-
type: RedshiftQueryEngineType | undefined;
|
|
989
|
-
/**
|
|
990
|
-
* <p>Specifies configurations for a serverless Amazon Redshift query engine.</p>
|
|
991
|
-
* @public
|
|
992
|
-
*/
|
|
993
|
-
serverlessConfiguration?: RedshiftServerlessConfiguration | undefined;
|
|
994
|
-
/**
|
|
995
|
-
* <p>Specifies configurations for a provisioned Amazon Redshift query engine.</p>
|
|
996
|
-
* @public
|
|
997
|
-
*/
|
|
998
|
-
provisionedConfiguration?: RedshiftProvisionedConfiguration | undefined;
|
|
999
|
-
}
|
|
1000
|
-
/**
|
|
1001
|
-
* <p>Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
|
|
1002
|
-
* @public
|
|
1003
|
-
*/
|
|
1004
|
-
export interface CuratedQuery {
|
|
1005
|
-
/**
|
|
1006
|
-
* <p>An example natural language query.</p>
|
|
1007
|
-
* @public
|
|
1008
|
-
*/
|
|
1009
|
-
naturalLanguage: string | undefined;
|
|
1010
|
-
/**
|
|
1011
|
-
* <p>The SQL equivalent of the natural language query.</p>
|
|
1012
|
-
* @public
|
|
1013
|
-
*/
|
|
1014
|
-
sql: string | undefined;
|
|
1015
|
-
}
|
|
1016
|
-
/**
|
|
1017
|
-
* @public
|
|
1018
|
-
* @enum
|
|
1019
|
-
*/
|
|
1020
|
-
export declare const IncludeExclude: {
|
|
1021
|
-
readonly EXCLUDE: "EXCLUDE";
|
|
1022
|
-
readonly INCLUDE: "INCLUDE";
|
|
1023
|
-
};
|
|
1024
|
-
/**
|
|
1025
|
-
* @public
|
|
1026
|
-
*/
|
|
1027
|
-
export type IncludeExclude = (typeof IncludeExclude)[keyof typeof IncludeExclude];
|
|
1028
|
-
/**
|
|
1029
|
-
* <p>Contains information about a column in the current table for the query engine to consider.</p>
|
|
1030
|
-
* @public
|
|
1031
|
-
*/
|
|
1032
|
-
export interface QueryGenerationColumn {
|
|
1033
|
-
/**
|
|
1034
|
-
* <p>The name of the column for which the other fields in this object apply.</p>
|
|
1035
|
-
* @public
|
|
1036
|
-
*/
|
|
1037
|
-
name?: string | undefined;
|
|
1038
|
-
/**
|
|
1039
|
-
* <p>A description of the column that helps the query engine understand the contents of the column.</p>
|
|
1040
|
-
* @public
|
|
1041
|
-
*/
|
|
1042
|
-
description?: string | undefined;
|
|
1043
|
-
/**
|
|
1044
|
-
* <p>Specifies whether to include or exclude the column during query generation. If you specify <code>EXCLUDE</code>, the column will be ignored. If you specify <code>INCLUDE</code>, all other columns in the table will be ignored.</p>
|
|
1045
|
-
* @public
|
|
1046
|
-
*/
|
|
1047
|
-
inclusion?: IncludeExclude | undefined;
|
|
1048
|
-
}
|
|
1049
|
-
/**
|
|
1050
|
-
* <p>Contains information about a table for the query engine to consider.</p>
|
|
1051
|
-
* @public
|
|
1052
|
-
*/
|
|
1053
|
-
export interface QueryGenerationTable {
|
|
1054
|
-
/**
|
|
1055
|
-
* <p>The name of the table for which the other fields in this object apply.</p>
|
|
1056
|
-
* @public
|
|
1057
|
-
*/
|
|
1058
|
-
name: string | undefined;
|
|
1059
|
-
/**
|
|
1060
|
-
* <p>A description of the table that helps the query engine understand the contents of the table.</p>
|
|
1061
|
-
* @public
|
|
1062
|
-
*/
|
|
1063
|
-
description?: string | undefined;
|
|
1064
|
-
/**
|
|
1065
|
-
* <p>Specifies whether to include or exclude the table during query generation. If you specify <code>EXCLUDE</code>, the table will be ignored. If you specify <code>INCLUDE</code>, all other tables will be ignored.</p>
|
|
1066
|
-
* @public
|
|
1067
|
-
*/
|
|
1068
|
-
inclusion?: IncludeExclude | undefined;
|
|
1069
|
-
/**
|
|
1070
|
-
* <p>An array of objects, each of which defines information about a column in the table.</p>
|
|
1071
|
-
* @public
|
|
1072
|
-
*/
|
|
1073
|
-
columns?: QueryGenerationColumn[] | undefined;
|
|
1074
|
-
}
|
|
1075
|
-
/**
|
|
1076
|
-
* <p>>Contains configurations for context to use during query generation.</p>
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
export interface QueryGenerationContext {
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>An array of objects, each of which defines information about a table in the database.</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
tables?: QueryGenerationTable[] | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* <p>An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.</p>
|
|
1087
|
-
* @public
|
|
1088
|
-
*/
|
|
1089
|
-
curatedQueries?: CuratedQuery[] | undefined;
|
|
1090
|
-
}
|
|
1091
|
-
/**
|
|
1092
|
-
* <p>Contains configurations for query generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide..</p>
|
|
1093
|
-
* @public
|
|
1094
|
-
*/
|
|
1095
|
-
export interface QueryGenerationConfiguration {
|
|
1096
|
-
/**
|
|
1097
|
-
* <p>The time after which query generation will time out.</p>
|
|
1098
|
-
* @public
|
|
1099
|
-
*/
|
|
1100
|
-
executionTimeoutSeconds?: number | undefined;
|
|
1101
|
-
/**
|
|
1102
|
-
* <p>Specifies configurations for context to use during query generation.</p>
|
|
1103
|
-
* @public
|
|
1104
|
-
*/
|
|
1105
|
-
generationContext?: QueryGenerationContext | undefined;
|
|
1106
|
-
}
|
|
1107
|
-
/**
|
|
1108
|
-
* <p>Contains configurations for storage in Glue Data Catalog.</p>
|
|
1109
|
-
* @public
|
|
1110
|
-
*/
|
|
1111
|
-
export interface RedshiftQueryEngineAwsDataCatalogStorageConfiguration {
|
|
1112
|
-
/**
|
|
1113
|
-
* <p>A list of names of the tables to use.</p>
|
|
1114
|
-
* @public
|
|
1115
|
-
*/
|
|
1116
|
-
tableNames: string[] | undefined;
|
|
1117
|
-
}
|
|
1118
|
-
/**
|
|
1119
|
-
* <p>Contains configurations for storage in Amazon Redshift.</p>
|
|
1120
|
-
* @public
|
|
1121
|
-
*/
|
|
1122
|
-
export interface RedshiftQueryEngineRedshiftStorageConfiguration {
|
|
1123
|
-
/**
|
|
1124
|
-
* <p>The name of the Amazon Redshift database.</p>
|
|
1125
|
-
* @public
|
|
1126
|
-
*/
|
|
1127
|
-
databaseName: string | undefined;
|
|
1128
|
-
}
|
|
1129
|
-
/**
|
|
1130
|
-
* @public
|
|
1131
|
-
* @enum
|
|
1132
|
-
*/
|
|
1133
|
-
export declare const RedshiftQueryEngineStorageType: {
|
|
1134
|
-
readonly AWS_DATA_CATALOG: "AWS_DATA_CATALOG";
|
|
1135
|
-
readonly REDSHIFT: "REDSHIFT";
|
|
1136
|
-
};
|
|
1137
|
-
/**
|
|
1138
|
-
* @public
|
|
1139
|
-
*/
|
|
1140
|
-
export type RedshiftQueryEngineStorageType = (typeof RedshiftQueryEngineStorageType)[keyof typeof RedshiftQueryEngineStorageType];
|
|
1141
|
-
/**
|
|
1142
|
-
* <p>Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
1143
|
-
* @public
|
|
1144
|
-
*/
|
|
1145
|
-
export interface RedshiftQueryEngineStorageConfiguration {
|
|
1146
|
-
/**
|
|
1147
|
-
* <p>The data storage service to use.</p>
|
|
1148
|
-
* @public
|
|
1149
|
-
*/
|
|
1150
|
-
type: RedshiftQueryEngineStorageType | undefined;
|
|
1151
|
-
/**
|
|
1152
|
-
* <p>Specifies configurations for storage in Glue Data Catalog.</p>
|
|
1153
|
-
* @public
|
|
1154
|
-
*/
|
|
1155
|
-
awsDataCatalogConfiguration?: RedshiftQueryEngineAwsDataCatalogStorageConfiguration | undefined;
|
|
1156
|
-
/**
|
|
1157
|
-
* <p>Specifies configurations for storage in Amazon Redshift.</p>
|
|
1158
|
-
* @public
|
|
1159
|
-
*/
|
|
1160
|
-
redshiftConfiguration?: RedshiftQueryEngineRedshiftStorageConfiguration | undefined;
|
|
1161
|
-
}
|
|
1162
|
-
/**
|
|
1163
|
-
* <p>Contains configurations for an Amazon Redshift database. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
1164
|
-
* @public
|
|
1165
|
-
*/
|
|
1166
|
-
export interface RedshiftConfiguration {
|
|
1167
|
-
/**
|
|
1168
|
-
* <p>Specifies configurations for Amazon Redshift database storage.</p>
|
|
1169
|
-
* @public
|
|
1170
|
-
*/
|
|
1171
|
-
storageConfigurations: RedshiftQueryEngineStorageConfiguration[] | undefined;
|
|
1172
|
-
/**
|
|
1173
|
-
* <p>Specifies configurations for an Amazon Redshift query engine.</p>
|
|
1174
|
-
* @public
|
|
1175
|
-
*/
|
|
1176
|
-
queryEngineConfiguration: RedshiftQueryEngineConfiguration | undefined;
|
|
1177
|
-
/**
|
|
1178
|
-
* <p>Specifies configurations for generating queries.</p>
|
|
1179
|
-
* @public
|
|
1180
|
-
*/
|
|
1181
|
-
queryGenerationConfiguration?: QueryGenerationConfiguration | undefined;
|
|
1182
|
-
}
|
|
1183
|
-
/**
|
|
1184
|
-
* @public
|
|
1185
|
-
* @enum
|
|
1186
|
-
*/
|
|
1187
|
-
export declare const QueryEngineType: {
|
|
1188
|
-
readonly REDSHIFT: "REDSHIFT";
|
|
1189
|
-
};
|
|
1190
|
-
/**
|
|
1191
|
-
* @public
|
|
1192
|
-
*/
|
|
1193
|
-
export type QueryEngineType = (typeof QueryEngineType)[keyof typeof QueryEngineType];
|
|
1194
|
-
/**
|
|
1195
|
-
* <p>Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the <code>type</code> field and include the corresponding field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html">Build a knowledge base by connecting to a structured data source</a> in the Amazon Bedrock User Guide.</p>
|
|
1196
|
-
* @public
|
|
1197
|
-
*/
|
|
1198
|
-
export interface SqlKnowledgeBaseConfiguration {
|
|
1199
|
-
/**
|
|
1200
|
-
* <p>The type of SQL database to connect to the knowledge base.</p>
|
|
1201
|
-
* @public
|
|
1202
|
-
*/
|
|
1203
|
-
type: QueryEngineType | undefined;
|
|
1204
|
-
/**
|
|
1205
|
-
* <p>Specifies configurations for a knowledge base connected to an Amazon Redshift database.</p>
|
|
1206
|
-
* @public
|
|
1207
|
-
*/
|
|
1208
|
-
redshiftConfiguration?: RedshiftConfiguration | undefined;
|
|
1209
|
-
}
|
|
1210
|
-
/**
|
|
1211
|
-
* @public
|
|
1212
|
-
* @enum
|
|
1213
|
-
*/
|
|
1214
|
-
export declare const KnowledgeBaseType: {
|
|
1215
|
-
readonly KENDRA: "KENDRA";
|
|
1216
|
-
readonly SQL: "SQL";
|
|
1217
|
-
readonly VECTOR: "VECTOR";
|
|
1218
|
-
};
|
|
1219
|
-
/**
|
|
1220
|
-
* @public
|
|
1221
|
-
*/
|
|
1222
|
-
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
1223
|
-
/**
|
|
1224
|
-
* @public
|
|
1225
|
-
* @enum
|
|
1226
|
-
*/
|
|
1227
|
-
export declare const EmbeddingDataType: {
|
|
1228
|
-
readonly BINARY: "BINARY";
|
|
1229
|
-
readonly FLOAT32: "FLOAT32";
|
|
1230
|
-
};
|
|
1231
|
-
/**
|
|
1232
|
-
* @public
|
|
1233
|
-
*/
|
|
1234
|
-
export type EmbeddingDataType = (typeof EmbeddingDataType)[keyof typeof EmbeddingDataType];
|
|
1235
|
-
/**
|
|
1236
|
-
* <p>The vector configuration details for the Bedrock embeddings model.</p>
|
|
1237
|
-
* @public
|
|
1238
|
-
*/
|
|
1239
|
-
export interface BedrockEmbeddingModelConfiguration {
|
|
1240
|
-
/**
|
|
1241
|
-
* <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
|
|
1242
|
-
* @public
|
|
1243
|
-
*/
|
|
1244
|
-
dimensions?: number | undefined;
|
|
1245
|
-
/**
|
|
1246
|
-
* <p>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</p>
|
|
1247
|
-
* @public
|
|
1248
|
-
*/
|
|
1249
|
-
embeddingDataType?: EmbeddingDataType | undefined;
|
|
1250
|
-
}
|
|
1251
|
-
/**
|
|
1252
|
-
* <p>The configuration details for the embeddings model.</p>
|
|
1253
|
-
* @public
|
|
1254
|
-
*/
|
|
1255
|
-
export interface EmbeddingModelConfiguration {
|
|
1256
|
-
/**
|
|
1257
|
-
* <p>The vector configuration details on the Bedrock embeddings model.</p>
|
|
1258
|
-
* @public
|
|
1259
|
-
*/
|
|
1260
|
-
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
|
|
1261
|
-
}
|
|
1262
|
-
/**
|
|
1263
|
-
* @public
|
|
1264
|
-
* @enum
|
|
1265
|
-
*/
|
|
1266
|
-
export declare const SupplementalDataStorageLocationType: {
|
|
1267
|
-
readonly S3: "S3";
|
|
1268
|
-
};
|
|
1269
|
-
/**
|
|
1270
|
-
* @public
|
|
1271
|
-
*/
|
|
1272
|
-
export type SupplementalDataStorageLocationType = (typeof SupplementalDataStorageLocationType)[keyof typeof SupplementalDataStorageLocationType];
|
|
1273
|
-
/**
|
|
1274
|
-
* <p>Contains information about a storage location for images extracted from multimodal documents in your data source.</p>
|
|
1275
|
-
* @public
|
|
1276
|
-
*/
|
|
1277
|
-
export interface SupplementalDataStorageLocation {
|
|
1278
|
-
/**
|
|
1279
|
-
* <p>Specifies the storage service used for this location.</p>
|
|
1280
|
-
* @public
|
|
1281
|
-
*/
|
|
1282
|
-
type: SupplementalDataStorageLocationType | undefined;
|
|
1283
|
-
/**
|
|
1284
|
-
* <p>Contains information about the Amazon S3 location for the extracted images.</p>
|
|
1285
|
-
* @public
|
|
1286
|
-
*/
|
|
1287
|
-
s3Location?: S3Location | undefined;
|
|
1288
|
-
}
|
|
1289
|
-
/**
|
|
1290
|
-
* <p>Specifies configurations for the storage location of the images extracted from multimodal documents in your data source. These images can be retrieved and returned to the end user.</p>
|
|
1291
|
-
* @public
|
|
1292
|
-
*/
|
|
1293
|
-
export interface SupplementalDataStorageConfiguration {
|
|
1294
|
-
/**
|
|
1295
|
-
* <p>A list of objects specifying storage locations for images extracted from multimodal documents in your data source.</p>
|
|
1296
|
-
* @public
|
|
1297
|
-
*/
|
|
1298
|
-
storageLocations: SupplementalDataStorageLocation[] | undefined;
|
|
1299
|
-
}
|
|
2
|
+
import { AgentStatus, FlowNodeType, FlowStatus, KnowledgeBaseState, KnowledgeBaseStatus, KnowledgeBaseStorageType, KnowledgeBaseType, PromptTemplateType } from "./enums";
|
|
3
|
+
import { AgentFlowNodeConfiguration, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentVersion, AgentVersionSummary, CollectorFlowNodeConfiguration, ConditionFlowNodeConfiguration, EmbeddingModelConfiguration, FlowConnection, FlowNodeInput, FlowNodeOutput, FlowValidation, InlineCodeFlowNodeConfiguration, InputFlowNodeConfiguration, IteratorFlowNodeConfiguration, KendraKnowledgeBaseConfiguration, KnowledgeBaseFlowNodeConfiguration, LambdaFunctionFlowNodeConfiguration, LexFlowNodeConfiguration, LoopControllerFlowNodeConfiguration, LoopInputFlowNodeConfiguration, OutputFlowNodeConfiguration, PromptFlowNodeConfiguration, PromptInferenceConfiguration, PromptTemplateConfiguration, RetrievalFlowNodeConfiguration, SqlKnowledgeBaseConfiguration, StorageFlowNodeConfiguration, SupplementalDataStorageConfiguration } from "./models_0";
|
|
1300
4
|
/**
|
|
1301
5
|
* <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
|
|
1302
6
|
* @public
|
|
@@ -1704,24 +408,6 @@ export interface S3VectorsConfiguration {
|
|
|
1704
408
|
*/
|
|
1705
409
|
indexName?: string | undefined;
|
|
1706
410
|
}
|
|
1707
|
-
/**
|
|
1708
|
-
* @public
|
|
1709
|
-
* @enum
|
|
1710
|
-
*/
|
|
1711
|
-
export declare const KnowledgeBaseStorageType: {
|
|
1712
|
-
readonly MONGO_DB_ATLAS: "MONGO_DB_ATLAS";
|
|
1713
|
-
readonly NEPTUNE_ANALYTICS: "NEPTUNE_ANALYTICS";
|
|
1714
|
-
readonly OPENSEARCH_MANAGED_CLUSTER: "OPENSEARCH_MANAGED_CLUSTER";
|
|
1715
|
-
readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
|
|
1716
|
-
readonly PINECONE: "PINECONE";
|
|
1717
|
-
readonly RDS: "RDS";
|
|
1718
|
-
readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
|
|
1719
|
-
readonly S3_VECTORS: "S3_VECTORS";
|
|
1720
|
-
};
|
|
1721
|
-
/**
|
|
1722
|
-
* @public
|
|
1723
|
-
*/
|
|
1724
|
-
export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
|
|
1725
411
|
/**
|
|
1726
412
|
* <p>Contains the storage configuration of the knowledge base.</p>
|
|
1727
413
|
* @public
|
|
@@ -1813,22 +499,6 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
1813
499
|
*/
|
|
1814
500
|
tags?: Record<string, string> | undefined;
|
|
1815
501
|
}
|
|
1816
|
-
/**
|
|
1817
|
-
* @public
|
|
1818
|
-
* @enum
|
|
1819
|
-
*/
|
|
1820
|
-
export declare const KnowledgeBaseStatus: {
|
|
1821
|
-
readonly ACTIVE: "ACTIVE";
|
|
1822
|
-
readonly CREATING: "CREATING";
|
|
1823
|
-
readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
|
|
1824
|
-
readonly DELETING: "DELETING";
|
|
1825
|
-
readonly FAILED: "FAILED";
|
|
1826
|
-
readonly UPDATING: "UPDATING";
|
|
1827
|
-
};
|
|
1828
|
-
/**
|
|
1829
|
-
* @public
|
|
1830
|
-
*/
|
|
1831
|
-
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
1832
502
|
/**
|
|
1833
503
|
* <p>Contains information about a knowledge base.</p>
|
|
1834
504
|
* @public
|