Package software.amazon.awssdk.services.bedrockagent.model

Class PromptVariant

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.PromptVariant

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PromptVariant.Builder,PromptVariant>

@Generated("software.amazon.awssdk:codegen")
public final class PromptVariant
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PromptVariant.Builder,PromptVariant>

Contains details about a variant of the prompt.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptVariant.Builder

Method Summary

Modifier and Type	Method	Description
static PromptVariant.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata()	For responses, this returns true if the service returned a value for the Metadata property.
PromptInferenceConfiguration	inferenceConfiguration()	Contains inference configurations for the prompt variant.
List<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.
String	modelId()	The unique identifier of the model or inference profile with which to run inference on the prompt.
String	name()	The name of the prompt variant.
List<SdkField<?>>	sdkFields()
static Class<? extends PromptVariant.Builder>	serializableBuilderClass()
PromptTemplateConfiguration	templateConfiguration()	Contains configurations for the prompt template.
PromptTemplateType	templateType()	The type of prompt template to use.
String	templateTypeAsString()	The type of prompt template to use.
PromptVariant.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

inferenceConfiguration

public final PromptInferenceConfiguration inferenceConfiguration()

Contains inference configurations for the prompt variant.

Returns:

Contains inference configurations for the prompt variant.

hasMetadata

public final boolean hasMetadata()

For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metadata

public final List<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. For more information, see Create a prompt using Prompt management.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadata() method.

Returns:

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.

modelId

public final String modelId()

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

Returns:

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

name

public final String name()

The name of the prompt variant.

Returns:

The name of the prompt variant.

templateConfiguration

public final PromptTemplateConfiguration templateConfiguration()

Contains configurations for the prompt template.

Returns:

Contains configurations for the prompt template.

templateType

public final PromptTemplateType templateType()

The type of prompt template to use.

If the service returns an enum value that is not available in the current SDK version, templateType will return PromptTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

Returns:

The type of prompt template to use.

See Also:

PromptTemplateType

templateTypeAsString

public final String templateTypeAsString()

The type of prompt template to use.

If the service returns an enum value that is not available in the current SDK version, templateType will return PromptTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

Returns:

The type of prompt template to use.

See Also:

PromptTemplateType

toBuilder

public PromptVariant.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromptVariant.Builder,PromptVariant>

builder

public static PromptVariant.Builder builder()

serializableBuilderClass

public static Class<? extends PromptVariant.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo