@aws-sdk/client-bedrock-agent-runtime 3.609.0 → 3.614.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 +24 -0
- package/dist-cjs/index.js +672 -71
- package/dist-es/BedrockAgentRuntime.js +6 -0
- package/dist-es/commands/DeleteAgentMemoryCommand.js +24 -0
- package/dist-es/commands/GetAgentMemoryCommand.js +24 -0
- package/dist-es/commands/InvokeFlowCommand.js +29 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +221 -49
- package/dist-es/pagination/GetAgentMemoryPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +311 -3
- package/dist-types/BedrockAgentRuntime.d.ts +21 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +5 -2
- package/dist-types/commands/DeleteAgentMemoryCommand.d.ts +87 -0
- package/dist-types/commands/GetAgentMemoryCommand.d.ts +103 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +134 -4
- package/dist-types/commands/InvokeFlowCommand.d.ts +137 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +18 -1
- package/dist-types/commands/RetrieveCommand.d.ts +13 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +1339 -299
- package/dist-types/pagination/GetAgentMemoryPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +51 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteAgentMemoryCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetAgentMemoryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/InvokeFlowCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +527 -54
- package/dist-types/ts3.4/pagination/GetAgentMemoryPaginator.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 +36 -0
- package/package.json +20 -20
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { GetAgentMemoryRequest, GetAgentMemoryResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAgentMemoryCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAgentMemoryCommandInput extends GetAgentMemoryRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAgentMemoryCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAgentMemoryCommandOutput extends GetAgentMemoryResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetAgentMemoryCommand_base: {
|
|
25
|
+
new (input: GetAgentMemoryCommandInput): import("@smithy/smithy-client").CommandImpl<GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetAgentMemoryCommandInput): import("@smithy/smithy-client").CommandImpl<GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets the sessions stored in the memory of the agent.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, GetAgentMemoryCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, GetAgentMemoryCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // GetAgentMemoryRequest
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxItems: Number("int"),
|
|
40
|
+
* agentId: "STRING_VALUE", // required
|
|
41
|
+
* agentAliasId: "STRING_VALUE", // required
|
|
42
|
+
* memoryType: "SESSION_SUMMARY", // required
|
|
43
|
+
* memoryId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new GetAgentMemoryCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // GetAgentMemoryResponse
|
|
48
|
+
* // nextToken: "STRING_VALUE",
|
|
49
|
+
* // memoryContents: [ // Memories
|
|
50
|
+
* // { // Memory Union: only one key present
|
|
51
|
+
* // sessionSummary: { // MemorySessionSummary
|
|
52
|
+
* // memoryId: "STRING_VALUE",
|
|
53
|
+
* // sessionId: "STRING_VALUE",
|
|
54
|
+
* // sessionStartTime: new Date("TIMESTAMP"),
|
|
55
|
+
* // sessionExpiryTime: new Date("TIMESTAMP"),
|
|
56
|
+
* // summaryText: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param GetAgentMemoryCommandInput - {@link GetAgentMemoryCommandInput}
|
|
65
|
+
* @returns {@link GetAgentMemoryCommandOutput}
|
|
66
|
+
* @see {@link GetAgentMemoryCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link GetAgentMemoryCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
71
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link BadGatewayException} (server fault)
|
|
74
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictException} (client fault)
|
|
77
|
+
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link DependencyFailedException} (client fault)
|
|
80
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InternalServerException} (server fault)
|
|
83
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
86
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
89
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
92
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
99
|
+
*
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export declare class GetAgentMemoryCommand extends GetAgentMemoryCommand_base {
|
|
103
|
+
}
|
|
@@ -28,7 +28,7 @@ declare const InvokeAgentCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <note>
|
|
31
|
-
* <p>The CLI doesn't support <code>InvokeAgent</code>.</p>
|
|
31
|
+
* <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeAgent</code>.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p>
|
|
34
34
|
* <ul>
|
|
@@ -101,6 +101,85 @@ declare const InvokeAgentCommand_base: {
|
|
|
101
101
|
* },
|
|
102
102
|
* ],
|
|
103
103
|
* invocationId: "STRING_VALUE",
|
|
104
|
+
* files: [ // InputFiles
|
|
105
|
+
* { // InputFile
|
|
106
|
+
* name: "STRING_VALUE", // required
|
|
107
|
+
* source: { // FileSource
|
|
108
|
+
* sourceType: "S3" || "BYTE_CONTENT", // required
|
|
109
|
+
* s3Location: { // S3ObjectFile
|
|
110
|
+
* uri: "STRING_VALUE", // required
|
|
111
|
+
* },
|
|
112
|
+
* byteContent: { // ByteContentFile
|
|
113
|
+
* mediaType: "STRING_VALUE", // required
|
|
114
|
+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
115
|
+
* },
|
|
116
|
+
* },
|
|
117
|
+
* useCase: "CODE_INTERPRETER" || "CHAT", // required
|
|
118
|
+
* },
|
|
119
|
+
* ],
|
|
120
|
+
* knowledgeBaseConfigurations: [ // KnowledgeBaseConfigurations
|
|
121
|
+
* { // KnowledgeBaseConfiguration
|
|
122
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
123
|
+
* retrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
|
|
124
|
+
* vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
|
|
125
|
+
* numberOfResults: Number("int"),
|
|
126
|
+
* overrideSearchType: "HYBRID" || "SEMANTIC",
|
|
127
|
+
* filter: { // RetrievalFilter Union: only one key present
|
|
128
|
+
* equals: { // FilterAttribute
|
|
129
|
+
* key: "STRING_VALUE", // required
|
|
130
|
+
* value: "DOCUMENT_VALUE", // required
|
|
131
|
+
* },
|
|
132
|
+
* notEquals: {
|
|
133
|
+
* key: "STRING_VALUE", // required
|
|
134
|
+
* value: "DOCUMENT_VALUE", // required
|
|
135
|
+
* },
|
|
136
|
+
* greaterThan: {
|
|
137
|
+
* key: "STRING_VALUE", // required
|
|
138
|
+
* value: "DOCUMENT_VALUE", // required
|
|
139
|
+
* },
|
|
140
|
+
* greaterThanOrEquals: {
|
|
141
|
+
* key: "STRING_VALUE", // required
|
|
142
|
+
* value: "DOCUMENT_VALUE", // required
|
|
143
|
+
* },
|
|
144
|
+
* lessThan: {
|
|
145
|
+
* key: "STRING_VALUE", // required
|
|
146
|
+
* value: "DOCUMENT_VALUE", // required
|
|
147
|
+
* },
|
|
148
|
+
* lessThanOrEquals: "<FilterAttribute>",
|
|
149
|
+
* in: "<FilterAttribute>",
|
|
150
|
+
* notIn: "<FilterAttribute>",
|
|
151
|
+
* startsWith: "<FilterAttribute>",
|
|
152
|
+
* listContains: "<FilterAttribute>",
|
|
153
|
+
* stringContains: "<FilterAttribute>",
|
|
154
|
+
* andAll: [ // RetrievalFilterList
|
|
155
|
+
* {// Union: only one key present
|
|
156
|
+
* equals: "<FilterAttribute>",
|
|
157
|
+
* notEquals: "<FilterAttribute>",
|
|
158
|
+
* greaterThan: "<FilterAttribute>",
|
|
159
|
+
* greaterThanOrEquals: "<FilterAttribute>",
|
|
160
|
+
* lessThan: "<FilterAttribute>",
|
|
161
|
+
* lessThanOrEquals: "<FilterAttribute>",
|
|
162
|
+
* in: "<FilterAttribute>",
|
|
163
|
+
* notIn: "<FilterAttribute>",
|
|
164
|
+
* startsWith: "<FilterAttribute>",
|
|
165
|
+
* listContains: "<FilterAttribute>",
|
|
166
|
+
* stringContains: "<FilterAttribute>",
|
|
167
|
+
* andAll: [
|
|
168
|
+
* "<RetrievalFilter>",
|
|
169
|
+
* ],
|
|
170
|
+
* orAll: [
|
|
171
|
+
* "<RetrievalFilter>",
|
|
172
|
+
* ],
|
|
173
|
+
* },
|
|
174
|
+
* ],
|
|
175
|
+
* orAll: [
|
|
176
|
+
* "<RetrievalFilter>",
|
|
177
|
+
* ],
|
|
178
|
+
* },
|
|
179
|
+
* },
|
|
180
|
+
* },
|
|
181
|
+
* },
|
|
182
|
+
* ],
|
|
104
183
|
* },
|
|
105
184
|
* agentId: "STRING_VALUE", // required
|
|
106
185
|
* agentAliasId: "STRING_VALUE", // required
|
|
@@ -108,6 +187,7 @@ declare const InvokeAgentCommand_base: {
|
|
|
108
187
|
* endSession: true || false,
|
|
109
188
|
* enableTrace: true || false,
|
|
110
189
|
* inputText: "STRING_VALUE",
|
|
190
|
+
* memoryId: "STRING_VALUE",
|
|
111
191
|
* };
|
|
112
192
|
* const command = new InvokeAgentCommand(input);
|
|
113
193
|
* const response = await client.send(command);
|
|
@@ -133,10 +213,22 @@ declare const InvokeAgentCommand_base: {
|
|
|
133
213
|
* // text: "STRING_VALUE", // required
|
|
134
214
|
* // },
|
|
135
215
|
* // location: { // RetrievalResultLocation
|
|
136
|
-
* // type: "S3", // required
|
|
216
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
137
217
|
* // s3Location: { // RetrievalResultS3Location
|
|
138
218
|
* // uri: "STRING_VALUE",
|
|
139
219
|
* // },
|
|
220
|
+
* // webLocation: { // RetrievalResultWebLocation
|
|
221
|
+
* // url: "STRING_VALUE",
|
|
222
|
+
* // },
|
|
223
|
+
* // confluenceLocation: { // RetrievalResultConfluenceLocation
|
|
224
|
+
* // url: "STRING_VALUE",
|
|
225
|
+
* // },
|
|
226
|
+
* // salesforceLocation: { // RetrievalResultSalesforceLocation
|
|
227
|
+
* // url: "STRING_VALUE",
|
|
228
|
+
* // },
|
|
229
|
+
* // sharePointLocation: { // RetrievalResultSharePointLocation
|
|
230
|
+
* // url: "STRING_VALUE",
|
|
231
|
+
* // },
|
|
140
232
|
* // },
|
|
141
233
|
* // metadata: { // RetrievalResultMetadata
|
|
142
234
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -298,7 +390,7 @@ declare const InvokeAgentCommand_base: {
|
|
|
298
390
|
* // },
|
|
299
391
|
* // invocationInput: { // InvocationInput
|
|
300
392
|
* // traceId: "STRING_VALUE",
|
|
301
|
-
* // invocationType: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "FINISH",
|
|
393
|
+
* // invocationType: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "FINISH" || "ACTION_GROUP_CODE_INTERPRETER",
|
|
302
394
|
* // actionGroupInvocationInput: { // ActionGroupInvocationInput
|
|
303
395
|
* // actionGroupName: "STRING_VALUE",
|
|
304
396
|
* // verb: "STRING_VALUE",
|
|
@@ -322,11 +414,19 @@ declare const InvokeAgentCommand_base: {
|
|
|
322
414
|
* // },
|
|
323
415
|
* // },
|
|
324
416
|
* // function: "STRING_VALUE",
|
|
417
|
+
* // executionType: "LAMBDA" || "RETURN_CONTROL",
|
|
418
|
+
* // invocationId: "STRING_VALUE",
|
|
325
419
|
* // },
|
|
326
420
|
* // knowledgeBaseLookupInput: { // KnowledgeBaseLookupInput
|
|
327
421
|
* // text: "STRING_VALUE",
|
|
328
422
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
329
423
|
* // },
|
|
424
|
+
* // codeInterpreterInvocationInput: { // CodeInterpreterInvocationInput
|
|
425
|
+
* // code: "STRING_VALUE",
|
|
426
|
+
* // files: [ // Files
|
|
427
|
+
* // "STRING_VALUE",
|
|
428
|
+
* // ],
|
|
429
|
+
* // },
|
|
330
430
|
* // },
|
|
331
431
|
* // observation: { // Observation
|
|
332
432
|
* // traceId: "STRING_VALUE",
|
|
@@ -341,10 +441,22 @@ declare const InvokeAgentCommand_base: {
|
|
|
341
441
|
* // text: "STRING_VALUE", // required
|
|
342
442
|
* // },
|
|
343
443
|
* // location: {
|
|
344
|
-
* // type: "S3", // required
|
|
444
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
345
445
|
* // s3Location: {
|
|
346
446
|
* // uri: "STRING_VALUE",
|
|
347
447
|
* // },
|
|
448
|
+
* // webLocation: {
|
|
449
|
+
* // url: "STRING_VALUE",
|
|
450
|
+
* // },
|
|
451
|
+
* // confluenceLocation: {
|
|
452
|
+
* // url: "STRING_VALUE",
|
|
453
|
+
* // },
|
|
454
|
+
* // salesforceLocation: {
|
|
455
|
+
* // url: "STRING_VALUE",
|
|
456
|
+
* // },
|
|
457
|
+
* // sharePointLocation: {
|
|
458
|
+
* // url: "STRING_VALUE",
|
|
459
|
+
* // },
|
|
348
460
|
* // },
|
|
349
461
|
* // metadata: {
|
|
350
462
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -359,6 +471,14 @@ declare const InvokeAgentCommand_base: {
|
|
|
359
471
|
* // text: "STRING_VALUE",
|
|
360
472
|
* // source: "ACTION_GROUP" || "KNOWLEDGE_BASE" || "PARSER",
|
|
361
473
|
* // },
|
|
474
|
+
* // codeInterpreterInvocationOutput: { // CodeInterpreterInvocationOutput
|
|
475
|
+
* // executionOutput: "STRING_VALUE",
|
|
476
|
+
* // executionError: "STRING_VALUE",
|
|
477
|
+
* // files: [
|
|
478
|
+
* // "STRING_VALUE",
|
|
479
|
+
* // ],
|
|
480
|
+
* // executionTimeout: true || false,
|
|
481
|
+
* // },
|
|
362
482
|
* // },
|
|
363
483
|
* // modelInvocationInput: {
|
|
364
484
|
* // traceId: "STRING_VALUE",
|
|
@@ -481,9 +601,19 @@ declare const InvokeAgentCommand_base: {
|
|
|
481
601
|
* // message: "STRING_VALUE",
|
|
482
602
|
* // resourceName: "STRING_VALUE",
|
|
483
603
|
* // },
|
|
604
|
+
* // files: { // FilePart
|
|
605
|
+
* // files: [ // OutputFiles
|
|
606
|
+
* // { // OutputFile
|
|
607
|
+
* // name: "STRING_VALUE",
|
|
608
|
+
* // type: "STRING_VALUE",
|
|
609
|
+
* // bytes: new Uint8Array(),
|
|
610
|
+
* // },
|
|
611
|
+
* // ],
|
|
612
|
+
* // },
|
|
484
613
|
* // },
|
|
485
614
|
* // contentType: "STRING_VALUE", // required
|
|
486
615
|
* // sessionId: "STRING_VALUE", // required
|
|
616
|
+
* // memoryId: "STRING_VALUE",
|
|
487
617
|
* // };
|
|
488
618
|
*
|
|
489
619
|
* ```
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
+
import { InvokeFlowRequest, InvokeFlowResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link InvokeFlowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface InvokeFlowCommandInput extends InvokeFlowRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link InvokeFlowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface InvokeFlowCommandOutput extends InvokeFlowResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const InvokeFlowCommand_base: {
|
|
25
|
+
new (input: InvokeFlowCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeFlowCommandInput, InvokeFlowCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: InvokeFlowCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeFlowCommandInput, InvokeFlowCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html">Test a flow in Amazon Bedrock</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 { BedrockAgentRuntimeClient, InvokeFlowCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, InvokeFlowCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // InvokeFlowRequest
|
|
38
|
+
* flowIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* flowAliasIdentifier: "STRING_VALUE", // required
|
|
40
|
+
* inputs: [ // FlowInputs // required
|
|
41
|
+
* { // FlowInput
|
|
42
|
+
* nodeName: "STRING_VALUE", // required
|
|
43
|
+
* nodeOutputName: "STRING_VALUE", // required
|
|
44
|
+
* content: { // FlowInputContent Union: only one key present
|
|
45
|
+
* document: "DOCUMENT_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* };
|
|
50
|
+
* const command = new InvokeFlowCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // InvokeFlowResponse
|
|
53
|
+
* // responseStream: { // FlowResponseStream Union: only one key present
|
|
54
|
+
* // flowOutputEvent: { // FlowOutputEvent
|
|
55
|
+
* // nodeName: "STRING_VALUE", // required
|
|
56
|
+
* // nodeType: "FlowInputNode" || "FlowOutputNode" || "LambdaFunctionNode" || "KnowledgeBaseNode" || "PromptNode" || "ConditionNode" || "LexNode", // required
|
|
57
|
+
* // content: { // FlowOutputContent Union: only one key present
|
|
58
|
+
* // document: "DOCUMENT_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // flowCompletionEvent: { // FlowCompletionEvent
|
|
62
|
+
* // completionReason: "SUCCESS", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // internalServerException: { // InternalServerException
|
|
65
|
+
* // message: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // validationException: { // ValidationException
|
|
68
|
+
* // message: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // resourceNotFoundException: { // ResourceNotFoundException
|
|
71
|
+
* // message: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // serviceQuotaExceededException: { // ServiceQuotaExceededException
|
|
74
|
+
* // message: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // throttlingException: { // ThrottlingException
|
|
77
|
+
* // message: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // accessDeniedException: { // AccessDeniedException
|
|
80
|
+
* // message: "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // conflictException: { // ConflictException
|
|
83
|
+
* // message: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // dependencyFailedException: { // DependencyFailedException
|
|
86
|
+
* // message: "STRING_VALUE",
|
|
87
|
+
* // resourceName: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // badGatewayException: { // BadGatewayException
|
|
90
|
+
* // message: "STRING_VALUE",
|
|
91
|
+
* // resourceName: "STRING_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // },
|
|
94
|
+
* // };
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @param InvokeFlowCommandInput - {@link InvokeFlowCommandInput}
|
|
99
|
+
* @returns {@link InvokeFlowCommandOutput}
|
|
100
|
+
* @see {@link InvokeFlowCommandInput} for command's `input` shape.
|
|
101
|
+
* @see {@link InvokeFlowCommandOutput} for command's `response` shape.
|
|
102
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
105
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link BadGatewayException} (server fault)
|
|
108
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ConflictException} (client fault)
|
|
111
|
+
* <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link DependencyFailedException} (client fault)
|
|
114
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link InternalServerException} (server fault)
|
|
117
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
120
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
123
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
126
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link ValidationException} (client fault)
|
|
129
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
132
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
133
|
+
*
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
export declare class InvokeFlowCommand extends InvokeFlowCommand_base {
|
|
137
|
+
}
|
|
@@ -124,6 +124,11 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
124
124
|
* "<keys>": "DOCUMENT_VALUE",
|
|
125
125
|
* },
|
|
126
126
|
* },
|
|
127
|
+
* orchestrationConfiguration: { // OrchestrationConfiguration
|
|
128
|
+
* queryTransformationConfiguration: { // QueryTransformationConfiguration
|
|
129
|
+
* type: "QUERY_DECOMPOSITION", // required
|
|
130
|
+
* },
|
|
131
|
+
* },
|
|
127
132
|
* },
|
|
128
133
|
* externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
|
|
129
134
|
* modelArn: "STRING_VALUE", // required
|
|
@@ -192,10 +197,22 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
192
197
|
* // text: "STRING_VALUE", // required
|
|
193
198
|
* // },
|
|
194
199
|
* // location: { // RetrievalResultLocation
|
|
195
|
-
* // type: "S3", // required
|
|
200
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
196
201
|
* // s3Location: { // RetrievalResultS3Location
|
|
197
202
|
* // uri: "STRING_VALUE",
|
|
198
203
|
* // },
|
|
204
|
+
* // webLocation: { // RetrievalResultWebLocation
|
|
205
|
+
* // url: "STRING_VALUE",
|
|
206
|
+
* // },
|
|
207
|
+
* // confluenceLocation: { // RetrievalResultConfluenceLocation
|
|
208
|
+
* // url: "STRING_VALUE",
|
|
209
|
+
* // },
|
|
210
|
+
* // salesforceLocation: { // RetrievalResultSalesforceLocation
|
|
211
|
+
* // url: "STRING_VALUE",
|
|
212
|
+
* // },
|
|
213
|
+
* // sharePointLocation: { // RetrievalResultSharePointLocation
|
|
214
|
+
* // url: "STRING_VALUE",
|
|
215
|
+
* // },
|
|
199
216
|
* // },
|
|
200
217
|
* // metadata: { // RetrievalResultMetadata
|
|
201
218
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -108,10 +108,22 @@ declare const RetrieveCommand_base: {
|
|
|
108
108
|
* // text: "STRING_VALUE", // required
|
|
109
109
|
* // },
|
|
110
110
|
* // location: { // RetrievalResultLocation
|
|
111
|
-
* // type: "S3", // required
|
|
111
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
|
|
112
112
|
* // s3Location: { // RetrievalResultS3Location
|
|
113
113
|
* // uri: "STRING_VALUE",
|
|
114
114
|
* // },
|
|
115
|
+
* // webLocation: { // RetrievalResultWebLocation
|
|
116
|
+
* // url: "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // confluenceLocation: { // RetrievalResultConfluenceLocation
|
|
119
|
+
* // url: "STRING_VALUE",
|
|
120
|
+
* // },
|
|
121
|
+
* // salesforceLocation: { // RetrievalResultSalesforceLocation
|
|
122
|
+
* // url: "STRING_VALUE",
|
|
123
|
+
* // },
|
|
124
|
+
* // sharePointLocation: { // RetrievalResultSharePointLocation
|
|
125
|
+
* // url: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
115
127
|
* // },
|
|
116
128
|
* // score: Number("double"),
|
|
117
129
|
* // metadata: { // RetrievalResultMetadata
|