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

Class GuardrailContextualGroundingFilter

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailContextualGroundingFilter

All Implemented Interfaces:

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

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

The details for the guardrails contextual grounding filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailContextualGroundingFilter.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailContextualGroundingPolicyAction	action()	The action performed by the guardrails contextual grounding filter.
String	actionAsString()	The action performed by the guardrails contextual grounding filter.
static GuardrailContextualGroundingFilter.Builder	builder()
Boolean	detected()	Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	score()	The score generated by contextual grounding filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailContextualGroundingFilter.Builder>	serializableBuilderClass()
Double	threshold()	The threshold used by contextual grounding filter to determine whether the content is grounded or not.
GuardrailContextualGroundingFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailContextualGroundingFilterType	type()	The contextual grounding filter type.
String	typeAsString()	The contextual grounding filter type.

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 contextual grounding filter type.

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 contextual grounding filter type.

See Also:

GuardrailContextualGroundingFilterType

typeAsString

public final String typeAsString()

The contextual grounding filter type.

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 contextual grounding filter type.

See Also:

GuardrailContextualGroundingFilterType

threshold

public final Double threshold()

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

Returns:

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

score

public final Double score()

The score generated by contextual grounding filter.

Returns:

The score generated by contextual grounding filter.

action

public final GuardrailContextualGroundingPolicyAction action()

The action performed by the guardrails contextual grounding filter.

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

Returns:

The action performed by the guardrails contextual grounding filter.

See Also:

GuardrailContextualGroundingPolicyAction

actionAsString

public final String actionAsString()

The action performed by the guardrails contextual grounding filter.

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

Returns:

The action performed by the guardrails contextual grounding filter.

See Also:

GuardrailContextualGroundingPolicyAction

detected

public final Boolean detected()

Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

Returns:

Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

toBuilder

public GuardrailContextualGroundingFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailContextualGroundingFilter.Builder,GuardrailContextualGroundingFilter>

builder

public static GuardrailContextualGroundingFilter.Builder builder()

serializableBuilderClass

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