List Datasets#

List all datasets registered to NeMo Entity Store.

Prerequisites#

Before you can list existing datasets, make sure that you have:

  • Access to the NeMo Entity Store Microservice.

To List Datasets#

Choose one of the following options of listing datasets.

Set up a NeMoMicroservices client instance using the base URL of the NeMo Entity Store microservice and perform the task as follows.

from nemo_microservices import NeMoMicroservices

client = NeMoMicroservices(
    base_url=os.environ["ENTITY_STORE_BASE_URL"]
)

response = client.datasets.list()
print(response)

Make a GET request to the /v1/datasets endpoint.

export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>

curl -X GET "${ENTITY_STORE_BASE_URL}/v1/datasets" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' | jq
Example Response

The following is an example of a successful response.

  {
  "object": "list",
  "data": [
    {
    "created_at": "2025-02-14T20:47:20.798490",
    "updated_at": "2025-02-14T20:47:20.798492",
    "name": "your-dataset-name",
    "namespace": "your-namespace",
    "description": "your-dataset-description",
    "format": "json",
    "files_url": "file://your-dataset-name.json/",
    "project": "string",
    "custom_fields": {},
    "ownership": {
      "created_by": "your-email",
      "access_policies": {}
    }
  }
  ],
  "pagination": {
    "page": 1,
    "page_size": 10,
    "current_page_size": 10,
    "total_pages": 15,
    "total_results": 149
  },
  "sort": "created_at"
}