Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface FunctionResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FunctionResult.Builder,FunctionResult>, SdkBuilder<FunctionResult.Builder,FunctionResult>, SdkPojo

Enclosing class:

FunctionResult

@Mutable
@NotThreadSafe
public static interface FunctionResult.Builder
extends SdkPojo, CopyableBuilder<FunctionResult.Builder,FunctionResult>

Method Summary

Modifier and Type	Method	Description
FunctionResult.Builder	actionGroup(String actionGroup)	The action group that the function belongs to.
FunctionResult.Builder	agentId(String agentId)	The agent's ID.
FunctionResult.Builder	confirmationState(String confirmationState)	Contains the user confirmation information about the function that was called.
FunctionResult.Builder	confirmationState(ConfirmationState confirmationState)	Contains the user confirmation information about the function that was called.
FunctionResult.Builder	function(String function)	The name of the function that was called.
FunctionResult.Builder	responseBody(Map<String,ContentBody> responseBody)	The response from the function call using the parameters.
FunctionResult.Builder	responseState(String responseState)	Controls the final response state returned to end user when API/Function execution failed.
FunctionResult.Builder	responseState(ResponseState responseState)	Controls the final response state returned to end user when API/Function execution failed.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

actionGroup

FunctionResult.Builder actionGroup(String actionGroup)

The action group that the function belongs to.

Parameters:

actionGroup - The action group that the function belongs to.

Returns:

Returns a reference to this object so that method calls can be chained together.

agentId

FunctionResult.Builder agentId(String agentId)

The agent's ID.

Parameters:

agentId - The agent's ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

confirmationState

FunctionResult.Builder confirmationState(String confirmationState)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfirmationState, ConfirmationState

confirmationState

FunctionResult.Builder confirmationState(ConfirmationState confirmationState)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConfirmationState, ConfirmationState

function

FunctionResult.Builder function(String function)

The name of the function that was called.

Parameters:

function - The name of the function that was called.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseBody

FunctionResult.Builder responseBody(Map<String,ContentBody> responseBody)

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.

Parameters:

responseBody - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseState

FunctionResult.Builder responseState(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResponseState, ResponseState

responseState

FunctionResult.Builder responseState(ResponseState 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResponseState, ResponseState