Skip to main content

Usage

The following example shows how the step can be used in a recipe.

Examples

  • Example 1
  • Signature
This example creates a new boolean column that flags rows where the ‘cats’ column contains the value ‘red’:
query(ds, {"query": "cats: red"}) -> (ds.query_result)

Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").
ds_in
dataset
required
The input dataset to evaluate against the query.
result
column
required
A boolean column indicating whether each row in the dataset matches the query.

Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

query
string
required
The graphext advanced query used to identify rows to flag.
I