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 or upgrade this package:
pip:
pip install --upgrade cognite-sdk
poetry:
poetry add cognite-sdk
uv:
uv add cognite-sdk
To install with optional dependencies:
pip install "cognite-sdk[pandas, geo]"
Available extras:
numpy: numpy
pandas: pandas
geo: geopandas, shapely
sympy: sympy
all: all of the above
What’s new in v8
The SDK v8 introduces full async support with the new AsyncCogniteClient. This enables:
Native
async/awaitpatterns for all API operationsNon-blocking concurrent operations directly in Notebooks (including browser-based via Pyodide) and UI frameworks like Streamlit
Significantly faster file uploads on Windows (new underlying HTTP client,
httpx)Async variants for all helper/utility methods on data classes (e.g.,
Functionnow hascall_async)
Other improvements:
Simpler client instantiation: pass either
clusterorbase_urlTyped instance apply classes (e.g.,
CogniteAssetApply) now work correctly with patch updates (replace=False)Better pandas DataFrame columns for datapoints: now uses
MultiIndexfor identifiers, aggregates, units, etc.Read data classes now have correct types (no longer
Optionalon required fields)More specific exceptions are now always raised when appropriate (
CogniteNotFoundError,CogniteDuplicatedError)
For a complete list of changes, see the Migration Guide.
The synchronous CogniteClient remains fully supported and now wraps the async client internally.
# Async client (new in v8!)
from cognite.client import AsyncCogniteClient
async def main():
client = AsyncCogniteClient()
tss = await client.time_series.list()
# Sync client (still supported)
from cognite.client import CogniteClient
client = CogniteClient()
tss = client.time_series.list()
See the Quickstart for configuration examples.
Contents
- Quickstart
- Settings
- Credential Providers
- CogniteClient
- AsyncCogniteClient
- CogniteClient (sync)
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.proxyGlobalConfig.max_workersGlobalConfig.concurrency_settingsGlobalConfig.follow_redirectsGlobalConfig.file_download_chunk_sizeGlobalConfig.file_upload_chunk_sizeGlobalConfig.silence_feature_preview_warningsGlobalConfig.event_loopGlobalConfig.apply_settings()
- Extensions and optional dependencies
- Identity and access management
- Compare access rights (capabilities)
- Principals
- Tokens
- Groups
- Security categories
- Sessions
- User Profiles
- Data classes
ClientCredentialsCreatedSessionGroupGroupAttributesGroupAttributesTokenGroupCoreGroupListGroupWriteGroupWriteListProjectSpecSecurityCategorySecurityCategoryCoreSecurityCategoryListSecurityCategoryWriteSecurityCategoryWriteListSessionSessionListTokenInspectionUserProfileUserProfileListUserProfilesConfigurationPrincipalPrincipalListServiceAccountCreatorServicePrincipalUnknownPrincipalUserPrincipal
- 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
BTreeIndexBTreeIndexApplyConstraintConstraintApplyConstraintCoreContainerContainerApplyContainerApplyListContainerCoreContainerListContainerPropertyContainerPropertyApplyContainerPropertyCoreIndexIndexApplyIndexCoreInvertedIndexInvertedIndexApplyPropertyConstraintStateRequiresConstraintRequiresConstraintApplyUniquenessConstraintUniquenessConstraintApply
- 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
DataModelingInstancesListEdgeEdgeApplyEdgeApplyListEdgeApplyResultEdgeApplyResultListEdgeListEdgeListWithCursorInspectOperationInspectionResultsInstanceInstanceAggregationResultInstanceAggregationResultListInstanceApplyInstanceApplyResultInstanceCoreInstanceInspectResultInstanceInspectResultListInstanceInspectResultsInstanceSortInstancesApplyInstancesApplyResultInstancesDeleteResultInstancesResultInvolvedContainersInvolvedViewsNodeNodeApplyNodeApplyListNodeApplyResultNodeApplyResultListNodeListNodeListWithCursorNodeOrEdgeDataPropertiesPropertyOptionsTargetUnitTypeInformationTypePropertyDefinitionTypedEdgeTypedEdgeApplyTypedInstanceTypedNodeTypedNodeApplyWritableInstanceCore
- Instances query data classes
EdgeResultSetExpressionEdgeResultSetExpressionSyncIntersectionNodeOrEdgeResultSetExpressionNodeResultSetExpressionNodeResultSetExpressionSyncQueryQueryBaseQueryResultQuerySyncResultSetExpressionResultSetExpressionBaseResultSetExpressionSyncSelectSelectBaseSelectSyncSetOperationSourceSelectorUnionUnionAll
- Data Modeling ID data classes
- Statistics
- Project
- Retrieve space statistics
- List space statistics
- Data modeling statistics data classes
CountLimitInstanceStatisticsProjectStatisticsProjectStatistics.spacesProjectStatistics.containersProjectStatistics.viewsProjectStatistics.data_modelsProjectStatistics.container_propertiesProjectStatistics.instancesProjectStatistics.concurrent_read_limitProjectStatistics.concurrent_write_limitProjectStatistics.concurrent_delete_limitProjectStatistics.dump()
SpaceStatisticsSpaceStatisticsList
- GraphQL
- Core Data Model
Cognite360ImageCognite360ImageAnnotationCognite360ImageAnnotationApplyCognite360ImageApplyCognite360ImageCollectionCognite360ImageCollectionApplyCognite360ImageModelCognite360ImageModelApplyCognite360ImageStationCognite360ImageStationApplyCognite3DModelCognite3DModelApplyCognite3DObjectCognite3DObjectApplyCognite3DRevisionCognite3DRevisionApplyCognite3DTransformationEdgeCognite3DTransformationEdgeApplyCognite3DTransformationNodeCognite3DTransformationNodeApplyCogniteActivityCogniteActivityApplyCogniteAnnotationCogniteAnnotationApplyCogniteAssetCogniteAssetApplyCogniteAssetClassCogniteAssetClassApplyCogniteAssetTypeCogniteAssetTypeApplyCogniteCADModelCogniteCADModelApplyCogniteCADNodeCogniteCADNodeApplyCogniteCADRevisionCogniteCADRevisionApplyCogniteCubeMapCogniteCubeMapApplyCogniteDescribableEdgeCogniteDescribableEdgeApplyCogniteDescribableNodeCogniteDescribableNodeApplyCogniteDiagramAnnotationCogniteDiagramAnnotationApplyCogniteEquipmentCogniteEquipmentApplyCogniteEquipmentTypeCogniteEquipmentTypeApplyCogniteFileCogniteFileApplyCogniteFileCategoryCogniteFileCategoryApplyCognitePointCloudModelCognitePointCloudModelApplyCognitePointCloudRevisionCognitePointCloudRevisionApplyCognitePointCloudVolumeCognitePointCloudVolumeApplyCogniteSchedulableCogniteSchedulableApplyCogniteSourceSystemCogniteSourceSystemApplyCogniteSourceableEdgeCogniteSourceableEdgeApplyCogniteSourceableNodeCogniteSourceableNodeApplyCogniteTimeSeriesCogniteTimeSeriesApplyCogniteUnitCogniteUnitApplyCogniteVisualizableCogniteVisualizableApply
- Extractor Extensions
- Debugging Data Classes
ContainersWithoutIndexesInvolvedNoticeCursoringNoticeDebugInfoDebugNoticeDebugNoticeListDebugParametersExcessiveTimeoutNoticeExecutionPlanFilterMatchesCursorableSortNoticeFilteringNoticeIndexingNoticeIntractableDirectRelationsCursorNoticeInvalidDebugOptionsNoticeNoTimeoutWithResultsNoticeSelectiveExternalIDFilterNoticeSignificantHasDataFiltersNoticeSignificantPostFilteringNoticeSortNotBackedByIndexNoticeSortingNoticeTranslatedQueryUnindexedThroughNoticeUnknownDebugNotice
- Agents
- Create or update an agent
- Retrieve an agent by external id
- List all agents
- Delete an agent by external id
- Chat with an agent by external id
- Agent Data classes
ActionActionCallActionResultAgentAgentChatResponseAgentDataItemAgentListAgentMessageAgentMessageListAgentReasoningItemAgentToolAgentToolListAgentToolUpsertAgentToolUpsertListAgentUpsertAgentUpsertListAskDocumentAgentToolAskDocumentAgentToolUpsertClientToolActionClientToolCallClientToolResultDataModelInfoInstanceSpacesMessageMessageContentMessageListQueryKnowledgeGraphAgentToolQueryKnowledgeGraphAgentToolConfigurationQueryKnowledgeGraphAgentToolUpsertQueryTimeSeriesDatapointsAgentToolQueryTimeSeriesDatapointsAgentToolUpsertSummarizeDocumentAgentToolSummarizeDocumentAgentToolUpsertTextContentToolConfirmationCallToolConfirmationResultUnknownActionUnknownActionCallUnknownAgentToolUnknownAgentToolUpsertUnknownContent
- AI
- Limits
- Assets
- Retrieve an asset by id
- Retrieve multiple assets by id
- Retrieve an asset subtree
- List 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
- Update assets
- Upsert assets
- Asset Data classes
AggregateResultItemAssetAsset.as_write()Asset.children()Asset.children_async()Asset.dump()Asset.events()Asset.events_async()Asset.files()Asset.files_async()Asset.parent()Asset.parent_async()Asset.sequences()Asset.sequences_async()Asset.subtree()Asset.subtree_async()Asset.time_series()Asset.time_series_async()Asset.to_pandas()
AssetFilterAssetHierarchyAssetListAssetPropertyAssetUpdateAssetWriteAssetWriteListSortableAssetProperty
- Events
- Retrieve an event by id
- Retrieve multiple events by id
- List 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
- 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 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
- 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
- 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
DataDeletionDataPointSubscriptionUpdateDataPointSubscriptionWriteDatapointSubscriptionDatapointSubscriptionBatchDatapointSubscriptionCoreDatapointSubscriptionFilterPropertiesDatapointSubscriptionListDatapointSubscriptionPartitionDatapointSubscriptionPropertyDatapointSubscriptionWriteListDatapointsUpdateSubscriptionTimeSeriesUpdateTimeSeriesIDTimeSeriesIDList
- Metadata
- Sequences
- Metadata
- Retrieve a sequence by id
- Retrieve multiple sequences by id
- List 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
- 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
- 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
AssetTagDetectionParametersConnectionFlagsContextualizationJobContextualizationJob.dump()ContextualizationJob.dump_yaml()ContextualizationJob.get_result()ContextualizationJob.get_result_async()ContextualizationJob.load()ContextualizationJob.set_client_ref()ContextualizationJob.to_pandas()ContextualizationJob.update_status()ContextualizationJob.update_status_async()ContextualizationJob.wait_for_completion()ContextualizationJob.wait_for_completion_async()
ContextualizationJobListContextualizationJobList.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.set_client_ref()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()
DiagramConvertResultsDiagramConvertResults.dump()DiagramConvertResults.dump_yaml()DiagramConvertResults.get_result()DiagramConvertResults.get_result_async()DiagramConvertResults.load()DiagramConvertResults.resultDiagramConvertResults.set_client_ref()DiagramConvertResults.to_pandas()DiagramConvertResults.update_status()DiagramConvertResults.update_status_async()DiagramConvertResults.wait_for_completion()DiagramConvertResults.wait_for_completion_async()
DiagramDetectConfigDiagramDetectItemDiagramDetectResultsDiagramDetectResults.convert()DiagramDetectResults.convert_async()DiagramDetectResults.dump()DiagramDetectResults.dump_yaml()DiagramDetectResults.errorsDiagramDetectResults.get_errors()DiagramDetectResults.get_errors_async()DiagramDetectResults.get_result()DiagramDetectResults.get_result_async()DiagramDetectResults.load()DiagramDetectResults.resultDiagramDetectResults.set_client_ref()DiagramDetectResults.to_pandas()DiagramDetectResults.update_status()DiagramDetectResults.update_status_async()DiagramDetectResults.wait_for_completion()DiagramDetectResults.wait_for_completion_async()
DialGaugeDetectionDigitalGaugeDetectionDirectionWeightsEntityMatchingModelEntityMatchingModel.dump()EntityMatchingModel.dump_yaml()EntityMatchingModel.load()EntityMatchingModel.predict()EntityMatchingModel.predict_async()EntityMatchingModel.refit()EntityMatchingModel.refit_async()EntityMatchingModel.set_client_ref()EntityMatchingModel.to_pandas()EntityMatchingModel.update_status()EntityMatchingModel.update_status_async()EntityMatchingModel.wait_for_completion()EntityMatchingModel.wait_for_completion_async()
EntityMatchingModelListEntityMatchingModelList.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.set_client_ref()EntityMatchingModelList.sort()EntityMatchingModelList.to_pandas()
EntityMatchingModelUpdateEntityMatchingPredictionResultEntityMatchingPredictionResult.dump()EntityMatchingPredictionResult.dump_yaml()EntityMatchingPredictionResult.get_result()EntityMatchingPredictionResult.get_result_async()EntityMatchingPredictionResult.load()EntityMatchingPredictionResult.set_client_ref()EntityMatchingPredictionResult.to_pandas()EntityMatchingPredictionResult.update_status()EntityMatchingPredictionResult.update_status_async()EntityMatchingPredictionResult.wait_for_completion()EntityMatchingPredictionResult.wait_for_completion_async()
FeatureParametersFeatureParameters.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()
TextDetectionParametersThresholdParameterValveDetectionVisionExtractItemVisionExtractJobVisionExtractJob.dump()VisionExtractJob.dump_yaml()VisionExtractJob.get_errors()VisionExtractJob.get_errors_async()VisionExtractJob.get_result()VisionExtractJob.get_result_async()VisionExtractJob.load()VisionExtractJob.save_predictions()VisionExtractJob.save_predictions_async()VisionExtractJob.set_client_ref()VisionExtractJob.to_pandas()VisionExtractJob.update_status()VisionExtractJob.update_status_async()VisionExtractJob.wait_for_completion()VisionExtractJob.wait_for_completion_async()
VisionExtractPredictionsVisionExtractPredictions.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()VisionFeature.capitalize()VisionFeature.casefold()VisionFeature.center()VisionFeature.count()VisionFeature.encode()VisionFeature.endswith()VisionFeature.expandtabs()VisionFeature.find()VisionFeature.format()VisionFeature.format_map()VisionFeature.index()VisionFeature.isalnum()VisionFeature.isalpha()VisionFeature.isascii()VisionFeature.isdecimal()VisionFeature.isdigit()VisionFeature.isidentifier()VisionFeature.islower()VisionFeature.isnumeric()VisionFeature.isprintable()VisionFeature.isspace()VisionFeature.istitle()VisionFeature.isupper()VisionFeature.join()VisionFeature.ljust()VisionFeature.lower()VisionFeature.lstrip()VisionFeature.maketrans()VisionFeature.partition()VisionFeature.removeprefix()VisionFeature.removesuffix()VisionFeature.replace()VisionFeature.rfind()VisionFeature.rindex()VisionFeature.rjust()VisionFeature.rpartition()VisionFeature.rsplit()VisionFeature.rstrip()VisionFeature.split()VisionFeature.splitlines()VisionFeature.startswith()VisionFeature.strip()VisionFeature.swapcase()VisionFeature.title()VisionFeature.translate()VisionFeature.upper()VisionFeature.zfill()
AssetLinkKeypointCollectionKeypointCollectionWithObjectDetectionKeypointCollectionWithObjectDetection.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
ContainsAnySessionDetailsTransformationTransformationFilterTransformationListTransformationPreviewResultTransformationUpdateTransformationWriteTransformationWriteListTransformationScheduleTransformationScheduleCoreTransformationScheduleListTransformationScheduleUpdateTransformationScheduleWriteTransformationScheduleWriteListTransformationNotificationTransformationNotificationCoreTransformationNotificationFilterTransformationNotificationListTransformationNotificationWriteTransformationNotificationWriteListTransformationJobTransformationJobFilterTransformationJobListTransformationJobMetricTransformationJobMetricListTransformationJobStatusTransformationSchemaArrayTypeTransformationSchemaColumnTransformationSchemaColumnListTransformationSchemaMapTypeTransformationSchemaStructTypeTransformationSchemaTypeTransformationSchemaUnknownTypeDataModelInfoEdgeTypeEdgesInstancesNodesOidcCredentialsRawTableSequenceRowsDestinationTransformationBlockedInfoTransformationDestinationTransformationDestination.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
FunctionFunctionCallFunctionCallListFunctionCallLogFunctionCallLogEntryFunctionCallsFilterFunctionCoreFunctionFilterFunctionHandleFunctionListFunctionScheduleFunctionScheduleCoreFunctionScheduleWriteFunctionScheduleWriteListFunctionSchedulesFilterFunctionSchedulesListFunctionWriteFunctionWriteListFunctionsLimitsFunctionsStatus
- Simulators
- SimulatorsAPI
- Simulator Integrations
- Simulator Models
- Simulator Model Revisions
- Simulator Routines
- Simulator Routine Revisions
- Simulation Runs
- Simulator Logs
- Data classes
SimulationInputSimulationInputOverrideSimulationOutputSimulationRunSimulationRunDataItemSimulationRunDataListSimulationRunListSimulationRunWriteSimulationRunWriteListSimulationValueUnitSimulationValueUnitInputSimulationValueUnitNameSimulatorSimulatorFlowsheetSimulatorFlowsheetGraphicalObjectSimulatorFlowsheetObjectEdgeSimulatorFlowsheetObjectNodeSimulatorFlowsheetPositionSimulatorFlowsheetPropertySimulatorFlowsheetThermodynamicSimulatorIntegrationSimulatorIntegrationListSimulatorListSimulatorLogSimulatorLogDataSimulatorLogListSimulatorModelSimulatorModelDependencyFileIdSimulatorModelDependencyFileReferenceSimulatorModelListSimulatorModelRevisionSimulatorModelRevisionDataSimulatorModelRevisionDataListSimulatorModelRevisionDependencySimulatorModelRevisionListSimulatorModelRevisionWriteSimulatorModelRevisionWriteListSimulatorModelWriteSimulatorModelWriteListSimulatorRoutineSimulatorRoutineConfigurationSimulatorRoutineDataSamplingSimulatorRoutineInputSimulatorRoutineInputConstantSimulatorRoutineInputListSimulatorRoutineInputTimeseriesSimulatorRoutineListSimulatorRoutineLogicalCheckSimulatorRoutineOutputSimulatorRoutineOutputListSimulatorRoutineRevisionSimulatorRoutineRevisionListSimulatorRoutineRevisionWriteSimulatorRoutineRevisionWriteListSimulatorRoutineScheduleSimulatorRoutineStageSimulatorRoutineStageListSimulatorRoutineSteadyStateDetectionSimulatorRoutineStepSimulatorRoutineStepArgumentsSimulatorRoutineWriteSimulatorRoutineWriteListSimulatorStepSimulatorStepFieldSimulatorStepOptionSimulatorUnitEntry
- Data Workflows
- Workflows
- Workflow Versions
- Workflow Executions
- Workflow Tasks
- Workflow Triggers
- Upsert Trigger
- List Triggers
- List runs for a Trigger
- Delete Triggers
- Pause Trigger
- Resume Trigger
- Data Workflows data classes
CDFTaskOutputCDFTaskParametersDynamicTaskOutputDynamicTaskParametersFunctionTaskOutputFunctionTaskParametersSimulationTaskOutputSimulationTaskParametersSubworkflowReferenceParametersSubworkflowTaskOutputSubworkflowTaskParametersTransformationTaskOutputTransformationTaskParametersWorkflowWorkflowCoreWorkflowDataModelingTriggerRuleWorkflowDefinitionWorkflowDefinitionCoreWorkflowDefinitionUpsertWorkflowExecutionWorkflowExecutionDetailedWorkflowExecutionListWorkflowIdsWorkflowListWorkflowScheduledTriggerRuleWorkflowTaskWorkflowTaskExecutionWorkflowTaskOutputWorkflowTaskParametersWorkflowTriggerWorkflowTriggerCoreWorkflowTriggerDataModelingQueryWorkflowTriggerListWorkflowTriggerRuleWorkflowTriggerRunWorkflowTriggerRunListWorkflowTriggerUpsertWorkflowTriggerUpsertListWorkflowUpsertWorkflowUpsertListWorkflowVersionWorkflowVersionCoreWorkflowVersionIdWorkflowVersionListWorkflowVersionUpsertWorkflowVersionUpsertList
- Unit Catalog
- Filters
- Base data classes
- Exceptions
- Utils
- Testing
- Upsert
- Update and Upsert Mode Parameter
- Alpha and Beta Features