[TSI] Add Model Settings sample (Azure#20612)

Author: Basel Rustum

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/TimeSeriesInsightsClientSample/ModelSettingsSamples.cs

@@ -0,0 +1,79 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Threading.Tasks;
+using static Azure.IoT.TimeSeriesInsights.Samples.SampleLogger;
+
+namespace Azure.IoT.TimeSeriesInsights.Samples
+{
+    internal class ModelSettingsSamples
+    {
+        /// <summary>
+        /// This sample demonstrates getting Time Series model settings, updating model settings and changing the default type Id for a model.
+        /// </summary>
+        public async Task RunSamplesAsync(TimeSeriesInsightsClient client)
+        {
+            PrintHeader("TIME SERIES INSIGHTS MODEL SETTINGS SAMPLE");
+
+            #region Snippet:TimeSeriesInsightsSampleGetModelSettings
+            Response<TimeSeriesModelSettings> getModelSettingsResponse = await client.ModelSettings.GetAsync();
+            Console.WriteLine($"Retrieved Time Series Insights model settings:\n{JsonSerializer.Serialize(getModelSettingsResponse.Value)}");
+            #endregion Snippet:TimeSeriesInsightsSampleGetModelSettings
+
+            // Store the default type Id so it can be used during clean up
+            string defaultTypeId = getModelSettingsResponse.Value.DefaultTypeId;
+
+            #region Snippet:TimeSeriesInsightsSampleUpdateModelSettingsName
+            Response<TimeSeriesModelSettings> updateModelSettingsNameResponse = await client.ModelSettings.UpdateNameAsync("NewModelSettingsName");
+            Console.WriteLine($"Updated Time Series Insights model settings name:\n" +
+                $"{JsonSerializer.Serialize(updateModelSettingsNameResponse.Value)}");
+            #endregion Snippet:TimeSeriesInsightsSampleUpdateModelSettingsName
+
+            // For every Time Series Insights environment, there is a default type that any newly created Time Series instance will be associated with.
+            // You can change the default type for a TSI environment by creating a new type and calling the API to update the default type Id.
+
+            // Create a Time Series type.
+            var aggregateVariable = new AggregateVariable(new TimeSeriesExpression("count()"));
+            var variables = new Dictionary<string, TimeSeriesVariable>
+            {
+                { "aggregateVariableName", aggregateVariable },
+            };
+            var type = new TimeSeriesType("tsiTypeName", variables);
+            var timeSeriesTypes = new List<TimeSeriesType> { type };
+            string tsiTypeId = null;
+            Response<TimeSeriesTypeOperationResult[]> createTsiTypeResponse = await client.Types.CreateOrReplaceAsync(timeSeriesTypes);
+
+            // Ensure no error was reported as part of the response
+            if (createTsiTypeResponse.Value[0].Error == null)
+            {
+                // Store the Time Series type id to use it for updating default type in model settings
+                tsiTypeId = createTsiTypeResponse.Value[0].TimeSeriesType.Id;
+
+                #region Snippet:TimeSeriesInsightsSampleUpdateModelSettingsDefaultType
+                Response<TimeSeriesModelSettings> updateDefaultTypeIdResponse = await client.ModelSettings.UpdateDefaultTypeIdAsync(tsiTypeId);
+                Console.WriteLine($"Updated Time Series Insights model settings default type Id:\n" +
+                    $"{JsonSerializer.Serialize(updateDefaultTypeIdResponse.Value)}");
+                #endregion Snippet:TimeSeriesInsightsSampleUpdateModelSettingsDefaultType
+            }
+            // Clean up
+            try
+            {
+                // Revert back to the original default type Id
+                await client.ModelSettings.UpdateDefaultTypeIdAsync(defaultTypeId);
+
+                // Delete the type created
+                if (tsiTypeId != null)
+                {
+                    await client.Types.DeleteByIdAsync(new List<string> { tsiTypeId });
+                }
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine($"Failed at one of the clean up steps: {ex.Message}");
+            }
+        }
+    }
+}

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/samples/TimeSeriesInsightsClientSample/Program.cs

@@ -41,6 +41,9 @@ public static async Task Main(string[] args)
 
             var tsiInstancesSamples = new InstancesSamples();
             await tsiInstancesSamples.RunSamplesAsync(tsiClient);
+
+            var tsiModelSettingsSamples = new ModelSettingsSamples();
+            await tsiModelSettingsSamples.RunSamplesAsync(tsiClient);
         }
 
         /// <summary>

