RestApiCategories.autoMachineLearning.desc

auto_machine_learning

2024.10

2024.09

2024.08

2024.11

2024.12

The Machine Learning Pipeline Automation (MLPA) API enables CRUD operations on automation projects, which automates VDMML project creation, pipeline building and training, and the production of champion models.

Machine Learning Pipeline Automation

2023.10

2023.03

2024.03

Viya_35

Update state of the automation project with the ID from the path. The automation project state is considered a single piece of information and operations on state are atomic. State update is completely controlled by the state machine based on current state and intended state.

projectId

value

Automation Project state. One of the enums [pending, preparing, waiting, ready, modeling, constructingPipeline, runningPipeline, quiescing, quiesced, completed, canceled, failed, oversampling, retraining].

Automation Project State

The state of automation project was updated.

Error

application/vnd.sas.error

No automation project with the provided entity ID was found.

There was a conflict with the current state of the target resource.

Transition from current to desired state is not permitted.

Update state of the specified automation project

Describes the behavior of a supervised learning algorithm during pipeline generation. One of the enums [consider, exclude, forceInclude].

Supervised Learning Algorithm Behavior in Pipeline Generation

Supervised Learning Algorithm. One of the enums [DecisionTree, Forest, GAM, GradientBoosting, NeuralNetwork, Regression, Ensemble, SVM].

Supervised Learning Algorithm

A collection of settings to configure a supervised learning algorithm. defaultBehavior field is read-only.

Supervised Learning Algorithm Settings in Pipeline Generation

This object contains a list of supervised learning algorithms.

Supervised Learning Algorithm Collection

This object contains a list of analytics project attributes related to Model Studio project settings.


Analytics Project Attributes

This object contains a list of automation project objects.

Machine Learning Pipeline Automation Project Collection

This object contains metadata and information about an automation project.

Machine Learning Pipeline Automation Project

The collection of application/vnd.sas.analytics.report+json representations.

Report Collection

This object contains a summary of champion model.

Champion Model

This object contains the response to a champion model action.

Champion Model Action Response

This object contains publish destination information.

Publish Destination

Score Data Input

Score Data Output

This object contains a data field name value pair for score data inputs and outputs.

Score Data Field Name/Value Pair

A collection of optional settings to configure an automation project after Model Studio project is created based on analyticsProjectAttributes.


Automation Project Settings

This object contains a list of machine learning pipeline templates.

Machine Learning Pipeline Template Collection

This object contains information for a pipeline template that can be used in project creation.

Machine Learning Pipeline Template

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Base Collection

An analytics report consisting of rows of data and associated metadata (parameters).

Analytics Report

Contains details about execution results. This represents application/vnd.sas.score.execution media type (version 1).

Score Execution

The list of links to top-level resources and operations available from the root of the API.

A link to a related operation or resource.

Link

Data Row

Contains request details about how to generate score. This represents application/vnd.sas.score.execution.request media type (version 1).

Score Execution Request

Output generated by score execution or analysis. This doesn't represent any top-level media type.

Output Table

Metadata describing a particular variable.

Parameter

A definition containing details about Input Data, Score Object and Mapping. This represents application/vnd.sas.score.definition media type (version 1).

Score Definition

Job Definition

Overrides the details of the existing Score definition.  This doesn't represent any top-level media type.

Override Score Definition

Job Definition Parameter

Assigning Input Data column to a variable of the generated Mapped Code of Score Object. This doesn't represent any top-level media type.

Mapping

Input Data that will be scored.  This doesn't represent any top-level media type.

Input Data

Descriptor of a Score Object whose logic is used to produce a score for Input Data. This doesn't represent any top-level media type.

Object Descriptor

A pair consisting of a string name and a string value. This is an element of `application/vnd.sas.properties`

Status	Meaning	Description
202	Accepted	The state of automation project was updated.	Schema
400	Bad Request	One or more parameters were invalid.	Schema
404	Not Found	No automation project with the provided entity ID was found.	Schema
409	Conflict	Transition from current to desired state is not permitted.	Schema

Update state of the specified automation project

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses