dyff-schema 0.12.0__tar.gz → 0.14.0__tar.gz

{dyff_schema-0.12.0/dyff_schema.egg-info → dyff_schema-0.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.12.0
+Version: 0.14.0
 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.12.0 → dyff_schema-0.14.0}/dyff/schema/v0/r1/platform.py

@@ -345,7 +345,11 @@ class DocumentationBase(DyffSchemaBaseModel):
 
 
 class Documentation(SchemaVersion, DocumentationBase):
-    pass
+    entity: Optional[str] = pydantic.Field(
+        default=None,
+        description="The ID of the documented entity. This is Optional for"
+        " backward compatibility but it will always be populated in API responses.",
+    )
 
 
 class Documented(DyffSchemaBaseModel):
@@ -500,9 +504,17 @@ class AccessGrant(DyffSchemaBaseModel):
     )
 
 
-class APIKey(DyffSchemaBaseModel):
-    """A description of a set of permissions granted to a single subject (either an
-    account or a workload).
+class Role(DyffSchemaBaseModel):
+    """A set of permissions."""
+
+    grants: list[AccessGrant] = pydantic.Field(
+        default_factory=list, description="The permissions granted to the role."
+    )
+
+
+class APIKey(Role):
+    """A description of a Role (a set of permissions) granted to a single subject
+    (either an account or a workload).
 
     Dyff API clients authenticate with a *token* that contains a cryptographically
     signed APIKey.
@@ -525,9 +537,6 @@ class APIKey(DyffSchemaBaseModel):
         default=None,
         description="For account keys: a secret value to check when verifying the APIKey",
     )
-    grants: list[AccessGrant] = pydantic.Field(
-        default_factory=list, description="AccessGrants associated with the APIKey"
-    )
 
 
 class Identity(DyffSchemaBaseModel):
@@ -1650,11 +1659,32 @@ class AnalysisBase(DyffSchemaBaseModel):
     )
 
 
+class AnalysisData(DyffSchemaBaseModel):
+    """Arbitrary additional data for the Analysis, specified as a key-value pair where
+    the value is the data encoded in base64."""
+
+    key: str = pydantic.Field(
+        description="Key identifying the data. For data about a Dyff entity,"
+        " this should be the entity's ID."
+    )
+
+    value: str = pydantic.Field(
+        # Canonical base64 encoding
+        # https://stackoverflow.com/a/64467300/3709935
+        regex=r"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/][AQgw]==|[A-Za-z0-9+/]{2}[AEIMQUYcgkosw048]=)?$",
+        description="Arbitrary data encoded in base64.",
+    )
+
+
 class Analysis(AnalysisBase):
     method: ForeignMethod = pydantic.Field(
         description="The analysis Method to run.",
     )
 
+    data: list[AnalysisData] = pydantic.Field(
+        default_factory=list, description="Additional data to supply to the analysis."
+    )
+
 
 class Measurement(DyffEntity, MeasurementSpec, Analysis):
     kind: Literal["Measurement"] = Entities.Measurement.value
@@ -2015,6 +2045,7 @@ __all__ = [
     "Analysis",
     "AnalysisArgument",
     "AnalysisBase",
+    "AnalysisData",
     "AnalysisInput",
     "AnalysisOutputQueryFields",
     "AnalysisScope",
@@ -2113,6 +2144,7 @@ __all__ = [
     "Resources",
     "Revision",
     "RevisionMetadata",
+    "Role",
     "SafetyCase",
     "SafetyCaseSpec",
     "SchemaAdapter",

{dyff_schema-0.12.0 → dyff_schema-0.14.0}/dyff/schema/v0/r1/requests.py

@@ -205,6 +205,18 @@ class DyffEntityQueryRequest(DyffRequestDefaultValidators):
     )
 
 
+class DocumentationQueryRequest(DyffRequestDefaultValidators):
+    query: Optional[str] = pydantic.Field(
+        default=None,
+        description="A JSON structure describing a query, encoded as a string."
+        " Valid keys are the same as the valid query keys for the corresponding"
+        " endpoint. Values can be scalars or lists. Lists are treated as"
+        " disjunctive queries (i.e., 'value $in list').",
+    )
+
+    id: Optional[str] = pydantic.Field(default=None)
+
+
 class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
     method: Optional[str] = pydantic.Field(default=None)
     methodName: Optional[str] = pydantic.Field(default=None)
@@ -288,6 +300,7 @@ __all__ = [
     "DatasetCreateRequest",
     "DatasetQueryRequest",
     "DocumentationEditRequest",
+    "DocumentationQueryRequest",
     "EvaluationCreateRequest",
     "EvaluationQueryRequest",
     "EvaluationInferenceSessionRequest",

{dyff_schema-0.12.0 → dyff_schema-0.14.0/dyff_schema.egg-info}/PKG-INFO

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