Package version
Creates an instance of TextAnalyticsClient.
Example usage:
import { TextAnalyticsClient, CognitiveServicesCredential } from "@azure/ai-text-analytics";
const client = new TextAnalyticsClient(
"<service endpoint>",
new CognitiveServicesCredential("<subscription key>")
);The URL to the TextAnalytics endpoint
Used to authenticate requests to the service.
The default country hint to use. Defaults to "us".
The default language to use. Defaults to "en".
The URL to the TextAnalytics endpoint
Runs a predictive model to identify the positive, negative, neutral, or mixed sentiment contained in the input strings, as well as scores indicating the model's confidence in each of the predicted sentiments. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input strings to analyze.
The language that all the input strings are
written in. If unspecified, this value will be set to the default
language in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model
where the lanuage is explicitly set to "None".
Optional parameters for the operation.
Runs a predictive model to identify the positive, negative or neutral, or mixed sentiment contained in the input documents, as well as scores indicating the model's confidence in each of the predicted sentiments. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input documents to analyze.
Optional parameters for the operation.
Runs a predictive model to determine the language that the passed-in input strings are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. 120 languages are supported.
A collection of input strings to analyze.
Indicates the country of origin for all of
the input strings to assist the text analytics model in predicting
the language they are written in. If unspecified, this value will be
set to the default country hint in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model where the
country is explicitly set to "None".
The same country hint is applied to all strings in the input collection.
Optional parameters for the operation.
Runs a predictive model to determine the language that the passed-in input document are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. 120 languages are supported.
A collection of input documents to analyze.
Optional parameters for the operation.
Runs a model to identify a collection of significant phrases found in the passed-in input strings. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input strings to analyze.
The language that all the input strings are
written in. If unspecified, this value will be set to the default
language in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model
where the lanuage is explicitly set to "None".
Optional parameters for the operation.
Runs a model to identify a collection of significant phrases found in the passed-in input documents. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input documents to analyze.
Optional parameters for the operation.
Runs a predictive model to identify a collection of named entities in the passed-in input strings, and categorize those entities into types such as person, location, or organization. For more information on available categories, see https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/named-entity-types. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input strings to analyze.
The language that all the input strings are
written in. If unspecified, this value will be set to the default
language in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model
where the lanuage is explicitly set to "None".
Optional parameters for the operation.
Runs a predictive model to identify a collection of named entities in the passed-in input documents, and categorize those entities into types such as person, location, or organization. For more information on available categories, see https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/named-entity-types. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input documents to analyze.
Optional parameters for the operation.
Runs a predictive model to identify a collection of entities found in the passed-in input strings, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input strings to analyze.
The language that all the input strings are
written in. If unspecified, this value will be set to the default
language in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model
where the lanuage is explicitly set to "None".
Optional parameters for the operation.
Runs a predictive model to identify a collection of entities found in the passed-in input documents, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input documents to analyze.
Optional parameters for the operation.
Runs a predictive model to identify a collection of entities containing personally identifiable information found in the passed-in input strings, and categorize those entities into types such as US social security number, drivers license number, or credit card number. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input strings to analyze.
The language that all the input strings are
written in. If unspecified, this value will be set to the default
language in TextAnalyticsClientOptions.
If set to an empty string, the service will apply a model
where the lanuage is explicitly set to "None".
Optional parameters for the operation.
Runs a predictive model to identify a collection of entities containing personally identifiable information found in the passed-in input documents, and categorize those entities into types such as US social security number, drivers license number, or credit card number. For a list of languages supported by this operation, see https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.
The input documents to analyze.
Optional parameters for the operation.
Generated using TypeDoc
Client class for interacting with Azure Text Analytics.