spatio_sdk/models/extract_text_result.rs
1/*
2 * SpatioAPI
3 *
4 * The REST API that owns every resource in your Spatio workspace: notes, sheets, slides, tasks, calendar events, mail, chat, files, and contacts. SpatioMCP wraps this API; Spatio Desktop reads from it. You can call it directly from your own code. All requests must be authenticated with a Personal Access Token (`Authorization: Bearer pat_...`) or an OAuth 2.1 access token, and use HTTPS. Official SDKs (MIT, generated from this spec on every release): - TypeScript: https://github.com/spatio-labs/spatio-ts (`npm install @spatio-labs/spatio-ts`) - Python: https://github.com/spatio-labs/spatio-py (`pip install spatio-sdk`) - Go: https://github.com/spatio-labs/spatio-go (`go get github.com/spatio-labs/spatio-go`) This specification is generated from the platform-service Go source on every push to `main`. The spec, not hand-written documentation, is the source of truth: server stubs and SDKs are generated from it, and any drift between the spec and the running service fails CI.
5 *
6 * The version of the OpenAPI document: v1
7 * Contact: hello@spatio.app
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// ExtractTextResult : Extracted text + structural metadata from a PDF (or other extraction-supported file type). `pages` is provider-shaped — treat as an opaque per-page object array. Endpoint returns `422` with `code: extraction_unsupported` when the underlying file isn't extractable.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct ExtractTextResult {
17 #[serde(rename = "text")]
18 pub text: String,
19 #[serde(rename = "pageCount")]
20 pub page_count: i32,
21 #[serde(rename = "pages", skip_serializing_if = "Option::is_none")]
22 pub pages: Option<Vec<std::collections::HashMap<String, serde_json::Value>>>,
23 /// `true` when `maxChars` was hit before the end.
24 #[serde(rename = "truncated", skip_serializing_if = "Option::is_none")]
25 pub truncated: Option<bool>,
26}
27
28impl ExtractTextResult {
29 /// Extracted text + structural metadata from a PDF (or other extraction-supported file type). `pages` is provider-shaped — treat as an opaque per-page object array. Endpoint returns `422` with `code: extraction_unsupported` when the underlying file isn't extractable.
30 pub fn new(text: String, page_count: i32) -> ExtractTextResult {
31 ExtractTextResult {
32 text,
33 page_count,
34 pages: None,
35 truncated: None,
36 }
37 }
38}
39