meilisearch 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6503fb7f801990fd58fee344cdd3ea25edc549ddf2423b59c2ca84b2bcd11390
-  data.tar.gz: dfbb61ed72936cf705cddbdf76601ea94250dbf0cd95142e54d6a4f82771307d
+  metadata.gz: e182244659129f40ceff661d8e117af391a68aa1cf5fed79f198fc715863ba4e
+  data.tar.gz: 17f9fd0b3b529829f1bd3d4d39cb3444532ec2cc14b0aebaeac00bae6f217d9b
 SHA512:
-  metadata.gz: 5b0820f6b28e681410a4dde5538d8fb87dddba5f28d40ff5807d54c94e7886f3778b95e0b6c4658dabb6bd55c5698b27ca18fc051d00b60f138aeb3160e47260
-  data.tar.gz: aa7f20470f2014ae5a9526768c9418fd91d08478553254eb20e9600fbaf004042f7d585a5d3865c78c5db5daa024d1a583f048fef9b1428c1b73f09268327dc9
+  metadata.gz: 6aefe0097ef3f3c1785f1498ade5508ac77fca3e5aef025931d7ec34e12462419721cd2b7a1ee9d8c5037a36fa0dedd3aeabb35b473a400e05b9880401495149
+  data.tar.gz: 5b9949303254ca87e378904dadbbf0f7fc77a113cbda175dfb7bb950b674ed09742d411c0fb45cbc3a5626c6c16ebd1549e402b76504016b1e9567e28ba4e084

data/README.md

@@ -30,7 +30,7 @@
 
 **Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
 - [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
@@ -207,6 +207,82 @@ JSON output:
 }
 ```
 
+#### Display ranking details at search
+
+JSON output:
+
+```json
+{
+  "hits": [
+    {
+      "id": 15359,
+      "title": "Wonder Woman",
+      "_rankingScoreDetails": {
+        "words": {
+          "order": 0,
+          "matchingWords": 2,
+          "maxMatchingWords": 2,
+          "score": 1.0
+        },
+        "typo": {
+          "order": 1,
+          "typoCount": 0,
+          "maxTypoCount": 2,
+          "score": 1.0
+        },
+        "proximity": {
+          "order": 2,
+          "score": 1.0
+        },
+        "attribute": {
+          "order": 3,
+          "attributeRankingOrderScore": 0.8181818181818182,
+          "queryWordDistanceScore": 1.0,
+          "score": 0.8181818181818182
+        },
+        "exactness": {
+          "order": 4,
+          "matchType": "exactMatch",
+          "score": 1.0
+        }
+      }
+    }
+  ]
+}
+```
+
+You can enable it by querying PATCH /experimental-features with { "scoreDetails": true }
+
+This feature is only available with Meilisearch v1.3 and newer (optional).
+
+#### Custom Search With attributes on at search time  <!-- omit in toc -->
+
+[Customize attributes to search on at search time](https://www.meilisearch.com/docs/reference/api/search#customize-attributes-to-search-on-at-search-time).
+
+you can perform the search :
+
+```ruby
+index.search('wonder', { attributes_to_search_on: ['genres'] })
+```
+
+
+JSON output:
+
+```json
+{
+  "hits":[],
+  "query":"wonder",
+  "processingTimeMs":0,
+  "limit":20,
+  "offset":0,
+  "estimatedTotalHits":0,
+  "nbHits":0
+}
+```
+
+This feature is only available with Meilisearch v1.3 and newer (optional).
+
+
 ## 🤖 Compatibility with Meilisearch
 
 This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-ruby/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.

data/lib/meilisearch/error.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  class ApiError < StandardError
+  class Error < StandardError
+  end
+
+  class ApiError < Error
     # :http_code    # e.g. 400, 404...
     # :http_message # e.g. Bad Request, Not Found...
     # :http_body    # The response body received from the MeiliSearch API
@@ -45,7 +48,7 @@ module MeiliSearch
     end
   end
 
-  class CommunicationError < StandardError
+  class CommunicationError < Error
     attr_reader :message
 
     def initialize(message)
@@ -54,7 +57,7 @@ module MeiliSearch
     end
   end
 
-  class TimeoutError < StandardError
+  class TimeoutError < Error
     attr_reader :message
 
     def initialize(message = nil)
@@ -64,8 +67,8 @@ module MeiliSearch
   end
 
   module TenantToken
-    class ExpireOrInvalidSignature < StandardError; end
-    class InvalidApiKey < StandardError; end
-    class InvalidSearchRules < StandardError; end
+    class ExpireOrInvalidSignature < MeiliSearch::Error; end
+    class InvalidApiKey < MeiliSearch::Error; end
+    class InvalidSearchRules < MeiliSearch::Error; end
   end
 end

data/lib/meilisearch/index.rb

@@ -220,6 +220,9 @@ module MeiliSearch
 
     ### SEARCH
 
+    # options: A Hash
+    #   show_ranking_score - To see the ranking scores for returned documents
+    #   attributes_to_search_on - Customize attributes to search on at search time.
     def search(query, options = {})
       attributes = { q: query.to_s }.merge(options.compact)
 
@@ -231,6 +234,15 @@ module MeiliSearch
       response
     end
 
+    ### FACET SEARCH
+
+    def facet_search(name, query = '', **options)
+      options.merge!(facet_name: name, facet_query: query)
+      options = Utils.transform_attributes(options)
+
+      http_post("/indexes/#{@uid}/facet-search", options)
+    end
+
     ### TASKS
 
     def task_endpoint
@@ -458,5 +470,49 @@ module MeiliSearch
     def reset_faceting
       http_delete("/indexes/#{@uid}/settings/faceting")
     end
+
+    ### SETTINGS - DICTIONARY
+
+    def dictionary
+      http_get("/indexes/#{@uid}/settings/dictionary")
+    end
+
+    def update_dictionary(dictionary_attributes)
+      attributes = Utils.transform_attributes(dictionary_attributes)
+      http_put("/indexes/#{@uid}/settings/dictionary", attributes)
+    end
+
+    def reset_dictionary
+      http_delete("/indexes/#{@uid}/settings/dictionary")
+    end
+    ### SETTINGS - SEPARATOR TOKENS
+
+    def separator_tokens
+      http_get("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    def update_separator_tokens(separator_tokens_attributes)
+      attributes = Utils.transform_attributes(separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/separator-tokens", attributes)
+    end
+
+    def reset_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/separator-tokens")
+    end
+
+    ### SETTINGS - NON SEPARATOR TOKENS
+
+    def non_separator_tokens
+      http_get("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
+
+    def update_non_separator_tokens(non_separator_tokens_attributes)
+      attributes = Utils.transform_attributes(non_separator_tokens_attributes)
+      http_put("/indexes/#{@uid}/settings/non-separator-tokens", attributes)
+    end
+
+    def reset_non_separator_tokens
+      http_delete("/indexes/#{@uid}/settings/non-separator-tokens")
+    end
   end
 end

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.25.0'
+  VERSION = '0.26.0'
 
   def self.qualified_version
     "Meilisearch Ruby (v#{VERSION})"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty