guides: add pushSetup for ingestion API (#4126) (generated) [skip ci]

algolia-bot · shortcuts · millotp · algolia-bot · commit bc84ea9fd0ca · 2024-11-19T13:20:11.000Z
Co-authored-by: Clément Vannicatte &lt;vannicattec@gmail.com&gt;
Co-authored-by: Pierre Millot &lt;pierre.millot@algolia.com&gt;
diff --git a/docs/guides/csharp/.config/dotnet-tools.json b/docs/guides/csharp/.config/dotnet-tools.json
@@ -3,10 +3,10 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "0.29.2",
+      "version": "0.30.1",
       "commands": [
         "dotnet-csharpier"
       ]
     }
   }
-}
+}
diff --git a/docs/guides/csharp/src/pushSetup.cs b/docs/guides/csharp/src/pushSetup.cs
@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using Algolia.Search.Clients;
+using Algolia.Search.Models.Ingestion;
+using static Algolia.Search.Models.Ingestion.PushTaskRecords;
+using Action = Algolia.Search.Models.Ingestion.Action;
+
+class PushSetup
+{
+  public static async Task Main(string[] args)
+  {
+    string jsonContent = File.ReadAllText("/my-raw-records.json");
+
+    var records = JsonSerializer.Deserialize<List<PushTaskRecords>>(jsonContent);
+
+    // use the region matching your applicationID
+    var client = new IngestionClient(
+      new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
+    );
+
+    try
+    {
+      var run = await client.PushTaskAsync(
+        "YOUR_TASK_ID",
+        new PushTaskPayload { Action = Enum.Parse<Action>("AddObject"), Records = records }
+      );
+      Console.WriteLine(run.RunID);
+    }
+    catch (Exception e)
+    {
+      Console.WriteLine(e.Message);
+    }
+  }
+}
diff --git a/docs/guides/csharp/src/saveObjectsMovies.cs b/docs/guides/csharp/src/saveObjectsMovies.cs
@@ -1,12 +1,11 @@
 using System;
-using System.Text.Json;
-using System.Net.Http;
 using System.Collections.Generic;
-
+using System.Net.Http;
+using System.Text.Json;
 using Algolia.Search.Clients;
 using Algolia.Search.Models.Search;
 
