Add Ingest Pipeline support.

src/module-elasticsuite-core/Api/Client/ClientInterface.php

@@ -228,4 +228,22 @@ public function deleteByQuery(array $params): array;
      * @return array
      */
     public function updateByQuery(array $params): array;
+
+    /**
+     * Run an putPipeline request.
+     *
+     * @param array $params Pipeline params.
+     *
+     * @return array
+     */
+    public function putPipeline(array $params): array;
+
+    /**
+     * Run an getPipeline request.
+     *
+     * @param string $name Pipeline.
+     *
+     * @return array
+     */
+    public function getPipeline(string $name): array;
 }

src/module-elasticsuite-core/Api/Index/Ingest/PipelineInterface.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * DISCLAIMER
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Pierre Gauthier <pierre.gauthier@smile.fr>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+namespace Smile\ElasticsuiteCore\Api\Index\Ingest;
+
+/**
+ * Pipeline Interface
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCore
+ * @author   Pierre Gauthier <pierre.gauthier@smile.fr>
+ */
+interface PipelineInterface
+{
+    /**
+     * Get name
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+    /**
+     * Get description
+     *
+     * @return string
+     */
+    public function getDescription(): string;
+
+    /**
+     * Get processors
+     *
+     * @return array
+     */
+    public function getProcessors(): array;
+}

src/module-elasticsuite-core/Api/Index/Ingest/PipelineManagerInterface.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * DISCLAIMER
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Pierre Gauthier <pierre.gauthier@smile.fr>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+namespace Smile\ElasticsuiteCore\Api\Index\Ingest;
+
+use Smile\ElasticsuiteCore\Index\Ingest\Pipeline;
+
+/**
+ * Pipeline Manager
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCore
+ * @author   Pierre Gauthier <pierre.gauthier@smile.fr>
+ */
+interface PipelineManagerInterface
+{
+    /**
+     * Create ingest pipeline.
+     *
+     * @param string $name        name pipeline
+     * @param string $description description pipeline
+     * @param array  $processors  processors pipeline
+     */
+    public function create(string $name, string $description, array $processors): ?Pipeline;
+
+    /**
+     * Get Pipeline by name.
+     *
+     * @param string $name Pipeline name.
+     */
+    public function get(string $name): ?Pipeline;
+
+    /**
+     * Create Pipeline by index identifier.
+     *
+     * @param string $identifier Index identifier
+     */
+    public function createByIndexIdentifier(string $identifier): ?Pipeline;
+}

src/module-elasticsuite-core/Api/Index/Ingest/PipelineProcessorInterface.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * DISCLAIMER
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Pierre Gauthier <pierre.gauthier@smile.fr>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCore\Api\Index\Ingest;
+
+/**
+ * Pipeline Processor
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCore
+ * @author   Pierre Gauthier <pierre.gauthier@smile.fr>
+ */
+interface PipelineProcessorInterface
+{
+    /**
+     * Get Pipeline processors.
+     *
+     * @return array
+     */
+    public function getProcessors(): array;
+}

src/module-elasticsuite-core/Api/Index/Ingest/PipelineProcessorProviderInterface.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * DISCLAIMER
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Pierre Gauthier <pierre.gauthier@smile.fr>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCore\Api\Index\Ingest;
+
+/**
+ * Pipeline Processor Provider
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCore
+ * @author   Pierre Gauthier <pierre.gauthier@smile.fr>
+ */
+interface PipelineProcessorProviderInterface
+{
+    /**
+     * Get Pipeline processors by index identifier.
+     *
+     * @param string $indexIdentifier Index Identifier
+     *
+     * @return \Smile\ElasticsuiteCore\Api\Index\Ingest\PipelineProcessorInterface[]
+     */
+    public function getProcessors(string $indexIdentifier) : array;
+}

src/module-elasticsuite-core/Client/Client.php

@@ -261,6 +261,22 @@ public function updateByQuery(array $params): array
         return $this->getEsClient()->updateByQuery($params);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function putPipeline(array $params): array
