docling_rs 0.1.2

Rust SDK for Docling Serve that makes document conversion simple, reliable, and production-ready in Rust
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use super::enums::*;

// ============================================================================
// Response types
// ============================================================================

/// The converted document content in various formats.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ExportDocumentResponse {
    /// Original filename.
    pub filename: String,

    /// Markdown content (if requested).
    pub md_content: Option<String>,

    /// Structured JSON content (if requested). Uses generic Value
    /// because DoclingDocument is a very deep schema.
    pub json_content: Option<serde_json::Value>,

    /// HTML content (if requested).
    pub html_content: Option<String>,

    /// Plain text content (if requested).
    pub text_content: Option<String>,

    /// DocTags content (if requested).
    pub doctags_content: Option<String>,
}

/// An error that occurred during conversion.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ErrorItem {
    pub component_type: DoclingComponentType,
    pub module_name: String,
    pub error_message: String,
}

/// Profiling information for a conversion step.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ProfilingItem {
    pub scope: ProfilingScope,
    #[serde(default)]
    pub count: i64,
    #[serde(default)]
    pub times: Vec<f64>,
    #[serde(default)]
    pub start_timestamps: Vec<String>,
}

/// Response from `POST /v1/convert/source` (synchronous conversion).
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ConvertDocumentResponse {
    /// The converted document.
    pub document: ExportDocumentResponse,

    /// Conversion status.
    pub status: ConversionStatus,

    /// Errors encountered during conversion.
    #[serde(default)]
    pub errors: Vec<ErrorItem>,

    /// Total processing time in seconds.
    pub processing_time: f64,

    /// Detailed profiling timings.
    #[serde(default)]
    pub timings: HashMap<String, ProfilingItem>,
}

/// Response when target is S3/presigned URL (not in-body).
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct PresignedUrlConvertDocumentResponse {
    pub processing_time: f64,
    pub num_converted: i64,
    pub num_succeeded: i64,
    pub num_failed: i64,
}

// ============================================================================
// Async task types
// ============================================================================

/// Processing metadata for an async task.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct TaskProcessingMeta {
    pub num_docs: i64,
    #[serde(default)]
    pub num_processed: i64,
    #[serde(default)]
    pub num_succeeded: i64,
    #[serde(default)]
    pub num_failed: i64,
}

/// Response from async task submission and status polling.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct TaskStatusResponse {
    /// Unique identifier for the task.
    pub task_id: String,

    /// Type of task (convert or chunk).
    pub task_type: TaskType,

    /// Current status string (e.g. "PENDING", "SUCCESS", "FAILURE").
    pub task_status: String,

    /// Position in queue (if waiting).
    pub task_position: Option<i64>,

    /// Processing progress metadata.
    pub task_meta: Option<TaskProcessingMeta>,
}

// ============================================================================
// Health / version
// ============================================================================

/// Response from `GET /health`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct HealthCheckResponse {
    #[serde(default = "default_health_status")]
    pub status: String,
}

fn default_health_status() -> String {
    "ok".to_string()
}

// ============================================================================
// Validation error types (HTTP 422 responses)
// ============================================================================

/// A single validation error detail from the server.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ValidationErrorDetail {
    pub loc: Vec<serde_json::Value>,
    pub msg: String,
    #[serde(rename = "type")]
    pub error_type: String,
}

/// HTTP validation error response (422).
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct HttpValidationError {
    #[serde(default)]
    pub detail: Vec<ValidationErrorDetail>,
}