​
Dataset Objects

class Dataset(BaseClientModel, DecorateAllMethods)

​
get_content

def get_content() -> Union[None, DatasetContent]

Gets and returns the content of the dataset.

Also refreshes the content of the local dataset instance.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Union[None, DatasetContent]: The content of the dataset

​
add_rows

def add_rows(row_data: list[dict[str, Any]]) -> "Dataset"

Adds rows to the dataset.

Arguments:

  • row_data (list[Dict[str, Any]]): The rows to add to the dataset.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Dataset: The updated dataset with the new rows.

​
Datasets Objects

class Datasets(BaseClientModel)

​
list

def list(limit: Union[Unset, int] = 100) -> list[Dataset]

Lists all datasets.

Arguments:

  • limit (Union[Unset, int]): The maximum number of datasets to return. Default is 100.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[Dataset]: A list of datasets.

​
get

def get(*,
        id: Optional[str] = None,
        name: Optional[str] = None,
        with_content: bool = False) -> Optional[Dataset]

Retrieves a dataset by id or name (exactly one of id or name must be provided).

Arguments:

  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
  • with_content (bool): Whether to return the content of the dataset. Default is False.

Raises:

  • ValueError: If neither or both id and name are provided.
  • name1: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • name2: If the request takes longer than Client.timeout.

Returns:

name3: The dataset.

​
delete

def delete(*, id: Optional[str] = None, name: Optional[str] = None) -> None

Deletes a dataset by id or name.

Arguments:

  • id (str): The id of the dataset.
  • name (str): The name of the dataset.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

​
create

def create(name: str, content: DatasetType) -> Dataset

Creates a new dataset.

Arguments:

  • name (str): The name of the dataset.
  • content (DatasetType): The content of the dataset.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Dataset: The created dataset.

​
get_dataset

def get_dataset(*,
                id: Optional[str] = None,
                name: Optional[str] = None) -> Optional[Dataset]

Retrieves a dataset by id or name (exactly one of id or name must be provided).

Arguments:

  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
  • with_content (bool): Whether to return the content of the dataset. Default is False.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

name0: The dataset.

​
list_datasets

def list_datasets(limit: Union[Unset, int] = 100) -> list[Dataset]

Lists all datasets.

Arguments:

  • limit (Union[Unset, int]): The maximum number of datasets to return. Default is 100.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[Dataset]: A list of datasets.

​
delete_dataset

def delete_dataset(*,
                   id: Optional[str] = None,
                   name: Optional[str] = None) -> None

Deletes a dataset by id or name (exactly one of id or name must be provided).

Arguments:

  • id (str): The id of the dataset.
  • name (str): The name of the dataset.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

​
create_dataset

def create_dataset(name: str, content: DatasetType) -> Dataset

Creates a new dataset.

Arguments:

  • name (str): The name of the dataset.
  • content (DatasetType): The content of the dataset.

Raises:

  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Dataset: The created dataset.

​
get_dataset_version_history

def get_dataset_version_history(
    *,
    dataset_name: str = None,
    dataset_id: str = None
) -> Optional[Union[HTTPValidationError, ListDatasetVersionResponse]]

Retrieves a dataset version history by dataset name or dataset id.

Arguments:

  • dataset_name (str): The name of the dataset.
  • dataset_id (str): The id of the dataset.

Raises:

  • HTTPValidationError: None

Returns:

ListDatasetVersionResponse:

​
get_dataset_version

def get_dataset_version(*,
                        version_index: int,
                        dataset_name: str = None,
                        dataset_id: str = None) -> Optional[DatasetContent]

Retrieves a dataset version by dataset name or dataset id.

Arguments:

  • version_index (int): The version of the dataset.
  • dataset_name (Optional[str]): The name of the dataset.
  • dataset_id (Optional[str]): The id of the dataset.

Returns:

DatasetContent: