Skip to main content

PictureDescriptionOptions

Struct PictureDescriptionOptions 

Source
pub struct PictureDescriptionOptions {
    pub endpoint: String,
    pub model: String,
    pub api_key: Option<String>,
    pub prompt: Option<String>,
    pub mode: PictureDescriptionMode,
    pub concurrency: usize,
}
Expand description

The picture-description pass (#670): every picture of a document — a DOCX/PPTX/XLSX/HTML embedded image, a PDF figure crop, a sampled video frame — goes to an OpenAI-compatible vision endpoint and the answer becomes its description annotation (meta.description in docling JSON, printed after the caption in Markdown). MarkItDown’s llm_client / llm_model / llm_prompt and its markitdown-ocr plugin, on every format and surface. Endpoint, model and key fall back to the DOCLING_RS_VLM_* environment like the page pipeline’s; the prompt does not (DOCLING_RS_VLM_PROMPT asks for a page’s markup, not a caption).

Fields§

§endpoint: String

The server’s /v1 base or the full …/chat/completions URL.

§model: String

Model name as the server knows it.

§api_key: Option<String>

Bearer token, if the endpoint wants one.

§prompt: Option<String>

The instruction sent with every picture; None = the mode’s prompt.

§mode: PictureDescriptionMode

Caption or OCR.

§concurrency: usize

Pictures in flight at once (default 1; the endpoint’s rate limit sets the ceiling — 429s retry with backoff).

Implementations§

Source§

impl PictureDescriptionOptions

Source

pub fn resolve( endpoint: Option<String>, model: Option<String>, ) -> Result<Self, ConversionError>

Build options from explicit values, the endpoint, model and key falling back to the DOCLING_RS_VLM_* environment. Endpoint and model are required.

Source

pub fn prompt(&self) -> &str

The prompt in force: the explicit one, else the mode’s.

Source

pub fn provenance(&self) -> String

created_by of the descriptions this produces: the model name.

Source

pub fn describe( &self, agent: &Agent, mimetype: &str, image: &[u8], ) -> Result<Option<String>, RequestError>

Ask the endpoint about one image (mimetype as the data URI says it). The retry policy is the page loop’s; an empty answer is None, the way MarkItDown reads a blank completion as “no text”.

Trait Implementations§

Source§

impl Clone for PictureDescriptionOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PictureDescriptionOptions

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V