Package software.amazon.awssdk.services.bedrockagent.model

Class ContextEnrichmentConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.ContextEnrichmentConfiguration

All Implemented Interfaces:

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

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

Context enrichment configuration is used to provide additional context to the RAG application.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContextEnrichmentConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
BedrockFoundationModelContextEnrichmentConfiguration	bedrockFoundationModelConfiguration()	The configuration of the Amazon Bedrock foundation model used for context enrichment.
static ContextEnrichmentConfiguration.Builder	builder()
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 ContextEnrichmentConfiguration.Builder>	serializableBuilderClass()
ContextEnrichmentConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ContextEnrichmentType	type()	The method used for context enrichment.
String	typeAsString()	The method used for context enrichment.

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

type

public final ContextEnrichmentType type()

The method used for context enrichment. It must be Amazon Bedrock foundation models.

If the service returns an enum value that is not available in the current SDK version, type will return ContextEnrichmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The method used for context enrichment. It must be Amazon Bedrock foundation models.

See Also:

ContextEnrichmentType

typeAsString

public final String typeAsString()

The method used for context enrichment. It must be Amazon Bedrock foundation models.

If the service returns an enum value that is not available in the current SDK version, type will return ContextEnrichmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The method used for context enrichment. It must be Amazon Bedrock foundation models.

See Also:

ContextEnrichmentType

bedrockFoundationModelConfiguration

public final BedrockFoundationModelContextEnrichmentConfiguration bedrockFoundationModelConfiguration()

The configuration of the Amazon Bedrock foundation model used for context enrichment.

Returns:

The configuration of the Amazon Bedrock foundation model used for context enrichment.

toBuilder

public ContextEnrichmentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContextEnrichmentConfiguration.Builder,ContextEnrichmentConfiguration>

builder

public static ContextEnrichmentConfiguration.Builder builder()

serializableBuilderClass

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