@aws-sdk/client-bedrock-agent-runtime 3.755.0 → 3.764.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 +119 -7
- package/dist-cjs/index.js +1035 -78
- package/dist-es/BedrockAgentRuntime.js +28 -0
- package/dist-es/commands/CreateInvocationCommand.js +22 -0
- package/dist-es/commands/CreateSessionCommand.js +22 -0
- package/dist-es/commands/DeleteSessionCommand.js +22 -0
- package/dist-es/commands/EndSessionCommand.js +22 -0
- package/dist-es/commands/GetInvocationStepCommand.js +23 -0
- package/dist-es/commands/GetSessionCommand.js +22 -0
- package/dist-es/commands/InvokeAgentCommand.js +2 -1
- package/dist-es/commands/InvokeInlineAgentCommand.js +2 -1
- package/dist-es/commands/ListInvocationStepsCommand.js +22 -0
- package/dist-es/commands/ListInvocationsCommand.js +22 -0
- package/dist-es/commands/ListSessionsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/PutInvocationStepCommand.js +23 -0
- package/dist-es/commands/RetrieveAndGenerateCommand.js +2 -1
- package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +2 -1
- package/dist-es/commands/RetrieveCommand.js +2 -1
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateSessionCommand.js +22 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +76 -156
- package/dist-es/models/models_1.js +181 -0
- package/dist-es/pagination/ListInvocationStepsPaginator.js +4 -0
- package/dist-es/pagination/ListInvocationsPaginator.js +4 -0
- package/dist-es/pagination/ListSessionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +560 -8
- package/dist-types/BedrockAgentRuntime.d.ts +100 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +16 -2
- package/dist-types/commands/CreateInvocationCommand.d.ts +115 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +133 -0
- package/dist-types/commands/DeleteSessionCommand.d.ts +89 -0
- package/dist-types/commands/EndSessionCommand.d.ts +93 -0
- package/dist-types/commands/GetInvocationStepCommand.d.ts +109 -0
- package/dist-types/commands/GetSessionCommand.d.ts +94 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +3 -1
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +216 -64
- package/dist-types/commands/ListInvocationStepsCommand.d.ts +97 -0
- package/dist-types/commands/ListInvocationsCommand.d.ts +95 -0
- package/dist-types/commands/ListSessionsCommand.d.ts +93 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +88 -0
- package/dist-types/commands/PutInvocationStepCommand.d.ts +134 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +2 -1
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -1
- package/dist-types/commands/RetrieveCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +91 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +96 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +605 -684
- package/dist-types/models/models_1.d.ts +1055 -0
- package/dist-types/pagination/ListInvocationStepsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListInvocationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +240 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +86 -2
- package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/InvokeInlineAgentCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +250 -374
- package/dist-types/ts3.4/models/models_1.d.ts +441 -0
- package/dist-types/ts3.4/pagination/ListInvocationStepsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListInvocationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +12 -12
|
@@ -0,0 +1,109 @@
|
|
|
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 { GetInvocationStepRequest, GetInvocationStepResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetInvocationStepCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetInvocationStepCommandInput extends GetInvocationStepRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetInvocationStepCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetInvocationStepCommandOutput extends GetInvocationStepResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetInvocationStepCommand_base: {
|
|
25
|
+
new (input: GetInvocationStepCommandInput): import("@smithy/smithy-client").CommandImpl<GetInvocationStepCommandInput, GetInvocationStepCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetInvocationStepCommandInput): import("@smithy/smithy-client").CommandImpl<GetInvocationStepCommandInput, GetInvocationStepCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, GetInvocationStepCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, GetInvocationStepCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // GetInvocationStepRequest
|
|
38
|
+
* invocationIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* invocationStepId: "STRING_VALUE", // required
|
|
40
|
+
* sessionIdentifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetInvocationStepCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetInvocationStepResponse
|
|
45
|
+
* // invocationStep: { // InvocationStep
|
|
46
|
+
* // sessionId: "STRING_VALUE", // required
|
|
47
|
+
* // invocationId: "STRING_VALUE", // required
|
|
48
|
+
* // invocationStepId: "STRING_VALUE", // required
|
|
49
|
+
* // invocationStepTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // payload: { // InvocationStepPayload Union: only one key present
|
|
51
|
+
* // contentBlocks: [ // BedrockSessionContentBlocks
|
|
52
|
+
* // { // BedrockSessionContentBlock Union: only one key present
|
|
53
|
+
* // text: "STRING_VALUE",
|
|
54
|
+
* // image: { // ImageBlock
|
|
55
|
+
* // format: "png" || "jpeg" || "gif" || "webp", // required
|
|
56
|
+
* // source: { // ImageSource Union: only one key present
|
|
57
|
+
* // bytes: new Uint8Array(),
|
|
58
|
+
* // s3Location: { // S3Location
|
|
59
|
+
* // uri: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param GetInvocationStepCommandInput - {@link GetInvocationStepCommandInput}
|
|
72
|
+
* @returns {@link GetInvocationStepCommandOutput}
|
|
73
|
+
* @see {@link GetInvocationStepCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link GetInvocationStepCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerException} (server fault)
|
|
81
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
87
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare class GetInvocationStepCommand extends GetInvocationStepCommand_base {
|
|
98
|
+
/** @internal type navigation helper, not in runtime. */
|
|
99
|
+
protected static __types: {
|
|
100
|
+
api: {
|
|
101
|
+
input: GetInvocationStepRequest;
|
|
102
|
+
output: GetInvocationStepResponse;
|
|
103
|
+
};
|
|
104
|
+
sdk: {
|
|
105
|
+
input: GetInvocationStepCommandInput;
|
|
106
|
+
output: GetInvocationStepCommandOutput;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
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 { GetSessionRequest, GetSessionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSessionCommandInput extends GetSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetSessionCommand_base: {
|
|
25
|
+
new (input: GetSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionCommandInput, GetSessionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetSessionCommandInput, GetSessionCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves details about a specific session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, GetSessionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, GetSessionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // GetSessionRequest
|
|
38
|
+
* sessionIdentifier: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetSessionCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetSessionResponse
|
|
43
|
+
* // sessionId: "STRING_VALUE", // required
|
|
44
|
+
* // sessionArn: "STRING_VALUE", // required
|
|
45
|
+
* // sessionStatus: "ACTIVE" || "EXPIRED" || "ENDED", // required
|
|
46
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
47
|
+
* // lastUpdatedAt: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // sessionMetadata: { // SessionMetadataMap
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // encryptionKeyArn: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param GetSessionCommandInput - {@link GetSessionCommandInput}
|
|
57
|
+
* @returns {@link GetSessionCommandOutput}
|
|
58
|
+
* @see {@link GetSessionCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link GetSessionCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerException} (server fault)
|
|
66
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
72
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class GetSessionCommand extends GetSessionCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: GetSessionRequest;
|
|
87
|
+
output: GetSessionResponse;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: GetSessionCommandInput;
|
|
91
|
+
output: GetSessionCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import {
|
|
4
|
+
import { InvokeAgentResponse } from "../models/models_0";
|
|
5
|
+
import { InvokeAgentRequest } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -1033,6 +1034,7 @@ declare const InvokeAgentCommand_base: {
|
|
|
1033
1034
|
* // agentAliasArn: "STRING_VALUE",
|
|
1034
1035
|
* // },
|
|
1035
1036
|
* // ],
|
|
1037
|
+
* // eventTime: new Date("TIMESTAMP"),
|
|
1036
1038
|
* // collaboratorName: "STRING_VALUE",
|
|
1037
1039
|
* // },
|
|
1038
1040
|
* // returnControl: {
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import {
|
|
4
|
+
import { InvokeInlineAgentResponse } from "../models/models_0";
|
|
5
|
+
import { InvokeInlineAgentRequest } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -59,66 +60,7 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
59
60
|
* // const { BedrockAgentRuntimeClient, InvokeInlineAgentCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
60
61
|
* const client = new BedrockAgentRuntimeClient(config);
|
|
61
62
|
* const input = { // InvokeInlineAgentRequest
|
|
62
|
-
* sessionId: "STRING_VALUE", // required
|
|
63
63
|
* customerEncryptionKeyArn: "STRING_VALUE",
|
|
64
|
-
* endSession: true || false,
|
|
65
|
-
* enableTrace: true || false,
|
|
66
|
-
* inputText: "STRING_VALUE",
|
|
67
|
-
* inlineSessionState: { // InlineSessionState
|
|
68
|
-
* sessionAttributes: { // SessionAttributesMap
|
|
69
|
-
* "<keys>": "STRING_VALUE",
|
|
70
|
-
* },
|
|
71
|
-
* promptSessionAttributes: { // PromptSessionAttributesMap
|
|
72
|
-
* "<keys>": "STRING_VALUE",
|
|
73
|
-
* },
|
|
74
|
-
* returnControlInvocationResults: [ // ReturnControlInvocationResults
|
|
75
|
-
* { // InvocationResultMember Union: only one key present
|
|
76
|
-
* apiResult: { // ApiResult
|
|
77
|
-
* actionGroup: "STRING_VALUE", // required
|
|
78
|
-
* httpMethod: "STRING_VALUE",
|
|
79
|
-
* apiPath: "STRING_VALUE",
|
|
80
|
-
* confirmationState: "CONFIRM" || "DENY",
|
|
81
|
-
* responseState: "FAILURE" || "REPROMPT",
|
|
82
|
-
* httpStatusCode: Number("int"),
|
|
83
|
-
* responseBody: { // ResponseBody
|
|
84
|
-
* "<keys>": { // ContentBody
|
|
85
|
-
* body: "STRING_VALUE",
|
|
86
|
-
* },
|
|
87
|
-
* },
|
|
88
|
-
* agentId: "STRING_VALUE",
|
|
89
|
-
* },
|
|
90
|
-
* functionResult: { // FunctionResult
|
|
91
|
-
* actionGroup: "STRING_VALUE", // required
|
|
92
|
-
* confirmationState: "CONFIRM" || "DENY",
|
|
93
|
-
* function: "STRING_VALUE",
|
|
94
|
-
* responseBody: {
|
|
95
|
-
* "<keys>": {
|
|
96
|
-
* body: "STRING_VALUE",
|
|
97
|
-
* },
|
|
98
|
-
* },
|
|
99
|
-
* responseState: "FAILURE" || "REPROMPT",
|
|
100
|
-
* agentId: "STRING_VALUE",
|
|
101
|
-
* },
|
|
102
|
-
* },
|
|
103
|
-
* ],
|
|
104
|
-
* invocationId: "STRING_VALUE",
|
|
105
|
-
* files: [ // InputFiles
|
|
106
|
-
* { // InputFile
|
|
107
|
-
* name: "STRING_VALUE", // required
|
|
108
|
-
* source: { // FileSource
|
|
109
|
-
* sourceType: "S3" || "BYTE_CONTENT", // required
|
|
110
|
-
* s3Location: { // S3ObjectFile
|
|
111
|
-
* uri: "STRING_VALUE", // required
|
|
112
|
-
* },
|
|
113
|
-
* byteContent: { // ByteContentFile
|
|
114
|
-
* mediaType: "STRING_VALUE", // required
|
|
115
|
-
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
116
|
-
* },
|
|
117
|
-
* },
|
|
118
|
-
* useCase: "CODE_INTERPRETER" || "CHAT", // required
|
|
119
|
-
* },
|
|
120
|
-
* ],
|
|
121
|
-
* },
|
|
122
64
|
* foundationModel: "STRING_VALUE", // required
|
|
123
65
|
* instruction: "STRING_VALUE", // required
|
|
124
66
|
* idleSessionTTLInSeconds: Number("int"),
|
|
@@ -278,20 +220,230 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
278
220
|
* ],
|
|
279
221
|
* },
|
|
280
222
|
* parserMode: "DEFAULT" || "OVERRIDDEN",
|
|
223
|
+
* foundationModel: "STRING_VALUE",
|
|
281
224
|
* additionalModelRequestFields: "DOCUMENT_VALUE",
|
|
282
225
|
* },
|
|
283
226
|
* ],
|
|
284
227
|
* overrideLambda: "STRING_VALUE",
|
|
285
228
|
* },
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
229
|
+
* agentCollaboration: "SUPERVISOR" || "SUPERVISOR_ROUTER" || "DISABLED",
|
|
230
|
+
* collaboratorConfigurations: [ // CollaboratorConfigurations
|
|
231
|
+
* { // CollaboratorConfiguration
|
|
232
|
+
* collaboratorName: "STRING_VALUE", // required
|
|
233
|
+
* collaboratorInstruction: "STRING_VALUE", // required
|
|
234
|
+
* agentAliasArn: "STRING_VALUE",
|
|
235
|
+
* relayConversationHistory: "TO_COLLABORATOR" || "DISABLED",
|
|
289
236
|
* },
|
|
290
|
-
*
|
|
237
|
+
* ],
|
|
238
|
+
* sessionId: "STRING_VALUE", // required
|
|
239
|
+
* endSession: true || false,
|
|
240
|
+
* enableTrace: true || false,
|
|
241
|
+
* inputText: "STRING_VALUE",
|
|
291
242
|
* streamingConfigurations: { // StreamingConfigurations
|
|
292
243
|
* streamFinalResponse: true || false,
|
|
293
244
|
* applyGuardrailInterval: Number("int"),
|
|
294
245
|
* },
|
|
246
|
+
* inlineSessionState: { // InlineSessionState
|
|
247
|
+
* sessionAttributes: { // SessionAttributesMap
|
|
248
|
+
* "<keys>": "STRING_VALUE",
|
|
249
|
+
* },
|
|
250
|
+
* promptSessionAttributes: { // PromptSessionAttributesMap
|
|
251
|
+
* "<keys>": "STRING_VALUE",
|
|
252
|
+
* },
|
|
253
|
+
* returnControlInvocationResults: [ // ReturnControlInvocationResults
|
|
254
|
+
* { // InvocationResultMember Union: only one key present
|
|
255
|
+
* apiResult: { // ApiResult
|
|
256
|
+
* actionGroup: "STRING_VALUE", // required
|
|
257
|
+
* httpMethod: "STRING_VALUE",
|
|
258
|
+
* apiPath: "STRING_VALUE",
|
|
259
|
+
* confirmationState: "CONFIRM" || "DENY",
|
|
260
|
+
* responseState: "FAILURE" || "REPROMPT",
|
|
261
|
+
* httpStatusCode: Number("int"),
|
|
262
|
+
* responseBody: { // ResponseBody
|
|
263
|
+
* "<keys>": { // ContentBody
|
|
264
|
+
* body: "STRING_VALUE",
|
|
265
|
+
* },
|
|
266
|
+
* },
|
|
267
|
+
* agentId: "STRING_VALUE",
|
|
268
|
+
* },
|
|
269
|
+
* functionResult: { // FunctionResult
|
|
270
|
+
* actionGroup: "STRING_VALUE", // required
|
|
271
|
+
* confirmationState: "CONFIRM" || "DENY",
|
|
272
|
+
* function: "STRING_VALUE",
|
|
273
|
+
* responseBody: {
|
|
274
|
+
* "<keys>": {
|
|
275
|
+
* body: "STRING_VALUE",
|
|
276
|
+
* },
|
|
277
|
+
* },
|
|
278
|
+
* responseState: "FAILURE" || "REPROMPT",
|
|
279
|
+
* agentId: "STRING_VALUE",
|
|
280
|
+
* },
|
|
281
|
+
* },
|
|
282
|
+
* ],
|
|
283
|
+
* invocationId: "STRING_VALUE",
|
|
284
|
+
* files: [ // InputFiles
|
|
285
|
+
* { // InputFile
|
|
286
|
+
* name: "STRING_VALUE", // required
|
|
287
|
+
* source: { // FileSource
|
|
288
|
+
* sourceType: "S3" || "BYTE_CONTENT", // required
|
|
289
|
+
* s3Location: { // S3ObjectFile
|
|
290
|
+
* uri: "STRING_VALUE", // required
|
|
291
|
+
* },
|
|
292
|
+
* byteContent: { // ByteContentFile
|
|
293
|
+
* mediaType: "STRING_VALUE", // required
|
|
294
|
+
* data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
|
|
295
|
+
* },
|
|
296
|
+
* },
|
|
297
|
+
* useCase: "CODE_INTERPRETER" || "CHAT", // required
|
|
298
|
+
* },
|
|
299
|
+
* ],
|
|
300
|
+
* conversationHistory: { // ConversationHistory
|
|
301
|
+
* messages: [ // Messages
|
|
302
|
+
* { // Message
|
|
303
|
+
* role: "user" || "assistant", // required
|
|
304
|
+
* content: [ // ContentBlocks // required
|
|
305
|
+
* { // ContentBlock Union: only one key present
|
|
306
|
+
* text: "STRING_VALUE",
|
|
307
|
+
* },
|
|
308
|
+
* ],
|
|
309
|
+
* },
|
|
310
|
+
* ],
|
|
311
|
+
* },
|
|
312
|
+
* },
|
|
313
|
+
* collaborators: [ // Collaborators
|
|
314
|
+
* { // Collaborator
|
|
315
|
+
* customerEncryptionKeyArn: "STRING_VALUE",
|
|
316
|
+
* foundationModel: "STRING_VALUE", // required
|
|
317
|
+
* instruction: "STRING_VALUE", // required
|
|
318
|
+
* idleSessionTTLInSeconds: Number("int"),
|
|
319
|
+
* actionGroups: [
|
|
320
|
+
* {
|
|
321
|
+
* actionGroupName: "STRING_VALUE", // required
|
|
322
|
+
* description: "STRING_VALUE",
|
|
323
|
+
* parentActionGroupSignature: "AMAZON.UserInput" || "AMAZON.CodeInterpreter",
|
|
324
|
+
* actionGroupExecutor: {// Union: only one key present
|
|
325
|
+
* lambda: "STRING_VALUE",
|
|
326
|
+
* customControl: "RETURN_CONTROL",
|
|
327
|
+
* },
|
|
328
|
+
* apiSchema: {// Union: only one key present
|
|
329
|
+
* s3: {
|
|
330
|
+
* s3BucketName: "STRING_VALUE",
|
|
331
|
+
* s3ObjectKey: "STRING_VALUE",
|
|
332
|
+
* },
|
|
333
|
+
* payload: "STRING_VALUE",
|
|
334
|
+
* },
|
|
335
|
+
* functionSchema: {// Union: only one key present
|
|
336
|
+
* functions: [
|
|
337
|
+
* {
|
|
338
|
+
* name: "STRING_VALUE", // required
|
|
339
|
+
* description: "STRING_VALUE",
|
|
340
|
+
* parameters: {
|
|
341
|
+
* "<keys>": {
|
|
342
|
+
* description: "STRING_VALUE",
|
|
343
|
+
* type: "string" || "number" || "integer" || "boolean" || "array", // required
|
|
344
|
+
* required: true || false,
|
|
345
|
+
* },
|
|
346
|
+
* },
|
|
347
|
+
* requireConfirmation: "ENABLED" || "DISABLED",
|
|
348
|
+
* },
|
|
349
|
+
* ],
|
|
350
|
+
* },
|
|
351
|
+
* },
|
|
352
|
+
* ],
|
|
353
|
+
* knowledgeBases: [
|
|
354
|
+
* {
|
|
355
|
+
* knowledgeBaseId: "STRING_VALUE", // required
|
|
356
|
+
* description: "STRING_VALUE", // required
|
|
357
|
+
* retrievalConfiguration: {
|
|
358
|
+
* vectorSearchConfiguration: {
|
|
359
|
+
* numberOfResults: Number("int"),
|
|
360
|
+
* overrideSearchType: "HYBRID" || "SEMANTIC",
|
|
361
|
+
* filter: "<RetrievalFilter>",
|
|
362
|
+
* rerankingConfiguration: {
|
|
363
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
364
|
+
* bedrockRerankingConfiguration: {
|
|
365
|
+
* modelConfiguration: {
|
|
366
|
+
* modelArn: "STRING_VALUE", // required
|
|
367
|
+
* additionalModelRequestFields: {
|
|
368
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
369
|
+
* },
|
|
370
|
+
* },
|
|
371
|
+
* numberOfRerankedResults: Number("int"),
|
|
372
|
+
* metadataConfiguration: {
|
|
373
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
374
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
375
|
+
* fieldsToInclude: [
|
|
376
|
+
* {
|
|
377
|
+
* fieldName: "STRING_VALUE", // required
|
|
378
|
+
* },
|
|
379
|
+
* ],
|
|
380
|
+
* fieldsToExclude: [
|
|
381
|
+
* {
|
|
382
|
+
* fieldName: "STRING_VALUE", // required
|
|
383
|
+
* },
|
|
384
|
+
* ],
|
|
385
|
+
* },
|
|
386
|
+
* },
|
|
387
|
+
* },
|
|
388
|
+
* },
|
|
389
|
+
* implicitFilterConfiguration: {
|
|
390
|
+
* metadataAttributes: [ // required
|
|
391
|
+
* {
|
|
392
|
+
* key: "STRING_VALUE", // required
|
|
393
|
+
* type: "STRING" || "NUMBER" || "BOOLEAN" || "STRING_LIST", // required
|
|
394
|
+
* description: "STRING_VALUE", // required
|
|
395
|
+
* },
|
|
396
|
+
* ],
|
|
397
|
+
* modelArn: "STRING_VALUE", // required
|
|
398
|
+
* },
|
|
399
|
+
* },
|
|
400
|
+
* },
|
|
401
|
+
* },
|
|
402
|
+
* ],
|
|
403
|
+
* guardrailConfiguration: {
|
|
404
|
+
* guardrailIdentifier: "STRING_VALUE", // required
|
|
405
|
+
* guardrailVersion: "STRING_VALUE", // required
|
|
406
|
+
* },
|
|
407
|
+
* promptOverrideConfiguration: {
|
|
408
|
+
* promptConfigurations: [ // required
|
|
409
|
+
* {
|
|
410
|
+
* promptType: "PRE_PROCESSING" || "ORCHESTRATION" || "KNOWLEDGE_BASE_RESPONSE_GENERATION" || "POST_PROCESSING" || "ROUTING_CLASSIFIER",
|
|
411
|
+
* promptCreationMode: "DEFAULT" || "OVERRIDDEN",
|
|
412
|
+
* promptState: "ENABLED" || "DISABLED",
|
|
413
|
+
* basePromptTemplate: "STRING_VALUE",
|
|
414
|
+
* inferenceConfiguration: {
|
|
415
|
+
* temperature: Number("float"),
|
|
416
|
+
* topP: Number("float"),
|
|
417
|
+
* topK: Number("int"),
|
|
418
|
+
* maximumLength: Number("int"),
|
|
419
|
+
* stopSequences: [
|
|
420
|
+
* "STRING_VALUE",
|
|
421
|
+
* ],
|
|
422
|
+
* },
|
|
423
|
+
* parserMode: "DEFAULT" || "OVERRIDDEN",
|
|
424
|
+
* foundationModel: "STRING_VALUE",
|
|
425
|
+
* additionalModelRequestFields: "DOCUMENT_VALUE",
|
|
426
|
+
* },
|
|
427
|
+
* ],
|
|
428
|
+
* overrideLambda: "STRING_VALUE",
|
|
429
|
+
* },
|
|
430
|
+
* agentCollaboration: "SUPERVISOR" || "SUPERVISOR_ROUTER" || "DISABLED",
|
|
431
|
+
* collaboratorConfigurations: [
|
|
432
|
+
* {
|
|
433
|
+
* collaboratorName: "STRING_VALUE", // required
|
|
434
|
+
* collaboratorInstruction: "STRING_VALUE", // required
|
|
435
|
+
* agentAliasArn: "STRING_VALUE",
|
|
436
|
+
* relayConversationHistory: "TO_COLLABORATOR" || "DISABLED",
|
|
437
|
+
* },
|
|
438
|
+
* ],
|
|
439
|
+
* agentName: "STRING_VALUE",
|
|
440
|
+
* },
|
|
441
|
+
* ],
|
|
442
|
+
* bedrockModelConfigurations: { // InlineBedrockModelConfigurations
|
|
443
|
+
* performanceConfig: { // PerformanceConfiguration
|
|
444
|
+
* latency: "standard" || "optimized",
|
|
445
|
+
* },
|
|
446
|
+
* },
|
|
295
447
|
* };
|
|
296
448
|
* const command = new InvokeInlineAgentCommand(input);
|
|
297
449
|
* const response = await client.send(command);
|
|
@@ -0,0 +1,97 @@
|
|
|
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 { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListInvocationStepsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListInvocationStepsCommandInput extends ListInvocationStepsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListInvocationStepsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListInvocationStepsCommandOutput extends ListInvocationStepsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListInvocationStepsCommand_base: {
|
|
25
|
+
new (input: ListInvocationStepsCommandInput): import("@smithy/smithy-client").CommandImpl<ListInvocationStepsCommandInput, ListInvocationStepsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListInvocationStepsCommandInput): import("@smithy/smithy-client").CommandImpl<ListInvocationStepsCommandInput, ListInvocationStepsCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockAgentRuntimeClient, ListInvocationStepsCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockAgentRuntimeClient, ListInvocationStepsCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockAgentRuntimeClient(config);
|
|
37
|
+
* const input = { // ListInvocationStepsRequest
|
|
38
|
+
* invocationIdentifier: "STRING_VALUE",
|
|
39
|
+
* nextToken: "STRING_VALUE",
|
|
40
|
+
* maxResults: Number("int"),
|
|
41
|
+
* sessionIdentifier: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ListInvocationStepsCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ListInvocationStepsResponse
|
|
46
|
+
* // invocationStepSummaries: [ // InvocationStepSummaries // required
|
|
47
|
+
* // { // InvocationStepSummary
|
|
48
|
+
* // sessionId: "STRING_VALUE", // required
|
|
49
|
+
* // invocationId: "STRING_VALUE", // required
|
|
50
|
+
* // invocationStepId: "STRING_VALUE", // required
|
|
51
|
+
* // invocationStepTime: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param ListInvocationStepsCommandInput - {@link ListInvocationStepsCommandInput}
|
|
60
|
+
* @returns {@link ListInvocationStepsCommandOutput}
|
|
61
|
+
* @see {@link ListInvocationStepsCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link ListInvocationStepsCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
+
* <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link BedrockAgentRuntimeServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class ListInvocationStepsCommand extends ListInvocationStepsCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: ListInvocationStepsRequest;
|
|
90
|
+
output: ListInvocationStepsResponse;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: ListInvocationStepsCommandInput;
|
|
94
|
+
output: ListInvocationStepsCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|