-class Program
+class SaveObjectsMovies
 {
   public static async Task Main(string[] args)
   {
@@ -25,9 +24,7 @@ public static async Task Main(string[] args)
     // push data to algolia
     try
     {
-      var result = await client.SaveObjectsAsync("<YOUR_INDEX_NAME>"
-, movies
-);
+      var result = await client.SaveObjectsAsync("<YOUR_INDEX_NAME>", movies);
     }
     catch (Exception e)
     {
diff --git a/docs/guides/csharp/src/src.csproj b/docs/guides/csharp/src/src.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <RootNamespace>Algolia</RootNamespace>
diff --git a/docs/guides/go/.golangci.yml b/docs/guides/go/.golangci.yml
@@ -2,10 +2,11 @@ linters:
   disable:
     - ineffassign
     - staticcheck
+    - unused
 
 issues:
   exclude-generated: disable
 
 run:
   concurrency: 2
-  timeout: 10m
+  timeout: 10m
diff --git a/docs/guides/go/src/pushSetup.go b/docs/guides/go/src/pushSetup.go
@@ -0,0 +1,41 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/algolia/algoliasearch-client-go/v4/algolia/ingestion"
+)
+
+func push() {
+	// use the region matching your applicationID
+	client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
+	if err != nil {
+		// The client can fail to initialize if you pass an invalid parameter.
+		panic(err)
+	}
+
+	content, err := os.ReadFile("/my-raw-records.json")
+	if err != nil {
+		panic(err)
+	}
+
+	var records []ingestion.PushTaskRecords
+
+	err = json.Unmarshal(content, &records)
+	if err != nil {
+		panic(err)
+	}
+
+	run, err := client.PushTask(client.NewApiPushTaskRequest(
+		"YOUR_TASK_ID",
+		ingestion.NewEmptyPushTaskPayload().SetAction(ingestion.Action("addObject")).SetRecords(records),
+	))
+	if err != nil {
+		panic(err)
+	}
+
+	// use runID in the Observability debugger
+	fmt.Println("run", run.RunID)
+}
diff --git a/docs/guides/go/src/saveObjectsMovies.go b/docs/guides/go/src/saveObjectsMovies.go
@@ -8,7 +8,7 @@ import (
 	"github.com/algolia/algoliasearch-client-go/v4/algolia/search"
 )
 
-func main() {
+func saveObjectsMovies() {
 	// read json file
 	url := "https://dashboard.algolia.com/sample_datasets/movie.json"
 	response, err := http.Get(url)
diff --git a/docs/guides/java/src/test/java/com/algolia/pushSetup.java b/docs/guides/java/src/test/java/com/algolia/pushSetup.java
@@ -0,0 +1,24 @@
+import com.algolia.api.IngestionClient;
+import com.algolia.model.ingestion.*;
+import com.fasterxml.jackson.databind.*;
+import java.io.File;
+import java.util.List;
+import java.util.Map;
+
+public class pushSetup {
+
+  public static void main(String[] args) throws Exception {
+    JsonNode content = new ObjectMapper().readTree(new File("/my-raw-records.json"));
+    List<PushTaskRecords> records = new ObjectMapper().readerForListOf(Map.class).readValue(content);
+
+    // use the region matching your applicationID
+    IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
+
+    RunResponse run = client.pushTask("YOUR_TASK_ID", new PushTaskPayload().setAction(Action.ADD_OBJECT).setRecords(records));
+
+    // use runID in the Observability debugger
+    System.out.println(run.getRunID());
+
+    client.close();
+  }
+}
diff --git a/docs/guides/javascript/package.json b/docs/guides/javascript/package.json
@@ -1,6 +1,7 @@
 {
   "name": "javascript-guides",
   "version": "1.0.0",
+  "type": "module",
   "dependencies": {
     "@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",
     "@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http",
diff --git a/docs/guides/javascript/src/pushSetup.ts b/docs/guides/javascript/src/pushSetup.ts
@@ -0,0 +1,23 @@
+import type { PushTaskRecords } from 'algoliasearch';
+import fs from 'node:fs';
+
+import { algoliasearch } from 'algoliasearch';
+
+// use the region matching your applicationID
+const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });
+
+try {
+  // read local JSON file containing array of records
+  const records = JSON.parse(fs.readFileSync('/my-raw-records.json', 'utf8')) as PushTaskRecords[];
+
+  // push records to the API
+  const run = await client.pushTask({
+    taskID: 'YOUR_TASK_ID',
+    pushTaskPayload: { action: 'addObject', records: records },
+  });
+
+  // use runID in the Observability debugger
+  console.log(run.runID);
+} catch (err) {
+  console.error(err);
+}
diff --git a/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/pushSetup.kt b/docs/guides/kotlin/src/main/kotlin/com/algolia/snippets/pushSetup.kt
@@ -0,0 +1,31 @@
+package org.example
+import com.algolia.client.api.IngestionClient
+
+import com.algolia.client.model.ingestion.*
+
+import kotlinx.serialization.builtins.ListSerializer
+import kotlinx.serialization.json.Json
+import java.io.File
+
+suspend fun main() {
+  val json = File("/my-raw-records.json").readText()
+  val records: List<PushTaskRecords> = Json.decodeFromString(ListSerializer(PushTaskRecords.serializer()), json)
+
+  // use the region matching your applicationID
+  val client = IngestionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION")
+
+  try {
+    val run = client.pushTask(
+      taskID = "YOUR_TASK_ID",
+      pushTaskPayload = PushTaskPayload(
+        action = Action.entries.first { it.value == "addObject" },
+        records = records,
+      ),
+    )
+
+    // use runID in the Observability debugger
+    println(run)
+  } catch (e: Exception) {
+    println(e.message)
+  }
+}
diff --git a/docs/guides/php/src/pushSetup.php b/docs/guides/php/src/pushSetup.php
@@ -0,0 +1,19 @@
+<?php
+
+require __DIR__.'/vendor/autoload.php';
+use Algolia\AlgoliaSearch\Api\IngestionClient;
+
+$records = json_decode(file_get_contents('/my-raw-records.json'), true);
+
+// use the region matching your applicationID
+$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
+
+$run = $client->pushTask(
+    'YOUR_TASK_ID',
+    ['action' => 'addObject',
+        'records' => records,
+    ],
+);
+
+// use runID in the Observability debugger
+echo $run;
diff --git a/docs/guides/python/pushSetup.py b/docs/guides/python/pushSetup.py
@@ -0,0 +1,27 @@
+import asyncio
+import json
+from algoliasearch.ingestion.client import IngestionClientSync
+
+
+async def main():
+    # use the region matching your applicationID
+    _client = IngestionClientSync(
+        "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
+    )
+
+    with open("/my-raw-records.json") as f:
+        records = json.load(f)
+
+        run = _client.push_task(
+            task_id="YOUR_TASK_ID",
+            push_task_payload={
+                "action": "addObject",
+                "records": records,
+            },
+        )
+
+        # use runID in the Observability debugger
+        print(run.run_id)
+
+
+asyncio.run(main())
diff --git a/docs/guides/ruby/pushSetup.rb b/docs/guides/ruby/pushSetup.rb
@@ -0,0 +1,12 @@
+require "json"
+require "algolia"
+
+records = JSON.parse(File.read("/my-raw-records.json"))
+
+# use the region matching your applicationID
+client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
+
+run = client.push_task("YOUR_TASK_ID", Algolia::Ingestion::PushTaskPayload.new(action: "addObject", records: records))
+
+# use runID in the Observability debugger
+puts(run.run_id)
diff --git a/docs/guides/scala/src/main/scala/pushSetup.scala b/docs/guides/scala/src/main/scala/pushSetup.scala
@@ -0,0 +1,46 @@
+import scala.io.Source
+import scala.concurrent.duration.Duration
+import scala.concurrent.{Await, ExecutionContextExecutor}
+
+import algoliasearch.api.IngestionClient
+
+import algoliasearch.config.*
+import algoliasearch.ingestion.*
+
+import org.json4s.native.JsonMethods
+import org.json4s.jvalue2extractable
+
+object PushSetup {
+  def main(args: Array[String]): Unit = {
+    implicit val ec: ExecutionContextExecutor = scala.concurrent.ExecutionContext.global
+    implicit val formats: org.json4s.Formats = org.json4s.DefaultFormats
+
+    val result = Source.fromFile("/my-raw-records.json").getLines().mkString
+    val records = JsonMethods.parse(result).extract[Seq[algoliasearch.ingestion.PushTaskRecords]]
+
+    // use the region matching your applicationID
+    val client = IngestionClient(
+      appId = "ALGOLIA_APPLICATION_ID",
+      apiKey = "ALGOLIA_API_KEY",
+      region = "ALGOLIA_APPLICATION_REGION"
+    )
+
+    try {
+      val run = Await.result(
+        client.pushTask(
+          taskID = "YOUR_TASK_ID",
+          pushTaskPayload = PushTaskPayload(
+            action = Action.withName("addObject"),
+            records = records
+          )
+        ),
+        Duration(100, "sec")
+      )
+
+      // use runID in the Observability debugger
+      println(run.runID)
+    } catch {
+      case e: Exception => println(e)
+    }
+  }
+}
diff --git a/docs/guides/swift/Package.swift b/docs/guides/swift/Package.swift
@@ -12,11 +12,18 @@ let package = Package(
         .tvOS(.v13),
         .watchOS(.v6),
     ],
+    products: [
+        .library(
+            name: "AlgoliaSearchClientGuides",
+            type: .static,
+            targets: ["AlgoliaSearchClientGuides"]
+        ),
+    ],
     dependencies: [
         .package(path: "../../../clients/algoliasearch-client-swift"),
     ],
     targets: [
-        .executableTarget(
+        .target(
             name: "AlgoliaSearchClientGuides",
             dependencies: [
                 .product(
diff --git a/docs/guides/swift/Sources/pushSetup.swift b/docs/guides/swift/Sources/pushSetup.swift
@@ -0,0 +1,29 @@
+import Foundation
+#if os(Linux) // For linux interop
+    import FoundationNetworking
+#endif
+
+import Core
+import Ingestion
+
+func pushSetup() async throws {
+    do {
+        let path = URL(string: #file)!.deletingLastPathComponent()
+            .appendingPathComponent("/my-raw-records.json")
+        let data = try Data(contentsOf: URL(fileURLWithPath: path.absoluteString))
+        let records = try JSONDecoder().decode([PushTaskRecords].self, from: data)
+
+        // use the region matching your applicationID
+        let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
+
+        let run = try await client.pushTaskWithHTTPInfo(
+            taskID: "YOUR_TASK_ID",
+            pushTaskPayload: PushTaskPayload(action: IngestionAction.addObject, records: records)
+        )
+
+        // use runID in the Observability debugger
+        dump(run)
+    } catch {
+        print(error)
+    }
+}
diff --git a/docs/snippets/csharp/.config/dotnet-tools.json b/docs/snippets/csharp/.config/dotnet-tools.json
diff --git a/docs/snippets/csharp/src/src.csproj b/docs/snippets/csharp/src/src.csproj
diff --git a/docs/snippets/go/.golangci.yml b/docs/snippets/go/.golangci.yml
diff --git a/docs/snippets/javascript/package.json b/docs/snippets/javascript/package.json

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`	`"isRoot": true,`
`4`	`4`	`"tools": {`
`5`	`5`	`"csharpier": {`
`6`		`- "version": "0.29.2",`
	`6`	`+ "version": "0.30.1",`
`7`	`7`	`"commands": [`
`8`	`8`	`"dotnet-csharpier"`
`9`	`9`	`]`
`10`	`10`	`}`
`11`	`11`	`}`
`12`		`-}`
	`12`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,11 @@`
`1`	`1`	`using System;`
`2`		`-using System.Text.Json;`
`3`		`-using System.Net.Http;`
`4`	`2`	`using System.Collections.Generic;`
`5`		`-`
	`3`	`+using System.Net.Http;`
	`4`	`+using System.Text.Json;`
`6`	`5`	`using Algolia.Search.Clients;`
`7`	`6`	`using Algolia.Search.Models.Search;`
`8`	`7`
`9`		`-class Program`
	`8`	`+class SaveObjectsMovies`
`10`	`9`	`{`
`11`	`10`	`public static async Task Main(string[] args)`
`12`	`11`	`{`
`@@ -25,9 +24,7 @@ public static async Task Main(string[] args)`
`25`	`24`	`// push data to algolia`
`26`	`25`	`try`
`27`	`26`	`{`
`28`		`- var result = await client.SaveObjectsAsync("<YOUR_INDEX_NAME>"`
`29`		`-, movies`
`30`		`-);`
	`27`	`+ var result = await client.SaveObjectsAsync("<YOUR_INDEX_NAME>", movies);`
`31`	`28`	`}`
`32`	`29`	`catch (Exception e)`
`33`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"github.com/algolia/algoliasearch-client-go/v4/algolia/search"`
`9`	`9`	`)`
`10`	`10`
`11`		`-func main() {`
	`11`	`+func saveObjectsMovies() {`
`12`	`12`	`// read json file`
`13`	`13`	`url := "https://dashboard.algolia.com/sample_datasets/movie.json"`
`14`	`14`	`response, err := http.Get(url)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "javascript-guides",`
`3`	`3`	`"version": "1.0.0",`
	`4`	`+ "type": "module",`
`4`	`5`	`"dependencies": {`
`5`	`6`	`"@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",`
`6`	`7`	`"@algolia/requester-node-http": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http",`