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

Class AutomatedReasoningPolicyDefinition

java.lang.Object

software.amazon.awssdk.services.bedrock.model.AutomatedReasoningPolicyDefinition

All Implemented Interfaces:

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

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

Contains the formal logic rules, variables, and custom variable types that define an Automated Reasoning policy. The policy definition specifies the constraints used to validate foundation model responses for accuracy and logical consistency.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutomatedReasoningPolicyDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static AutomatedReasoningPolicyDefinition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
boolean	hasTypes()	For responses, this returns true if the service returned a value for the Types property.
boolean	hasVariables()	For responses, this returns true if the service returned a value for the Variables property.
List<AutomatedReasoningPolicyDefinitionRule>	rules()	The formal logic rules extracted from the source document.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutomatedReasoningPolicyDefinition.Builder>	serializableBuilderClass()
AutomatedReasoningPolicyDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<AutomatedReasoningPolicyDefinitionType>	types()	The custom user-defined vairable types used in the policy.
List<AutomatedReasoningPolicyDefinitionVariable>	variables()	The variables that represent concepts in the policy.
String	version()	The version of the policy definition format.

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

version

public final String version()

The version of the policy definition format.

Returns:

The version of the policy definition format.

hasTypes

public final boolean hasTypes()

For responses, this returns true if the service returned a value for the Types property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

types

public final List<AutomatedReasoningPolicyDefinitionType> types()

The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.

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 hasTypes() method.

Returns:

The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.

hasRules

public final boolean hasRules()

For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

rules

public final List<AutomatedReasoningPolicyDefinitionRule> rules()

The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.

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 hasRules() method.

Returns:

The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.

hasVariables

public final boolean hasVariables()

For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

variables

public final List<AutomatedReasoningPolicyDefinitionVariable> variables()

The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.

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 hasVariables() method.

Returns:

The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.

toBuilder

public AutomatedReasoningPolicyDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutomatedReasoningPolicyDefinition.Builder,AutomatedReasoningPolicyDefinition>

builder

public static AutomatedReasoningPolicyDefinition.Builder builder()

serializableBuilderClass

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