sdk/timeseriesinsights/Azure.IoT.TimeSeriesInsights/src/ModelSettingsClient.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using System;
@@ -41,6 +41,12 @@ internal ModelSettingsClient(ModelSettingsRestClient modelSettingsRestClient, Cl
         /// The model settings which includes model display name, Time Series Id properties and default type Id with the
         /// http response <see cref="Response{TimeSeriesModelSettings}"/>.
         /// </returns>
+        /// <example>
+        /// <code snippet="Snippet:TimeSeriesInsightsSampleGetModelSettings">
+        /// Response&lt;TimeSeriesModelSettings&gt; getModelSettingsResponse = await client.ModelSettings.GetAsync();
+        /// Console.WriteLine($&quot;Retrieved Time Series Insights model settings:\n{JsonSerializer.Serialize(getModelSettingsResponse.Value)}&quot;);
+        /// </code>
+        /// </example>
         public virtual async Task<Response<TimeSeriesModelSettings>> GetAsync(CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(Get)}");
@@ -65,6 +71,9 @@ public virtual async Task<Response<TimeSeriesModelSettings>> GetAsync(Cancellati
         /// The model settings which includes model display name, Time Series Id properties and default type Id with the
         /// http response <see cref="Response{TimeSeriesModelSettings}"/>.
         /// </returns>
+        /// <seealso cref="GetAsync(CancellationToken)">
+        /// See the asynchronous version of this method for examples.
+        /// </seealso>
         public virtual Response<TimeSeriesModelSettings> Get(CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(Get)}");
@@ -87,6 +96,13 @@ public virtual Response<TimeSeriesModelSettings> Get(CancellationToken cancellat
         /// <param name="name">Model display name which is mutable by the user. Initial value is &quot;DefaultModel&quot;.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The updated model settings with the http response <see cref="Response{TimeSeriesModelSettings}"/>.</returns>
+        /// <example>
+        /// <code snippet="Snippet:TimeSeriesInsightsSampleUpdateModelSettingsName">
+        /// Response&lt;TimeSeriesModelSettings&gt; updateModelSettingsNameResponse = await client.ModelSettings.UpdateNameAsync(&quot;NewModelSettingsName&quot;);
+        /// Console.WriteLine($&quot;Updated Time Series Insights model settings name:\n&quot; +
+        ///     $&quot;{JsonSerializer.Serialize(updateModelSettingsNameResponse.Value)}&quot;);
+        /// </code>
+        /// </example>
         public virtual async Task<Response<TimeSeriesModelSettings>> UpdateNameAsync(string name, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(UpdateName)}");
@@ -110,6 +126,9 @@ public virtual async Task<Response<TimeSeriesModelSettings>> UpdateNameAsync(str
         /// <param name="name">Model display name which is mutable by the user. Initial value is &quot;DefaultModel&quot;.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The updated model settings with the http response <see cref="Response{TimeSeriesModelSettings}"/>.</returns>
+        /// <seealso cref="UpdateNameAsync(string, CancellationToken)">
+        /// See the asynchronous version of this method for examples.
+        /// </seealso>
         public virtual Response<TimeSeriesModelSettings> UpdateName(string name, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(UpdateName)}");
@@ -134,6 +153,13 @@ public virtual Response<TimeSeriesModelSettings> UpdateName(string name, Cancell
         /// <param name="defaultTypeId">Default type Id of the model that new instances will automatically belong to.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The updated model settings with the http response <see cref="Response{TimeSeriesModelSettings}"/>.</returns>
+        /// <example>
+        /// <code snippet="Snippet:TimeSeriesInsightsSampleUpdateModelSettingsDefaultType">
+        /// Response&lt;TimeSeriesModelSettings&gt; updateDefaultTypeIdResponse = await client.ModelSettings.UpdateDefaultTypeIdAsync(tsiTypeId);
+        /// Console.WriteLine($&quot;Updated Time Series Insights model settings default type Id:\n&quot; +
+        ///     $&quot;{JsonSerializer.Serialize(updateDefaultTypeIdResponse.Value)}&quot;);
+        /// </code>
+        /// </example>
         public virtual async Task<Response<TimeSeriesModelSettings>> UpdateDefaultTypeIdAsync(string defaultTypeId, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(UpdateDefaultTypeId)}");
@@ -157,6 +183,9 @@ public virtual async Task<Response<TimeSeriesModelSettings>> UpdateDefaultTypeId
         /// <param name="defaultTypeId">Default type Id of the model that new instances will automatically belong to.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>The updated model settings with the http response <see cref="Response{TimeSeriesModelSettings}"/>.</returns>
+        /// <seealso cref="UpdateDefaultTypeIdAsync(string, CancellationToken)">
+        /// See the asynchronous version of this method for examples.
+        /// </seealso>
         public virtual Response<TimeSeriesModelSettings> UpdateDefaultTypeId(string defaultTypeId, CancellationToken cancellationToken = default)
         {
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TimeSeriesInsightsClient)}.{nameof(UpdateDefaultTypeId)}");