cognite-toolkit 0.6.39__py3-none-any.whl → 0.7.30__py3-none-any.whl

cognite_toolkit/_cdf_tk/resource_classes/agent_tools.py

@@ -0,0 +1,101 @@
+from typing import Annotated, Literal
+
+from pydantic import Field
+
+from cognite_toolkit._cdf_tk.constants import DM_EXTERNAL_ID_PATTERN, DM_VERSION_PATTERN, SPACE_FORMAT_PATTERN
+
+from .base import BaseModelResource
+
+
+class AgentToolDefinition(BaseModelResource):
+    type: str
+    name: str = Field(
+        description="A name for the tool, unique within the agent.",
+        min_length=1,
+        max_length=64,
+        pattern=r"^[^\x00]{1,64}$",
+    )
+    description: str = Field(
+        description="A description of how the tool helps the language model understand when and how to use the tool.",
+        min_length=10,
+        max_length=1024,
+    )
+
+
+class AskDocument(AgentToolDefinition):
+    type: Literal["askDocument"] = "askDocument"
+
+
+class AgentDataModel(BaseModelResource):
+    space: str = Field(
+        description="The space the data model is in.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )
+    external_id: str = Field(
+        description="The external ID of the data model.",
+        min_length=1,
+        max_length=255,
+        pattern=DM_EXTERNAL_ID_PATTERN,
+    )
+    version: str = Field(
+        description="The version of the data model.",
+        max_length=43,
+        pattern=DM_VERSION_PATTERN,
+    )
+    view_external_ids: list[str] = Field(description="The views of the data model.", min_length=1, max_length=10)
+
+
+class AgentInstanceSpacesDefinition(BaseModelResource):
+    type: str
+
+
+class AllInstanceSpaces(AgentInstanceSpacesDefinition):
+    type: Literal["all"] = "all"
+
+
+class ManualInstanceSpaces(AgentInstanceSpacesDefinition):
+    type: Literal["manual"] = "manual"
+    spaces: list[str]
+
+
+AgentInstanceSpaces = Annotated[
+    AllInstanceSpaces | ManualInstanceSpaces,
+    Field(discriminator="type"),
+]
+
+
+class QueryKnowledgeGraphConfig(BaseModelResource):
+    data_models: list[AgentDataModel] = Field(
+        description="List of relevant data models.",
+        min_length=1,
+        max_length=80,
+    )
+    instance_spaces: AgentInstanceSpaces
+    version: Literal["v1", "v2"] = Field(
+        "v2",
+        description="The version of the query generation strategy to use. "
+        "A higher number does not necessarily mean a better query.",
+    )
+
+
+class QueryKnowledgeGraph(AgentToolDefinition):
+    type: Literal["queryKnowledgeGraph"] = "queryKnowledgeGraph"
+    configuration: QueryKnowledgeGraphConfig = Field(
+        description="Configuration for the Query Knowledge Graph tool.",
+    )
+
+
+class QueryTimeSeriesDatapoints(AgentToolDefinition):
+    type: Literal["queryTimeSeriesDatapoints"] = "queryTimeSeriesDatapoints"
+
+
+class SummarizeDocument(AgentToolDefinition):
+    type: Literal["summarizeDocument"] = "summarizeDocument"
+
+
+AgentTool = Annotated[
+    AskDocument | QueryKnowledgeGraph | QueryTimeSeriesDatapoints | SummarizeDocument,
+    Field(discriminator="type"),
+]

cognite_toolkit/_cdf_tk/resource_classes/capabilities.py

@@ -510,6 +510,18 @@ class LegacyGenericsAcl(Capability):
     scope: AllScope
 
 
+class StreamsAcl(Capability):
+    _capability_name = "streamsAcl"
+    actions: list[Literal["READ", "CREATE", "DELETE"]]
+    scope: AllScope
+
+
+class StreamRecordsAcl(Capability):
+    _capability_name = "streamRecordsAcl"
+    actions: list[Literal["READ", "WRITE"]]
+    scope: AllScope | SpaceIDScope
+
+
 _CAPABILITY_CLASS_BY_NAME: MappingProxyType[str, type[Capability]] = MappingProxyType(
     {c._capability_name: c for c in Capability.__subclasses__()}
 )

cognite_toolkit/_cdf_tk/resource_classes/functions.py

@@ -2,6 +2,8 @@ from typing import Literal
 
 from pydantic import Field
 
+from cognite_toolkit._cdf_tk.constants import SPACE_FORMAT_PATTERN
+
 from .base import ToolkitResource
 
 
@@ -42,7 +44,9 @@ class FunctionsYAML(ToolkitResource):
     )
     cpu: float | None = Field(default=None, description="Number of CPU cores per function.")
     memory: float | None = Field(default=None, description="Memory per function measured in GB.")
