BatchDetectLanguagePiiEntitiesDetails

class oci.ai_language.models.BatchDetectLanguagePiiEntitiesDetails(**kwargs)

Bases: object

The documents details to detect personal identification information.

Methods:

__init__(**kwargs)

Initializes a new BatchDetectLanguagePiiEntitiesDetails object with values from keyword arguments.

Attributes:

alias

Gets the alias of this BatchDetectLanguagePiiEntitiesDetails.

compartment_id

Gets the compartment_id of this BatchDetectLanguagePiiEntitiesDetails.

documents

[Required] Gets the documents of this BatchDetectLanguagePiiEntitiesDetails.

endpoint_id

Gets the endpoint_id of this BatchDetectLanguagePiiEntitiesDetails.

masking

Gets the masking of this BatchDetectLanguagePiiEntitiesDetails.

profile

Gets the profile of this BatchDetectLanguagePiiEntitiesDetails.

__init__(**kwargs)

Initializes a new BatchDetectLanguagePiiEntitiesDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • alias (str) – The value to assign to the alias property of this BatchDetectLanguagePiiEntitiesDetails.

  • endpoint_id (str) – The value to assign to the endpoint_id property of this BatchDetectLanguagePiiEntitiesDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this BatchDetectLanguagePiiEntitiesDetails.

  • documents (list[oci.ai_language.models.TextDocument]) – The value to assign to the documents property of this BatchDetectLanguagePiiEntitiesDetails.

  • masking (dict(str, PiiEntityMasking)) – The value to assign to the masking property of this BatchDetectLanguagePiiEntitiesDetails.

  • profile (oci.ai_language.models.Profile) – The value to assign to the profile property of this BatchDetectLanguagePiiEntitiesDetails.

property alias

Gets the alias of this BatchDetectLanguagePiiEntitiesDetails. Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns

The alias of this BatchDetectLanguagePiiEntitiesDetails.

Return type

str

property compartment_id

Gets the compartment_id of this BatchDetectLanguagePiiEntitiesDetails. The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns

The compartment_id of this BatchDetectLanguagePiiEntitiesDetails.

Return type

str

property documents

[Required] Gets the documents of this BatchDetectLanguagePiiEntitiesDetails. List of documents to detect personal identification information.

Returns

The documents of this BatchDetectLanguagePiiEntitiesDetails.

Return type

list[oci.ai_language.models.TextDocument]

property endpoint_id

Gets the endpoint_id of this BatchDetectLanguagePiiEntitiesDetails. 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 endpoint_id of this BatchDetectLanguagePiiEntitiesDetails.

Return type

str

property masking

Gets the masking of this BatchDetectLanguagePiiEntitiesDetails. Mask recognized PII entities with different modes.

Returns

The masking of this BatchDetectLanguagePiiEntitiesDetails.

Return type

dict(str, PiiEntityMasking)

property profile

Gets the profile of this BatchDetectLanguagePiiEntitiesDetails.

Returns

The profile of this BatchDetectLanguagePiiEntitiesDetails.

Return type

oci.ai_language.models.Profile