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

Class CitationGeneratedContent

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.CitationGeneratedContent

All Implemented Interfaces:

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

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

Contains the generated text content that corresponds to or is supported by a citation from a source document.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CitationGeneratedContent.Builder
static enum	CitationGeneratedContent.Type

Method Summary

Modifier and Type	Method	Description
static CitationGeneratedContent.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
static CitationGeneratedContent	fromText(String text)	Create an instance of this class with text() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CitationGeneratedContent.Builder>	serializableBuilderClass()
final String	text()	The text content that was generated by the model and is supported by the associated citation.
CitationGeneratedContent.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
CitationGeneratedContent.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 Details

text

public final String text()

The text content that was generated by the model and is supported by the associated citation.

Returns:

The text content that was generated by the model and is supported by the associated citation.

toBuilder

public CitationGeneratedContent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CitationGeneratedContent.Builder,CitationGeneratedContent>

builder

public static CitationGeneratedContent.Builder builder()

serializableBuilderClass

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

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

The text content that was generated by the model and is supported by the associated citation.

Parameters:

text - The text content that was generated by the model and is supported by the associated citation.

type

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