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

Inherits:

Struct

• Object
• Struct
• Aws::Personalize::Types::Recommender

Includes:

Structure

Defined in:

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][1

request.

[1]: docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date_time ⇒ Time

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

• #dataset_group_arn ⇒ String

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

• #failure_reason ⇒ String

  If a recommender fails, the reason behind the failure.

• #last_updated_date_time ⇒ Time

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

• #latest_recommender_update ⇒ Types::RecommenderUpdateSummary

  Provides a summary of the latest updates to the recommender.

• #model_metrics ⇒ Hash<String,Float>

  Provides evaluation metrics that help you determine the performance of a recommender.

• #name ⇒ String

  The name of the recommender.

• #recipe_arn ⇒ String

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

• #recommender_arn ⇒ String

  The Amazon Resource Name (ARN) of the recommender.

• #recommender_config ⇒ Types::RecommenderConfig

  The configuration details of the recommender.

• #status ⇒ String

  The status of the recommender.

Instance Attribute Details

#creation_date_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_reason ⇒ String

If a recommender fails, the reason behind the failure.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_update ⇒ Types::RecommenderUpdateSummary

Provides a summary of the latest updates to the recommender.

Returns:

• (Types::RecommenderUpdateSummary)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_metrics ⇒ Hash<String,Float>

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

[1]: docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html

Returns:

• (Hash<String,Float>)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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

#name ⇒ String

The name of the recommender.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_arn ⇒ String

The Amazon Resource Name (ARN) of the recommender.

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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_config ⇒ Types::RecommenderConfig

The configuration details of the recommender.

Returns:

• (Types::RecommenderConfig)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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

#status ⇒ String

The status of the recommender.

A recommender can be in one of the following states:

• CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED

• STOP PENDING &gt; STOP IN_PROGRESS &gt; INACTIVE &gt; START PENDING &gt; START IN_PROGRESS &gt; ACTIVE

• DELETE PENDING &gt; DELETE IN_PROGRESS

Returns:

• (String)

# File 'lib/aws-sdk-personalize/types.rb', line 4603

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