Skip to content

/AWS1/CL_BDZFUNCTIONRESULT

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:

CONSTRUCTOR

IMPORTING

Required arguments:

iv_actiongroup TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The action group that the function belongs to.

Optional arguments:

iv_confirmationstate TYPE /AWS1/BDZCONFIRMATIONSTATE /AWS1/BDZCONFIRMATIONSTATE

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

iv_function TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The name of the function that was called.

it_responsebody TYPE /AWS1/CL_BDZCONTENTBODY=>TT_RESPONSEBODY TT_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.

iv_responsestate TYPE /AWS1/BDZRESPONSESTATE /AWS1/BDZRESPONSESTATE

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

iv_agentid TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The agent's ID.

Queryable Attributes

actionGroup

The action group that the function belongs to.

Accessible with the following methods

Method Description
GET_ACTIONGROUP() Getter for ACTIONGROUP, with configurable default
ASK_ACTIONGROUP() Getter for ACTIONGROUP w/ exceptions if field has no value
HAS_ACTIONGROUP() Determine if ACTIONGROUP has a value

confirmationState

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

Accessible with the following methods

Method Description
GET_CONFIRMATIONSTATE() Getter for CONFIRMATIONSTATE, with configurable default
ASK_CONFIRMATIONSTATE() Getter for CONFIRMATIONSTATE w/ exceptions if field has no v
HAS_CONFIRMATIONSTATE() Determine if CONFIRMATIONSTATE has a value

function

The name of the function that was called.

Accessible with the following methods

Method Description
GET_FUNCTION() Getter for FUNCTION, with configurable default
ASK_FUNCTION() Getter for FUNCTION w/ exceptions if field has no value
HAS_FUNCTION() Determine if FUNCTION has a value

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.

Accessible with the following methods

Method Description
GET_RESPONSEBODY() Getter for RESPONSEBODY, with configurable default
ASK_RESPONSEBODY() Getter for RESPONSEBODY w/ exceptions if field has no value
HAS_RESPONSEBODY() Determine if RESPONSEBODY has a value

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

Accessible with the following methods

Method Description
GET_RESPONSESTATE() Getter for RESPONSESTATE, with configurable default
ASK_RESPONSESTATE() Getter for RESPONSESTATE w/ exceptions if field has no value
HAS_RESPONSESTATE() Determine if RESPONSESTATE has a value

agentId

The agent's ID.

Accessible with the following methods

Method Description
GET_AGENTID() Getter for AGENTID, with configurable default
ASK_AGENTID() Getter for AGENTID w/ exceptions if field has no value
HAS_AGENTID() Determine if AGENTID has a value