Interface CfnPrompt.ToolProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPrompt.ToolProperty.Jsii$Proxy
- Enclosing class:
CfnPrompt
@Stability(Stable)
public static interface CfnPrompt.ToolProperty
extends software.amazon.jsii.JsiiSerializable
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;
Object json;
ToolProperty toolProperty = ToolProperty.builder()
.cachePoint(CachePointBlockProperty.builder()
.type("type")
.build())
.toolSpec(ToolSpecificationProperty.builder()
.inputSchema(ToolInputSchemaProperty.builder()
.json(json)
.build())
.name("name")
// the properties below are optional
.description("description")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPrompt.ToolPropertystatic final classAn implementation forCfnPrompt.ToolProperty -
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCachePoint
CachePoint to include in the tool configuration.Returns union: either
IResolvableorCfnPrompt.CachePointBlockProperty- See Also:
-
getToolSpec
The specfication for the tool.Returns union: either
IResolvableorCfnPrompt.ToolSpecificationProperty- See Also:
-
builder
- Returns:
- a
CfnPrompt.ToolProperty.BuilderofCfnPrompt.ToolProperty
-