TextAnalyticsClient.RecognizeEntitiesBatch Method

Definition

Overloads

RecognizeEntitiesBatch(IEnumerable<TextDocumentInput>, TextAnalyticsRequestOptions, CancellationToken)

Runs a predictive model to identify a collection of named entities in the passed-in documents, 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/Text-Analytics/named-entity-types.

For a list of languages supported by this operation, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

For document length limits, maximum batch size, and supported text encoding, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/data-limits?tabs=version-3.

RecognizeEntitiesBatch(IEnumerable<String>, String, TextAnalyticsRequestOptions, CancellationToken)

Runs a predictive model to identify a collection of named entities in the passed-in documents, 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/Text-Analytics/named-entity-types.

For a list of languages supported by this operation, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

For document length limits, maximum batch size, and supported text encoding, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/data-limits?tabs=version-3.

RecognizeEntitiesBatch(IEnumerable<TextDocumentInput>, TextAnalyticsRequestOptions, CancellationToken)

Runs a predictive model to identify a collection of named entities in the passed-in documents, 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/Text-Analytics/named-entity-types.

For a list of languages supported by this operation, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

For document length limits, maximum batch size, and supported text encoding, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/data-limits?tabs=version-3.

public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RecognizeEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
override this.RecognizeEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
Public Overridable Function RecognizeEntitiesBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeEntitiesResultCollection)

Parameters

documents
System.Collections.Generic.IEnumerable<TextDocumentInput>

The documents to analyze.

options
TextAnalyticsRequestOptions

TextAnalyticsRequestOptions used to select the version of the predictive model to run, and whether statistics are returned in the response.

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken controlling the request lifetime.

Returns

Response<RecognizeEntitiesResultCollection>

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

Service returned a non-success status code.

Applies to

RecognizeEntitiesBatch(IEnumerable<String>, String, TextAnalyticsRequestOptions, CancellationToken)

Runs a predictive model to identify a collection of named entities in the passed-in documents, 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/Text-Analytics/named-entity-types.

For a list of languages supported by this operation, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

For document length limits, maximum batch size, and supported text encoding, see https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/data-limits?tabs=version-3.

public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member RecognizeEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
override this.RecognizeEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
Public Overridable Function RecognizeEntitiesBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeEntitiesResultCollection)

Parameters

documents
System.Collections.Generic.IEnumerable<System.String>

The documents to analyze.

language
System.String

The language that all the documents are 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
TextAnalyticsRequestOptions

TextAnalyticsRequestOptions used to select the version of the predictive model to run, and whether statistics are returned in the response.

cancellationToken
System.Threading.CancellationToken

A System.Threading.CancellationToken controlling the request lifetime.

Returns

Response<RecognizeEntitiesResultCollection>

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

Service returned a non-success status code.

Applies to