Interface PromptVariant.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PromptVariant.Builder,PromptVariant>, SdkBuilder<PromptVariant.Builder,PromptVariant>, SdkPojo

Enclosing class:

PromptVariant

@Mutable
@NotThreadSafe
public static interface PromptVariant.Builder
extends SdkPojo, CopyableBuilder<PromptVariant.Builder,PromptVariant>

Method Summary

Modifier and Type	Method	Description
PromptVariant.Builder	additionalModelRequestFields(Document additionalModelRequestFields)	Contains model-specific inference configurations that aren't in the inferenceConfiguration field.
default PromptVariant.Builder	genAiResource(Consumer<PromptGenAiResource.Builder> genAiResource)	Specifies a generative AI resource with which to use the prompt.
PromptVariant.Builder	genAiResource(PromptGenAiResource genAiResource)	Specifies a generative AI resource with which to use the prompt.
default PromptVariant.Builder	inferenceConfiguration(Consumer<PromptInferenceConfiguration.Builder> inferenceConfiguration)	Contains inference configurations for the prompt variant.
PromptVariant.Builder	inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)	Contains inference configurations for the prompt variant.
PromptVariant.Builder	metadata(Collection<PromptMetadataEntry> metadata)	An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
PromptVariant.Builder	metadata(Consumer<PromptMetadataEntry.Builder>... metadata)	An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
PromptVariant.Builder	metadata(PromptMetadataEntry... metadata)	An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
PromptVariant.Builder	modelId(String modelId)	The unique identifier of the model or inference profile with which to run inference on the prompt.
PromptVariant.Builder	name(String name)	The name of the prompt variant.
default PromptVariant.Builder	templateConfiguration(Consumer<PromptTemplateConfiguration.Builder> templateConfiguration)	Contains configurations for the prompt template.
PromptVariant.Builder	templateConfiguration(PromptTemplateConfiguration templateConfiguration)	Contains configurations for the prompt template.
PromptVariant.Builder	templateType(String templateType)	The type of prompt template to use.
PromptVariant.Builder	templateType(PromptTemplateType templateType)	The type of prompt template to use.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

PromptVariant.Builder name(String name)

The name of the prompt variant.

Parameters:

name - The name of the prompt variant.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateType

PromptVariant.Builder templateType(String templateType)

The type of prompt template to use.

Parameters:

templateType - The type of prompt template to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PromptTemplateType
• PromptTemplateType

templateType

PromptVariant.Builder templateType(PromptTemplateType templateType)

The type of prompt template to use.

Parameters:

templateType - The type of prompt template to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PromptTemplateType
• PromptTemplateType

templateConfiguration

PromptVariant.Builder templateConfiguration(PromptTemplateConfiguration templateConfiguration)

Contains configurations for the prompt template.

Parameters:

templateConfiguration - Contains configurations for the prompt template.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateConfiguration

default PromptVariant.Builder templateConfiguration(Consumer<PromptTemplateConfiguration.Builder> templateConfiguration)

Contains configurations for the prompt template.

This is a convenience method that creates an instance of the PromptTemplateConfiguration.Builder avoiding the need to create one manually via PromptTemplateConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to templateConfiguration(PromptTemplateConfiguration).

Parameters:

templateConfiguration - a consumer that will call methods on PromptTemplateConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• templateConfiguration(PromptTemplateConfiguration)

modelId

PromptVariant.Builder modelId(String modelId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

inferenceConfiguration

PromptVariant.Builder inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)

Contains inference configurations for the prompt variant.

Parameters:

inferenceConfiguration - Contains inference configurations for the prompt variant.

Returns:

Returns a reference to this object so that method calls can be chained together.

inferenceConfiguration

default PromptVariant.Builder inferenceConfiguration(Consumer<PromptInferenceConfiguration.Builder> inferenceConfiguration)

Contains inference configurations for the prompt variant.

This is a convenience method that creates an instance of the PromptInferenceConfiguration.Builder avoiding the need to create one manually via PromptInferenceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceConfiguration(PromptInferenceConfiguration).

Parameters:

inferenceConfiguration - a consumer that will call methods on PromptInferenceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• inferenceConfiguration(PromptInferenceConfiguration)

metadata

PromptVariant.Builder metadata(Collection<PromptMetadataEntry> metadata)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Parameters:

metadata - An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

PromptVariant.Builder metadata(PromptMetadataEntry... metadata)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Parameters:

metadata - An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

PromptVariant.Builder metadata(Consumer<PromptMetadataEntry.Builder>... metadata)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

This is a convenience method that creates an instance of the PromptMetadataEntry.Builder avoiding the need to create one manually via PromptMetadataEntry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadata(List<PromptMetadataEntry>).

Parameters:

metadata - a consumer that will call methods on PromptMetadataEntry.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• metadata(java.util.Collection<PromptMetadataEntry>)

additionalModelRequestFields

PromptVariant.Builder additionalModelRequestFields(Document additionalModelRequestFields)

Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.

Parameters:

additionalModelRequestFields - Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.

Returns:

Returns a reference to this object so that method calls can be chained together.

genAiResource

PromptVariant.Builder genAiResource(PromptGenAiResource genAiResource)

Specifies a generative AI resource with which to use the prompt.

Parameters:

genAiResource - Specifies a generative AI resource with which to use the prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

genAiResource

default PromptVariant.Builder genAiResource(Consumer<PromptGenAiResource.Builder> genAiResource)

Specifies a generative AI resource with which to use the prompt.

This is a convenience method that creates an instance of the PromptGenAiResource.Builder avoiding the need to create one manually via PromptGenAiResource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to genAiResource(PromptGenAiResource).

Parameters:

genAiResource - a consumer that will call methods on PromptGenAiResource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• genAiResource(PromptGenAiResource)