diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md index d694345729d1..3419e907db8e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md @@ -1,7 +1,7 @@ # Release History -## 1.0.0-preview.6 (Unreleased) - +## 1.0.0 (2020-06-09) +- First stable release of Azure.AI.TextAnalytics package. ## 1.0.0-preview.5 (2020-05-27) ### Breaking changes diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md index 3a0d9d705011..4569f33b688d 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md @@ -14,7 +14,7 @@ Azure Cognitive Services Text Analytics is a cloud service that provides advance Install the Azure Text Analytics client library for .NET with [NuGet][nuget]: ```PowerShell -dotnet add package Azure.AI.TextAnalytics --version 1.0.0-preview.5 +dotnet add package Azure.AI.TextAnalytics ``` **Note:** This package version targets Azure Text Analytics service API version v3.0. @@ -34,13 +34,13 @@ You can create either resource using: Below is an example of how you can create a Text Analytics resource using the CLI: ```PowerShell -# Create a new resource group to hold the text analytics resource - +# Create a new resource group to hold the Text Analytics resource - # if using an existing resource group, skip this step az group create --name --location ``` ```PowerShell -# Create text analytics +# Create Text Analytics az cognitiveservices account create \ --name \ --resource-group \ @@ -320,12 +320,12 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con -[textanalytics_client_src]: src +[textanalytics_client_src]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/src [textanalytics_docs]: https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/ [textanalytics_refdocs]: https://aka.ms/azsdk-net-textanalytics-ref-docs [textanalytics_nuget_package]: https://www.nuget.org/packages/Azure.AI.TextAnalytics -[textanalytics_samples]: /samples/README.md -[textanalytics_rest_api]: https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0-Preview-1/operations/Languages +[textanalytics_samples]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md +[textanalytics_rest_api]: https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages [cognitive_resource_portal]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account [cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli @@ -335,23 +335,23 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [named_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-entity-linking [named_entities_categories]: https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types -[textanalytics_client_class]: src/TextAnalyticsClient.cs -[azure_identity]: ../../identity/Azure.Identity +[textanalytics_client_class]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs +[azure_identity]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.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 [aad_grant_access]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal [custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain -[DefaultAzureCredential]: ../../identity/Azure.Identity/README.md -[logging]: ../../core/Azure.Core/samples/Diagnostics.md +[DefaultAzureCredential]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.Identity/README.md +[logging]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md [data_limits]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview#data-limits -[contributing]: ../../../CONTRIBUTING.md - -[detect_language_sample]: samples/Sample1_DetectLanguage.md -[analyze_sentiment_sample]: samples/Sample2_AnalyzeSentiment.md -[extract_key_phrases_sample]: samples/Sample3_ExtractKeyPhrases.md -[recognize_entities_sample]: samples/Sample4_RecognizeEntities.md -[recognize_linked_entities_sample]: samples/Sample6_RecognizeLinkedEntities.md -[mock_client_sample]: samples/Sample_MockClient.md +[contributing]: https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md + +[detect_language_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample1_DetectLanguage.md +[analyze_sentiment_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample2_AnalyzeSentiment.md +[extract_key_phrases_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample3_ExtractKeyPhrases.md +[recognize_entities_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample4_RecognizeEntities.md +[recognize_linked_entities_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample6_RecognizeLinkedEntities.md +[mock_client_sample]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample_MockClient.md [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md index 5ae5e276555d..9956ed369f2e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md @@ -4,6 +4,7 @@ languages: - csharp products: - azure +- azure-cognitive-services - azure-text-analytics name: Azure Text Analytics samples for .NET description: Samples for the Azure.AI.TextAnalytics client library diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentResultCollection.cs index 6c6c5c8ab68e..8d7a4a8064fd 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeSentimentResultCollection.cs @@ -26,7 +26,7 @@ internal AnalyzeSentimentResultCollection(IList list, Te public TextDocumentBatchStatistics Statistics { get; } /// - /// Gets the version of the text analytics model used by this operation + /// Gets the version of the Text Analytics model used by this operation /// on this batch of documents. /// public string ModelVersion { get; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Azure.AI.TextAnalytics.csproj b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Azure.AI.TextAnalytics.csproj index e0e3e5b879a5..fe1858860023 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Azure.AI.TextAnalytics.csproj +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Azure.AI.TextAnalytics.csproj @@ -2,7 +2,7 @@ This is the Microsoft Azure Cognitive Services Text Analytics Service client library Microsoft Azure.AI.TextAnalytics client library - 1.0.0-preview.6 + 1.0.0 Microsoft Azure Text Analytics $(RequiredTargetFrameworks) $(NoWarn);3021 diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/CategorizedEntity.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/CategorizedEntity.cs index 8c0e48ff1483..2ac5dbf7be78 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/CategorizedEntity.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/CategorizedEntity.cs @@ -6,7 +6,7 @@ namespace Azure.AI.TextAnalytics /// /// A word or phrase identified as an entity that can be categorized /// as known type in a given taxonomy. The set of categories recognized by the - /// text analytics service is described at + /// Text Analytics service is described at /// . /// public readonly struct CategorizedEntity @@ -25,7 +25,7 @@ internal CategorizedEntity(string text, string category, string subCategory, dou public string Text { get; } /// - /// Gets the entity category inferred by the text analytics service's + /// Gets the entity category inferred by the Text Analytics service's /// named entity recognition model. The list of available categories is /// described at /// . @@ -33,7 +33,7 @@ internal CategorizedEntity(string text, string category, string subCategory, dou public EntityCategory Category { get; } /// - /// Gets the sub category of the entity inferred by the text analytics service's + /// Gets the sub category of the entity inferred by the Text Analytics service's /// named entity recognition model. This property may not have a value if /// a sub category doesn't exist for this entity. The list of available categories and /// subcategories is described at diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageInput.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageInput.cs index f4653c10191d..dbc115b5a76a 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageInput.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageInput.cs @@ -7,7 +7,7 @@ namespace Azure.AI.TextAnalytics /// An input to the detect language operation. This object allows the /// caller to specify a unique document id, as well as the full text of a /// document and a hint indicating the document's country of origin to assist - /// the text analytics predictive model in detecting the document's language. + /// the Text Analytics predictive model in detecting the document's language. /// public class DetectLanguageInput : TextAnalyticsInput { @@ -28,7 +28,7 @@ public class DetectLanguageInput : TextAnalyticsInput public DetectLanguageInput(string id, string text) : base(id, text) { } /// - /// Gets or sets a hint to assist the text analytics model in predicting + /// Gets or sets a hint to assist the Text Analytics model in predicting /// the language the document is written in. If unspecified, this value /// will be set to the default country hint in /// in the request sent to the service. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageResultCollection.cs index 8341d7191ce7..8a89d927856a 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/DetectLanguageResultCollection.cs @@ -31,7 +31,7 @@ internal DetectLanguageResultCollection(IList list, TextDo public TextDocumentBatchStatistics Statistics { get; } /// - /// Gets the version of the text analytics model used by this operation + /// Gets the version of the Text Analytics model used by this operation /// on this batch of documents. /// public string ModelVersion { get; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractKeyPhrasesResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractKeyPhrasesResultCollection.cs index 2e8dd08dd404..342457f4e528 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractKeyPhrasesResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractKeyPhrasesResultCollection.cs @@ -26,7 +26,7 @@ internal ExtractKeyPhrasesResultCollection(IList list, public TextDocumentBatchStatistics Statistics { get; } /// - /// Gets the version of the text analytics model used by this operation + /// Gets the version of the Text Analytics model used by this operation /// on this batch of documents. /// public string ModelVersion { get; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/LinkedEntityMatch.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/LinkedEntityMatch.cs index ed83cd471357..57255ab97133 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/LinkedEntityMatch.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/LinkedEntityMatch.cs @@ -5,7 +5,7 @@ namespace Azure.AI.TextAnalytics { /// /// Details regarding the specific substring in the document matching - /// the linked entity, or well-known item, that the text analytics model + /// the linked entity, or well-known item, that the Text Analytics model /// identified. /// public readonly struct LinkedEntityMatch diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeEntitiesResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeEntitiesResultCollection.cs index 7c3b0f2c2443..0ee841a703ae 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeEntitiesResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeEntitiesResultCollection.cs @@ -26,7 +26,7 @@ internal RecognizeEntitiesResultCollection(IList list, public TextDocumentBatchStatistics Statistics { get; } /// - /// Gets the version of the text analytics model used by this operation + /// Gets the version of the Text Analytics model used by this operation /// on this batch of documents. /// public string ModelVersion { get; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeLinkedEntitiesResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeLinkedEntitiesResultCollection.cs index d97e9ace90d1..dd3280b09fde 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeLinkedEntitiesResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeLinkedEntitiesResultCollection.cs @@ -26,7 +26,7 @@ internal RecognizeLinkedEntitiesResultCollection(IList - /// Gets the version of the text analytics model used by this operation + /// Gets the version of the Text Analytics model used by this operation /// on this batch of documents. /// public string ModelVersion { get; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs index f573e15922ee..b8e7c78bb870 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs @@ -117,7 +117,7 @@ public TextAnalyticsClient(Uri endpoint, AzureKeyCredential credential, TextAnal /// /// The document to analyze. /// Indicates the country of origin of the - /// document to assist the text analytics model in predicting the language + /// document to assist the Text Analytics model in predicting the language /// it is written in. If unspecified, this value will be set to the /// default country hint in /// in the request sent to the service. @@ -176,7 +176,7 @@ public virtual async Task> DetectLanguageAsync(string /// /// The document to analyze. /// Indicates the country of origin of the - /// document to assist the text analytics model in predicting the language + /// document to assist the Text Analytics model in predicting the language /// it is written in. If unspecified, this value will be set to the /// default country hint in /// in the request sent to the service. @@ -235,7 +235,7 @@ public virtual Response DetectLanguage(string document, string /// /// A collection of documents to analyze. /// Indicates the country of origin of all of - /// the documents to assist the text analytics model in predicting + /// the documents 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 /// in the request sent to the service. @@ -269,7 +269,7 @@ public virtual async Task> DetectLangua /// /// A collection of documents to analyze. /// Indicates the country of origin of all of - /// the documents to assist the text analytics model in predicting + /// the documents 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 /// in the request sent to the service. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsInput.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsInput.cs index 8df5d32a03bf..598b33c99277 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsInput.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsInput.cs @@ -5,7 +5,7 @@ namespace Azure.AI.TextAnalytics { /// /// An input representing an individual text document to - /// be analyzed by the text analytics predictive model for a given operation. + /// be analyzed by the Text Analytics predictive model for a given operation. /// public class TextAnalyticsInput { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsResult.cs index f6cbb31e61c6..9e5d1f2eb37d 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsResult.cs @@ -4,7 +4,7 @@ namespace Azure.AI.TextAnalytics { /// - /// Base type for results of text analytics operations corresponding to a + /// Base type for results of Text Analytics operations corresponding to a /// document. If the operation is unsuccessful, the Id and /// Error properties will be populated, but not others. /// diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextDocumentInput.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextDocumentInput.cs index 25104371cec8..6e855d7a4c92 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextDocumentInput.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextDocumentInput.cs @@ -5,7 +5,7 @@ namespace Azure.AI.TextAnalytics { /// /// An input representing an individual text document to - /// be analyzed by the text analytics predictive model for a given operation. + /// be analyzed by the Text Analytics predictive model for a given operation. /// The document contains the document's id, the full text of the document, /// and the language that the document is written in. ///