Package software.amazon.awssdk.services.personalize.model

Class CreateSolutionRequest

    • Method Detail

      • name

        public final String name()

        The name for the solution.

        Returns:
        The name for the solution.

      • performHPO

        public final Boolean performHPO()

        Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

        When performing AutoML, this parameter is always true and you should not set it to false.

        Returns:
        Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

        When performing AutoML, this parameter is always true and you should not set it to false.

      • performAutoML

        public final Boolean performAutoML()

        We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

        Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

        When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

        Returns:

        We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see Choosing a recipe.

        Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

        When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

      • performAutoTraining

        public final Boolean performAutoTraining()

        Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

        Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

        After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

        Returns:
        Whether the solution uses automatic training to create new solution versions (trained models). The default is True and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a schedulingExpression in the AutoTrainingConfig as part of solution configuration. For more information about automatic training, see Configuring automatic training.

        Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.

        After training starts, you can get the solution version's Amazon Resource Name (ARN) with the ListSolutionVersions API operation. To get its status, use the DescribeSolutionVersion.

      • recipeArn

        public final String recipeArn()

        The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

        Returns:
        The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when performAutoML is false. For information about different Amazon Personalize recipes and their ARNs, see Choosing a recipe.

      • datasetGroupArn

        public final String datasetGroupArn()

        The Amazon Resource Name (ARN) of the dataset group that provides the training data.

        Returns:
        The Amazon Resource Name (ARN) of the dataset group that provides the training data.

      • eventType

        public final String eventType()

        When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

        If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

        Returns:
        When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

        If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

      • solutionConfig

        public final SolutionConfig solutionConfig()

        The configuration properties for the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

        Amazon Personalize doesn't support configuring the hpoObjective at this time.

        Returns:
        The configuration properties for the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

        Amazon Personalize doesn't support configuring the hpoObjective at this time.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        A list of tags to apply to the solution.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        A list of tags to apply to the solution.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object