Class GuardrailTraceAssessment
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockruntime.model.GuardrailTraceAssessment
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<GuardrailTraceAssessment.Builder,GuardrailTraceAssessment>
@Generated("software.amazon.awssdk:codegen") public final class GuardrailTraceAssessment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailTraceAssessment.Builder,GuardrailTraceAssessment>
A Top level guardrail trace object. For more information, see ConverseTrace.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGuardrailTraceAssessment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringactionReason()Provides the reason for the action taken when harmful content is detected.static GuardrailTraceAssessment.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInputAssessment()For responses, this returns true if the service returned a value for the InputAssessment property.booleanhasModelOutput()For responses, this returns true if the service returned a value for the ModelOutput property.booleanhasOutputAssessments()For responses, this returns true if the service returned a value for the OutputAssessments property.Map<String,GuardrailAssessment>inputAssessment()The input assessment.List<String>modelOutput()The output from the model.Map<String,List<GuardrailAssessment>>outputAssessments()the output assessments.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GuardrailTraceAssessment.Builder>serializableBuilderClass()GuardrailTraceAssessment.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
hasModelOutput
public final boolean hasModelOutput()
For responses, this returns true if the service returned a value for the ModelOutput property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
modelOutput
public final List<String> modelOutput()
The output from the model.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasModelOutput()method.- Returns:
- The output from the model.
-
hasInputAssessment
public final boolean hasInputAssessment()
For responses, this returns true if the service returned a value for the InputAssessment property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
inputAssessment
public final Map<String,GuardrailAssessment> inputAssessment()
The input assessment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInputAssessment()method.- Returns:
- The input assessment.
-
hasOutputAssessments
public final boolean hasOutputAssessments()
For responses, this returns true if the service returned a value for the OutputAssessments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
outputAssessments
public final Map<String,List<GuardrailAssessment>> outputAssessments()
the output assessments.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOutputAssessments()method.- Returns:
- the output assessments.
-
actionReason
public final String actionReason()
Provides the reason for the action taken when harmful content is detected.
- Returns:
- Provides the reason for the action taken when harmful content is detected.
-
toBuilder
public GuardrailTraceAssessment.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GuardrailTraceAssessment.Builder,GuardrailTraceAssessment>
-
builder
public static GuardrailTraceAssessment.Builder builder()
-
serializableBuilderClass
public static Class<? extends GuardrailTraceAssessment.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-