Retrieves a recommender¶

Description¶

Retrieves a recommender.

Usage¶

customerprofiles_get_recommender(DomainName, RecommenderName,
  TrainingMetricsCount)

Arguments¶

DomainName

[required] The unique name of the domain.

RecommenderName

[required] The name of the recommender.

TrainingMetricsCount

The number of training metrics to retrieve for the recommender.

Value¶

A list with the following syntax:

list(
  RecommenderName = "string",
  RecommenderRecipeName = "recommended-for-you"|"similar-items"|"frequently-paired-items"|"popular-items"|"trending-now"|"personalized-ranking",
  RecommenderSchemaName = "string",
  RecommenderConfig = list(
    EventsConfig = list(
      EventParametersList = list(
        list(
          EventType = "string",
          EventValueThreshold = 123.0,
          EventWeight = 123.0
        )
      )
    ),
    TrainingFrequency = 123,
    InferenceConfig = list(
      MinProvisionedTPS = 123
    ),
    IncludedColumns = list(
      list(
        "string"
      )
    ),
    ExcludedColumns = list(
      list(
        "string"
      )
    ),
    DiversityConfig = list(
      DiversityColumns = list(
        list(
          Name = "string",
          CapType = "PERCENTAGE"|"VALUE",
          Target = "string"
        )
      )
    )
  ),
  Description = "string",
  Status = "PENDING"|"IN_PROGRESS"|"ACTIVE"|"FAILED"|"STOPPING"|"INACTIVE"|"STARTING"|"DELETING",
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  FailureReason = "string",
  LatestRecommenderUpdate = list(
    RecommenderConfig = list(
      EventsConfig = list(
        EventParametersList = list(
          list(
            EventType = "string",
            EventValueThreshold = 123.0,
            EventWeight = 123.0
          )
        )
      ),
      TrainingFrequency = 123,
      InferenceConfig = list(
        MinProvisionedTPS = 123
      ),
      IncludedColumns = list(
        list(
          "string"
        )
      ),
      ExcludedColumns = list(
        list(
          "string"
        )
      ),
      DiversityConfig = list(
        DiversityColumns = list(
          list(
            Name = "string",
            CapType = "PERCENTAGE"|"VALUE",
            Target = "string"
          )
        )
      )
    ),
    Status = "PENDING"|"IN_PROGRESS"|"ACTIVE"|"FAILED"|"STOPPING"|"INACTIVE"|"STARTING"|"DELETING",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    FailureReason = "string",
    RecommenderVersionName = "string"
  ),
  ActiveRecommenderVersionName = "string",
  TrainingMetrics = list(
    list(
      Time = as.POSIXct(
        "2015-01-01"
      ),
      Metrics = list(
        123.0
      ),
      RecommenderVersionName = "string"
    )
  ),
  Tags = list(
    "string"
  )
)

Request syntax¶

svc$get_recommender(
  DomainName = "string",
  RecommenderName = "string",
  TrainingMetricsCount = 123
)