Prometheus Entity Management API
    Preparing search index...

    Interface AgUiStateMapping

    Maps one slice of agent state onto an entity type.

    interface AgUiStateMapping {
        constantId?: string;
        entityType: string;
        idField?: string;
        kind: "single" | "collection";
        pointer: string;
        write?: "replace" | "upsert";
    }
    Index
    constantId? entityType idField? kind pointer write?
    constantId?: string

    Constant id for single mappings whose object has no id field.

    entityType: string

    Entity type the mapped object(s) belong to.

    idField?: string

    Field on each object that holds its entity id. For single you may instead pass a constant id via constantId.

    kind: "single" | "collection"

    Whether pointer addresses one object or a collection (array/record).

    pointer: string

    JSON-Pointer prefix into the agent state where this entity (or collection) lives. "/order" → a single entity; "/orders" → a collection keyed by id.

    write?: "replace" | "upsert"

    How to write: upsert (merge via MergeStrategy — default) or replace (full overwrite). Snapshots typically replace; deltas typically upsert.

    Settings
    Member Visibility

    On This Page
    Properties