Interface RecommenderConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>, SdkBuilder<RecommenderConfig.Builder,RecommenderConfig>, SdkPojo
Enclosing class:
RecommenderConfig
@Mutable @NotThreadSafe public static interface RecommenderConfig.Builder extends SdkPojo, CopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>

  • Method Details

    • eventsConfig

      RecommenderConfig.Builder eventsConfig(EventsConfig eventsConfig)

      Configuration settings for how the recommender processes and uses events.

      Parameters:
      eventsConfig - Configuration settings for how the recommender processes and uses events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventsConfig

      default RecommenderConfig.Builder eventsConfig(Consumer<EventsConfig.Builder> eventsConfig)

      Configuration settings for how the recommender processes and uses events.

      This is a convenience method that creates an instance of the EventsConfig.Builder avoiding the need to create one manually via EventsConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventsConfig(EventsConfig).

      Parameters:
      eventsConfig - a consumer that will call methods on EventsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trainingFrequency

      RecommenderConfig.Builder trainingFrequency(Integer trainingFrequency)

      How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.

      Parameters:
      trainingFrequency - How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inferenceConfig

      RecommenderConfig.Builder inferenceConfig(InferenceConfig inferenceConfig)

      Configuration settings for how the recommender handles inference requests.

      Parameters:
      inferenceConfig - Configuration settings for how the recommender handles inference requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inferenceConfig

      default RecommenderConfig.Builder inferenceConfig(Consumer<InferenceConfig.Builder> inferenceConfig)

      Configuration settings for how the recommender handles inference requests.

      This is a convenience method that creates an instance of the InferenceConfig.Builder avoiding the need to create one manually via InferenceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceConfig(InferenceConfig).

      Parameters:
      inferenceConfig - a consumer that will call methods on InferenceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includedColumns

      RecommenderConfig.Builder includedColumns(Map<String,? extends Collection<String>> includedColumns)

      A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.

      Parameters:
      includedColumns - A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludedColumns

      RecommenderConfig.Builder excludedColumns(Map<String,? extends Collection<String>> excludedColumns)

      A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.

      Parameters:
      excludedColumns - A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.