@aws-sdk/client-bedrock-agent 3.702.0 → 3.703.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 +32 -0
- package/dist-cjs/index.js +422 -22
- package/dist-es/BedrockAgent.js +8 -0
- package/dist-es/commands/DeleteKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/GetKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/IngestKnowledgeBaseDocumentsCommand.js +23 -0
- package/dist-es/commands/ListKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +80 -18
- package/dist-es/models/models_1.js +22 -0
- package/dist-es/pagination/ListKnowledgeBaseDocumentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +208 -0
- package/dist-types/BedrockAgent.d.ts +28 -0
- package/dist-types/BedrockAgentClient.d.ts +6 -2
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- 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/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- 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/ListKnowledgeBaseDocumentsCommand.d.ts +110 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +370 -351
- package/dist-types/models/models_1.d.ts +623 -1
- package/dist-types/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +68 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +24 -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/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- 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/ListKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +161 -147
- package/dist-types/ts3.4/models/models_1.d.ts +167 -4
- package/dist-types/ts3.4/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +1 -1
|
@@ -20,6 +20,7 @@ import { DeleteFlowAliasCommandInput, DeleteFlowAliasCommandOutput } from "./com
|
|
|
20
20
|
import { DeleteFlowCommandInput, DeleteFlowCommandOutput } from "./commands/DeleteFlowCommand";
|
|
21
21
|
import { DeleteFlowVersionCommandInput, DeleteFlowVersionCommandOutput } from "./commands/DeleteFlowVersionCommand";
|
|
22
22
|
import { DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput } from "./commands/DeleteKnowledgeBaseCommand";
|
|
23
|
+
import { DeleteKnowledgeBaseDocumentsCommandInput, DeleteKnowledgeBaseDocumentsCommandOutput } from "./commands/DeleteKnowledgeBaseDocumentsCommand";
|
|
23
24
|
import { DeletePromptCommandInput, DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
|
|
24
25
|
import { DisassociateAgentKnowledgeBaseCommandInput, DisassociateAgentKnowledgeBaseCommandOutput } from "./commands/DisassociateAgentKnowledgeBaseCommand";
|
|
25
26
|
import { GetAgentActionGroupCommandInput, GetAgentActionGroupCommandOutput } from "./commands/GetAgentActionGroupCommand";
|
|
@@ -33,7 +34,9 @@ import { GetFlowCommandInput, GetFlowCommandOutput } from "./commands/GetFlowCom
|
|
|
33
34
|
import { GetFlowVersionCommandInput, GetFlowVersionCommandOutput } from "./commands/GetFlowVersionCommand";
|
|
34
35
|
import { GetIngestionJobCommandInput, GetIngestionJobCommandOutput } from "./commands/GetIngestionJobCommand";
|
|
35
36
|
import { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from "./commands/GetKnowledgeBaseCommand";
|
|
37
|
+
import { GetKnowledgeBaseDocumentsCommandInput, GetKnowledgeBaseDocumentsCommandOutput } from "./commands/GetKnowledgeBaseDocumentsCommand";
|
|
36
38
|
import { GetPromptCommandInput, GetPromptCommandOutput } from "./commands/GetPromptCommand";
|
|
39
|
+
import { IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput } from "./commands/IngestKnowledgeBaseDocumentsCommand";
|
|
37
40
|
import { ListAgentActionGroupsCommandInput, ListAgentActionGroupsCommandOutput } from "./commands/ListAgentActionGroupsCommand";
|
|
38
41
|
import { ListAgentAliasesCommandInput, ListAgentAliasesCommandOutput } from "./commands/ListAgentAliasesCommand";
|
|
39
42
|
import { ListAgentKnowledgeBasesCommandInput, ListAgentKnowledgeBasesCommandOutput } from "./commands/ListAgentKnowledgeBasesCommand";
|
|
@@ -44,6 +47,7 @@ import { ListFlowAliasesCommandInput, ListFlowAliasesCommandOutput } from "./com
|
|
|
44
47
|
import { ListFlowsCommandInput, ListFlowsCommandOutput } from "./commands/ListFlowsCommand";
|
|
45
48
|
import { ListFlowVersionsCommandInput, ListFlowVersionsCommandOutput } from "./commands/ListFlowVersionsCommand";
|
|
46
49
|
import { ListIngestionJobsCommandInput, ListIngestionJobsCommandOutput } from "./commands/ListIngestionJobsCommand";
|
|
50
|
+
import { ListKnowledgeBaseDocumentsCommandInput, ListKnowledgeBaseDocumentsCommandOutput } from "./commands/ListKnowledgeBaseDocumentsCommand";
|
|
47
51
|
import { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
|
|
48
52
|
import { ListPromptsCommandInput, ListPromptsCommandOutput } from "./commands/ListPromptsCommand";
|
|
49
53
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
@@ -184,6 +188,12 @@ export interface BedrockAgent {
|
|
|
184
188
|
deleteKnowledgeBase(args: DeleteKnowledgeBaseCommandInput, options?: __HttpHandlerOptions): Promise<DeleteKnowledgeBaseCommandOutput>;
|
|
185
189
|
deleteKnowledgeBase(args: DeleteKnowledgeBaseCommandInput, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void): void;
|
|
186
190
|
deleteKnowledgeBase(args: DeleteKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void): void;
|
|
191
|
+
/**
|
|
192
|
+
* @see {@link DeleteKnowledgeBaseDocumentsCommand}
|
|
193
|
+
*/
|
|
194
|
+
deleteKnowledgeBaseDocuments(args: DeleteKnowledgeBaseDocumentsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteKnowledgeBaseDocumentsCommandOutput>;
|
|
195
|
+
deleteKnowledgeBaseDocuments(args: DeleteKnowledgeBaseDocumentsCommandInput, cb: (err: any, data?: DeleteKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
196
|
+
deleteKnowledgeBaseDocuments(args: DeleteKnowledgeBaseDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
187
197
|
/**
|
|
188
198
|
* @see {@link DeletePromptCommand}
|
|
189
199
|
*/
|
|
@@ -262,12 +272,24 @@ export interface BedrockAgent {
|
|
|
262
272
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options?: __HttpHandlerOptions): Promise<GetKnowledgeBaseCommandOutput>;
|
|
263
273
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
|
|
264
274
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
|
|
275
|
+
/**
|
|
276
|
+
* @see {@link GetKnowledgeBaseDocumentsCommand}
|
|
277
|
+
*/
|
|
278
|
+
getKnowledgeBaseDocuments(args: GetKnowledgeBaseDocumentsCommandInput, options?: __HttpHandlerOptions): Promise<GetKnowledgeBaseDocumentsCommandOutput>;
|
|
279
|
+
getKnowledgeBaseDocuments(args: GetKnowledgeBaseDocumentsCommandInput, cb: (err: any, data?: GetKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
280
|
+
getKnowledgeBaseDocuments(args: GetKnowledgeBaseDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
265
281
|
/**
|
|
266
282
|
* @see {@link GetPromptCommand}
|
|
267
283
|
*/
|
|
268
284
|
getPrompt(args: GetPromptCommandInput, options?: __HttpHandlerOptions): Promise<GetPromptCommandOutput>;
|
|
269
285
|
getPrompt(args: GetPromptCommandInput, cb: (err: any, data?: GetPromptCommandOutput) => void): void;
|
|
270
286
|
getPrompt(args: GetPromptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPromptCommandOutput) => void): void;
|
|
287
|
+
/**
|
|
288
|
+
* @see {@link IngestKnowledgeBaseDocumentsCommand}
|
|
289
|
+
*/
|
|
290
|
+
ingestKnowledgeBaseDocuments(args: IngestKnowledgeBaseDocumentsCommandInput, options?: __HttpHandlerOptions): Promise<IngestKnowledgeBaseDocumentsCommandOutput>;
|
|
291
|
+
ingestKnowledgeBaseDocuments(args: IngestKnowledgeBaseDocumentsCommandInput, cb: (err: any, data?: IngestKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
292
|
+
ingestKnowledgeBaseDocuments(args: IngestKnowledgeBaseDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IngestKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
271
293
|
/**
|
|
272
294
|
* @see {@link ListAgentActionGroupsCommand}
|
|
273
295
|
*/
|
|
@@ -330,6 +352,12 @@ export interface BedrockAgent {
|
|
|
330
352
|
listIngestionJobs(args: ListIngestionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListIngestionJobsCommandOutput>;
|
|
331
353
|
listIngestionJobs(args: ListIngestionJobsCommandInput, cb: (err: any, data?: ListIngestionJobsCommandOutput) => void): void;
|
|
332
354
|
listIngestionJobs(args: ListIngestionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIngestionJobsCommandOutput) => void): void;
|
|
355
|
+
/**
|
|
356
|
+
* @see {@link ListKnowledgeBaseDocumentsCommand}
|
|
357
|
+
*/
|
|
358
|
+
listKnowledgeBaseDocuments(args: ListKnowledgeBaseDocumentsCommandInput, options?: __HttpHandlerOptions): Promise<ListKnowledgeBaseDocumentsCommandOutput>;
|
|
359
|
+
listKnowledgeBaseDocuments(args: ListKnowledgeBaseDocumentsCommandInput, cb: (err: any, data?: ListKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
360
|
+
listKnowledgeBaseDocuments(args: ListKnowledgeBaseDocumentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKnowledgeBaseDocumentsCommandOutput) => void): void;
|
|
333
361
|
/**
|
|
334
362
|
* @see {@link ListKnowledgeBasesCommand}
|
|
335
363
|
*/
|
|
@@ -27,6 +27,7 @@ import { DeleteFlowAliasCommandInput, DeleteFlowAliasCommandOutput } from "./com
|
|
|
27
27
|
import { DeleteFlowCommandInput, DeleteFlowCommandOutput } from "./commands/DeleteFlowCommand";
|
|
28
28
|
import { DeleteFlowVersionCommandInput, DeleteFlowVersionCommandOutput } from "./commands/DeleteFlowVersionCommand";
|
|
29
29
|
import { DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput } from "./commands/DeleteKnowledgeBaseCommand";
|
|
30
|
+
import { DeleteKnowledgeBaseDocumentsCommandInput, DeleteKnowledgeBaseDocumentsCommandOutput } from "./commands/DeleteKnowledgeBaseDocumentsCommand";
|
|
30
31
|
import { DeletePromptCommandInput, DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
|
|
31
32
|
import { DisassociateAgentKnowledgeBaseCommandInput, DisassociateAgentKnowledgeBaseCommandOutput } from "./commands/DisassociateAgentKnowledgeBaseCommand";
|
|
32
33
|
import { GetAgentActionGroupCommandInput, GetAgentActionGroupCommandOutput } from "./commands/GetAgentActionGroupCommand";
|
|
@@ -40,7 +41,9 @@ import { GetFlowCommandInput, GetFlowCommandOutput } from "./commands/GetFlowCom
|
|
|
40
41
|
import { GetFlowVersionCommandInput, GetFlowVersionCommandOutput } from "./commands/GetFlowVersionCommand";
|
|
41
42
|
import { GetIngestionJobCommandInput, GetIngestionJobCommandOutput } from "./commands/GetIngestionJobCommand";
|
|
42
43
|
import { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from "./commands/GetKnowledgeBaseCommand";
|
|
44
|
+
import { GetKnowledgeBaseDocumentsCommandInput, GetKnowledgeBaseDocumentsCommandOutput } from "./commands/GetKnowledgeBaseDocumentsCommand";
|
|
43
45
|
import { GetPromptCommandInput, GetPromptCommandOutput } from "./commands/GetPromptCommand";
|
|
46
|
+
import { IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput } from "./commands/IngestKnowledgeBaseDocumentsCommand";
|
|
44
47
|
import { ListAgentActionGroupsCommandInput, ListAgentActionGroupsCommandOutput } from "./commands/ListAgentActionGroupsCommand";
|
|
45
48
|
import { ListAgentAliasesCommandInput, ListAgentAliasesCommandOutput } from "./commands/ListAgentAliasesCommand";
|
|
46
49
|
import { ListAgentKnowledgeBasesCommandInput, ListAgentKnowledgeBasesCommandOutput } from "./commands/ListAgentKnowledgeBasesCommand";
|
|
@@ -51,6 +54,7 @@ import { ListFlowAliasesCommandInput, ListFlowAliasesCommandOutput } from "./com
|
|
|
51
54
|
import { ListFlowsCommandInput, ListFlowsCommandOutput } from "./commands/ListFlowsCommand";
|
|
52
55
|
import { ListFlowVersionsCommandInput, ListFlowVersionsCommandOutput } from "./commands/ListFlowVersionsCommand";
|
|
53
56
|
import { ListIngestionJobsCommandInput, ListIngestionJobsCommandOutput } from "./commands/ListIngestionJobsCommand";
|
|
57
|
+
import { ListKnowledgeBaseDocumentsCommandInput, ListKnowledgeBaseDocumentsCommandOutput } from "./commands/ListKnowledgeBaseDocumentsCommand";
|
|
54
58
|
import { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
|
|
55
59
|
import { ListPromptsCommandInput, ListPromptsCommandOutput } from "./commands/ListPromptsCommand";
|
|
56
60
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
@@ -76,11 +80,11 @@ export { __Client };
|
|
|
76
80
|
/**
|
|
77
81
|
* @public
|
|
78
82
|
*/
|
|
79
|
-
export type ServiceInputTypes = AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeletePromptCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetPromptCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListTagsForResourceCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | StartIngestionJobCommandInput | StopIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput | ValidateFlowDefinitionCommandInput;
|
|
83
|
+
export type ServiceInputTypes = AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeleteKnowledgeBaseDocumentsCommandInput | DeletePromptCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetKnowledgeBaseDocumentsCommandInput | GetPromptCommandInput | IngestKnowledgeBaseDocumentsCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBaseDocumentsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListTagsForResourceCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | StartIngestionJobCommandInput | StopIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput | ValidateFlowDefinitionCommandInput;
|
|
80
84
|
/**
|
|
81
85
|
* @public
|
|
82
86
|
*/
|
|
83
|
-
export type ServiceOutputTypes = AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeletePromptCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetPromptCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListTagsForResourceCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | StartIngestionJobCommandOutput | StopIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput | ValidateFlowDefinitionCommandOutput;
|
|
87
|
+
export type ServiceOutputTypes = AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeleteKnowledgeBaseDocumentsCommandOutput | DeletePromptCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetKnowledgeBaseDocumentsCommandOutput | GetPromptCommandOutput | IngestKnowledgeBaseDocumentsCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBaseDocumentsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListTagsForResourceCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | StartIngestionJobCommandOutput | StopIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput | ValidateFlowDefinitionCommandOutput;
|
|
84
88
|
/**
|
|
85
89
|
* @public
|
|
86
90
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
-
import { AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse } from "../models/
|
|
4
|
+
import { AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -27,7 +27,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the <code>dataSourceConfiguration</code> field.</p>
|
|
31
31
|
* <important>
|
|
32
32
|
* <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector.</p>
|
|
33
33
|
* </important>
|
|
@@ -43,7 +43,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
43
43
|
* name: "STRING_VALUE", // required
|
|
44
44
|
* description: "STRING_VALUE",
|
|
45
45
|
* dataSourceConfiguration: { // DataSourceConfiguration
|
|
46
|
-
* type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
46
|
+
* type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
|
|
47
47
|
* s3Configuration: { // S3DataSourceConfiguration
|
|
48
48
|
* bucketArn: "STRING_VALUE", // required
|
|
49
49
|
* inclusionPrefixes: [ // S3Prefixes
|
|
@@ -213,7 +213,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
213
213
|
* // status: "AVAILABLE" || "DELETING" || "DELETE_UNSUCCESSFUL", // required
|
|
214
214
|
* // description: "STRING_VALUE",
|
|
215
215
|
* // dataSourceConfiguration: { // DataSourceConfiguration
|
|
216
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
216
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
|
|
217
217
|
* // s3Configuration: { // S3DataSourceConfiguration
|
|
218
218
|
* // bucketArn: "STRING_VALUE", // required
|
|
219
219
|
* // inclusionPrefixes: [ // S3Prefixes
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
-
import { CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse } from "../models/
|
|
4
|
+
import { CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
-
import { DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse } from "../models/
|
|
4
|
+
import { DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
+
import { DeleteKnowledgeBaseDocumentsRequest, DeleteKnowledgeBaseDocumentsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteKnowledgeBaseDocumentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteKnowledgeBaseDocumentsCommandInput extends DeleteKnowledgeBaseDocumentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteKnowledgeBaseDocumentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteKnowledgeBaseDocumentsCommandOutput extends DeleteKnowledgeBaseDocumentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteKnowledgeBaseDocumentsCommand_base: {
|
|
25
|
+
new (input: DeleteKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKnowledgeBaseDocumentsCommandInput, DeleteKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKnowledgeBaseDocumentsCommandInput, DeleteKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentClient, DeleteKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentClient, DeleteKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentClient(config);
|
|
37
|
+
* const input = { // DeleteKnowledgeBaseDocumentsRequest
|
|
38
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
39
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
40
|
+
* clientToken: "STRING_VALUE",
|
|
41
|
+
* documentIdentifiers: [ // DocumentIdentifiers // required
|
|
42
|
+
* { // DocumentIdentifier
|
|
43
|
+
* dataSourceType: "CUSTOM" || "S3", // required
|
|
44
|
+
* s3: { // S3Location
|
|
45
|
+
* uri: "STRING_VALUE", // required
|
|
46
|
+
* },
|
|
47
|
+
* custom: { // CustomDocumentIdentifier
|
|
48
|
+
* id: "STRING_VALUE", // required
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* ],
|
|
52
|
+
* };
|
|
53
|
+
* const command = new DeleteKnowledgeBaseDocumentsCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // { // DeleteKnowledgeBaseDocumentsResponse
|
|
56
|
+
* // documentDetails: [ // KnowledgeBaseDocumentDetails
|
|
57
|
+
* // { // KnowledgeBaseDocumentDetail
|
|
58
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
59
|
+
* // dataSourceId: "STRING_VALUE", // required
|
|
60
|
+
* // status: "INDEXED" || "PARTIALLY_INDEXED" || "PENDING" || "FAILED" || "METADATA_PARTIALLY_INDEXED" || "METADATA_UPDATE_FAILED" || "IGNORED" || "NOT_FOUND" || "STARTING" || "IN_PROGRESS" || "DELETING" || "DELETE_IN_PROGRESS", // required
|
|
61
|
+
* // identifier: { // DocumentIdentifier
|
|
62
|
+
* // dataSourceType: "CUSTOM" || "S3", // required
|
|
63
|
+
* // s3: { // S3Location
|
|
64
|
+
* // uri: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // custom: { // CustomDocumentIdentifier
|
|
67
|
+
* // id: "STRING_VALUE", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // statusReason: "STRING_VALUE",
|
|
71
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @param DeleteKnowledgeBaseDocumentsCommandInput - {@link DeleteKnowledgeBaseDocumentsCommandInput}
|
|
79
|
+
* @returns {@link DeleteKnowledgeBaseDocumentsCommandOutput}
|
|
80
|
+
* @see {@link DeleteKnowledgeBaseDocumentsCommandInput} for command's `input` shape.
|
|
81
|
+
* @see {@link DeleteKnowledgeBaseDocumentsCommandOutput} for command's `response` shape.
|
|
82
|
+
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
85
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InternalServerException} (server fault)
|
|
88
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
94
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
97
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link BedrockAgentServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class DeleteKnowledgeBaseDocumentsCommand extends DeleteKnowledgeBaseDocumentsCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: DeleteKnowledgeBaseDocumentsRequest;
|
|
112
|
+
output: DeleteKnowledgeBaseDocumentsResponse;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: DeleteKnowledgeBaseDocumentsCommandInput;
|
|
116
|
+
output: DeleteKnowledgeBaseDocumentsCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
-
import { DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse } from "../models/
|
|
4
|
+
import { DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -48,7 +48,7 @@ declare const GetDataSourceCommand_base: {
|
|
|
48
48
|
* // status: "AVAILABLE" || "DELETING" || "DELETE_UNSUCCESSFUL", // required
|
|
49
49
|
* // description: "STRING_VALUE",
|
|
50
50
|
* // dataSourceConfiguration: { // DataSourceConfiguration
|
|
51
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
51
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
|
|
52
52
|
* // s3Configuration: { // S3DataSourceConfiguration
|
|
53
53
|
* // bucketArn: "STRING_VALUE", // required
|
|
54
54
|
* // inclusionPrefixes: [ // S3Prefixes
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
+
import { GetKnowledgeBaseDocumentsRequest, GetKnowledgeBaseDocumentsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetKnowledgeBaseDocumentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetKnowledgeBaseDocumentsCommandInput extends GetKnowledgeBaseDocumentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetKnowledgeBaseDocumentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetKnowledgeBaseDocumentsCommandOutput extends GetKnowledgeBaseDocumentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetKnowledgeBaseDocumentsCommand_base: {
|
|
25
|
+
new (input: GetKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<GetKnowledgeBaseDocumentsCommandInput, GetKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<GetKnowledgeBaseDocumentsCommandInput, GetKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentClient, GetKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentClient, GetKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentClient(config);
|
|
37
|
+
* const input = { // GetKnowledgeBaseDocumentsRequest
|
|
38
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
39
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
40
|
+
* documentIdentifiers: [ // DocumentIdentifiers // required
|
|
41
|
+
* { // DocumentIdentifier
|
|
42
|
+
* dataSourceType: "CUSTOM" || "S3", // required
|
|
43
|
+
* s3: { // S3Location
|
|
44
|
+
* uri: "STRING_VALUE", // required
|
|
45
|
+
* },
|
|
46
|
+
* custom: { // CustomDocumentIdentifier
|
|
47
|
+
* id: "STRING_VALUE", // required
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
51
|
+
* };
|
|
52
|
+
* const command = new GetKnowledgeBaseDocumentsCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* // { // GetKnowledgeBaseDocumentsResponse
|
|
55
|
+
* // documentDetails: [ // KnowledgeBaseDocumentDetails
|
|
56
|
+
* // { // KnowledgeBaseDocumentDetail
|
|
57
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
58
|
+
* // dataSourceId: "STRING_VALUE", // required
|
|
59
|
+
* // status: "INDEXED" || "PARTIALLY_INDEXED" || "PENDING" || "FAILED" || "METADATA_PARTIALLY_INDEXED" || "METADATA_UPDATE_FAILED" || "IGNORED" || "NOT_FOUND" || "STARTING" || "IN_PROGRESS" || "DELETING" || "DELETE_IN_PROGRESS", // required
|
|
60
|
+
* // identifier: { // DocumentIdentifier
|
|
61
|
+
* // dataSourceType: "CUSTOM" || "S3", // required
|
|
62
|
+
* // s3: { // S3Location
|
|
63
|
+
* // uri: "STRING_VALUE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // custom: { // CustomDocumentIdentifier
|
|
66
|
+
* // id: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // statusReason: "STRING_VALUE",
|
|
70
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param GetKnowledgeBaseDocumentsCommandInput - {@link GetKnowledgeBaseDocumentsCommandInput}
|
|
78
|
+
* @returns {@link GetKnowledgeBaseDocumentsCommandOutput}
|
|
79
|
+
* @see {@link GetKnowledgeBaseDocumentsCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link GetKnowledgeBaseDocumentsCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
84
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InternalServerException} (server fault)
|
|
87
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
93
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
96
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ValidationException} (client fault)
|
|
99
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link BedrockAgentServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
103
|
+
*
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export declare class GetKnowledgeBaseDocumentsCommand extends GetKnowledgeBaseDocumentsCommand_base {
|
|
107
|
+
/** @internal type navigation helper, not in runtime. */
|
|
108
|
+
protected static __types: {
|
|
109
|
+
api: {
|
|
110
|
+
input: GetKnowledgeBaseDocumentsRequest;
|
|
111
|
+
output: GetKnowledgeBaseDocumentsResponse;
|
|
112
|
+
};
|
|
113
|
+
sdk: {
|
|
114
|
+
input: GetKnowledgeBaseDocumentsCommandInput;
|
|
115
|
+
output: GetKnowledgeBaseDocumentsCommandOutput;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
}
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
|
|
4
|
+
import { IngestKnowledgeBaseDocumentsRequest, IngestKnowledgeBaseDocumentsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link IngestKnowledgeBaseDocumentsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface IngestKnowledgeBaseDocumentsCommandInput extends IngestKnowledgeBaseDocumentsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link IngestKnowledgeBaseDocumentsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface IngestKnowledgeBaseDocumentsCommandOutput extends IngestKnowledgeBaseDocumentsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const IngestKnowledgeBaseDocumentsCommand_base: {
|
|
25
|
+
new (input: IngestKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: IngestKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Ingests documents directly into the knowledge base that is connected to the data source. The <code>dataSourceType</code> specified in the content for each document must match the type of the data source that you specify in the header. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentClient, IngestKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentClient, IngestKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentClient(config);
|
|
37
|
+
* const input = { // IngestKnowledgeBaseDocumentsRequest
|
|
38
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
39
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
40
|
+
* clientToken: "STRING_VALUE",
|
|
41
|
+
* documents: [ // KnowledgeBaseDocuments // required
|
|
42
|
+
* { // KnowledgeBaseDocument
|
|
43
|
+
* metadata: { // DocumentMetadata
|
|
44
|
+
* type: "IN_LINE_ATTRIBUTE" || "S3_LOCATION", // required
|
|
45
|
+
* inlineAttributes: [ // MetadataAttributes
|
|
46
|
+
* { // MetadataAttribute
|
|
47
|
+
* key: "STRING_VALUE", // required
|
|
48
|
+
* value: { // MetadataAttributeValue
|
|
49
|
+
* type: "BOOLEAN" || "NUMBER" || "STRING" || "STRING_LIST", // required
|
|
50
|
+
* numberValue: Number("double"),
|
|
51
|
+
* booleanValue: true || false,
|
|
52
|
+
* stringValue: "STRING_VALUE",
|
|
53
|
+
* stringListValue: [ // StringListValue
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* },
|
|
57
|
+
* },
|
|
58
|
+
* ],
|
|
59
|
+
* s3Location: { // CustomS3Location
|
|
60
|
+
* uri: "STRING_VALUE", // required
|
|
61
|
+
* bucketOwnerAccountId: "STRING_VALUE",
|
|
62
|
+
* },
|
|
63
|
+
* },
|
|
64
|
+
* content: { // DocumentContent
|
|
65
|
+
* dataSourceType: "CUSTOM" || "S3", // required
|
|
66
|
+
* custom: { // CustomContent
|
|
67
|
+
* customDocumentIdentifier: { // CustomDocumentIdentifier
|
|
68
|
+
* id: "STRING_VALUE", // required
|
|
69
|
+
* },
|
|
70
|
+
* sourceType: "IN_LINE" || "S3_LOCATION", // required
|
|
71
|
+
* s3Location: {
|
|
72
|
+
* uri: "STRING_VALUE", // required
|
|
73
|
+
* bucketOwnerAccountId: "STRING_VALUE",
|
|
74
|
+
* },
|
|
75
|
+
* inlineContent: { // InlineContent
|
|
76
|
+
* type: "BYTE" || "TEXT", // required
|
|
77
|
+
* byteContent: { // ByteContentDoc
|
|
78
|
+
* mimeType: "STRING_VALUE", // required
|
|
79
|
+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
80
|
+
* },
|
|
81
|
+
* textContent: { // TextContentDoc
|
|
82
|
+
* data: "STRING_VALUE", // required
|
|
83
|
+
* },
|
|
84
|
+
* },
|
|
85
|
+
* },
|
|
86
|
+
* s3: { // S3Content
|
|
87
|
+
* s3Location: { // S3Location
|
|
88
|
+
* uri: "STRING_VALUE", // required
|
|
89
|
+
* },
|
|
90
|
+
* },
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
93
|
+
* ],
|
|
94
|
+
* };
|
|
95
|
+
* const command = new IngestKnowledgeBaseDocumentsCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* // { // IngestKnowledgeBaseDocumentsResponse
|
|
98
|
+
* // documentDetails: [ // KnowledgeBaseDocumentDetails
|
|
99
|
+
* // { // KnowledgeBaseDocumentDetail
|
|
100
|
+
* // knowledgeBaseId: "STRING_VALUE", // required
|
|
101
|
+
* // dataSourceId: "STRING_VALUE", // required
|
|
102
|
+
* // status: "INDEXED" || "PARTIALLY_INDEXED" || "PENDING" || "FAILED" || "METADATA_PARTIALLY_INDEXED" || "METADATA_UPDATE_FAILED" || "IGNORED" || "NOT_FOUND" || "STARTING" || "IN_PROGRESS" || "DELETING" || "DELETE_IN_PROGRESS", // required
|
|
103
|
+
* // identifier: { // DocumentIdentifier
|
|
104
|
+
* // dataSourceType: "CUSTOM" || "S3", // required
|
|
105
|
+
* // s3: { // S3Location
|
|
106
|
+
* // uri: "STRING_VALUE", // required
|
|
107
|
+
* // },
|
|
108
|
+
* // custom: { // CustomDocumentIdentifier
|
|
109
|
+
* // id: "STRING_VALUE", // required
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // statusReason: "STRING_VALUE",
|
|
113
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // };
|
|
117
|
+
*
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
* @param IngestKnowledgeBaseDocumentsCommandInput - {@link IngestKnowledgeBaseDocumentsCommandInput}
|
|
121
|
+
* @returns {@link IngestKnowledgeBaseDocumentsCommandOutput}
|
|
122
|
+
* @see {@link IngestKnowledgeBaseDocumentsCommandInput} for command's `input` shape.
|
|
123
|
+
* @see {@link IngestKnowledgeBaseDocumentsCommandOutput} for command's `response` shape.
|
|
124
|
+
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
127
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link InternalServerException} (server fault)
|
|
130
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
133
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
134
|
+
*
|
|
135
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
136
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
139
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ValidationException} (client fault)
|
|
142
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link BedrockAgentServiceException}
|
|
145
|
+
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
146
|
+
*
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
export declare class IngestKnowledgeBaseDocumentsCommand extends IngestKnowledgeBaseDocumentsCommand_base {
|
|
150
|
+
/** @internal type navigation helper, not in runtime. */
|
|
151
|
+
protected static __types: {
|
|
152
|
+
api: {
|
|
153
|
+
input: IngestKnowledgeBaseDocumentsRequest;
|
|
154
|
+
output: IngestKnowledgeBaseDocumentsResponse;
|
|
155
|
+
};
|
|
156
|
+
sdk: {
|
|
157
|
+
input: IngestKnowledgeBaseDocumentsCommandInput;
|
|
158
|
+
output: IngestKnowledgeBaseDocumentsCommandOutput;
|
|
159
|
+
};
|
|
160
|
+
};
|
|
161
|
+
}
|