Class: Aws::BedrockAgentRuntime::Types::FunctionResult

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

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:

^

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_group ⇒ String

The action group that the function belongs to.

Returns:

  • (String) 


648
649
650
651
652
653
654
655
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 648

class FunctionResult < Struct.new(
  :action_group,
  :function,
  :response_body,
  :response_state)
  SENSITIVE = []
  include Aws::Structure
end

#function ⇒ String

The name of the function that was called.

Returns:

  • (String) 


648
649
650
651
652
653
654
655
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 648

class FunctionResult < Struct.new(
  :action_group,
  :function,
  :response_body,
  :response_state)
  SENSITIVE = []
  include Aws::Structure
end

#response_body ⇒ Hash<String,Types::ContentBody>

The response from the function call using the parameters. The response may be returned directly or from the Lambda function.

Returns:



648
649
650
651
652
653
654
655
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 648

class FunctionResult < Struct.new(
  :action_group,
  :function,
  :response_body,
  :response_state)
  SENSITIVE = []
  include Aws::Structure
end

#response_state ⇒ String

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:

  • (String) 


648
649
650
651
652
653
654
655
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 648

class FunctionResult < Struct.new(
  :action_group,
  :function,
  :response_body,
  :response_state)
  SENSITIVE = []
  include Aws::Structure
end