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

Class ContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ContentBlock

All Implemented Interfaces:

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

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

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContentBlock.Builder	builder()
DocumentBlock	document()	A document to include in the message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ContentBlock	fromDocument(Consumer<DocumentBlock.Builder> document)	Create an instance of this class with document() initialized to the given value.
static ContentBlock	fromDocument(DocumentBlock document)	Create an instance of this class with document() initialized to the given value.
static ContentBlock	fromGuardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)	Create an instance of this class with guardContent() initialized to the given value.
static ContentBlock	fromGuardContent(GuardrailConverseContentBlock guardContent)	Create an instance of this class with guardContent() initialized to the given value.
static ContentBlock	fromImage(Consumer<ImageBlock.Builder> image)	Create an instance of this class with image() initialized to the given value.
static ContentBlock	fromImage(ImageBlock image)	Create an instance of this class with image() initialized to the given value.
static ContentBlock	fromText(String text)	Create an instance of this class with text() initialized to the given value.
static ContentBlock	fromToolResult(Consumer<ToolResultBlock.Builder> toolResult)	Create an instance of this class with toolResult() initialized to the given value.
static ContentBlock	fromToolResult(ToolResultBlock toolResult)	Create an instance of this class with toolResult() initialized to the given value.
static ContentBlock	fromToolUse(Consumer<ToolUseBlock.Builder> toolUse)	Create an instance of this class with toolUse() initialized to the given value.
static ContentBlock	fromToolUse(ToolUseBlock toolUse)	Create an instance of this class with toolUse() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GuardrailConverseContentBlock	guardContent()	Contains the content to assess with the guardrail.
int	hashCode()
ImageBlock	image()	Image to include in the message.
List<SdkField<?>>	sdkFields()
static Class<? extends ContentBlock.Builder>	serializableBuilderClass()
String	text()	Text to include in the message.
ContentBlock.Builder	toBuilder()
ToolResultBlock	toolResult()	The result for a tool request that a model makes.
ToolUseBlock	toolUse()	Information about a tool use request from a model.
String	toString()	Returns a string representation of this object.
ContentBlock.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()

Text to include in the message.

Returns:

Text to include in the message.

image

public final ImageBlock image()

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

Returns:

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

document

public final DocumentBlock document()

A document to include in the message.

Returns:

A document to include in the message.

toolUse

public final ToolUseBlock toolUse()

Information about a tool use request from a model.

Returns:

Information about a tool use request from a model.

toolResult

public final ToolResultBlock toolResult()

The result for a tool request that a model makes.

Returns:

The result for a tool request that a model makes.

guardContent

public final GuardrailConverseContentBlock guardContent()

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

  </p> 
 

Returns:

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

 </p> 

toBuilder

public ContentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContentBlock.Builder,ContentBlock>

builder

public static ContentBlock.Builder builder()

serializableBuilderClass

public static Class<? extends ContentBlock.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 ContentBlock fromText(String text)

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

Text to include in the message.

Parameters:

text - Text to include in the message.

fromImage

public static ContentBlock fromImage(ImageBlock image)

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

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

fromImage

public static ContentBlock fromImage(Consumer<ImageBlock.Builder> image)

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

Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

Parameters:

image - Image to include in the message.

This field is only supported by Anthropic Claude 3 models.

fromDocument

public static ContentBlock fromDocument(DocumentBlock document)

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

A document to include in the message.

Parameters:

document - A document to include in the message.

fromDocument

public static ContentBlock fromDocument(Consumer<DocumentBlock.Builder> document)

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

A document to include in the message.

Parameters:

document - A document to include in the message.

fromToolUse

public static ContentBlock fromToolUse(ToolUseBlock toolUse)

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

Information about a tool use request from a model.

Parameters:

toolUse - Information about a tool use request from a model.

fromToolUse

public static ContentBlock fromToolUse(Consumer<ToolUseBlock.Builder> toolUse)

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

Information about a tool use request from a model.

Parameters:

toolUse - Information about a tool use request from a model.

fromToolResult

public static ContentBlock fromToolResult(ToolResultBlock toolResult)

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

The result for a tool request that a model makes.

Parameters:

toolResult - The result for a tool request that a model makes.

fromToolResult

public static ContentBlock fromToolResult(Consumer<ToolResultBlock.Builder> toolResult)

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

The result for a tool request that a model makes.

Parameters:

toolResult - The result for a tool request that a model makes.

fromGuardContent

public static ContentBlock fromGuardContent(GuardrailConverseContentBlock guardContent)

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

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

  </p> 
 

Parameters:

guardContent - Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

 </p> 

fromGuardContent

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

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

Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

  </p> 
 

Parameters:

guardContent - Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

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

 </p> 

type

public ContentBlock.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 ContentBlock.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 ContentBlock.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