Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextAnalyticsClient

Package version

Client class for interacting with Azure Text Analytics.

Hierarchy

  • TextAnalyticsClient

Index

Constructors

constructor

Properties

defaultCountryHint

defaultCountryHint: string

The default country hint to use. Defaults to "us".

defaultLanguage

defaultLanguage: string

The default language to use. Defaults to "en".

endpointUrl

endpointUrl: string

The URL to the TextAnalytics endpoint

Methods

analyzeSentiment

beginAnalyzeActions

beginAnalyzeHealthcareEntities

detectLanguage

  • 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.

    Parameters

    • documents: string[]

      A collection of input strings to analyze.

    • Optional countryHint: undefined | string

      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, or the string "none", the service will apply a model where the country is explicitly unset. The same country hint is applied to all strings in the input collection.

    • Optional options: DetectLanguageOptions

      Optional parameters for the operation.

    Returns Promise<DetectLanguageResultArray>

  • 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.

    Parameters

    Returns Promise<DetectLanguageResultArray>

extractKeyPhrases

recognizeEntities

recognizeLinkedEntities

recognizePiiEntities

Generated using TypeDoc