dyff-schema 0.20.0__tar.gz → 0.21.0__tar.gz

{dyff_schema-0.20.0 → dyff_schema-0.21.0}/.gitlab-ci.yml

@@ -12,7 +12,7 @@ include:
     file:
       - gitlab-release.yml
   - project: buildgarden/pipelines/detect-secrets
-    ref: 0.2.2
+    ref: 0.2.3
     file:
       - detect-secrets.yml
   - project: buildgarden/pipelines/prettier
@@ -20,7 +20,7 @@ include:
     file:
       - prettier.yml
   - project: buildgarden/pipelines/python
-    ref: 0.14.1
+    ref: 0.14.2
     file:
       - python-autoflake.yml
       - python-black.yml

{dyff_schema-0.20.0/dyff_schema.egg-info → dyff_schema-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.20.0
+Version: 0.21.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.20.0 → dyff_schema-0.21.0}/dyff/schema/v0/r1/requests.py

@@ -16,11 +16,11 @@ from __future__ import annotations
 
 import re
 from datetime import datetime
-from typing import Optional, Union
+from typing import Literal, Optional, Union
 
 import pydantic
 
-from .base import DyffBaseModel
+from .base import DyffBaseModel, DyffSchemaBaseModel
 from .platform import (
     AnalysisBase,
     AnalysisScope,
@@ -38,6 +38,8 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     ReportBase,
+    summary_maxlen,
+    title_maxlen,
 )
 from .version import SchemaVersion
 
@@ -94,7 +96,28 @@ class AnalysisCreateRequest(DyffEntityCreateRequest, AnalysisBase):
 
 
 class ConcernCreateRequest(DyffEntityCreateRequest, ConcernBase):
-    pass
+    @pydantic.validator("documentation", check_fields=False)
+    def _validate_documentation(
+        cls, documentation: DocumentationBase
+    ) -> DocumentationBase:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if (
+            documentation.title is not None
+            and len(documentation.title) > title_maxlen()
+        ):
+            raise ValueError(
+                f".documentation.title must have length < {title_maxlen()}"
+            )
+        if (
+            documentation.summary is not None
+            and len(documentation.summary) > summary_maxlen()
+        ):
+            raise ValueError(
+                f".documentation.summary must have length < {summary_maxlen()}"
+            )
+        return documentation
 
 
 class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
@@ -102,7 +125,23 @@ class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
 
 
 class DocumentationEditRequest(DyffRequestBase, DocumentationBase):
-    pass
+    @pydantic.validator("title", check_fields=False)
+    def _validate_title(cls, title: Optional[str]) -> Optional[str]:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if title is not None and len(title) > title_maxlen():
+            raise ValueError(f".title must have length < {title_maxlen()}")
+        return title
+
+    @pydantic.validator("summary", check_fields=False)
+    def _validate_summary(cls, summary: Optional[str]) -> Optional[str]:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if summary is not None and len(summary) > summary_maxlen():
+            raise ValueError(f".summary must have length < {summary_maxlen()}")
+        return summary
 
 
 class InferenceServiceCreateRequest(DyffEntityCreateRequest, InferenceServiceBase):
@@ -213,7 +252,7 @@ class LabelUpdateRequest(DyffRequestBase, Labeled):
 # specify. I think it's not that important, because all of the query parameters
 # will always be optional. There could be a problem if the semantics of a
 # name change, but let's just not do that!
-class DyffEntityQueryRequest(DyffRequestDefaultValidators):
+class QueryRequest(DyffRequestDefaultValidators):
     query: Optional[str] = pydantic.Field(
         default=None,
         description="A JSON structure describing a query, encoded as a string."
@@ -223,6 +262,30 @@ class DyffEntityQueryRequest(DyffRequestDefaultValidators):
     )
 
     id: Optional[str] = pydantic.Field(default=None)
+
+    order: Optional[Literal["ascending", "descending"]] = pydantic.Field(
+        default=None,
+        description="Sort the results in this order. Default: unsorted."
+        " Ignored unless 'orderBy' is also set."
+        " The order of operations is query -> order -> limit.",
+    )
+
+    orderBy: Optional[str] = pydantic.Field(
+        default=None,
+        description="Sort the results by the value of the specified field."
+        " The 'order' field must be set also."
+        " The order of operations is query -> order -> limit.",
+    )
+
+    limit: Optional[int] = pydantic.Field(
+        default=None,
+        ge=1,
+        description="Return at most this many results."
+        " The order of operations is query -> order -> limit.",
+    )
+
+
+class DyffEntityQueryRequest(QueryRequest):
     account: Optional[str] = pydantic.Field(default=None)
     status: Optional[str] = pydantic.Field(default=None)
     reason: Optional[str] = pydantic.Field(default=None)
@@ -231,16 +294,8 @@ 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 DocumentationQueryRequest(QueryRequest):
+    pass
 
 
 class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
@@ -370,6 +425,7 @@ __all__ = [
     "ModelQueryRequest",
     "ModuleCreateRequest",
     "ModuleQueryRequest",
+    "QueryRequest",
     "ReportCreateRequest",
     "ReportQueryRequest",
     "SafetyCaseQueryRequest",

{dyff_schema-0.20.0 → dyff_schema-0.21.0/dyff_schema.egg-info}/PKG-INFO

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