Skip to content

Commit 3f2527c

Browse files
author
awstools
committed
feat(client-bedrock-agent-runtime): Releasing the support for simplified configuration and return of control
1 parent 0ab635e commit 3f2527c

File tree

6 files changed

+1132
-22
lines changed

6 files changed

+1132
-22
lines changed

‎clients/client-bedrock-agent-runtime/src/commands/InvokeAgentCommand.ts

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface InvokeAgentCommandInput extends InvokeAgentRequest {}
3636
export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __MetadataBearer {}
3737

3838
/**
39-
* <p>Sends a prompt for the agent to process and respond to.</p>
39+
* <p>Sends a prompt for the agent to process and respond to. Use return control event type for function calling.</p>
4040
* <note>
4141
* <p>The CLI doesn't support <code>InvokeAgent</code>.</p>
4242
* </note>
@@ -51,7 +51,10 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
5151
* <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p>
5252
* </li>
5353
* <li>
54-
* <p>Include attributes for the session or prompt in the <code>sessionState</code> object.</p>
54+
* <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or parameters returned from the action group.</p>
55+
* </li>
56+
* <li>
57+
* <p>Use return control event type for function calling.</p>
5558
* </li>
5659
* </ul>
5760
* <p>The response is returned in the <code>bytes</code> field of the <code>chunk</code> object.</p>
@@ -80,13 +83,40 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
8083
* promptSessionAttributes: { // PromptSessionAttributesMap
8184
* "<keys>": "STRING_VALUE",
8285
* },
86+
* returnControlInvocationResults: [ // ReturnControlInvocationResults
87+
* { // InvocationResultMember Union: only one key present
88+
* apiResult: { // ApiResult
89+
* actionGroup: "STRING_VALUE", // required
90+
* httpMethod: "STRING_VALUE",
91+
* apiPath: "STRING_VALUE",
92+
* responseBody: { // ResponseBody
93+
* "<keys>": { // ContentBody
94+
* body: "STRING_VALUE",
95+
* },
96+
* },
97+
* httpStatusCode: Number("int"),
98+
* responseState: "FAILURE" || "REPROMPT",
99+
* },
100+
* functionResult: { // FunctionResult
101+
* actionGroup: "STRING_VALUE", // required
102+
* function: "STRING_VALUE",
103+
* responseBody: {
104+
* "<keys>": {
105+
* body: "STRING_VALUE",
106+
* },
107+
* },
108+
* responseState: "FAILURE" || "REPROMPT",
109+
* },
110+
* },
111+
* ],
112+
* invocationId: "STRING_VALUE",
83113
* },
84114
* agentId: "STRING_VALUE", // required
85115
* agentAliasId: "STRING_VALUE", // required
86116
* sessionId: "STRING_VALUE", // required
87117
* endSession: true || false,
88118
* enableTrace: true || false,
89-
* inputText: "STRING_VALUE", // required
119+
* inputText: "STRING_VALUE",
90120
* };
91121
* const command = new InvokeAgentCommand(input);
92122
* const response = await client.send(command);
@@ -130,6 +160,7 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
130160
* // agentId: "STRING_VALUE",
131161
* // agentAliasId: "STRING_VALUE",
132162
* // sessionId: "STRING_VALUE",
163+
* // agentVersion: "STRING_VALUE",
133164
* // trace: { // Trace Union: only one key present
134165
* // preProcessingTrace: { // PreProcessingTrace Union: only one key present
135166
* // modelInvocationInput: { // ModelInvocationInput
@@ -187,6 +218,7 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
187218
* // ],
188219
* // },
189220
* // },
221+
* // function: "STRING_VALUE",
190222
* // },
191223
* // knowledgeBaseLookupInput: { // KnowledgeBaseLookupInput
192224
* // text: "STRING_VALUE",
@@ -274,6 +306,49 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
274306
* // },
275307
* // },
276308
* // },
309+
* // returnControl: { // ReturnControlPayload
310+
* // invocationInputs: [ // InvocationInputs
311+
* // { // InvocationInputMember Union: only one key present
312+
* // apiInvocationInput: { // ApiInvocationInput
313+
* // actionGroup: "STRING_VALUE", // required
314+
* // httpMethod: "STRING_VALUE",
315+
* // apiPath: "STRING_VALUE",
316+
* // parameters: [ // ApiParameters
317+
* // { // ApiParameter
318+
* // name: "STRING_VALUE",
319+
* // type: "STRING_VALUE",
320+
* // value: "STRING_VALUE",
321+
* // },
322+
* // ],
323+
* // requestBody: { // ApiRequestBody
324+
* // content: { // ApiContentMap
325+
* // "<keys>": { // PropertyParameters
326+
* // properties: [ // ParameterList
327+
* // {
328+
* // name: "STRING_VALUE",
329+
* // type: "STRING_VALUE",
330+
* // value: "STRING_VALUE",
331+
* // },
332+
* // ],
333+
* // },
334+
* // },
335+
* // },
336+
* // },
337+
* // functionInvocationInput: { // FunctionInvocationInput
338+
* // actionGroup: "STRING_VALUE", // required
339+
* // parameters: [ // FunctionParameters
340+
* // { // FunctionParameter
341+
* // name: "STRING_VALUE",
342+
* // type: "STRING_VALUE",
343+
* // value: "STRING_VALUE",
344+
* // },
345+
* // ],
346+
* // function: "STRING_VALUE",
347+
* // },
348+
* // },
349+
* // ],
350+
* // invocationId: "STRING_VALUE",
351+
* // },
277352
* // internalServerException: { // InternalServerException
278353
* // message: "STRING_VALUE",
279354
* // },
@@ -332,7 +407,7 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
332407
* <p>An internal server error occurred. Retry your request.</p>
333408
*
334409
* @throws {@link ResourceNotFoundException} (client fault)
335-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
410+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
336411
*
337412
* @throws {@link ServiceQuotaExceededException} (client fault)
338413
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>

‎clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ export interface RetrieveAndGenerateCommandOutput extends RetrieveAndGenerateRes
180180
* <p>An internal server error occurred. Retry your request.</p>
181181
*
182182
* @throws {@link ResourceNotFoundException} (client fault)
183-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
183+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
184184
*
185185
* @throws {@link ServiceQuotaExceededException} (client fault)
186186
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>

‎clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ export interface RetrieveCommandOutput extends RetrieveResponse, __MetadataBeare
151151
* <p>An internal server error occurred. Retry your request.</p>
152152
*
153153
* @throws {@link ResourceNotFoundException} (client fault)
154-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
154+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
155155
*
156156
* @throws {@link ServiceQuotaExceededException} (client fault)
157157
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>

0 commit comments

Comments
 (0)