typesense 0.4.0

Client for typesense
Documentation 
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

//! Provides access to the API endpoints for managing the collection of stemming dictionaries.
//!
//! A `Dictionaries` instance is created via the `client.stemming().dictionaries()` method.

use crate::{
    client::{Client, Error},
    execute_wrapper,
};
use ::std::borrow::Cow;
use typesense_codegen::{apis::stemming_api, models};

/// Provides methods for interacting with the collection of stemming dictionaries.
///
/// This struct is created by calling `client.stemming().dictionaries()`.
pub struct Dictionaries<'a> {
    pub(super) client: &'a Client,
}

impl<'a> Dictionaries<'a> {
    /// Creates a new `Dictionaries` instance.
    #[inline]
    pub(super) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Imports a stemming dictionary from a JSONL file content.
    ///
    /// This creates or updates a dictionary with the given ID.
    ///
    /// # Arguments
    /// * `dictionary_id` - The ID to assign to the dictionary.
    /// * `dictionary_jsonl` - A string containing the word mappings in JSONL format.
    pub async fn import(
        &self,
        dictionary_id: impl Into<Cow<'_, str>>,
        dictionary_jsonl: impl Into<Cow<'_, str>>,
    ) -> Result<String, Error<stemming_api::ImportStemmingDictionaryError>> {
        let params = stemming_api::ImportStemmingDictionaryParams {
            id: dictionary_id.into(),
            body: dictionary_jsonl.into(),
        };
        execute_wrapper!(self, stemming_api::import_stemming_dictionary, params)
    }

    /// Retrieves a list of all stemming dictionaries.
    pub async fn retrieve(
        &self,
    ) -> Result<
        models::ListStemmingDictionaries200Response,
        Error<stemming_api::ListStemmingDictionariesError>,
    > {
        execute_wrapper!(self, stemming_api::list_stemming_dictionaries)
    }
}