Create models

async AsyncCogniteClient.three_d.models.create(
name: str | ThreeDModelWrite | SequenceNotStr[str | ThreeDModelWrite],
data_set_id: int | None = None,
metadata: dict[str, str] | None = None,
) ThreeDModel | ThreeDModelList

Create new 3d models.

Parameters:
  • name (str | ThreeDModelWrite | SequenceNotStr[str | ThreeDModelWrite]) – The name of the 3d model(s) or 3D model object to create. If a 3D model object is provided, the other arguments are ignored.

  • data_set_id (int | None) – The id of the dataset this 3D model belongs to.

  • metadata (dict[str, str] | None) – Custom, application-specific metadata. String key -> String value. Limits: Maximum length of key is 32 bytes, value 512 bytes, up to 16 key-value pairs.

Returns:

The created 3d model(s).

Return type:

ThreeDModel | ThreeDModelList

Example

Create new 3d models:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.three_d.models.create(
...     name="My Model", data_set_id=1, metadata={"key1": "value1", "key2": "value2"}
... )

Create multiple new 3D Models:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes import ThreeDModelWrite
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> my_model = ThreeDModelWrite(
...     name="My Model", data_set_id=1, metadata={"key1": "value1", "key2": "value2"}
... )
>>> my_other_model = ThreeDModelWrite(
...     name="My Other Model",
...     data_set_id=1,
...     metadata={"key1": "value1", "key2": "value2"},
... )
>>> res = client.three_d.models.create([my_model, my_other_model])