cognite-toolkit 0.7.45__tar.gz → 0.7.47__tar.gz

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.7.45
+Version: 0.7.47
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Author: Cognite AS
 Author-email: Cognite AS <support@cognite.com>
@@ -37,10 +37,10 @@ Requires-Dist: sqlparse>=0.5.3 ; extra == 'sql'
 Requires-Dist: pyarrow>=20.0.0 ; extra == 'table'
 Requires-Dist: openpyxl>=3.1.5 ; extra == 'table'
 Requires-Python: >=3.10
+Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
 Project-URL: Changelog, https://github.com/cognitedata/toolkit/releases
-Project-URL: Documentation, https://docs.cognite.com/cdf/deploy/cdf_toolkit/references/resource_library
 Project-URL: GitHub, https://github.com/cognitedata/toolkit
-Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
+Project-URL: Documentation, https://docs.cognite.com/cdf/deploy/cdf_toolkit/references/resource_library
 Provides-Extra: sql
 Provides-Extra: table
 Description-Content-Type: text/markdown

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/cognite_toolkit/_cdf_tk/apps/_download_app.py

@@ -7,7 +7,7 @@ import typer
 from questionary import Choice
 from rich import print
 
-from cognite_toolkit._cdf_tk.client.data_classes.legacy.raw import RawTable
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.raw import RawTable
 from cognite_toolkit._cdf_tk.commands import DownloadCommand
 from cognite_toolkit._cdf_tk.constants import DATA_DEFAULT_DIR
 from cognite_toolkit._cdf_tk.feature_flags import Flags

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/cognite_toolkit/_cdf_tk/apps/_dump_app.py

@@ -6,7 +6,7 @@ from cognite.client.data_classes import WorkflowVersionId
 from cognite.client.data_classes.data_modeling import DataModelId, ViewId
 from rich import print
 
