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
To install this package without the pandas and NumPy support:
pip install cognite-sdk-core
To install with pandas, geopandas and shapely support (equivalent to installing cognite-sdk). However, this gives you the option to only have pandas (and NumPy) support without geopandas.
pip install cognite-sdk-core[pandas, geo]
Contents¶
- Quickstart
- Settings
- Extensions and core library
- API
- CogniteClient
- Authentication
- Assets
- Labels
- Events
- Data sets
- 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
- Time series
- Synthetic 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
- Relationships
- 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
- 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
- Identity and access management
- Extraction pipelines
- Transformations
- Base data classes
- Exceptions
- Utils
- Testing
- Experimental features