Class: Aws::Personalize::Types::Recommender

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date_timeTime

The date and time (in Unix format) that the recommender was created.

Returns:

  • (Time)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_group_arnString

The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasonString

If a recommender fails, the reason behind the failure.

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date_timeTime

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

Returns:

  • (Time)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#latest_recommender_updateTypes::RecommenderUpdateSummary

Provides a summary of the latest updates to the recommender.



4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#model_metricsHash<String,Float>

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

Returns:

  • (Hash<String,Float>)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the recommender.

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#recipe_arnString

The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#recommender_arnString

The Amazon Resource Name (ARN) of the recommender.

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#recommender_configTypes::RecommenderConfig

The configuration details of the recommender.



4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the recommender.

A recommender can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

  • DELETE PENDING > DELETE IN_PROGRESS

Returns:

  • (String)


4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 4878

class Recommender < Struct.new(
  :recommender_arn,
  :dataset_group_arn,
  :name,
  :recipe_arn,
  :recommender_config,
  :creation_date_time,
  :last_updated_date_time,
  :status,
  :failure_reason,
  :latest_recommender_update,
  :model_metrics)
  SENSITIVE = []
  include Aws::Structure
end