Merge #592

592: Support embedders API r=curquiza a=ellnix

# Pull Request

## Related issue
Fixes #590




Co-authored-by: ellnix <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -689,6 +689,19 @@ get_all_batches_1: |-
   client.batches
 get_batch_1: |-
   client.batch(BATCH_UID)
+get_embedders_1: |-
+  client.index('INDEX_NAME').embedders
+update_embedders_1: |-
+  client.index('INDEX_NAME').update_embedders(
+    default: {
+      source:  'openAi',
+      api_key: 'anOpenAiApiKey',
+      model: 'text-embedding-3-small',
+      document_template: "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
+    }
+  )
+reset_embedders_1: |-
+  client.index('INDEX_NAME').reset_embedders
 distinct_attribute_guide_filterable_1: |-
   client.index('products').update_filterable_attributes([
     'product_id',

.rubocop_todo.yml

@@ -1,21 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-08 15:54:24 UTC using RuboCop version 1.69.2.
+# on 2025-01-10 14:26:27 UTC using RuboCop version 1.69.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 66
+# Offense count: 67
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 670
+  Max: 702
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 470
+  Max: 480
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch/index.rb

@@ -673,5 +673,21 @@ def update_prefix_search(new_prefix_search_setting)
     def reset_prefix_search
       http_delete("/indexes/#{@uid}/settings/prefix-search")
     end
+
+    ### SETTINGS - EMBEDDERS
+
+    def embedders
+      http_get("/indexes/#{@uid}/settings/embedders")
+    end
+
+    def update_embedders(new_embedders)
+      new_embedders = Utils.transform_attributes(new_embedders)
+
+      http_patch("/indexes/#{@uid}/settings/embedders", new_embedders)
+    end
+
+    def reset_embedders
+      http_delete("/indexes/#{@uid}/settings/embedders")
+    end
   end
 end

spec/meilisearch/index/settings_spec.rb

@@ -865,4 +865,45 @@
       expect(index.prefix_search).to eq(default_prefix_search)
     end
   end
+
+  context 'on embedders' do
+    let(:index) { client.index(uid) }
+    let(:default_embedders) { nil }
+
+    before { client.create_index(uid).await }
+    before { enable_vector_store(true) }
+
+    it '#embedders gets default value' do
+      expect(index.embedders).to eq(default_embedders)
+    end
+
+    it '#update_embedders updates default value' do
+      update_task = index.update_embedders(
+        custom: {
+          source: 'userProvided',
+          dimensions: 3
+        }
+      )
+      client.wait_for_task(update_task['taskUid'])
+
+      expect(index.embedders).to have_key('custom')
+    end
+
+    it '#reset_embedders resets embedders to nil' do
+      update_task = index.update_embedders(
+        custom: {
+          source: 'userProvided',
+          dimensions: 3
+        }
+      )
+      client.wait_for_task(update_task['taskUid'])
+
+      expect(index.embedders).to have_key('custom')
+
+      reset_task = index.reset_embedders
+      client.wait_for_task(reset_task['taskUid'])
+
+      expect(index.embedders).to eq(default_embedders)
+    end
+  end
 end