wpsparser
v0.1.0
Published
Simple document parser powered by LlamaParse v2
Downloads
17
Maintainers
Readme
wpsparser
Simple document parser powered by LlamaParse v2. Zero dependencies, Node 18+.
Install
npm install wpsparserQuick Start
Set your API key:
export LLAMA_CLOUD_API_KEY=llx-...Parse a document:
import { parse } from "wpsparser";
const result = await parse("./document.pdf");
console.log(result.markdown);Advanced Usage
import { WPSParser } from "wpsparser";
const parser = new WPSParser({ apiKey: "llx-..." });
// Parse with options
const result = await parser.parse("./document.pdf", {
tier: "agentic",
processing_options: { language: "fr" },
});
// Parse a buffer
const buffer = fs.readFileSync("./document.pdf");
const result = await parser.parse(buffer, {
fileName: "document.pdf",
});API
parse(input, options?)
Uploads a document, waits for parsing to complete, and returns the result.
Input: file path (string) or file contents (Buffer | Uint8Array)
Options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| tier | string | "fast" | Parsing tier: fast, cost_effective, agentic, agentic_plus |
| version | string | "latest" | API version |
| apiKey | string | env var | Override API key |
| expand | string[] | ["markdown_full", "text_full"] | Fields to expand |
| pollIntervalMs | number | 1000 | Polling interval in ms |
| timeoutMs | number | 300000 | Max wait time in ms |
| fileName | string | "document" | Filename hint for buffer input |
| mimeType | string | auto-detected | MIME type for buffer input |
| signal | AbortSignal | — | Cancellation signal |
| processing_options | object | — | LlamaParse processing options (language, disable_ocr, etc.) |
| agentic_options | object | — | Agentic options (custom_prompt) |
| page_ranges | object | — | Page range options (max_pages, target_pages) |
| disable_cache | boolean | — | Disable document caching |
Returns: ParseResult
interface ParseResult {
markdown: string; // Full markdown output
text: string; // Full text output
job: JobResponse; // Job metadata (id, status, etc.)
_raw: object; // Raw API response
}new WPSParser(config?)
Create an instance with explicit configuration.
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| apiKey | string | LLAMA_CLOUD_API_KEY | API key |
| baseUrl | string | https://api.cloud.llamaindex.ai | API base URL |
License
MIT
