Package com.oracle.bmc.ailanguage.model

Class BatchDetectLanguagePiiEntitiesDetails

java.lang.Object

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

com.oracle.bmc.ailanguage.model.BatchDetectLanguagePiiEntitiesDetails

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

The documents details to detect personal identification information.
Note: Objects should always be created or deserialized using the BatchDetectLanguagePiiEntitiesDetails.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 BatchDetectLanguagePiiEntitiesDetails.Builder, which maintain a set of all explicitly set fields called BatchDetectLanguagePiiEntitiesDetails.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	BatchDetectLanguagePiiEntitiesDetails.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
BatchDetectLanguagePiiEntitiesDetails(String alias, String endpointId, String compartmentId, List<TextDocument> documents, Map<String,PiiEntityMasking> masking, Profile profile)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static BatchDetectLanguagePiiEntitiesDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAlias()	Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
String	getCompartmentId()	The OCID of the compartment that calls the API, inference will be served from pre trained model
List<TextDocument>	getDocuments()	List of documents to detect personal identification information.
String	getEndpointId()	The endpoint which have to be used for inferencing.
Map<String,PiiEntityMasking>	getMasking()	Mask recognized PII entities with different modes.
Profile	getProfile()
int	hashCode()
BatchDetectLanguagePiiEntitiesDetails.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

BatchDetectLanguagePiiEntitiesDetails

@Deprecated
@ConstructorProperties({"alias","endpointId","compartmentId","documents","masking","profile"})
public BatchDetectLanguagePiiEntitiesDetails(String alias,
                                             String endpointId,
                                             String compartmentId,
                                             List<TextDocument> documents,
                                             Map<String,PiiEntityMasking> masking,
                                             Profile profile)

Deprecated.

Method Detail

builder

public static BatchDetectLanguagePiiEntitiesDetails.Builder builder()

Create a new builder.

toBuilder

public BatchDetectLanguagePiiEntitiesDetails.Builder toBuilder()

getAlias

public String getAlias()

Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns:

the value

getEndpointId

public String getEndpointId()

The endpoint which have to be used for inferencing.

If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns:

the value

getDocuments

public List<TextDocument> getDocuments()

List of documents to detect personal identification information.

Returns:

the value

getMasking

public Map<String,PiiEntityMasking> getMasking()

Mask recognized PII entities with different modes.

Returns:

the value

getProfile

public Profile getProfile()

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