Share via

RecognizePiiEntitiesResult Class

  • Reference

Definition

Namespace:
Azure.AI.TextAnalytics
Assembly:
Azure.AI.TextAnalytics.dll
Package:
Azure.AI.TextAnalytics v5.3.0
Source:
RecognizePiiEntitiesResult.cs

The result of the recognize PII entities operation on a document, containing a collection of the PiiEntity objects containing Personally Identifiable Information that were found in that document.

public class RecognizePiiEntitiesResult : Azure.AI.TextAnalytics.TextAnalyticsResult
type RecognizePiiEntitiesResult = class
    inherit TextAnalyticsResult
Public Class RecognizePiiEntitiesResult
Inherits TextAnalyticsResult
Inheritance
Object
TextAnalyticsResult
RecognizePiiEntitiesResult

Properties

Entities

Gets the collection of PII entities containing Personally Identifiable Information in the document.
Error

Gets the error explaining why the operation failed on this document. This property will have a value only when the document cannot be processed.

(Inherited from TextAnalyticsResult)
HasError

Indicates that the document was not successfully processed and an error was returned for this document.

(Inherited from TextAnalyticsResult)
Id

Gets the unique identifier for the document that generated the result.

(Inherited from TextAnalyticsResult)
Statistics

Gets statistics about the document and how it was processed by the service. This property will have a value when IncludeStatistics is set to true in the client call.

(Inherited from TextAnalyticsResult)

Applies to