ABEJA Dataset documentation

ABEJA dataset library is (SDK) for python, which allow developers to create, get and delete dataset and dataset items.

High level API

High level APIs are used trough following classes.

Usage

from abeja.datasets import Client

client = Client(organization_id)
dataset = client.get_dataset(dataset_id)
for item in dataset.dataset_items.list():
   pass

API Mapping

method path  
post /organizations/<organization_id>/datasets Datasets.create()
get /organizations/<organization_id>/datasets Datasets.list()
get /organizations/<organization_id>/datasets/<id> Datasets.get()
delete /organizations/<organization_id>/datasets/<id> Datasets.delete()
post /organizations/<organization_id>/datasets/<dataset_id>/items DatasetItems.create()
get /organizations/<organization_id>/datasets/<dataset_id>/items DatasetItems.list()
get /organizations/<organization_id>/datasets/<dataset_id>/items/<id> DatasetItems.get()
update /organizations/<organization_id>/datasets/<dataset_id>/items/<id> DatasetItems.update()
bulk_update /organizations/<organization_id>/datasets/<dataset_id>/items DatasetItems.bulk_update()
delete /organizations/<organization_id>/datasets/<dataset_id>/items/<id> DatasetItems.delete()

Low level API

Low lavel apis are directly access the api endpoint.

Usage

from abeja.datasets import APIClient

api = APIClient()
dataset = api.get_dataset(organization_id, dataset_id)
dataset_items = api.list_dataset_items(organization_id, dataset_id)

API Mapping

method path  
post /organizations/<organization_id>/datasets APIClient.create_dataset()
get /organizations/<organization_id>/datasets APIClient.list_datasets()
get /organizations/<organization_id>/datasets/<id> APIClient.get_dataset()
delete /organizations/<organization_id>/datasets/<id> APIClient.delete_dataset()
post /organizations/<organization_id>/datasets/<dataset_id>/items APIClient.create_dataset_item()
get /organizations/<organization_id>/datasets/<dataset_id>/items APIClient.list_dataset_items()
get /organizations/<organization_id>/datasets/<dataset_id>/items/<id> APIClient.get_dataset_item()
update /organizations/<organization_id>/datasets/<dataset_id>/items/<id> APIClient.update_dataset_item()
bulk_update /organizations/<organization_id>/datasets/<dataset_id>/items APIClient.bulk_update_dataset_item()
delete /organizations/<organization_id>/datasets/<dataset_id>/items/<id> APIClient.delete_dataset_item()