Export#
Dictionary (JSON)#
- class relevanceai.dataset.io.export.dict.DictExport#
- api_key: str#
- project: str#
- request_logger: relevanceai.utils.logger.FileLogger#
- to_dict(orient='records', **kwargs)#
Returns the raw list of dicts from Relevance AI
- Parameters
None –
- Return type
list of documents in dictionary format
Example
from relevanceai import Client client = Client() dataset_id = "sample_dataset_id" df = client.Dataset(dataset_id) dict = df.to_dict(orient="records")
CSV#
- class relevanceai.dataset.io.export.csv.CSVExport#
- api_key: str#
- project: str#
- request_logger: relevanceai.utils.logger.FileLogger#
- to_csv(filename, **kwargs)#
Download a dataset from Relevance AI to a local .csv file
- Parameters
filename (str) – path to downloaded .csv file
kwargs (Optional) – see client.get_all_documents() for extra args
Example
from relevanceai import Client client = Client() dataset_id = "sample_dataset_id" df = client.Dataset(dataset_id) csv_fname = "path/to/csv/file.csv" df.to_csv(csv_fname)
Pandas#
- class relevanceai.dataset.io.export.pandas.PandasExport#
- api_key: str#
- project: str#
- request_logger: relevanceai.utils.logger.FileLogger#
- to_df(**kwargs)#
Note
This function was introduced in 1.1.5.
- Return type
DataFrame
- to_pandas_dataframe(**kwargs)#
Note
This function was introduced in 1.1.5.
- Return type
DataFrame