dyff-schema 0.3.7__tar.gz → 0.3.9__tar.gz

{dyff-schema-0.3.7/dyff_schema.egg-info → dyff_schema-0.3.9}/PKG-INFO

@@ -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 → dyff_schema-0.3.9}/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 → dyff_schema-0.3.9/dyff_schema.egg-info}/PKG-INFO

@@ -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