-    runtime: Literal["py39", "py310", "py311"] | None = Field(default="py311", description="Runtime of the function.")
+    runtime: Literal["py39", "py310", "py311", "py312"] | None = Field(
+        default="py311", description="Runtime of the function."
+    )
     metadata: dict[str, str] | None = Field(
         default=None, description="Custom, application-specific metadata.", max_length=16
     )
@@ -59,3 +63,10 @@ class FunctionsYAML(ToolkitResource):
         description="Target dataset external ID for the file where the function code is stored.",
         max_length=255,
     )
+    space: str | None = Field(
+        default=None,
+        description="The space for the CogniteFile where the function code is stored.",
+        min_length=1,
+        max_length=43,
+        pattern=SPACE_FORMAT_PATTERN,
+    )

cognite_toolkit/_cdf_tk/resource_classes/infield_cdm_location_config.py

@@ -0,0 +1,109 @@
+from typing import Any
+
+from .base import BaseModelResource, ToolkitResource
+
+
+class FeatureToggles(BaseModelResource):
+    """Feature toggles for InField location configuration."""
+
+    three_d: bool | None = None
+    trends: bool | None = None
+    documents: bool | None = None
+    workorders: bool | None = None
+    notifications: bool | None = None
+    media: bool | None = None
+    template_checklist_flow: bool | None = None
+
+
+class AccessManagement(BaseModelResource):
+    """Access management configuration."""
+
+    template_admins: list[str] | None = None  # list of CDF group external IDs
+    checklist_admins: list[str] | None = None  # list of CDF group external IDs
+
+
+class DataFilterPath(BaseModelResource):
+    """Path reference for data filters."""
+
+    space: str
+    external_id: str
+
+
+class DataFilter(BaseModelResource):
+    """Data filter configuration for a resource type."""
+
+    path: DataFilterPath | None = None
+    instance_spaces: list[str] | None = None
+
+
+class DataFilters(BaseModelResource):
+    """Data filters configuration."""
+
+    files: DataFilter | None = None
+    assets: DataFilter | None = None
+    operations: DataFilter | None = None
+    time_series: DataFilter | None = None
+    notifications: DataFilter | None = None
+    maintenance_orders: DataFilter | None = None
+
+
+class DataStorage(BaseModelResource):
+    """Data storage configuration."""
+
+    root_location: DataFilterPath | None = None
+    app_instance_space: str | None = None
+
+
+class ViewMapping(BaseModelResource):
+    """View mapping configuration."""
+
+    space: str
+    version: str
+    external_id: str
+
+
+class ViewMappings(BaseModelResource):
+    """View mappings configuration."""
+
+    asset: ViewMapping | None = None
+    operation: ViewMapping | None = None
+    notification: ViewMapping | None = None
+    maintenance_order: ViewMapping | None = None
+
+
+class Discipline(BaseModelResource):
+    """Discipline configuration."""
+
+    name: str
+    external_id: str
+
+
+class InFieldCDMLocationConfigYAML(ToolkitResource):
+    """Properties for InFieldCDMLocationConfig node.
+
+    Fields:
+    - space: The space of the InField CDM location configuration
+    - external_id: The external ID of the InField CDM location configuration
+    - name: The name of the location configuration
+    - description: The description of the location configuration
+    - feature_toggles: Feature toggles configuration
+    - access_management: Access management configuration
+    - data_filters: Data filters configuration for various resource types
+    - data_storage: Data storage configuration
+    - view_mappings: View mappings configuration
+    - disciplines: List of disciplines
+    - data_exploration_config: Data exploration configuration
+    """
+
+    space: str
+    external_id: str
+
+    name: str | None = None
+    description: str | None = None
+    feature_toggles: FeatureToggles | None = None
+    access_management: AccessManagement | None = None
+    data_filters: DataFilters | None = None
+    data_storage: DataStorage | None = None
+    view_mappings: ViewMappings | None = None
+    disciplines: list[Discipline] | None = None
+    data_exploration_config: dict[str, Any] | None = None

cognite_toolkit/_cdf_tk/resource_classes/infield_location_config.py

