Metadata Schema

OpenConstruction metadata fields

This page documents the complete metadata fields currently used in OpenConstruction catalogs: Datasets, Models, Use Cases, and Open Educational Resources (OER). It also shows how to publish structured data (JSON-LD) that aligns with schema.org.

Note: Some OpenConstruction fields (e.g., added_date, contributor, num_images) do not have a single dedicated schema.org property. For structured data, publish them via additionalProperty (PropertyValue) or variableMeasured, and keep the raw fields in the catalog.

Datasets

From use-cases.json

OER

15 fields

From oer.json

Datasets

Dataset fields in `datasets.json`

Structured data recommendation: @type: Dataset with creator, license, keywords, identifier, and distribution where applicable.

Field	Required	Schema.org mapping	Description
`access`	No	schema.org:url / schema.org:sameAs	Direct download URL or access page.
`added_date`	No	(catalog metadata) —	Date added to OpenConstruction catalog (YYYY-MM-DD).
`annotation_types`	No	schema.org:keywords	Label/annotation types (e.g., bbox, segmentation).
`authors`	No	schema.org:creator	Creators/authors of the dataset (string or list).
`classes`	No	schema.org:variableMeasured / additionalProperty	List of class names.
`contributor`	No	schema.org:additionalProperty	GitHub handle or name of submitter.
`contributor_url`	No	schema.org:additionalProperty	Profile/org URL for submitter.
`data_modality`	No	schema.org:keywords	Primary modality (e.g., images, point clouds).
`doi`	No	schema.org:identifier	DOI if available.
`geographical_location`	No	schema.org:variableMeasured / additionalProperty	Location/region covered (if relevant).
`id`	Yes	schema.org:additionalProperty	Stable short identifier used in URLs and JSON key.
`image_url`	No	schema.org:image	Preview/thumbnail URL.
`license`	Yes	schema.org:license	License name or SPDX-like identifier.
`name`	Yes	schema.org:name	Human-readable dataset name.
`num_classes`	No	schema.org:variableMeasured / additionalProperty	Number of classes/labels.
`num_images`	No	schema.org:variableMeasured / additionalProperty	Number of images (if applicable).
`paper`	Yes	schema.org:url / schema.org:sameAs	Primary paper or landing page URL for the dataset.
`potential_tasks`	No	schema.org:keywords	Supported tasks (e.g., detection, segmentation).
`resolution`	No	schema.org:variableMeasured / additionalProperty	Spatial/image resolution info (free text).
`year`	Yes	schema.org:datePublished	Publication/release year.

Example catalog record

{
  "id": "CISI",
  "name": "Critical Infrastructure Sensor Imagery (CISI)",
  "year": 2025,
  "authors": [
    "First Last"
  ],
  "doi": "10.xxxx/xxxx",
  "paper": "https://example.org/paper",
  "license": "CC BY 4.0",
  "access": "https://example.org/download",
  "data_modality": ["image"],
  "annotation_types": ["bbox"],
  "potential_tasks": ["detection"],
  "geographical_location": "United States",
  "resolution": "1024x768",
  "num_images": 12345,
  "num_classes": 5,
  "classes": ["bridge"],
  "image_url": "https://example.org/preview.png",
  "added_date": "2026-01-09",
  "contributor": "@someone",
  "contributor_url": "https://github.com/someone"
}

Example JSON-LD (Dataset)

{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "Critical Infrastructure Sensor Imagery (CISI)",
  "description": "OpenConstruction dataset catalog entry.",
  "identifier": "CISI",
  "creator": [{"@type":"Person","name":"First Last"}],
  "datePublished": "2025",
  "license": "CC BY 4.0",
  "url": "https://www.openconstruction.org/datasets/detail.html?id=CISI",
  "sameAs": "https://example.org/paper",
  "keywords": ["image","detection","bbox"],
  "distribution": [{
    "@type": "DataDownload",
    "contentUrl": "https://example.org/download"
  }],
  "additionalProperty": [
    {"@type":"PropertyValue","name":"num_images","value":"12345"},
    {"@type":"PropertyValue","name":"num_classes","value":"5"},
    {"@type":"PropertyValue","name":"classes","value":"bridge, road, rail, pipeline, powerline"},
    {"@type":"PropertyValue","name":"added_date","value":"2026-01-09"},
    {"@type":"PropertyValue","name":"contributor","value":"@someone"}
  ]
}

