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

Class SystemContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.SystemContentBlock

All Implemented Interfaces:

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

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

Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SystemContentBlock.Builder
static enum	SystemContentBlock.Type

Method Summary

Modifier and Type	Method	Description
static SystemContentBlock.Builder	builder()
final CachePointBlock	cachePoint()	Creates a cache checkpoint within a tool designation
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static SystemContentBlock	fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)	Create an instance of this class with cachePoint() initialized to the given value.
static SystemContentBlock	fromCachePoint(CachePointBlock cachePoint)	Create an instance of this class with cachePoint() initialized to the given value.
static SystemContentBlock	fromText(String text)	Create an instance of this class with text() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SystemContentBlock.Builder>	serializableBuilderClass()
final String	text()	The text in the system prompt.
SystemContentBlock.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
SystemContentBlock.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 Details

text

public final String text()

The text in the system prompt.

Returns:

The text in the system prompt.

cachePoint

public final CachePointBlock cachePoint()

Creates a cache checkpoint within a tool designation

Returns:

Creates a cache checkpoint within a tool designation

toBuilder

public SystemContentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SystemContentBlock.Builder,SystemContentBlock>

builder

public static SystemContentBlock.Builder builder()

serializableBuilderClass

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

fromText

public static SystemContentBlock fromText(String text)

Create an instance of this class with text() initialized to the given value.

The text in the system prompt.

Parameters:

text - The text in the system prompt.

fromCachePoint

public static SystemContentBlock fromCachePoint(CachePointBlock cachePoint)

Create an instance of this class with cachePoint() initialized to the given value.

Creates a cache checkpoint within a tool designation

Parameters:

cachePoint - Creates a cache checkpoint within a tool designation

fromCachePoint

public static SystemContentBlock fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)

Create an instance of this class with cachePoint() initialized to the given value.

Creates a cache checkpoint within a tool designation

Parameters:

cachePoint - Creates a cache checkpoint within a tool designation

type

public SystemContentBlock.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be SystemContentBlock.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be SystemContentBlock.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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