📘 Overview

FileOrURLToMarkdownConverterAPI is an operator that utilizes the official API of MinerU for knowledge extraction, it supports extracting structured content from multiple file formats (e.g., PDF, Office documents, web pages, plain text) and URLs, converting them into a unified Markdown format. The operator automatically detects the file type and invokes the optimal parsing engine (such as MinerU or trafilatura) to preserve the original layout and key information.

init Function

def __init__(self, intermediate_dir: str = "intermediate", mineru_backend: str = "vlm", api_key:str = None):

init Parameter Description

Parameter	Type	Default	Description
intermediate_dir	str	"intermediate"	Directory path used to store intermediate files generated during the conversion process.
api_key	str	None	Specifies the API key for accessing external MinerU services.
mineru_backend	str	"vlm"	Specifies the backend engine for MinerU, used for handling complex documents such as PDFs. Options include "pipeline", "vlm-transformers", "MinerU-HTML".

Prompt Template Description

Prompt Template Name	Main Purpose	Applicable Scenario	Characteristics
--	--	--	--

run Function

def run(self, storage: DataFlowStorage, input_key: str = "source", output_key: str = "text_path"):

Parameters

Name	Type	Default	Description
storage	DataFlowStorage	Required	Data flow storage instance responsible for reading and writing data.
input_key	str	"source"	Input column name containing the file path or URL to be processed.
output_key	str	"text_path"	Output column name that stores the path to the generated Markdown file.

🧠 Example Usage

self.knowledge_cleaning_step1 = FileOrURLToMarkdownConverterAPI(
    intermediate_dir="../example_data/KBCleaningPipeline/raw/",
    api_key="your-api-key-here",
    mineru_backend="vlm",
)
self.knowledge_cleaning_step1.run(
    storage=self.storage.step(),
    # input_key=,
    # output_key=,
)

🧾 Default Output Format

Field	Type	Description
source	str	Input source file path or URL.
text_path	str	Path to the generated Markdown file.

Example Input:

{
"source":"/path/to/your/document.pdf"
}

Example Output:

{
"source":"/path/to/your/document.pdf",
"text_path":"intermediate/document_pdf.md"
}