Dataset API
api_create_datasets(name, description, reference, license, method, **kwargs)
This function creates a new dataset.
This function takes the name, description, reference, and license for a new dataset as input. It then creates a new DatasetArguments object with these details and an empty id. The id is left empty because it will be generated from the name during the creation process. The function then calls the Dataset's create method to create the new dataset.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
The name of the new dataset. |
required |
description |
str
|
A brief description of the new dataset. |
required |
reference |
str
|
A reference link for the new dataset. |
required |
license |
str
|
The license of the new dataset. |
required |
method |
str
|
The method to create new dataset. (csv/hf) |
required |
kwargs |
Additional keyword arguments for the Dataset's create method. |
{}
|
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The ID of the newly created dataset. |
Source code in moonshot/src/api/api_dataset.py
api_delete_dataset(ds_id)
Deletes a dataset identified by its unique dataset ID.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ds_id |
str
|
The unique identifier for the dataset to be deleted. |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True if the dataset was successfully deleted. |
Raises:
Type | Description |
---|---|
Exception
|
If the deletion process encounters an error. |
Source code in moonshot/src/api/api_dataset.py
api_get_all_datasets()
This function retrieves all available datasets and returns them as a list of dictionaries. Each dictionary represents a result and contains its information.
Returns:
Type | Description |
---|---|
list[dict]
|
list[dict]: A list of dictionaries, each representing a result. |
Source code in moonshot/src/api/api_dataset.py
api_get_all_datasets_name()
This function retrieves all available datasets names and returns them as a list.
Returns:
Type | Description |
---|---|
list[str]
|
list[str]: A list of datasets names. |