Update Dataset

You can update a dataset if you need to change its details through the NeMo Entity Store microservice.

Prerequisites

Before you can update a dataset, make sure that you have:

• Obtained the base URL of your NeMo Entity Store Microservice.

• Permissions to access the NeMo Entity Store microservice endpoint.

• Obtained the namespace and dataset_name of the dataset you want to update.

---

How to Update a Dataset

API

1. Make a PATCH request to the /v1/datasets/{namespace}/{dataset_name} endpoint. The following example updates the documentation-test-dataset dataset.

   cURL

   export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>
   export NAMESPACE="team-docs"
   export DATASET_NAME="documentation-test-dataset"
   
   curl -X PATCH "${ENTITY_STORE_BASE_URL}/v1/datasets/${NAMESPACE}/${DATASET_NAME}" \
       -H 'Accept: application/json' \
       -H 'Content-Type: application/json' \
       -d '{
        "custom_fields": {
          "size": "large",
          "focus": "active voice",
          "tone": "casual"
        }' | jq
   

2. Verify that the dataset was updated by reviewing the response.

   Example Response

   {
     "schema_version": "1.0",
     "id": "dataset-EEeeZRcqNMTw1wFDtkVLn3",
     "description": "A dataset for documentation testing",
     "type_prefix": null,
     "namespace": "team-docs",
     "project": "string",
     "created_at": "2025-02-14T21:13:21.306347",
     "updated_at": "2025-02-14T21:13:21.306349",
     "custom_fields": {
       "size": "large",
       "focus": "active voice",
       "tone": "casual"
     },
     "ownership": {
       "created_by": "user@nvidia.com",
       "access_policies": {}
     },
     "name": "documentation-test-dataset",
     "version_id": "main",
     "version_tags": [],
     "format": "json",
     "files_url": "file://documentation-test-dataset.json/"
   }