abacusai.annotations_status

Classes

`AnnotationConfig`	Annotation config for a feature group
`AbstractApiClass`
`AnnotationsStatus`	The status of annotations for a feature group

Module Contents

class abacusai.annotations_status.AnnotationConfig(client, featureAnnotationConfigs=None, labels=None, statusFeature=None, commentsFeatures=None, metadataFeature=None)

Bases: abacusai.return_class.AbstractApiClass

Annotation config for a feature group

Parameters:

client (ApiClient) – An authenticated API Client instance
featureAnnotationConfigs (list) – List of feature annotation configs
labels (list) – List of labels
statusFeature (str) – Name of the feature that contains the status of the annotation (Optional)
commentsFeatures (list) – Features that contain comments for the annotation (Optional)
metadataFeature (str) – Name of the feature that contains the metadata for the annotation (Optional)

__repr__(): Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:: The dict value representation of the class parameters
Return type:: dict

class abacusai.annotations_status.AbstractApiClass(client, id)

__eq__(other): Return self==value.

_get_attribute_as_dict(attribute)

class abacusai.annotations_status.AnnotationsStatus(client, total=None, done=None, inProgress=None, todo=None, latestUpdatedAt=None, isMaterializationNeeded=None, latestMaterializedAnnotationConfig={})

Bases: abacusai.return_class.AbstractApiClass

The status of annotations for a feature group

Parameters:

client (ApiClient) – An authenticated API Client instance
total (int) – The total number of documents annotated
done (int) – The number of documents annotated
inProgress (int) – The number of documents currently being annotated
todo (int) – The number of documents that need to be annotated
latestUpdatedAt (str) – The latest time an annotation was updated (ISO-8601 format)
isMaterializationNeeded (bool) – Whether feature group needs to be materialized before using for annotations
latestMaterializedAnnotationConfig (AnnotationConfig) – The annotation config corresponding to the latest materialized feature group

__repr__(): Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:: The dict value representation of the class parameters
Return type:: dict