v1.1: Multi-index search

.code-samples.meilisearch.yaml

@@ -567,7 +567,7 @@ getting_started_communicating_with_a_protected_instance: |-
   curl \ 
     -X POST 'http://localhost:7700/indexes/movies/search' \
     -H 'Authorization: Bearer API_KEY'    
-faceted_search_update_settings_1: |-
+filtering_update_settings_1: |-
   curl \
     -X PATCH 'http://localhost:7700/indexes/movie_ratings/settings' \
     -H 'Content-Type: application/json' \
@@ -993,3 +993,73 @@ swap_indexes_1: |
         ]
       }
     ]'
+multi_search_1: |-
+  curl \
+    -X POST 'http://localhost:7700/multi-search' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "queries": [
+        {
+          "indexUid": "movies",
+          "q": "pooh",
+          "limit": 5
+        },
+        {
+          "indexUid": "movies",
+          "q": "nemo",
+          "limit": 5
+        },
+        {
+          "indexUid": "movie_ratings",
+          "q": "us"
+        }
+      ]
+    }'
+faceted_search_update_settings_1: |-
+  curl \
+    -X PUT 'http://localhost:7700/indexes/books/settings/filterable-attributes' \
+    -H 'Content-Type: application/json' \
+    --data-binary '[
+      "genres", "rating", "language"
+    ]'
+faceted_search_1: |-
+  curl \
+    -X POST 'http://localhost:7700/indexes/books/search' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "q": "classic",
+      "facets": [
+      "genres", "rating", "language"
+    ]
+  }'
+search_parameter_guide_facet_stats_1: |-
+  curl \
+    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "q": "Batman",
+      "facets": ["genres", "rating"]
+    }'
+faceted_search_2: |-
+  curl \
+    -X POST 'http://localhost:7700/multi-search' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "queries": [
+        {
+          "indexUid": "books",
+          "facets": ["language", "genres", "author", "format"],
+          "filter": "(language = English AND language = French) OR genres = Fiction"
+        },
+        {
+          "indexUid": "books",
+          "facets": ["language"],
+          "filter": "genres = Fiction"
+        },
+        {
+          "indexUid": "books",
+          "facets": ["genres"],
+          "filter": "language = English OR language = French"
+        }
+      ]
+    }'

.vuepress/config.js

@@ -74,6 +74,7 @@ module.exports = {
           { text: 'GitHub', link: 'https://github.com/meilisearch/meilisearch' },
           { text: 'Discord', link: 'https://discord.gg/meilisearch' },
           { text: 'Blog', link: 'https://blog.meilisearch.com/' },
+          { text: 'Awesome Meilisearch', link: 'https://github.com/meilisearch/awesome-meilisearch' },
           { text: 'meilisearch.com', link: 'https://meilisearch.com' },
         ],
       },
