Struct OcrRequest 

pub struct OcrRequest {
    pub body: OcrBody,
    /* private fields */
}

OCR recognition request encoded as multipart/form-data.

Builder for the OCR endpoint. Set the image via OcrRequest::with_file_path, then call OcrRequest::send_via.

Fields

body: OcrBody

Multipart form fields (tool type, language, …).

Implementations

impl OcrRequest

pub fn new() -> Self

Create a new OCR request with default options.

pub fn with_file_path(self, path: impl Into<PathBuf>) -> Self

Set the local image file path to recognize (required).

pub fn with_tool_type(self, tool_type: OcrToolType) -> Self

Set the OCR tool type (e.g. handwriting).

pub fn with_language_type(self, language_type: OcrLanguageType) -> Self

Set the document language.

pub fn with_probability(self, probability: bool) -> Self

Whether to return per-character recognition probabilities.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Set the client-side request id.

pub fn with_user_id(self, user_id: impl Into<String>) -> Self

Set the end-user id.

pub fn validate(&self) -> ZaiResult<()>

Validate the request: body constraints, file existence, size (≤8MB), and supported extension (png/jpg/jpeg/bmp).

pub async fn send_via(&self, client: &ZaiClient) -> ZaiResult<OcrResponse>

Submit the multipart request via a ZaiClient and parse the typed OCR response.

Trait Implementations

impl Default for OcrRequest

fn default() -> Self

Returns the “default value” for a type.