abacusai.annotation_entry

Classes

`Annotation`	An Annotation Store Annotation
`AbstractApiClass`
`AnnotationEntry`	An Annotation Store entry for an Annotation

Module Contents

class abacusai.annotation_entry.Annotation(client, annotationType=None, annotationValue=None, comments=None, metadata=None)

Bases: abacusai.return_class.AbstractApiClass

An Annotation Store Annotation

Parameters:

client (ApiClient) – An authenticated API Client instance
annotationType (str) – A name determining the type of annotation and how to interpret the annotation value data, e.g. as a label, bounding box, etc.
annotationValue (dict) – JSON-compatible value of the annotation. The format of the value is determined by the annotation type.
comments (dict) – Comments about the annotation. This is a dictionary of feature name to the corresponding comment.
metadata (dict) – Metadata about the annotation.

__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.annotation_entry.AbstractApiClass(client, id)

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

_get_attribute_as_dict(attribute)

class abacusai.annotation_entry.AnnotationEntry(client, featureGroupId=None, featureName=None, docId=None, featureGroupRowIdentifier=None, updatedAt=None, annotationEntryMarker=None, status=None, lockedUntil=None, verificationInfo=None, annotation={})

Bases: abacusai.return_class.AbstractApiClass

An Annotation Store entry for an Annotation

Parameters:

client (ApiClient) – An authenticated API Client instance
featureGroupId (str) – The ID of the feature group this annotation belongs to.
featureName (str) – name of the feature this annotation is on.
docId (str) – The ID of the primary document the annotation is on.
featureGroupRowIdentifier (str) – The key value of the feature group row the annotation is on (cast to string). Usually the primary key value.
updatedAt (str) – Most recent time the annotation entry was modified, e.g. creation or update time.
annotationEntryMarker (str) – The entry marker for the annotation.
status (str) – The status of labeling the document.
lockedUntil (str) – The time until which the document is locked for editing, in ISO-8601 format.
verificationInfo (dict) – The verification info for the annotation.
annotation (Annotation) – json-compatible structure holding the type and value of the annotation.

__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