cognite-toolkit 0.5.44__py3-none-any.whl → 0.7.34__py3-none-any.whl

cognite_toolkit/_cdf_tk/resource_classes/__init__.py

@@ -7,42 +7,105 @@ This is means that we have three set of resource classes we use in Toolkit:
 3. Read resource classes (from cognite-sdk): Represent the read/response format the Cognite resources.
 """
 
+from .agent import AgentYAML
 from .asset import AssetYAML
 from .base import BaseModelResource, ToolkitResource
+from .cognitefile import CogniteFileYAML
+from .containers import ContainerYAML
+from .data_model import DataModelYAML
+from .datapoint_subscription import DatapointSubscriptionYAML
 from .dataset import DataSetYAML
 from .event import EventYAML
+from .extraction_pipeline import ExtractionPipelineYAML
+from .extraction_pipeline_config import ExtractionPipelineConfigYAML
 from .filemetadata import FileMetadataYAML
 from .function_schedule import FunctionScheduleYAML
 from .functions import FunctionsYAML
+from .graphql_model import GraphQLDataModelYAML
 from .groups import GroupYAML
+from .hosted_extractor_destination import HostedExtractorDestinationYAML
+from .hosted_extractor_job import HostedExtractorJobYAML
+from .hosted_extractor_mapping import HostedExtractorMappingYAML
+from .hosted_extractor_source import HostedExtractorSourceYAML
+from .infield_cdm_location_config import InFieldCDMLocationConfigYAML
+from .infield_location_config import InfieldLocationConfigYAML
+from .infield_v1 import InfieldV1YAML
+from .instance import EdgeYAML, NodeYAML
 from .labels import LabelsYAML
 from .location import LocationYAML
+from .migration import ResourceViewMappingYAML
 from .raw_database_table import DatabaseYAML, TableYAML
+from .relationship import RelationshipYAML
+from .robotics import RobotCapabilityYAML, RobotDataPostProcessingYAML, RobotFrameYAML, RobotLocationYAML, RobotMapYAML
+from .search_config import SearchConfigYAML
 from .securitycategories import SecurityCategoriesYAML
+from .sequence import SequenceRowYAML, SequenceYAML
 from .space import SpaceYAML
+from .streamlit_ import StreamlitYAML
+from .streams import StreamYAML
 from .threedmodels import ThreeDModelYAML
 from .timeseries import TimeSeriesYAML
+from .transformation_notification import TransformationNotificationYAML
 from .transformation_schedule import TransformationScheduleYAML
 from .transformations import TransformationYAML
+from .views import ViewYAML
+from .workflow import WorkflowYAML
+from .workflow_trigger import WorkflowTriggerYAML
+from .workflow_version import WorkflowVersionYAML
 
 __all__ = [
+    "AgentYAML",
     "AssetYAML",
     "BaseModelResource",
+    "CogniteFileYAML",
+    "ContainerYAML",
+    "DataModelYAML",
+    "DataModelYAML",
     "DataSetYAML",
     "DatabaseYAML",
+    "DatapointSubscriptionYAML",
+    "EdgeYAML",
     "EventYAML",
+    "ExtractionPipelineConfigYAML",
+    "ExtractionPipelineYAML",
     "FileMetadataYAML",
     "FunctionScheduleYAML",
     "FunctionsYAML",
+    "GraphQLDataModelYAML",
     "GroupYAML",
+    "HostedExtractorDestinationYAML",
+    "HostedExtractorJobYAML",
+    "HostedExtractorMappingYAML",
+    "HostedExtractorSourceYAML",
+    "InFieldCDMLocationConfigYAML",
+    "InfieldLocationConfigYAML",
+    "InfieldV1YAML",
     "LabelsYAML",
     "LocationYAML",
+    "NodeYAML",
+    "RelationshipYAML",
+    "ResourceViewMappingYAML",
+    "RobotCapabilityYAML",
+    "RobotDataPostProcessingYAML",
+    "RobotFrameYAML",
+    "RobotLocationYAML",
+    "RobotMapYAML",
+    "SearchConfigYAML",
     "SecurityCategoriesYAML",
+    "SequenceRowYAML",
+    "SequenceYAML",
     "SpaceYAML",
+    "StreamYAML",
+    "StreamlitYAML",
     "TableYAML",
     "ThreeDModelYAML",
     "TimeSeriesYAML",
     "ToolkitResource",
+    "TransformationNotificationYAML",
     "TransformationScheduleYAML",
     "TransformationYAML",
+    "ViewYAML",
+    "WorkflowTriggerYAML",
+    "WorkflowVersionYAML",
+    "WorkflowYAML",
 ]

cognite_toolkit/_cdf_tk/resource_classes/agent.py

@@ -0,0 +1,58 @@
+from typing import Literal
+
+from pydantic import Field
+
+from .agent_tools import AgentTool
+from .base import ToolkitResource
+
+Model = Literal[
+    "azure/o3",
+    "azure/o4-mini",
+    "azure/gpt-4o",
+    "azure/gpt-4o-mini",
+    "azure/gpt-4.1",
+    "azure/gpt-4.1-nano",
+    "azure/gpt-4.1-mini",
+    "azure/gpt-5",
+    "azure/gpt-5-mini",
+    "azure/gpt-5-nano",
+    "gcp/gemini-2.5-pro",
+    "gcp/gemini-2.5-flash",
+    "aws/claude-4-sonnet",
+    "aws/claude-4-opus",
+    "aws/claude-4.1-opus",
+    "aws/claude-3.5-sonnet",
+]
+
+
+class AgentYAML(ToolkitResource):
+    """Atlas AI Agent"""
+
+    external_id: str = Field(
+        description="An external ID that uniquely identifies the agent.",
+        min_length=1,
+        max_length=128,
+        pattern=r"^[^\x00]{1,128}$",
+    )
+    name: str = Field(
+        description="A descriptive name intended for use in user interfaces.",
+        min_length=1,
+        max_length=255,
+    )
+    description: str | None = Field(
+        default=None,
+        description="A human-readable description of what the agent does, used for documentation only. "
+        "This description is not used by the language model.",
+        max_length=1024,
+    )
+    instructions: str | None = Field(
+        default=None,
+        description="The instructions for the agent prompt the language model to understand "
+        "the agent's goals and how to achieve them.",
+        max_length=32000,
+    )
+    model: Model = Field(
+        "azure/gpt-4o-mini", description="The name of the model to use. Defaults to your CDF project's default model."
+    )
+    tools: list[AgentTool] | None = Field(None, description="A list of tools available to the agent.", max_length=20)
+    runtime_version: str | None = Field(None, description="The runtime version")

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/authentication.py

@@ -0,0 +1,15 @@
+from pydantic import Field, SecretStr
+
+from .base import BaseModelResource
+
+
+class AuthenticationClientIdSecret(BaseModelResource):
+    client_id: str = Field(description="Client Id.")
+    client_secret: SecretStr = Field(description="Client Secret.")
+
+
+class OIDCCredential(AuthenticationClientIdSecret):
+    scopes: str | list[str] | None = Field(default=None, description="Scopes for the authentication.")
+    token_uri: str = Field(description="OAuth token url.")
+    cdf_project_name: str = Field(description="CDF project name.")
+    audience: str | None = Field(default=None, description="Audience for the authentication.")

cognite_toolkit/_cdf_tk/resource_classes/capabilities.py

@@ -48,6 +48,11 @@ class AllScope(Scope):
     _scope_name = "all"
 
 
+class AppConfigScope(Scope):
+    _scope_name = "appScope"
+    apps: list[Literal["SEARCH"]]
+
+
 class CurrentUserScope(Scope):
     _scope_name = "currentuserscope"
 
@@ -86,7 +91,7 @@ class DataSetScope(Scope):
 
 class TableScope(Scope):
     _scope_name = "tableScope"
-    dbs_to_tables: dict[str, list[str] | dict[Literal["tables"], list[str]]]
+    dbs_to_tables: dict[str, list[str]]
 
 
 class AssetRootIDScope(Scope):
@@ -163,6 +168,12 @@ class Capability(BaseModelResource):
         return {self._capability_name: serialized_data}
 
 
+class AgentsAcl(Capability):
+    _capability_name = "agentsAcl"
+    actions: list[Literal["READ", "WRITE", "RUN"]]
+    scope: AllScope
+
+
 class AnalyticsAcl(Capability):
     _capability_name = "analyticsAcl"
     actions: list[Literal["READ", "EXECUTE", "LIST"]]
@@ -175,6 +186,12 @@ class AnnotationsAcl(Capability):
     scope: AllScope
 
 
+class AppConfigAcl(Capability):
+    _capability_name = "appConfigAcl"
+    actions: list[Literal["READ", "WRITE"]]
+    scope: AllScope | AppConfigScope
+
+
 class AssetsAcl(Capability):
     _capability_name = "assetsAcl"
     actions: list[Literal["READ", "WRITE"]]
@@ -493,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/cognitefile.py

@@ -0,0 +1,51 @@
+from datetime import datetime
+
+from pydantic import Field, JsonValue
+
+from cognite_toolkit._cdf_tk.constants import (
+    INSTANCE_EXTERNAL_ID_PATTERN,
+    SPACE_FORMAT_PATTERN,
+)
+
+from .base import ToolkitResource
+from .view_field_definitions import DirectRelationReference, ViewReference
+
+
+class CogniteFileYAML(ToolkitResource):
+    space: str = Field(description="The space where the file is located.", max_length=43, pattern=SPACE_FORMAT_PATTERN)
+    external_id: str = Field(
+        description="External-id of the file.", max_length=255, pattern=INSTANCE_EXTERNAL_ID_PATTERN
+    )
+    name: str | None = Field(default=None, description="name of the file.")
+    description: str | None = Field(default=None, description="Description of the file.")
+    tags: list[str] | None = Field(default=None, description="Text based labels for generic use.", max_length=1000)
+    aliases: list[str] | None = Field(default=None, description="Alternative names for the file.")
+    source_id: str | None = Field(default=None, description="Identifier from the source system.")
+    source_context: str | None = Field(default=None, description="Context of the source system.")
+    source: DirectRelationReference | None = Field(default=None, description="Direct relation to the source system.")
+    source_created_time: datetime | None = Field(
+        default=None, description="When the file was created in the source system."
+    )
+    source_updated_time: datetime | None = Field(
+        default=None, description="When the file was last updated in the source system."
+    )
+    source_created_user: str | None = Field(
+        default=None, description="User identifier from the source system who created the file."
+    )
+    source_updated_user: str | None = Field(
+        default=None, description="User identifier from the source system who last updated the file."
+    )
+    assets: list[DirectRelationReference] | None = Field(
+        default=None, description="A list of assets this file is related to."
+    )
+    mime_type: str | None = Field(default=None, description="MIME type of the file.")
+    directory: str | None = Field(default=None, description="Directory path for the file.")
+    category: DirectRelationReference | None = Field(
+        default=None, description="Direct relation to the category of the file."
+    )
+    existing_version: int | None = Field(default=None, description="Existing version of the file.")
+    type: DirectRelationReference | None = Field(default=None, description="Direct relation to the type of the file.")
+    node_source: ViewReference | None = Field(default=None, description="The source view for this file.")
+    extra_properties: dict[str, JsonValue] | None = Field(
+        default=None, description="Additional custom properties for the file."
+    )