Class: Aws::QConnect::Types::ToolConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::ToolConfiguration

Defined in:

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

Overview

Configuration settings for a tool used by AI Agents.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #annotations ⇒ Types::Annotation

  Annotations for the tool configuration.

• #description ⇒ String

  The description of the tool configuration.

• #input_schema ⇒ Hash, ...

  The input schema for the tool configuration.

• #instruction ⇒ Types::ToolInstruction

  Instructions for using the tool.

• #output_filters ⇒ Array<Types::ToolOutputFilter>

  Output filters applies to the tool result.

• #output_schema ⇒ Hash, ...

  The output schema for the tool configuration.

• #override_input_values ⇒ Array<Types::ToolOverrideInputValue>

  Override input values for the tool configuration.

• #title ⇒ String

  The title of the tool configuration.

• #tool_id ⇒ String

  The identifier of the tool, for example toolName from Model Context Provider server.

• #tool_name ⇒ String

  The name of the tool.

• #tool_type ⇒ String

  The type of the tool.

• #user_interaction_configuration ⇒ Types::UserInteractionConfiguration

  Configuration for user interaction with the tool.

Instance Attribute Details

#annotations ⇒ Types::Annotation

Annotations for the tool configuration.

Returns:

• (Types::Annotation)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the tool configuration.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#input_schema ⇒ Hash, ...

The input schema for the tool configuration.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instruction ⇒ Types::ToolInstruction

Instructions for using the tool.

Returns:

• (Types::ToolInstruction)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_filters ⇒ Array<Types::ToolOutputFilter>

Output filters applies to the tool result.

Returns:

• (Array<Types::ToolOutputFilter>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#output_schema ⇒ Hash, ...

The output schema for the tool configuration.

Returns:

• (Hash, Array, String, Numeric, Boolean)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#override_input_values ⇒ Array<Types::ToolOverrideInputValue>

Override input values for the tool configuration.

Returns:

• (Array<Types::ToolOverrideInputValue>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the tool configuration.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tool_id ⇒ String

The identifier of the tool, for example toolName from Model Context Provider server.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tool_name ⇒ String

The name of the tool.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tool_type ⇒ String

The type of the tool.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_interaction_configuration ⇒ Types::UserInteractionConfiguration

Configuration for user interaction with the tool.

Returns:

• (Types::UserInteractionConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 11455

class ToolConfiguration < Struct.new(
  :tool_name,
  :tool_type,
  :title,
  :tool_id,
  :description,
  :instruction,
  :override_input_values,
  :output_filters,
  :input_schema,
  :output_schema,
  :annotations,
  :user_interaction_configuration)
  SENSITIVE = []
  include Aws::Structure
end