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

use serde_json::json;

pub use crate::api::{API, Texts, TextsBatch};

/// Textractor definition
pub struct Textractor {
    api: API
}

/// Textractor implementation
impl Textractor {
    /// Creates a Textractor instance.
    /// 
    pub fn new() -> Textractor {
        Textractor { 
            api: API::new()
        }
    }

    /// Creates a Textractor instance.
    /// 
    /// # Arguments
    /// * `url` - API url
    pub fn with_url(url: &str) -> Textractor {
        Textractor {
            api: API::with_url(url) 
        }
    }

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

    /// Extracts text from a file at path.
    ///  
    /// # Arguments
    /// * `file` file to extract text
    pub async fn textract(&self, file: &str) -> Texts {
        // Query parameters
        let params = [("file", file)];

        // Execute API call
        Ok(self.api.get("textract", &params).await?.json().await?)
    }

    /// Extracts text from a file at path.
    ///  
    /// # Arguments
    /// * `files` file to extract text
    pub async fn batchtextract(&self, files: &Vec<&str>) -> TextsBatch {
        // Post parameters
        let params = json!(files);

        // Execute API call
        Ok(self.api.post("batchtextract", &params).await?.json().await?)
    }
}