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

Class CitationSourceContent

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.CitationSourceContent

All Implemented Interfaces:

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

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

Contains the actual text content from a source document that is being cited or referenced in the model's response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CitationSourceContent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static CitationSourceContent	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)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CitationSourceContent.Builder>	serializableBuilderClass()
String	text()	The text content from the source document that is being cited.
CitationSourceContent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CitationSourceContent.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()

The text content from the source document that is being cited.

Returns:

The text content from the source document that is being cited.

toBuilder

public CitationSourceContent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CitationSourceContent.Builder,CitationSourceContent>

builder

public static CitationSourceContent.Builder builder()

serializableBuilderClass

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

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

The text content from the source document that is being cited.

Parameters:

text - The text content from the source document that is being cited.

type

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