Class MarkItDown.Builder

java.lang.Object

io.github.cyber655.markitdown.MarkItDown.Builder

Enclosing class:

MarkItDown

public static final class MarkItDown.Builder
extends Object

Builder for MarkItDown.

Method Summary

Modifier and Type	Method	Description
MarkItDown	build()	Builds an immutable client.
MarkItDown.Builder	environment(String key, String value)	Adds an environment variable for the subprocess (e.g.
MarkItDown.Builder	executable(String executable)	Path to (or name of) the markitdown executable.
MarkItDown.Builder	timeout(Duration timeout)	Maximum time to wait for a single conversion.
MarkItDown.Builder	usePlugins(boolean usePlugins)	Enables third-party plugins for every conversion (maps to -p).
MarkItDown.Builder	workingDirectory(Path workingDirectory)	Working directory for the subprocess.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

executable

public MarkItDown.Builder executable(String executable)

Path to (or name of) the markitdown executable. Defaults to "markitdown", which is resolved against the PATH.

timeout

public MarkItDown.Builder timeout(Duration timeout)

Maximum time to wait for a single conversion. Defaults to no timeout.

workingDirectory

public MarkItDown.Builder workingDirectory(Path workingDirectory)

Working directory for the subprocess. Defaults to the JVM's working directory.

environment

public MarkItDown.Builder environment(String key,
 String value)

Adds an environment variable for the subprocess (e.g. an Azure API key).

usePlugins

public MarkItDown.Builder usePlugins(boolean usePlugins)

Enables third-party plugins for every conversion (maps to -p).

build

public MarkItDown build()

Builds an immutable client.