dyff-schema 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

dyff/schema/v0/r1/platform.py

@@ -1332,16 +1332,34 @@ class ForeignMethod(DyffModelWithID, MethodBase):
 
 
 class AnalysisScope(DyffSchemaBaseModel):
-    dataset: Optional[str]
-    inferenceService: Optional[str]
-    evaluation: Optional[str]
-    model: Optional[str]
+    """The specific entities to which the analysis applies.
+
+    When applying an InferenceService-scoped Method, at least
+    ``.inferenceService`` must be set.
+
+    When applying an Evaluation-scoped Method, at least ``.evaluation``,
+    ``.inferenceService``, and ``.dataset`` must be set.
+    """
+
+    dataset: Optional[str] = pydantic.Field(
+        default=None, description="The Dataset to which the analysis applies."
+    )
+    inferenceService: Optional[str] = pydantic.Field(
+        default=None, description="The InferenceService to which the analysis applies."
+    )
+    evaluation: Optional[str] = pydantic.Field(
+        default=None, description="The Evaluation to which the analysis applies."
+    )
+    model: Optional[str] = pydantic.Field(
+        default=None, description="The Model to which the analysis applies."
+    )
 
 
 class AnalysisBase(DyffSchemaBaseModel):
     scope: AnalysisScope = pydantic.Field(
+        default_factory=AnalysisScope,
         description="The specific entities to which the analysis results apply."
-        " At a minimum, the field corresponding to method.scope must be set."
+        " At a minimum, the field corresponding to method.scope must be set.",
     )
 
     arguments: list[AnalysisArgument] = pydantic.Field(
@@ -1689,6 +1707,7 @@ __all__ = [
     "AnalysisBase",
     "AnalysisInput",
     "AnalysisOutputQueryFields",
+    "AnalysisScope",
     "Annotation",
     "APIFunctions",
     "APIKey",

{dyff_schema-0.3.7.dist-info → dyff_schema-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.3.7
+Version: 0.3.9
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{dyff_schema-0.3.7.dist-info → dyff_schema-0.3.9.dist-info}/RECORD

@@ -21,7 +21,7 @@ dyff/schema/v0/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/adapters.py,sha256=2t2oxsnGfSEDKKDIEYw4qqLXMH7qlFIwPVuLyUmbsHs,23552
 dyff/schema/v0/r1/base.py,sha256=g_wqh4OU_9ftMHovVxPtdeup4O5MZi422v3eZH99ZQI,17139
-dyff/schema/v0/r1/platform.py,sha256=IoonxCKyPTnVNCmiGIxT9xG3m06V8wRmf_iuzcocPm0,55462
+dyff/schema/v0/r1/platform.py,sha256=J1TC-UXHb-cV2_cSYzvH9L3gMzk3u5Rm9oCfxxu6NiA,56247
 dyff/schema/v0/r1/requests.py,sha256=ZD31iDNyJQFDzJlFrSsDBorS7TXyhRBk-R6oG7PI3kE,7762
 dyff/schema/v0/r1/test.py,sha256=X6dUyVd5svcPCI-PBMOAqEfK9jv3bRDvkQTJzwS96c0,10720
 dyff/schema/v0/r1/version.py,sha256=SG9ds8afHgdrqOA4CEY8-MM3lKfAE9G0rxsG4uyeglE,363
@@ -33,9 +33,9 @@ dyff/schema/v0/r1/dataset/text.py,sha256=nLIn91Zlt0tNdXUklSgjJ-kEDxoPX32ISLkiv2D
 dyff/schema/v0/r1/dataset/vision.py,sha256=aIe0fbfM_g3DsrDTdg2K803YKLjZBpurM_VJcJFuZLc,369
 dyff/schema/v0/r1/io/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/io/vllm.py,sha256=CUE9y8KthtUI7sD49S875rDmPvKotSXVIRaBS79aBZs,5320
-dyff_schema-0.3.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.3.7.dist-info/METADATA,sha256=FIKMxpdwwuY4OzJXANPAZmsiQF4OQmgaZJid44UqoMY,3459
-dyff_schema-0.3.7.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.3.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dyff_schema-0.3.7.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.3.7.dist-info/RECORD,,
+dyff_schema-0.3.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.3.9.dist-info/METADATA,sha256=pqNfbMEOI4iyaOd5DDJLAMiynpatnQ2dJ-rfOH-Nj1k,3459
+dyff_schema-0.3.9.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.3.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+dyff_schema-0.3.9.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.3.9.dist-info/RECORD,,