@@ -0,0 +1,94 @@
+from typing import Any
+
+from .base import BaseModelResource, ToolkitResource
+
+
+class ObservationFeatureToggles(BaseModelResource):
+    """Feature toggles for observations."""
+
+    is_enabled: bool | None = None
+    is_write_back_enabled: bool | None = None
+    notifications_endpoint_external_id: str | None = None
+    attachments_endpoint_external_id: str | None = None
+
+
+class FeatureToggles(BaseModelResource):
+    """Feature toggles for InField location configuration."""
+
+    three_d: bool | None = None
+    trends: bool | None = None
+    documents: bool | None = None
+    workorders: bool | None = None
+    notifications: bool | None = None
+    media: bool | None = None
+    template_checklist_flow: bool | None = None
+    workorder_checklist_flow: bool | None = None
+    observations: ObservationFeatureToggles | None = None
+
+
+class AccessManagement(BaseModelResource):
+    """Access management configuration."""
+
+    template_admins: list[str] | None = None  # list of CDF group external IDs
+    checklist_admins: list[str] | None = None  # list of CDF group external IDs
+
+
+class ResourceFilters(BaseModelResource):
+    """Resource filters."""
+
+    spaces: list[str] | None = None
+
+
+class RootLocationDataFilters(BaseModelResource):
+    """Data filters for root location."""
+
+    general: ResourceFilters | None = None
+    assets: ResourceFilters | None = None
+    files: ResourceFilters | None = None
+    timeseries: ResourceFilters | None = None
+
+
+class DataExplorationConfig(BaseModelResource):
+    """Properties for DataExplorationConfig node.
+
+    Contains configuration for data exploration features:
+    - observations: Observations feature configuration
+    - activities: Activities configuration
+    - documents: Document configuration
+    - notifications: Notifications configuration
+    - assets: Asset page configuration
+    """
+
+    space: str | None = None
+    external_id: str | None = None
+
+    observations: dict[str, Any] | None = None  # ObservationsConfigFeature
+    activities: dict[str, Any] | None = None  # ActivitiesConfiguration
+    documents: dict[str, Any] | None = None  # DocumentConfiguration
+    notifications: dict[str, Any] | None = None  # NotificationsConfiguration
+    assets: dict[str, Any] | None = None  # AssetPageConfiguration
+
+
+class InfieldLocationConfigYAML(ToolkitResource):
+    """Properties for InFieldLocationConfig node.
+
+    Currently migrated fields:
+    - root_location_external_id: Reference to the LocationFilterDTO external ID
+    - feature_toggles: Feature toggles migrated from old configuration
+    - rootAsset: Direct relation to the root asset (space and externalId)
+    - app_instance_space: Application instance space from appDataInstanceSpace
+    - access_management: Template and checklist admin groups (from templateAdmins and checklistAdmins)
+    - disciplines: List of disciplines (from disciplines in FeatureConfiguration)
+    - data_filters: Data filters for general, assets, files, and timeseries (from dataFilters in old configuration)
+    - data_exploration_config: Direct relation to the DataExplorationConfig node (shared across all locations)
+    """
+
+    space: str
+    external_id: str
+
+    root_location_external_id: str | None = None
+    feature_toggles: FeatureToggles | None = None
+    app_instance_space: str | None = None
+    access_management: AccessManagement | None = None
+    data_filters: RootLocationDataFilters | None = None
+    data_exploration_config: DataExplorationConfig | None = None

cognite_toolkit/_cdf_tk/resource_classes/infield_v1.py

