BRbraintrustdata
DatasetSnapshots

Partially update dataset snapshot

Changed on

Partially update a dataset snapshot object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/dataset_snapshot/{dataset_snapshot_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

dataset_snapshot_idstring uuid required

DatasetSnapshot id

Request body

namestring nullable

Name of the dataset snapshot

descriptionstring nullable

Textual description of the dataset snapshot

Response

Returns the dataset snapshot object

idstring uuid required

Unique identifier for the dataset snapshot

dataset_idstring uuid required

Unique identifier for the dataset that this snapshot belongs to

namestring required

Name of the dataset snapshot

descriptionstring nullable required
xact_idstring required

Transaction id of the brainstore version at the time of the snapshot

createdstring date-time nullable required

Date of dataset snapshot creation

Changes