Merge branch 'facet-search' into issue-503

Author: Mubelotix

.code-samples.meilisearch.yaml

@@ -337,7 +337,8 @@ update_settings_1: |-
       "release_date"
     ])
     .with_synonyms(synonyms)
-    .with_typo_tolerance(typo_tolerance);
+    .with_typo_tolerance(typo_tolerance)
+    .with_search_cutoff(150);
 
   let task: TaskInfo = client
     .index("movies")
@@ -595,6 +596,42 @@ reset_faceting_settings_1: |-
     .reset_faceting()
     .await
     .unwrap();
+get_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .get_separator_tokens()
+    .await
+    .unwrap();
+update_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .set_separator_tokens(&vec!['|'.to_string(), '…'.to_string()])
+    .await
+    .unwrap();
+reset_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .reset_separator_tokens()
+    .await
+    .unwrap();
+get_non_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .get_non_separator_tokens()
+    .await
+    .unwrap();
+update_non_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .set_non_separator_tokens(&vec!['@'.to_string(), '#'.to_string()])
+    .await
+    .unwrap();
+reset_non_separator_tokens_1: |-
+  let task: TaskInfo = client
+    .index('articles')
+    .reset_non_separator_tokens()
+    .await
+    .unwrap();
 get_dictionary_1: |-
   let task: TaskInfo = client
     .index('books')
@@ -839,6 +876,15 @@ search_parameter_guide_show_ranking_score_1: |-
     .execute()
     .await
     .unwrap();
+search_parameter_guide_show_ranking_score_details_1: |-
+  let results: SearchResults<Movie> = client
+    .index("movies")
+    .search()
+    .with_query("dragon")
+    .with_show_ranking_score_details(true)
+    .execute()
+    .await
+    .unwrap();
 search_parameter_guide_matching_strategy_1: |-
   let results: SearchResults<Movie> = client
   .index("movies")
@@ -857,6 +903,15 @@ search_parameter_guide_matching_strategy_2: |-
   .execute()
   .await
   .unwrap();
+search_parameter_guide_matching_strategy_3: |-
+  let results: SearchResults<Movie> = client
+  .index("movies")
+  .search()
+  .with_query("white shirt")
+  .with_matching_strategy(MatchingStrategies::FREQUENCY)
+  .execute()
+  .await
+  .unwrap();
 search_parameter_guide_hitsperpage_1: |-
   client.index("movies").search().with_hits_per_page(15).execute().await?;
 search_parameter_guide_page_1: |-
@@ -990,10 +1045,10 @@ primary_field_guide_add_document_primary_key: |-
     ], Some("reference_number"))
     .await
     .unwrap();
-getting_started_add_documents_md: |-
-  ```toml
+getting_started_add_documents: |-
+  // In your .toml file:
     [dependencies]
-    meilisearch-sdk = "0.26.1"
+    meilisearch-sdk = "0.28.0"
     # futures: because we want to block on futures
     futures = "0.3"
     # serde: required if you are going to use documents
@@ -1002,9 +1057,8 @@ getting_started_add_documents_md: |-
     serde_json = "1.0"
   ```
 
-  Documents in the Rust library are strongly typed.
-
-  ```rust
+  // In your .rs file:
+  // Documents in the Rust library are strongly typed
   #[derive(Serialize, Deserialize)]
   struct Movie {
     id: i64,
@@ -1014,23 +1068,17 @@ getting_started_add_documents_md: |-
     release_date: i64,
     genres: Vec<String>
   }
-  ```
 
-  You will often need this `Movie` struct in other parts of this documentation. (you will have to change it a bit sometimes)
-  You can also use schemaless values, by putting a `serde_json::Value` inside your own struct like this:
-
-  ```rust
+  // You will often need this `Movie` struct in other parts of this documentation. (you will have to change it a bit sometimes)
+  // You can also use schemaless values, by putting a `serde_json::Value` inside your own struct like this:
   #[derive(Serialize, Deserialize)]
   struct Movie {
     id: i64,
     #[serde(flatten)]
     value: serde_json::Value,
   }
-  ```
-
-  Then, add documents into the index:
 
-  ```rust
+  // Then, add documents into the index:
   use meilisearch_sdk::{
     indexes::*,
     client::*,
@@ -1044,7 +1092,7 @@ getting_started_add_documents_md: |-
   fn main() { block_on(async move {
     let client = Client::new("http://localhost:7700", Some("aSampleMasterKey"));
 
-    // reading and parsing the file
+    // Reading and parsing the file
     let mut file = File::open("movies.json")
       .unwrap();
     let mut content = String::new();
@@ -1054,19 +1102,15 @@ getting_started_add_documents_md: |-
     let movies_docs: Vec<Movie> = serde_json::from_str(&content)
       .unwrap();
 
-    // adding documents
+    // Adding documents
     client
       .index("movies")
       .add_documents(&movies_docs, None)
       .await
       .unwrap();
   })}
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-rust/)
-getting_started_search_md: |-
-  You can build a `SearchQuery` and execute it later:
-  ```rust
+getting_started_search: |-
+  // You can build a `SearchQuery` and execute it later:
   let query: SearchQuery = SearchQuery::new(&movies)
     .with_query("botman")
     .build();
@@ -1076,29 +1120,22 @@ getting_started_search_md: |-
     .execute_query(&query)
     .await
     .unwrap();
-  ```
 
-  You can build a `SearchQuery` and execute it directly:
-  ```rust
+  // You can build a `SearchQuery` and execute it directly:
   let results: SearchResults<Movie> = SearchQuery::new(&movies)
     .with_query("botman")
     .execute()
     .await
     .unwrap();
