TextAnalyticsClient.RecognizeEntities Method

Reference

Definition

Namespace:: Azure.AI.TextAnalytics

Assembly:: Azure.AI.TextAnalytics.dll

Package:: Azure.AI.TextAnalytics v5.3.0

Source:: TextAnalyticsClient.cs

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.

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 Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection> RecognizeEntities (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function RecognizeEntities (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

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.

Applies to

Share via