# legacydeveloper Salesforce Recipes Api - Full Documentation # Abstract Bucket Algorithm The base bucket algorithm for a recipe. ## Properties Inherited by [Typographic Cluster](https://developer.salesforce.com/docs/atlas.en-us.salesforce_recipes_api.meta/salesforce_recipes_api/sforce_recipes_api_responses_typographic_cluster.htm "The configuration for a typographic cluster algorithm.").
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| type | RecipeBucketAlgorithmType | The algorithm type of the recipe bucket field. Valid values are:
|
Small, 52.0 | 52.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| type | RecipeBucketAlgorithmType | The algorithm type of the recipe bucket field. Valid values are:
|
Required | 52.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| action | RecipeAggregateType | The recipe aggregation type. Valid values are:
|
Small, v51.0 | 51.0 |
| label | String | The label for the aggregate data. | Small, v51.0 | 51.0 |
| name | String | The name for the aggregate data. | Small, v51.0 | 51.0 |
| source | String | The source for the aggregate data. | Small, v51.0 | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| action | RecipeAggregateType | The recipe aggregation type. Valid values are:
|
Required | 49.0 |
| label | String | The label for the aggregate data. | Required | 49.0 |
| name | String | The name for the aggregate data. | Required | 49.0 |
| source | String | The source for the aggregate data. | Required | 49.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| aggregations | Aggregate[] | The list of aggregations for the node. | Small, v51.0 | 51.0 |
| groupings | String[] | The list of groupings for the node. | Small, v51.0 | 51.0 |
| nodeType | RecipeAggregateNodeEnum | The aggregate type for the node. Valid values are:
|
Small, v53.0 | 53.0 |
| parentField | String | The parent field for the node | Small, v53.0 | 53.0 |
| percentageField | String | The percentage field for the node | Small, v53.0 | 53.0 |
| pivot_v2 | PivotV2[] | The pivot v2 data for the node. | Small, v54.0 | 54.0 |
| pivots | Pivot[] | The list of pivots for the node. | Small, v51.0 | 51.0 |
| selfField | String | The self field for the node | Small, v53.0 | 53.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| aggregations | AggregateInput[] | The list of aggregations for the node. | Required | 49.0 |
| groupings | String[] | The list of groupings for the node. | Required | 49.0 |
| nodeType | RecipeAggregateNodeEnum | The aggregate type for the node. Valid values are:
|
Required | 49.0 |
| parentField | String | The parent field for the node | Required | 53.0 |
| percentageField | String | The percentage field for the node | Required | 53.0 |
| pivot_v2 | PivotV2Input[] | The pivot v2 data for the node. | Optional | 54.0 |
| pivots | PivotInput[] | The list of pivots for the node. | Required | 51.0 |
| selfField | String | The self field for the node | Required | 53.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| argument | Long | The date argument. | Small, 49.0 | 49.0 |
| type | RecipeBucketGrain | The recipe bucket date grain type. Valid values are:
|
Small, 49.0 | 49.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| argument | Long | The date argument. | Required | 51.0 |
| type | RecipeBucketGrain | The bucket grain for the field. Valid values are:
|
Required | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| name | String | The name of the field. | Required | 51.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Required | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| name | String | The name of the field. | Required | 51.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Required | 51.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| bucketsSetup | BucketSetup | The bucket field property label. | Small, v49.0 | 49.0 |
| label | String | The bucket field property label. | Small, v49.0 | 49.0 |
| name | String | The bucket field property name. | Small, v49.0 | 49.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Small, v49.0 | 49.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| label | String | The bucket field property label. | Required | 51.0 |
| name | String | The bucket field property name. | Required | 51.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Required | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| name | String | The name of the field. | Required | 51.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Required | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| fields | BucketFieldInput[] | The list of fields for the node. Valid bucket fields are: | Required | 51.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| algorithm | AbstractBucketAlgorithm | The bucketing algorithm. Valid values are: | Small, v52.0 | 52.0 |
| buckets | Bucket | The buckets. Valid values are: | Small, v51.0 | 51.0 |
| defaultBucketValue | String | The default bucket value. | Small, v51.0 | 51.0 |
| isPassThroughEnabled | Boolean | Indicates whether pass through is enabled (true) or not (false). | Small, v51.0 | 51.0 |
| nullBucketValue | String | The null bucket value | Small, v51.0 | 51.0 |
| sourceField | BucketSourceField | The bucket source fields. | Small, v51.0 | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| algorithm | AbstractBucketAlgorithmInput | The bucketing algorithm. Valid values are: | Required | 52.0 |
| defaultBucketValue | String | The default bucket value. | Required | 51.0 |
| isPassThroughEnabled | Boolean | Indicates whether pass through is enabled (true) or not (false). | Required | 51.0 |
| nullBucketValue | String | The null bucket value | Required | 51.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| name | String | The bucket source field name. | Small, 49.0 | 49.0 |
| type | RecipeDataType | The recipe data type. Valid values are:
|
Small, v49.0 | 49.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| opType | RecipeDataType | The recipe node data type. Valid recipe data types are:
|
Small, 64.0 | 64.0 |
| operands | Map<Object, Object> | A map of operands for the bucket term. | Small, 64.0 | 64.0 |
| operator | String | The operator for the bucket term. | Small, 64.0 | 64.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| opType | RecipeDataType | The recipe node data type. Valid recipe data types are:
|
Required | 64.0 |
| operands | Map<Object, Object> | A map of operands for the bucket term. | Required | 64.0 |
| operator | String | The operator for the bucket term. | Required | 64.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| algorithm | AbstractBucketAlgorithm[] | The bucket algorithm. Valid bucket algorithms are: | Small, 64.0 | 64.0 |
| buckets | BucketV2[] | A list of the buckets for the node. | Small, 64.0 | 64.0 |
| defaultBucket | Object | A default bucket for the node. | Small, 64.0 | 64.0 |
| multiValueResult | boolean | Indicates whether the bucket result is multi-value (true) or not (false). | Small, 64.0 | 64.0 |
| nullBucket | Object | A null bucket for the node. | Small, 64.0 | 64.0 |
| passthroughEnabled | boolean | Indicates whether pass through is enabled for the bucket (true) or not (false). | Small, 64.0 | 64.0 |
| sourceField | String | The source field for the bucket. | Small, 64.0 | 64.0 |
| targetField | TargetField | The target field for the bucket. | Small, 64.0 | 64.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| algorithm | AbstractBucketAlgorithmInput[] | The bucket algorithm. Valid bucket algorithms are: | Required | 64.0 |
| buckets | BucketV2Input[] | A list of the buckets for the node. | Required | 64.0 |
| defaultBucket | Object | A default bucket for the node. | Required | 64.0 |
| multiValueResult | boolean | Indicates whether the bucket result is multi-value (true) or not (false). | Optional | 64.0 |
| nullBucket | Object | A null bucket for the node. | Optional | 64.0 |
| passthroughEnabled | boolean | Indicates whether pass through is enabled for the bucket (true) or not (false). | Optional | 64.0 |
| sourceField | String | The source field for the bucket. | Required | 64.0 |
| targetField | TargetFieldInput | The target field for the bucket. | Required | 64.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| clusterCount | Integer | The cluster count. | Required | 51.0 |
| findOptimalClusters | Boolean | Indicates whether to find the optimal clusters (true) or (not). | Required | 53.0 |
| produceScaledColumns | Boolean | Indicates whether to produce scaled columns (true) or (not). | Required | 53.0 |
| scaling | MeasureScalingTypeEnum | The scaling type. Valid values are:
|
Required | 53.0 |
| sourceFields | String[] | The source fields. | Required | 51.0 |
| targetField | RecipeNameLabelInput | The target field. | Required | 51.0 |
| targetScaledFields | RecipeNameLabelInput[] | A list of target scaled fields. | Required | 53.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| clusterCount | Integer | The cluster count. | Small, v49.0 | 49.0 |
| findOptimalClusters | Boolean | Indicates whether to find the optimal clusters (true) or (not). | Small, v53.0 | 53.0 |
| produceScaledColumns | Boolean | Indicates whether to produce scaled columns (true) or (not). | Small, v53.0 | 53.0 |
| scaling | MeasureScalingTypeEnum | The scaling type. Valid values are:
|
Small, v53.0 | 53.0 |
| sourceFields | String[] | The source fields. | Small, v51.0 | 51.0 |
| targetField | RecipeNameLabel | The target field. | Small, v51.0 | 51.0 |
| targetScaledFields | RecipeNameLabel[] | A list of target scaled fields. | Small, v53.0 | 53.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| expressionType | RecipeFormulaExpressionType | The formula expression type. Valid values are:
|
Small, v51.0 | 51.0 |
| fields | SqlFormulaField[] | The list of formula fields. Valid values are: | Small, v51.0 | 51.0 |
| orderBy | ComputeRelativeSortParameters[] | The list of sort fields. | Small, v51.0 | 51.0 |
| partitionBy | String[] | The list of partition by values. | Small, v51.0 | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| expressionType | RecipeFormulaExpressionType | The formula expression type. Valid values are:
|
Optional | 51.0 |
| fields | SqlFormulaFieldInput[] | The list of formula fields. Valid values are: | Required | 51.0 |
| orderBy | ComputeRelativeSortParametersInput[] | The list of sort fields. | Optional | 51.0 |
| partitionBy | String[] | The list of partition by values. | Optional | 51.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| direction | RecipeSortOrderEnum | The sort direction. Valid values are:
|
Small, v51.0 | 51.0 |
| fieldName | String | The field name. | Small, v51.0 | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| direction | RecipeSortOrderEnum | The sort direction. Valid values are:
|
Required | 51.0 |
| fieldName | String | The field name. | Required | 51.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| outputType | DetectSentimentOutputTypeEnum | The output type. Valid values are:
|
Small, v54.0 | 54.0 |
| sentimentScore | SentimentScoreTypeEnum | The sentiment score type. Valid values are:
|
Small, v54.0 | 54.0 |
| sourceField | String | The source field. | Small, v51.0 | 51.0 |
| targetField | RecipeNameLabel | The target field. | Small, v51.0 | 51.0 |
| targetSentimentScoreFields | Map<String, Map<String, RecipeNameLabel>> | The collection of target confidence fields. | Small, v54.0 | 54.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| outputType | DetectSentimentOutputTypeEnum | The output type. Valid values are:
|
Required | 54.0 |
| sentimentScore | SentimentScoreTypeEnum | The sentiment score type. Valid values are:
|
Required | 54.0 |
| sourceField | String | The source field. | Required | 51.0 |
| targetField | RecipeNameLabelInput | The target field. | Required | 51.0 |
| targetSentimentScoreFields | Map<String, Map<String, RecipeNameLabelInput> | The collection of target confidence fields. | Required | 54.0 |
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| csvHeaderRowValueType | RecipeExportCsvHeaderRowValueType | The type of the recipe export CSV header row value. Valid values are:
|
Small, v53.0 | 53.0 |
| fields | String[] | The list of fields to select. | Small, v51.0 | 51.0 |
| format | RecipeExportFormat | The format of the export. Valid values are:
|
Small, v51.0 | 51.0 |
| limitsPerPart | ExportLimits | The limits to export. | Small, v51.0 | 51.0 |
| userId | String | The user ID with access to the exported data. | Small, v51.0 | 51.0 |
| Property Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| csvHeaderRowValueType | RecipeExportCsvHeaderRowValueType | The type of the recipe export CSV header row value. Valid values are:
|
Required | 53.0 |
| fields | String[] | The list of fields to export. | Required | 51.0 |
| format | String | The format of the export. | Required | 51.0 |
| limitsPerPart | ExportLimitsInput | The limits to export. | Required | 51.0 |
| userId | String | The user ID with access to the exported data. | Required | 51.0 |