update

Author: Bidisha Chakraborty

sdk/cognitivelanguage/Azure.AI.Language.Documents/CHANGELOG.md

@@ -1,24 +1,9 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
-
-### Features Added
-
-- Exposed `JsonModelWriteCore` for model serialization procedure.
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
-## 1.0.0-beta.1 (2024-08-06)
+## 1.0.0-beta.1 (Unreleased)
 
 - Initial release
 
 ### Features Added
-
-- Added support for analyze-text API Versions
-  - 2022-05-01
-  - 2023-04-01
-  - 2023-11-15-preview
+- Added support for analyze-documents API Versions
+  - 2024-11-15-preview

sdk/cognitivelanguage/Azure.AI.Language.Documents/README.md

@@ -3,30 +3,31 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Azure.Core;
-using System.Threading;
 using System.Threading.Tasks;
+using System.Threading;
+using Azure.Core;
 using Azure.Core.Pipeline;
+using System.Linq;
 
 namespace Azure.AI.Language.Documents
 {
-    /// <summary> The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms.  The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in &lt;a href=\"https://docs.microsoft.com/azure/cognitive-services/language-service/overview\"&gt;https://docs.microsoft.com/azure/cognitive-services/language-service/overview&lt;/a&gt;.0. </summary>
-    public partial class AnalyzeDocumentsClient
+    [CodeGenModel("AnalyzeDocumentsClient")]
+
+    public partial class DocumentAnalysisClient
     {
-        /// <summary> Initializes a new instance of TextAnalysisClient. </summary>
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DocumentAnalysisClient"/> class.
+        /// </summary>
         /// <param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://&lt;resource-name&gt;.cognitiveservices.azure.com). </param>
         /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
         /// <param name="options"> The options for configuring the client. </param>
-        /// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
-        public AnalyzeDocumentsClient(Uri endpoint, TokenCredential credential, AnalyzeDocumentsClientOptions options)
+        public DocumentAnalysisClient(Uri endpoint, TokenCredential credential, DocumentAnalysisClientOptions options = default)
         {
             Argument.AssertNotNull(endpoint, nameof(endpoint));
             Argument.AssertNotNull(credential, nameof(credential));
-            options ??= new AnalyzeDocumentsClientOptions();
+            options ??= new DocumentAnalysisClientOptions();
 
-            var authorizationScope = $"{(string.IsNullOrEmpty(options.Audience?.ToString()) ? TextAudience.AzurePublicCloud : options.Audience)}/.default";
+            var authorizationScope = $"{(string.IsNullOrEmpty(options.Audience?.ToString()) ? DocumentsAudience.AzurePublicCloud : options.Audience)}/.default";
 
             _tokenCredential = credential;
 
@@ -37,30 +38,30 @@ public AnalyzeDocumentsClient(Uri endpoint, TokenCredential credential, AnalyzeD
         }
 
         /// <summary> Submit a collection of text documents for analysis and get the results. Specify one or more unique tasks to be executed as a long-running operation. </summary>
-        /// <param name="textInput"> Contains the input to be analyzed. </param>
+        /// <param name="documentsInput"> Contains the documents to be analyzed. </param>
         /// <param name="actions"> List of tasks to be performed as part of the LRO. </param>
         /// <param name="displayName"> Name for the task. </param>
         /// <param name="defaultLanguage"> Default language to use for records requesting automatic language detection. </param>
         /// <param name="cancellationToken"> The cancellation token to use. </param>
-        /// <exception cref="ArgumentNullException"> <paramref name="textInput"/> or <paramref name="actions"/> is null. </exception>
-        public virtual Response<AnalyzeTextOperationState> AnalyzeTextOperation(MultiLanguageTextInput textInput, IEnumerable<AnalyzeTextOperationAction> actions, string displayName = null, string defaultLanguage = null, CancellationToken cancellationToken = default)
+        /// <exception cref="ArgumentNullException"> <paramref name="documentsInput"/> or <paramref name="actions"/> is null. </exception>
+        public virtual Response<AnalyzeDocumentsOperationState> AnalyzeDocumentsOperation(MultiLanguageDocumentInput documentsInput, IEnumerable<AnalyzeDocumentsOperationAction> actions, string displayName = null, string defaultLanguage = null, CancellationToken cancellationToken = default)
         {
-            Argument.AssertNotNull(textInput, nameof(textInput));
+            Argument.AssertNotNull(documentsInput, nameof(documentsInput));
             Argument.AssertNotNull(actions, nameof(actions));
 
-            string scopeName = $"{nameof(AnalyzeDocumentsClient)}.{nameof(AnalyzeTextOperation)}";
+            string scopeName = $"{nameof(DocumentAnalysisClient)}.{nameof(AnalyzeDocumentsOperation)}";
             using var scope = ClientDiagnostics.CreateScope(scopeName);
             scope.Start();
 
-            AnalyzeTextSubmitJobRequest analyzeTextOperationInput = new AnalyzeTextSubmitJobRequest(displayName, textInput, actions.ToList(), defaultLanguage, null);
+            var analyzeDocumentsInput = new AnalyzeDocumentsOperationInput(displayName, documentsInput, actions.ToList(), defaultLanguage, null);
             RequestContext context = FromCancellationToken(cancellationToken);
 
             try
             {
-                using HttpMessage message = CreateAnalyzeTextSubmitOperationRequest(analyzeTextOperationInput.ToRequestContent(), context);
+                using HttpMessage message = CreateAnalyzeDocumentsSubmitOperationRequest(analyzeDocumentsInput.ToRequestContent(), context);
                 var operation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, scopeName, OperationFinalStateVia.OperationLocation, context, WaitUntil.Completed);
                 Response response = operation.GetRawResponse();
-                return Response.FromValue(AnalyzeTextOperationState.FromResponse(response), response);
+                return Response.FromValue(AnalyzeDocumentsOperationState.FromResponse(response), response);
             }
             catch (Exception e)
             {
@@ -69,31 +70,31 @@ public virtual Response<AnalyzeTextOperationState> AnalyzeTextOperation(MultiLan
             }
         }
 
-        /// <summary> Submit a collection of text documents for analysis and get the results. Specify one or more unique tasks to be executed as a long-running operation. </summary>
-        /// <param name="textInput"> Contains the input to be analyzed. </param>
+        /// <summary> Submit a collection of documents for analysis and get the results. Specify one or more unique tasks to be executed as a long-running operation. </summary>
+        /// <param name="documentsInput"> Contains the input to be analyzed. </param>
         /// <param name="actions"> List of tasks to be performed as part of the LRO. </param>
         /// <param name="displayName"> Name for the task. </param>
         /// <param name="defaultLanguage"> Default language to use for records requesting automatic language detection. </param>
         /// <param name="cancellationToken"> The cancellation token to use. </param>
-        /// <exception cref="ArgumentNullException"> <paramref name="textInput"/> or <paramref name="actions"/> is null. </exception>
-        public virtual async Task<Response<AnalyzeTextOperationState>> AnalyzeTextOperationAsync(MultiLanguageTextInput textInput, IEnumerable<AnalyzeTextOperationAction> actions, string displayName = null, string defaultLanguage = null, CancellationToken cancellationToken = default)
+        /// <exception cref="ArgumentNullException"> <paramref name="documentsInput"/> or <paramref name="actions"/> is null. </exception>
+        public virtual async Task<Response<AnalyzeDocumentsOperationState>> AnalyzeDocumentsOperationAsync(MultiLanguageDocumentInput documentsInput, IEnumerable<AnalyzeDocumentsOperationAction> actions, string displayName = null, string defaultLanguage = null, CancellationToken cancellationToken = default)
         {
-            Argument.AssertNotNull(textInput, nameof(textInput));
+            Argument.AssertNotNull(documentsInput, nameof(documentsInput));
             Argument.AssertNotNull(actions, nameof(actions));
 
-            string scopeName = $"{nameof(AnalyzeDocumentsClient)}.{nameof(AnalyzeTextOperation)}";
+            string scopeName = $"{nameof(DocumentAnalysisClient)}.{nameof(AnalyzeDocumentsOperation)}";
             using var scope = ClientDiagnostics.CreateScope(scopeName);
             scope.Start();
 
-            AnalyzeTextSubmitJobRequest analyzeTextOperationInput = new AnalyzeTextSubmitJobRequest(displayName, textInput, actions.ToList(), defaultLanguage, null);
+            var analyzeDocumentsInput = new AnalyzeDocumentsOperationInput(displayName, documentsInput, actions.ToList(), defaultLanguage, null);
             RequestContext context = FromCancellationToken(cancellationToken);
 
             try
             {
-                using HttpMessage message = CreateAnalyzeTextSubmitOperationRequest(analyzeTextOperationInput.ToRequestContent(), context);
+                using HttpMessage message = CreateAnalyzeDocumentsSubmitOperationRequest(analyzeDocumentsInput.ToRequestContent(), context);
                 var operation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, scopeName, OperationFinalStateVia.OperationLocation, context, WaitUntil.Completed).ConfigureAwait(false);
                 Response response = operation.GetRawResponse();
-                return Response.FromValue(AnalyzeTextOperationState.FromResponse(response), response);
+                return Response.FromValue(AnalyzeDocumentsOperationState.FromResponse(response), response);
             }
             catch (Exception e)
             {

sdk/cognitivelanguage/Azure.AI.Language.Documents/api/Azure.AI.Language.Documents.net8.0.cs

@@ -6,7 +6,7 @@
 namespace Azure.AI.Language.Documents
 {
     [CodeGenModel("AILanguageDocumentsClientBuilderExtensions")]
-    public static partial class LanguageDocumentsClientBuilderExtensions
+    public static partial class DocumentAnalysisClientBuilderExtensions
     {
     }
 }

sdk/cognitivelanguage/Azure.AI.Language.Documents/api/Azure.AI.Language.Documents.netstandard2.0.cs

@@ -13,7 +13,7 @@ public partial class DocumentAnalysisClientOptions : ClientOptions
         /// <summary>
         /// Gets or sets the audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
         /// </summary>
-        /// <value>If <c>null</c>, <see cref="TextAudience.AzurePublicCloud" /> will be assumed.</value>
-        internal TextAudience? Audience { get; set; }
+        /// <value>If <c>null</c>, <see cref="DocumentsAudience.AzurePublicCloud" /> will be assumed.</value>
+        internal DocumentsAudience? Audience { get; set; }
     }
 }

sdk/cognitivelanguage/Azure.AI.Language.Documents/src/AnalyzeDocumentsClient.cs renamed to sdk/cognitivelanguage/Azure.AI.Language.Documents/src/DocumentAnalysisClient.cs

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core;
+
+namespace Azure.AI.Language.Documents
+{
+    [CodeGenModel("AILanguageDocumentsModelFactory")]
+    public partial class DocumentAnalysisModelFactory
+    {
+    }
+}

sdk/cognitivelanguage/Azure.AI.Language.Documents/src/AILanguageDocumentsClientBuilderExtensions.cs renamed to sdk/cognitivelanguage/Azure.AI.Language.Documents/src/DocumentAnalysisClientBuilderExtensions.cs

@@ -4,20 +4,20 @@
 using System;
 using System.ComponentModel;
 
-namespace Azure.AI.Language.Text
+namespace Azure.AI.Language.Documents
 {
     /// <summary> Cloud audiences available for Text. </summary>
-    internal readonly partial struct TextAudience : IEquatable<TextAudience>
+    internal readonly partial struct DocumentsAudience : IEquatable<DocumentsAudience>
     {
         private readonly string _value;
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="TextAudience"/> object.
+        /// Initializes a new instance of the <see cref="DocumentsAudience"/> object.
         /// </summary>
         /// <param name="value">The Azure Active Directory audience to use when forming authorization scopes.For the Language service, this value corresponds to a URL that identifies the Azure cloud where the resource is located. For more information: <see href="https://learn.microsoft.com/azure/azure-government/documentation-government-cognitiveservices" />.</param>
         /// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
         /// <remarks>Please use one of the constant members over creating a custom value unless you have special needs for doing so.</remarks>
-        public TextAudience(string value)
+        public DocumentsAudience(string value)
         {
             Argument.AssertNotNullOrEmpty(value, nameof(value));
             _value = value;
@@ -28,26 +28,26 @@ public TextAudience(string value)
         private const string AzurePublicCloudValue = "https://cognitiveservices.azure.com";
 
         /// <summary> Azure China. </summary>
-        public static TextAudience AzureChina { get; } = new TextAudience(AzureChinaValue);
+        public static DocumentsAudience AzureChina { get; } = new DocumentsAudience(AzureChinaValue);
 
         /// <summary> Azure Government. </summary>
-        public static TextAudience AzureGovernment { get; } = new TextAudience(AzureGovernmentValue);
+        public static DocumentsAudience AzureGovernment { get; } = new DocumentsAudience(AzureGovernmentValue);
 
         /// <summary> Azure Public Cloud. </summary>
-        public static TextAudience AzurePublicCloud { get; } = new TextAudience(AzurePublicCloudValue);
+        public static DocumentsAudience AzurePublicCloud { get; } = new DocumentsAudience(AzurePublicCloudValue);
 
-        /// <summary> Determines if two <see cref="TextAudience"/> values are the same. </summary>
-        public static bool operator ==(TextAudience left, TextAudience right) => left.Equals(right);
-        /// <summary> Determines if two <see cref="TextAudience"/> values are not the same. </summary>
-        public static bool operator !=(TextAudience left, TextAudience right) => !left.Equals(right);
-        /// <summary> Converts a string to a <see cref="TextAudience"/>. </summary>
-        public static implicit operator TextAudience(string value) => new TextAudience(value);
+        /// <summary> Determines if two <see cref="DocumentsAudience"/> values are the same. </summary>
+        public static bool operator ==(DocumentsAudience left, DocumentsAudience right) => left.Equals(right);
+        /// <summary> Determines if two <see cref="DocumentsAudience"/> values are not the same. </summary>
+        public static bool operator !=(DocumentsAudience left, DocumentsAudience right) => !left.Equals(right);
+        /// <summary> Converts a string to a <see cref="DocumentsAudience"/>. </summary>
+        public static implicit operator DocumentsAudience(string value) => new DocumentsAudience(value);
 
         /// <inheritdoc />
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public override bool Equals(object obj) => obj is TextAudience other && Equals(other);
+        public override bool Equals(object obj) => obj is DocumentsAudience other && Equals(other);
         /// <inheritdoc />
-        public bool Equals(TextAudience other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
+        public bool Equals(DocumentsAudience other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
 
         /// <inheritdoc />
         [EditorBrowsable(EditorBrowsableState.Never)]