Tip: embed this JSON-LD in the dataset detail page <head>.

Models

Model fields in `models.json`

Structured data recommendation: treat a model as SoftwareSourceCode (if code-first) or CreativeWork (if publication-first). Use keywords for modalities/tasks.

Field	Required	Schema.org mapping	Description
`abstract`	No	schema.org:description	Short description/summary.
`added_date`	No	(catalog metadata) —	Date added to OpenConstruction catalog (YYYY-MM-DD).
`applications`	No	schema.org:keywords	Application domains/use cases.
`authors`	No	schema.org:creator	Creators/authors of the model.
`code_url`	No	schema.org:url / schema.org:sameAs	Code repository URL.
`contributor`	No	schema.org:additionalProperty	GitHub handle or name of submitter.
`contributor_url`	No	schema.org:additionalProperty	Profile/org URL for submitter.
`id`	Yes	schema.org:additionalProperty	Stable short identifier used in URLs.
`license`	Yes	schema.org:license	Model/license terms.
`modalities`	No	schema.org:keywords	Input modalities (e.g., image, text, point cloud).
`paper_url`	No	schema.org:url / schema.org:sameAs	Paper or preprint URL.
`tasks`	No	schema.org:keywords	Supported tasks (e.g., segmentation, QA).
`thumbnail`	No	schema.org:image	Preview image URL.
`title`	Yes	schema.org:name	Model name/title.
`year`	Yes	schema.org:datePublished	Release/publication year.

Example catalog record

{
  "id": "bim-llm",
  "title": "BIM-QA LLM",
  "year": 2025,
  "authors": ["First Last"],
  "abstract": "A language model fine-tuned for BIM question answering.",
  "paper_url": "https://example.org/paper",
  "code_url": "https://github.com/org/repo",
  "license": "Apache-2.0",
  "modalities": ["text"],
  "tasks": ["question answering"],
  "applications": ["BIM compliance checking"],
  "thumbnail": "https://example.org/thumb.png",
  "added_date": "2026-01-09",
  "contributor": "@someone",
  "contributor_url": "https://github.com/someone"
}

Example JSON-LD (SoftwareSourceCode)

{
  "@context":"https://schema.org",
  "@type":"SoftwareSourceCode",
  "name":"BIM-QA LLM",
  "description":"A language model fine-tuned for BIM question answering.",
  "codeRepository":"https://github.com/org/repo",
  "license":"Apache-2.0",
  "datePublished":"2025",
  "url":"https://www.openconstruction.org/models/detail.html?id=bim-llm",
  "sameAs":"https://example.org/paper",
  "keywords":["LLM","text","question answering","BIM compliance checking"],
  "additionalProperty":[
    {"@type":"PropertyValue","name":"added_date","value":"2026-01-09"},
    {"@type":"PropertyValue","name":"contributor","value":"@someone"}
  ]
}

Use Cases

Use case fields in `use-cases.json`

Structured data recommendation: use CreativeWork (or CaseStudy when appropriate) and attach evidence links, organizations, and outcomes via additionalProperty.