-  ```
 
-  You can search in an index directly:
-  ```rust
+  // You can search in an index directly:
   let results: SearchResults<Movie> = client
     .index("movies")
     .search()
     .with_query("botman")
     .execute()
     .await
     .unwrap();
-  ```
-
-  [About this SDK](https://github.com/meilisearch/meilisearch-rust/)
 getting_started_update_ranking_rules: |-
   let ranking_rules = [
     "exactness",
@@ -1594,8 +1631,8 @@ get_experimental_features_1: |-
     .unwrap();
 update_experimental_features_1: |-
   let client = Client::new("http://localhost:7700", Some("apiKey"));
-  let mut features = ExperimentalFeatures::new(&client);
-  features.set_vector_store(true);
+  let features = ExperimentalFeatures::new(&client);
+  features.set_metrics(true)
   let res = features
     .update()
     .await
@@ -1641,8 +1678,92 @@ facet_search_3: |-
     .facet_search("genres")
     .with_facet_query("c")
     .execute()
+get_search_cutoff_1: |-
+  let search_cutoff_ms: String = client
+    .index("movies")
+    .get_search_cutoff_ms()
+    .await
+    .unwrap();
+update_search_cutoff_1: |-
+  let task: TaskInfo = client
+    .index("movies")
+    .set_search_cutoff_ms(Some(150))
+    .await
+    .unwrap();
+reset_search_cutoff_1: |-
+  let task: TaskInfo = client
+    .index("movies")
+    .reset_search_cutoff_ms()
+    .await
+    .unwrap();
 create_snapshot_1: |-
   client
     .create_snapshot()
     .await
     .unwrap();
+search_parameter_reference_distinct_1: |-
+  let res = client
+    .index("INDEX_NAME")
+    .search()
+    .with_query("QUERY TERMS")
+    .with_distinct("ATTRIBUTE_A")
+    .execute()
+    .await
+    .unwrap();
+distinct_attribute_guide_filterable_1: |-
+  let task: TaskInfo = client
+    .index("products")
+    .settings()
+    .set_filterable_attributes(["product_id", "sku", "url"])
+    .execute()
+    .await
+    .unwrap();
+distinct_attribute_guide_distinct_parameter_1: |-
+  let res = client
+    .index("products")
+    .search()
+    .with_query("white shirt")
+    .with_distinct("sku")
+    .execute()
+    .await
+    .unwrap();
+search_parameter_reference_ranking_score_threshold_1: |-
+  let res = client
+    .index("INDEX_NAME")
+    .search()
+    .with_query("badman")
+    .with_ranking_score_threshold(0.2)
+    .execute()
+    .await
+    .unwrap();
+search_parameter_reference_locales_1: |-
+  let res = client
+    .index("books")
+    .search()
+    .with_query("進撃の巨人")
+    .with_locales(&["jpn"])
+    .execute()
+    .await
+    .unwrap();
+get_localized_attribute_settings_1: |-
+  let localized_attributes: Option<Vec<LocalizedAttributes>> = client
+    .index("books")
+    .get_localized_attributes()
+    .await
+    .unwrap();
+update_localized_attribute_settings_1: |-
+  let localized_attributes = vec![LocalizedAttributes {
+      locales: vec!["jpn".to_string()],
+      attribute_patterns: vec!["*_ja".to_string()],
+  }];
+  let task: TaskInfo = client
+    .index("books")
+    .set_localized_attributes(&localizced_attributes)
+    .await
+    .unwrap();
+reset_localized_attribute_settings_1: |-
+  let task: TaskInfo = client
+    .index("books")
+    .reset_localized_attributes()
+    .await
+    .unwrap();

Cargo.toml

@@ -1,12 +1,13 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.26.1"
+version = "0.28.0"
 authors = ["Mubelotix <[email protected]>"]
 edition = "2018"
 description = "Rust wrapper for the Meilisearch API. Meilisearch is a powerful, fast, open-source, easy to use and deploy search engine."
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/meilisearch/meilisearch-sdk"
+resolver = "2"
 
 [workspace]
 members = ["examples/*"]
@@ -21,7 +22,7 @@ time = { version = "0.3.7", features = ["serde-well-known", "formatting", "parsi
 yaup = "0.3.1"
 either = { version = "1.8.0", features = ["serde"] }
 thiserror = "1.0.37"
-meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.26.1" }
+meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.28.0" }
 pin-project-lite = { version = "0.2.13", optional = true }
 reqwest = { version = "0.12.3", optional = true, default-features = false, features = ["rustls-tls", "http2", "stream"] }
 bytes = { version = "1.6", optional = true }

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Meili SAS
+Copyright (c) 2020-2025 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

README.md

@@ -35,7 +35,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
 - [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
@@ -48,17 +47,13 @@ This readme contains all the documentation you need to start using this Meilisea
 
 For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust). Get started with a 14-day free trial! No credit card required.
-
 ## 🔧 Installation
 
 To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.26.1"
+meilisearch-sdk = "0.28.0"
 ```
 
 The following optional dependencies may also be useful:
@@ -73,23 +68,11 @@ You can enable the `sync` feature to make most structs `Sync`. It may be a bit s
 
 Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde.
 
-### Run a Meilisearch Instance <!-- omit in TOC -->
-
-This crate requires a Meilisearch server to run.
-
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
+### Run Meilisearch <!-- omit in toc -->
 
-For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
-
-```bash
-# Install Meilisearch
-curl -L https://install.meilisearch.com | sh
-
-# Launch Meilisearch
-./meilisearch --master-key=masterKey
-```
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust).
 
-NB: you can also download Meilisearch from **Homebrew** or **APT**.
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust) our fast, open-source search engine on your own infrastructure.
 
 ## 🚀 Getting started