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
CogniteClientClientConfigGlobalConfigGlobalConfig.default_client_configGlobalConfig.disable_gzipGlobalConfig.disable_pypi_version_checkGlobalConfig.status_forcelistGlobalConfig.max_retriesGlobalConfig.max_retries_connectGlobalConfig.max_retry_backoffGlobalConfig.max_connection_pool_sizeGlobalConfig.disable_sslGlobalConfig.proxiesGlobalConfig.max_workersGlobalConfig.silence_feature_preview_warningsGlobalConfig.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
ConnectionDefinitionConnectionDefinitionApplyEdgeConnectionEdgeConnectionApplyMappedPropertyMappedPropertyApplyMultiEdgeConnectionMultiEdgeConnectionApplyMultiReverseDirectRelationMultiReverseDirectRelationApplyReverseDirectRelationReverseDirectRelationApplySingleEdgeConnectionSingleEdgeConnectionApplySingleHopConnectionDefinitionSingleHopConnectionDefinitionApplySingleReverseDirectRelationSingleReverseDirectRelationApplyViewViewApplyViewApplyListViewCoreViewFilterViewListViewPropertyViewPropertyApply
- 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
- Inspect instances
- Sync instances
- Delete instances
- Instances core data classes
DataModelingInstancesListEdgeEdgeApplyEdgeApplyListEdgeApplyResultEdgeApplyResultListEdgeListEdgeListWithCursorInspectOperationInspectionResultsInstanceInstanceAggregationResultInstanceAggregationResultListInstanceApplyInstanceApplyResultInstanceCoreInstanceInspectResultInstanceInspectResultListInstanceInspectResultsInstanceSortInstancesApplyInstancesApplyResultInstancesDeleteResultInstancesResultInvolvedContainersInvolvedViewsNodeNodeApplyNodeApplyListNodeApplyResultNodeApplyResultListNodeListNodeListWithCursorNodeOrEdgeDataPropertiesPropertyOptionsSubscriptionContextTargetUnitTypeInformationTypePropertyDefinitionTypedEdgeTypedEdgeApplyTypedInstanceTypedNodeTypedNodeApplyWritableInstanceCore
- 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
- Iterate through datapoints in chunks
- 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
DataDeletionDataPointSubscriptionCreateDataPointSubscriptionUpdateDataPointSubscriptionWriteDatapointSubscriptionDatapointSubscriptionBatchDatapointSubscriptionCoreDatapointSubscriptionFilterPropertiesDatapointSubscriptionListDatapointSubscriptionPartitionDatapointSubscriptionPropertyDatapointSubscriptionWriteListDatapointsUpdateSubscriptionTimeSeriesUpdateTimeSeriesIDTimeSeriesIDList
- 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
SequenceColumnSequenceColumnCoreSequenceColumnListSequenceColumnUpdateSequenceColumnWriteSequenceColumnWriteListSequenceCoreSequenceDataSequenceDataListSequenceFilterSequenceListSequencePropertySequenceRowSequenceRowsSequenceRowsListSequenceUpdateSequenceWriteSequenceWriteListSortableSequenceProperty
- Metadata
- Geospatial
- Feature types
- Features
- Reference systems
- Raster data
- Geospatial Data classes
CoordinateReferenceSystemCoordinateReferenceSystemCoreCoordinateReferenceSystemListCoordinateReferenceSystemWriteCoordinateReferenceSystemWriteListFeatureFeatureAggregateFeatureAggregateListFeatureCoreFeatureListFeatureListCoreFeatureTypeFeatureTypeCoreFeatureTypeListFeatureTypePatchFeatureTypeWriteFeatureTypeWriteListFeatureWriteFeatureWriteListGeospatialComputeFunctionGeospatialComputedItemGeospatialComputedItemListGeospatialComputedResponseGeospatialGeometryComputeFunctionGeospatialGeometryTransformComputeFunctionGeospatialGeometryValueComputeFunctionOrderSpecPatchesPropertyAndSearchSpecRasterMetadatanan_to_none()
- 3D
- Models
- Revisions
- Files
- Asset mappings
- Data classes
BoundingBox3DRevisionCameraPropertiesThreeDAssetMappingThreeDAssetMappingCoreThreeDAssetMappingListThreeDAssetMappingWriteThreeDAssetMappingWriteListThreeDModelThreeDModelCoreThreeDModelListThreeDModelRevisionThreeDModelRevisionCoreThreeDModelRevisionListThreeDModelRevisionUpdateThreeDModelRevisionWriteThreeDModelRevisionWriteListThreeDModelUpdateThreeDModelWriteThreeDModelWriteListThreeDNodeThreeDNodeList
- Contextualization
- Entity Matching
- Engineering Diagrams
- Vision
- Contextualization Data Classes
AssetTagDetectionParametersConnectionFlagsContextualizationJobContextualizationJobListContextualizationJobList.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()
ContextualizationJobTypeCustomizeFuzzinessDetectJobBundleDiagramConvertItemDiagramConvertPageDiagramConvertPageListDiagramConvertPageList.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()
DiagramConvertResultsDiagramDetectConfigDiagramDetectItemDiagramDetectResultsDiagramDetectResults.convert()DiagramDetectResults.dump()DiagramDetectResults.dump_yaml()DiagramDetectResults.errorsDiagramDetectResults.itemsDiagramDetectResults.load()DiagramDetectResults.resultDiagramDetectResults.to_pandas()DiagramDetectResults.update_status()DiagramDetectResults.wait_for_completion()
DialGaugeDetectionDigitalGaugeDetectionDirectionWeightsEntityMatchingModelEntityMatchingModelListEntityMatchingModelList.append()EntityMatchingModelList.as_external_ids()EntityMatchingModelList.as_ids()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()
EntityMatchingModelUpdateFeatureParametersFeatureParameters.asset_tag_detection_parametersFeatureParameters.dial_gauge_detection_parametersFeatureParameters.digital_gauge_detection_parametersFeatureParameters.dump()FeatureParameters.dump_yaml()FeatureParameters.industrial_object_detection_parametersFeatureParameters.level_gauge_detection_parametersFeatureParameters.load()FeatureParameters.people_detection_parametersFeatureParameters.personal_protective_equipment_detection_parametersFeatureParameters.text_detection_parametersFeatureParameters.to_pandas()FeatureParameters.valve_detection_parameters
FileReferenceIndustrialObjectDetectionParametersJobStatusLevelGaugeDetectionPeopleDetectionParametersPersonalProtectiveEquipmentDetectionParametersResourceReferenceResourceReferenceListResourceReferenceList.append()ResourceReferenceList.as_external_ids()ResourceReferenceList.as_ids()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()
TextDetectionParametersThresholdParameterValveDetectionVisionExtractItemVisionExtractJobVisionExtractPredictionsVisionExtractPredictions.asset_tag_predictionsVisionExtractPredictions.dial_gauge_predictionsVisionExtractPredictions.digital_gauge_predictionsVisionExtractPredictions.dump()VisionExtractPredictions.dump_yaml()VisionExtractPredictions.industrial_object_predictionsVisionExtractPredictions.level_gauge_predictionsVisionExtractPredictions.load()VisionExtractPredictions.people_predictionsVisionExtractPredictions.personal_protective_equipment_predictionsVisionExtractPredictions.text_predictionsVisionExtractPredictions.to_pandas()VisionExtractPredictions.valve_predictions
VisionFeatureVisionFeature.ASSET_TAG_DETECTIONVisionFeature.DIAL_GAUGE_DETECTIONVisionFeature.DIGITAL_GAUGE_DETECTIONVisionFeature.INDUSTRIAL_OBJECT_DETECTIONVisionFeature.LEVEL_GAUGE_DETECTIONVisionFeature.PEOPLE_DETECTIONVisionFeature.PERSONAL_PROTECTIVE_EQUIPMENT_DETECTIONVisionFeature.TEXT_DETECTIONVisionFeature.VALVE_DETECTIONVisionFeature.beta_features()
VisionJobAssetLinkKeypointCollectionKeypointCollectionWithObjectDetectionKeypointCollectionWithObjectDetection.dump()KeypointCollectionWithObjectDetection.dump_yaml()KeypointCollectionWithObjectDetection.keypoint_collectionKeypointCollectionWithObjectDetection.load()KeypointCollectionWithObjectDetection.object_detectionKeypointCollectionWithObjectDetection.to_pandas()
ObjectDetectionTextRegionAttributeBoundingBoxCdfResourceRefKeypointPointPolygonPolylineVisionResource
- 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
ExtractionPipelineExtractionPipelineConfigExtractionPipelineConfigCoreExtractionPipelineConfigListExtractionPipelineConfigRevisionExtractionPipelineConfigRevisionListExtractionPipelineConfigWriteExtractionPipelineConfigWriteListExtractionPipelineContactExtractionPipelineCoreExtractionPipelineListExtractionPipelineNotificationConfigurationExtractionPipelineRunExtractionPipelineRunCoreExtractionPipelineRunFilterExtractionPipelineRunListExtractionPipelineRunWriteExtractionPipelineRunWriteListExtractionPipelineUpdateExtractionPipelineWriteExtractionPipelineWriteListStringFilter
- Hosted Extractors
- Postgres Gateway
- Postgres Gateway Users API
- Postgres Gateway Tables API
- Create Postgres Gateway Tables
- Delete Postgres Gateway Tables
- Retrieve Postgres Gateway Tables
- List Postgres Gateway Tables
- Postgres Gateway classes
- Data Organization
- Annotations
- Data sets
- Labels
- Relationships
- Transformations
- TransformationsAPI
- Transformation Schedules
- Transformation Notifications
- Transformation Jobs
- Transformation Schema
- Data classes
ContainsAnySessionDetailsTransformationTransformationCoreTransformationFilterTransformationListTransformationPreviewResultTransformationUpdateTransformationWriteTransformationWriteListTransformationScheduleTransformationScheduleCoreTransformationScheduleListTransformationScheduleUpdateTransformationScheduleWriteTransformationScheduleWriteListTransformationNotificationTransformationNotificationCoreTransformationNotificationFilterTransformationNotificationListTransformationNotificationWriteTransformationNotificationWriteListTransformationJobTransformationJobFilterTransformationJobListTransformationJobMetricTransformationJobMetricListTransformationJobStatusTransformationSchemaArrayTypeTransformationSchemaColumnTransformationSchemaColumnListTransformationSchemaMapTypeTransformationSchemaStructTypeTransformationSchemaTypeTransformationSchemaUnknownTypeDataModelInfoEdgeTypeEdgesInstancesNodesOidcCredentialsRawTableSequenceRowsDestinationTransformationBlockedInfoTransformationDestinationTransformationDestination.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
FunctionFunctionCallFunctionCallListFunctionCallLogFunctionCallLogEntryFunctionCallsFilterFunctionCoreFunctionFilterFunctionListFunctionScheduleFunctionScheduleCoreFunctionScheduleWriteFunctionScheduleWriteListFunctionSchedulesFilterFunctionSchedulesListFunctionWriteFunctionWriteListFunctionsLimitsFunctionsStatus
- Data Workflows
- Workflows
- Workflow Versions
- Workflow Executions
- Workflow Tasks
- Workflow Triggers
- Upsert Trigger
- List Triggers
- List runs for a Trigger
- Delete Triggers
- Data Workflows data classes
CDFTaskOutputCDFTaskParametersDynamicTaskOutputDynamicTaskParametersFunctionTaskOutputFunctionTaskParametersSimulationTaskOutputSimulationTaskParametersSubworkflowReferenceParametersSubworkflowTaskOutputSubworkflowTaskParametersTransformationTaskOutputTransformationTaskParametersWorkflowWorkflowCoreWorkflowDataModelingTriggerRuleWorkflowDefinitionWorkflowDefinitionCoreWorkflowDefinitionUpsertWorkflowExecutionWorkflowExecutionDetailedWorkflowExecutionListWorkflowIdsWorkflowListWorkflowScheduledTriggerRuleWorkflowTaskWorkflowTaskExecutionWorkflowTaskOutputWorkflowTaskParametersWorkflowTriggerWorkflowTriggerCoreWorkflowTriggerCreateWorkflowTriggerDataModelingQueryWorkflowTriggerListWorkflowTriggerRuleWorkflowTriggerRunWorkflowTriggerRunListWorkflowTriggerUpsertWorkflowTriggerUpsertListWorkflowUpsertWorkflowUpsertListWorkflowVersionWorkflowVersionCoreWorkflowVersionIdWorkflowVersionListWorkflowVersionUpsertWorkflowVersionUpsertList
- 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