Field	Required	Schema.org mapping	Description
`added_date`	No	(catalog metadata) —	Date added to OpenConstruction catalog (YYYY-MM-DD).
`ai_tech`	No	schema.org:additionalProperty	AI techniques used (e.g., CV, LLMs).
`applications`	Yes	schema.org:keywords	Application areas (e.g., safety monitoring).
`companies`	Yes	schema.org:publisher / provider	Company list (name/url).
`companies[].name`	No	schema.org:publisher / provider	Company name.
`companies[].url`	No	schema.org:publisher / provider	Company website URL.
`contributor`	No	schema.org:additionalProperty	GitHub handle or name of submitter.
`contributor_url`	No	schema.org:additionalProperty	Profile/org URL for submitter.
`data_modalities`	No	schema.org:keywords	Data types/modalities used.
`deployment_stage`	No	schema.org:additionalProperty	Stage of deployment (pilot, production).
`evidence_level`	No	schema.org:additionalProperty	Strength of evidence (case study, peer-reviewed, etc.).
`geography`	No	schema.org:additionalProperty	Geographic scope/region.
`license`	No	schema.org:license	License/terms for linked assets (if applicable).
`links`	No	schema.org:additionalProperty	External links (paper, code, demo, etc.).
`links.additional`	No	schema.org:url / schema.org:sameAs	Other relevant URL(s).
`links.code`	No	schema.org:url / schema.org:sameAs	Code repository URL(s).
`links.doi`	No	schema.org:additionalProperty	—
`links.paper`	No	schema.org:url / schema.org:sameAs	Paper URL(s).
`links.source`	No	schema.org:additionalProperty	—
`media`	No	schema.org:associatedMedia	Media assets (type/url).
`media[].alt`	No	schema.org:associatedMedia	—
`media[].type`	No	schema.org:associatedMedia	Media type (image, video, etc.).
`media[].url`	No	schema.org:associatedMedia	Media URL.
`notes`	No	schema.org:additionalProperty	Curator notes.
`organizations`	No	schema.org:additionalProperty	Organizations involved.
`outcomes`	No	schema.org:additionalProperty	Outcome metrics (value/metric/note).
`outcomes[].metric`	No	schema.org:additionalProperty	Outcome metric name.
`outcomes[].note`	No	schema.org:additionalProperty	Notes/assumptions for the metric.
`outcomes[].value`	No	schema.org:additionalProperty	Outcome value.
`phase`	Yes	schema.org:additionalProperty	Project lifecycle phase (e.g., design, construction).
`provider`	No	schema.org:publisher	Technology provider (if applicable).
`stakeholders`	Yes	schema.org:additionalProperty	Primary stakeholder groups.
`summary`	Yes	schema.org:description	Short description of the use case.
`tags`	No	schema.org:keywords	Tag list.
`title`	Yes	schema.org:name	Use case title.
`year`	Yes	schema.org:datePublished	Year of the referenced deployment/publication.

Example catalog record

{
  "title": "Jobsite PPE compliance monitoring",
  "summary": "Computer vision detects PPE compliance on live site cameras.",
  "phase": "Construction",
  "stakeholders": ["General contractor"],
  "ai_tech": ["Computer vision"],
  "applications": ["Safety monitoring"],
  "data_modalities": ["Video"],
  "deployment_stage": "Pilot",
  "evidence_level": "Case study",
  "geography": "United States",
  "companies": [
    {
      "name": "Example Co.",
      "url": "https://example.com"
    }
  ],
  "provider": "Example CV Vendor",
  "outcomes": [
    {
      "metric": "Recordable incidents",
    }
  ],
  "media": [
    {
      "type": "image",
      "url": "https://example.org/fig1.png"
    }
  ],
  "links": {"code": "https://github.com/org/repo",},
  "license": "CC BY 4.0",
  "tags": ["Safety"],
  "notes": "Curated from public case study.",
  "added_date": "2026-01-09",
  "contributor": "@someone",
  "contributor_url": "https://github.com/someone"
}

Example JSON-LD (CreativeWork)

