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

Class CitationLocation

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.CitationLocation

All Implemented Interfaces:

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

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

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CitationLocation.Builder	builder()
DocumentCharLocation	documentChar()	The character-level location within the document where the cited content is found.
DocumentChunkLocation	documentChunk()	The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.
DocumentPageLocation	documentPage()	The page-level location within the document where the cited content is found.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static CitationLocation	fromDocumentChar(Consumer<DocumentCharLocation.Builder> documentChar)	Create an instance of this class with documentChar() initialized to the given value.
static CitationLocation	fromDocumentChar(DocumentCharLocation documentChar)	Create an instance of this class with documentChar() initialized to the given value.
static CitationLocation	fromDocumentChunk(Consumer<DocumentChunkLocation.Builder> documentChunk)	Create an instance of this class with documentChunk() initialized to the given value.
static CitationLocation	fromDocumentChunk(DocumentChunkLocation documentChunk)	Create an instance of this class with documentChunk() initialized to the given value.
static CitationLocation	fromDocumentPage(Consumer<DocumentPageLocation.Builder> documentPage)	Create an instance of this class with documentPage() initialized to the given value.
static CitationLocation	fromDocumentPage(DocumentPageLocation documentPage)	Create an instance of this class with documentPage() initialized to the given value.
static CitationLocation	fromSearchResultLocation(Consumer<SearchResultLocation.Builder> searchResultLocation)	Create an instance of this class with searchResultLocation() initialized to the given value.
static CitationLocation	fromSearchResultLocation(SearchResultLocation searchResultLocation)	Create an instance of this class with searchResultLocation() initialized to the given value.
static CitationLocation	fromWeb(Consumer<WebLocation.Builder> web)	Create an instance of this class with web() initialized to the given value.
static CitationLocation	fromWeb(WebLocation web)	Create an instance of this class with web() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SearchResultLocation	searchResultLocation()	The search result location where the cited content is found, including the search result index and block positions within the content array.
static Class<? extends CitationLocation.Builder>	serializableBuilderClass()
CitationLocation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CitationLocation.Type	type()	Retrieve an enum value representing which member of this object is populated.
WebLocation	web()	The web URL that was cited for this reference.

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

web

public final WebLocation web()

The web URL that was cited for this reference.

Returns:

The web URL that was cited for this reference.

documentChar

public final DocumentCharLocation documentChar()

The character-level location within the document where the cited content is found.

Returns:

The character-level location within the document where the cited content is found.

documentPage

public final DocumentPageLocation documentPage()

The page-level location within the document where the cited content is found.

Returns:

The page-level location within the document where the cited content is found.

documentChunk

public final DocumentChunkLocation documentChunk()

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Returns:

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

searchResultLocation

public final SearchResultLocation searchResultLocation()

The search result location where the cited content is found, including the search result index and block positions within the content array.

Returns:

The search result location where the cited content is found, including the search result index and block positions within the content array.

toBuilder

public CitationLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CitationLocation.Builder,CitationLocation>

builder

public static CitationLocation.Builder builder()

serializableBuilderClass

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

fromWeb

public static CitationLocation fromWeb(WebLocation web)

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

The web URL that was cited for this reference.

Parameters:

web - The web URL that was cited for this reference.

fromWeb

public static CitationLocation fromWeb(Consumer<WebLocation.Builder> web)

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

The web URL that was cited for this reference.

Parameters:

web - The web URL that was cited for this reference.

fromDocumentChar

public static CitationLocation fromDocumentChar(DocumentCharLocation documentChar)

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

The character-level location within the document where the cited content is found.

Parameters:

documentChar - The character-level location within the document where the cited content is found.

fromDocumentChar

public static CitationLocation fromDocumentChar(Consumer<DocumentCharLocation.Builder> documentChar)

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

The character-level location within the document where the cited content is found.

Parameters:

documentChar - The character-level location within the document where the cited content is found.

fromDocumentPage

public static CitationLocation fromDocumentPage(DocumentPageLocation documentPage)

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

The page-level location within the document where the cited content is found.

Parameters:

documentPage - The page-level location within the document where the cited content is found.

fromDocumentPage

public static CitationLocation fromDocumentPage(Consumer<DocumentPageLocation.Builder> documentPage)

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

The page-level location within the document where the cited content is found.

Parameters:

documentPage - The page-level location within the document where the cited content is found.

fromDocumentChunk

public static CitationLocation fromDocumentChunk(DocumentChunkLocation documentChunk)

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

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Parameters:

documentChunk - The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

fromDocumentChunk

public static CitationLocation fromDocumentChunk(Consumer<DocumentChunkLocation.Builder> documentChunk)

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

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Parameters:

documentChunk - The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

fromSearchResultLocation

public static CitationLocation fromSearchResultLocation(SearchResultLocation searchResultLocation)

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

The search result location where the cited content is found, including the search result index and block positions within the content array.

Parameters:

searchResultLocation - The search result location where the cited content is found, including the search result index and block positions within the content array.

fromSearchResultLocation

public static CitationLocation fromSearchResultLocation(Consumer<SearchResultLocation.Builder> searchResultLocation)

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

The search result location where the cited content is found, including the search result index and block positions within the content array.

Parameters:

searchResultLocation - The search result location where the cited content is found, including the search result index and block positions within the content array.

type

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