PiiEntityDocumentResult¶
- class oci.ai_language.models.PiiEntityDocumentResult(**kwargs)¶
Bases:
objectThe document response for batch detect personal identification.
Methods:
__init__(**kwargs)Initializes a new PiiEntityDocumentResult object with values from keyword arguments.
Attributes:
[Required] Gets the entities of this PiiEntityDocumentResult.
[Required] Gets the key of this PiiEntityDocumentResult.
[Required] Gets the language_code of this PiiEntityDocumentResult.
[Required] Gets the masked_text of this PiiEntityDocumentResult.
- __init__(**kwargs)¶
Initializes a new PiiEntityDocumentResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
key (str) – The value to assign to the key property of this PiiEntityDocumentResult.
entities (list[oci.ai_language.models.PiiEntity]) – The value to assign to the entities property of this PiiEntityDocumentResult.
masked_text (str) – The value to assign to the masked_text property of this PiiEntityDocumentResult.
language_code (str) – The value to assign to the language_code property of this PiiEntityDocumentResult.
- property entities¶
[Required] Gets the entities of this PiiEntityDocumentResult. List of batch detect personal identification.
- Returns
The entities of this PiiEntityDocumentResult.
- Return type
- property key¶
[Required] Gets the key of this PiiEntityDocumentResult. Document unique identifier defined by the user.
- Returns
The key of this PiiEntityDocumentResult.
- Return type
str
- property language_code¶
[Required] Gets the language_code of this PiiEntityDocumentResult. Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew
- Returns
The language_code of this PiiEntityDocumentResult.
- Return type
str
- property masked_text¶
[Required] Gets the masked_text of this PiiEntityDocumentResult. Masked text per given mask mode.
- Returns
The masked_text of this PiiEntityDocumentResult.
- Return type
str