Struct ConvertResult 

pub struct ConvertResult {
    pub markdown: String,
    pub document_id: Option<String>,
    pub filename: Option<String>,
}

Result from the /convert endpoint.

document_id is populated when akribes-server has S3 persistence configured (the default in prod). Callers that want to re-use the uploaded file as a document-typed input on a subsequent /run call should pass this id instead of the converted markdown.

Fields

markdown: String

document_id: Option<String>

filename: Option<String>

Trait Implementations

impl Clone for ConvertResult

fn clone(&self) -> ConvertResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvertResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConvertResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConvertResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.