AnnotationAnalyticsAggregation

class oci.data_labeling_service_dataplane.models.AnnotationAnalyticsAggregation(**kwargs)

Bases: object

Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they’re summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.

Methods

__init__(**kwargs) Initializes a new AnnotationAnalyticsAggregation object with values from keyword arguments.

Attributes

compartment_id [Required] Gets the compartment_id of this AnnotationAnalyticsAggregation.
count [Required] Gets the count of this AnnotationAnalyticsAggregation.
dataset_id [Required] Gets the dataset_id of this AnnotationAnalyticsAggregation.
dimensions Gets the dimensions of this AnnotationAnalyticsAggregation.
lifecycle_state Gets the lifecycle_state of this AnnotationAnalyticsAggregation.
updated_by Gets the updated_by of this AnnotationAnalyticsAggregation.
__init__(**kwargs)

Initializes a new AnnotationAnalyticsAggregation object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • count (float) – The value to assign to the count property of this AnnotationAnalyticsAggregation.
  • dataset_id (str) – The value to assign to the dataset_id property of this AnnotationAnalyticsAggregation.
  • dimensions (oci.data_labeling_service_dataplane.models.AnnotationAggregationDimensions) – The value to assign to the dimensions property of this AnnotationAnalyticsAggregation.
  • updated_by (str) – The value to assign to the updated_by property of this AnnotationAnalyticsAggregation.
  • compartment_id (str) – The value to assign to the compartment_id property of this AnnotationAnalyticsAggregation.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnnotationAnalyticsAggregation.
compartment_id

[Required] Gets the compartment_id of this AnnotationAnalyticsAggregation. OCID of the compartment containing the annotations

Returns:The compartment_id of this AnnotationAnalyticsAggregation.
Return type:str
count

[Required] Gets the count of this AnnotationAnalyticsAggregation. the count of the matching results

Returns:The count of this AnnotationAnalyticsAggregation.
Return type:float
dataset_id

[Required] Gets the dataset_id of this AnnotationAnalyticsAggregation. OCID of the dataset the annotations belongs to

Returns:The dataset_id of this AnnotationAnalyticsAggregation.
Return type:str
dimensions

Gets the dimensions of this AnnotationAnalyticsAggregation.

Returns:The dimensions of this AnnotationAnalyticsAggregation.
Return type:oci.data_labeling_service_dataplane.models.AnnotationAggregationDimensions
lifecycle_state

Gets the lifecycle_state of this AnnotationAnalyticsAggregation. Describes the lifecycle state.

Returns:The lifecycle_state of this AnnotationAnalyticsAggregation.
Return type:str
updated_by

Gets the updated_by of this AnnotationAnalyticsAggregation. The OCID of the principal who updated the annotation

Returns:The updated_by of this AnnotationAnalyticsAggregation.
Return type:str