Search for sequences

async AsyncCogniteClient.sequences.search(
name: str | None = None,
description: str | None = None,
query: str | None = None,
filter: SequenceFilter | dict[str, Any] | None = None,
limit: int = 25,
) → SequenceList

Search for sequences.

Primarily meant for human-centric use-cases and data exploration, not for programs, since matching and ordering may change over time. Use the list function if stable or exact matches are required.

Parameters:

  • name (str | None) – Prefix and fuzzy search on name.

  • description (str | None) – Prefix and fuzzy search on description.

  • query (str | None) – Search on name and description using wildcard search on each of the words (separated by spaces). Retrieves results where at least one word must match. Example: ‘some other’

  • filter (SequenceFilter | dict[str, Any] | None) – Filter to apply. Performs exact match on these fields.

  • limit (int) – Max number of results to return.

Returns:

The search result as a SequenceList

Return type:

SequenceList

Examples

Search for a sequence:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.sequences.search(name="some name")