Package software.amazon.awscdk.services.bedrock

Interface CfnPromptVersion.PromptVariantProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPromptVersion.PromptVariantProperty.Jsii$Proxy

Enclosing class:

CfnPromptVersion

@Stability(Stable)
public static interface CfnPromptVersion.PromptVariantProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about a variant of the prompt.

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.*;
 PromptVariantProperty promptVariantProperty = PromptVariantProperty.builder()
         .name("name")
         .templateConfiguration(PromptTemplateConfigurationProperty.builder()
                 .text(TextPromptTemplateConfigurationProperty.builder()
                         .text("text")
                         // the properties below are optional
                         .inputVariables(List.of(PromptInputVariableProperty.builder()
                                 .name("name")
                                 .build()))
                         .build())
                 .build())
         .templateType("templateType")
         // the properties below are optional
         .inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
                 .text(PromptModelInferenceConfigurationProperty.builder()
                         .maxTokens(123)
                         .stopSequences(List.of("stopSequences"))
                         .temperature(123)
                         .topP(123)
                         .build())
                 .build())
         .modelId("modelId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPromptVersion.PromptVariantProperty.Builder	A builder for CfnPromptVersion.PromptVariantProperty
static final class	CfnPromptVersion.PromptVariantProperty.Jsii$Proxy	An implementation for CfnPromptVersion.PromptVariantProperty

Method Summary

Modifier and Type	Method	Description
static CfnPromptVersion.PromptVariantProperty.Builder	builder()
default Object	getInferenceConfiguration()	Contains inference configurations for the prompt variant.
default String	getModelId()	The unique identifier of the model or inference profile with which to run inference on the prompt.
String	getName()	The name of the prompt variant.
Object	getTemplateConfiguration()	Contains configurations for the prompt template.
String	getTemplateType()	The type of prompt template to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the prompt variant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-name

getTemplateConfiguration

@Stability(Stable)
@NotNull
Object getTemplateConfiguration()

Contains configurations for the prompt template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-templateconfiguration

getTemplateType

@Stability(Stable)
@NotNull
String getTemplateType()

The type of prompt template to use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-templatetype

getInferenceConfiguration

@Stability(Stable)
@Nullable
default Object getInferenceConfiguration()

Contains inference configurations for the prompt variant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-inferenceconfiguration

getModelId

@Stability(Stable)
@Nullable
default String getModelId()

The unique identifier of the model or inference profile with which to run inference on the prompt.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-promptvariant.html#cfn-bedrock-promptversion-promptvariant-modelid

builder

@Stability(Stable)
static CfnPromptVersion.PromptVariantProperty.Builder builder()

Returns:

a CfnPromptVersion.PromptVariantProperty.Builder of CfnPromptVersion.PromptVariantProperty