Class: Aws::BedrockAgent::Types::Function

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::Function

Defined in:

gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

• CreateAgentActionGroup request

• CreateAgentActionGroup response

• UpdateAgentActionGroup request

• UpdateAgentActionGroup response

• GetAgentActionGroup response

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the function and its purpose.

• #name ⇒ String

  A name for the function.

• #parameters ⇒ Hash<String,Types::ParameterDetail>

  The parameters that the agent elicits from the user to fulfill the function.

• #require_confirmation ⇒ String

  Contains information if user confirmation is required to invoke the function.

Instance Attribute Details

#description ⇒ String

A description of the function and its purpose.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 4540

class Function < Struct.new(
  :description,
  :name,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the function.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 4540

class Function < Struct.new(
  :description,
  :name,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Types::ParameterDetail>

The parameters that the agent elicits from the user to fulfill the function.

Returns:

• (Hash<String,Types::ParameterDetail>)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 4540

class Function < Struct.new(
  :description,
  :name,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end

#require_confirmation ⇒ String

Contains information if user confirmation is required to invoke the function.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 4540

class Function < Struct.new(
  :description,
  :name,
  :parameters,
  :require_confirmation)
  SENSITIVE = []
  include Aws::Structure
end