bedrockruntime/aws.sdk.kotlin.services.bedrockruntime.model/Tool

Tool

sealed class Tool

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.

Inheritors

Types

CachePoint

data class CachePoint(val value: CachePointBlock) : Tool

CachePoint to include in the tool configuration.

SdkUnknown

object SdkUnknown : Tool

SystemTool

data class SystemTool(val value: SystemTool) : Tool

Specifies the system-defined tool that you want use.

ToolSpec

data class ToolSpec(val value: ToolSpecification) : Tool

The specfication for the tool.

Functions

asCachePoint

fun asCachePoint(): CachePointBlock

Casts this Tool as a CachePoint and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CachePointBlock value. Throws an exception if the Tool is not a CachePoint.

asCachePointOrNull

fun asCachePointOrNull(): CachePointBlock?

Casts this Tool as a CachePoint and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.CachePointBlock value. Returns null if the Tool is not a CachePoint.

asSystemTool

fun asSystemTool(): SystemTool

Casts this Tool as a SystemTool and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.SystemTool value. Throws an exception if the Tool is not a SystemTool.

asSystemToolOrNull

fun asSystemToolOrNull(): SystemTool?

Casts this Tool as a SystemTool and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.SystemTool value. Returns null if the Tool is not a SystemTool.

asToolSpec

fun asToolSpec(): ToolSpecification

Casts this Tool as a ToolSpec and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolSpecification value. Throws an exception if the Tool is not a ToolSpec.

asToolSpecOrNull

fun asToolSpecOrNull(): ToolSpecification?

Casts this Tool as a ToolSpec and retrieves its aws.sdk.kotlin.services.bedrockruntime.model.ToolSpecification value. Returns null if the Tool is not a ToolSpec.