Struct FunctionResult 

#[non_exhaustive]
pub struct FunctionResult {
    pub action_group: String,
    pub confirmation_state: Option<ConfirmationState>,
    pub function: Option<String>,
    pub response_body: Option<HashMap<String, ContentBody>>,
    pub response_state: Option<ResponseState>,
    pub agent_id: Option<String>,
}

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 returnControlInvocationResults of the InvokeAgent request

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action_group: String

The action group that the function belongs to.

confirmation_state: Option<ConfirmationState>

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

function: Option<String>

The name of the function that was called.

response_body: Option<HashMap<String, ContentBody>>

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.

response_state: Option<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

agent_id: Option<String>

The agent's ID.

Implementations

impl FunctionResult

pub fn action_group(&self) -> &str

The action group that the function belongs to.

pub fn confirmation_state(&self) -> Option<&ConfirmationState>

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

pub fn function(&self) -> Option<&str>

The name of the function that was called.

pub fn response_body(&self) -> Option<&HashMap<String, ContentBody>>

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.

pub fn response_state(&self) -> Option<&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

pub fn agent_id(&self) -> Option<&str>

The agent's ID.

impl FunctionResult

pub fn builder() -> FunctionResultBuilder

Creates a new builder-style object to manufacture FunctionResult.

Trait Implementations

impl Clone for FunctionResult

fn clone(&self) -> FunctionResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FunctionResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FunctionResult

fn eq(&self, other: &FunctionResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FunctionResult