TextAnalyticsClient Class

Definition

The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview

public class TextAnalyticsClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.CognitiveServices.Language.TextAnalytics.TextAnalyticsClient>, IDisposable, Microsoft.Azure.CognitiveServices.Language.TextAnalytics.ITextAnalyticsClient
type TextAnalyticsClient = class
    inherit ServiceClient<TextAnalyticsClient>
    interface ITextAnalyticsClient
    interface IDisposable
Public Class TextAnalyticsClient
Inherits ServiceClient(Of TextAnalyticsClient)
Implements IDisposable, ITextAnalyticsClient
Inheritance
Microsoft.Rest.ServiceClient`1
TextAnalyticsClient
Implements

Constructors

TextAnalyticsClient(DelegatingHandler[])

Initializes a new instance of the TextAnalyticsClient class.

TextAnalyticsClient(HttpClient, Boolean)

Initializes a new instance of the TextAnalyticsClient class.

TextAnalyticsClient(HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the TextAnalyticsClient class.

TextAnalyticsClient(ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the TextAnalyticsClient class.

TextAnalyticsClient(ServiceClientCredentials, HttpClient, Boolean)

Initializes a new instance of the TextAnalyticsClient class.

TextAnalyticsClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the TextAnalyticsClient class.

Properties

Credentials

Subscription credentials which uniquely identify client subscription.

DeserializationSettings

Gets or sets json deserialization settings.

Endpoint

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

SerializationSettings

Gets or sets json serialization settings.

Methods

DetectLanguageWithHttpMessagesAsync(BatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns the detected language and a numeric score between 0 and 1.

DetectLanguageWithHttpMessagesAsync(Nullable<Boolean>, LanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns the detected language and a numeric score between 0 and 1.

EntitiesWithHttpMessagesAsync(MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a list of recognized entities in a given document.

EntitiesWithHttpMessagesAsync(Nullable<Boolean>, MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a list of recognized entities in a given document.

KeyPhrasesWithHttpMessagesAsync(MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a list of strings denoting the key talking points in the input text.

KeyPhrasesWithHttpMessagesAsync(Nullable<Boolean>, MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a list of strings denoting the key talking points in the input text.

SentimentWithHttpMessagesAsync(MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a numeric score between 0 and 1.

SentimentWithHttpMessagesAsync(Nullable<Boolean>, MultiLanguageBatchInput, Dictionary<String,List<String>>, CancellationToken)

The API returns a numeric score between 0 and 1.

Extension Methods

DetectLanguage(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
DetectLanguageAsync(ITextAnalyticsClient, BatchInput, CancellationToken)

The API returns the detected language and a numeric score between 0 and 1.

DetectLanguageAsync(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
DetectLanguageBatch(ITextAnalyticsClient, LanguageBatchInput, Nullable<Boolean>, CancellationToken)
DetectLanguageBatchAsync(ITextAnalyticsClient, LanguageBatchInput, Nullable<Boolean>, CancellationToken)
Entities(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
EntitiesAsync(ITextAnalyticsClient, MultiLanguageBatchInput, CancellationToken)

The API returns a list of recognized entities in a given document.

EntitiesAsync(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
EntitiesBatch(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)
EntitiesBatchAsync(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)
KeyPhrases(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
KeyPhrasesAsync(ITextAnalyticsClient, MultiLanguageBatchInput, CancellationToken)

The API returns a list of strings denoting the key talking points in the input text.

KeyPhrasesAsync(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
KeyPhrasesBatch(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)
KeyPhrasesBatchAsync(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)
Sentiment(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
SentimentAsync(ITextAnalyticsClient, MultiLanguageBatchInput, CancellationToken)

The API returns a numeric score between 0 and 1.

SentimentAsync(ITextAnalyticsClient, String, String, Nullable<Boolean>, CancellationToken)
SentimentBatch(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)
SentimentBatchAsync(ITextAnalyticsClient, MultiLanguageBatchInput, Nullable<Boolean>, CancellationToken)

Applies to