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) 


1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1003

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

#confirmation_state ⇒ String

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

Returns:

  • (String) 


1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1003

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

#function ⇒ String

The name of the function that was called.

Returns:

  • (String) 


1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1003

class FunctionResult < Struct.new(
  :action_group,
  :confirmation_state,
  :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 key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.

Returns:



1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1003

class FunctionResult < Struct.new(
  :action_group,
  :confirmation_state,
  :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) 


1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1003

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