-from cognite_toolkit._cdf_tk.client.data_classes.legacy.search_config import ViewId as SearchConfigViewId
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.search_config import ViewId as SearchConfigViewId
 from cognite_toolkit._cdf_tk.commands import DumpResourceCommand
 from cognite_toolkit._cdf_tk.commands.dump_resource import (
     AgentFinder,

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/cognite_toolkit/_cdf_tk/builders/_raw.py

@@ -3,7 +3,7 @@ from collections.abc import Callable, Iterable, Sequence
 from typing import Any
 
 from cognite_toolkit._cdf_tk.builders import Builder
-from cognite_toolkit._cdf_tk.client.data_classes.legacy.raw import RawDatabase
+from cognite_toolkit._cdf_tk.client.resource_classes.legacy.raw import RawDatabase
 from cognite_toolkit._cdf_tk.cruds import RawDatabaseCRUD, RawTableCRUD, ResourceCRUD
 from cognite_toolkit._cdf_tk.data_classes import (
     BuildDestinationFile,

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/cognite_toolkit/_cdf_tk/client/_toolkit_client.py

@@ -15,20 +15,28 @@ from cognite_toolkit._cdf_tk.client.api.legacy.robotics import RoboticsAPI
 from cognite_toolkit._cdf_tk.client.http_client import HTTPClient
 
 from .api.assets import AssetsAPI
+from .api.datasets import DataSetsAPI
 from .api.events import EventsAPI
+from .api.extraction_pipelines import ExtractionPipelinesAPI
 from .api.filemetadata import FileMetadataAPI
+from .api.hosted_extractors import HostedExtractorsAPI
 from .api.infield import InfieldAPI
+from .api.labels import LabelsAPI
 from .api.lookup import LookUpGroup
 from .api.migration import MigrationAPI
 from .api.project import ProjectAPI
 from .api.raw import RawAPI
 from .api.search import SearchAPI
+from .api.security_categories import SecurityCategoriesAPI
+from .api.sequences import SequencesAPI
 from .api.simulators import SimulatorsAPI
 from .api.streams import StreamsAPI
 from .api.three_d import ThreeDAPI
 from .api.timeseries import TimeSeriesAPI
 from .api.token import TokenAPI
+from .api.transformations import TransformationsAPI
 from .api.verify import VerifyAPI
+from .api.workflows import WorkflowsAPI
 from .config import ToolkitClientConfig
 
 
@@ -37,13 +45,21 @@ class ToolAPI:
 
     def __init__(self, http_client: HTTPClient, console: Console) -> None:
         self.http_client = http_client
-        self.three_d = ThreeDAPI(http_client, console)
         self.assets = AssetsAPI(http_client)
-        self.timeseries = TimeSeriesAPI(http_client)
-        self.filemetadata = FileMetadataAPI(http_client)
+        self.datasets = DataSetsAPI(http_client)
         self.events = EventsAPI(http_client)
+        self.extraction_pipelines = ExtractionPipelinesAPI(http_client)
+        self.hosted_extractors = HostedExtractorsAPI(http_client)
+        self.labels = LabelsAPI(http_client)
+        self.filemetadata = FileMetadataAPI(http_client)
         self.raw = RawAPI(http_client)
+        self.security_categories = SecurityCategoriesAPI(http_client)
+        self.sequences = SequencesAPI(http_client)
         self.simulators = SimulatorsAPI(http_client)
+        self.three_d = ThreeDAPI(http_client, console)
+        self.timeseries = TimeSeriesAPI(http_client)
+        self.transformations = TransformationsAPI(http_client)
+        self.workflows = WorkflowsAPI(http_client)
 
 
 class ToolkitClient(CogniteClient):

cognite_toolkit-0.7.47/cognite_toolkit/_cdf_tk/client/api/agents.py

@@ -0,0 +1,107 @@
+"""Agents API for managing CDF AI agents.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101-alpha/tag/Agents/operation/main_ai_agents_post
+
+Note: This is an alpha API and may change in future releases.
+"""
+
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.agent import AgentRequest, AgentResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
+
+
+class AgentsAPI(CDFResourceAPI[ExternalId, AgentRequest, AgentResponse]):
+    """API for managing CDF AI agents.
+
+    Note: This is an alpha API and may change in future releases.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/ai/agents", item_limit=1),
+                "retrieve": Endpoint(method="POST", path="/ai/agents/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/ai/agents/delete", item_limit=1),
+                "list": Endpoint(method="GET", path="/ai/agents", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[AgentResponse]:
+        return PagedResponse[AgentResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[AgentRequest]) -> list[AgentResponse]:
+        """Apply (create or update) agents in CDF.
+
+        Args:
+            items: List of AgentRequest objects to apply.
+
+        Returns:
+            List of applied AgentResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def update(self, items: Sequence[AgentRequest]) -> list[AgentResponse]:
+        """Update agents in CDF.
+
+        Args:
+            items: List of AgentRequest objects to update.
+        Returns:
+            List of updated AgentResponse objects.
+        """
+        # Implemented as an alias to create (upsert) to have a standardized interface.
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False) -> list[AgentResponse]:
+        """Retrieve agents from CDF by external ID.
+
+        Args:
+            items: List of ExternalId objects to retrieve.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+
+        Returns:
+            List of retrieved AgentResponse objects.
+        """
+        return self._request_item_response(
+            items, method="retrieve", extra_body={"ignoreUnknownIds": ignore_unknown_ids}
+        )
+
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False) -> None:
+        """Delete agents from CDF.
+
+        Args:
+            items: List of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
+        """
+        self._request_no_response(items, "delete", extra_body={"ignoreUnknownIds": ignore_unknown_ids})
+
+    def iterate(
+        self,
+        limit: int | None = None,
+    ) -> Iterable[list[AgentResponse]]:
+        """Iterate over all agents in CDF.
+
+        Args:
+            limit: Maximum total number of agents to return.
+
+        Returns:
+            Iterable of lists of AgentResponse objects.
+        """
+        return self._iterate(limit=limit)
+
+    def list(self, limit: int | None = None) -> list[AgentResponse]:
+        """List all agents in CDF.
+
+        Args:
+            limit: Maximum total number of agents to return.
+
+        Returns:
+            List of AgentResponse objects.
+        """
+        return self._list(limit=limit)

cognite_toolkit-0.7.47/cognite_toolkit/_cdf_tk/client/api/annotations.py

