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
- Settings
- Credential Providers
- CogniteClient
CogniteClient
ClientConfig
GlobalConfig
GlobalConfig.default_client_config
GlobalConfig.disable_gzip
GlobalConfig.disable_pypi_version_check
GlobalConfig.status_forcelist
GlobalConfig.max_retries
GlobalConfig.max_retries_connect
GlobalConfig.max_retry_backoff
GlobalConfig.max_connection_pool_size
GlobalConfig.disable_ssl
GlobalConfig.proxies
GlobalConfig.max_workers
GlobalConfig.silence_feature_preview_warnings
GlobalConfig.apply_settings()
- Extensions and optional dependencies
- Identity and access management
- Compare access rights (capabilities)
- Tokens
- Groups
- Security categories
- Sessions
- User Profiles
- Data classes
- Data Modeling
- Data Models
- Spaces
- Views
- Retrieve views by id(s)
- List views
- Apply view
- Delete views
- View data classes
ConnectionDefinition
ConnectionDefinitionApply
EdgeConnection
EdgeConnectionApply
MappedProperty
MappedPropertyApply
MultiEdgeConnection
MultiEdgeConnectionApply
MultiReverseDirectRelation
MultiReverseDirectRelationApply
ReverseDirectRelation
ReverseDirectRelationApply
SingleEdgeConnection
SingleEdgeConnectionApply
SingleHopConnectionDefinition
SingleHopConnectionDefinitionApply
SingleReverseDirectRelation
SingleReverseDirectRelationApply
View
ViewApply
ViewApplyList
ViewCore
ViewFilter
ViewList
ViewProperty
ViewPropertyApply
- Containers
- Retrieve containers by id(s)
- List containers
- Apply containers
- Delete containers
- Delete constraints
- Delete indexes
- Containers data classes
- Instances
- Retrieve instances by id(s)
- Retrieve Nodes by id(s)
- Retrieve Edges by id(s)
- List instances
- Apply instances
- Search instances
- Aggregate instances
- Query instances
- Sync instances
- Delete instances
- Instances core data classes
DataModelingInstancesList
Edge
EdgeApply
EdgeApplyList
EdgeApplyResult
EdgeApplyResultList
EdgeList
EdgeListWithCursor
Instance
InstanceAggregationResult
InstanceAggregationResultList
InstanceApply
InstanceApplyResult
InstanceCore
InstanceSort
InstancesApply
InstancesApplyResult
InstancesDeleteResult
InstancesResult
Node
NodeApply
NodeApplyList
NodeApplyResult
NodeApplyResultList
NodeList
NodeListWithCursor
NodeOrEdgeData
Properties
PropertyOptions
SubscriptionContext
TargetUnit
TypeInformation
TypePropertyDefinition
TypedEdge
TypedEdgeApply
TypedInstance
TypedNode
TypedNodeApply
WritableInstanceCore
- Instances query data classes
- Data Modeling ID data classes
- GraphQL
- Assets
- Retrieve an asset by id
- Retrieve multiple assets by id
- Retrieve an asset subtree
- List assets
- Aggregate assets
- Aggregate Asset Count
- Aggregate Asset Value Cardinality
- Aggregate Asset Property Cardinality
- Aggregate Asset Unique Values
- Aggregate Asset Unique Properties
- Search for assets
- Create assets
- Create asset hierarchy
- Delete assets
- Filter assets
- Update assets
- Upsert assets
- Asset Data classes
- Events
- Retrieve an event by id
- Retrieve multiple events by id
- List events
- Aggregate events
- Aggregate Event Count
- Aggregate Event Values Cardinality
- Aggregate Event Property Cardinality
- Aggregate Event Unique Values
- Aggregate Event Unique Properties
- Search for events
- Create events
- Delete events
- Update events
- Upsert events
- Filter events
- Events 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
- Upload a file content
- Upload a file content in string or bytes
- Upload a file in multiple parts
- Upload a file content in multiple parts
- 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
- Files Data classes
- Time Series
- Metadata
- Retrieve a time series by id
- Retrieve multiple time series by id
- List time series
- Aggregate time series
- Aggregate Time Series Count
- Aggregate Time Series Values Cardinality
- Aggregate Time Series Property Cardinality
- Aggregate Time Series Unique Values
- Aggregate Time Series Unique Properties
- Search for time series
- Create time series
- Delete time series
- Filter time series
- Update time series
- Upsert time series
- Time Series Data classes
- Synthetic time series
- Datapoints
- Retrieve datapoints
- Retrieve datapoints as numpy arrays
- Retrieve datapoints in pandas dataframe
- Retrieve datapoints in time zone in pandas dataframe
- Retrieve latest datapoint
- Insert datapoints
- Insert datapoints into multiple time series
- Insert pandas dataframe
- Delete a range of datapoints
- Delete ranges of datapoints
- Datapoints Data classes
- Datapoint Subscriptions
- Create datapoint subscriptions
- Retrieve a datapoint subscription by id(s)
- List datapoint subscriptions
- List member time series of subscription
- Iterate over subscriptions data
- Update datapoint subscription
- Delete datapoint subscription
- Datapoint Subscription classes
DataDeletion
DataPointSubscriptionCreate
DataPointSubscriptionUpdate
DataPointSubscriptionWrite
DatapointSubscription
DatapointSubscriptionBatch
DatapointSubscriptionCore
DatapointSubscriptionFilterProperties
DatapointSubscriptionList
DatapointSubscriptionPartition
DatapointSubscriptionProperty
DatapointSubscriptionWriteList
DatapointsUpdate
SubscriptionTimeSeriesUpdate
TimeSeriesID
TimeSeriesIDList
- Metadata
- Sequences
- Metadata
- Retrieve a sequence by id
- Retrieve multiple sequences by id
- List sequences
- Aggregate sequences
- Aggregate Sequences Count
- Aggregate Sequences Value Cardinality
- Aggregate Sequences Property Cardinality
- Aggregate Sequences Unique Values
- Aggregate Sequences Unique Properties
- Search for sequences
- Create a sequence
- Delete sequences
- Filter sequences
- Update sequences
- Upsert sequences
- Rows
- Retrieve rows
- Retrieve rows in a pandas dataframe
- Retrieve last row
- 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
- Sequence Data classes
SequenceColumn
SequenceColumnCore
SequenceColumnList
SequenceColumnUpdate
SequenceColumnWrite
SequenceColumnWriteList
SequenceCore
SequenceData
SequenceDataList
SequenceFilter
SequenceList
SequenceProperty
SequenceRow
SequenceRows
SequenceRowsList
SequenceUpdate
SequenceWrite
SequenceWriteList
SortableSequenceProperty
- Metadata
- Geospatial
- Feature types
- Features
- Reference systems
- Raster data
- Geospatial Data classes
CoordinateReferenceSystem
CoordinateReferenceSystemCore
CoordinateReferenceSystemList
CoordinateReferenceSystemWrite
CoordinateReferenceSystemWriteList
Feature
FeatureAggregate
FeatureAggregateList
FeatureCore
FeatureList
FeatureListCore
FeatureType
FeatureTypeCore
FeatureTypeList
FeatureTypePatch
FeatureTypeWrite
FeatureTypeWriteList
FeatureWrite
FeatureWriteList
GeospatialComputeFunction
GeospatialComputedItem
GeospatialComputedItemList
GeospatialComputedResponse
GeospatialGeometryComputeFunction
GeospatialGeometryTransformComputeFunction
GeospatialGeometryValueComputeFunction
OrderSpec
Patches
PropertyAndSearchSpec
RasterMetadata
nan_to_none()
- 3D
- Models
- Revisions
- Files
- Asset mappings
- Data classes
BoundingBox3D
RevisionCameraProperties
ThreeDAssetMapping
ThreeDAssetMappingCore
ThreeDAssetMappingList
ThreeDAssetMappingWrite
ThreeDAssetMappingWriteList
ThreeDModel
ThreeDModelCore
ThreeDModelList
ThreeDModelRevision
ThreeDModelRevisionCore
ThreeDModelRevisionList
ThreeDModelRevisionUpdate
ThreeDModelRevisionWrite
ThreeDModelRevisionWriteList
ThreeDModelUpdate
ThreeDModelWrite
ThreeDModelWriteList
ThreeDNode
ThreeDNodeList
- Contextualization
- Entity Matching
- Engineering Diagrams
- Vision
- Contextualization Data Classes
AssetTagDetectionParameters
ConnectionFlags
ContextualizationJob
ContextualizationJobList
ContextualizationJobList.append()
ContextualizationJobList.clear()
ContextualizationJobList.copy()
ContextualizationJobList.count()
ContextualizationJobList.dump()
ContextualizationJobList.dump_raw()
ContextualizationJobList.dump_yaml()
ContextualizationJobList.extend()
ContextualizationJobList.get()
ContextualizationJobList.index()
ContextualizationJobList.insert()
ContextualizationJobList.load()
ContextualizationJobList.pop()
ContextualizationJobList.remove()
ContextualizationJobList.reverse()
ContextualizationJobList.sort()
ContextualizationJobList.to_pandas()
ContextualizationJobType
CustomizeFuzziness
DetectJobBundle
DiagramConvertItem
DiagramConvertPage
DiagramConvertPageList
DiagramConvertPageList.append()
DiagramConvertPageList.clear()
DiagramConvertPageList.copy()
DiagramConvertPageList.count()
DiagramConvertPageList.dump()
DiagramConvertPageList.dump_raw()
DiagramConvertPageList.dump_yaml()
DiagramConvertPageList.extend()
DiagramConvertPageList.get()
DiagramConvertPageList.index()
DiagramConvertPageList.insert()
DiagramConvertPageList.load()
DiagramConvertPageList.pop()
DiagramConvertPageList.remove()
DiagramConvertPageList.reverse()
DiagramConvertPageList.sort()
DiagramConvertPageList.to_pandas()
DiagramConvertResults
DiagramDetectConfig
DiagramDetectItem
DiagramDetectResults
DiagramDetectResults.convert()
DiagramDetectResults.dump()
DiagramDetectResults.dump_yaml()
DiagramDetectResults.errors
DiagramDetectResults.items
DiagramDetectResults.load()
DiagramDetectResults.result
DiagramDetectResults.to_pandas()
DiagramDetectResults.update_status()
DiagramDetectResults.wait_for_completion()
DialGaugeDetection
DigitalGaugeDetection
DirectionWeights
EntityMatchingModel
EntityMatchingModelList
EntityMatchingModelList.append()
EntityMatchingModelList.clear()
EntityMatchingModelList.copy()
EntityMatchingModelList.count()
EntityMatchingModelList.dump()
EntityMatchingModelList.dump_raw()
EntityMatchingModelList.dump_yaml()
EntityMatchingModelList.extend()
EntityMatchingModelList.get()
EntityMatchingModelList.index()
EntityMatchingModelList.insert()
EntityMatchingModelList.load()
EntityMatchingModelList.pop()
EntityMatchingModelList.remove()
EntityMatchingModelList.reverse()
EntityMatchingModelList.sort()
EntityMatchingModelList.to_pandas()
EntityMatchingModelUpdate
FeatureParameters
FeatureParameters.asset_tag_detection_parameters
FeatureParameters.dial_gauge_detection_parameters
FeatureParameters.digital_gauge_detection_parameters
FeatureParameters.dump()
FeatureParameters.dump_yaml()
FeatureParameters.industrial_object_detection_parameters
FeatureParameters.level_gauge_detection_parameters
FeatureParameters.load()
FeatureParameters.people_detection_parameters
FeatureParameters.personal_protective_equipment_detection_parameters
FeatureParameters.text_detection_parameters
FeatureParameters.to_pandas()
FeatureParameters.valve_detection_parameters
FileReference
IndustrialObjectDetectionParameters
JobStatus
LevelGaugeDetection
PeopleDetectionParameters
PersonalProtectiveEquipmentDetectionParameters
ResourceReference
ResourceReferenceList
ResourceReferenceList.append()
ResourceReferenceList.clear()
ResourceReferenceList.copy()
ResourceReferenceList.count()
ResourceReferenceList.dump()
ResourceReferenceList.dump_raw()
ResourceReferenceList.dump_yaml()
ResourceReferenceList.extend()
ResourceReferenceList.get()
ResourceReferenceList.index()
ResourceReferenceList.insert()
ResourceReferenceList.load()
ResourceReferenceList.pop()
ResourceReferenceList.remove()
ResourceReferenceList.reverse()
ResourceReferenceList.sort()
ResourceReferenceList.to_pandas()
TextDetectionParameters
ThresholdParameter
ValveDetection
VisionExtractItem
VisionExtractJob
VisionExtractPredictions
VisionExtractPredictions.asset_tag_predictions
VisionExtractPredictions.dial_gauge_predictions
VisionExtractPredictions.digital_gauge_predictions
VisionExtractPredictions.dump()
VisionExtractPredictions.dump_yaml()
VisionExtractPredictions.industrial_object_predictions
VisionExtractPredictions.level_gauge_predictions
VisionExtractPredictions.load()
VisionExtractPredictions.people_predictions
VisionExtractPredictions.personal_protective_equipment_predictions
VisionExtractPredictions.text_predictions
VisionExtractPredictions.to_pandas()
VisionExtractPredictions.valve_predictions
VisionFeature
VisionFeature.ASSET_TAG_DETECTION
VisionFeature.DIAL_GAUGE_DETECTION
VisionFeature.DIGITAL_GAUGE_DETECTION
VisionFeature.INDUSTRIAL_OBJECT_DETECTION
VisionFeature.LEVEL_GAUGE_DETECTION
VisionFeature.PEOPLE_DETECTION
VisionFeature.PERSONAL_PROTECTIVE_EQUIPMENT_DETECTION
VisionFeature.TEXT_DETECTION
VisionFeature.VALVE_DETECTION
VisionFeature.beta_features()
VisionJob
AssetLink
KeypointCollection
KeypointCollectionWithObjectDetection
KeypointCollectionWithObjectDetection.dump()
KeypointCollectionWithObjectDetection.dump_yaml()
KeypointCollectionWithObjectDetection.keypoint_collection
KeypointCollectionWithObjectDetection.load()
KeypointCollectionWithObjectDetection.object_detection
KeypointCollectionWithObjectDetection.to_pandas()
ObjectDetection
TextRegion
Attribute
BoundingBox
CdfResourceRef
Keypoint
Point
Polygon
Polyline
VisionResource
- Documents
- Documents API
- Aggregate Document Count
- Aggregate Document Value Cardinality
- Aggregate Document Property Cardinality
- Aggregate Document Unique Values
- Aggregate Document Unique Properties
- List Documents
- Retrieve Document Content
- Retrieve Document Content Buffer
- Search Documents
- Documents classes
- Preview
- Documents API
- Data Ingestion
- Raw
- Extraction pipelines
- Extraction pipeline runs
- Extraction pipeline configs
- Get the latest or a specific config revision
- List configuration revisions
- Create a config revision
- Revert to an earlier config revision
- Extractor Config Data classes
ExtractionPipeline
ExtractionPipelineConfig
ExtractionPipelineConfigCore
ExtractionPipelineConfigList
ExtractionPipelineConfigRevision
ExtractionPipelineConfigRevisionList
ExtractionPipelineConfigWrite
ExtractionPipelineConfigWriteList
ExtractionPipelineContact
ExtractionPipelineCore
ExtractionPipelineList
ExtractionPipelineRun
ExtractionPipelineRunCore
ExtractionPipelineRunFilter
ExtractionPipelineRunList
ExtractionPipelineRunWrite
ExtractionPipelineRunWriteList
ExtractionPipelineUpdate
ExtractionPipelineWrite
ExtractionPipelineWriteList
StringFilter
- Hosted Extractors
- Postgres Gateway
- Data Organization
- Annotations
- Data sets
- Labels
- Relationships
- Transformations
- TransformationsAPI
- Transformation Schedules
- Transformation Notifications
- Transformation Jobs
- Transformation Schema
- Data classes
ContainsAny
SessionDetails
Transformation
TransformationCore
TransformationFilter
TransformationList
TransformationPreviewResult
TransformationUpdate
TransformationWrite
TransformationWriteList
TransformationSchedule
TransformationScheduleCore
TransformationScheduleList
TransformationScheduleUpdate
TransformationScheduleWrite
TransformationScheduleWriteList
TransformationNotification
TransformationNotificationCore
TransformationNotificationFilter
TransformationNotificationList
TransformationNotificationWrite
TransformationNotificationWriteList
TransformationJob
TransformationJobFilter
TransformationJobList
TransformationJobMetric
TransformationJobMetricList
TransformationJobStatus
TransformationSchemaArrayType
TransformationSchemaColumn
TransformationSchemaColumnList
TransformationSchemaMapType
TransformationSchemaStructType
TransformationSchemaType
TransformationSchemaUnknownType
DataModelInfo
EdgeType
Edges
Instances
Nodes
OidcCredentials
RawTable
SequenceRowsDestination
TransformationBlockedInfo
TransformationDestination
TransformationDestination.asset_hierarchy()
TransformationDestination.assets()
TransformationDestination.data_sets()
TransformationDestination.datapoints()
TransformationDestination.dump()
TransformationDestination.edges()
TransformationDestination.events()
TransformationDestination.files()
TransformationDestination.instances()
TransformationDestination.labels()
TransformationDestination.nodes()
TransformationDestination.raw()
TransformationDestination.relationships()
TransformationDestination.sequence_rows()
TransformationDestination.sequences()
TransformationDestination.string_datapoints()
TransformationDestination.timeseries()
ViewInfo
- Functions
- Functions API
- Function calls
- Function schedules
- Retrieve function schedule
- List function schedules
- Create function schedule
- Delete function schedule
- Get function schedule input data
- Data classes
Function
FunctionCall
FunctionCallList
FunctionCallLog
FunctionCallLogEntry
FunctionCallsFilter
FunctionCore
FunctionFilter
FunctionList
FunctionSchedule
FunctionScheduleCore
FunctionScheduleWrite
FunctionScheduleWriteList
FunctionSchedulesFilter
FunctionSchedulesList
FunctionWrite
FunctionWriteList
FunctionsLimits
FunctionsStatus
- Data Workflows
- Workflows
- Workflow Versions
- Workflow Executions
- Workflow Tasks
- Workflow Triggers
- Create or update triggers for workflow executions
- Create triggers for workflow executions
- Delete triggers for workflow executions
- Get triggers for workflow executions
- Get trigger run history for a workflow trigger
- Data Workflows data classes
CDFTaskOutput
CDFTaskParameters
DynamicTaskOutput
DynamicTaskParameters
FunctionTaskOutput
FunctionTaskParameters
SubworkflowReferenceParameters
SubworkflowTaskOutput
SubworkflowTaskParameters
TransformationTaskOutput
TransformationTaskParameters
Workflow
WorkflowCore
WorkflowDefinition
WorkflowDefinitionCore
WorkflowDefinitionUpsert
WorkflowExecution
WorkflowExecutionDetailed
WorkflowExecutionList
WorkflowIds
WorkflowList
WorkflowScheduledTriggerRule
WorkflowTask
WorkflowTaskExecution
WorkflowTaskOutput
WorkflowTaskParameters
WorkflowTrigger
WorkflowTriggerCore
WorkflowTriggerCreate
WorkflowTriggerList
WorkflowTriggerRule
WorkflowTriggerRun
WorkflowTriggerRunList
WorkflowTriggerUpsert
WorkflowTriggerUpsertList
WorkflowUpsert
WorkflowUpsertList
WorkflowVersion
WorkflowVersionCore
WorkflowVersionId
WorkflowVersionList
WorkflowVersionUpsert
WorkflowVersionUpsertList
- Unit Catalog
- Filters
- Deprecated
- 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
- Update Template instances
- Retrieve Template instances
- List Template instances
- Delete Template instances
- Create Template Views
- Upsert Template Views
- List Template Views
- Resolve Template View
- Delete Template Views
- Templates
- Base data classes
- Exceptions
- Utils
- Testing
- Upsert
- Update and Upsert Mode Parameter
- Alpha and Beta Features