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

Interface SolutionVersion.Builder

    • Method Detail

      • name

        SolutionVersion.Builder name​(String name)

        The name of the solution version.

        Parameters:
        name - The name of the solution version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • solutionVersionArn

        SolutionVersion.Builder solutionVersionArn​(String solutionVersionArn)

        The ARN of the solution version.

        Parameters:
        solutionVersionArn - The ARN of the solution version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • solutionArn

        SolutionVersion.Builder solutionArn​(String solutionArn)

        The ARN of the solution.

        Parameters:
        solutionArn - The ARN of the solution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performHPO

        SolutionVersion.Builder performHPO​(Boolean performHPO)

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

        Parameters:
        performHPO - Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performAutoML

        SolutionVersion.Builder performAutoML​(Boolean performAutoML)

        When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

        Parameters:
        performAutoML - When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • recipeArn

        SolutionVersion.Builder recipeArn​(String recipeArn)

        The ARN of the recipe used in the solution.

        Parameters:
        recipeArn - The ARN of the recipe used in the solution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventType

        SolutionVersion.Builder eventType​(String eventType)

        The event type (for example, 'click' or 'like') that is used for training the model.

        Parameters:
        eventType - The event type (for example, 'click' or 'like') that is used for training the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetGroupArn

        SolutionVersion.Builder datasetGroupArn​(String datasetGroupArn)

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

        Parameters:
        datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group providing the training data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • solutionConfig

        SolutionVersion.Builder solutionConfig​(SolutionConfig solutionConfig)

        Describes the configuration properties for the solution.

        Parameters:
        solutionConfig - Describes the configuration properties for the solution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingHours

        SolutionVersion.Builder trainingHours​(Double trainingHours)

        The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

        Parameters:
        trainingHours - The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • trainingMode

        SolutionVersion.Builder trainingMode​(String trainingMode)

        The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

        The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

        Parameters:
        trainingMode - The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

        The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TrainingMode, TrainingMode

      • trainingMode

        SolutionVersion.Builder trainingMode​(TrainingMode trainingMode)

        The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

        The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

        Parameters:
        trainingMode - The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

        The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TrainingMode, TrainingMode

      • tunedHPOParams

        SolutionVersion.Builder tunedHPOParams​(TunedHPOParams tunedHPOParams)

        If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

        Parameters:
        tunedHPOParams - If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        SolutionVersion.Builder status​(String status)

        The status of the solution version.

        A solution version can be in one of the following states:

        • CREATE PENDING

        • CREATE IN_PROGRESS

        • ACTIVE

        • CREATE FAILED

        • CREATE STOPPING

        • CREATE STOPPED

        Parameters:
        status - The status of the solution version.

        A solution version can be in one of the following states:

        • CREATE PENDING

        • CREATE IN_PROGRESS

        • ACTIVE

        • CREATE FAILED

        • CREATE STOPPING

        • CREATE STOPPED

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        SolutionVersion.Builder failureReason​(String failureReason)

        If training a solution version fails, the reason for the failure.

        Parameters:
        failureReason - If training a solution version fails, the reason for the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDateTime

        SolutionVersion.Builder creationDateTime​(Instant creationDateTime)

        The date and time (in Unix time) that this version of the solution was created.

        Parameters:
        creationDateTime - The date and time (in Unix time) that this version of the solution was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedDateTime

        SolutionVersion.Builder lastUpdatedDateTime​(Instant lastUpdatedDateTime)

        The date and time (in Unix time) that the solution was last updated.

        Parameters:
        lastUpdatedDateTime - The date and time (in Unix time) that the solution was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.