Skip to content

featurebyte.Feature.str.slice

slice(
start: Optional[int]=None,
stop: Optional[int]=None,
step: Optional[int]=None
) -> Feature

Description

Slices substring from each string element.

Parameters

  • start: Optional[int]
    Starting position for slice operation.

  • stop: Optional[int]
    Ending position for slice operation.

  • step: Optional[int]
    Step size for slice operation (only size 1 is supported)

Returns

  • Feature
    A new Feature object.

Raises

  • ValueError
    When the step size is neither None nor 1.

Examples

Slice the first 10 characters from the ProductGroupLookup feature:

>>> feature = catalog.get_feature("ProductGroupLookup")
>>> feature_group = fb.FeatureGroup([feature])
>>> feature_group["ProductGroupSlice"] = feature.str.slice(0, 10)