Interface MlAPI

interface MlAPI {
    activateModelsMlDeployment: (
        deploymentId: string,
        options?: ApiCallOptions,
    ) => Promise<ActivateModelsMlDeploymentHttpResponse>;
    addMlDeploymentModels: (
        deploymentId: string,
        body: DeployedModelsInput,
        options?: ApiCallOptions,
    ) => Promise<AddMlDeploymentModelsHttpResponse>;
    cancelMlJob: (
        corrType: string,
        corrId: string,
        options?: ApiCallOptions,
    ) => Promise<CancelMlJobHttpResponse>;
    clearCache: () => void;
    createMlDeployment: (
        body: DeploymentInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlDeploymentHttpResponse>;
    createMlDeploymentAliase: (
        deploymentId: string,
        body: AliasInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlDeploymentAliaseHttpResponse>;
    createMlDeploymentBatchPrediction: (
        deploymentId: string,
        body: BatchPredictionInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlDeploymentBatchPredictionHttpResponse>;
    createMlExperiment: (
        body: ExperimentInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlExperimentHttpResponse>;
    createMlExperimentVersion: (
        experimentId: string,
        body: ExperimentVersionInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlExperimentVersionHttpResponse>;
    createMlProfileInsight: (
        body: ProfileInsightsInput,
        options?: ApiCallOptions,
    ) => Promise<CreateMlProfileInsightHttpResponse>;
    deactivateModelsMlDeployment: (
        deploymentId: string,
        options?: ApiCallOptions,
    ) => Promise<DeactivateModelsMlDeploymentHttpResponse>;
    deleteMlDeployment: (
        deploymentId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlDeploymentHttpResponse>;
    deleteMlDeploymentAliase: (
        deploymentId: string,
        aliasId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlDeploymentAliaseHttpResponse>;
    deleteMlDeploymentBatchPrediction: (
        deploymentId: string,
        batchPredictionId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlDeploymentBatchPredictionHttpResponse>;
    deleteMlDeploymentBatchPredictionSchedule: (
        deploymentId: string,
        batchPredictionId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlDeploymentBatchPredictionScheduleHttpResponse>;
    deleteMlExperiment: (
        experimentId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlExperimentHttpResponse>;
    deleteMlExperimentVersion: (
        experimentId: string,
        experimentVersionId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteMlExperimentVersionHttpResponse>;
    getMlDeployment: (
        deploymentId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentHttpResponse>;
    getMlDeploymentAliase: (
        deploymentId: string,
        aliasId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentAliaseHttpResponse>;
    getMlDeploymentAliases: (
        deploymentId: string,
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortAliases;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentAliasesHttpResponse>;
    getMlDeploymentBatchPrediction: (
        deploymentId: string,
        batchPredictionId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentBatchPredictionHttpResponse>;
    getMlDeploymentBatchPredictions: (
        deploymentId: string,
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortBatchPredictions;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentBatchPredictionsHttpResponse>;
    getMlDeploymentBatchPredictionSchedule: (
        deploymentId: string,
        batchPredictionId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentBatchPredictionScheduleHttpResponse>;
    getMlDeployments: (
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortDeployments;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlDeploymentsHttpResponse>;
    getMlExperiment: (
        experimentId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentHttpResponse>;
    getMlExperimentModel: (
        experimentId: string,
        modelId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentModelHttpResponse>;
    getMlExperimentModels: (
        experimentId: string,
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortModels;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentModelsHttpResponse>;
    getMlExperiments: (
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortExperiments;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentsHttpResponse>;
    getMlExperimentVersion: (
        experimentId: string,
        experimentVersionId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentVersionHttpResponse>;
    getMlExperimentVersions: (
        experimentId: string,
        query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortExperimentVersions;
        },
        options?: ApiCallOptions,
    ) => Promise<GetMlExperimentVersionsHttpResponse>;
    getMlProfileInsight: (
        dataSetId: string,
        options?: ApiCallOptions,
    ) => Promise<GetMlProfileInsightHttpResponse>;
    getMlProfileInsightWithQuery: (
        dataSetId: string,
        query: { experimentType?: ExperimentType; target?: string },
        options?: ApiCallOptions,
    ) => Promise<GetMlProfileInsightWithQueryHttpResponse>;
    patchMlDeployment: (
        deploymentId: string,
        body: DeploymentPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchMlDeploymentHttpResponse>;
    patchMlDeploymentAliase: (
        deploymentId: string,
        aliasId: string,
        body: AliasPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchMlDeploymentAliaseHttpResponse>;
    patchMlDeploymentBatchPrediction: (
        deploymentId: string,
        batchPredictionId: string,
        body: BatchPredictionPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchMlDeploymentBatchPredictionHttpResponse>;
    patchMlExperiment: (
        experimentId: string,
        body: ExperimentPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchMlExperimentHttpResponse>;
    patchMlExperimentVersion: (
        experimentId: string,
        experimentVersionId: string,
        body: ExperimentVersionPatch,
        options?: ApiCallOptions,
    ) => Promise<PatchMlExperimentVersionHttpResponse>;
    predictMlDeploymentBatchPrediction: (
        deploymentId: string,
        batchPredictionId: string,
        options?: ApiCallOptions,
    ) => Promise<PredictMlDeploymentBatchPredictionHttpResponse>;
    recommendModelsMlExperiment: (
        experimentId: string,
        body: ExperimentModelRecommendationFilter,
        options?: ApiCallOptions,
    ) => Promise<RecommendModelsMlExperimentHttpResponse>;
    removeMlDeploymentModels: (
        deploymentId: string,
        body: DeployedModelsInput,
        options?: ApiCallOptions,
    ) => Promise<RemoveMlDeploymentModelsHttpResponse>;
    runMlDeploymentAliaseRealtimePredictions: (
        deploymentId: string,
        aliasName: string,
        query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        },
        body: RealtimePredictionInput,
        options?: ApiCallOptions,
    ) => Promise<RunMlDeploymentAliaseRealtimePredictionsHttpResponse>;
    runMlDeploymentRealtimePredictions: (
        deploymentId: string,
        query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        },
        body: RealtimePredictionInput,
        options?: ApiCallOptions,
    ) => Promise<RunMlDeploymentRealtimePredictionsHttpResponse>;
    setMlDeploymentBatchPredictionSchedule: (
        deploymentId: string,
        batchPredictionId: string,
        body: BatchPredictionScheduleInput,
        options?: ApiCallOptions,
    ) => Promise<SetMlDeploymentBatchPredictionScheduleHttpResponse>;
    updateMlDeploymentBatchPredictionSchedule: (
        deploymentId: string,
        batchPredictionId: string,
        body: BatchPredictionSchedulePatch,
        options?: ApiCallOptions,
    ) => Promise<UpdateMlDeploymentBatchPredictionScheduleHttpResponse>;
}
Index

Properties

activateModelsMlDeployment addMlDeploymentModels cancelMlJob clearCache createMlDeployment createMlDeploymentAliase createMlDeploymentBatchPrediction createMlExperiment createMlExperimentVersion createMlProfileInsight deactivateModelsMlDeployment deleteMlDeployment deleteMlDeploymentAliase deleteMlDeploymentBatchPrediction deleteMlDeploymentBatchPredictionSchedule deleteMlExperiment deleteMlExperimentVersion getMlDeployment getMlDeploymentAliase getMlDeploymentAliases getMlDeploymentBatchPrediction getMlDeploymentBatchPredictions getMlDeploymentBatchPredictionSchedule getMlDeployments getMlExperiment getMlExperimentModel getMlExperimentModels getMlExperiments getMlExperimentVersion getMlExperimentVersions getMlProfileInsight getMlProfileInsightWithQuery patchMlDeployment patchMlDeploymentAliase patchMlDeploymentBatchPrediction patchMlExperiment patchMlExperimentVersion predictMlDeploymentBatchPrediction recommendModelsMlExperiment removeMlDeploymentModels runMlDeploymentAliaseRealtimePredictions runMlDeploymentRealtimePredictions setMlDeploymentBatchPredictionSchedule updateMlDeploymentBatchPredictionSchedule

Properties

activateModelsMlDeployment: (
    deploymentId: string,
    options?: ApiCallOptions,
) => Promise<ActivateModelsMlDeploymentHttpResponse>

Activate the model for this deployment

Type Declaration

ID of the deployment

ActivateModelsMlDeploymentHttpError

addMlDeploymentModels: (
    deploymentId: string,
    body: DeployedModelsInput,
    options?: ApiCallOptions,
) => Promise<AddMlDeploymentModelsHttpResponse>

Add deployed models for this deployment

Type Declaration

ID of the deployment

Param: body

an object with the body content

AddMlDeploymentModelsHttpError

cancelMlJob: (
    corrType: string,
    corrId: string,
    options?: ApiCallOptions,
) => Promise<CancelMlJobHttpResponse>

Cancels jobs for an experiment version or batch prediction.

Type Declaration

    • (
          corrType: string,
          corrId: string,
          options?: ApiCallOptions,
      ): Promise<CancelMlJobHttpResponse>

    • Cancels jobs for an experiment version or batch prediction.

      Parameters

      • corrType: string

        The type of a resource paired with a corrId

      • corrId: string

        The ID of a correlated resource of corrType

      • Optionaloptions: ApiCallOptions

      Returns Promise<CancelMlJobHttpResponse>

      CancelMlJobHttpError

The type of a resource paired with a corrId

The ID of a correlated resource of corrType

CancelMlJobHttpError

clearCache: () => void

Clears the cache for ml api requests.

Type Declaration

    • (): void

    • Clears the cache for ml api requests.

      Returns void

createMlDeployment: (
    body: DeploymentInput,
    options?: ApiCallOptions,
) => Promise<CreateMlDeploymentHttpResponse>

Create a deployment

Type Declaration

Param: body

an object with the body content

CreateMlDeploymentHttpError

createMlDeploymentAliase: (
    deploymentId: string,
    body: AliasInput,
    options?: ApiCallOptions,
) => Promise<CreateMlDeploymentAliaseHttpResponse>

Creates an alias for a deployment.

Type Declaration

ID of the deployment

Param: body

an object with the body content

CreateMlDeploymentAliaseHttpError

createMlDeploymentBatchPrediction: (
    deploymentId: string,
    body: BatchPredictionInput,
    options?: ApiCallOptions,
) => Promise<CreateMlDeploymentBatchPredictionHttpResponse>

Create a prediction configuration

Type Declaration

ID of the deployment

Param: body

an object with the body content

CreateMlDeploymentBatchPredictionHttpError

createMlExperiment: (
    body: ExperimentInput,
    options?: ApiCallOptions,
) => Promise<CreateMlExperimentHttpResponse>

Create an experiment

Type Declaration

Param: body

an object with the body content

CreateMlExperimentHttpError

createMlExperimentVersion: (
    experimentId: string,
    body: ExperimentVersionInput,
    options?: ApiCallOptions,
) => Promise<CreateMlExperimentVersionHttpResponse>

Creates an experiment version. Poll this version and check its status field to determine when models are finished training.

Type Declaration

ID of the experiment

Param: body

an object with the body content

CreateMlExperimentVersionHttpError

createMlProfileInsight: (
    body: ProfileInsightsInput,
    options?: ApiCallOptions,
) => Promise<CreateMlProfileInsightHttpResponse>

Starts creating profile insights for an experiment dataset. This is an asynchronous operation. A 202 Accepted response indicates that the process has started successfully. Use the link in the response to check the status.

Type Declaration

Param: body

an object with the body content

CreateMlProfileInsightHttpError

deactivateModelsMlDeployment: (
    deploymentId: string,
    options?: ApiCallOptions,
) => Promise<DeactivateModelsMlDeploymentHttpResponse>

Deactivate the model for this deployment

Type Declaration

ID of the deployment

DeactivateModelsMlDeploymentHttpError

deleteMlDeployment: (
    deploymentId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlDeploymentHttpResponse>

Delete a deployment

Type Declaration

ID of the deployment

DeleteMlDeploymentHttpError

deleteMlDeploymentAliase: (
    deploymentId: string,
    aliasId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlDeploymentAliaseHttpResponse>

Delete an alias from a deployment.

Type Declaration

ID of the deployment

ID of the alias

DeleteMlDeploymentAliaseHttpError

deleteMlDeploymentBatchPrediction: (
    deploymentId: string,
    batchPredictionId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlDeploymentBatchPredictionHttpResponse>

Delete a batch prediction

Type Declaration

ID of the deployment

ID of the batch prediction

DeleteMlDeploymentBatchPredictionHttpError

deleteMlDeploymentBatchPredictionSchedule: (
    deploymentId: string,
    batchPredictionId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlDeploymentBatchPredictionScheduleHttpResponse>

Deletes the schedule from a batch prediction.

Type Declaration

ID of the deployment

ID of the batch prediction

DeleteMlDeploymentBatchPredictionScheduleHttpError

deleteMlExperiment: (
    experimentId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlExperimentHttpResponse>

Delete an experiment

Type Declaration

ID of the experiment

DeleteMlExperimentHttpError

deleteMlExperimentVersion: (
    experimentId: string,
    experimentVersionId: string,
    options?: ApiCallOptions,
) => Promise<DeleteMlExperimentVersionHttpResponse>

Delete an experiment version

Type Declaration

ID of the experiment

ID of the experiment version

DeleteMlExperimentVersionHttpError

getMlDeployment: (
    deploymentId: string,
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentHttpResponse>

Get a deployment

Type Declaration

ID of the deployment

GetMlDeploymentHttpError

getMlDeploymentAliase: (
    deploymentId: string,
    aliasId: string,
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentAliaseHttpResponse>

Retrieves an alias that exists on the deployment.

Type Declaration

ID of the deployment

ID of the alias

GetMlDeploymentAliaseHttpError

getMlDeploymentAliases: (
    deploymentId: string,
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortAliases;
    },
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentAliasesHttpResponse>

Retrieves a list of aliases based on filter parameters for a deployment.

Type Declaration

    • (
          deploymentId: string,
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortAliases;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlDeploymentAliasesHttpResponse>

    • Retrieves a list of aliases based on filter parameters for a deployment.

      Parameters

      • deploymentId: string

        ID of the deployment

      • query: { filter?: string; limit?: number; offset?: number; sort?: EnumSortAliases }

        an object with query parameters

        • Optionalfilter?: string

          Alias fields by which you can filter responses

          • name string - Aliases with exact name
          • modelId UUID string - By model ID
          • mode enum string - Mode by which alias is set to
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortAliases

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlDeploymentAliasesHttpResponse>

      GetMlDeploymentAliasesHttpError

ID of the deployment

an object with query parameters

GetMlDeploymentAliasesHttpError

getMlDeploymentBatchPrediction: (
    deploymentId: string,
    batchPredictionId: string,
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentBatchPredictionHttpResponse>

Retrieve a batch prediction

Type Declaration

ID of the deployment

ID of the batch prediction

GetMlDeploymentBatchPredictionHttpError

getMlDeploymentBatchPredictions: (
    deploymentId: string,
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortBatchPredictions;
    },
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentBatchPredictionsHttpResponse>

List batch prediction configurations

Type Declaration

    • (
          deploymentId: string,
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortBatchPredictions;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlDeploymentBatchPredictionsHttpResponse>

    • List batch prediction configurations

      Parameters

      • deploymentId: string

        ID of the deployment

      • query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortBatchPredictions;
        }

        an object with query parameters

        • Optionalfilter?: string

          Batch prediction fields by which you can filter responses.

          • modelId UUID string - By model ID
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortBatchPredictions

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlDeploymentBatchPredictionsHttpResponse>

      GetMlDeploymentBatchPredictionsHttpError

ID of the deployment

an object with query parameters

GetMlDeploymentBatchPredictionsHttpError

getMlDeploymentBatchPredictionSchedule: (
    deploymentId: string,
    batchPredictionId: string,
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentBatchPredictionScheduleHttpResponse>

Retrieves the schedule for a batch prediction.

Type Declaration

ID of the deployment

ID of the batch prediction

GetMlDeploymentBatchPredictionScheduleHttpError

getMlDeployments: (
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortDeployments;
    },
    options?: ApiCallOptions,
) => Promise<GetMlDeploymentsHttpResponse>

List deployments

Type Declaration

    • (
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortDeployments;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlDeploymentsHttpResponse>

    • List deployments

      Parameters

      • query: { filter?: string; limit?: number; offset?: number; sort?: EnumSortDeployments }

        an object with query parameters

        • Optionalfilter?: string

          Deployment fields by which you can filter responses.

          • spaceId ID string (or empty string for personal space) - ID of space in which deployment(s) exist
          • modelId UUID string - By model ID
          • createdBy ID string
          • ownerId ID string
          • approverId ID string - ID of user that approved a model in the deployment
          • experimentId UUID string - ID of experiment in which model(s) exist
          • experimentVersionId UUID string - ID of experiment version in which model(s) exist
          • predictionEnabled boolean - Are predictions enabled
          • exactName string - Deployments with exact name. Names may not be unique.
          • nameContains string - Deployments where name includes this. Names may not be unique
          • modelName string - Partial or exact, case-insensitive name of model in the deployment
          • modelState enum string - State by which to find models

            • Valid states: pending, enabled, disabled, inactive
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortDeployments

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlDeploymentsHttpResponse>

      getMlDeployments(
        {
          filter: "`filter=spaceId eq \"UUID\" and modelState eq \"enabled\"`",
          limit: 10,
          offset: 32
        }
      )

      GetMlDeploymentsHttpError

getMlDeployments(
  {
    filter: "`filter=spaceId eq \"UUID\" and modelState eq \"enabled\"`",
    limit: 10,
    offset: 32
  }
)

an object with query parameters

GetMlDeploymentsHttpError

getMlExperiment: (
    experimentId: string,
    options?: ApiCallOptions,
) => Promise<GetMlExperimentHttpResponse>

Get an experiment

Type Declaration

ID of the experiment

GetMlExperimentHttpError

getMlExperimentModel: (
    experimentId: string,
    modelId: string,
    options?: ApiCallOptions,
) => Promise<GetMlExperimentModelHttpResponse>

Get a model

Type Declaration

ID of the experiment

ID of the model

GetMlExperimentModelHttpError

getMlExperimentModels: (
    experimentId: string,
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortModels;
    },
    options?: ApiCallOptions,
) => Promise<GetMlExperimentModelsHttpResponse>

List models

Type Declaration

    • (
          experimentId: string,
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortModels;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlExperimentModelsHttpResponse>

    • List models

      Parameters

      • experimentId: string

        ID of the experiment

      • query: { filter?: string; limit?: number; offset?: number; sort?: EnumSortModels }

        an object with query parameters

        • Optionalfilter?: string

          Model fields you can filter by:

          • experimentVersionId UUID string - Find by experiment version ID

          • batchNum UUID string - Search by batch number

          • isHpo boolean - Is hyperparameter optimization used?

          • isMetrics boolean - Are metrics for regression, binary, or multiclass are used?

          • id UUID string - Find by model ID

          • algorithm enum string - Find by algorithm

            • Valid algorithms: catboost_classifier, catboost_regression, elasticnet_regression, gaussian_nb, kneighbors_classifier, lasso_regression, lasso, lgbm_classifier, lgbm_regression, linear_regression, logistic_regression, random_forest_classifier, random_forest_regression, sgd_regression, xgb_classifier, xgb_regression

          • status enum string - find by status

            • Valid statuses: pending, training_requested, training_done, ready, error

          • hasDeployment boolean - Models that are part of a deployment

          • nameContains string - Models with name includes this case-insensitive string

          • exactName string - Models with exact name. Model names may not be unique

          • samplingRatio number - Find models by sampling ratio

          • modelState enum string - State by which to find models

            • Valid states: pending, enabled, disabled, inactive
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortModels

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlExperimentModelsHttpResponse>

      GetMlExperimentModelsHttpError

ID of the experiment

an object with query parameters

GetMlExperimentModelsHttpError

getMlExperiments: (
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortExperiments;
    },
    options?: ApiCallOptions,
) => Promise<GetMlExperimentsHttpResponse>

Retrieves a list of experiments based on provided filter and sort parameters.

Type Declaration

    • (
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortExperiments;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlExperimentsHttpResponse>

    • Retrieves a list of experiments based on provided filter and sort parameters.

      Parameters

      • query: { filter?: string; limit?: number; offset?: number; sort?: EnumSortExperiments }

        an object with query parameters

        • Optionalfilter?: string

          Experiment fields by which you can filter responses within this tenant

          • ownerId ID string - ID of the owner/user that created the experiment
          • spaceId ID string (or empty string for personal space) - ID of the space where the experiment is saved.
          • experimentVersionId UUID string - ID of an experiment version in the experiment
          • modelId UUID string - ID of a model associated with the experiment
          • deploymentId UUID string - ID of a deployment of a model associated with the experiment
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortExperiments

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlExperimentsHttpResponse>

      getMlExperiments(
        {
          filter: "`filter=ownerId eq UUID and experimentVersionId eq UUID`",
          limit: 10,
          offset: 32
        }
      )

      GetMlExperimentsHttpError

getMlExperiments(
  {
    filter: "`filter=ownerId eq UUID and experimentVersionId eq UUID`",
    limit: 10,
    offset: 32
  }
)

an object with query parameters

GetMlExperimentsHttpError

getMlExperimentVersion: (
    experimentId: string,
    experimentVersionId: string,
    options?: ApiCallOptions,
) => Promise<GetMlExperimentVersionHttpResponse>

Get an experiment version

Type Declaration

ID of the experiment

ID of the experiment version

GetMlExperimentVersionHttpError

getMlExperimentVersions: (
    experimentId: string,
    query: {
        filter?: string;
        limit?: number;
        offset?: number;
        sort?: EnumSortExperimentVersions;
    },
    options?: ApiCallOptions,
) => Promise<GetMlExperimentVersionsHttpResponse>

List experiment versions

Type Declaration

    • (
          experimentId: string,
          query: {
              filter?: string;
              limit?: number;
              offset?: number;
              sort?: EnumSortExperimentVersions;
          },
          options?: ApiCallOptions,
      ): Promise<GetMlExperimentVersionsHttpResponse>

    • List experiment versions

      Parameters

      • experimentId: string

        ID of the experiment

      • query: {
            filter?: string;
            limit?: number;
            offset?: number;
            sort?: EnumSortExperimentVersions;
        }

        an object with query parameters

        • Optionalfilter?: string

          Experiment version filter options

          • isRunning boolean - Is the experiment version running (training models)?
          • isSettled boolean - Is the experiment version settled?
          • status enum string - Status to filter by. Omit to get models of any status.
            • Valid statuses: pending, ready, error, cancelled
          • modelId UUID string - ID of a model associated with the experiment
        • Optionallimit?: number

          Number of results per page. Default is 32.

        • Optionaloffset?: number

          Number of rows to skip before getting page[size]

        • Optionalsort?: EnumSortExperimentVersions

          Field(s) by which to sort response

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlExperimentVersionsHttpResponse>

      GetMlExperimentVersionsHttpError

ID of the experiment

an object with query parameters

GetMlExperimentVersionsHttpError

getMlProfileInsight: (
    dataSetId: string,
    options?: ApiCallOptions,
) => Promise<GetMlProfileInsightHttpResponse>

Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned.

Type Declaration

    • (
          dataSetId: string,
          options?: ApiCallOptions,
      ): Promise<GetMlProfileInsightHttpResponse>

    • Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned.

      Parameters

      • dataSetId: string

        The Qlik catalog dataset ID

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlProfileInsightHttpResponse>

      GetMlProfileInsightHttpError

The Qlik catalog dataset ID

GetMlProfileInsightHttpError

getMlProfileInsightWithQuery: (
    dataSetId: string,
    query: { experimentType?: ExperimentType; target?: string },
    options?: ApiCallOptions,
) => Promise<GetMlProfileInsightWithQueryHttpResponse>

Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned.

Type Declaration

    • (
          dataSetId: string,
          query: { experimentType?: ExperimentType; target?: string },
          options?: ApiCallOptions,
      ): Promise<GetMlProfileInsightWithQueryHttpResponse>

    • Retrieves profile insights for the specified dataset. If you received a 202 Accepted response from POST /ml/profile-insights, poll this endpoint until a 200 OK response with ready status is returned.

      Parameters

      • dataSetId: string

        The Qlik catalog dataset ID

      • query: { experimentType?: ExperimentType; target?: string }

        an object with query parameters

        • OptionalexperimentType?: ExperimentType

          The optional experiment type for profile-insights GET requests after this is known.

        • Optionaltarget?: string

          The optional target feature for profile-insights GET requests after this is known.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetMlProfileInsightWithQueryHttpResponse>

      GetMlProfileInsightWithQueryHttpError

The Qlik catalog dataset ID

an object with query parameters

GetMlProfileInsightWithQueryHttpError

patchMlDeployment: (
    deploymentId: string,
    body: DeploymentPatch,
    options?: ApiCallOptions,
) => Promise<PatchMlDeploymentHttpResponse>

Update a deployment

Type Declaration

ID of the deployment

Param: body

an object with the body content

PatchMlDeploymentHttpError

patchMlDeploymentAliase: (
    deploymentId: string,
    aliasId: string,
    body: AliasPatch,
    options?: ApiCallOptions,
) => Promise<PatchMlDeploymentAliaseHttpResponse>

Updates an alias for a deployment.

Type Declaration

ID of the deployment

ID of the alias

Param: body

an object with the body content

PatchMlDeploymentAliaseHttpError

patchMlDeploymentBatchPrediction: (
    deploymentId: string,
    batchPredictionId: string,
    body: BatchPredictionPatch,
    options?: ApiCallOptions,
) => Promise<PatchMlDeploymentBatchPredictionHttpResponse>

Updates a batch prediction

Type Declaration

ID of the deployment

ID of the batch prediction

Param: body

an object with the body content

PatchMlDeploymentBatchPredictionHttpError

patchMlExperiment: (
    experimentId: string,
    body: ExperimentPatch,
    options?: ApiCallOptions,
) => Promise<PatchMlExperimentHttpResponse>

Update an experiment

Type Declaration

ID of the experiment

Param: body

an object with the body content

PatchMlExperimentHttpError

patchMlExperimentVersion: (
    experimentId: string,
    experimentVersionId: string,
    body: ExperimentVersionPatch,
    options?: ApiCallOptions,
) => Promise<PatchMlExperimentVersionHttpResponse>

Update an experiment version

Type Declaration

ID of the experiment

ID of the experiment version

Param: body

an object with the body content

PatchMlExperimentVersionHttpError

predictMlDeploymentBatchPrediction: (
    deploymentId: string,
    batchPredictionId: string,
    options?: ApiCallOptions,
) => Promise<PredictMlDeploymentBatchPredictionHttpResponse>

Run a batch prediction

Type Declaration

ID of the deployment

ID of the batch prediction

PredictMlDeploymentBatchPredictionHttpError

recommendModelsMlExperiment: (
    experimentId: string,
    body: ExperimentModelRecommendationFilter,
    options?: ApiCallOptions,
) => Promise<RecommendModelsMlExperimentHttpResponse>

Returns model recommendations for a specified experiment, including the best-performing, fastest, and most accurate models based on evaluation metrics.

Type Declaration

ID of the experiment

Param: body

an object with the body content

RecommendModelsMlExperimentHttpError

removeMlDeploymentModels: (
    deploymentId: string,
    body: DeployedModelsInput,
    options?: ApiCallOptions,
) => Promise<RemoveMlDeploymentModelsHttpResponse>

Remove deployed models from this deployment

Type Declaration

ID of the deployment

Param: body

an object with the body content

RemoveMlDeploymentModelsHttpError

runMlDeploymentAliaseRealtimePredictions: (
    deploymentId: string,
    aliasName: string,
    query: {
        includeNotPredictedReason?: boolean;
        includeShap?: boolean;
        includeSource?: boolean;
        index?: string;
    },
    body: RealtimePredictionInput,
    options?: ApiCallOptions,
) => Promise<RunMlDeploymentAliaseRealtimePredictionsHttpResponse>

Generate predictions in a synchronous request/response

Type Declaration

    • (
          deploymentId: string,
          aliasName: string,
          query: {
              includeNotPredictedReason?: boolean;
              includeShap?: boolean;
              includeSource?: boolean;
              index?: string;
          },
          body: RealtimePredictionInput,
          options?: ApiCallOptions,
      ): Promise<RunMlDeploymentAliaseRealtimePredictionsHttpResponse>

    • Generate predictions in a synchronous request/response

      Parameters

      • deploymentId: string

        ID of the deployment

      • aliasName: string

        The name of the ML Deployment Alias that will be used to determine which model should be used to produce predictions

      • query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        }

        an object with query parameters

        • OptionalincludeNotPredictedReason?: boolean

          If true, reason why a prediction was not produced included response

        • OptionalincludeShap?: boolean

          If true, shap values included in response

        • OptionalincludeSource?: boolean

          If true, source data included in response

        • Optionalindex?: string

          The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

      • body: RealtimePredictionInput

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<RunMlDeploymentAliaseRealtimePredictionsHttpResponse>

      RunMlDeploymentAliaseRealtimePredictionsHttpError

ID of the deployment

The name of the ML Deployment Alias that will be used to determine which model should be used to produce predictions

an object with query parameters

Param: body

an object with the body content

RunMlDeploymentAliaseRealtimePredictionsHttpError

runMlDeploymentRealtimePredictions: (
    deploymentId: string,
    query: {
        includeNotPredictedReason?: boolean;
        includeShap?: boolean;
        includeSource?: boolean;
        index?: string;
    },
    body: RealtimePredictionInput,
    options?: ApiCallOptions,
) => Promise<RunMlDeploymentRealtimePredictionsHttpResponse>

Generate predictions in a synchronous request/response

Type Declaration

    • (
          deploymentId: string,
          query: {
              includeNotPredictedReason?: boolean;
              includeShap?: boolean;
              includeSource?: boolean;
              index?: string;
          },
          body: RealtimePredictionInput,
          options?: ApiCallOptions,
      ): Promise<RunMlDeploymentRealtimePredictionsHttpResponse>

    • Generate predictions in a synchronous request/response

      Parameters

      • deploymentId: string

        ID of the deployment

      • query: {
            includeNotPredictedReason?: boolean;
            includeShap?: boolean;
            includeSource?: boolean;
            index?: string;
        }

        an object with query parameters

        • OptionalincludeNotPredictedReason?: boolean

          If true, reason why a prediction was not produced included response

        • OptionalincludeShap?: boolean

          If true, shapley values included in response

        • OptionalincludeSource?: boolean

          If true, source data included in response

        • Optionalindex?: string

          The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

      • body: RealtimePredictionInput

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<RunMlDeploymentRealtimePredictionsHttpResponse>

      RunMlDeploymentRealtimePredictionsHttpError

ID of the deployment

an object with query parameters

Param: body

an object with the body content

RunMlDeploymentRealtimePredictionsHttpError

setMlDeploymentBatchPredictionSchedule: (
    deploymentId: string,
    batchPredictionId: string,
    body: BatchPredictionScheduleInput,
    options?: ApiCallOptions,
) => Promise<SetMlDeploymentBatchPredictionScheduleHttpResponse>

Adds a schedule to a batch prediction.

Type Declaration

ID of the deployment

ID of the batch prediction

Param: body

an object with the body content

SetMlDeploymentBatchPredictionScheduleHttpError

updateMlDeploymentBatchPredictionSchedule: (
    deploymentId: string,
    batchPredictionId: string,
    body: BatchPredictionSchedulePatch,
    options?: ApiCallOptions,
) => Promise<UpdateMlDeploymentBatchPredictionScheduleHttpResponse>

Updates the schedule for a batch prediction.

Type Declaration

ID of the deployment

ID of the batch prediction

Param: body

an object with the body content

UpdateMlDeploymentBatchPredictionScheduleHttpError

Settings

Member Visibility

On This Page

Properties
activateModelsMlDeploymentaddMlDeploymentModelscancelMlJobclearCachecreateMlDeploymentcreateMlDeploymentAliasecreateMlDeploymentBatchPredictioncreateMlExperimentcreateMlExperimentVersioncreateMlProfileInsightdeactivateModelsMlDeploymentdeleteMlDeploymentdeleteMlDeploymentAliasedeleteMlDeploymentBatchPredictiondeleteMlDeploymentBatchPredictionScheduledeleteMlExperimentdeleteMlExperimentVersiongetMlDeploymentgetMlDeploymentAliasegetMlDeploymentAliasesgetMlDeploymentBatchPredictiongetMlDeploymentBatchPredictionsgetMlDeploymentBatchPredictionSchedulegetMlDeploymentsgetMlExperimentgetMlExperimentModelgetMlExperimentModelsgetMlExperimentsgetMlExperimentVersiongetMlExperimentVersionsgetMlProfileInsightgetMlProfileInsightWithQuerypatchMlDeploymentpatchMlDeploymentAliasepatchMlDeploymentBatchPredictionpatchMlExperimentpatchMlExperimentVersionpredictMlDeploymentBatchPredictionrecommendModelsMlExperimentremoveMlDeploymentModelsrunMlDeploymentAliaseRealtimePredictionsrunMlDeploymentRealtimePredictionssetMlDeploymentBatchPredictionScheduleupdateMlDeploymentBatchPredictionSchedule