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:

  • 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.

    • invocationMetrics

      public final GuardrailInvocationMetrics invocationMetrics()

      The invocation metrics for the guardrail assessment.

      Returns:
      The invocation metrics for the guardrail assessment.

    • toBuilder

      public GuardrailAssessment.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GuardrailAssessment.Builder,GuardrailAssessment>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.