{
  "@context":"https://schema.org",
  "@type":"CreativeWork",
  "name":"Jobsite PPE compliance monitoring",
  "description":"Computer vision detects PPE compliance on live site cameras.",
  "datePublished":"2025",
  "keywords":["Construction","Safety monitoring","Computer vision","Video"],
  "url":"https://www.openconstruction.org/use-cases/detail.html?id=jobsite-ppe",
  "publisher":[{"@type":"Organization","name":"Example Co.","url":"https://example.com"}],
  "sameAs":["https://example.org/paper","https://example.org/demo"],
  "associatedMedia":[{"@type":"MediaObject","contentUrl":"https://example.org/fig1.png"}],
  "additionalProperty":[
    {"@type":"PropertyValue","name":"deployment_stage","value":"Pilot"},
    {"@type":"PropertyValue","name":"evidence_level","value":"Case study"},
    {"@type":"PropertyValue","name":"outcome_recordable_incidents","value":"-12% (over 6 months)"},
    {"@type":"PropertyValue","name":"added_date","value":"2026-01-09"},
    {"@type":"PropertyValue","name":"contributor","value":"@someone"}
  ]
}

Open Educational Resources

OER fields in `oer.json`

Structured data recommendation: use LearningResource (or CreativeWork) and publish keywords, inLanguage, license, and url.

Field	Required	Schema.org mapping	Description
`added`	No	(catalog metadata) —	Date added to OpenConstruction catalog (YYYY-MM-DD).
`contributor`	No	schema.org:additionalProperty	GitHub handle or name of submitter.
`contributor_url`	No	schema.org:additionalProperty	Profile/org URL for submitter.
`id`	Yes	schema.org:additionalProperty	Stable short identifier used in URLs.
`image`	No	schema.org:image	Preview image URL.
`institutions`	No	schema.org:additionalProperty	Associated institutions.
`language`	Yes	schema.org:additionalProperty	Language code or name.
`license`	Yes	schema.org:license	License (e.g., CC BY).
`media`	No	schema.org:associatedMedia	Media formats (video, pdf, interactive, etc.).
`provider`	Yes	schema.org:publisher	Provider/host organization.
`publisher`	No	schema.org:publisher	Publisher (if different from provider).
`source`	Yes	schema.org:url / schema.org:sameAs	Canonical source URL.
`title`	Yes	schema.org:name	Resource title.
`topics`	Yes	schema.org:keywords	Topic tags (professional phrasing).
`year`	Yes	schema.org:datePublished	Publication year (if known).

Example catalog record

{
  "id": "bluebeam-takeoff-basics",
  "title": "Quantity Takeoff Basics in Bluebeam",
  "year": 2024,
  "language": "English",
  "topics": ["Construction estimating"],
  "media": ["Video"],
  "license": "CC BY-NC 4.0",
  "provider": "OER Commons",
  "publisher": "OER Commons",
  "institutions": [
    "Kent State University"
  ],
  "source": "https://oercommons.org/...",
  "image": "https://example.org/oer.png",
  "added": "2026-01-09",
  "contributor": "@someone",
  "contributor_url": "https://github.com/someone"
}

Example JSON-LD (LearningResource)

{
  "@context":"https://schema.org",
  "@type":"LearningResource",
  "name":"Quantity Takeoff Basics in Bluebeam",
  "description":"OpenConstruction OER catalog entry.",
  "inLanguage":"en",
  "datePublished":"2024",
  "license":"CC BY-NC 4.0",
  "url":"https://oercommons.org/...",
  "image":"https://example.org/oer.png",
  "keywords":["Construction estimating","Quantity takeoff","Bluebeam"],
  "publisher":{"@type":"Organization","name":"OER Commons"},
  "additionalProperty":[
    {"@type":"PropertyValue","name":"media","value":"Video, PDF"},
    {"@type":"PropertyValue","name":"institutions","value":"Kent State University"},
    {"@type":"PropertyValue","name":"added","value":"2026-01-09"},
    {"@type":"PropertyValue","name":"contributor","value":"@someone"}
  ]
}

OpenConstruction metadata fields

Dataset fields in datasets.json

Model fields in models.json

Use case fields in use-cases.json

OER fields in oer.json

Dataset fields in `datasets.json`

Model fields in `models.json`

Use case fields in `use-cases.json`

OER fields in `oer.json`