relevanceai.dataset.read.cluster#

Module Contents#

class relevanceai.dataset.read.cluster.ClusterRead(credentials: relevanceai.client.helpers.Credentials, dataset_id: str, **kwargs)#

Batch API client

list_closest_to_center(self, vector_fields: list, alias: str, cluster_ids: Optional[list] = None, select_fields: Optional[List] = None, approx: int = 0, page_size: int = 1, page: int = 1, similarity_metric: str = 'cosine', filters: Optional[list] = None, facets: Optional[list] = None, include_vector: bool = False, cluster_properties_filters: Optional[Dict] = None, include_count: bool = False, include_facets: bool = False, verbose: bool = False)#