GeneratedClient | @azure/ai-text-analytics

Hierarchy

GeneratedClientContext
- GeneratedClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GeneratedClient(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, endpoint: string, options?: coreHttp.ServiceClientOptions): GeneratedClient

Overrides GeneratedClientContext.constructor
- Defined in generated/generatedClient.ts:17
Initializes a new instance of the GeneratedClient class.

Parameters
- credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials
  
  Subscription credentials which uniquely identify client subscription.
- endpoint: string
  
  Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
- Optional options: coreHttp.ServiceClientOptions
Returns GeneratedClient

Properties

credentials

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

endpoint

endpoint: string

Methods

entitiesLinking

entitiesLinking(input: MultiLanguageBatchInput, options?: Models.GeneratedClientEntitiesLinkingOptionalParams): Promise<Models.EntitiesLinkingResponse>
entitiesLinking(input: MultiLanguageBatchInput, callback: coreHttp.ServiceCallback<EntityLinkingResult>): void
entitiesLinking(input: MultiLanguageBatchInput, options: GeneratedClientEntitiesLinkingOptionalParams, callback: coreHttp.ServiceCallback<EntityLinkingResult>): void

- Defined in generated/generatedClient.ts:70
The API returns a list of recognized entities with links to a well-known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.

summary

Linked entities from a well-known knowledge base

Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- Optional options: Models.GeneratedClientEntitiesLinkingOptionalParams
Returns Promise<Models.EntitiesLinkingResponse>

Promise<Models.EntitiesLinkingResponse>
- Defined in generated/generatedClient.ts:75
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- callback: coreHttp.ServiceCallback<EntityLinkingResult>
  
  The callback
Returns void
- Defined in generated/generatedClient.ts:81
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- options: GeneratedClientEntitiesLinkingOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<EntityLinkingResult>
  
  The callback
Returns void

entitiesRecognitionGeneral

entitiesRecognitionGeneral(input: MultiLanguageBatchInput, options?: Models.GeneratedClientEntitiesRecognitionGeneralOptionalParams): Promise<Models.EntitiesRecognitionGeneralResponse>
entitiesRecognitionGeneral(input: MultiLanguageBatchInput, callback: coreHttp.ServiceCallback<EntitiesResult>): void
entitiesRecognitionGeneral(input: MultiLanguageBatchInput, options: GeneratedClientEntitiesRecognitionGeneralOptionalParams, callback: coreHttp.ServiceCallback<EntitiesResult>): void

- Defined in generated/generatedClient.ts:39
The API returns a list of general named entities in a given document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. See the Supported languages in Text Analytics API for the list of enabled languages.

summary

Named Entity Recognition

Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- Optional options: Models.GeneratedClientEntitiesRecognitionGeneralOptionalParams
Returns Promise<Models.EntitiesRecognitionGeneralResponse>

Promise<Models.EntitiesRecognitionGeneralResponse>
- Defined in generated/generatedClient.ts:44
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- callback: coreHttp.ServiceCallback<EntitiesResult>
  
  The callback
Returns void
- Defined in generated/generatedClient.ts:50
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- options: GeneratedClientEntitiesRecognitionGeneralOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<EntitiesResult>
  
  The callback
Returns void

keyPhrases

keyPhrases(input: MultiLanguageBatchInput, options?: Models.GeneratedClientKeyPhrasesOptionalParams): Promise<Models.KeyPhrasesResponse>
keyPhrases(input: MultiLanguageBatchInput, callback: coreHttp.ServiceCallback<KeyPhraseResult>): void
keyPhrases(input: MultiLanguageBatchInput, options: GeneratedClientKeyPhrasesOptionalParams, callback: coreHttp.ServiceCallback<KeyPhraseResult>): void

- Defined in generated/generatedClient.ts:102
The API returns a list of strings denoting the key phrases in the input text. See the Supported languages in Text Analytics API for the list of enabled languages.

summary

Key Phrases

Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze. Documents can now contain a language field to indicate the text language
- Optional options: Models.GeneratedClientKeyPhrasesOptionalParams
Returns Promise<Models.KeyPhrasesResponse>

Promise<Models.KeyPhrasesResponse>
- Defined in generated/generatedClient.ts:108
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze. Documents can now contain a language field to indicate the text language
- callback: coreHttp.ServiceCallback<KeyPhraseResult>
  
  The callback
Returns void
- Defined in generated/generatedClient.ts:115
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze. Documents can now contain a language field to indicate the text language
- options: GeneratedClientKeyPhrasesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<KeyPhraseResult>
  
  The callback
Returns void

languages

languages(input: LanguageBatchInput, options?: Models.GeneratedClientLanguagesOptionalParams): Promise<Models.LanguagesResponse>
languages(input: LanguageBatchInput, callback: coreHttp.ServiceCallback<LanguageResult>): void
languages(input: LanguageBatchInput, options: GeneratedClientLanguagesOptionalParams, callback: coreHttp.ServiceCallback<LanguageResult>): void

- Defined in generated/generatedClient.ts:136
The API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See the Supported languages in Text Analytics API for the list of enabled languages.

summary

Detect Language

Parameters
- input: LanguageBatchInput
  
  Collection of documents to analyze.
- Optional options: Models.GeneratedClientLanguagesOptionalParams
Returns Promise<Models.LanguagesResponse>

Promise<Models.LanguagesResponse>
- Defined in generated/generatedClient.ts:141
Parameters
- input: LanguageBatchInput
  
  Collection of documents to analyze.
- callback: coreHttp.ServiceCallback<LanguageResult>
  
  The callback
Returns void
- Defined in generated/generatedClient.ts:147
Parameters
- input: LanguageBatchInput
  
  Collection of documents to analyze.
- options: GeneratedClientLanguagesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<LanguageResult>
  
  The callback
Returns void

sentiment

sentiment(input: MultiLanguageBatchInput, options?: Models.GeneratedClientSentimentOptionalParams): Promise<Models.SentimentResponse2>
sentiment(input: MultiLanguageBatchInput, callback: coreHttp.ServiceCallback<SentimentResponse>): void
sentiment(input: MultiLanguageBatchInput, options: GeneratedClientSentimentOptionalParams, callback: coreHttp.ServiceCallback<SentimentResponse>): void

- Defined in generated/generatedClient.ts:168
The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the Supported languages in Text Analytics API for the list of enabled languages.

summary

Sentiment

Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- Optional options: Models.GeneratedClientSentimentOptionalParams
Returns Promise<Models.SentimentResponse2>

Promise<Models.SentimentResponse2>
- Defined in generated/generatedClient.ts:173
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- callback: coreHttp.ServiceCallback<SentimentResponse>
  
  The callback
Returns void
- Defined in generated/generatedClient.ts:179
Parameters
- input: MultiLanguageBatchInput
  
  Collection of documents to analyze.
- options: GeneratedClientSentimentOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SentimentResponse>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

endpoint: string

Optional options: coreHttp.ServiceClientOptions

Returns GeneratedClient

Properties

credentials

endpoint

Methods

entitiesLinking

Parameters

input: MultiLanguageBatchInput

Optional options: Models.GeneratedClientEntitiesLinkingOptionalParams

Returns Promise<Models.EntitiesLinkingResponse>

Parameters

input: MultiLanguageBatchInput

callback: coreHttp.ServiceCallback<EntityLinkingResult>

Returns void

Parameters

input: MultiLanguageBatchInput

options: GeneratedClientEntitiesLinkingOptionalParams

callback: coreHttp.ServiceCallback<EntityLinkingResult>

Returns void

entitiesRecognitionGeneral

Parameters

input: MultiLanguageBatchInput

Optional options: Models.GeneratedClientEntitiesRecognitionGeneralOptionalParams

Returns Promise<Models.EntitiesRecognitionGeneralResponse>

Parameters

input: MultiLanguageBatchInput

callback: coreHttp.ServiceCallback<EntitiesResult>

Returns void

Parameters

input: MultiLanguageBatchInput

options: GeneratedClientEntitiesRecognitionGeneralOptionalParams

callback: coreHttp.ServiceCallback<EntitiesResult>

Returns void

keyPhrases

Parameters

input: MultiLanguageBatchInput

Optional options: Models.GeneratedClientKeyPhrasesOptionalParams

Returns Promise<Models.KeyPhrasesResponse>

Parameters

input: MultiLanguageBatchInput

callback: coreHttp.ServiceCallback<KeyPhraseResult>

Returns void

Parameters

input: MultiLanguageBatchInput

options: GeneratedClientKeyPhrasesOptionalParams

callback: coreHttp.ServiceCallback<KeyPhraseResult>

Returns void

languages

Parameters

input: LanguageBatchInput

Optional options: Models.GeneratedClientLanguagesOptionalParams

Returns Promise<Models.LanguagesResponse>

Parameters

input: LanguageBatchInput

callback: coreHttp.ServiceCallback<LanguageResult>

Returns void

Parameters

input: LanguageBatchInput

options: GeneratedClientLanguagesOptionalParams

callback: coreHttp.ServiceCallback<LanguageResult>

Returns void

sentiment

Parameters

input: MultiLanguageBatchInput

Optional options: Models.GeneratedClientSentimentOptionalParams

Returns Promise<Models.SentimentResponse2>

Parameters

input: MultiLanguageBatchInput

callback: coreHttp.ServiceCallback<SentimentResponse>