Type Alias ProfileInsights

Insights (metadata) about an experiment dataset

type ProfileInsights = {
    algorithms?: ModelAlgorithm[];
    defaultVersionConfig?: {
        dataSetId: DataSetId;
        datasetOrigin: DatasetOrigin;
        experimentMode: ExperimentMode;
        featuresList?: FeaturesList;
        name: string;
    };
    experimentVersionId?: string;
    insights?: FeatureInsights[];
    isLargeCsv?: boolean;
    numberOfRows?: number;
    ownerId: OwnerId;
    sizeInBytes?: number;
    status: "pending"
    | "error"
    | "ready";
    tenantId: TenantId;
}
Index

Properties

algorithms?: ModelAlgorithm[]

List of algorithms available for the selected experiment type

defaultVersionConfig?: {
    dataSetId: DataSetId;
    datasetOrigin: DatasetOrigin;
    experimentMode: ExperimentMode;
    featuresList?: FeaturesList;
    name: string;
}

Type Declaration

  • dataSetId: DataSetId

    The Qlik catalog dataset ID

  • datasetOrigin: DatasetOrigin
  • experimentMode: ExperimentMode
  • OptionalfeaturesList?: FeaturesList

    List of features from your dataset for creating Experiment Versions. This appears in from ProfileInsights response (in the defaultVersionConfig). You can adjust the default settings before using it as input to create or update Experiment Versions.

  • name: string
experimentVersionId?: string

Optional experiment version ID. When included, it indicates that this dataset profile is a snapshot from a previous version.

insights?: FeatureInsights[]
isLargeCsv?: boolean
numberOfRows?: number

Number of rows in the dataset.

When isLargeCsv is true, this is an estimate since their metadata is based on a sample rather than the full dataset.

For datasets over 1GB, multiply rows (this) by columns (features included in experiment version) to calculate total cells to ensure it stays under your license limit. Large CSVs have a hard 100M cell limit.

ownerId: OwnerId
sizeInBytes?: number
status: "pending" | "error" | "ready"
tenantId: TenantId