TextAnalyticsClient.ExtractKeyPhrases Method

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

TextAnalyticsClient.cs

Runs a model to identify a collection of significant phrases found in the passed-in document.

For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".

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

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

Public Overridable Function ExtractKeyPhrases (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KeyPhraseCollection)

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<KeyPhraseCollection>

A result containing the collection of key phrases identified in the document.

Exceptions

RequestFailedException

Service returned a non-success status code.