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

Class CitationsConfig

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.CitationsConfig

All Implemented Interfaces:

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

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

Configuration settings for enabling and controlling document citations in Converse API responses. When enabled, the model can include citation information that links generated content back to specific source documents.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CitationsConfig.Builder

Method Summary

Modifier and Type	Method	Description
static CitationsConfig.Builder	builder()
Boolean	enabled()	Specifies whether document citations should be included in the model's response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CitationsConfig.Builder>	serializableBuilderClass()
CitationsConfig.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

enabled

public final Boolean enabled()

Specifies whether document citations should be included in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response.

Returns:

Specifies whether document citations should be included in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response.

toBuilder

public CitationsConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CitationsConfig.Builder,CitationsConfig>

builder

public static CitationsConfig.Builder builder()

serializableBuilderClass

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