Package software.amazon.awssdk.services.bedrockagentruntime.model

Class PromptTemplate

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.PromptTemplate

All Implemented Interfaces:

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

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

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

• RetrieveAndGenerate request – in the filter field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptTemplate.Builder

Method Summary

Modifier and Type	Method	Description
static PromptTemplate.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PromptTemplate.Builder>	serializableBuilderClass()
String	textPromptTemplate()	The template for the prompt that's sent to the model for response generation.
PromptTemplate.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

textPromptTemplate

public final String textPromptTemplate()

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

• Knowledge base prompt templates

• Use XML tags with Anthropic Claude models

Returns:

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

• Knowledge base prompt templates

• Use XML tags with Anthropic Claude models

toBuilder

public PromptTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromptTemplate.Builder,PromptTemplate>

builder

public static PromptTemplate.Builder builder()

serializableBuilderClass

public static Class<? extends PromptTemplate.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo