featurebyte.Feature.str.slice

slice(

start: Union[int, NoneType]=None,

stop: Union[int, NoneType]=None,

step: Union[int, NoneType]=None

) -> Feature

Description

Slices substring from each string element.

Parameters

• start: Union[int, NoneType]
  Starting position for slice operation.
  
  
• stop: Union[int, NoneType]
  Ending position for slice operation.
  
  
• step: Union[int, NoneType]
  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)