extract-resume · diff
git:20260726.d1ce024 to git:20260830.c89ff82
38 added, 0 removed. Audit A to A.
---
name: extract-resume
description: Parse a resume's uploaded PDF into structured JSON (basics, experience, projects, skills, education) and save it to the editor.
argument-hint: "[resume-id] [--force]"
---
# Extract Resume - Source PDF → Structured Data
Read a resume's uploaded source PDF and produce JSON matching the JobPilot resume schema, then save via the API. Inverse of the editor.
## Setup
Follow `../_shared/setup.md`. The profile response provides `user.primaryResumeId`, `primaryResumeSourceAbsolutePath`, and `resumes` (every base with `id`, `label`, `sourceFilename`, `hasData`, `isPrimary`).
## Step 1: Resolve Target
Parse the argument:
- Integer → use that resume id.
- Empty → use `user.primaryResumeId`. If no primary, stop:
> No primary resume set. Pass an explicit id, or set a primary at <$JOBPILOT_WEB/resumes>.
- `--force` (anywhere) → overwrite existing structured data. Otherwise refuse to overwrite (Step 3).
Let `RESUME_ID` be the resolved id, `FORCE` be `true`/`false`.
```bash
curl -fsS -H "authorization: Bearer $JOBPILOT_API_TOKEN" "$JOBPILOT_API/api/resumes/$RESUME_ID"
```
If 404, stop and report the id doesn't exist.
## Step 2: Verify Source PDF
`sourceFilename` must be set. If `null`, stop:
> Resume {id} ({label}) has no uploaded source PDF. Upload one at <$JOBPILOT_WEB/resumes/{id}>, then re-run.
Resolve the absolute path:
- Primary resume → prefer `primaryResumeSourceAbsolutePath`.
- Otherwise → `${JOBPILOT_WORKSPACE_ROOT}/apps/api/storage/resumes/{sourceFilename}`.
If `sourceMimeType !== "application/pdf"`, stop and ask the user to re-upload as PDF.
## Step 3: Refuse to Clobber
If `content` is non-null and `FORCE === false`, stop:
> Resume {id} ({label}) already has structured data (version {n}). Edit at <$JOBPILOT_WEB/resumes/{id}>, or re-run with `--force` to overwrite from the PDF.
If `FORCE`, proceed and overwrite.
## Step 4: Read and Parse
`Read` the PDF at the path from Step 2. Produce a single JSON object matching:
```ts
{
basics: {
name: string, // required
headline?: string, // professional title/headline if present
email?: string,
phone?: string,
website?: string,
linkedin?: string,
github?: string,
location?: string,
},
summary?: string, // 1–3 sentences
experience: Array<{
company: string,
title: string,
location?: string,
start: string, // free-form, e.g. "Jul 2022"
end?: string, // omit or "Present" if current
bullets: string[],
}>,
projects: Array<{
name: string,
url?: string,
description?: string, // one prose line; omit if there's only a tech-stack line
bullets: string[],
keywords: string[], // the tech-stack line (e.g. "Next.js, Prisma, Docker")
start?: string, // only if the PDF states it; same format as experience dates
end?: string, // "Present" if ongoing
}>,
skills: Array<{
group: string, // e.g. "Languages"
items: string[],
}>,
education: Array<{
school: string,
degree: string,
start?: string,
end?: string,
details: string[],
}>,
+ publications: Array<{
+ title: string,
+ authors?: string, // the citation's author list, verbatim, et al. included
+ venue?: string, // journal, conference, or publisher
+ year?: string, // free-form: "2024", "In press", "Under review"
+ url?: string,
+ doi?: string,
+ }>,
+ awards: Array<{
+ title: string,
+ issuer?: string,
+ year?: string,
+ description?: string,
+ }>,
+ certifications: Array<{
+ name: string,
+ issuer?: string,
+ issued?: string,
+ expires?: string,
+ credentialId?: string,
+ url?: string,
+ }>,
+ sections: Array<{ // anything above doesn't model - see the rule below
+ title: string, // the PDF's own heading, verbatim ("Grants", "Invited Talks")
+ entries: Array<{
+ heading: string, // the entry's first line - a grant name, a talk title
+ subheading?: string, // funder, host, venue
+ meta?: string, // year, amount, or other right-aligned detail
+ bullets: string[],
+ }>,
+ }>,
}
```
Hard rules:
- **Preserve verbatim** dates, employers, titles, schools, degrees, contact info.
- **Do not invent** roles, bullets, dates, or skills. Missing section → `[]` (or omit optional field).
- Keep the PDF's date display format. Do not normalize to ISO.
- Current role → `end: "Present"` (or omit).
- Project dates: copy when the PDF shows them, omit otherwise - never infer a range. They let
`tailor-resume` promote a project onto the timeline, so a guess becomes a fabricated range.
- Skills: keep the PDF's grouping if present; flat list → single group `"Skills"`.
- Strip leading bullet glyphs (•, ▪, –) from bullet text; keep the rest unchanged.
- A project's tech-stack line goes in `keywords` only - never copy it into `description`.
- For long PDFs, use `Read` with `pages` to ingest all pages - don't silently drop later-page entries.
+ - **Never drop a section because there is no field for it.** Anything the shape above doesn't model
+ becomes a `sections[]` entry under the PDF's own heading: grants and funding, invited talks and
+ presentations, patents, teaching, academic service, professional memberships, volunteering,
+ languages. An academic CV is mostly these, and dropping them silently guts the resume.
+ - Publications: one entry per citation, in the PDF's order. Split the citation into `authors`,
+ `title`, `venue` and `year` only where the split is unambiguous; when it is not, put the whole
+ citation in `title` rather than guessing where the venue ends.
## Step 5: Save
The PUT body must be `{ "content": <resume-object> }` - the API rejects a bare resume payload with 400 "label or content required". Write the file with that wrapper, then send it:
```bash
curl -fsS -H "authorization: Bearer $JOBPILOT_API_TOKEN" -X PUT "$JOBPILOT_API/api/resumes/$RESUME_ID" \
-H "Content-Type: application/json" \
--data-binary @resume.json
```
Where `resume.json` looks like `{"content": {"basics": {...}, "experience": [...], ...}}`. On 422, read the issue list, fix the field, retry once.
## Step 6: Suggest Improvements
**Only on a first extraction** (`content` was `null` in Step 1): invoke the `review-resume` skill for `$RESUME_ID`. This step is faithful to the PDF, so it carries over every weakness in it; that skill proposes a stronger version for the user to accept or discard.
Skip on `--force` - the user re-parsed to recover what the PDF says, and a rewrite proposal fights that.
## Step 7: Report
> Extracted resume {id} ({label}) → version {n}.
> Review at <$JOBPILOT_WEB/resumes/{id}>.
Do not echo the parsed fields - the editor and preview show them.