relevanceai.dataset.dataset#

Module Contents#

class relevanceai.dataset.dataset.Dataset(credentials: relevanceai.client.helpers.Credentials, dataset_id: str, fields: Optional[list] = None, image_fields: Optional[List[str]] = None, audio_fields: Optional[List[str]] = None, highlight_fields: Optional[Dict[str, List]] = None, text_fields: Optional[List[str]] = None, **kwargs)#

A Pandas Like datatset API for interacting with the RelevanceAI python package

is_empty(self)#

Check if a dataset is empty.

set_dtypes(self, mapping: dict)#
get_dtypes(self)#
label_clusters(self, cluster_labels: dict, alias: str, vector_fields: list)#

Label your clusters programatiically

Example

ds.label_clusters(
    {"cluster_1" : "nice reviews"},
    alias=...,
    vector_fields=...
)
update_alias(self, field: str, alias: str)#

Update the alias of a field using the SDK.