Package software.amazon.awssdk.services.bedrockruntime.model

Class SystemContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.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>

A system content block.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SystemContentBlock.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static SystemContentBlock	fromGuardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)	Create an instance of this class with guardContent() initialized to the given value.
static SystemContentBlock	fromGuardContent(GuardrailConverseContentBlock guardContent)	Create an instance of this class with guardContent() initialized to the given value.
static SystemContentBlock	fromText(String text)	Create an instance of this class with text() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GuardrailConverseContentBlock	guardContent()	A content block to assess with the guardrail.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SystemContentBlock.Builder>	serializableBuilderClass()
String	text()	A system prompt for the model.
SystemContentBlock.Builder	toBuilder()
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 Detail

text

public final String text()

A system prompt for the model.

Returns:

A system prompt for the model.

guardContent

public final GuardrailConverseContentBlock guardContent()

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Returns:

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

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.

A system prompt for the model.

Parameters:

text - A system prompt for the model.

fromGuardContent

public static SystemContentBlock fromGuardContent(GuardrailConverseContentBlock guardContent)

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

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Parameters:

guardContent - A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

fromGuardContent

public static SystemContentBlock fromGuardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)

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

A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

Parameters:

guardContent - A content block to assess with the guardrail. Use with the Converse or ConverseStream API operations.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

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