TextAnalysisModelFactory.PiiEntity Method

Definition

Namespace:

Azure.AI.Language.Text

Assembly:

Azure.AI.Language.Text.dll

Package:

Azure.AI.Language.Text v1.0.0-beta.2

Source:

TextAnalysisModelFactory.cs

Initializes a new instance of PiiEntity.

public static Azure.AI.Language.Text.PiiEntity PiiEntity (string text = default, string category = default, string subcategory = default, int offset = 0, int length = 0, double confidenceScore = 0, string type = default, System.Collections.Generic.IEnumerable<Azure.AI.Language.Text.EntityTag> tags = default, string mask = default, int? maskOffset = default, int? maskLength = default);

static member PiiEntity : string * string * string * int * int * double * string * seq<Azure.AI.Language.Text.EntityTag> * string * Nullable<int> * Nullable<int> -> Azure.AI.Language.Text.PiiEntity

Public Shared Function PiiEntity (Optional text As String = Nothing, Optional category As String = Nothing, Optional subcategory As String = Nothing, Optional offset As Integer = 0, Optional length As Integer = 0, Optional confidenceScore As Double = 0, Optional type As String = Nothing, Optional tags As IEnumerable(Of EntityTag) = Nothing, Optional mask As String = Nothing, Optional maskOffset As Nullable(Of Integer) = Nothing, Optional maskLength As Nullable(Of Integer) = Nothing) As PiiEntity

Parameters

text

String

Entity text as appears in the request.

category

String

Entity type.

subcategory

String

(Optional) Entity sub type.

offset

Int32

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

length

Int32

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

confidenceScore

Double

Confidence score between 0 and 1 of the extracted entity.

type

String

An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected.

tags

IEnumerable<EntityTag>

List of entity tags. Tags are to express some similarities/affinity between entities.

mask

String

Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text.

maskOffset

Nullable<Int32>

Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”.

maskLength

Nullable<Int32>

The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”.

Returns

PiiEntity

A new PiiEntity instance for mocking.