{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-get-recommender-response-schema.json",
  "title": "GetRecommenderResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-connect-recommenders-api-openapi.yml#/components/schemas/GetRecommenderResponse",
  "type": "object",
  "properties": {
    "RecommenderName": {
      "type": "string",
      "description": "The name of the recommender."
    },
    "RecommenderRecipeName": {
      "type": "string",
      "enum": [
        "recommended-for-you",
        "similar-items",
        "frequently-paired-items",
        "popular-items",
        "trending-now",
        "personalized-ranking"
      ],
      "description": "The name of the recipe used by the recommender to generate recommendations."
    },
    "RecommenderSchemaName": {
      "type": "string",
      "description": "The name of the recommender schema associated with this recommender."
    },
    "RecommenderConfig": {
      "$ref": "#/$defs/ProfileRecommenderConfig"
    },
    "Description": {
      "type": "string",
      "description": "A detailed description of the recommender providing information about its purpose and functionality."
    },
    "Status": {
      "type": "string",
      "enum": [
        "PENDING",
        "IN_PROGRESS",
        "ACTIVE",
        "FAILED",
        "STOPPING",
        "INACTIVE",
        "STARTING",
        "DELETING"
      ],
      "description": "The current status of the recommender, indicating whether it is active, creating, updating, or in another state."
    },
    "LastUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp of when the recommender was edited."
    },
    "CreatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp of when the recommender was created."
    },
    "FailureReason": {
      "type": "string",
      "description": "If the recommender fails, provides the reason for the failure."
    },
    "LatestRecommenderUpdate": {
      "$ref": "#/$defs/RecommenderUpdate"
    },
    "ActiveRecommenderVersionName": {
      "type": "string",
      "description": "The name of the recommender version currently serving recommendations. Omitted when no active recommender version is set."
    },
    "TrainingMetrics": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TrainingMetrics"
      },
      "description": "A set of metrics that provide information about the recommender's training performance and accuracy."
    },
    "Tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The tags used to organize, track, or control access for this resource."
    }
  },
  "required": [
    "RecommenderName",
    "RecommenderRecipeName"
  ],
  "$defs": {
    "DiversityColumn": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of the item catalog column on which to apply the diversity cap. The column must be defined in the recommender schema."
        },
        "CapType": {
          "type": "string",
          "enum": [
            "PERCENTAGE",
            "VALUE"
          ],
          "description": "The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count)."
        },
        "Target": {
          "type": "string",
          "description": "The diversity cap target. Either an integer literal (for example, \"25\") or a placeholder expression of the form $name whose value is supplied at inference time through GetProfileRecommendations."
        }
      },
      "required": [
        "Name",
        "CapType",
        "Target"
      ]
    },
    "DiversityConfig": {
      "type": "object",
      "properties": {
        "DiversityColumns": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DiversityColumn"
          },
          "description": "A list of up to two diversity columns. Each column defines a cap on the number or percentage of recommended items that share the same value for that column."
        }
      }
    },
    "EventParameters": {
      "type": "object",
      "properties": {
        "EventType": {
          "type": "string",
          "description": "The type of event being tracked (e.g., 'click', 'purchase', 'view')."
        },
        "EventValueThreshold": {
          "type": "number",
          "description": "The minimum value threshold that an event must meet to be considered valid."
        },
        "EventWeight": {
          "type": "number",
          "description": "The weight of the event type. A higher weight means higher importance of the event type for the created solution."
        }
      },
      "required": [
        "EventType"
      ]
    },
    "EventsConfig": {
      "type": "object",
      "properties": {
        "EventParametersList": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EventParameters"
          },
          "description": "A list of event parameters configurations that specify how different event types should be handled."
        }
      },
      "required": [
        "EventParametersList"
      ]
    },
    "InferenceConfig": {
      "type": "object",
      "properties": {
        "MinProvisionedTPS": {
          "type": "integer",
          "description": "The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost."
        }
      }
    },
    "ProfileRecommenderConfig": {
      "type": "object",
      "properties": {
        "EventsConfig": {
          "$ref": "#/$defs/EventsConfig"
        },
        "TrainingFrequency": {
          "type": "integer",
          "description": "How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled."
        },
        "InferenceConfig": {
          "$ref": "#/$defs/InferenceConfig"
        },
        "IncludedColumns": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": "A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request."
        },
        "ExcludedColumns": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": "A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request."
        },
        "DiversityConfig": {
          "$ref": "#/$defs/DiversityConfig"
        }
      }
    },
    "RecommenderUpdate": {
      "type": "object",
      "properties": {
        "RecommenderConfig": {
          "$ref": "#/$defs/ProfileRecommenderConfig"
        },
        "Status": {
          "type": "string",
          "enum": [
            "PENDING",
            "IN_PROGRESS",
            "ACTIVE",
            "FAILED",
            "STOPPING",
            "INACTIVE",
            "STARTING",
            "DELETING"
          ],
          "description": "The current status of the recommender update operation."
        },
        "CreatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when this recommender update was initiated."
        },
        "LastUpdatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp of when the recommender was edited."
        },
        "FailureReason": {
          "type": "string",
          "description": "If the update operation failed, provides the reason for the failure."
        },
        "RecommenderVersionName": {
          "type": "string",
          "description": "The name of the recommender version associated with this update operation."
        }
      }
    },
    "TrainingMetrics": {
      "type": "object",
      "properties": {
        "Time": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when these training metrics were recorded."
        },
        "Metrics": {
          "type": "object",
          "additionalProperties": {
            "type": "number"
          },
          "description": "A collection of performance metrics and statistics from the training process."
        },
        "RecommenderVersionName": {
          "type": "string",
          "description": "The name of the recommender version that produced these training metrics."
        }
      }
    }
  }
}