Skip to main content

DatalabClient

Struct DatalabClient 

Source
pub struct DatalabClient { /* private fields */ }
Expand description

Async client for the DataLab Marker REST API.

§Authentication

All requests require an API key sent via the X-API-Key header. Create the client with DatalabClient::new or load from the DATALAB_API_KEY environment variable with DatalabClient::from_env.

§Usage

use papers_datalab::{DatalabClient, MarkerRequest, OutputFormat, ProcessingMode};

let client = DatalabClient::from_env()?;
let pdf_bytes = std::fs::read("paper.pdf").unwrap();

let result = client.convert_document(MarkerRequest {
    file: Some(pdf_bytes),
    filename: Some("paper.pdf".into()),
    output_format: vec![OutputFormat::Markdown],
    mode: ProcessingMode::Accurate,
    ..Default::default()
}).await?;

println!("{}", result.markdown.unwrap_or_default());

Implementations§

Source§

impl DatalabClient

Source

pub fn new(api_key: impl Into<String>) -> Self

Create a new client with an explicit API key.

Source

pub fn with_base_url(self, url: impl Into<String>) -> Self

Override the base URL. Useful for testing with a mock server.

Source

pub fn from_env() -> Result<Self>

Create a client from the DATALAB_API_KEY environment variable.

Returns DatalabError::MissingApiKey if the variable is not set.

Source

pub async fn convert_document( &self, req: MarkerRequest, ) -> Result<MarkerPollResponse>

High-level: submit a document and poll until conversion is complete.

Uses a 2-second poll interval. Returns the completed MarkerPollResponse or an error if the job fails. No timeout is applied — the caller is responsible for cancellation if needed.

Source

pub async fn submit_marker( &self, req: MarkerRequest, ) -> Result<MarkerSubmitResponse>

POST /api/v1/marker — submit a conversion job.

Returns immediately with a request_id. Use get_marker_result to poll for the result, or call convert_document to do both.

Source

pub async fn get_marker_result( &self, request_id: &str, ) -> Result<MarkerPollResponse>

GET /api/v1/marker/{request_id} — poll for a single conversion result.

Returns the current state of the job. status will be processing, complete, or failed. Poll every 2 seconds until complete or failed.

Source

pub async fn list_step_types(&self) -> Result<StepTypesResponse>

GET /api/v1/workflows/step-types — list available workflow step types.

Trait Implementations§

Source§

impl Clone for DatalabClient

Source§

fn clone(&self) -> DatalabClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more