Session

cognite.neat._session._session.NeatSession

A session is an interface for neat operations.

version: str property

Get the current version of neat.

__init__(client, config='legacy-additive')

Initialize a Neat session.

Parameters:

Name	Type	Description	Default
client	CogniteClient | ClientConfig	The Cognite client or client configuration to use for the session.	required
config	Literal[legacy - additive, legacy - rebuild, deep - additive, deep - rebuild] | NeatConfig	The configuration profile to use for the session. Defaults to "legacy-additive". This means Neat will perform additive modeling and apply only validations that were part of the legacy Neat version.	'legacy-additive'

Session Components

The NeatSession provides three main components to interact with:

physical_data_model

The PhysicalDataModel component provides methods for reading, creating, and managing physical data models in CDF.

neat.physical_data_model.read(...)
neat.physical_data_model.write(...)

See Physical Data Model for detailed documentation.

issues

The Issues component provides access to issues found during reading and writing of data models:

neat.issues

result

The Result component provides access to the results of data model operations and transformations.

neat.result