dyff-schema 0.20.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

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.dist-info → dyff_schema-0.21.0.dist-info}/METADATA

@@ -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.dist-info → dyff_schema-0.21.0.dist-info}/RECORD

@@ -25,7 +25,7 @@ dyff/schema/v0/r1/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs
 dyff/schema/v0/r1/adapters.py,sha256=2t2oxsnGfSEDKKDIEYw4qqLXMH7qlFIwPVuLyUmbsHs,23552
 dyff/schema/v0/r1/base.py,sha256=IpvlYDr6JjYo6tn8XW4C1Fpgd_uqzZGZsG_cuEn_gQs,19441
 dyff/schema/v0/r1/platform.py,sha256=bvROO9WEOV257C_QSWuWeDLCFegaYl116YvMP-AClUE,75609
-dyff/schema/v0/r1/requests.py,sha256=s31J0fegRm_7My_5Ut-qNQnXtMMVwlhOSWKf51h5u4g,13269
+dyff/schema/v0/r1/requests.py,sha256=4TM1IKG9IP4MyprIy9E9XA_JqvkuwKAuY1ao1BbVLI0,15676
 dyff/schema/v0/r1/test.py,sha256=X6dUyVd5svcPCI-PBMOAqEfK9jv3bRDvkQTJzwS96c0,10720
 dyff/schema/v0/r1/version.py,sha256=isKAGuGxsdru8vDaYmI4YiZdJOu_wNxXK7u6QzD6FE4,392
 dyff/schema/v0/r1/dataset/__init__.py,sha256=LbVlkO2asyGYBKk2z49xjJYTM-pu9y9e4eQDXgTDLnM,2553
@@ -37,9 +37,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.20.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.20.0.dist-info/METADATA,sha256=WkVYqNNDqfAfcdwnC5kkmYa2q86AYDVjhZcMD5Sn14k,3482
-dyff_schema-0.20.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.20.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-dyff_schema-0.20.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.20.0.dist-info/RECORD,,
+dyff_schema-0.21.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.21.0.dist-info/METADATA,sha256=9GEkk75CrXQJyJVMlEDJJLI0c3XD49ZHnrcjTa8Bsls,3482
+dyff_schema-0.21.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.21.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+dyff_schema-0.21.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.21.0.dist-info/RECORD,,