SliceSpec

Specification for how the data should be sliced.

JSON representation
{
  "configs": {
    string: {
      object (SliceConfig)
    },
    ...
  }
}
Fields
configs

map (key: string, value: object (SliceConfig))

Mapping configuration for this SliceSpec. The key is the name of the feature. By default, the key will be prefixed by "instance" as a dictionary prefix for Vertex Batch Predictions output format.

SliceConfig

Specification message containing the config for this SliceSpec. When kind is selected as value and/or range, only a single slice will be computed. When allValues is present, a separate slice will be computed for each possible label/value for the corresponding key in config. Examples, with feature zipCode with values 12345, 23334, 88888 and feature country with values "US", "Canada", "Mexico" in the dataset:

Example 1:

{
  "zipCode": { "value": { "floatValue": 12345.0 } }
}

A single slice for any data with zipCode 12345 in the dataset.

Example 2:

{
  "zipCode": { "range": { "low": 12345, "high": 20000 } }
}

A single slice containing data where the zip_codes between 12345 and 20000 For this example, data with the zipCode of 12345 will be in this slice.

Example 3:

{
  "zipCode": { "range": { "low": 10000, "high": 20000 } },
  "country": { "value": { "stringValue": "US" } }
}

A single slice containing data where the zip_codes between 10000 and 20000 has the country "US". For this example, data with the zipCode of 12345 and country "US" will be in this slice.

Example 4:

{ "country": {"allValues": { "value": true } } }

Three slices are computed, one for each unique country in the dataset.

Example 5:

{
  "country": { "allValues": { "value": true } },
  "zipCode": { "value": { "floatValue": 12345.0 } }
}

Three slices are computed, one for each unique country in the dataset where the zipCode is also 12345. For this example, data with zipCode 12345 and country "US" will be in one slice, zipCode 12345 and country "Canada" in another slice, and zipCode 12345 and country "Mexico" in another slice, totaling 3 slices.

JSON representation
{

  // Union field kind can be only one of the following:
  "value": {
    object (Value)
  },
  "range": {
    object (Range)
  },
  "allValues": boolean
  // End of list of possible types for union field kind.
}
Fields

Union field kind.

kind can be only one of the following:

value

object (Value)

A unique specific value for a given feature. Example: { "value": { "stringValue": "12345" } }

range

object (Range)

A range of values for a numerical feature. Example: {"range":{"low":10000.0,"high":50000.0}} will capture 12345 and 23334 in the slice.

allValues

boolean

If allValues is set to true, then all possible labels of the keyed feature will have another slice computed. Example: {"allValues":{"value":true}}

Value

Single value that supports strings and floats.

JSON representation
{

  // Union field kind can be only one of the following:
  "stringValue": string,
  "floatValue": number
  // End of list of possible types for union field kind.
}
Fields

Union field kind.

kind can be only one of the following:

stringValue

string

String type.

floatValue

number

Float type.

Range

A range of values for slice(s). low is inclusive, high is exclusive.

JSON representation
{
  "low": number,
  "high": number
}
Fields
low

number

Inclusive low value for the range.

high

number

Exclusive high value for the range.