List labels

async AsyncCogniteClient.labels.list(
name: str | None = None,
external_id_prefix: str | None = None,
data_set_ids: int | Sequence[int] | None = None,
data_set_external_ids: str | SequenceNotStr[str] | None = None,
limit: int | None = 25,
) → LabelDefinitionList

List Labels.

Parameters:

  • name (str | None) – returns the label definitions matching that name

  • external_id_prefix (str | None) – filter label definitions with external ids starting with the prefix specified

  • data_set_ids (int | Sequence[int] | None) – return only labels in the data sets with this id / these ids.

  • data_set_external_ids (str | SequenceNotStr[str] | None) – return only labels in the data sets with this external id / these external ids.

  • limit (int | None) – Maximum number of label definitions to return. Defaults to 25. Set to -1, float(“inf”) or None to return all items.

Returns:

List of requested Labels

Return type:

LabelDefinitionList

Examples

List Labels and filter on name:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> label_list = client.labels.list(limit=5, name="Pump")

Iterate over label definitions, one-by-one:

>>> for label in client.labels():
...     label  # do something with the label definition

Iterate over chunks of label definitions to reduce memory load:

>>> for label_list in client.labels(chunk_size=2500):
...     label_list  # do something with the type definitions