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
55
56
57
58
59
60
61
62
63
64
65
66

//! Provides access to the API endpoints for managing a single conversation model.
//!
//! An instance of `Model` is created via the `client.conversations().model("model_id")` method.

use crate::{Client, Error, execute_wrapper, models};
use typesense_codegen::apis::conversations_api;

/// Provides methods for interacting with a specific conversation model.
///
/// This struct is created by calling `client.conversations().model("model_id")`.
pub struct Model<'a> {
    pub(super) client: &'a Client,
    pub(super) model_id: &'a str,
}

impl<'a> Model<'a> {
    /// Creates a new `Model` instance for a specific model ID.
    #[inline]
    pub(super) fn new(client: &'a Client, model_id: &'a str) -> Self {
        Self { client, model_id }
    }

    /// Retrieves the details of this specific conversation model.
    pub async fn retrieve(
        &self,
    ) -> Result<
        models::ConversationModelSchema,
        Error<conversations_api::RetrieveConversationModelError>,
    > {
        let params = conversations_api::RetrieveConversationModelParams {
            model_id: self.model_id.into(),
        };
        execute_wrapper!(self, conversations_api::retrieve_conversation_model, params)
    }

    /// Updates this specific conversation model.
    ///
    /// # Arguments
    /// * `schema` - A `ConversationModelUpdateSchema` object with the fields to update.
    pub async fn update(
        &self,
        schema: models::ConversationModelUpdateSchema<'_>,
    ) -> Result<
        models::ConversationModelSchema,
        Error<conversations_api::UpdateConversationModelError>,
    > {
        let params = conversations_api::UpdateConversationModelParams {
            model_id: self.model_id.into(),
            conversation_model_update_schema: schema,
        };
        execute_wrapper!(self, conversations_api::update_conversation_model, params)
    }

    /// Deletes this specific conversation model.
    pub async fn delete(
        &self,
    ) -> Result<
        models::ConversationModelSchema,
        Error<conversations_api::DeleteConversationModelError>,
    > {
        let params = conversations_api::DeleteConversationModelParams {
            model_id: self.model_id.into(),
        };
        execute_wrapper!(self, conversations_api::delete_conversation_model, params)
    }
}