Type Alias MlAPI

type MlAPI = {
    activateModelsMlDeployment: typeof activateModelsMlDeployment;
    addMlDeploymentModels: typeof addMlDeploymentModels;
    cancelMlJob: typeof cancelMlJob;
    clearCache: typeof clearCache;
    createMlDeployment: typeof createMlDeployment;
    createMlDeploymentAliase: typeof createMlDeploymentAliase;
    createMlDeploymentBatchPrediction: typeof createMlDeploymentBatchPrediction;
    createMlExperiment: typeof createMlExperiment;
    createMlExperimentVersion: typeof createMlExperimentVersion;
    createMlProfileInsight: typeof createMlProfileInsight;
    deactivateModelsMlDeployment: typeof deactivateModelsMlDeployment;
    deleteMlDeployment: typeof deleteMlDeployment;
    deleteMlDeploymentAliase: typeof deleteMlDeploymentAliase;
    deleteMlDeploymentBatchPrediction: typeof deleteMlDeploymentBatchPrediction;
    deleteMlDeploymentBatchPredictionSchedule: typeof deleteMlDeploymentBatchPredictionSchedule;
    deleteMlExperiment: typeof deleteMlExperiment;
    deleteMlExperimentVersion: typeof deleteMlExperimentVersion;
    getMlDeployment: typeof getMlDeployment;
    getMlDeploymentAliase: typeof getMlDeploymentAliase;
    getMlDeploymentAliases: typeof getMlDeploymentAliases;
    getMlDeploymentBatchPrediction: typeof getMlDeploymentBatchPrediction;
    getMlDeploymentBatchPredictions: typeof getMlDeploymentBatchPredictions;
    getMlDeploymentBatchPredictionSchedule: typeof getMlDeploymentBatchPredictionSchedule;
    getMlDeployments: typeof getMlDeployments;
    getMlExperiment: typeof getMlExperiment;
    getMlExperimentModel: typeof getMlExperimentModel;
    getMlExperimentModels: typeof getMlExperimentModels;
    getMlExperiments: typeof getMlExperiments;
    getMlExperimentVersion: typeof getMlExperimentVersion;
    getMlExperimentVersions: typeof getMlExperimentVersions;
    getMlProfileInsight: typeof getMlProfileInsight;
    getMlProfileInsightWithQuery: typeof getMlProfileInsightWithQuery;
    patchMlDeployment: typeof patchMlDeployment;
    patchMlDeploymentAliase: typeof patchMlDeploymentAliase;
    patchMlDeploymentBatchPrediction: typeof patchMlDeploymentBatchPrediction;
    patchMlExperiment: typeof patchMlExperiment;
    patchMlExperimentVersion: typeof patchMlExperimentVersion;
    predictMlDeploymentBatchPrediction: typeof predictMlDeploymentBatchPrediction;
    recommendModelsMlExperiment: typeof recommendModelsMlExperiment;
    removeMlDeploymentModels: typeof removeMlDeploymentModels;
    runMlDeploymentAliaseRealtimePredictions: typeof runMlDeploymentAliaseRealtimePredictions;
    runMlDeploymentRealtimePredictions: typeof runMlDeploymentRealtimePredictions;
    setMlDeploymentBatchPredictionSchedule: typeof setMlDeploymentBatchPredictionSchedule;
    updateMlDeploymentBatchPredictionSchedule: typeof updateMlDeploymentBatchPredictionSchedule;
}
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: typeof activateModelsMlDeployment

Activate the model for this deployment

ID of the deployment

ActivateModelsMlDeploymentHttpError

addMlDeploymentModels: typeof addMlDeploymentModels

Add deployed models for this deployment

ID of the deployment

Param: body

an object with the body content

AddMlDeploymentModelsHttpError

cancelMlJob: typeof cancelMlJob

Cancels jobs for an experiment version or batch prediction.

The type of a resource paired with a corrId

The ID of a correlated resource of corrType

CancelMlJobHttpError

clearCache: typeof clearCache

Clears the cache for ml api requests.

createMlDeployment: typeof createMlDeployment

Create a deployment

Param: body

an object with the body content

CreateMlDeploymentHttpError

createMlDeploymentAliase: typeof createMlDeploymentAliase

Creates an alias for a deployment.

ID of the deployment

Param: body

an object with the body content

CreateMlDeploymentAliaseHttpError

createMlDeploymentBatchPrediction: typeof createMlDeploymentBatchPrediction

Create a prediction configuration

ID of the deployment

Param: body

an object with the body content

CreateMlDeploymentBatchPredictionHttpError

createMlExperiment: typeof createMlExperiment

Create an experiment

Param: body

an object with the body content

CreateMlExperimentHttpError

createMlExperimentVersion: typeof createMlExperimentVersion

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

ID of the experiment

Param: body

an object with the body content

CreateMlExperimentVersionHttpError

createMlProfileInsight: typeof createMlProfileInsight

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.

Param: body

an object with the body content

CreateMlProfileInsightHttpError

deactivateModelsMlDeployment: typeof deactivateModelsMlDeployment

Deactivate the model for this deployment

ID of the deployment

DeactivateModelsMlDeploymentHttpError

deleteMlDeployment: typeof deleteMlDeployment

Delete a deployment

ID of the deployment

DeleteMlDeploymentHttpError

deleteMlDeploymentAliase: typeof deleteMlDeploymentAliase

Delete an alias from a deployment.

ID of the deployment

ID of the alias

DeleteMlDeploymentAliaseHttpError

deleteMlDeploymentBatchPrediction: typeof deleteMlDeploymentBatchPrediction