@@ -189,7 +190,8 @@ module.exports = {
           collapsable: false,
           children: [
             '/learn/advanced/asynchronous_operations',
-            '/learn/advanced/filtering_and_faceted_search',
+            '/learn/advanced/filtering',
+            '/learn/advanced/faceted_search',
             '/learn/advanced/geosearch',
             '/learn/advanced/pagination',
             '/learn/advanced/sorting',
@@ -318,6 +320,7 @@ module.exports = {
             '/reference/api/indexes',
             '/reference/api/documents',
             '/reference/api/search',
+            '/reference/api/multi_search',
             '/reference/api/tasks',
             '/reference/api/keys',
             '/reference/api/settings',

.vuepress/public/_redirects

@@ -11,8 +11,8 @@
 /guides/advanced_guides/installation.html           /learn/getting_started/installation.html
 /guides/advanced_guides/configuration.html          /learn/configuration/instance_options.html
 /guides/advanced_guides/search_parameters.html      /reference/api/search.html
-/guides/advanced_guides/filtering.html              /learn/advanced/filtering_and_faceted_search.html
-/guides/advanced_guides/faceted_search.html         /learn/advanced/filtering_and_faceted_search.html
+/guides/advanced_guides/filtering.html              /learn/advanced/filtering.html
+/guides/advanced_guides/faceted_search.html         /learn/advanced/faceted_search.html
 /guides/advanced_guides/authentication.html         /learn/security/master_api_keys.html
 /guides/advanced_guides/asynchronous_updates.html   /learn/advanced/asynchronous_operations.html
 /guides/advanced_guides/web_interface.html          /learn/what_is_meilisearch/search_preview.html
@@ -77,8 +77,8 @@
 
 # Group filters and facets content
 /reference/api/attributes_for_faceting.html         /reference/api/settings.html
-/reference/features/filtering.html                  /learn/advanced/filtering_and_faceted_search.html
-/reference/features/faceted_search.html             /learn/advanced/filtering_and_faceted_search.html
+/reference/features/filtering.html                  /learn/advanced/filtering.html
+/reference/features/faceted_search.html             /learn/advanced/faceted_search.html
 
 # Rename Asynchronous updates to Asynchronous operations
 /learn/advanced/asynchronous_updates.html           /learn/advanced/asynchronous_operations.html
@@ -203,3 +203,10 @@
 # New "Update and migration" section
 /learn/getting_started/algolia_migration.html       /learn/update_and_migration/algolia_migration.html
 /learn/advanced/updating.html                       /learn/update_and_migration/updating.html
+
+# Move faceting to a new guide
+/learn/advanced/filtering_and_faceted_search.html#faceted-search   /learn/advanced/faceted_search.html
+
+# Rename filtering guide
+/learn/advanced/filtering_and_faceted_search.html   /learn/advanced/filtering.html
+

.vuepress/public/books.json

@@ -0,0 +1,146 @@
+[
+  {
+  "id":5,
+  "title": "Hard Times",
+  "genres": ["Classics","Fiction", "Victorian", "Literature"],
+  "publisher": "Penguin Classics",
+  "language": "English",
+  "author": "Charles Dickens",
+  "description":"Hard Times is a novel of social protest which attacks utilitarianism, Bentham's theory which only considered the practical aspects of happiness and ignored emotional, spiritual and moral values. It is set in Coketown, a fictious industrial city in northern England in the mid-1800s.",
+  "format": "Hardcover",
+  "rating": 3
+  },
+  {
+    "id":1,
+    "title": "Don Quixote",
+    "genres": ["Satire","Fiction"],
+    "publisher": "Penguin Classics",
+    "language": "Spanish",
+    "author": "Miguel de Cervantes",
+    "description":"Don Quixote is a classic novel from 1605 which portraits the life and insightful journey of Don Quixote de la Mancha, a Spanish man who seems to be losing his mind on his quest to become a knight and restore chivalry alongside with a farmer named Sancho Panza, with whom he fights multiple imaginary ",
+    "format": "Hardcover",
+    "rating": 4
+  },
+  {
+    "id":2,
+    "title": "The Travels of Ibn Battuta",
+    "genres": ["Travel","Adventure"],
+    "publisher": "Dover Publications",
+    "language": "English",
+    "author": "Ibn Battuta",
+    "description":"His main reason to travel was to go on a Hajj, or a Pilgrimage to Mecca, to fulfill the fifth pillar of Isla.. But his traveling went on for around 29 years and he covered about 75,000 miles visiting the equivalent of 44 modern countries which were then mostly under the governments of Muslim leaders of the World of ",
+    "format": "Hardcover",
+    "rating": 4.5
+  },
+  {
+  "id":3,
+  "title": "Les Misérables",
+  "genres": ["Tragedy", "Fiction", "Novel", "Historical Fiction", "Literature", "Classics"],
+  "publisher": "Simon & Schuster",
+  "language": "French",
+  "author": "Victor Hugo",
+  "description":"Les Misérables centres on the character Jean Valjean, an ex-convict in 19th-century France. The story spans many years as it tells of Valjean's release from prison and reformation as an industrialist while being constantly pursued by the morally strict inspector Javert.",
+  "format": "Hardcover",
+  "rating": 4.7
+  },
+  {
+    "id":4,
+    "title": "James and the Giant Peach",
+    "genres": ["Novel","Children's Literature", "Fantasy"],
+    "publisher": "Puffin Books",
+    "language": "English",
+    "author": "Roald Dahl",
+    "description":"When his parents are unceremoniously eaten by a rhinoceros that escapes from London Zoo, James is forced to go and live with his unpleasant aunts. Through a series of peculiar and magical happenings, James finds himself in a giant peach with a bunch of friendly giant insects for travelling companions.",
+    "format": "Paperback",
+    "rating": 4
+  },
+  {
+    "id":6,
+    "title": "Pride and Prejudice",
+    "genres": ["Classics","Fiction", "Romance", "Literature"],
+    "publisher": "Penguin Classics",
+    "language": "English",
+    "author": "Jane Austen",
+    "description":"Pride and Prejudice follows the turbulent relationship between Elizabeth Bennet, the daughter of a country gentleman, and Fitzwilliam Darcy, a rich aristocratic landowner. They must overcome the titular sins of pride and prejudice in order to fall in love and marry.",
+    "format": "Hardcover",
+    "rating": 4
+  },
+  {
+  "id":7,
+  "title": "Diary of a Wimpy Kid",
+  "genres": ["Humor", "Fiction", "Young Adult", "Comedy","Diary Fiction"],
+  "publisher": "",
+  "language": "English",
+  "author": "Jeff Kinney",
+  "description":"It's a new school year, and Greg Heffley finds himself thrust into middle school, where undersized weaklings share the hallways with kids who are taller, meaner, and already shaving. The hazards of growing up before you're ready are uniquely revealed through words and drawings as Greg records them in his diary.",
+  "format": "Hardcover",
+  "rating": 4.8
+  },
+  {
+    "id":8,
+    "title": "Anne of Green Gables",
+    "genres": ["Literature", "Fiction", "Novel", "Comedy", "Coming-of-Age"],
+    "publisher": "Wordsworth Editions Ltd",
+    "language": "English",
+    "author": "Lucy M. Montgomery",
+    "description":"Anne of Green Gables, children's novel by Canadian author Lucy Maud Montgomery, published in 1908. The work, a sentimental but charming coming-of-age story about a spirited and unconventional orphan girl who finds a home with elderly siblings, became a classic of children's literature and led to several sequels.",
+    "format": "Hardcover",
+    "rating": 4
+  },
+  {
+    "id":9,
+    "title": "Harry Potter and the Chamber of Secrets",
+    "genres": ["Fantasy", "Fiction", "Magic", "Adventure", "Young Adult"],
+    "publisher": "Bloomsbury Publishing PLC",
+    "language": "English",
+    "author": "J.K. Rowling",
+    "description":"The second instalment of boy wizard Harry Potter's adventures at Hogwarts School of Witchcraft and Wizardry, based on the novel by JK Rowling. A mysterious elf tells Harry to expect trouble during his second year at Hogwarts, but nothing can prepare him for trees that fight back, flying cars, spiders that talk and deadly warnings written in blood on the walls of the school.",
+    "format": "Paperback",
+    "rating": 2
+  },
+  {
+    "id":10,
+    "title": "David Copperfield",
+    "genres": ["Classics","Fiction", "Victorian", "Literature"],
+    "publisher": "Penguin UK",
+    "language": "English",
+    "author": "Charles Dickens",
+    "description":"The story follows the life of David Copperfield from childhood to maturity. David was born in Blunderstone, Suffolk, England, six months after the death of his father. David spends his early years in relative happiness with his loving, childish mother and their kindly housekeeper, Clara Peggotty.",
+    "format": "Hardcover",
+    "rating": 3.9
+  },
+  {
+    "id":11,
+    "title": "Dracula",
+    "genres": ["Classics","Fiction", "Horror", "Literature", "Vampires", "Fantasy"],
+    "publisher": "Penguin UK",
+    "language": "English",
+    "author": "Bram Stoker",
+    "description":"Dracula is a gothic novel by Bram Stoker published in 1897. Stoker tells the story of the fight against the vampire Dracula in an epistolary format. The story comprises various letters, telegrams, journal entries, and newspaper articles written by the main characters.",
+    "format": "Hardcover",
+    "rating": 2.5
+  },
+  {
+    "id":12,
+    "title": "Frankenstein",
+    "genres": ["Classics","Fiction", "Horror", "Literature", "Fantasy"],
+    "publisher": "Penguin UK",
+    "language": "English",
+    "author": "Mary Shelley",
+    "description":"Frankenstein tells the story of gifted scientist Victor Frankenstein who succeeds in giving life to a being of his own creation. However, this is not the perfect specimen he imagines that it will be, but rather a hideous creature who is rejected by Victor and mankind in general.",
+    "format": "Hardcover",
+    "rating": 3
+  },
+  {
+    "id":13,
+    "title": "Madame Bovary",
+    "genres": ["Novel","Fiction", "Realism", "Literature"],
+    "publisher": "Penguin UK",
+    "language": "French",
+    "author": "Gustave Flaubert",
+    "description":"Madame Bovary is the debut novel of French writer Gustave Flaubert, published in 1856. The character lives beyond her means in order to escape the banalities and emptiness of provincial life. When the novel was first serialized in La Revue de Paris between 1 October 1856 and 15 December 1856, public prosecutors attacked the novel for obscenity. The resulting trial in January 1857 made the story notorious. After Flaubert's acquittal on 7 February 1857, Madame Bovary became a bestseller in April 1857 when it was published in two volumes. A seminal work of literary realism, the novel is now considered Flaubert's masterpiece, and one of the most influential literary works in history.",
+    "format": "Hardcover",
+    "rating": 4
+  }
+]
+

.vuepress/public/sample-template.yaml

@@ -84,7 +84,7 @@ getting_started_geo_radius: |-
 getting_started_geo_point: |-
 getting_started_sorting: |-
 getting_started_filtering: |-
-faceted_search_update_settings_1: |-
+filtering_update_settings_1: |-
 faceted_search_facets_1: |-
 faceted_search_walkthrough_filter_1: |-
 add_movies_json_1: |-
@@ -157,3 +157,8 @@ async_guide_filter_by_index_uids_1: |
 cancel_tasks_1: |
 delete_tasks_1: |
 swap_indexes_1: |
+multi_search_1: |
+faceted_search_update_settings_1: |-
+search_parameter_guide_facet_stats_1: |-
+faceted_search_1: |-
+faceted_search_2: |-

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2022 Meili SAS
+Copyright (c) 2019-2023 Meili SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

learn/advanced/datatypes.md

@@ -57,7 +57,7 @@ A numeric type (`integer`, `float`) is converted to a human-readable decimal num
 
 You can add [custom ranking rules](/learn/core_concepts/relevancy.md#custom-rules) to create an ascending or descending sorting rule on a given attribute that has a numeric value in the documents.
 
-You can also create [filters](/learn/advanced/filtering_and_faceted_search.md). The `>`, `>=`, `<`, `<=`, and `TO` relational operators apply only to numerical values.
+You can also create [filters](/learn/advanced/filtering.md). The `>`, `>=`, `<`, `<=`, and `TO` relational operators apply only to numerical values.
 
 ## Boolean