Class: Aws::BedrockAgentCore::Types::ToolArguments

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::ToolArguments

Defined in:

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

Overview

The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock AgentCore. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #clear_context ⇒ Boolean

  Whether to clear the context for the tool.

• #code ⇒ String

  The code to execute in a code interpreter session.

• #command ⇒ String

  The command to execute with the tool.

• #content ⇒ Array<Types::InputContentBlock>

  The content for the tool operation.

• #directory_path ⇒ String

  The directory path for the tool operation.

• #language ⇒ String

  The programming language of the code to execute.

• #path ⇒ String

  The path for the tool operation.

• #paths ⇒ Array<String>

  The paths for the tool operation.

• #runtime ⇒ String

  The runtime environment to use for code execution.

• #task_id ⇒ String

  The identifier of the task for the tool operation.

Instance Attribute Details

#clear_context ⇒ Boolean

Whether to clear the context for the tool.

Returns:

• (Boolean)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ String

The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#command ⇒ String

The command to execute with the tool.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ Array<Types::InputContentBlock>

The content for the tool operation.

Returns:

• (Array<Types::InputContentBlock>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#directory_path ⇒ String

The directory path for the tool operation.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#language ⇒ String

The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The path for the tool operation.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#paths ⇒ Array<String>

The paths for the tool operation.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#runtime ⇒ String

The runtime environment to use for code execution. If not specified, defaults to deno for JavaScript and TypeScript.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

The identifier of the task for the tool operation.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 10855

class ToolArguments < Struct.new(
  :code,
  :language,
  :clear_context,
  :command,
  :path,
  :paths,
  :content,
  :directory_path,
  :task_id,
  :runtime)
  SENSITIVE = []
  include Aws::Structure
end