Enum Tool 

#[non_exhaustive]
pub enum Tool {
    CachePoint(CachePointBlock),
    SystemTool(SystemTool),
    ToolSpec(ToolSpecification),
    #[non_exhaustive]
    Unknown,
}

Information about a tool that you can use with the Converse API. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CachePoint(CachePointBlock)

CachePoint to include in the tool configuration.

SystemTool(SystemTool)

Specifies the system-defined tool that you want use.

ToolSpec(ToolSpecification)

The specfication for the tool.

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl Tool

pub fn as_cache_point(&self) -> Result<&CachePointBlock, &Self>

Tries to convert the enum instance into CachePoint, extracting the inner CachePointBlock. Returns Err(&Self) if it can’t be converted.

pub fn is_cache_point(&self) -> bool

Returns true if this is a CachePoint.

pub fn as_system_tool(&self) -> Result<&SystemTool, &Self>

Tries to convert the enum instance into SystemTool, extracting the inner SystemTool. Returns Err(&Self) if it can’t be converted.

pub fn is_system_tool(&self) -> bool

Returns true if this is a SystemTool.

pub fn as_tool_spec(&self) -> Result<&ToolSpecification, &Self>

Tries to convert the enum instance into ToolSpec, extracting the inner ToolSpecification. Returns Err(&Self) if it can’t be converted.

pub fn is_tool_spec(&self) -> bool

Returns true if this is a ToolSpec.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Tool