Package software.amazon.awssdk.services.bedrockagentruntime.model

Class Citation

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.Citation

All Implemented Interfaces:

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

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

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Citation.Builder

Method Summary

Modifier and Type	Method	Description
static Citation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
GeneratedResponsePart	generatedResponsePart()	Contains the generated response and metadata
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRetrievedReferences()	For responses, this returns true if the service returned a value for the RetrievedReferences property.
List<RetrievedReference>	retrievedReferences()	Contains metadata about the sources cited for the generated response.
List<SdkField<?>>	sdkFields()
static Class<? extends Citation.Builder>	serializableBuilderClass()
Citation.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

generatedResponsePart

public final GeneratedResponsePart generatedResponsePart()

Contains the generated response and metadata

Returns:

Contains the generated response and metadata

hasRetrievedReferences

public final boolean hasRetrievedReferences()

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

retrievedReferences

public final List<RetrievedReference> retrievedReferences()

Contains metadata about the sources cited for the generated response.

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

Returns:

Contains metadata about the sources cited for the generated response.

toBuilder

public Citation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Citation.Builder,Citation>

builder

public static Citation.Builder builder()

serializableBuilderClass

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