@@ -0,0 +1,100 @@
+from .base import BaseModelResource, ToolkitResource
+
+
+class ThreeDModelIdentifier(BaseModelResource):
+    revision_id: int | None = None
+    model_id: int | None = None
+    name: str | None = None
+
+
+class ThreeDConfiguration(BaseModelResource):
+    full_weight_models: list[ThreeDModelIdentifier] | None = None
+    light_weight_models: list[ThreeDModelIdentifier] | None = None
+
+
+class ResourceFilters(BaseModelResource):
+    data_set_external_ids: list[str] | None = None
+    asset_subtree_external_ids: list[str] | None = None
+    root_asset_external_ids: list[str] | None = None
+    external_id_prefix: str | None = None
+    spaces: list[str] | None = None
+
+
+class RootLocationDataFilters(BaseModelResource):
+    general: ResourceFilters | None = None
+    assets: ResourceFilters | None = None
+    files: ResourceFilters | None = None
+    timeseries: ResourceFilters | None = None
+
+
+class ObservationFeatureToggles(BaseModelResource):
+    is_enabled: bool | None = None
+    is_write_back_enabled: bool | None = None
+    notifications_endpoint_external_id: str | None = None
+    attachments_endpoint_external_id: str | None = None
+
+
+class RootLocationFeatureToggles(BaseModelResource):
+    three_d: bool | None = None
+    trends: bool | None = None
+    documents: bool | None = None
+    workorders: bool | None = None
+    notifications: bool | None = None
+    media: bool | None = None
+    template_checklist_flow: bool | None = None
+    workorder_checklist_flow: bool | None = None
+    observations: ObservationFeatureToggles | None = None
+
+
+class ObservationConfigFieldProperty(BaseModelResource):
+    display_title: str | None = None
+    display_description: str | None = None
+    is_required: bool | None = None
+
+
+class ObservationConfigDropdownPropertyOption(BaseModelResource):
+    id: str | None = None
+    value: str | None = None
+    label: str | None = None
+
+
+class ObservationConfigDropdownProperty(ObservationConfigFieldProperty):
+    options: list[ObservationConfigDropdownPropertyOption] | None = None
+
+
+class ObservationsConfig(BaseModelResource):
+    files: ObservationConfigFieldProperty | None = None
+    description: ObservationConfigFieldProperty | None = None
+    asset: ObservationConfigFieldProperty | None = None
+    troubleshooting: ObservationConfigFieldProperty | None = None
+    type: ObservationConfigDropdownProperty | None = None
+    priority: ObservationConfigDropdownProperty | None = None
+
+
+class RootLocationConfiguration(BaseModelResource):
+    asset_external_id: str | None = None
+    external_id: str | None = None
+    display_name: str | None = None
+    three_d_configuration: ThreeDConfiguration | None = None
+    data_set_external_id: str | None = None
+    template_admins: list[str] | None = None  # list of Group Names
+    checklist_admins: list[str] | None = None  # list of Group Names
+    app_data_instance_space: str | None = None
+    source_data_instance_space: str | None = None
+    data_filters: RootLocationDataFilters | None = None
+    feature_toggles: RootLocationFeatureToggles | None = None
+    observations: ObservationsConfig | None = None
+
+
+class FeatureConfiguration(BaseModelResource):
+    root_location_configurations: list[RootLocationConfiguration] | None = None
+
+
+class InfieldV1YAML(ToolkitResource):
+    external_id: str
+    name: str | None = None
+    app_data_space_id: str | None = None
+    app_data_space_version: str | None = None
+    customer_data_space_id: str | None = None
+    customer_data_space_version: str | None = None
+    feature_configuration: FeatureConfiguration | None = None

cognite_toolkit/_cdf_tk/resource_classes/migration.py

@@ -0,0 +1,28 @@
+from typing import Literal
+
+from pydantic import Field
+
+from cognite_toolkit._cdf_tk.constants import INSTANCE_EXTERNAL_ID_PATTERN
+
+from .base import ToolkitResource
+from .view_field_definitions import ViewReference
+
+
+class ResourceViewMappingYAML(ToolkitResource):
+    external_id: str = Field(
+        description="External-id of the mapping.",
+        min_length=1,
+        max_length=256,
+        pattern=INSTANCE_EXTERNAL_ID_PATTERN,
+    )
+    resource_type: Literal["asset", "event", "file", "timeSeries", "sequence", "assetAnnotation", "fileAnnotation"] = (
+        Field(
+            description="The type of the resource to map to the view.",
+        )
+    )
+    view_id: ViewReference = Field(
+        description="The view to map the resource to.",
+    )
+    property_mapping: dict[str, str] = Field(
+        description="A dictionary mapping from resource property to view property.",
+    )

cognite_toolkit/_cdf_tk/resource_classes/raw_database_table.py

@@ -11,7 +11,7 @@ class DatabaseYAML(ToolkitResource):
     )
 
 
