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

Class KnowledgeBasePromptTemplate

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.KnowledgeBasePromptTemplate

All Implemented Interfaces:

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

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

Defines a custom prompt template for orchestrating the retrieval and generation process.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBasePromptTemplate.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBasePromptTemplate.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 KnowledgeBasePromptTemplate.Builder>	serializableBuilderClass()
String	textPromptTemplate()	The text of the prompt template.
KnowledgeBasePromptTemplate.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 text of the prompt template.

Returns:

The text of the prompt template.

toBuilder

public KnowledgeBasePromptTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBasePromptTemplate.Builder,KnowledgeBasePromptTemplate>

builder

public static KnowledgeBasePromptTemplate.Builder builder()

serializableBuilderClass

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