BRbraintrustdata
Datasets

Partially update dataset

Changed on

Partially update a dataset 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/{dataset_id}

Request

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

Path parameters

dataset_idstring uuid required

Dataset id

Request body

namestring nullable

Name of the dataset. Within a project, dataset names are unique

descriptionstring nullable

Textual description of the dataset

tagsstring[] nullable

A list of tags for the dataset

metadataobject nullable

User-controlled metadata about the dataset

Response

Returns the dataset object

idstring uuid required

Unique identifier for the dataset

project_idstring uuid required

Unique identifier for the project that the dataset belongs under

namestring required

Name of the dataset. Within a project, dataset names are unique

descriptionstring nullable

Textual description of the dataset

createdstring date-time nullable

Date of dataset creation

deleted_atstring date-time nullable

Date of dataset deletion, or null if the dataset is still active

user_idstring uuid nullable

Identifies the user who created the dataset

tagsstring[] nullable

A list of tags for the dataset

metadataobject nullable

User-controlled metadata about the dataset

url_slugstring required

URL slug for the dataset. used to construct dataset URLs

Changes

  • 8f5039399f77Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • a21b724fece9Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status