Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ai-text-analytics] Final doc fixes before GA #9382

Merged
merged 2 commits into from
Jun 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sdk/textanalytics/ai-text-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,11 @@ If you'd like to contribute to this library, please read the [contributing guide

[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[cognitive_resource]: https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account
[cognitive_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity
[cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication
[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
[data_limits]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview#data-limits
```

Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export interface SentimentConfidenceScores {
/**
* The predicted sentiment for a given span of text. For more information regarding text sentiment,
* see
* https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis.
* https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis.
*/
export interface SentenceSentiment {
/**
Expand Down Expand Up @@ -244,7 +244,7 @@ export interface SentimentResponse {
/**
* A word or phrase identified as an entity that is categorized within a taxonomy of types. The set
* of categories recognized by the Text Analytics service is described at
* https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/named-entity-types .
* https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types .
*/
export interface Entity {
/**
Expand Down
22 changes: 11 additions & 11 deletions sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export interface TextAnalyticsOperationOptions extends OperationOptions {
* This value indicates which model will be used for scoring. If a model-version is
* not specified, the API should default to the latest, non-preview version.
* For supported model versions, see operation-specific documentation, for example:
* https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning
* https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning
*/
modelVersion?: string;
/**
Expand Down Expand Up @@ -286,9 +286,9 @@ export class TextAnalyticsClient {
* 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.
* https://docs.microsoft.com/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.
* 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
Expand All @@ -308,9 +308,9 @@ export class TextAnalyticsClient {
* 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.
* https://docs.microsoft.com/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.
* https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
* @param documents The input documents to analyze.
* @param options Optional parameters for the operation.
*/
Expand Down Expand Up @@ -377,7 +377,7 @@ export class TextAnalyticsClient {
* 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.
* 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
Expand All @@ -396,7 +396,7 @@ export class TextAnalyticsClient {
* 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.
* https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
* @param documents The input documents to analyze.
* @param options Optional parameters for the operation.
*/
Expand Down Expand Up @@ -460,7 +460,7 @@ export class TextAnalyticsClient {
* 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.
* 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
Expand All @@ -478,7 +478,7 @@ export class TextAnalyticsClient {
* 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.
* https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
* @param documents The input documents to analyze.
* @param options Optional parameters for the operation.
*/
Expand Down Expand Up @@ -543,7 +543,7 @@ export class TextAnalyticsClient {
* 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.
* 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
Expand All @@ -562,7 +562,7 @@ export class TextAnalyticsClient {
* 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.
* https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.
* @param documents The input documents to analyze.
* @param options Optional parameters for the operation.
*/
Expand Down
4 changes: 2 additions & 2 deletions sdk/textanalytics/ai-text-analytics/swagger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,13 @@ directive:
transform: $.description = "Represents a warning encountered while processing a document."
- from: swagger-document
where: $.definitions.SentenceSentiment
transform: $.description = "The predicted sentiment for a given span of text. For more information regarding text sentiment, see https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis."
transform: $.description = "The predicted sentiment for a given span of text. For more information regarding text sentiment, see https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis."
- from: swagger-document
where: $.definitions.Match
transform: $.description = "Details about the specific substring in a document that refers to a linked entity identified by the Text Analytics model."
- from: swagger-document
where: $.definitions.Entity
transform: $.description = "A word or phrase identified as an entity that is categorized within a taxonomy of types. The set of categories recognized by the Text Analytics service is described at https://docs.microsoft.com/en-us/azure/cognitive-services/Text-Analytics/named-entity-types ."
transform: $.description = "A word or phrase identified as an entity that is categorized within a taxonomy of types. The set of categories recognized by the Text Analytics service is described at https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types ."
- from: swagger-document
where: $.definitions.LinkedEntity
transform: $.description = "A word or phrase identified as a well-known entity within a database, including its formal (disambiguated) name and a link to the entity information within the source database."
Expand Down
4 changes: 2 additions & 2 deletions sdk/textanalytics/ai-text-analytics/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by

The Azure resource that is used by the tests in this project is:

- An [Azure Cognitive Services](https://azure.microsoft.com/en-us/services/cognitive-services/) account of the Text Analytics type.
- An [Azure Cognitive Services](https://azure.microsoft.com/services/cognitive-services/) account of the Text Analytics type.

To run the live tests, you will also need to set the below environment variables:

Expand All @@ -23,7 +23,7 @@ In order to use Azure Active Directory to run the live tests, you will need to c

### Using an App Registration (Service Principal)

- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal).
- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal).
- Note the Client ID and Tenant ID.
- In the "Certificates & Secrets" tab, create a secret and note that down.
- Ensure the following environment variables are set:
Expand Down