Commit

POST

Commit a version of the Dataset with a commit message.

If the version is already committed, an exception will be raised.

Path parameters

idstringRequired
Unique identifier for Dataset.
version_idstringRequired
Unique identifier for the specific version of the Dataset.

Request

This endpoint expects an object.
commit_messagestringRequired
Message describing the changes made.

Response

This endpoint returns an object.
pathstring
Path of the Dataset, including the name, which is used as a unique identifier.
idstring

Unique identifier for the Dataset. Starts with ds_.

namestring
Name of the Dataset, which is used as a unique identifier.
version_idstring

Unique identifier for the specific Dataset Version. If no query params provided, the default deployed Dataset Version is returned. Starts with dsv_.

created_atdatetime
updated_atdatetime
statusenum
Allowed values: uncommittedcommitteddeleted
The status of the Dataset Version.
last_used_atdatetime
datapoints_countinteger
The number of Datapoints in this Dataset version.
directory_idstringOptional
ID of the directory that the file is in on Humanloop.
type"dataset"Optional
environmentslist of objectsOptional
The list of environments the Dataset Version is deployed to.
created_byobjectOptional
The user who created the Dataset.
commit_messagestringOptional
Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created.
datapointslist of objectsOptional
The list of Datapoints in this Dataset version. Only provided if explicitly requested.
attributesmap from strings to anyOptional
Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used.

Errors

Built with