+    {
+        return $this->getEsClient()->ingest()->putPipeline($params);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getPipeline(string $name): array
+    {
+        return $this->getEsClient()->ingest()->getPipeline(['id' => $name]);
+    }
+
     /**
      * @return \OpenSearch\Client
      */

src/module-elasticsuite-core/Index/AsyncIndexOperation.php

@@ -15,6 +15,7 @@
 
 use Smile\ElasticsuiteCore\Api\Client\ClientConfigurationInterface;
 use Smile\ElasticsuiteCore\Api\Index\AsyncIndexOperationInterface;
+use Smile\ElasticsuiteCore\Api\Index\Ingest\PipelineManagerInterface;
 
 /**
  * Asynchronous Index Operations interface
@@ -47,18 +48,20 @@ class AsyncIndexOperation extends IndexOperation implements AsyncIndexOperationI
      * @param \Smile\ElasticsuiteCore\Api\Client\ClientInterface              $client              ES client.
      * @param \Smile\ElasticsuiteCore\Api\Client\ClientConfigurationInterface $clientConfiguration ES client configuration.
      * @param \Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface        $indexSettings       ES settings.
+     * @param PipelineManagerInterface                                        $pipelineManager     Ingest Pipeline Manager.
      * @param \Psr\Log\LoggerInterface                                        $logger              Logger access.
      */
     public function __construct(
         \Magento\Framework\ObjectManagerInterface $objectManager,
         \Smile\ElasticsuiteCore\Api\Client\ClientInterface $client,
         \Smile\ElasticsuiteCore\Api\Client\ClientConfigurationInterface $clientConfiguration,
         \Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface $indexSettings,
+        PipelineManagerInterface $pipelineManager,
         \Psr\Log\LoggerInterface $logger
     ) {
         $this->client          = $client;
         $this->parallelHandles = $clientConfiguration->getMaxParallelHandles();
-        parent::__construct($objectManager, $client, $indexSettings, $logger);
+        parent::__construct($objectManager, $client, $indexSettings, $pipelineManager, $logger);
     }
 
     /**

src/module-elasticsuite-core/Index/IndexOperation.php

@@ -16,6 +16,7 @@
 
 use Smile\ElasticsuiteCore\Api\Index\Bulk\BulkResponseInterface;
 use Smile\ElasticsuiteCore\Api\Index\IndexOperationInterface;
+use Smile\ElasticsuiteCore\Api\Index\Ingest\PipelineManagerInterface;
 
 /**
  * Default implementation of operation on indices (\Smile\ElasticsuiteCore\Api\Index\IndexOperationInterface).
@@ -51,6 +52,11 @@ class IndexOperation implements IndexOperationInterface
      */
     private $client;
 
+    /**
+     * @var \Smile\ElasticsuiteCore\Api\Index\Ingest\PipelineManagerInterface
+     */
+    private $pipelineManager;
+
     /**
      * @var \Psr\Log\LoggerInterface
      */
@@ -59,21 +65,24 @@ class IndexOperation implements IndexOperationInterface
     /**
      * Instanciate the index operation manager.
      *
-     * @param \Magento\Framework\ObjectManagerInterface                $objectManager Object manager.
-     * @param \Smile\ElasticsuiteCore\Api\Client\ClientInterface       $client        ES client.
-     * @param \Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface $indexSettings ES settings.
-     * @param \Psr\Log\LoggerInterface                                 $logger        Logger access.
+     * @param \Magento\Framework\ObjectManagerInterface                $objectManager   Object manager.
+     * @param \Smile\ElasticsuiteCore\Api\Client\ClientInterface       $client          ES client.
+     * @param \Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface $indexSettings   ES settings.
+     * @param PipelineManagerInterface                                 $pipelineManager Ingest Pipeline Manager.
+     * @param \Psr\Log\LoggerInterface                                 $logger          Logger access.
      */
     public function __construct(
         \Magento\Framework\ObjectManagerInterface $objectManager,
         \Smile\ElasticsuiteCore\Api\Client\ClientInterface $client,
         \Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface $indexSettings,
+        PipelineManagerInterface $pipelineManager,
         \Psr\Log\LoggerInterface $logger
     ) {
         $this->objectManager        = $objectManager;
         $this->client               = $client;
         $this->indexSettings        = $indexSettings;
         $this->indicesConfiguration = $indexSettings->getIndicesConfig();
+        $this->pipelineManager      = $pipelineManager;
         $this->logger               = $logger;
     }
 
@@ -138,6 +147,12 @@ public function createIndex($indexIdentifier, $store)
         // @codingStandardsIgnoreEnd
         $indexSettings['settings']['analysis'] = $this->indexSettings->getAnalysisSettings($store);
 
+        // Add (and create, if needed) default pipeline.
+        $pipeline = $this->pipelineManager->createByIndexIdentifier($indexIdentifier);
+        if ($pipeline !== null) {
+            $indexSettings['settings']['default_pipeline'] = $pipeline->getName();
+        }
+
         $this->client->createIndex($index->getName(), $indexSettings);
 
         $this->client->putMapping($index->getName(), $index->getMapping()->asArray());

src/module-elasticsuite-core/Index/Ingest/Pipeline.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * DISCLAIMER
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Pierre Gauthier <pierre.gauthier@smile.fr>
+ * @copyright 2024 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCore\Index\Ingest;
+
+use Smile\ElasticsuiteCore\Api\Index\Ingest\PipelineInterface;
+
+/**
+ * Ingest Pipeline Implementation
+ *
+ * @category Smile
+ * @package  Smile\ElasticsuiteCore
+ * @author   Pierre Gauthier <pierre.gauthier@smile.fr>
+ */
+class Pipeline implements PipelineInterface
+{
+    /**
+     * @param string $name        Pipeline name
+     * @param string $description Pipeline description
+     * @param array  $processors  Pipeline processors
+     */
+    public function __construct(
+        protected string $name,
+        protected string $description,
+        protected array $processors
+    ) {
+    }
+
+    /**
+     * Get name
+     *
+     * @return string
+     */
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * Get description
+     *
+     * @return string
+     */
+    public function getDescription(): string
+    {
+        return $this->description;
+    }
+
+    /**
+     * Get processors
+     *
+     * @return array
+     */
+    public function getProcessors(): array
+    {
+        return $this->processors;
+    }
+}