TextAnalyticsClient.RecognizePiiEntitiesBatchAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| RecognizePiiEntitiesBatchAsync(IEnumerable<String>, String, RecognizePiiEntitiesOptions, CancellationToken) |
Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. For more information on available categories, see https://aka.ms/azsdk/language/pii. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits. |
| RecognizePiiEntitiesBatchAsync(IEnumerable<TextDocumentInput>, RecognizePiiEntitiesOptions, CancellationToken) |
Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. For more information on available categories, see https://aka.ms/azsdk/language/pii. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits. |
RecognizePiiEntitiesBatchAsync(IEnumerable<String>, String, RecognizePiiEntitiesOptions, CancellationToken)
- Source:
- TextAnalyticsClient.cs
Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number.
For more information on available categories, see https://aka.ms/azsdk/language/pii.
For a list of languages supported by this operation, see https://aka.ms/talangs.
For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member RecognizePiiEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>
override this.RecognizePiiEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>Public Overridable Function RecognizePiiEntitiesBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizePiiEntitiesResultCollection))Parameters
- documents
- IEnumerable<String>
The documents to analyze.
- language
- String
The language that the document is written in. If unspecified, this value will be set to the default language in DefaultLanguage in the request sent to the service. If set to an empty string, the service will apply a model where the language is explicitly set to "None".
- options
- RecognizePiiEntitiesOptions
The additional configurable RecognizePiiEntitiesOptions that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A result containing the collection of entities identified for each of the documents, as well as scores indicating the confidence that a given entity correctly matches the identified substring.
Exceptions
This method is only supported in service API version v3.1 and newer.
Service returned a non-success status code.
Remarks
This method is only available for V3_1, V2022_05_01, and newer.
Applies to
RecognizePiiEntitiesBatchAsync(IEnumerable<TextDocumentInput>, RecognizePiiEntitiesOptions, CancellationToken)
- Source:
- TextAnalyticsClient.cs
Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number.
For more information on available categories, see https://aka.ms/azsdk/language/pii.
For a list of languages supported by this operation, see https://aka.ms/talangs.
For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member RecognizePiiEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>
override this.RecognizePiiEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>Public Overridable Function RecognizePiiEntitiesBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizePiiEntitiesResultCollection))Parameters
- documents
- IEnumerable<TextDocumentInput>
The documents to analyze.
- options
- RecognizePiiEntitiesOptions
The additional configurable RecognizePiiEntitiesOptions that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A result containing the collection of entities identified for each of the documents, as well as scores indicating the confidence that a given entity correctly matches the identified substring.
Exceptions
This method is only supported in service API version v3.1 and newer.
Service returned a non-success status code.
Remarks
This method is only available for V3_1, V2022_05_01, and newer.
