Add Field Definitions
Adds new fields to the global BASE_FIELD_DEFINITIONS registry in prompture/field_definitions.py.
Before Starting
Ask the user for each field:
- Field name — lowercase, underscore-separated (e.g.
linkedin_url, blood_type)
- Category — Person, Contact, Professional, Financial, Location, Education, Demographic, Social Media, Task Management, or a new one
- Type —
str, int, float, bool, list, dict
- Description — what this field represents
- Instructions — how the LLM should extract or compute the value
- Default — type-appropriate:
"" for str, 0 for int, 0.0 for float, [] for list, False for bool
- Nullable —
True if the field can legitimately be absent
- Enum values (optional) — list of allowed string values
Field Structure
"field_name": {
"type": str,
"description": "What this field represents.",
"instructions": "How the LLM should extract or compute this value.",
"default": "",
"nullable": False,
},
Optional keys
"enum": ["low", "medium", "high"]
- Template variables in
instructions: {{current_year}}, {{current_date}}, {{current_datetime}}, {{current_month}}, {{current_day}}, {{current_weekday}}, {{current_iso_week}}
Steps
1. Edit prompture/field_definitions.py
Add fields to BASE_FIELD_DEFINITIONS under the right category comment. If the category is new, add a comment header:
# ── Medical Fields ──────────────────────────────────
Alphabetical order within each category.
2. Verify
python -c "from prompture.field_definitions import get_field_definition; print(get_field_definition('field_name'))"
pytest tests/test_field_definitions.py -x -q
1---2name: add-field3description: Add predefined field definitions to the Prompture field registry. Handles field structure, categories, template variables, enum support, and thread-safe registration. Use when adding reusable extraction fields.4metadata:5 source: https://skillmd.com/skills/jhd3197/add-field6 author: prompture7 version: "1.0"8---910# Add Field Definitions1112Adds new fields to the global `BASE_FIELD_DEFINITIONS` registry in `prompture/field_definitions.py`.1314## Before Starting1516Ask the user for each field:17- **Field name** — lowercase, underscore-separated (e.g. `linkedin_url`, `blood_type`)18- **Category** — Person, Contact, Professional, Financial, Location, Education, Demographic, Social Media, Task Management, or a new one19- **Type** — `str`, `int`, `float`, `bool`, `list`, `dict`20- **Description** — what this field represents21- **Instructions** — how the LLM should extract or compute the value22- **Default** — type-appropriate: `""` for str, `0` for int, `0.0` for float, `[]` for list, `False` for bool23- **Nullable** — `True` if the field can legitimately be absent24- **Enum values** (optional) — list of allowed string values2526## Field Structure2728```python29"field_name": {30 "type": str,31 "description": "What this field represents.",32 "instructions": "How the LLM should extract or compute this value.",33 "default": "",34 "nullable": False,35},36```3738### Optional keys3940- `"enum"`: `["low", "medium", "high"]`41- Template variables in `instructions`: `{{current_year}}`, `{{current_date}}`, `{{current_datetime}}`, `{{current_month}}`, `{{current_day}}`, `{{current_weekday}}`, `{{current_iso_week}}`4243## Steps4445### 1. Edit `prompture/field_definitions.py`4647Add fields to `BASE_FIELD_DEFINITIONS` under the right category comment. If the category is new, add a comment header:4849```python50 # ── Medical Fields ──────────────────────────────────51```5253Alphabetical order within each category.5455### 2. Verify5657```bash58python -c "from prompture.field_definitions import get_field_definition; print(get_field_definition('field_name'))"59pytest tests/test_field_definitions.py -x -q60```