feat: FIT-761: New user stats prediction endpoint for multiple users (#642)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>

Author: robot-ci-heartex

.mock/definition/dashboard.yml

@@ -21,56 +21,6 @@ types:
         docs: Total number of tasks
     source:
       openapi: openapi/openapi.yaml
-  ApiProjectsDashboardMembersRetrieveResponseStatsItem:
-    docs: User statistics
-    properties:
-      accepted:
-        type: optional<integer>
-        docs: Number of annotations marked as "Accepted" by reviewer
-      finished:
-        type: optional<integer>
-      gt:
-        type: optional<double>
-        docs: Average agreement with Ground Truth annotations
-      mean_time:
-        type: optional<double>
-        docs: Average mean time spent on annotation
-      median_time:
-        type: optional<double>
-        docs: Average median time spent on annotation
-      predictions:
-        type: optional<double>
-        docs: Average agreement with predictions
-      progress:
-        type: optional<integer>
-        docs: Fraction of annotation work done so far
-      rejected:
-        type: optional<integer>
-        docs: Number of annotations marked as "Rejected" by reviewer
-      review_score:
-        type: optional<double>
-        docs: >-
-          Average reviewing score, when calling with "per_label=true", returns
-          dictionary with labels to score breakdown
-      skipped:
-        type: optional<integer>
-    source:
-      openapi: openapi/openapi.yaml
-    inline: true
-  ApiProjectsDashboardMembersRetrieveResponse:
-    docs: Task creation response
-    properties:
-      similarity:
-        type: optional<list<map<string, unknown>>>
-        docs: Consensus statistics between different users
-      stats:
-        type: optional<list<ApiProjectsDashboardMembersRetrieveResponseStatsItem>>
-        docs: Number of annotated (completed) tasks
-      users:
-        type: optional<list<map<string, unknown>>>
-        docs: List of users
-    source:
-      openapi: openapi/openapi.yaml
 service:
   auth: false
   base-path: ''
@@ -102,72 +52,5 @@ service:
               tasks: 1
       audiences:
         - internal
-    api_projects_dashboard_members_retrieve:
-      path: /api/projects/{id}/dashboard-members
-      method: GET
-      auth: true
-      docs: >-
-        Get dashboard for members, including similarity matrix, user statistics
-        and users list.
-      source:
-        openapi: openapi/openapi.yaml
-      path-parameters:
-        id: integer
-      display-name: Get dashboard data for members
-      request:
-        name: ApiProjectsDashboardMembersRetrieveRequest
-        query-parameters:
-          action:
-            type: optional<string>
-            docs: >-
-              All data objects will be filtered by updated_at or created_at
-              field
-          end_date:
-            type: optional<string>
-            docs: >-
-              End date for dashboard stats calculation. UTC timezone by default.
-              Use iso format (yyyy-mm-dd-hh-mm) to specify timezone.
-          per_label:
-            type: optional<boolean>
-            docs: Per label calculation
-          start_date:
-            type: optional<string>
-            docs: >-
-              Start date for dashboard stats calculation. UTC timezone by
-              default. Use iso format (yyyy-mm-dd-hh-mm) to specify timezone.
-          updated_by:
-            type: optional<string>
-            docs: >-
-              All task objects will be filtered by updated_by field. Only tasks
-              that were updated by concrete user will be taken in account.
-          use_kappa:
-            type: optional<boolean>
-            docs: Use kappa statistics for calculation
-      response:
-        docs: Successful response returns project-related annotation statistics
-        type: ApiProjectsDashboardMembersRetrieveResponse
-      availability: deprecated
-      examples:
-        - path-parameters:
-            id: 1
-          response:
-            body:
-              similarity:
-                - key: value
-              stats:
-                - accepted: 1
-                  finished: 1
-                  gt: 1.1
-                  mean_time: 1.1
-                  median_time: 1.1
-                  predictions: 1.1
-                  progress: 1
-                  rejected: 1
-                  review_score: 1.1
-                  skipped: 1
-              users:
-                - key: value
-      audiences:
-        - internal
   source:
     openapi: openapi/openapi.yaml

.mock/definition/projects/stats.yml

@@ -175,6 +175,29 @@ types:
       - StatsTotalAgreementResponseOne
     source:
       openapi: openapi/openapi.yaml
+  StatsUsersPredictionAgreementResponseAgreementValue:
+    discriminated: false
+    union:
+      - type: double
+        docs: >-
+          Average prediction agreement score for the user (0-1) when
+          per_label=False
+      - type: map<string, double>
+        docs: >-
+          Average prediction agreement score per label for the user (0-1) when
+          per_label=True
+    source:
+      openapi: openapi/openapi.yaml
+    inline: true
+  StatsUsersPredictionAgreementResponse:
+    properties:
+      agreement:
+        type: >-
+          optional<map<string,
+          StatsUsersPredictionAgreementResponseAgreementValue>>
+        docs: Dictionary mapping user IDs to their prediction agreement scores
+    source:
+      openapi: openapi/openapi.yaml
   StatsUserPredictionAgreementResponseAveragePredictionAgreementPerUser:
     discriminated: false
     union:
@@ -497,7 +520,7 @@ service:
           ids:
             type: string
             docs: >-
-              Comma-separated list of annotator user IDs to get agreement scores
+              Comma separated list of annotator user IDs to get agreement scores
               for
       response:
         docs: Multiple annotator agreement statistics
@@ -660,6 +683,50 @@ service:
               key: value
       audiences:
         - public
+    users_prediction_agreement:
+      path: /api/projects/{id}/user-stats/prediction
+      method: GET
+      auth: true
+      docs: >-
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Get prediction agreement statistics for multiple annotators within a
+        project.
+      source:
+        openapi: openapi/openapi.yaml
+      path-parameters:
+        id: integer
+      display-name: Get prediction agreement statistics for multiple annotators
+      request:
+        name: StatsUsersPredictionAgreementRequest
+        query-parameters:
+          ids:
+            type: string
+            docs: >-
+              Comma separated list of annotator user IDs to get agreement scores
+              for
+          per_label:
+            type: optional<boolean>
+            default: false
+            docs: Per label
+      response:
+        docs: Prediction agreement statistics for multiple annotators
+        type: StatsUsersPredictionAgreementResponse
+      examples:
+        - path-parameters:
+            id: 1
+          query-parameters:
+            ids: ids
+          response:
+            body:
+              agreement:
+                key: 1.1
+      audiences:
+        - public
     user_prediction_agreement:
       path: /api/projects/{id}/user-stats/{user_pk}/prediction
       method: GET