relevanceai.dataset.io.export.dict#

Module Contents#

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

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

to_dict(self, orient: str = '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")