Cognite Python SDK Documentation

This is the Cognite Python SDK for developers and data scientists working with Cognite Data Fusion (CDF). The package is tightly integrated with pandas, and helps you work easily and efficiently with data in Cognite Data Fusion (CDF).

Installation

To install this package:

pip install cognite-sdk

To upgrade the version of this package:

pip install cognite-sdk --upgrade

pip install cognite-sdk[pandas, geo]

Contents

• Quickstart
  • Authenticate
  • Instantiate a new client
  • Discover time series
  • Plot time series
  • Create an asset hierarchy
  • Retrieve all events related to an asset subtree
• Settings
  • Client configuration
  • Environment configuration
  • Concurrency and connection pooling
• Extensions and optional dependencies
  • Pandas integration
  • Matplotlib integration
  • How to install extra dependencies
• API
  • CogniteClient
  • Authentication
    • Get login status
    • Data classes
  • Assets
    • Retrieve an asset by id
    • Retrieve multiple assets by id
    • Retrieve an asset subtree
    • List assets
    • Aggregate assets
    • Search for assets
    • Create assets
    • Create asset hierarchy
    • Delete assets
    • Update assets
    • Data classes
  • Labels
    • List labels
    • Create a label
    • Delete labels
    • Data classes
  • Events
    • Retrieve an event by id
    • Retrieve multiple events by id
    • List events
    • Aggregate events
    • Search for events
    • Create events
    • Delete events
    • Update events
    • Data classes
  • Data sets
    • Retrieve an data set by id
    • Retrieve multiple data sets by id
    • List data sets
    • Aggregate data sets
    • Create data sets
    • Delete data sets
    • Update data sets
    • Data classes
  • Files
    • Retrieve file metadata by id
    • Retrieve multiple files’ metadata by id
    • List files metadata
    • Aggregate files metadata
    • Search for files
    • Create file metadata
    • Upload a file or directory
    • Upload a string or bytes
    • Retrieve download urls
    • Download files to disk
    • Download a single file to a specific path
    • Download a file as bytes
    • Delete files
    • Update files metadata
    • Data classes
  • Functions
    • Create function
    • Delete function
    • List functions
    • Retrieve function
    • Retrieve multiple functions
    • Call function
    • Function calls
      • List function calls
      • Retrieve function call
      • Retrieve function call response
      • Retrieve function call logs
    • Function schedules
      • List function schedules
      • Create function schedule
      • Delete function schedule
    • Data classes
  • Time series
    • Retrieve a time series by id
    • Retrieve multiple time series by id
    • List time series
    • Aggregate time series
    • Search for time series
    • Create time series
    • Delete time series
    • Update time series
    • Data classes
  • Synthetic time series
    • Calculate the result of a function on time series
  • Data points
    • Retrieve datapoints
    • Retrieve pandas dataframe
    • Retrieve pandas dataframes indexed by aggregate
    • Perform data points queries
    • Retrieve latest datapoint
    • Insert data points
    • Insert data points into multiple time series
    • Insert pandas dataframe
    • Delete a range of data points
    • Delete ranges of data points
    • Data classes
  • Sequences
    • Retrieve a sequence by id
    • Retrieve multiple sequences by id
    • List sequences
    • Aggregate sequences
    • Search for sequences
    • Create a sequence
    • Delete sequences
    • Update sequences
    • Retrieve data
    • Retrieve pandas dataframe
    • Insert rows into a sequence
    • Insert a pandas dataframe into a sequence
    • Delete rows from a sequence
    • Delete a range of rows from a sequence
    • Data classes
  • Raw
    • Databases
      • List databases
      • Create new databases
      • Delete databases
    • Tables
      • List tables in a database
      • Create new tables in a database
      • Delete tables from a database
    • Rows
      • Get a row from a table
      • List rows in a table
      • Insert rows into a table
      • Delete rows from a table
      • Retrieve pandas dataframe
      • Insert pandas dataframe
    • Data classes
  • Relationships
    • Retrieve a relationship by id
    • Retrieve multiple relationships by id
    • List relationships
    • Create a relationship
    • Update relationships
    • Delete relationships
    • Data classes
  • Geospatial
    • Create feature types
    • Delete feature types
    • List feature types
    • Retrieve feature types
    • Update feature types
    • Create features
    • Delete features
    • Retrieve features
    • Update features
    • Search features
    • Stream features
    • Aggregate features
    • Get coordinate reference systems
    • List coordinate reference systems
    • Create coordinate reference systems
    • Data classes
  • 3D
    • Models
      • Retrieve a model by ID
      • List models
      • Create models
      • Update models
      • Delete models
    • Revisions
      • Retrieve a revision by ID
      • Create a revision
      • List revisions
      • Update revisions
      • Delete revisions
      • Update a revision thumbnail
      • List nodes
      • Filter nodes
      • List ancestor nodes
    • Files
      • Retrieve a 3D file
    • Asset mappings
      • Create an asset mapping
      • List asset mappings
      • Delete asset mappings
    • Data classes
  • Contextualization
    • Fit Entity Matching Model
    • Re-fit Entity Matching Model
    • Retrieve Entity Matching Models
    • Delete Entity Matching Models
    • Update Entity Matching Models
    • Predict Using an Entity Matching Model
    • Detect entities in Engineering Diagrams
    • Convert to an interactive SVG where the provided annotations are highlighted
    • Contextualization Data Classes
  • Templates
    • Create Template groups
    • Upsert Template groups
    • Retrieve Template groups
    • List Template groups
    • Delete Template groups
    • Upsert a Template group version
    • List Temple Group versions
    • Delete a Temple Group version
    • Run a GraphQL query
    • Create Template instances
    • Upsert Template instances
    • Retrieve Template instances
    • List Template instances
    • Delete Template instances
    • Create Views
    • Upsert Views
    • List Views
    • Resolve View
    • Delete Views
    • Data classes
  • Annotations
    • Retrieve an annotation by id
    • Retrieve multiple annotations by id
    • List annotation
    • Create an annotation
    • Suggest an annotation
    • Update annotations
    • Delete annotations
    • Data classes
  • Identity and access management
    • Tokens
      • Inspect the token currently used by the client
    • Service accounts
      • List service accounts
      • Create service accounts
      • Delete service accounts
    • API keys
      • List API keys
      • Create API keys
      • Delete API keys
    • Groups
      • List groups
      • Create groups
      • Delete groups
      • List service accounts in a group
      • Add service accounts to a group
      • Remove service accounts from a group
    • Security categories
      • List security categories
      • Create security categories
      • Delete security categories
    • Sessions
      • List sessions
      • Create a session
      • Revoke a session
    • Data classes
  • Extraction pipelines
    • List extraction pipelines
    • Create extraction pipeline
    • Retrieve an extraction pipeline by ID
    • Retrieve multiple extraction pipelines by ID
    • Update extraction pipelines
    • Delete extraction pipelines
    • Extraction pipeline runs
      • List runs for an extraction pipeline
      • Report new runs
    • Data classes
  • Transformations
    • Create transformations
    • Retrieve transformations by id
    • Run transformations by id
    • Preview transformations
    • Cancel transformation run by id
    • List transformations
    • Update transformations
    • Delete transformations
    • Transformation Schedules
      • Create transformation Schedules
      • Retrieve transformation schedules
      • Retrieve multiple transformation schedules
      • List transformation schedules
      • Update transformation schedules
      • Delete transformation schedules
    • Transformation Notifications
      • Create transformation notifications
      • List transformation notifications
      • Delete transformation notifications
    • Transformation Jobs
      • Retrieve transformation jobs
      • List transformation jobs
    • Transformation Schema
      • Get transformation schema
    • Data classes
  • Base data classes
    • CogniteResource
    • CogniteResourceList
    • CogniteResponse
    • CogniteFilter
    • CogniteUpdate
  • Exceptions
    • CogniteAPIError
    • CogniteNotFoundError
    • CogniteDuplicatedError
    • CogniteAPIKeyError
    • CogniteImportError
    • CogniteMissingClientError
    • CogniteDuplicateColumnsError
  • Utils
    • Convert timestamp to milliseconds since epoch
    • Convert milliseconds since epoch to datetime
  • Testing
    • Object to use as a mock for CogniteClient
    • Use a context manager to monkeypatch CogniteClient

Examples

For a collection of scripts and Jupyter Notebooks that explain how to perform various tasks in Cognite Data Fusion (CDF) using Python, see the GitHub repository here.