Tailored Generation

Update Dataset

Changed on

Update a dataset.

In order to use a dataset in a model training, its status must be set to completed.

Once a dataset status is changed to completed:

  • Images cannot be added or removed
  • Image captions cannot be edited
  • Caption prefix cannot be modified

It is recommended to use the route Clone Dataset As Draft in order to create a new version of a dataset.

Constraints:

  • Cannot update caption_prefix if dataset status is completed
  • Dataset must have at least 1 image to be marked as completed
put/tailored-gen/datasets/{dataset_id}

Request

  • Base URL: https://engine.prod.bria-api.com/v1
  • URL: https://engine.prod.bria-api.com/v1/tailored-gen/datasets/{dataset_id}
  • Auth: none declared. Required headers: api_token

Path parameters

dataset_idstring required

Dataset ID

Headers

api_tokenstring required

Request body

namestring

New dataset name (optional)

caption_prefixstring

New caption prefix (optional). Cannot be updated if dataset status is completed. If the user has updated the caption prefix, it is crucial to Regenerate All Captions using the endpoint PUT /datasets/{dataset_id}/images/

status'draft' | 'completed'

Dataset status (optional). Can be set to completed to enable usage in model training

Response

Dataset successfully updated

idinteger

Unique identifier for the dataset

project_idinteger

Associated project ID

namestring

Dataset name

caption_prefixstring

Text automatically prepended to all image captions in the dataset. Each image caption should naturally continues this prefix. A default prefix is automatically created but can be modified, and this same prefix is later used as the default generation prefix during image generation.

status'draft' | 'completed'

Status of the dataset

captions_update_status'empty' | 'in_progress' | 'completed'

Status of captions update process

created_atstring date-time

Timestamp when the dataset was created

updated_atstring date-time

Timestamp when the dataset was last updated

Changes