Skip to content
UPG is in early alpha. The specification is still evolving and may change between versions.
Tools/Workspace & Portfolios/aggregate_edge_properties

aggregate_edge_properties

Aggregate the distribution of one property across every portfolio cross-edge of a type, optionally grouped by a dimension. The digest of the property layer: turns the by-eye "165 high / 53 medium / 0 low, mediums cluster on ext_api_sdk" count over a `jq` dump into one call. `property` defaults to `confidence` (an assessment-object property buckets by its `label`). `group_by`: `none` (one overall distribution, default), `axis` (the classification axis the target value belongs to), `competitor` (the source node), or `value` (the target value). Read-only.

Workspace & Portfoliosatomic (read-only). Reads the portfolio document only; never mutates.

Arguments

edge_typestringrequired

Cross-edge type to aggregate (e.g. competitor_classified_as_classification_value).

group_bystringoptional

Dimension to group the distribution by. Default none (one overall distribution).

noneaxiscompetitorvalue
propertystringoptional

The edge property whose distribution to compute. Default confidence.

Returns

Shape
{ shape: "edge_property_aggregate", edge_type, property, group_by, total, with_property, without_property, overall: [{ key, count }], groups?: [{ group, group_label?, total, with_property, distribution }] }

overall is the whole-type distribution; groups appears when group_by is not none.

See Also