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

Class SearchResultBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.SearchResultBlock

All Implemented Interfaces:

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

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

A search result block that enables natural citations with proper source attribution for retrieved content.

This field is only supported by Anthropic Claude Opus 4.1, Opus 4, Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchResultBlock.Builder

Method Summary

Modifier and Type	Method	Description
static SearchResultBlock.Builder	builder()
CitationsConfig	citations()	Configuration setting for citations
List<SearchResultContentBlock>	content()	An array of search result content block.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContent()	For responses, this returns true if the service returned a value for the Content property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchResultBlock.Builder>	serializableBuilderClass()
String	source()	The source URL or identifier for the content.
String	title()	A descriptive title for the search result.
SearchResultBlock.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

source

public final String source()

The source URL or identifier for the content.

Returns:

The source URL or identifier for the content.

title

public final String title()

A descriptive title for the search result.

Returns:

A descriptive title for the search result.

hasContent

public final boolean hasContent()

For responses, this returns true if the service returned a value for the Content property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

content

public final List<SearchResultContentBlock> content()

An array of search result content block.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContent() method.

Returns:

An array of search result content block.

citations

public final CitationsConfig citations()

Configuration setting for citations

Returns:

Configuration setting for citations

toBuilder

public SearchResultBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchResultBlock.Builder,SearchResultBlock>

builder

public static SearchResultBlock.Builder builder()

serializableBuilderClass

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