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

Class GuardrailAssessment

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.GuardrailAssessment

All Implemented Interfaces:

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

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

A behavior assessment of the guardrail policies used in a call to the Converse API.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailAssessment.Builder

Method Summary

Modifier and Type	Method	Description
final AppliedGuardrailDetails	appliedGuardrailDetails()	Returns the value of the AppliedGuardrailDetails property for this object.
final GuardrailAutomatedReasoningPolicyAssessment	automatedReasoningPolicy()	The automated reasoning policy assessment results, including logical validation findings for the input content.
static GuardrailAssessment.Builder	builder()
final GuardrailContentPolicyAssessment	contentPolicy()	The content policy.
final GuardrailContextualGroundingPolicyAssessment	contextualGroundingPolicy()	The contextual grounding policy used for the guardrail assessment.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final GuardrailInvocationMetrics	invocationMetrics()	The invocation metrics for the guardrail assessment.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
final GuardrailSensitiveInformationPolicyAssessment	sensitiveInformationPolicy()	The sensitive information policy.
static Class<? extends GuardrailAssessment.Builder>	serializableBuilderClass()
GuardrailAssessment.Builder	toBuilder()
final GuardrailTopicPolicyAssessment	topicPolicy()	The topic policy.
final String	toString()	Returns a string representation of this object.
final GuardrailWordPolicyAssessment	wordPolicy()	The word policy.

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 Details

topicPolicy

public final GuardrailTopicPolicyAssessment topicPolicy()

The topic policy.

Returns:

The topic policy.

contentPolicy

public final GuardrailContentPolicyAssessment contentPolicy()

The content policy.

Returns:

The content policy.

wordPolicy

public final GuardrailWordPolicyAssessment wordPolicy()

The word policy.

Returns:

The word policy.

sensitiveInformationPolicy

public final GuardrailSensitiveInformationPolicyAssessment sensitiveInformationPolicy()

The sensitive information policy.

Returns:

The sensitive information policy.

contextualGroundingPolicy

public final GuardrailContextualGroundingPolicyAssessment contextualGroundingPolicy()

The contextual grounding policy used for the guardrail assessment.

Returns:

The contextual grounding policy used for the guardrail assessment.

automatedReasoningPolicy

public final GuardrailAutomatedReasoningPolicyAssessment automatedReasoningPolicy()

The automated reasoning policy assessment results, including logical validation findings for the input content.

Returns:

The automated reasoning policy assessment results, including logical validation findings for the input content.

invocationMetrics

public final GuardrailInvocationMetrics invocationMetrics()

The invocation metrics for the guardrail assessment.

Returns:

The invocation metrics for the guardrail assessment.

appliedGuardrailDetails

public final AppliedGuardrailDetails appliedGuardrailDetails()

Returns the value of the AppliedGuardrailDetails property for this object.

Returns:

The value of the AppliedGuardrailDetails property for this object.

toBuilder

public GuardrailAssessment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailAssessment.Builder,GuardrailAssessment>

builder

public static GuardrailAssessment.Builder builder()

serializableBuilderClass

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