secretary 0.4.42

Transform natural language into structured data using large language models (LLMs) with powerful derive macros
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
67
68
69
70
71
72
73
74
75
76
77

use serde_json::{Value, json};

use crate::{
    message::Message,
    traits::{AsyncGenerateData, GenerateData, IsLLM},
};

/// Represents a Large Language Model (LLM) that is compatible with OpenAI API.
/// An LLM is the primary tool we use to convert unstructured data into structured data.
#[derive(Debug, Clone)]
pub struct AzureOpenAILLM {
    model: String,
    base_url: String,
    api_key: String,
}

impl AzureOpenAILLM {
    /// Creates a new instance of the AzureOpenAILLM struct.
    ///
    /// # Arguments
    ///
    /// * `api_base` - A string slice that holds the base URL for the Azure OpenAI API.
    /// * `api_key` - A string slice that holds the API key for authenticating with the Azure OpenAI API.
    /// * `deployment_id` - A string slice that specifies the deployment ID for the Azure OpenAI service.
    /// * `api_version` - A string slice that specifies the API version to use.
    ///
    /// # Returns
    ///
    /// * `Result<Self, Error>` - On success, returns an instance of the AzureOpenAILLM struct. On failure, returns an Box<dyn std::error::Error>.
    pub fn new(api_base: &str, api_key: &str, deployment_id: &str, api_version: &str) -> Self {
        let base_url: String = format!(
            "{}/openai/deployments/{}/chat/completions?api-version={}",
            api_base, deployment_id, api_version
        );

        Self {
            model: deployment_id.to_string(),
            base_url,
            api_key: api_key.to_string(),
        }
    }
}

impl IsLLM for AzureOpenAILLM {
    fn get_authorization_credentials(&self) -> String {
        self.api_key.clone()
    }

    fn get_model_ref(&self) -> &str {
        &self.model
    }

    fn get_chat_completion_request_url(&self) -> String {
        self.base_url.clone()
    }

    fn get_request_body(&self, message: Message, return_json: bool) -> Value {
        if return_json {
            return json!(
                {
                    "messages": [message],
                    "response_format": {"type": "json_object"}
                }
            );
        }

        return json!(
            {
                "messages": [message],
            }
        );
    }
}

impl GenerateData for AzureOpenAILLM {}

impl AsyncGenerateData for AzureOpenAILLM {}