1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
use crate::{
request::{request, Method},
Client, Error,
};
use serde::{Deserialize, Serialize};
/// Struct representing the experimental features result from the API.
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ExperimentalFeaturesResult {
pub score_details: bool,
pub vector_store: bool,
}
/// Struct representing the experimental features request.
///
/// You can build this struct using the builder pattern.
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{Client, ExperimentalFeatures};
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// let mut features = ExperimentalFeatures::new(&client);
/// features.set_score_details(true);
/// ```
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ExperimentalFeatures<'a> {
#[serde(skip_serializing)]
client: &'a Client,
#[serde(skip_serializing_if = "Option::is_none")]
pub score_details: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub vector_store: Option<bool>,
}
impl<'a> ExperimentalFeatures<'a> {
pub fn new(client: &'a Client) -> Self {
ExperimentalFeatures {
client,
score_details: None,
vector_store: None,
}
}
pub fn set_score_details(&mut self, score_details: bool) -> &mut Self {
self.score_details = Some(score_details);
self
}
pub fn set_vector_store(&mut self, vector_store: bool) -> &mut Self {
self.vector_store = Some(vector_store);
self
}
/// Get all the experimental features
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{Client, ExperimentalFeatures};
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// futures::executor::block_on(async move {
/// let features = ExperimentalFeatures::new(&client);
/// features.get().await.unwrap();
/// });
/// ```
pub async fn get(&self) -> Result<ExperimentalFeaturesResult, Error> {
request::<(), (), ExperimentalFeaturesResult>(
&format!("{}/experimental-features", self.client.host),
self.client.get_api_key(),
Method::Get { query: () },
200,
)
.await
}
/// Update the experimental features
///
/// # Example
///
/// ```
/// # use meilisearch_sdk::{Client, ExperimentalFeatures};
/// # let MEILISEARCH_URL = option_env!("MEILISEARCH_URL").unwrap_or("http://localhost:7700");
/// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
/// # let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
/// futures::executor::block_on(async move {
/// let mut features = ExperimentalFeatures::new(&client);
/// features.set_score_details(true);
/// features.update().await.unwrap();
/// });
/// ```
pub async fn update(&self) -> Result<ExperimentalFeaturesResult, Error> {
request::<(), &Self, ExperimentalFeaturesResult>(
&format!("{}/experimental-features", self.client.host),
self.client.get_api_key(),
Method::Patch {
query: (),
body: self,
},
200,
)
.await
}
}
#[cfg(test)]
mod tests {
use super::*;
use meilisearch_test_macro::meilisearch_test;
#[meilisearch_test]
async fn test_experimental_features_get(client: Client) {
let mut features = ExperimentalFeatures::new(&client);
features.set_score_details(false);
features.set_vector_store(false);
let _ = features.update().await.unwrap();
let res = features.get().await.unwrap();
assert!(!res.score_details);
assert!(!res.vector_store);
}
#[meilisearch_test]
async fn test_experimental_features_enable_score_details(client: Client) {
let mut features = ExperimentalFeatures::new(&client);
features.set_score_details(true);
let res = features.update().await.unwrap();
assert!(res.score_details);
}
#[meilisearch_test]
async fn test_experimental_features_enable_vector_store(client: Client) {
let mut features = ExperimentalFeatures::new(&client);
features.set_vector_store(true);
let res = features.update().await.unwrap();
assert!(res.vector_store);
}
}