Method
getAnnotationsStatus GET
Copy GET

Get the status of the annotations for a given feature group and feature.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes featureGroupId str The ID of the feature group the annotation is on.
No featureName str The name of the feature the annotation is on.
No checkForMaterialization bool If True, check if the feature group needs to be materialized before using for annotations.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result AnnotationsStatus
KEY TYPE Description
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
KEY TYPE Description
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)

Exceptions:

TYPE WHEN
DataNotFoundError

featureGroupId is not found.
Language:

© Copyright