txtai 9.1.0

Rust client for txtai
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
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

use enum_as_inner::EnumAsInner;
use reqwest::{RequestBuilder, Response};
use serde::Deserialize;
use serde_json::Value;
use std::env;
use std::error::Error;

// Generic return types
pub type APIResponse = Result<Response, Box<dyn Error>>;
pub type IndexResults = Result<Vec<IndexResult>, Box<dyn Error>>;
pub type IndexResultsBatch = Result<Vec<Vec<IndexResult>>, Box<dyn Error>>;
pub type Strings = Result<String, Box<dyn Error>>;
pub type StringsBatch = Result<Vec<String>, Box<dyn Error>>;
pub type Texts = Result<Text, Box<dyn Error>>;
pub type TextsBatch = Result<Vec<Text>, Box<dyn Error>>;

/// Base API definition
pub struct API {
    url: String,
    token: String
}

/// Base API implementation
impl API {
    /// Creates an API instance.
    ///
    pub fn new() -> API {
        API { 
            url: env::var("TXTAI_API_URL").unwrap_or(String::from("")),
            token: env::var("TXTAI_API_TOKEN").unwrap_or(String::from(""))
        }
    }

    /// Creates an API instance.
    /// 
    /// # Arguments
    /// * `url` - API url
    pub fn with_url(url: &str) -> API {
        API { 
            url: url.to_string(),
            token: env::var("TXTAI_API_TOKEN").unwrap_or(String::from(""))
        }
    }

    /// Creates an API instance.
    /// 
    /// # Arguments
    /// * `url` - API url
    /// * `token` - API token
    pub fn with_url_token(url: &str, token: &str) -> API {
        API { 
            url: url.to_string(),
            token: token.to_string()
        }
    }

    /// Executes a GET request. Returns Response.
    /// 
    /// # Arguments
    /// * `method` - API method
    /// * `params` - List of (name, value) tuples to use as query parameters
    pub async fn get(&self, method: &str, params: &[(&str, &str)]) -> APIResponse {
        // Generate url
        let url = format!("{url}/{method}", url=self.url, method=method);

        // Create client
        let client = reqwest::Client::new();
        let mut request = client.get(&url);

        // Set headers
        request = self.headers(request);

        // Execute API call
        Ok(request.query(&params).send().await?)
    }

    /// Executes a POST request. Returns Response.
    /// 
    /// # Arguments
    /// * `method` - API method
    /// * `json` - Value object with post body 
    pub async fn post(&self, method: &str, json: &Value) -> APIResponse {
        // Generate url
        let url = format!("{url}/{method}", url=self.url, method=method);

        // Create client
        let client = reqwest::Client::new();
        let mut request = client.post(&url);

        // Set headers
        request = self.headers(request);

        // Execute API call
        Ok(request.json(&json).send().await?)
    }

    /// Sets headers on a request. 
    ///
    /// # Arguments
    //  * `request` - RequestBuilder
    pub fn headers(&self, request: RequestBuilder) -> RequestBuilder {
        // Authorization header
        if self.token != "" {
            return request.header("Authorization", format!("Bearer {token}", token=self.token))
        }
        return request
    }
}

// Index result
#[derive(Debug, Deserialize)]
pub struct IndexResult {
    pub id: usize,
    pub score: f32
}

// Text result that handles String and Vector of Strings
#[derive(Debug, Deserialize, EnumAsInner)]
#[serde(untagged)]
pub enum Text {
    String(String),
    List(Vec<String>)
}