feat(csharp): add transformation helpers for object indexing with a transformation (#5452) (generated) [skip ci]

Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs

@@ -18,7 +18,7 @@ namespace Algolia.Search.Clients;
 /// <summary>
 /// Represents a collection of functions to interact with the API endpoints
 /// </summary>
-public interface IIngestionClient
+public partial interface IIngestionClient
 {
   /// <summary>
   /// Creates a new authentication resource.

clients/algoliasearch-client-csharp/algoliasearch/Clients/SearchClient.cs

@@ -6,6 +6,7 @@
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
+using Algolia.Search.Clients;
 using Algolia.Search.Http;
 using Algolia.Search.Models.Search;
 using Algolia.Search.Transport;
@@ -2568,6 +2569,7 @@ public partial class SearchClient : ISearchClient
 {
   internal HttpTransport _transport;
   private readonly ILogger<SearchClient> _logger;
+  private IIngestionClient _ingestionTransporter;
 
   /// <summary>
   /// Create a new Search client for the given appID and apiKey.
@@ -2640,6 +2642,43 @@ public void SetClientApiKey(string apiKey)
     _transport._algoliaConfig.SetClientApiKey(apiKey);
   }
 
+  /// <summary>
+  /// Sets the region of the transformation pipeline. This is required to be called
+  /// if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+  /// </summary>
+  /// <param name="region">The region ("us" or "eu")</param>
+  /// <param name="factory">Logger factory</param>
+  public void SetTransformationRegion(string region, ILoggerFactory factory = null)
+  {
+    if (string.IsNullOrWhiteSpace(region))
+    {
+      throw new ArgumentException(
+        "`region` must be provided when leveraging the transformation pipeline"
+      );
+    }
+
+    if (
+      string.IsNullOrWhiteSpace(_transport._algoliaConfig.AppId)
+      || string.IsNullOrWhiteSpace(_transport._algoliaConfig.ApiKey)
+    )
+    {
+      throw new ArgumentException("AppId and ApiKey are required for transformation pipeline");
+    }
+
+    _ingestionTransporter = new IngestionClient(
+      new IngestionConfig(_transport._algoliaConfig.AppId, _transport._algoliaConfig.ApiKey, region)
+      {
+        DefaultHeaders = _transport._algoliaConfig.DefaultHeaders,
+        ConnectTimeout = _transport._algoliaConfig.ConnectTimeout,
+        ReadTimeout = _transport._algoliaConfig.ReadTimeout,
+        WriteTimeout = _transport._algoliaConfig.WriteTimeout,
+        Compression = _transport._algoliaConfig.Compression,
+        CustomHosts = _transport._algoliaConfig.CustomHosts,
+      },
+      factory
+    );
+  }
+
   /// <inheritdoc />
   public async Task<AddApiKeyResponse> AddApiKeyAsync(
     ApiKey apiKey,

clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs

@@ -118,7 +118,8 @@ public async Task<List<WatchResponse>> ChunkedPushAsync(
             );
           }
 
-          await RetryHelper.RetryUntil(
+          await RetryHelper
+            .RetryUntil(
               async () =>
               {
                 try

clients/algoliasearch-client-csharp/algoliasearch/Utils/RetryHelper.cs

@@ -27,35 +27,35 @@ public static class RetryHelper
   /// <returns>The result of the function if the validation function returns true</returns>
   /// <exception cref="AlgoliaException">Thrown if the maximum number of retries is reached</exception>
   public static async Task<T> RetryUntil<T>(
-      Func<Task<T>> func,
-      Func<T, bool> validate,
-      int maxRetries = DefaultMaxRetries,
-      Func<int, int> timeout = null,
-      CancellationToken ct = default
-    )
-    {
-      timeout ??= NextDelay;
+    Func<Task<T>> func,
+    Func<T, bool> validate,
+    int maxRetries = DefaultMaxRetries,
+    Func<int, int> timeout = null,
+    CancellationToken ct = default
+  )
+  {
+    timeout ??= NextDelay;
 
-      var retryCount = 0;
-      while (retryCount < maxRetries)
+    var retryCount = 0;
+    while (retryCount < maxRetries)
+    {
+      var resp = await func().ConfigureAwait(false);
+      if (validate(resp))
       {
-        var resp = await func().ConfigureAwait(false);
-        if (validate(resp))
-        {
-          return resp;
-        }
-
-        await Task.Delay(timeout(retryCount), ct).ConfigureAwait(false);
-        retryCount++;
+        return resp;
       }
 
-      throw new AlgoliaException(
-        "The maximum number of retries exceeded. (" + (retryCount + 1) + "/" + maxRetries + ")"
-      );
+      await Task.Delay(timeout(retryCount), ct).ConfigureAwait(false);
+      retryCount++;
     }
 
-    private static int NextDelay(int retryCount)
-    {
-      return Math.Min(retryCount * 200, 5000);
-    }
+    throw new AlgoliaException(
+      "The maximum number of retries exceeded. (" + (retryCount + 1) + "/" + maxRetries + ")"
+    );
+  }
+
+  private static int NextDelay(int retryCount)
+  {
+    return Math.Min(retryCount * 200, 5000);
+  }
 }

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -536,7 +536,8 @@ public async Task<GetTaskResponse> WaitForTaskAsync(
     RequestOptions requestOptions = null,
     CancellationToken ct = default
   ) =>
-    await RetryHelper.RetryUntil(
+    await RetryHelper
+      .RetryUntil(
         async () => await GetTaskAsync(indexName, taskId, requestOptions, ct),
         resp => resp.Status == Models.Search.TaskStatus.Published,
         maxRetries,
@@ -566,7 +567,8 @@ public async Task<GetTaskResponse> WaitForAppTaskAsync(
     RequestOptions requestOptions = null,
     CancellationToken ct = default
   ) =>
-    await RetryHelper.RetryUntil(
+    await RetryHelper
+      .RetryUntil(
         async () => await GetAppTaskAsync(taskId, requestOptions, ct),
         resp => resp.Status == Models.Search.TaskStatus.Published,
         maxRetries,
@@ -603,7 +605,8 @@ public async Task<GetApiKeyResponse> WaitForApiKeyAsync(
         throw new AlgoliaException("`ApiKey` is required when waiting for an `update` operation.");
       }
 
-      return await RetryHelper.RetryUntil(
+      return await RetryHelper
+        .RetryUntil(
           () => GetApiKeyAsync(key, requestOptions, ct),
           resp =>
           {

docs/bundled/ingestion.json

@@ -2728,9 +2728,10 @@
           "Records"
         ],
         "x-available-languages": [
-          "javascript",
+          "csharp",
           "go",
           "java",
+          "javascript",
           "php",
           "python"
         ],

docs/bundled/search-snippets.json

@@ -199,6 +199,9 @@
       "call partialUpdateObjects with createIfNotExists=true": "var response = await client.PartialUpdateObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n    new Dictionary<string, string> { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n  },\n  true\n);",
       "call partialUpdateObjects with createIfNotExists=false": "var response = await client.PartialUpdateObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"3\" }, { \"name\", \"Cyril\" } },\n    new Dictionary<string, string> { { \"objectID\", \"4\" }, { \"name\", \"David\" } },\n  },\n  false\n);"
     },
+    "partialUpdateObjectsWithTransformation": {
+      "default": "var response = await client.PartialUpdateObjectsWithTransformationAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n    new Dictionary<string, string> { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n  },\n  true,\n  true\n);"
+    },
     "removeUserId": {
       "default": "var response = await client.RemoveUserIdAsync(\"uniqueID\");"
     },
@@ -207,6 +210,9 @@
       "call replaceAllObjects with partial scopes": "var response = await client.ReplaceAllObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n    new Dictionary<string, string> { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n  },\n  77,\n  new List<ScopeType> { Enum.Parse<ScopeType>(\"Settings\"), Enum.Parse<ScopeType>(\"Synonyms\") }\n);",
       "replaceAllObjects should cleanup on failure": "var response = await client.ReplaceAllObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"fine\" }, { \"body\", \"small obj\" } },\n    new Dictionary<string, string>\n    {\n      { \"objectID\", \"toolarge\" },\n      { \"body\", \"something bigger than 10KB\" },\n    },\n  }\n);"
     },
+    "replaceAllObjectsWithTransformation": {
+      "default": "var response = await client.ReplaceAllObjectsWithTransformationAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n    new Dictionary<string, string> { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n    new Dictionary<string, string> { { \"objectID\", \"3\" }, { \"name\", \"Cyril\" } },\n    new Dictionary<string, string> { { \"objectID\", \"4\" }, { \"name\", \"David\" } },\n    new Dictionary<string, string> { { \"objectID\", \"5\" }, { \"name\", \"Eva\" } },\n    new Dictionary<string, string> { { \"objectID\", \"6\" }, { \"name\", \"Fiona\" } },\n    new Dictionary<string, string> { { \"objectID\", \"7\" }, { \"name\", \"Gael\" } },\n    new Dictionary<string, string> { { \"objectID\", \"8\" }, { \"name\", \"Hugo\" } },\n    new Dictionary<string, string> { { \"objectID\", \"9\" }, { \"name\", \"Igor\" } },\n    new Dictionary<string, string> { { \"objectID\", \"10\" }, { \"name\", \"Julia\" } },\n  },\n  3\n);"
+    },
     "replaceSources": {
       "default": "var response = await client.ReplaceSourcesAsync(\n  new List<Source>\n  {\n    new Source { VarSource = \"theSource\", Description = \"theDescription\" },\n  }\n);"
     },
@@ -222,6 +228,9 @@
       "saveObjectsPlaylist": "var response = await client.SaveObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string>\n    {\n      { \"objectID\", \"1\" },\n      { \"visibility\", \"public\" },\n      { \"name\", \"Hot 100 Billboard Charts\" },\n      { \"playlistId\", \"d3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f\" },\n      { \"createdAt\", \"1500240452\" },\n    },\n  }\n);",
       "saveObjectsPublicUser": "var response = await client.SaveObjectsAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string>\n    {\n      { \"objectID\", \"1\" },\n      { \"visibility\", \"public\" },\n      { \"name\", \"Hot 100 Billboard Charts\" },\n      { \"playlistId\", \"d3e8e8f3-0a4f-4b7d-9b6b-7e8f4e8e3a0f\" },\n      { \"createdAt\", \"1500240452\" },\n    },\n  },\n  false,\n  1000,\n  new RequestOptionBuilder().AddExtraHeader(\"X-Algolia-User-ID\", \"*\").Build()\n);"
     },
+    "saveObjectsWithTransformation": {
+      "default": "var response = await client.SaveObjectsWithTransformationAsync(\n  \"<YOUR_INDEX_NAME>\",\n  new List<Object>\n  {\n    new Dictionary<string, string> { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n    new Dictionary<string, string> { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n  },\n  true\n);"
+    },
     "saveRule": {
       "saveRule with minimal parameters": "var response = await client.SaveRuleAsync(\n  \"<YOUR_INDEX_NAME>\",\n  \"id1\",\n  new Rule\n  {\n    ObjectID = \"id1\",\n    Conditions = new List<Condition>\n    {\n      new Condition { Pattern = \"apple\", Anchoring = Enum.Parse<Anchoring>(\"Contains\") },\n    },\n    Consequence = new Consequence\n    {\n      Params = new ConsequenceParams { Filters = \"brand:xiaomi\" },\n    },\n  }\n);",
       "saveRule with all parameters": "var response = await client.SaveRuleAsync(\n  \"<YOUR_INDEX_NAME>\",\n  \"id1\",\n  new Rule\n  {\n    ObjectID = \"id1\",\n    Conditions = new List<Condition>\n    {\n      new Condition\n      {\n        Pattern = \"apple\",\n        Anchoring = Enum.Parse<Anchoring>(\"Contains\"),\n        Alternatives = false,\n        Context = \"search\",\n      },\n    },\n    Consequence = new Consequence\n    {\n      Params = new ConsequenceParams\n      {\n        Filters = \"brand:apple\",\n        Query = new ConsequenceQuery(\n          new ConsequenceQueryObject\n          {\n            Remove = new List<string> { \"algolia\" },\n            Edits = new List<Edit>\n            {\n              new Edit\n              {\n                Type = Enum.Parse<EditType>(\"Remove\"),\n                Delete = \"abc\",\n                Insert = \"cde\",\n              },\n              new Edit\n              {\n                Type = Enum.Parse<EditType>(\"Replace\"),\n                Delete = \"abc\",\n                Insert = \"cde\",\n              },\n            },\n          }\n        ),\n      },\n      Hide = new List<ConsequenceHide> { new ConsequenceHide { ObjectID = \"321\" } },\n      FilterPromotes = false,\n      UserData = new Dictionary<string, string> { { \"algolia\", \"aloglia\" } },\n      Promote = new List<Promote>\n      {\n        new Promote(new PromoteObjectID { ObjectID = \"abc\", Position = 3 }),\n        new Promote(\n          new PromoteObjectIDs\n          {\n            ObjectIDs = new List<string> { \"abc\", \"def\" },\n            Position = 1,\n          }\n        ),\n      },\n    },\n    Description = \"test\",\n    Enabled = true,\n    Validity = new List<TimeRange>\n    {\n      new TimeRange { From = 1656670273L, Until = 1656670277L },\n    },\n  },\n  true\n);",

docs/bundled/search.json

@@ -4253,9 +4253,10 @@
           "Records"
         ],
         "x-available-languages": [
-          "javascript",
+          "csharp",
           "go",
           "java",
+          "javascript",
           "php",
           "python"
         ],
@@ -4499,16 +4500,17 @@
     "/saveObjectsWithTransformation": {
       "get": {
         "x-helper": true,
+        "tags": [
+          "Records"
+        ],
         "x-available-languages": [
+          "csharp",
           "go",
           "java",
           "javascript",
           "php",
           "python"
         ],
-        "tags": [
-          "Records"
-        ],
         "operationId": "saveObjectsWithTransformation",
         "summary": "Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push)",
         "description": "Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.\n",
@@ -4782,6 +4784,7 @@
       "post": {
         "x-helper": true,
         "x-available-languages": [
+          "csharp",
           "go",
           "java",
           "javascript",

docs/snippets/csharp/src/Search.cs

@@ -2394,6 +2394,34 @@ public async Task SnippetForSearchClientPartialUpdateObjects1()
     // SEPARATOR<
   }
 
+  /// <summary>
+  /// Snippet for the PartialUpdateObjectsWithTransformation method.
+  ///
+  /// call partialUpdateObjectsWithTransformation with createIfNotExists=true
+  /// </summary>
+  public async Task SnippetForSearchClientPartialUpdateObjectsWithTransformation()
+  {
+    // >SEPARATOR partialUpdateObjectsWithTransformation default
+    // Initialize the client
+    var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
+
+    // Call the API
+    var response = await client.PartialUpdateObjectsWithTransformationAsync(
+      "<YOUR_INDEX_NAME>",
+      new List<Object>
+      {
+        new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
+        new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
+      },
+      true,
+      true
+    );
+    // >LOG
+    // print the response
+    Console.WriteLine(response);
+    // SEPARATOR<
+  }
+
   /// <summary>
   /// Snippet for the RemoveUserId method.
   ///
@@ -2506,6 +2534,41 @@ public async Task SnippetForSearchClientReplaceAllObjects2()
     // SEPARATOR<
   }
 
+  /// <summary>
+  /// Snippet for the ReplaceAllObjectsWithTransformation method.
+  ///
+  /// call replaceAllObjectsWithTransformation without error
+  /// </summary>
+  public async Task SnippetForSearchClientReplaceAllObjectsWithTransformation()
+  {
+    // >SEPARATOR replaceAllObjectsWithTransformation default
+    // Initialize the client
+    var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
+
+    // Call the API
+    var response = await client.ReplaceAllObjectsWithTransformationAsync(
+      "<YOUR_INDEX_NAME>",
+      new List<Object>
+      {
+        new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
+        new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
+        new Dictionary<string, string> { { "objectID", "3" }, { "name", "Cyril" } },
+        new Dictionary<string, string> { { "objectID", "4" }, { "name", "David" } },
+        new Dictionary<string, string> { { "objectID", "5" }, { "name", "Eva" } },
+        new Dictionary<string, string> { { "objectID", "6" }, { "name", "Fiona" } },
+        new Dictionary<string, string> { { "objectID", "7" }, { "name", "Gael" } },
+        new Dictionary<string, string> { { "objectID", "8" }, { "name", "Hugo" } },
+        new Dictionary<string, string> { { "objectID", "9" }, { "name", "Igor" } },
+        new Dictionary<string, string> { { "objectID", "10" }, { "name", "Julia" } },
+      },
+      3
+    );
+    // >LOG
+    // print the response
+    Console.WriteLine(response);
+    // SEPARATOR<
+  }
+
   /// <summary>
   /// Snippet for the ReplaceSources method.
   ///
@@ -2696,6 +2759,33 @@ public async Task SnippetForSearchClientSaveObjects3()
     // SEPARATOR<
   }
 
+  /// <summary>
+  /// Snippet for the SaveObjectsWithTransformation method.
+  ///
+  /// call saveObjectsWithTransformation without error
+  /// </summary>
+  public async Task SnippetForSearchClientSaveObjectsWithTransformation()
+  {
+    // >SEPARATOR saveObjectsWithTransformation default
+    // Initialize the client
+    var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));
+
+    // Call the API
+    var response = await client.SaveObjectsWithTransformationAsync(
+      "<YOUR_INDEX_NAME>",
+      new List<Object>
+      {
+        new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
+        new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
+      },
+      true
+    );
+    // >LOG
+    // print the response
+    Console.WriteLine(response);
+    // SEPARATOR<
+  }
+
   /// <summary>
   /// Snippet for the SaveRule method.
   ///

specs/bundled/ingestion.yml

@@ -1860,9 +1860,10 @@ paths:
       tags:
         - ingestion
       x-available-languages:
-        - javascript
+        - csharp
         - go
         - java
+        - javascript
         - php
         - python
       operationId: chunkedPush