Class BatchDetectLanguagePiiEntitiesDetails

The documents details to detect personal identification information.

Inheritance

object

BatchDetectLanguagePiiEntitiesDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AilanguageService.Models

Assembly: OCI.DotNetSDK.Ailanguage.dll

Syntax

public class BatchDetectLanguagePiiEntitiesDetails

Properties

Alias

Declaration

[JsonProperty(PropertyName = "alias")]
public string Alias { get; set; }

Property Value

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

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

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

Documents

Declaration

[Required(ErrorMessage = "Documents is required.")]
[JsonProperty(PropertyName = "documents")]
public List<TextDocument> Documents { get; set; }

Property Value

Type	Description
List<TextDocument>	List of documents to detect personal identification information.

Remarks

Required

EndpointId

Declaration

[JsonProperty(PropertyName = "endpointId")]
public string EndpointId { get; set; }

Property Value

Type	Description
string	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.

Masking

Declaration

[JsonProperty(PropertyName = "masking")]
public Dictionary<string, PiiEntityMasking> Masking { get; set; }

Property Value

Type	Description
Dictionary<string, PiiEntityMasking>	Mask recognized PII entities with different modes.

Profile

Declaration

[JsonProperty(PropertyName = "profile")]
public Profile Profile { get; set; }

Property Value

Type	Description
Profile