-class TableYAML(ToolkitResource):
+class TableYAML(ToolkitResource, populate_by_name=True):
     db_name: str = Field(
         description="The name of the database.",
         min_length=1,

cognite_toolkit/_cdf_tk/resource_classes/streams.py

@@ -0,0 +1,29 @@
+from typing import Literal
+
+from pydantic import Field
+
+from cognite_toolkit._cdf_tk.constants import StreamTemplateName
+
+from .base import BaseModelResource, ToolkitResource
+
+
+class StreamSettings(BaseModelResource):
+    """Stream settings resource class."""
+
+    template: dict[Literal["name"], StreamTemplateName] = Field(
+        description="Reference to a template which should be used to define initial settings for the stream."
+    )
+
+
+class StreamYAML(ToolkitResource):
+    """Stream YAML resource class."""
+
+    external_id: str = Field(
+        description="The external ID of the stream.",
+        min_length=1,
+        max_length=100,
+        pattern="^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$",
+    )
+    settings: StreamSettings = Field(
+        description="Stream settings which should be applied to a stream.",
+    )

cognite_toolkit/_cdf_tk/resource_classes/view_field_definitions.py

@@ -25,7 +25,7 @@ else:
 KEY_PATTERN = re.compile(CONTAINER_AND_VIEW_PROPERTIES_IDENTIFIER_PATTERN)
 
 
-class ViewReference(BaseModelResource):
+class ViewReference(BaseModelResource, populate_by_name=True):
     type: Literal["view"] = "view"
     space: str = Field(
         description="Id of the space that the view belongs to.",

cognite_toolkit/_cdf_tk/storageio/__init__.py

@@ -1,44 +1,69 @@
-from ._applications import ChartIO
-from ._asset_centric import AssetIO, BaseAssetCentricIO, FileMetadataIO
-from ._base import StorageIO, TableStorageIO
+from cognite_toolkit._cdf_tk.utils._auxiliary import get_concrete_subclasses
+
+from ._annotations import AnnotationIO
+from ._applications import CanvasIO, ChartIO
+from ._asset_centric import (
+    AssetCentricIO,
+    AssetIO,
+    EventIO,
+    FileMetadataIO,
+    HierarchyIO,
+    TimeSeriesIO,
+)
+from ._base import (
+    ConfigurableStorageIO,
+    Page,
+    StorageIO,
+    StorageIOConfig,
+    T_Selector,
+    TableStorageIO,
+    UploadableStorageIO,
+    UploadItem,
+)
 from ._data_classes import InstanceIdCSVList, InstanceIdRow, ModelList
+from ._datapoints import DatapointsIO
+from ._file_content import FileContentIO
 from ._instances import InstanceIO
 from ._raw import RawIO
-from ._selectors import (
-    AllChartSelector,
-    AssetCentricFileSelector,
-    AssetCentricSelector,
-    AssetSubtreeSelector,
-    ChartFileSelector,
-    ChartOwnerSelector,
-    ChartSelector,
-    DataSetSelector,
-    InstanceFileSelector,
-    InstanceSelector,
-    InstanceViewSelector,
-)
+from .selectors._base import DataSelector
+
+# MyPy fails to recognize that get_concrete_subclasses always returns a list of concrete subclasses.
+STORAGE_IO_CLASSES = get_concrete_subclasses(StorageIO)  # type: ignore[type-abstract]
+UPLOAD_IO_CLASSES = get_concrete_subclasses(UploadableStorageIO)  # type: ignore[type-abstract]
+
+
+def get_upload_io(selector: DataSelector) -> type[UploadableStorageIO]:
+    """Get the appropriate UploadableStorageIO class based on the type of the provided selector."""
+    for cls in UPLOAD_IO_CLASSES:
+        if isinstance(selector, cls.BASE_SELECTOR) and selector.kind == cls.KIND:
+            return cls
+    raise ValueError(f"No UploadableStorageIO found for selector of type {type(selector).__name__}")
+
 
 __all__ = [
-    "AllChartSelector",
-    "AssetCentricFileSelector",
-    "AssetCentricSelector",
+    "AnnotationIO",
+    "AssetCentricIO",
     "AssetIO",
-    "AssetSubtreeSelector",
-    "BaseAssetCentricIO",
-    "ChartFileSelector",
+    "CanvasIO",
     "ChartIO",
-    "ChartOwnerSelector",
-    "ChartSelector",
-    "DataSetSelector",
+    "ConfigurableStorageIO",
+    "DatapointsIO",
+    "EventIO",
+    "FileContentIO",
     "FileMetadataIO",
-    "InstanceFileSelector",
+    "HierarchyIO",
     "InstanceIO",
     "InstanceIdCSVList",
     "InstanceIdRow",
-    "InstanceSelector",
-    "InstanceViewSelector",
     "ModelList",
+    "Page",
     "RawIO",
     "StorageIO",
+    "StorageIOConfig",
+    "T_Selector",
     "TableStorageIO",
+    "TimeSeriesIO",
+    "UploadItem",
+    "UploadableStorageIO",
+    "get_upload_io",
 ]