Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Entity

Generated artifact. This page is generated from schemas/Entity.schema.json and schemas/common.schema.json. Do not hand-edit; regenerate from the schema and the field tables will stay authoritative.

A named thing extracted from memory — a person, place, organization, concept, technology, product, skill, or discriminative keyword.

Maturity: OMM-3

Purpose

An Entity is a canonicalized node in the knowledge graph. It is the target of MemoryRecord.entityRefs and Episode.entityRefs, and the endpoint type for every Relationship. Salience governs how strongly an entity pulls on retrieval.

See Memory Semantics §5 for how salience is computed and used in retrieval.

Fields

FieldTypeCard.Description
resourceType"Entity" (const)1..1Discriminator. MUST be Entity.
idId (string)1..1Resource-local identifier, unique among Entity resources within a Bundle. Pattern ^[A-Za-z0-9._:-]{1,128}$.
namestring1..1Canonical surface form, e.g. "John", "Paris", "Rust programming".
metaMeta0..1Metadata envelope (omirVersion, profile[], source, createdAt, lastUpdated, maturity).
labelsarray of enum (12 values, see below)0..*One or more type labels. Open at the edges via other + extension.
summarystring0..1Context summary built from surrounding relationships.
mentionCountinteger ≥ 00..1Number of times this entity has been mentioned.
salienceUnitInterval ([0,1])0..1How important this entity is. Higher salience = stronger gravitational pull in retrieval.
properNounboolean0..1Proper nouns carry higher base salience than common nouns.
attributesobject (string → string)0..1Type-specific key/value attributes.
createdAtInstant (date-time)0..1When the entity was first recorded.
lastSeenAtInstant (date-time)0..1When the entity was most recently observed.
extensionarray of Extension0..*Implementation-specific data (e.g. name embeddings — model + vector — ride here; embeddings are NOT core in R1).

additionalProperties is false: a conformant Entity carries only the fields above.

labels vocabulary

person, organization, location, technology, concept, event, date, product, skill, keyword, project, other.

Minimal

The required set is resourceType, id, name.

{
  "resourceType": "Entity",
  "id": "varun",
  "name": "Varun"
}

Full

{
  "resourceType": "Entity",
  "id": "omir",
  "meta": {
    "omirVersion": "R1",
    "source": "veld/0.7.6",
    "maturity": 3
  },
  "name": "OMIR",
  "labels": ["project", "concept"],
  "summary": "Open Memory Interoperability Resources — a FHIR-style standard for portable agent memory.",
  "mentionCount": 34,
  "salience": 0.97,
  "properNoun": true,
  "attributes": { "kind": "standard", "release": "R1" },
  "createdAt": "2026-05-30T10:00:00Z",
  "lastSeenAt": "2026-05-30T11:42:00Z",
  "extension": [
    {
      "url": "https://veld.dev/omir/ext/name-embedding",
      "valueJson": { "model": "minilm-384", "dim": 384 }
    }
  ]
}

References

An Entity holds no outbound references to other OMIR resources — it is a leaf node by design. The graph edges around it are expressed elsewhere:

  • Relationship.from / Relationship.toEntity — entities are the endpoints of every relationship.
  • MemoryRecord.entityRefs[]Entity and Episode.entityRefs[]Entity — records and episodes point to entities.