diff --git a/AGENTS.md b/AGENTS.md index 923ead4..2c47453 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,5 +6,6 @@ Each skill lives under `plugins//skills//SKILL.md`. Rea ## Available Skills -- **nutrient-dws / document-processor-api** — Convert, extract, transform, and secure documents via the Nutrient Document Web Services API (Python scripts via `uv`). +- **nutrient-dws / document-processor-api** — Convert, transform, redact, sign, watermark, OCR, and secure documents via the Nutrient DWS Processor API (Python scripts via `uv`). +- **nutrient-dws / document-extraction-api** — Parse documents into a structural model (typed elements with bounds) or whole-document Markdown via the Nutrient DWS Data Extraction API (`/extraction/parse`). Use for RAG ingestion, layout analysis, and form/invoice extraction. - **pdf-to-markdown / pdf-to-markdown** — Extract text from PDFs as structured, semantic Markdown. Use when converting a PDF to Markdown, extracting text from a PDF, or processing one or more PDFs into Markdown output. diff --git a/plugins/nutrient-dws/skills/document-extraction-api/.gitignore b/plugins/nutrient-dws/skills/document-extraction-api/.gitignore new file mode 100644 index 0000000..7a60b85 --- /dev/null +++ b/plugins/nutrient-dws/skills/document-extraction-api/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +*.pyc diff --git a/plugins/nutrient-dws/skills/document-extraction-api/SKILL.md b/plugins/nutrient-dws/skills/document-extraction-api/SKILL.md new file mode 100644 index 0000000..2fc4f57 --- /dev/null +++ b/plugins/nutrient-dws/skills/document-extraction-api/SKILL.md @@ -0,0 +1,151 @@ +--- +name: document-extraction-api +description: >- + Parse documents into a structural model or whole-document Markdown via the Nutrient Data + Extraction API (`/extraction/parse`). Use when the user wants to extract layout, tables, + key-value pairs, formulas, or images with bounding boxes; build a RAG ingestion pipeline; + produce Markdown for search indexing or content migration; or run layout-aware document + understanding. Triggers include parse this document, extract layout, RAG pipeline, document + understanding, form/invoice extraction, layout analysis, or whole-document Markdown. +license: MIT +metadata: + author: nutrient-sdk + version: "1.0" + homepage: "https://www.nutrient.io/api/" + repository: "https://github.com/PSPDFKit-labs/nutrient-skills" + compatibility: "Requires Python 3.10+, uv, and internet. Works with Claude Code, Codex CLI, Gemini CLI, OpenCode, Cursor, Windsurf, GitHub Copilot, Amp, or any Agent Skills-compatible product." + short-description: "Parse documents into a structural model or Markdown via Nutrient Data Extraction" +--- + +# Nutrient Data Extraction + +Use Nutrient DWS Extract for document-understanding workflows where you need typed +elements (paragraphs, tables, formulas, pictures, key-value regions, handwriting) with +bounding boxes — or a clean Markdown representation of the whole document. + +## When to use + +- Build a RAG ingestion pipeline: PDF -> Markdown -> chunks -> embeddings. +- Index content for search or migrate documents into a new CMS. +- Extract structured fields from forms and invoices (key/value pairs, tables, semantic regions). +- Reconstruct page layout for downstream rendering or comparison. +- Run layout-aware document understanding (semantic paragraph roles, table cell spans, + formulas in LaTeX, picture classification and alt descriptions). + +This skill is **only** for `/extraction/parse`. For PDF generation, conversion, OCR, +redaction, signing, watermarking, or any `/build`-based workflow, use the sibling +`document-processor-api` skill. + +## Setup + +DWS Extract is a separate product from DWS Processor and has its own API key. + +- Get a Nutrient DWS Extract API key at . +- Export it as `NUTRIENT_EXTRACT_API_KEY`: + ```bash + export NUTRIENT_EXTRACT_API_KEY="pdf_live_..." + ``` +- Scripts live in `scripts/` relative to this SKILL.md. Use the directory containing this + SKILL.md as the working directory: + ```bash + cd && uv run scripts/