feat: UTC-243: Add model agreement stats to SDK (#634)

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

Author: robot-ci-heartex

.mock/definition/projects/stats.yml

@@ -1,4 +1,19 @@
 types:
+  StatsModelVersionAnnotatorAgreementResponse:
+    properties:
+      agreement: optional<double>
+    source:
+      openapi: openapi/openapi.yaml
+  StatsModelVersionGroundTruthAgreementResponse:
+    properties:
+      agreement: optional<double>
+    source:
+      openapi: openapi/openapi.yaml
+  StatsModelVersionPredictionAgreementResponse:
+    properties:
+      average_prediction_agreement_per_model: optional<double>
+    source:
+      openapi: openapi/openapi.yaml
   StatsIaaResponseIaa:
     discriminated: false
     docs: >-
@@ -216,6 +231,113 @@ service:
   auth: false
   base-path: ''
   endpoints:
+    model_version_annotator_agreement:
+      path: /api/projects/{id}/model-stats/{model_version}/agreement
+      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 agreement between a given model version and all annotators in the
+        project for overlapping tasks.
+      source:
+        openapi: openapi/openapi.yaml
+      path-parameters:
+        id: integer
+        model_version: string
+      display-name: Get model-version overall agreement vs annotators
+      response:
+        docs: Model-version overall agreement vs annotators
+        type: StatsModelVersionAnnotatorAgreementResponse
+      examples:
+        - path-parameters:
+            id: 1
+            model_version: model_version
+          response:
+            body:
+              agreement: 1.1
+      audiences:
+        - public
+    model_version_ground_truth_agreement:
+      path: /api/projects/{id}/model-stats/{model_version}/agreement-groundtruth
+      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 agreement between a given model version and ground truth annotations
+        in the project for overlapping tasks.
+      source:
+        openapi: openapi/openapi.yaml
+      path-parameters:
+        id: integer
+        model_version: string
+      display-name: Get model-version ground truth agreement
+      request:
+        name: StatsModelVersionGroundTruthAgreementRequest
+        query-parameters:
+          per_label:
+            type: optional<boolean>
+            default: false
+            docs: Calculate agreement per label
+      response:
+        docs: Model-version ground truth agreement
+        type: StatsModelVersionGroundTruthAgreementResponse
+      examples:
+        - path-parameters:
+            id: 1
+            model_version: model_version
+          response:
+            body:
+              agreement: 1.1
+      audiences:
+        - public
+    model_version_prediction_agreement:
+      path: /api/projects/{id}/model-stats/{model_version}/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 agreement between a given model version and all other model versions
+        in the project for overlapping tasks.
+      source:
+        openapi: openapi/openapi.yaml
+      path-parameters:
+        id: integer
+        model_version: string
+      display-name: Get model-version prediction agreement
+      request:
+        name: StatsModelVersionPredictionAgreementRequest
+        query-parameters:
+          per_label:
+            type: optional<boolean>
+            default: false
+            docs: Calculate agreement per label
+      response:
+        docs: Model-version prediction agreement
+        type: StatsModelVersionPredictionAgreementResponse
+      examples:
+        - path-parameters:
+            id: 1
+            model_version: model_version
+          response:
+            body:
+              average_prediction_agreement_per_model: 1.1
+      audiences:
+        - public
     iaa:
       path: /api/projects/{id}/stats/IAA
       method: GET

.mock/definition/stats.yml

@@ -8574,10 +8574,13 @@ paths:
   /api/projects/{id}/model-stats/{model_version}/agreement:
     get:
       description: |-
-        Overall agreement between a given model version's predictions and all annotators on overlapping tasks.
-        Computed as the average of per-annotator agreement vs this model version over annotators who overlap on at least one task.
-        Mirrors IAA per annotator, but one side is the model.
-        :return: {"agreement": float[0..1]}
+        <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 agreement between a given model version and all annotators in the project for overlapping tasks.
       operationId: api_projects_model_stats_agreement_retrieve
       parameters:
         - in: path
@@ -8597,6 +8600,7 @@ paths:
               schema:
                 properties:
                   agreement:
+                    nullable: true
                     type: number
                 type: object
           description: Model-version overall agreement vs annotators
@@ -8605,12 +8609,22 @@ paths:
       summary: Get model-version overall agreement vs annotators
       tags:
         - Stats
+      x-fern-audiences:
+        - public
+      x-fern-sdk-group-name:
+        - projects
+        - stats
+      x-fern-sdk-method-name: model_version_annotator_agreement
   /api/projects/{id}/model-stats/{model_version}/agreement-groundtruth:
     get:
       description: |-
-        Ground truth agreement for annotations that match predictions of a specific model version.
-        This mirrors gt_per_user_agreement but filters stats by tasks where predictions have given model_version.
-        :return: {"agreement": float[0..1]}
+        <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 agreement between a given model version and ground truth annotations in the project for overlapping tasks.
       operationId: api_projects_model_stats_agreement_groundtruth_retrieve
       parameters:
         - in: path
@@ -8636,6 +8650,7 @@ paths:
               schema:
                 properties:
                   agreement:
+                    nullable: true
                     type: number
                 type: object
           description: Model-version ground truth agreement
@@ -8644,17 +8659,22 @@ paths:
       summary: Get model-version ground truth agreement
       tags:
         - Stats
+      x-fern-audiences:
+        - public
+      x-fern-sdk-group-name:
+        - projects
+        - stats
+      x-fern-sdk-method-name: model_version_ground_truth_agreement
   /api/projects/{id}/model-stats/{model_version}/prediction:
     get:
       description: |-
-        Mean agreement between the given model version and all other model versions in the project.
-
-        Computed as the average of pairwise model-to-model agreement scores from PredictionPairStats where either
-        prediction pair's model_version_from or model_version_to equals the provided model_version.
-
-        When per_label=true, returns a mapping of label -> average agreement across the same set of pairs.
-
-        :return: {"average_prediction_agreement_per_model": float[0..1] | {label: float[0..1]}}
+        <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 agreement between a given model version and all other model versions in the project for overlapping tasks.
       operationId: api_projects_model_stats_prediction_retrieve
       parameters:
         - in: path
@@ -8680,6 +8700,7 @@ paths:
               schema:
                 properties:
                   average_prediction_agreement_per_model:
+                    nullable: true
                     type: number
                 type: object
           description: Model-version prediction agreement
@@ -8688,6 +8709,12 @@ paths:
       summary: Get model-version prediction agreement
       tags:
         - Stats
+      x-fern-audiences:
+        - public
+      x-fern-sdk-group-name:
+        - projects
+        - stats
+      x-fern-sdk-method-name: model_version_prediction_agreement
   /api/projects/{id}/project-extra-params/:
     get:
       description: |-