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:

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The action group that the function belongs to.

Link copied to clipboard

The agent's ID.

Link copied to clipboard

Contains the user confirmation information about the function that was called.

Link copied to clipboard

The name of the function that was called.

Link copied to clipboard

The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: FunctionResult.Builder.() -> Unit = {}): FunctionResult
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String