@aws-sdk/client-bedrock-agent 3.702.0 → 3.705.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/README.md +72 -0
- package/dist-cjs/index.js +772 -28
- package/dist-es/BedrockAgent.js +18 -0
- package/dist-es/commands/AssociateAgentCollaboratorCommand.js +23 -0
- package/dist-es/commands/DeleteKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/DisassociateAgentCollaboratorCommand.js +22 -0
- package/dist-es/commands/GetAgentCollaboratorCommand.js +23 -0
- package/dist-es/commands/GetKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/IngestKnowledgeBaseDocumentsCommand.js +23 -0
- package/dist-es/commands/ListAgentCollaboratorsCommand.js +23 -0
- package/dist-es/commands/ListKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/UpdateAgentCollaboratorCommand.js +23 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +75 -18
- package/dist-es/models/models_1.js +71 -1
- package/dist-es/pagination/ListAgentCollaboratorsPaginator.js +4 -0
- package/dist-es/pagination/ListKnowledgeBaseDocumentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +392 -0
- package/dist-types/BedrockAgent.d.ts +63 -0
- package/dist-types/BedrockAgentClient.d.ts +11 -2
- package/dist-types/commands/AssociateAgentCollaboratorCommand.d.ts +113 -0
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/CreateAgentCommand.d.ts +4 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +119 -0
- package/dist-types/commands/DisassociateAgentCollaboratorCommand.d.ts +89 -0
- package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentCollaboratorCommand.d.ts +101 -0
- package/dist-types/commands/GetAgentCommand.d.ts +2 -0
- package/dist-types/commands/GetAgentVersionCommand.d.ts +2 -0
- package/dist-types/commands/GetDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseDocumentsCommand.d.ts +118 -0
- package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +161 -0
- package/dist-types/commands/ListAgentCollaboratorsCommand.d.ts +104 -0
- package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts +110 -0
- package/dist-types/commands/UpdateAgentCollaboratorCommand.d.ts +113 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/models_0.d.ts +589 -475
- package/dist-types/models/models_1.d.ts +923 -1
- package/dist-types/pagination/ListAgentCollaboratorsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +81 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +153 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/AssociateAgentCollaboratorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateAgentCollaboratorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAgentCollaboratorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAgentCollaboratorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAgentCollaboratorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +185 -153
- package/dist-types/ts3.4/models/models_1.d.ts +270 -4
- package/dist-types/ts3.4/pagination/ListAgentCollaboratorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +108 -0
- package/package.json +1 -1
|
@@ -1,5 +1,899 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentStatus, AgentVersion, AgentVersionSummary, FlowDefinition, FlowValidation,
|
|
2
|
+
import { AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentStatus, AgentVersion, AgentVersionSummary, ContentDataSourceType, CustomDocumentIdentifier, FlowDefinition, FlowValidation, InlineContent, KnowledgeBaseDocumentDetail, KnowledgeBaseState, PromptInferenceConfiguration, PromptTemplateConfiguration, PromptTemplateType, S3Location } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* <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>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface CustomS3Location {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The S3 URI of the file containing the content to ingest.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
uri: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
bucketOwnerAccountId?: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
* @enum
|
|
22
|
+
*/
|
|
23
|
+
export declare const CustomSourceType: {
|
|
24
|
+
readonly IN_LINE: "IN_LINE";
|
|
25
|
+
readonly S3_LOCATION: "S3_LOCATION";
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export type CustomSourceType = (typeof CustomSourceType)[keyof typeof CustomSourceType];
|
|
31
|
+
/**
|
|
32
|
+
* <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>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export interface CustomContent {
|
|
36
|
+
/**
|
|
37
|
+
* <p>A unique identifier for the document.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
customDocumentIdentifier: CustomDocumentIdentifier | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The source of the data to ingest.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
sourceType: CustomSourceType | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>Contains information about the Amazon S3 location of the file from which to ingest data.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
s3Location?: CustomS3Location | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* <p>Contains information about content defined inline to ingest into a knowledge base.</p>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
inlineContent?: InlineContent | undefined;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export interface S3Content {
|
|
62
|
+
/**
|
|
63
|
+
* <p>The S3 location of the file containing the content to ingest.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
s3Location: S3Location | undefined;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* <p>Contains information about the content of a document. Choose a <code>dataSourceType</code> and include the field that corresponds to it.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export interface DocumentContent {
|
|
73
|
+
/**
|
|
74
|
+
* <p>The type of data source that is connected to the knowledge base to which to ingest this document.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
custom?: CustomContent | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
s3?: S3Content | undefined;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
* @enum
|
|
92
|
+
*/
|
|
93
|
+
export declare const MetadataValueType: {
|
|
94
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
95
|
+
readonly NUMBER: "NUMBER";
|
|
96
|
+
readonly STRING: "STRING";
|
|
97
|
+
readonly STRING_LIST: "STRING_LIST";
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export type MetadataValueType = (typeof MetadataValueType)[keyof typeof MetadataValueType];
|
|
103
|
+
/**
|
|
104
|
+
* <p>Contains the value of the metadata attribute. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface MetadataAttributeValue {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The type of the metadata attribute.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
type: MetadataValueType | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The value of the numeric metadata attribute.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
numberValue?: number | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>The value of the Boolean metadata attribute.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
booleanValue?: boolean | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* <p>The value of the string metadata attribute.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
stringValue?: string | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* <p>An array of strings that define the value of the metadata attribute.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
stringListValue?: string[] | undefined;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* <p>Contains information about a metadata attribute.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export interface MetadataAttribute {
|
|
139
|
+
/**
|
|
140
|
+
* <p>The key of the metadata attribute.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
key: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>Contains the value of the metadata attribute.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
value: MetadataAttributeValue | undefined;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
* @enum
|
|
153
|
+
*/
|
|
154
|
+
export declare const MetadataSourceType: {
|
|
155
|
+
readonly IN_LINE_ATTRIBUTE: "IN_LINE_ATTRIBUTE";
|
|
156
|
+
readonly S3_LOCATION: "S3_LOCATION";
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export type MetadataSourceType = (typeof MetadataSourceType)[keyof typeof MetadataSourceType];
|
|
162
|
+
/**
|
|
163
|
+
* <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>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export interface DocumentMetadata {
|
|
167
|
+
/**
|
|
168
|
+
* <p>The type of the source source from which to add metadata.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
type: MetadataSourceType | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <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>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
inlineAttributes?: MetadataAttribute[] | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The Amazon S3 location of the file containing metadata to associate with the content to ingest.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
s3Location?: CustomS3Location | undefined;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* <p>Contains information about a document to ingest into a knowledge base and metadata to associate with it.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
export interface KnowledgeBaseDocument {
|
|
188
|
+
/**
|
|
189
|
+
* <p>Contains the metadata to associate with the document.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
metadata?: DocumentMetadata | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* <p>Contains the content of the document.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
content: DocumentContent | undefined;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
export interface IngestKnowledgeBaseDocumentsRequest {
|
|
203
|
+
/**
|
|
204
|
+
* <p>The unique identifier of the knowledge base to ingest the documents into.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
knowledgeBaseId: string | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
dataSourceId: string | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* <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,
|
|
215
|
+
* 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>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
clientToken?: string | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>A list of objects, each of which contains information about the documents to add.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
documents: KnowledgeBaseDocument[] | undefined;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export interface IngestKnowledgeBaseDocumentsResponse {
|
|
229
|
+
/**
|
|
230
|
+
* <p>A list of objects, each of which contains information about the documents that were ingested.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
export interface ListKnowledgeBaseDocumentsRequest {
|
|
239
|
+
/**
|
|
240
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
knowledgeBaseId: string | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
dataSourceId: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <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>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
maxResults?: number | undefined;
|
|
254
|
+
/**
|
|
255
|
+
* <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>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
nextToken?: string | undefined;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export interface ListKnowledgeBaseDocumentsResponse {
|
|
264
|
+
/**
|
|
265
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <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>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
nextToken?: string | undefined;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export interface AssociateAgentKnowledgeBaseRequest {
|
|
279
|
+
/**
|
|
280
|
+
* <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
agentId: string | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
agentVersion: string | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
knowledgeBaseId: string | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
description: string | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <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>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
export interface AssociateAgentKnowledgeBaseResponse {
|
|
309
|
+
/**
|
|
310
|
+
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
314
|
+
}
|
|
315
|
+
/**
|
|
316
|
+
* @public
|
|
317
|
+
* @enum
|
|
318
|
+
*/
|
|
319
|
+
export declare const KnowledgeBaseType: {
|
|
320
|
+
readonly VECTOR: "VECTOR";
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
326
|
+
/**
|
|
327
|
+
* @public
|
|
328
|
+
* @enum
|
|
329
|
+
*/
|
|
330
|
+
export declare const EmbeddingDataType: {
|
|
331
|
+
readonly BINARY: "BINARY";
|
|
332
|
+
readonly FLOAT32: "FLOAT32";
|
|
333
|
+
};
|
|
334
|
+
/**
|
|
335
|
+
* @public
|
|
336
|
+
*/
|
|
337
|
+
export type EmbeddingDataType = (typeof EmbeddingDataType)[keyof typeof EmbeddingDataType];
|
|
338
|
+
/**
|
|
339
|
+
* <p>The vector configuration details for the Bedrock embeddings model.</p>
|
|
340
|
+
* @public
|
|
341
|
+
*/
|
|
342
|
+
export interface BedrockEmbeddingModelConfiguration {
|
|
343
|
+
/**
|
|
344
|
+
* <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
|
|
345
|
+
* @public
|
|
346
|
+
*/
|
|
347
|
+
dimensions?: number | undefined;
|
|
348
|
+
/**
|
|
349
|
+
* <p>The data type for the vectors when using a model to convert text into vector
|
|
350
|
+
* embeddings. The model must support the specified data type for vector embeddings.
|
|
351
|
+
* Floating-point (float32) is the default data type, and is supported by most models
|
|
352
|
+
* for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings
|
|
353
|
+
* models</a> for information on the available models and their vector data types.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
embeddingDataType?: EmbeddingDataType | undefined;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* <p>The configuration details for the embeddings model.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
export interface EmbeddingModelConfiguration {
|
|
363
|
+
/**
|
|
364
|
+
* <p>The vector configuration details on the Bedrock embeddings model.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
export interface VectorKnowledgeBaseConfiguration {
|
|
374
|
+
/**
|
|
375
|
+
* <p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
embeddingModelArn: string | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* <p>The embeddings model configuration details for the vector model used in Knowledge Base.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
embeddingModelConfiguration?: EmbeddingModelConfiguration | undefined;
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* <p>Contains details about the vector embeddings configuration of the knowledge base.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
export interface KnowledgeBaseConfiguration {
|
|
390
|
+
/**
|
|
391
|
+
* <p>The type of data that the data source is converted into for the knowledge base.</p>
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
type: KnowledgeBaseType | undefined;
|
|
395
|
+
/**
|
|
396
|
+
* <p>Contains details about the model that's used to convert the data source into vector embeddings.</p>
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
export interface MongoDbAtlasFieldMapping {
|
|
406
|
+
/**
|
|
407
|
+
* <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
vectorField: string | undefined;
|
|
411
|
+
/**
|
|
412
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
textField: string | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
metadataField: string | undefined;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* <p>Contains details about the storage configuration of the knowledge base in MongoDB Atlas. </p>
|
|
424
|
+
* @public
|
|
425
|
+
*/
|
|
426
|
+
export interface MongoDbAtlasConfiguration {
|
|
427
|
+
/**
|
|
428
|
+
* <p>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</p>
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
endpoint: string | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* <p>The database name in your MongoDB Atlas cluster for your knowledge base.</p>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
databaseName: string | undefined;
|
|
437
|
+
/**
|
|
438
|
+
* <p>The collection name of the knowledge base in MongoDB Atlas.</p>
|
|
439
|
+
* @public
|
|
440
|
+
*/
|
|
441
|
+
collectionName: string | undefined;
|
|
442
|
+
/**
|
|
443
|
+
* <p>The name of the MongoDB Atlas vector search index.</p>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
vectorIndexName: string | undefined;
|
|
447
|
+
/**
|
|
448
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
credentialsSecretArn: string | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
fieldMapping: MongoDbAtlasFieldMapping | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* <p>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
endpointServiceName?: string | undefined;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export interface OpenSearchServerlessFieldMapping {
|
|
468
|
+
/**
|
|
469
|
+
* <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
vectorField: string | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
textField: string | undefined;
|
|
478
|
+
/**
|
|
479
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
482
|
+
metadataField: string | undefined;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* <p>Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Amazon OpenSearch Service</a>.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
export interface OpenSearchServerlessConfiguration {
|
|
489
|
+
/**
|
|
490
|
+
* <p>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</p>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
collectionArn: string | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* <p>The name of the vector store.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
vectorIndexName: string | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
fieldMapping: OpenSearchServerlessFieldMapping | undefined;
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
export interface PineconeFieldMapping {
|
|
510
|
+
/**
|
|
511
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
textField: string | undefined;
|
|
515
|
+
/**
|
|
516
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
metadataField: string | undefined;
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* <p>Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector index in Pinecone</a>.</p>
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
export interface PineconeConfiguration {
|
|
526
|
+
/**
|
|
527
|
+
* <p>The endpoint URL for your index management page.</p>
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
connectionString: string | undefined;
|
|
531
|
+
/**
|
|
532
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.</p>
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
credentialsSecretArn: string | undefined;
|
|
536
|
+
/**
|
|
537
|
+
* <p>The namespace to be used to write new data to your database.</p>
|
|
538
|
+
* @public
|
|
539
|
+
*/
|
|
540
|
+
namespace?: string | undefined;
|
|
541
|
+
/**
|
|
542
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
543
|
+
* @public
|
|
544
|
+
*/
|
|
545
|
+
fieldMapping: PineconeFieldMapping | undefined;
|
|
546
|
+
}
|
|
547
|
+
/**
|
|
548
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
export interface RdsFieldMapping {
|
|
552
|
+
/**
|
|
553
|
+
* <p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
primaryKeyField: string | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
vectorField: string | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
textField: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
metadataField: string | undefined;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
export interface RdsConfiguration {
|
|
578
|
+
/**
|
|
579
|
+
* <p>The Amazon Resource Name (ARN) of the vector store.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
resourceArn: string | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
credentialsSecretArn: string | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The name of your Amazon RDS database.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
databaseName: string | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The name of the table in the database.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
tableName: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
fieldMapping: RdsFieldMapping | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
606
|
+
* @public
|
|
607
|
+
*/
|
|
608
|
+
export interface RedisEnterpriseCloudFieldMapping {
|
|
609
|
+
/**
|
|
610
|
+
* <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
|
|
611
|
+
* @public
|
|
612
|
+
*/
|
|
613
|
+
vectorField: string | undefined;
|
|
614
|
+
/**
|
|
615
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
textField: string | undefined;
|
|
619
|
+
/**
|
|
620
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
621
|
+
* @public
|
|
622
|
+
*/
|
|
623
|
+
metadataField: string | undefined;
|
|
624
|
+
}
|
|
625
|
+
/**
|
|
626
|
+
* <p>Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Redis Enterprise Cloud</a>.</p>
|
|
627
|
+
* @public
|
|
628
|
+
*/
|
|
629
|
+
export interface RedisEnterpriseCloudConfiguration {
|
|
630
|
+
/**
|
|
631
|
+
* <p>The endpoint URL of the Redis Enterprise Cloud database.</p>
|
|
632
|
+
* @public
|
|
633
|
+
*/
|
|
634
|
+
endpoint: string | undefined;
|
|
635
|
+
/**
|
|
636
|
+
* <p>The name of the vector index.</p>
|
|
637
|
+
* @public
|
|
638
|
+
*/
|
|
639
|
+
vectorIndexName: string | undefined;
|
|
640
|
+
/**
|
|
641
|
+
* <p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.</p>
|
|
642
|
+
* @public
|
|
643
|
+
*/
|
|
644
|
+
credentialsSecretArn: string | undefined;
|
|
645
|
+
/**
|
|
646
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
647
|
+
* @public
|
|
648
|
+
*/
|
|
649
|
+
fieldMapping: RedisEnterpriseCloudFieldMapping | undefined;
|
|
650
|
+
}
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
* @enum
|
|
654
|
+
*/
|
|
655
|
+
export declare const KnowledgeBaseStorageType: {
|
|
656
|
+
readonly MONGO_DB_ATLAS: "MONGO_DB_ATLAS";
|
|
657
|
+
readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
|
|
658
|
+
readonly PINECONE: "PINECONE";
|
|
659
|
+
readonly RDS: "RDS";
|
|
660
|
+
readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
|
|
661
|
+
};
|
|
662
|
+
/**
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType];
|
|
666
|
+
/**
|
|
667
|
+
* <p>Contains the storage configuration of the knowledge base.</p>
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
export interface StorageConfiguration {
|
|
671
|
+
/**
|
|
672
|
+
* <p>The vector store service in which the knowledge base is stored.</p>
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
type: KnowledgeBaseStorageType | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* <p>Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
pineconeConfiguration?: PineconeConfiguration | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.</p>
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
rdsConfiguration?: RdsConfiguration | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>Contains the storage configuration of the knowledge base in MongoDB Atlas.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
export interface CreateKnowledgeBaseRequest {
|
|
706
|
+
/**
|
|
707
|
+
* <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,
|
|
708
|
+
* 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>
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
clientToken?: string | undefined;
|
|
712
|
+
/**
|
|
713
|
+
* <p>A name for the knowledge base.</p>
|
|
714
|
+
* @public
|
|
715
|
+
*/
|
|
716
|
+
name: string | undefined;
|
|
717
|
+
/**
|
|
718
|
+
* <p>A description of the knowledge base.</p>
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
description?: string | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
roleArn: string | undefined;
|
|
727
|
+
/**
|
|
728
|
+
* <p>Contains details about the embeddings model used for the knowledge base.</p>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* <p>Contains details about the configuration of the vector database used for the knowledge base.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
tags?: Record<string, string> | undefined;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
* @enum
|
|
746
|
+
*/
|
|
747
|
+
export declare const KnowledgeBaseStatus: {
|
|
748
|
+
readonly ACTIVE: "ACTIVE";
|
|
749
|
+
readonly CREATING: "CREATING";
|
|
750
|
+
readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
|
|
751
|
+
readonly DELETING: "DELETING";
|
|
752
|
+
readonly FAILED: "FAILED";
|
|
753
|
+
readonly UPDATING: "UPDATING";
|
|
754
|
+
};
|
|
755
|
+
/**
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
759
|
+
/**
|
|
760
|
+
* <p>Contains information about a knowledge base.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
export interface KnowledgeBase {
|
|
764
|
+
/**
|
|
765
|
+
* <p>The unique identifier of the knowledge base.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
knowledgeBaseId: string | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* <p>The name of the knowledge base.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
name: string | undefined;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
knowledgeBaseArn: string | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>The description of the knowledge base.</p>
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
description?: string | undefined;
|
|
784
|
+
/**
|
|
785
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
roleArn: string | undefined;
|
|
789
|
+
/**
|
|
790
|
+
* <p>Contains details about the embeddings configuration of the knowledge base.</p>
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>Contains details about the storage configuration of the knowledge base.</p>
|
|
796
|
+
* @public
|
|
797
|
+
*/
|
|
798
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
799
|
+
/**
|
|
800
|
+
* <p>The status of the knowledge base. The following statuses are possible:</p>
|
|
801
|
+
* <ul>
|
|
802
|
+
* <li>
|
|
803
|
+
* <p>CREATING – The knowledge base is being created.</p>
|
|
804
|
+
* </li>
|
|
805
|
+
* <li>
|
|
806
|
+
* <p>ACTIVE – The knowledge base is ready to be queried.</p>
|
|
807
|
+
* </li>
|
|
808
|
+
* <li>
|
|
809
|
+
* <p>DELETING – The knowledge base is being deleted.</p>
|
|
810
|
+
* </li>
|
|
811
|
+
* <li>
|
|
812
|
+
* <p>UPDATING – The knowledge base is being updated.</p>
|
|
813
|
+
* </li>
|
|
814
|
+
* <li>
|
|
815
|
+
* <p>FAILED – The knowledge base API operation failed.</p>
|
|
816
|
+
* </li>
|
|
817
|
+
* </ul>
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
status: KnowledgeBaseStatus | undefined;
|
|
821
|
+
/**
|
|
822
|
+
* <p>The time the knowledge base was created.</p>
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
createdAt: Date | undefined;
|
|
826
|
+
/**
|
|
827
|
+
* <p>The time the knowledge base was last updated.</p>
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
updatedAt: Date | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>A list of reasons that the API operation on the knowledge base failed.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
failureReasons?: string[] | undefined;
|
|
836
|
+
}
|
|
837
|
+
/**
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
export interface CreateKnowledgeBaseResponse {
|
|
841
|
+
/**
|
|
842
|
+
* <p>Contains details about the knowledge base.</p>
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
knowledgeBase: KnowledgeBase | undefined;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
851
|
+
/**
|
|
852
|
+
* <p>The unique identifier of the knowledge base to delete.</p>
|
|
853
|
+
* @public
|
|
854
|
+
*/
|
|
855
|
+
knowledgeBaseId: string | undefined;
|
|
856
|
+
}
|
|
857
|
+
/**
|
|
858
|
+
* @public
|
|
859
|
+
*/
|
|
860
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
861
|
+
/**
|
|
862
|
+
* <p>The unique identifier of the knowledge base that was deleted.</p>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
knowledgeBaseId: string | undefined;
|
|
866
|
+
/**
|
|
867
|
+
* <p>The status of the knowledge base and whether it has been successfully deleted.</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
status: KnowledgeBaseStatus | undefined;
|
|
871
|
+
}
|
|
872
|
+
/**
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
export interface DisassociateAgentKnowledgeBaseRequest {
|
|
876
|
+
/**
|
|
877
|
+
* <p>The unique identifier of the agent from which to disassociate the knowledge base.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
agentId: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>The version of the agent from which to disassociate the knowledge base.</p>
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
agentVersion: string | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* <p>The unique identifier of the knowledge base to disassociate.</p>
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
knowledgeBaseId: string | undefined;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
export interface DisassociateAgentKnowledgeBaseResponse {
|
|
896
|
+
}
|
|
3
897
|
/**
|
|
4
898
|
* @public
|
|
5
899
|
*/
|
|
@@ -970,6 +1864,34 @@ export interface ListAgentVersionsResponse {
|
|
|
970
1864
|
*/
|
|
971
1865
|
nextToken?: string | undefined;
|
|
972
1866
|
}
|
|
1867
|
+
/**
|
|
1868
|
+
* @internal
|
|
1869
|
+
*/
|
|
1870
|
+
export declare const CustomContentFilterSensitiveLog: (obj: CustomContent) => any;
|
|
1871
|
+
/**
|
|
1872
|
+
* @internal
|
|
1873
|
+
*/
|
|
1874
|
+
export declare const DocumentContentFilterSensitiveLog: (obj: DocumentContent) => any;
|
|
1875
|
+
/**
|
|
1876
|
+
* @internal
|
|
1877
|
+
*/
|
|
1878
|
+
export declare const MetadataAttributeValueFilterSensitiveLog: (obj: MetadataAttributeValue) => any;
|
|
1879
|
+
/**
|
|
1880
|
+
* @internal
|
|
1881
|
+
*/
|
|
1882
|
+
export declare const MetadataAttributeFilterSensitiveLog: (obj: MetadataAttribute) => any;
|
|
1883
|
+
/**
|
|
1884
|
+
* @internal
|
|
1885
|
+
*/
|
|
1886
|
+
export declare const DocumentMetadataFilterSensitiveLog: (obj: DocumentMetadata) => any;
|
|
1887
|
+
/**
|
|
1888
|
+
* @internal
|
|
1889
|
+
*/
|
|
1890
|
+
export declare const KnowledgeBaseDocumentFilterSensitiveLog: (obj: KnowledgeBaseDocument) => any;
|
|
1891
|
+
/**
|
|
1892
|
+
* @internal
|
|
1893
|
+
*/
|
|
1894
|
+
export declare const IngestKnowledgeBaseDocumentsRequestFilterSensitiveLog: (obj: IngestKnowledgeBaseDocumentsRequest) => any;
|
|
973
1895
|
/**
|
|
974
1896
|
* @internal
|
|
975
1897
|
*/
|