TextAnalyticsClient.RecognizeEntitiesAsync Method

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

TextAnalyticsClient.cs

Runs a predictive model to identify a collection of named entities in the passed-in document, and categorize those entities into types such as person, location, or organization.

For more information on available categories, see https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories.

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.CategorizedEntityCollection>> RecognizeEntitiesAsync (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RecognizeEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>>
override this.RecognizeEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>>

Public Overridable Function RecognizeEntitiesAsync (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CategorizedEntityCollection))

Parameters

document

String

The document 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".

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<CategorizedEntityCollection>>

A result containing the collection of entities identified in the document, as well as a score indicating the confidence that the entity correctly matches the identified substring.

Exceptions

RequestFailedException

Service returned a non-success status code.