Interface CfnPrompt.ChatPromptTemplateConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPrompt.ChatPromptTemplateConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnPrompt
@Stability(Stable)
public static interface CfnPrompt.ChatPromptTemplateConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
Contains configurations to use a prompt in a conversational format.
For more information, see Create a prompt using Prompt management .
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 any;
Object auto;
Object json;
ChatPromptTemplateConfigurationProperty chatPromptTemplateConfigurationProperty = ChatPromptTemplateConfigurationProperty.builder()
.messages(List.of(MessageProperty.builder()
.content(List.of(ContentBlockProperty.builder()
.cachePoint(CachePointBlockProperty.builder()
.type("type")
.build())
.text("text")
.build()))
.role("role")
.build()))
// the properties below are optional
.inputVariables(List.of(PromptInputVariableProperty.builder()
.name("name")
.build()))
.system(List.of(SystemContentBlockProperty.builder()
.cachePoint(CachePointBlockProperty.builder()
.type("type")
.build())
.text("text")
.build()))
.toolConfiguration(ToolConfigurationProperty.builder()
.tools(List.of(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()))
// the properties below are optional
.toolChoice(ToolChoiceProperty.builder()
.any(any)
.auto(auto)
.tool(SpecificToolChoiceProperty.builder()
.name("name")
.build())
.build())
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPrompt.ChatPromptTemplateConfigurationPropertystatic final classAn implementation forCfnPrompt.ChatPromptTemplateConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectAn array of the variables in the prompt template.Contains messages in the chat for the prompt.default ObjectContains system prompts to provide context to the model or to describe how it should behave.default ObjectConfiguration information for the tools that the model can use when generating a response.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMessages
Contains messages in the chat for the prompt.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPrompt.MessageProperty>- See Also:
-
getInputVariables
An array of the variables in the prompt template.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPrompt.PromptInputVariableProperty>- See Also:
-
getSystem
Contains system prompts to provide context to the model or to describe how it should behave.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPrompt.SystemContentBlockProperty>- See Also:
-
getToolConfiguration
Configuration information for the tools that the model can use when generating a response.Returns union: either
IResolvableorCfnPrompt.ToolConfigurationProperty- See Also:
-
builder
-