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

Class CitationsContentBlock

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.CitationsContentBlock

All Implemented Interfaces:

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

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

A content block that contains both generated text and associated citation information. This block type is returned when document citations are enabled, providing traceability between the generated content and the source documents that informed the response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CitationsContentBlock.Builder

Method Summary

Modifier and Type	Method	Description
static CitationsContentBlock.Builder	builder()
List<Citation>	citations()	An array of citations that reference the source documents used to generate the associated content.
List<CitationGeneratedContent>	content()	The generated content that is supported by the associated citations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCitations()	For responses, this returns true if the service returned a value for the Citations property.
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 CitationsContentBlock.Builder>	serializableBuilderClass()
CitationsContentBlock.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

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<CitationGeneratedContent> content()

The generated content that is supported by the associated citations.

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:

The generated content that is supported by the associated citations.

hasCitations

public final boolean hasCitations()

For responses, this returns true if the service returned a value for the Citations 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.

citations

public final List<Citation> citations()

An array of citations that reference the source documents used to generate the associated content.

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 hasCitations() method.

Returns:

An array of citations that reference the source documents used to generate the associated content.

toBuilder

public CitationsContentBlock.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CitationsContentBlock.Builder,CitationsContentBlock>

builder

public static CitationsContentBlock.Builder builder()

serializableBuilderClass

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