anatools.anaclient.analytics module

Analytics Functions

create_analytics(self, datasetId, type, workspaceId=None, tags=None)

Generate analytics for a dataset.

Parameters

  • datasetId (str) – The datasetId of the dataset to generate analytics for.

  • type (str) – The type of analytics to generate for the dataset.

  • workspaceId (str) – Workspace ID of the dataset to generate the analytics for. If none is provided, the current workspace will get used.

  • tags (list[str]) – Tags for the analytics job.

Returns

The analyticsId for the analytics job.

Return type

str

delete_analytics(self, analyticsId, workspaceId=None)

Deletes analytics for a dataset.

Parameters

  • analyticsId (str) – Analytics ID for the analytics to delete.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns

If true, successfully deleted the analytics.

Return type

bool

download_analytics(self, analyticsId, workspaceId=None)

Retrieve information about a specific analytics job. If an analytics job is of type Object Metrics or Mean Brightness, then images will get downloaded to current working directory.

Parameters

  • analyticsId (str) – Analytics Job ID.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns

Analytics job information.

Return type

list[dict]

edit_analytics(self, analyticsId, tags=None, workspaceId=None)

Edits analytics for a dataset.

Parameters

  • analyticsId (str) – Analytics ID for the analytics to edit.

  • tags (list[str]) – Tags for the analytics job.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns

If true, successfully edited the analytics.

Return type

bool

get_analytics(self, analyticsId=None, datasetId=None, workspaceId=None, cursor=None, limit=None, filters=None, fields=None)

Retrieve information about analytics jobs.

Parameters

  • analyticsId (str) – Analytics Job ID.

  • datasetId (str) – Dataset ID of the analytics job.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

  • cursor (str) – Cursor for pagination.

  • limit (int) – Maximum number of analytics to return.

  • filters (dict) – Filters that limit output to entries that match the filter

  • fields (list[str]) – List of fields to return, leave empty to get all fields.

Returns

Analytics job information.

Return type

list[dict]

get_analytics_types(self)

Retrieve the analytics types available on the Rendered.ai Platform.

Returns

The analytics types available on the Platform.

Return type

list[str]