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

{dyff_schema-0.20.1/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.1
+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.1 → 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,
@@ -252,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."
@@ -262,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)
@@ -270,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):
@@ -409,6 +425,7 @@ __all__ = [
     "ModelQueryRequest",
     "ModuleCreateRequest",
     "ModuleQueryRequest",
+    "QueryRequest",
     "ReportCreateRequest",
     "ReportQueryRequest",
     "SafetyCaseQueryRequest",

{dyff_schema-0.20.1 → 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.1
+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