Package software.amazon.awssdk.services.bedrock.model

Class GuardrailContextualGroundingFilterConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailContextualGroundingFilterConfig

All Implemented Interfaces:

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

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

The filter configuration details for the guardrails contextual grounding filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailContextualGroundingFilterConfig.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailContextualGroundingAction	action()	Specifies the action to take when content fails the contextual grounding evaluation.
String	actionAsString()	Specifies the action to take when content fails the contextual grounding evaluation.
static GuardrailContextualGroundingFilterConfig.Builder	builder()
Boolean	enabled()	Specifies whether to enable contextual grounding evaluation.
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 GuardrailContextualGroundingFilterConfig.Builder>	serializableBuilderClass()
Double	threshold()	The threshold details for the guardrails contextual grounding filter.
GuardrailContextualGroundingFilterConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailContextualGroundingFilterType	type()	The filter details for the guardrails contextual grounding filter.
String	typeAsString()	The filter details for the guardrails contextual grounding filter.

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 GuardrailContextualGroundingFilterType type()

The filter details for the guardrails contextual grounding filter.

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

Returns:

The filter details for the guardrails contextual grounding filter.

See Also:

GuardrailContextualGroundingFilterType

typeAsString

public final String typeAsString()

The filter details for the guardrails contextual grounding filter.

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

Returns:

The filter details for the guardrails contextual grounding filter.

See Also:

GuardrailContextualGroundingFilterType

threshold

public final Double threshold()

The threshold details for the guardrails contextual grounding filter.

Returns:

The threshold details for the guardrails contextual grounding filter.

action

public final GuardrailContextualGroundingAction action()

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailContextualGroundingAction

actionAsString

public final String actionAsString()

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

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

Returns:

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:

• BLOCK – Block the content and replace it with blocked messaging.

• NONE – Take no action but return detection information in the trace response.

See Also:

GuardrailContextualGroundingAction

enabled

public final Boolean enabled()

Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

toBuilder

public GuardrailContextualGroundingFilterConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailContextualGroundingFilterConfig.Builder,GuardrailContextualGroundingFilterConfig>

builder

public static GuardrailContextualGroundingFilterConfig.Builder builder()

serializableBuilderClass

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