FunctionResult
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
-
In the
returnControlInvocationResultsof the InvokeAgent request
Contents
- actionGroup
-
The action group that the function belongs to.
Type: String
Required: Yes
- agentId
-
The agent's ID.
Type: String
Required: No
- confirmationState
-
Contains the user confirmation information about the function that was called.
Type: String
Valid Values:
CONFIRM | DENYRequired: No
- function
-
The name of the function that was called.
Type: String
Required: No
- responseBody
-
The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify
TEXTorIMAGES. The key of the object is the content type. You can only specify one type. If you specifyIMAGES, you can specify only one image. You can specify images only when the function in thereturnControlInvocationResultsis a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.Type: String to ContentBody object map
Required: No
- responseState
-
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
Type: String
Valid Values:
FAILURE | REPROMPTRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
