Meilisearch Ruby

Meilisearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The Meilisearch API client written for Ruby 💎

Meilisearch Ruby is the Meilisearch API client for Ruby developers.

Meilisearch is an open-source search engine. Discover what Meilisearch is!

Table of Contents <!-- omit in toc -->

• 🎃 Hacktoberfest
• 📖 Documentation
• 🔧 Installation
• 🚀 Getting Started
• 🤖 Compatibility with Meilisearch
• 💡 Learn More
• ⚙️ Development Workflow and Contributing

🎃 Hacktoberfest

It’s Hacktoberfest 2022 @Meilisearch

Hacktoberfest is a celebration of the open-source community. This year, and for the third time in a row, Meilisearch is participating in this fantastic event.

You’d like to contribute? Don’t hesitate to check out our contributing guidelines.

📖 Documentation

See our Documentation or our API References.

🔧 Installation

This package requires Ruby version 2.6.0 or later.

With gem in command line:

gem install meilisearch

In your Gemfile with bundler:

source 'https://rubygems.org'

gem 'meilisearch'

Run Meilisearch <!-- omit in toc -->

There are many easy ways to download and run a Meilisearch instance.

For example, using the curl command in your Terminal:

#Install Meilisearch
curl -L https://install.meilisearch.com | sh

# Launch Meilisearch
./meilisearch --master-key=masterKey

NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.

🚀 Getting Started

Add documents <!-- omit in toc -->

require 'meilisearch'

client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')

# An index is where the documents are stored.
index = client.index('movies')

documents = [
  { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
  { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
  { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
  { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
  { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
  { id: 6, title: 'Philadelphia', genres: ['Drama'] },
]
# If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
index.add_documents(documents) # => { "uid": 0 }

With the uid, you can check the status (enqueued, processing, succeeded or failed) of your documents addition using the task.

💡 To customize the Client, for example, increasing the default timeout, please check out this section of the Wiki.

Basic Search <!-- omit in toc -->

# Meilisearch is typo-tolerant:
puts index.search('carlo')

Output:

{
  "hits" => [{
    "id" => 1,
    "title" => "Carol"
  }],
  "offset" => 0,
  "limit" => 20,
  "processingTimeMs" => 1,
  "query" => "carlo"
}

Custom search <!-- omit in toc -->

All the supported options are described in the search parameters section of the documentation.

index.search(
  'wonder',
  attributes_to_highlight: ['*']
)

JSON output:

{
    "hits": [
        {
            "id": 2,
            "title": "Wonder Woman",
            "_formatted": {
                "id": 2,
                "title": "<em>Wonder</em> Woman"
            }
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "wonder"
}

Custom Search With Filters <!-- omit in toc -->

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

index.update_filterable_attributes([
  'id',
  'genres'
])

You only need to perform this operation once.

Note that Meilisearch will rebuild your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take time. You can track the process using the tasks).

Then, you can perform the search:

index.search('wonder', { filter: ['id > 1 AND genres = Action'] })

JSON output:

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": [
        "Action",
        "Adventure"
      ]
    }
  ],
  "estimatedTotalHits": 1,
  "query": "wonder",
  "limit": 20,
  "offset": 0,
  "processingTimeMs": 0
}

🤖 Compatibility with Meilisearch

This package only guarantees the compatibility with the version v0.29.0 of Meilisearch.

💡 Learn More

The following sections may interest you:

• Manipulate documents: see the API references or read more about documents.
• Search: see the API references or follow our guide on search parameters.
• Manage the indexes: see the API references or read more about indexes.
• Configure the index settings: see the API references or follow our guide on settings parameters.

📖 Also, check out the Wiki of this repository to know what this SDK provdes!

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

---

Meilisearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.