Skip to content

Commit

Permalink
[Text Analytics] Increase discoverability for OM (#14086)
Browse files Browse the repository at this point in the history
By adding a line to the `analyzeSentiment` docstring about OM. Fixes #11970 after I talked to @maririos that this should be enough for now.
  • Loading branch information
deyaaeldeen authored Mar 3, 2021
1 parent 29c8bef commit 6c4485c
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -548,16 +548,17 @@ export class TextAnalyticsClient {
/**
* 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
* the model's confidence in each of the predicted sentiments. Optionally it
* can also identify targets in the text and assessments about it through
* opinion mining. For a list of languages supported by this operation, @see
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
* @param documents - The input strings to analyze.
* @param language - 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".
* @param options - Optional parameters for the operation.
* @param options - Optional parameters that includes enabling opinion mining.
*/
public async analyzeSentiment(
documents: string[],
Expand All @@ -567,11 +568,12 @@ export class TextAnalyticsClient {
/**
* 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
* the model's confidence in each of the predicted sentiments.Optionally it
* can also identify targets in the text and assessments about it through
* opinion mining. For a list of languages supported by this operation, @see
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
* @param documents - The input documents to analyze.
* @param options - Options for the operation.
* @param options - Optional parameters that includes enabling opinion mining.
*/
public async analyzeSentiment(
documents: TextDocumentInput[],
Expand Down

0 comments on commit 6c4485c

Please sign in to comment.