Package com.oracle.bmc.generativeai.model

Class PiiDetectionConfig

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeai.model.PiiDetectionConfig

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class PiiDetectionConfig
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The configuration details for personally identifiable information (PII) detection, in prompts and responses.
Note: Objects should always be created or deserialized using the PiiDetectionConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PiiDetectionConfig.Builder, which maintain a set of all explicitly set fields called PiiDetectionConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PiiDetectionConfig.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
PiiDetectionConfig(ContentModerationConfig.Mode mode, String modelId, Boolean isEnabled)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PiiDetectionConfig.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getIsEnabled()	Whether to enable the PII detection feature.
ContentModerationConfig.Mode	getMode()	The mode of operation for PII detection.
String	getModelId()	The OCID of the model used for the feature.
int	hashCode()
PiiDetectionConfig.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PiiDetectionConfig

@Deprecated
@ConstructorProperties({"mode","modelId","isEnabled"})
public PiiDetectionConfig(ContentModerationConfig.Mode mode,
                          String modelId,
                          Boolean isEnabled)

Deprecated.

Method Detail

builder

public static PiiDetectionConfig.Builder builder()

Create a new builder.

toBuilder

public PiiDetectionConfig.Builder toBuilder()

getMode

public ContentModerationConfig.Mode getMode()

The mode of operation for PII detection.

Returns:

the value

getModelId

public String getModelId()

The OCID of the model used for the feature.

Returns:

the value

getIsEnabled

public Boolean getIsEnabled()

Whether to enable the PII detection feature.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel