relevanceai.api.endpoints.monitor

All Dataset related functions

Module Contents

Classes

MonitorClient

Base class for all relevanceai client utilities
class relevanceai.api.endpoints.monitor.MonitorClient(project, api_key)

Bases: relevanceai.base._Base

Base class for all relevanceai client utilities

health(self, dataset_id: str)

Gives you a summary of the health of your vectors, e.g. how many documents with vectors are missing, how many documents with zero vectors

Parameters

dataset_id (string) – Unique name of dataset

stats(self, dataset_id: str)

All operations related to monitoring

Parameters

dataset_id (string) – Unique name of dataset

usage(self, dataset_id: str, filters: list = [], page_size: int = 20, page: int = 1, asc: bool = False, flatten: bool = True, log_ids: list = [])

Aggregate the logs for a dataset.

The response returned has the following fields:

>>> [{'frequency': 958, 'insert_date': 1630159200000},...]
Parameters

  • dataset_id (string) – Unique name of dataset

  • filters (list) – Query for filtering the search results

  • page_size (int) – Size of each page of results

  • page (int) – Page of the results

  • asc (bool) – Whether to sort results by ascending or descending order

  • flatten (bool) – Whether to flatten

  • log_ids (list) – The log dataset IDs to aggregate with - one or more of logs, logs-write, logs-search, logs-task or js-logs