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

Class SearchResultLocation

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.SearchResultLocation

All Implemented Interfaces:

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

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

Specifies a search result location within the content array, providing positioning information for cited content using search result index and block positions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchResultLocation.Builder

Method Summary

Modifier and Type	Method	Description
static SearchResultLocation.Builder	builder()
Integer	end()	The ending position in the content array where the cited content ends.
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()
Integer	searchResultIndex()	The index of the search result content block where the cited content is found.
static Class<? extends SearchResultLocation.Builder>	serializableBuilderClass()
Integer	start()	The starting position in the content array where the cited content begins.
SearchResultLocation.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

searchResultIndex

public final Integer searchResultIndex()

The index of the search result content block where the cited content is found.

Returns:

The index of the search result content block where the cited content is found.

start

public final Integer start()

The starting position in the content array where the cited content begins.

Returns:

The starting position in the content array where the cited content begins.

end

public final Integer end()

The ending position in the content array where the cited content ends.

Returns:

The ending position in the content array where the cited content ends.

toBuilder

public SearchResultLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchResultLocation.Builder,SearchResultLocation>

builder

public static SearchResultLocation.Builder builder()

serializableBuilderClass

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