Workflow Metrics Types
- class indico.types.workflow_metrics.WorkflowMetricsOptions(value)
Options for pulling back specific metrics.
- SUBMISSIONS
Generates SubmissionMetrics in the response.
- REIVEW
Generates review Queue metrics in the response.
- STRAIGHT_THROUGH_PROCESSING
Generates StraightThroughProcessing metrics in the response.
- TIME_ON_TASK
Average time spent by reviewers on documents.
- class indico.types.workflow_metrics.TimeOnTaskMetric(**kwargs)
Time on task metrics.
- avg_mins_per_doc
Average amount of minutes reviewers spend on documents in this workflow across review and exceptions queue.
- Type
float
- avg_mins_per_doc_review
Average amount of minutes reviewers spend on documents in this workflow in the review queue.
- Type
float
- avg_min_per_doc_exceptions
Average amount of minutes reviewers spend on ducments for this workflow in the exceptions queue.
- Type
float
- class indico.types.workflow_metrics.TimeOnTaskMetrics(**kwargs)
Time on task metrics.
- aggregate
Aggregate level time on task metrics.
- Type
- daily
Daily level time on task metrics.
- Type
- class indico.types.workflow_metrics.DailyTimeOnTaskMetric(**kwargs)
Daily time on task metrics.
- avg_mins_per_doc
Average amount of minutes reviewers spend on documents in this workflow across review and exceptions queue.
- Type
float
- avg_mins_per_doc_review
Average amount of minutes reviewers spend on documents in this workflow in the review queue.
- Type
float
- avg_min_per_doc_exceptions
Average amount of minutes reviewers spend on ducments for this workflow in the exceptions queue.
- Type
float
- date
Date.
- Type
str
- class indico.types.workflow_metrics.SubmissionMetric(**kwargs)
Submission metric.
- Attributes:
submitted(int): Number of items submitted to this workflow on this day. completed(int): Number of items completed in this workflow on this day. completed_in_review(int): Number of items accepted in the review or the exceptions queue. completed_review_queue(int): Number of items accepted in the review queue. completed_exception_queue(int): Number of items accepted in the exceptions queue. rejected_in_review(int): Number of items rejected in the exceptions queue. date(str): Date.
- class indico.types.workflow_metrics.DailySubmissionMetric(**kwargs)
Daily submission metrics.
- submitted
Number of items submitted to this workflow on this day.
- Type
int
- completed
Number of items completed in this workflow on this day.
- Type
int
- completed_in_review
Number of items accepted in the review or the exceptions queue.
- Type
int
- completed_review_queue
Number of items accepted in the review queue.
- Type
int
- completed_exception_queue
Number of items accepted in the exceptions queue.
- Type
int
- rejected_in_review
Number of items rejected in the exceptions queue.
- Type
int
- date
Date.
- Type
str
- class indico.types.workflow_metrics.DailyQueueMetric(**kwargs)
Daily cumulative metrics for queues .. attribute:: date
the date.
- type
str
- subs_on_queue
Number of submissions queued for review
- Type
int
- hours_on_queue
Cumulative hours items wait on queue for review.
- Type
float
- avg_age_in_queue
Average cumulative age of items waiting in review queues.
- Type
float
- class indico.types.workflow_metrics.QueueMetrics(**kwargs)
Daily cumulative metrics for queues. .. attribute:: daily_cumulative
list of cumulative queue metrics per day
- type
List[DailyQueueMetric]
- class indico.types.workflow_metrics.PredictionMetric(**kwargs)
The total number of model-generated predictions for specified workflow. .. attribute:: num_preds
the total number of model-generated predictions.
- type
int
- class indico.types.workflow_metrics.PredictionMetrics(**kwargs)
Prediction metrics.
- aggregate
Total number of predictions generated for this workflow.
- Type
- daily
Number of predictions generated per-date.
- Type
List[PredictionMetrics]
- class indico.types.workflow_metrics.DailyPredictionMetric(**kwargs)
The total number of model-generated predictions for specified workflow, for this date. .. attribute:: date
the date of the prediction.
- type
str
- num_preds
the total number of model-generated predictions.
- Type
int
- class indico.types.workflow_metrics.StpMetric(**kwargs)
Base Straight through processing (STP) metric for a model, class, or workflow.
- review_numerator
The number of human accepted model predictions.
- Type
int
- auto_review_numerator
The nymber of human accepted auto review labels.
- Type
int
- review_denom
Total of user supplied labels and model predictions.
- Type
int
- auto_review_denom
- Type
int
- review_stp_pct
Percent of human accepted model predictions. Present if auto review is disabled.
- Type
float
- auto_review_stp_pct
Percent of auto review labels accepted. Present if auto review is enabled.
- Type
float
- class indico.types.workflow_metrics.DailyStpMetric(**kwargs)
Daily Straight through processing (STP) metric for a model, class, or workflow.
- review_numerator
The number of human accepted model predictions.
- Type
int
- auto_review_numerator
The nymber of human accepted auto review labels.
- Type
int
- review_denom
Total of user supplied labels and model predictions.
- Type
int
- auto_review_denom
- Type
int
- review_stp_pct
Percent of human accepted model predictions. Present if auto review is disabled.
- Type
float
- auto_review_stp_pct
Percent of auto review labels accepted. Present if auto review is enabled.
- Type
float
- date
The date these metrics are applicable.
- Type
str
- class indico.types.workflow_metrics.ClassStpMetrics(**kwargs)
STP Metrics per class.
- class_name
Name of the class.
- Type
str
- daily
Per-date STP metrics for this class.
- Type
List[DailyStpMetric]
- class indico.types.workflow_metrics.ModelStpMetrics(**kwargs)
Model STP metrics.
- model_group_id
Id of the model group.
- Type
int
- name
Name of the model.
- Type
str
- daily
Daily STP metrics for the model.
- Type
List[DailyStpMetric]
- class_metrics
Metrics per model class.
- Type
List[ClassStpMetrics]
- class indico.types.workflow_metrics.WorkflowStpMetrics(**kwargs)
Daily workflow STP metrics.
- daily
List of daily metrics.
- Type
List[DailyStpMetric]
- class indico.types.workflow_metrics.StraightThroughProcessing(**kwargs)
Straight Through Processing (STP) metrics.
- workflow
Daily aggregate workflow level STP metrics.
- Type
- model
Model STP metrics (including class STP).
- Type
List[ModelStpMetrics]
- class indico.types.workflow_metrics.WorkflowMetrics(**kwargs)
Workflow metrics for the requested workflow id and dates.
- workflow_id
The workflow id.
- Type
int
- time_on_task
Time spent on tasks.
- Type
- submissions
Submission specific metrics.
- Type
SubmissionMetrics
- queues
Review queue metrics.
- Type
- predictions
Prediction metrics.
- Type
- straight_through_processing
Straight through processing (STP) metrics.
- first_submitted_date
The earliest date of submission to this workflow.
- Type
str