Rename Segment Levels

Rename levels of a segment column using a mapping dict.

Levels not present in mapping are left unchanged. Useful for cleaning up raw segment data, or for giving a clustering result (e.g. from add_clusters) human-readable names. Renaming a level to match another existing level merges the two.

Usage

stream.add_clusters(
    name="cluster",
    features=[{"metric": "length"}],
    method_args={"n_clusters": 3},
).rename_segment_levels(
    "cluster", {"cluster_0": "buyers", "cluster_1": "browsers"}
)

Parameters

Parameter	Type	Description
`segment_col`	`str`	Name of the segment column. Must be listed in `schema.segment_cols`.
`mapping`	`dict`	Mapping of `{old_level: new_level}`. Keys must be levels already present in `segment_col` (see `get_segment_levels`).