Renames

Author: Mubelotix

src/indexes.rs

@@ -1702,7 +1702,7 @@ impl<Http: HttpClient> Index<Http> {
     /// # movies.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
     /// # });
     /// ```
-    pub async fn similar_query<T: 'static + DeserializeOwned + Send + Sync>(
+    pub async fn execute_similar_query<T: 'static + DeserializeOwned + Send + Sync>(
         &self,
         body: &SimilarQuery<'_, Http>,
     ) -> Result<SimilarResults<T>, Error> {
@@ -1715,6 +1715,14 @@ impl<Http: HttpClient> Index<Http> {
             )
             .await
     }
+
+    pub fn similar_search<'a, T: 'static + DeserializeOwned + Send + Sync>(
+        &'a self,
+        document_id: &'a str,
+        index_name: &'a str,
+    ) -> SimilarQuery<'a, Http> {
+        SimilarQuery::new(self, document_id, index_name)
+    }
 }
 
 impl<Http: HttpClient> AsRef<str> for Index<Http> {

src/similar.rs

@@ -45,7 +45,7 @@ pub struct SimilarResults<T> {
 ///
 /// ```no_run
 /// # use serde::{Serialize, Deserialize};
-/// # use meilisearch_sdk::{client::Client, search::*, indexes::Index, similar::SimilarQuery};
+/// # use meilisearch_sdk::{client::Client, search::*, indexes::Index};
 /// #
 /// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
 /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
@@ -60,7 +60,7 @@ pub struct SimilarResults<T> {
 /// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)).unwrap();
 /// # let index = client.index("similar_query_builder");
 /// #
-/// let mut res = SimilarQuery::new(&index, "100", "default")
+/// let mut res = index.similar_search("100", "default")
 ///     .execute::<Movie>()
 ///     .await
 ///     .unwrap();
@@ -213,7 +213,7 @@ impl<'a, Http: HttpClient> SimilarQuery<'a, Http> {
     pub async fn execute<T: 'static + DeserializeOwned + Send + Sync>(
         &'a self,
     ) -> Result<SimilarResults<T>, Error> {
-        self.index.similar_query::<T>(self).await
+        self.index.execute_similar_query::<T>(self).await
     }
 }