Delete a batch prediction

ID of the deployment

ID of the batch prediction

DeleteMlDeploymentBatchPredictionHttpError

deleteMlDeploymentBatchPredictionSchedule: typeof deleteMlDeploymentBatchPredictionSchedule

Deletes the schedule from a batch prediction.

ID of the deployment

ID of the batch prediction

DeleteMlDeploymentBatchPredictionScheduleHttpError

deleteMlExperiment: typeof deleteMlExperiment

Delete an experiment

ID of the experiment

DeleteMlExperimentHttpError

deleteMlExperimentVersion: typeof deleteMlExperimentVersion

Delete an experiment version

ID of the experiment

ID of the experiment version

DeleteMlExperimentVersionHttpError

getMlDeployment: typeof getMlDeployment

Get a deployment

ID of the deployment

GetMlDeploymentHttpError

getMlDeploymentAliase: typeof getMlDeploymentAliase

Retrieves an alias that exists on the deployment.

ID of the deployment

ID of the alias

GetMlDeploymentAliaseHttpError

getMlDeploymentAliases: typeof getMlDeploymentAliases

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

ID of the deployment

an object with query parameters

GetMlDeploymentAliasesHttpError

getMlDeploymentBatchPrediction: typeof getMlDeploymentBatchPrediction

Retrieve a batch prediction

ID of the deployment

ID of the batch prediction

GetMlDeploymentBatchPredictionHttpError

getMlDeploymentBatchPredictions: typeof getMlDeploymentBatchPredictions

List batch prediction configurations

ID of the deployment

an object with query parameters

GetMlDeploymentBatchPredictionsHttpError

getMlDeploymentBatchPredictionSchedule: typeof getMlDeploymentBatchPredictionSchedule

Retrieves the schedule for a batch prediction.

ID of the deployment

ID of the batch prediction

GetMlDeploymentBatchPredictionScheduleHttpError

getMlDeployments: typeof getMlDeployments

List deployments

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

an object with query parameters

GetMlDeploymentsHttpError

getMlExperiment: typeof getMlExperiment

Get an experiment

ID of the experiment

GetMlExperimentHttpError

getMlExperimentModel: typeof getMlExperimentModel

Get a model

ID of the experiment

ID of the model

GetMlExperimentModelHttpError

getMlExperimentModels: typeof getMlExperimentModels

List models

ID of the experiment

an object with query parameters

GetMlExperimentModelsHttpError

getMlExperiments: typeof getMlExperiments

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

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

an object with query parameters

GetMlExperimentsHttpError

getMlExperimentVersion: typeof getMlExperimentVersion

Get an experiment version

ID of the experiment

ID of the experiment version

GetMlExperimentVersionHttpError

getMlExperimentVersions: typeof getMlExperimentVersions

List experiment versions

ID of the experiment

an object with query parameters

GetMlExperimentVersionsHttpError

getMlProfileInsight: typeof getMlProfileInsight

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.

The Qlik catalog dataset ID

GetMlProfileInsightHttpError

getMlProfileInsightWithQuery: typeof getMlProfileInsightWithQuery

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.

The Qlik catalog dataset ID

an object with query parameters

GetMlProfileInsightWithQueryHttpError

patchMlDeployment: typeof patchMlDeployment

Update a deployment

ID of the deployment

Param: body

an object with the body content

PatchMlDeploymentHttpError

patchMlDeploymentAliase: typeof patchMlDeploymentAliase

Updates an alias for a deployment.

ID of the deployment

ID of the alias

Param: body

an object with the body content

PatchMlDeploymentAliaseHttpError

patchMlDeploymentBatchPrediction: typeof patchMlDeploymentBatchPrediction

Updates a batch prediction

ID of the deployment

ID of the batch prediction

Param: body

an object with the body content

PatchMlDeploymentBatchPredictionHttpError

patchMlExperiment: typeof patchMlExperiment

Update an experiment

ID of the experiment

Param: body

an object with the body content

PatchMlExperimentHttpError

patchMlExperimentVersion: typeof patchMlExperimentVersion

Update an experiment version

ID of the experiment

ID of the experiment version

Param: body

an object with the body content

PatchMlExperimentVersionHttpError

predictMlDeploymentBatchPrediction: typeof predictMlDeploymentBatchPrediction

Run a batch prediction

ID of the deployment

ID of the batch prediction

PredictMlDeploymentBatchPredictionHttpError

recommendModelsMlExperiment: typeof recommendModelsMlExperiment

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

ID of the experiment

Param: body

an object with the body content

RecommendModelsMlExperimentHttpError

removeMlDeploymentModels: typeof removeMlDeploymentModels

Remove deployed models from this deployment

ID of the deployment

Param: body

an object with the body content

RemoveMlDeploymentModelsHttpError

runMlDeploymentAliaseRealtimePredictions: typeof runMlDeploymentAliaseRealtimePredictions

Generate predictions in a synchronous request/response

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: typeof runMlDeploymentRealtimePredictions

Generate predictions in a synchronous request/response

ID of the deployment

an object with query parameters

Param: body

an object with the body content

RunMlDeploymentRealtimePredictionsHttpError

setMlDeploymentBatchPredictionSchedule: typeof setMlDeploymentBatchPredictionSchedule

Adds a schedule to a batch prediction.

ID of the deployment

ID of the batch prediction

Param: body

an object with the body content

SetMlDeploymentBatchPredictionScheduleHttpError

updateMlDeploymentBatchPredictionSchedule: typeof updateMlDeploymentBatchPredictionSchedule

Updates the schedule for a batch prediction.

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