@@ -0,0 +1,129 @@
+"""Annotations API for managing CDF annotations.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Annotations/operation/annotationsCreate
+"""
+
+from collections.abc import Iterable, Sequence
+from typing import Literal
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import AnnotationFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.annotation import AnnotationRequest, AnnotationResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalId
+
+
+class AnnotationsAPI(CDFResourceAPI[InternalId, AnnotationRequest, AnnotationResponse]):
+    """API for managing CDF annotations."""
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/annotations", item_limit=1000),
+                "retrieve": Endpoint(method="POST", path="/annotations/byids", item_limit=1000),
+                "update": Endpoint(method="POST", path="/annotations/update", item_limit=1000),
+                "delete": Endpoint(method="POST", path="/annotations/delete", item_limit=1000),
+                "list": Endpoint(method="POST", path="/annotations/list", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[AnnotationResponse]:
+        return PagedResponse[AnnotationResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[AnnotationRequest]) -> list[AnnotationResponse]:
+        """Create annotations in CDF.
+
+        Args:
+            items: List of AnnotationRequest objects to create.
+
+        Returns:
+            List of created AnnotationResponse objects.
+        """
+        return self._request_item_response(items, "create")
+
+    def retrieve(self, items: Sequence[InternalId]) -> list[AnnotationResponse]:
+        """Retrieve annotations from CDF by ID.
+
+        Args:
+            items: List of InternalId objects to retrieve.
+
+        Returns:
+            List of retrieved AnnotationResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def update(
+        self, items: Sequence[AnnotationRequest], mode: Literal["patch", "replace"] = "replace"
+    ) -> list[AnnotationResponse]:
+        """Update annotations in CDF.
+
+        Args:
+            items: List of AnnotationRequest objects to update.
+            mode: Update mode, either "patch" or "replace".
+
+        Returns:
+            List of updated AnnotationResponse objects.
+        """
+        return self._update(items, mode=mode)
+
+    def delete(self, items: Sequence[InternalId]) -> None:
+        """Delete annotations from CDF.
+
+        Args:
+            items: List of InternalId objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: AnnotationFilter,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[AnnotationResponse]:
+        """Get a page of annotations from CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum number of annotations to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of AnnotationResponse objects.
+        """
+        return self._paginate(cursor=cursor, limit=limit, body=filter.dump())
+
+    def iterate(
+        self,
+        filter: AnnotationFilter,
+        limit: int | None = None,
+    ) -> Iterable[list[AnnotationResponse]]:
+        """Iterate over all annotations in CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum total number of annotations to return.
+
+        Returns:
+            Iterable of lists of AnnotationResponse objects.
+        """
+        return self._iterate(limit=limit, body=filter.dump())
+
+    def list(
+        self,
+        filter: AnnotationFilter,
+        limit: int | None = None,
+    ) -> list[AnnotationResponse]:
+        """List all annotations in CDF.
+
+        Args:
+            filter: AnnotationFilter to filter annotations.
+            limit: Maximum total number of annotations to return.
+
+        Returns:
+            List of AnnotationResponse objects.
+        """
+        return self._list(limit=limit, body=filter.dump())

{cognite_toolkit-0.7.45 → cognite_toolkit-0.7.47}/cognite_toolkit/_cdf_tk/client/api/assets.py

@@ -1,11 +1,12 @@
-from collections.abc import Sequence
-from typing import Any, Literal
+from collections.abc import Iterable, Sequence
+from typing import Literal
 
 from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse, ResponseItems
 from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
-from cognite_toolkit._cdf_tk.client.data_classes.asset import AssetRequest, AssetResponse
-from cognite_toolkit._cdf_tk.client.data_classes.identifiers import InternalOrExternalId
 from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import ClassicFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.asset import AssetRequest, AssetResponse
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import InternalOrExternalId
 
 
 class AssetsAPI(CDFResourceAPI[InternalOrExternalId, AssetRequest, AssetResponse]):
@@ -21,7 +22,9 @@ class AssetsAPI(CDFResourceAPI[InternalOrExternalId, AssetRequest, AssetResponse
             },
         )
 
-    def _page_response(self, response: SuccessResponse2 | ItemsSuccessResponse2) -> PagedResponse[AssetResponse]:
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[AssetResponse]:
         return PagedResponse[AssetResponse].model_validate_json(response.body)
 
     def _reference_response(self, response: SuccessResponse2) -> ResponseItems[InternalOrExternalId]:
@@ -78,11 +81,10 @@ class AssetsAPI(CDFResourceAPI[InternalOrExternalId, AssetRequest, AssetResponse
             items, "delete", extra_body={"recursive": recursive, "ignoreUnknownIds": ignore_unknown_ids}
         )
 
-    def iterate(
+    def paginate(
         self,
         aggregated_properties: bool = False,
-        data_set_external_ids: list[str] | None = None,
-        asset_subtree_external_ids: list[str] | None = None,
+        filter: ClassicFilter | None = None,
         limit: int = 100,
         cursor: str | None = None,
     ) -> PagedResponse[AssetResponse]:
@@ -91,25 +93,35 @@ class AssetsAPI(CDFResourceAPI[InternalOrExternalId, AssetRequest, AssetResponse
         Returns:
             PagedResponse of AssetResponse objects.
         """
-        filter_: dict[str, Any] = {}
-        if asset_subtree_external_ids:
-            filter_["assetSubtreeExternalIds"] = [{"externalId": ext_id} for ext_id in asset_subtree_external_ids]
-        if data_set_external_ids:
-            filter_["dataSetIds"] = [{"externalId": ds_id} for ds_id in data_set_external_ids]
-
-        return self._iterate(
+        return self._paginate(
             cursor=cursor,
             limit=limit,
             body={
                 "aggregatedProperties": ["childCount", "path", "depth"] if aggregated_properties else [],
-                "filter": filter_ or None,
+                "filter": filter.dump() if filter else None,
             },
         )
 
-    def list(
+    def iterate(
         self,
+        aggregated_properties: bool = False,
+        filter: ClassicFilter | None = None,
         limit: int | None = 100,
-    ) -> list[AssetResponse]:
+    ) -> Iterable[list[AssetResponse]]:
+        """Iterate over all assets in CDF.
+
+        Returns:
+            Sequence of AssetResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            body={
+                "aggregatedProperties": ["childCount", "path", "depth"] if aggregated_properties else [],
+                "filter": filter.dump() if filter else None,
+            },
+        )
+
+    def list(self, limit: int | None = 100) -> list[AssetResponse]:
         """List all asset references in CDF.
 
         Returns:

cognite_toolkit-0.7.47/cognite_toolkit/_cdf_tk/client/api/containers.py

@@ -0,0 +1,132 @@
+"""Containers API for managing CDF data modeling containers.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Containers/operation/ApplyContainers
+"""
+
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.request_classes.filters import ContainerFilter
+from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import (
+    ContainerReference,
+    ContainerRequest,
+    ContainerResponse,
+)
+
+
+class ContainersAPI(CDFResourceAPI[ContainerReference, ContainerRequest, ContainerResponse]):
+    """API for managing CDF data modeling containers.
+
+    Containers use an apply/upsert pattern for create and update operations.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/models/containers", item_limit=100),
+                "retrieve": Endpoint(method="POST", path="/models/containers/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/models/containers/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/models/containers", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[ContainerResponse]:
+        return PagedResponse[ContainerResponse].model_validate_json(response.body)
+
+    def create(self, items: Sequence[ContainerRequest]) -> list[ContainerResponse]:
+        """Create (create or update) containers in CDF.
+
+        Args:
+            items: List of ContainerRequest objects to apply.
+
+        Returns:
+            List of applied ContainerResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def update(self, items: Sequence[ContainerRequest]) -> list[ContainerResponse]:
+        """Update (create or update) containers in CDF.
+
+        Args:
+            items: List of ContainerRequest objects to apply.
+        Returns:
+            List of applied ContainerResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[ContainerReference]) -> list[ContainerResponse]:
+        """Retrieve containers from CDF.
+
+        Args:
+            items: List of ContainerReference objects to retrieve.
+
+        Returns:
+            List of retrieved ContainerResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def delete(self, items: Sequence[ContainerReference]) -> None:
+        """Delete containers from CDF.
+
+        Args:
+            items: List of ContainerReference objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        filter: ContainerFilter | None = None,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[ContainerResponse]:
+        """Get a page of containers from CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum number of containers to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of ContainerResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def iterate(
+        self,
+        filter: ContainerFilter | None = None,
+        limit: int | None = None,
+    ) -> Iterable[list[ContainerResponse]]:
+        """Iterate over all containers in CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum total number of containers to return.
+
+        Returns:
+            Iterable of lists of ContainerResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            params=filter.dump() if filter else None,
+        )
+
+    def list(self, filter: ContainerFilter | None = None, limit: int | None = None) -> list[ContainerResponse]:
+        """List all containers in CDF.
+
+        Args:
+            filter: ContainerFilter to filter containers.
+            limit: Maximum total number of containers to return.
+
+        Returns:
+            List of ContainerResponse objects.
+        """
+        return self._list(limit=limit, params=filter.dump() if filter else None)