liter-llm 1.6.3

Universal LLM API client — 142+ providers, streaming, tool calling. Rust-powered, type-safe, compiled.
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

//! Types for document OCR (optical character recognition) requests and responses.

use serde::{Deserialize, Serialize};

use super::common::Usage;

/// An OCR request.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct OcrRequest {
    /// The model/provider to use (e.g. `"mistral/mistral-ocr-latest"`).
    pub model: String,
    /// The document to process (URL or base64).
    pub document: OcrDocument,
    /// Specific pages to process (1-indexed). `None` means all pages.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pages: Option<Vec<u32>>,
    /// Whether to include base64-encoded images of each processed page.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub include_image_base64: Option<bool>,
}

/// Document input for OCR — either a URL or inline base64 data.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum OcrDocument {
    /// A publicly accessible document URL.
    #[serde(rename = "document_url")]
    Url {
        /// The document URL (HTTP/HTTPS).
        url: String,
    },
    /// Inline base64-encoded document data.
    #[serde(rename = "base64")]
    Base64 {
        /// Base64-encoded document content.
        data: String,
        /// MIME type (e.g. `"application/pdf"`, `"image/png"`, `"image/jpeg"`).
        media_type: String,
    },
}

#[cfg_attr(alef, alef(skip))]
impl Default for OcrDocument {
    fn default() -> Self {
        Self::Url { url: String::new() }
    }
}

/// An OCR response.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OcrResponse {
    /// Extracted pages in order.
    pub pages: Vec<OcrPage>,
    /// Model/provider used for OCR.
    pub model: String,
    /// Token usage, if reported by the provider.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub usage: Option<Usage>,
}

/// A single page of OCR output.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OcrPage {
    /// Page index (0-based).
    pub index: u32,
    /// Extracted page content as Markdown.
    pub markdown: String,
    /// Embedded images extracted from the page (if `include_image_base64` was true).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub images: Option<Vec<OcrImage>>,
    /// Page dimensions in pixels, if available.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dimensions: Option<PageDimensions>,
}

/// An image extracted from an OCR page.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OcrImage {
    /// Unique image identifier within the document.
    pub id: String,
    /// Base64-encoded image data (if `include_image_base64` was true).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub image_base64: Option<String>,
}

/// Page dimensions in pixels.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PageDimensions {
    /// Width in pixels.
    pub width: u32,
    /// Height in pixels.
    pub height: u32,
}