viam-sdk 0.45.2__py3-none-win_amd64.whl → 0.47.0__py3-none-win_amd64.whl

viam/app/data_client.py

@@ -7,6 +7,7 @@ from typing import Any, Dict, List, Mapping, Optional, Sequence, Tuple, Union, c
 import bson
 from google.protobuf.struct_pb2 import Struct
 from grpclib.client import Channel, Stream
+from typing_extensions import Self
 
 from viam import logging
 from viam.proto.app.data import (
@@ -54,9 +55,30 @@ from viam.proto.app.data import (
     TabularDataByMQLResponse,
     TabularDataBySQLRequest,
     TabularDataBySQLResponse,
+    TabularDataSource,
+    TabularDataSourceType,
     TagsByFilterRequest,
     TagsByFilterResponse,
 )
+from viam.proto.app.datapipelines import (
+    CreateDataPipelineRequest,
+    CreateDataPipelineResponse,
+    DataPipelineRunStatus,
+    DataPipelinesServiceStub,
+    DeleteDataPipelineRequest,
+    GetDataPipelineRequest,
+    GetDataPipelineResponse,
+    ListDataPipelineRunsRequest,
+    ListDataPipelineRunsResponse,
+    ListDataPipelinesRequest,
+    ListDataPipelinesResponse,
+)
+from viam.proto.app.datapipelines import (
+    DataPipeline as ProtoDataPipeline,
+)
+from viam.proto.app.datapipelines import (
+    DataPipelineRun as ProtoDataPipelineRun,
+)
 from viam.proto.app.dataset import (
     CreateDatasetRequest,
     CreateDatasetResponse,
@@ -92,10 +114,10 @@ LOGGER = logging.getLogger(__name__)
 class DataClient:
     """gRPC client for uploading and retrieving data from app.
 
-    Constructor is used by `ViamClient` to instantiate relevant service stubs. Calls to `DataClient` methods should be made through
-    `ViamClient`.
+    This class's constructor instantiates relevant service stubs. Always make :class:`DataClient` method calls through an instance of
+    :class:`ViamClient`.
 
-    Establish a Connection::
+    Establish a connection::
 
         import asyncio
 
@@ -159,10 +181,10 @@ class DataClient:
         """The resource name"""
 
         resource_api: str
-        """The resource API. Ex: rdk:component:sensor"""
+        """The resource API. For example, rdk:component:sensor"""
 
         method_name: str
-        """The method used for data capture. Ex: Readings"""
+        """The method used for data capture. For example, Readings"""
 
         time_captured: datetime
         """The time at which the data point was captured"""
@@ -220,8 +242,123 @@ class DataClient:
             )
             return self.resource_api
 
+    @dataclass
+    class DataPipeline:
+        """Represents a data pipeline and its associated metadata."""
+
+        id: str
+        """The ID of the data pipeline"""
+
+        organization_id: str
+        """The organization ID"""
+
+        name: str
+        """The name of the data pipeline"""
+
+        mql_binary: List[Dict[str, Any]]
+        """The MQL binary of the data pipeline"""
+
+        schedule: str
+        """The schedule of the data pipeline"""
+
+        created_on: datetime
+        """The time the data pipeline was created"""
+
+        updated_at: datetime
+        """The time the data pipeline was last updated"""
+
+        enabled: bool
+        """Whether the data pipeline is enabled"""
+
+        @classmethod
+        def from_proto(cls, data_pipeline: ProtoDataPipeline) -> Self:
+            return cls(
+                id=data_pipeline.id,
+                organization_id=data_pipeline.organization_id,
+                name=data_pipeline.name,
+                mql_binary=[bson.decode(bson_bytes) for bson_bytes in data_pipeline.mql_binary],
+                schedule=data_pipeline.schedule,
+                created_on=data_pipeline.created_on.ToDatetime(),
+                updated_at=data_pipeline.updated_at.ToDatetime(),
+                enabled=data_pipeline.enabled,
+            )
+
+    @dataclass
+    class DataPipelineRun:
+        """Represents a data pipeline run and its associated metadata."""
+
+        id: str
+        """The ID of the data pipeline run"""
+
+        status: DataPipelineRunStatus.ValueType
+        """The status of the data pipeline run"""
+
+        start_time: datetime
+        """The time the data pipeline run started"""
+
+        end_time: datetime
+        """The time the data pipeline run ended"""
+
+        data_start_time: datetime
+        """The start time of the data that was processed in the run."""
+        data_end_time: datetime
+        """The end time of the data that was processed in the run."""
+
+        @classmethod
+        def from_proto(cls, data_pipeline_run: ProtoDataPipelineRun) -> Self:
+            return cls(
+                id=data_pipeline_run.id,
+                status=data_pipeline_run.status,
+                start_time=data_pipeline_run.start_time.ToDatetime(),
+                end_time=data_pipeline_run.end_time.ToDatetime(),
+                data_start_time=data_pipeline_run.data_start_time.ToDatetime(),
+                data_end_time=data_pipeline_run.data_end_time.ToDatetime(),
+            )
+
+    @dataclass
+    class DataPipelineRunsPage:
+        """Represents a page of data pipeline runs and provides pagination functionality."""
+
+        _client: "DataClient"
+        """The data client used to make API calls"""
+
+        pipeline_id: str
+        """The ID of the pipeline these runs belong to"""
+
+        page_size: int
+        """The number of runs per page"""
+
+        runs: List["DataClient.DataPipelineRun"]
+        """The list of runs in this page"""
+
+        next_page_token: str
+        """The token to use to get the next page of results"""
+
+        async def next_page(self) -> "DataClient.DataPipelineRunsPage":
+            """Get the next page of data pipeline runs.
+
+            Returns:
+                DataPipelineRunsPage: The next page of runs, or an empty page if there are no more runs
+            """
+            if not self.next_page_token:
+                # no token, return empty next page
+                return DataClient.DataPipelineRunsPage(
+                    _client=self._client, pipeline_id=self.pipeline_id, page_size=self.page_size, runs=[], next_page_token=""
+                )
+            return await self._client._list_data_pipeline_runs(self.pipeline_id, self.page_size, self.next_page_token)
+
+        @classmethod
+        def from_proto(cls, data_pipeline_runs_page: ListDataPipelineRunsResponse, client: "DataClient", page_size: int) -> Self:
+            return cls(
+                _client=client,
+                pipeline_id=data_pipeline_runs_page.pipeline_id,
+                page_size=page_size,
+                runs=[DataClient.DataPipelineRun.from_proto(run) for run in data_pipeline_runs_page.runs],
+                next_page_token=data_pipeline_runs_page.next_page_token,
+            )
+
     def __init__(self, channel: Channel, metadata: Mapping[str, str]):
-        """Create a `DataClient` that maintains a connection to app.
+        """Create a :class:`DataClient` that maintains a connection to app.
 
         Args:
             channel (grpclib.client.Channel): Connection to app.
@@ -231,11 +368,13 @@ class DataClient:
         self._data_client = DataServiceStub(channel)
         self._data_sync_client = DataSyncServiceStub(channel)
         self._dataset_client = DatasetServiceStub(channel)
+        self._data_pipelines_client = DataPipelinesServiceStub(channel)
         self._channel = channel
 
     _data_client: DataServiceStub
     _data_sync_client: DataSyncServiceStub
     _dataset_client: DatasetServiceStub
+    _data_pipelines_client: DataPipelinesServiceStub
     _metadata: Mapping[str, str]
     _channel: Channel
 
@@ -249,9 +388,8 @@ class DataClient:
         include_internal_data: bool = False,
         dest: Optional[str] = None,
     ) -> Tuple[List[TabularData], int, str]:
-        """Filter and download tabular data. The data will be paginated into pages of `limit` items, and the pagination ID will be included
-        in the returned tuple. If a destination is provided, the data will be saved to that file.
-        If the file is not empty, it will be overwritten.
+        """Filter and download tabular data. The data will be paginated into pages of ``limit`` items; the returned tuple will include
+        the pagination ID. If a destination is provided, this method saves returned data to that file, overwriting any existing file content.
 
         ::
 
@@ -269,23 +407,23 @@ class DataClient:
             print(f"My data: {my_data}")
 
         Args:
-            filter (viam.proto.app.data.Filter): Optional `Filter` specifying tabular data to retrieve. No `Filter` implies all tabular
-                data.
+            filter (~viam.proto.app.data.Filter): Optional, specifies tabular data to retrieve. If missing, matches all tabular data.
             limit (int): The maximum number of entries to include in a page. Defaults to 50 if unspecified.
-            sort_order (viam.proto.app.data.Order): The desired sort order of the data.
+            sort_order (~viam.proto.app.data.Order): The desired sort order of the data.
             last (str): Optional string indicating the object identifier of the last-returned data.
-                        This object identifier is returned by calls to `TabularDataByFilter` as the `last` value.
-                        If provided, the server will return the next data entries after the last object identifier.
+                Returned by calls to :class:`TabularDataByFilter` as the ``last`` value.
+                If provided, the server returns the next data entries after the last object identifier.
             count_only (bool): Whether to return only the total count of entries.
             include_internal_data (bool): Whether to return the internal data. Internal data is used for Viam-specific data ingestion,
-                                          like cloud SLAM. Defaults to `False`.
+                like cloud SLAM. Defaults to ``False``.
             dest (str): Optional filepath for writing retrieved data.
 
         Returns:
             Tuple[List[TabularData], int, str]: A tuple containing the following:
-            List[TabularData]: The tabular data,
-            int: The count (number of entries),
-            str: The last-returned page ID.
+
+                - ``tabular_data`` (*List[TabularData]*): The tabular data.
+                - ``count`` (*int*): The count (number of entries).
+                - ``last`` (*str*): The last-returned page ID.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#tabulardatabyfilter>`_.
         """
@@ -332,7 +470,7 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that owns the data.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                To find your organization ID, visit the organization settings page in the Viam app.
             sql_query (str): The SQL query to run.
 
         Returns:
@@ -346,7 +484,12 @@ class DataClient:
 
     @_alias_param("query", param_alias="mql_binary")
     async def tabular_data_by_mql(
-        self, organization_id: str, query: Union[List[bytes], List[Dict[str, Any]]], use_recent_data: Optional[bool] = None
+        self,
+        organization_id: str,
+        query: Union[List[bytes], List[Dict[str, Any]]],
+        use_recent_data: Optional[bool] = None,
+        tabular_data_source_type: TabularDataSourceType.ValueType = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD,
+        pipeline_id: Optional[str] = None,
     ) -> List[Dict[str, Union[ValueTypes, datetime]]]:
         """Obtain unified tabular data and metadata, queried with MQL.
 
@@ -363,11 +506,16 @@ class DataClient:
 
         Args:
             organization_id (str): The ID of the organization that owns the data.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                To find your organization ID, visit the organization settings page in the Viam app.
             query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run, as a list of MongoDB aggregation pipeline stages.
-                Note: Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the future,
-                so using a dictionary is preferred.
-            use_recent_data (bool): Whether to query blob storage or your recent data store. Defaults to `False`
+                Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the
+                future, so prefer the dictionary option.
+            use_recent_data (bool): Whether to query blob storage or your recent data store. Defaults to ``False``..
+                Deprecated, use `tabular_data_source_type` instead.
+            tabular_data_source_type (viam.proto.app.data.TabularDataSourceType): The data source to query.
+                Defaults to `TABULAR_DATA_SOURCE_TYPE_STANDARD`.
+            pipeline_id (str): The ID of the data pipeline to query. Defaults to `None`.
+                Required if `tabular_data_source_type` is `TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK`.
 
         Returns:
             List[Dict[str, Union[ValueTypes, datetime]]]: An array of decoded BSON data objects.
@@ -375,7 +523,10 @@ class DataClient:
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#tabulardatabymql>`_.
         """
         binary: List[bytes] = [bson.encode(query) for query in query] if isinstance(query[0], dict) else query  # type: ignore
-        request = TabularDataByMQLRequest(organization_id=organization_id, mql_binary=binary, use_recent_data=use_recent_data)
+        data_source = TabularDataSource(type=tabular_data_source_type, pipeline_id=pipeline_id)
+        if use_recent_data:
+            data_source.type = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE
+        request = TabularDataByMQLRequest(organization_id=organization_id, mql_binary=binary, data_source=data_source)
         response: TabularDataByMQLResponse = await self._data_client.TabularDataByMQL(request, metadata=self._metadata)
         return [bson.decode(bson_bytes) for bson_bytes in response.raw_data]
 
@@ -404,16 +555,19 @@ class DataClient:
 
         Args:
             part_id (str): The ID of the part that owns the data.
-            resource_name (str): The name of the requested resource that captured the data. Ex: "my-sensor".
-            resource_api (str): The API of the requested resource that captured the data. Ex: "rdk:component:sensor".
-            method_name (str): The data capture method name. Ex: "Readings".
+            resource_name (str): The name of the requested resource that captured the data. For example, "my-sensor".
+            resource_api (str): The API of the requested resource that captured the data. For example, "rdk:component:sensor".
+            method_name (str): The data capture method name. For exampe, "Readings".
 
         Returns:
-            Optional[Tuple[datetime, datetime, Dict[str, ValueTypes]]]: A return value of None means that data hasn't been synced yet for the data source
-            or the most recently captured data was over a year ago, otherwise the returned tuple contains the following:
-            datetime: The time captured,
-            datetime: The time synced,
-            Dict[str, ValueTypes]: The latest tabular data captured from the specified data source.
+            Optional[Tuple[datetime, datetime, Dict[str, ValueTypes]]]:
+            A return value of ``None`` means that this data source
+            has not synced data in the last year. Otherwise, the data source has synced some data in the last year, so the returned
+            tuple contains the following:
+
+                - ``time_captured`` (*datetime*): The time captured.
+                - ``time_synced`` (*datetime*): The time synced.
+                - ``payload`` (*Dict[str, ValueTypes]*): The latest tabular data captured from the specified data source.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#getlatesttabulardata>`_.
         """
@@ -501,9 +655,9 @@ class DataClient:
         include_internal_data: bool = False,
         dest: Optional[str] = None,
     ) -> Tuple[List[BinaryData], int, str]:
-        """Filter and download binary data. The data will be paginated into pages of `limit` items, and the pagination ID will be included
-        in the returned tuple. If a destination is provided, the data will be saved to that file.
-        If the file is not empty, it will be overwritten.
+        """Filter and download binary data. The data will be paginated into pages of ``limit`` items, and the pagination ID will be included
+        in the returned tuple as ``last``. If a destination is provided, this method saves returned data to that file,
+        overwriting any existing file content.
 
         ::
 
@@ -542,25 +696,25 @@ class DataClient:
                 my_untagged_data.extend(data)
 
         Args:
-            filter (viam.proto.app.data.Filter): Optional `Filter` specifying tabular data to retrieve. No `Filter` implies all binary
-                data.
+            filter (~viam.proto.app.data.Filter): Optional, specifies tabular data to retrieve. An empty filter matches all binary data.
             limit (int): The maximum number of entries to include in a page. Defaults to 50 if unspecified.
-            sort_order (viam.proto.app.data.Order): The desired sort order of the data.
+            sort_order (~viam.proto.app.data.Order): The desired sort order of the data.
             last (str): Optional string indicating the object identifier of the last-returned data.
-                        This object identifier is returned by calls to `BinaryDataByFilter` as the `last` value.
-                        If provided, the server will return the next data entries after the last object identifier.
+                This object identifier is returned by calls to :meth:`binary_data_by_filter` as the ``last`` value.
+                If provided, the server will return the next data entries after the last object identifier.
             include_binary_data (bool): Boolean specifying whether to actually include the binary file data with each retrieved file.
-                                        Defaults to true (that is, both the files' data and metadata are returned).
+                Defaults to true (that is, both the files' data and metadata are returned).
             count_only (bool): Whether to return only the total count of entries.
             include_internal_data (bool): Whether to return the internal data. Internal data is used for Viam-specific data ingestion,
-                                          like cloud SLAM. Defaults to `False`.
+                like cloud SLAM. Defaults to ``False``.
             dest (str): Optional filepath for writing retrieved data.
 
         Returns:
-            Tuple[List[viam.proto.app.data.BinaryData], int, str]: A tuple containing the following:
-            List[viam.proto.app.data.BinaryData]: The binary data,
-            int: The count (number of entries),
-            str: The last-returned page ID.
+            Tuple[List[~viam.proto.app.data.BinaryData], int, str]: A tuple containing the following:
+
+                - ``data`` (*List[* :class:`~viam.proto.app.data.BinaryData` *]*): The binary data.
+                - ``count`` (*int*): The count (number of entries).
+                - ``last`` (*str*): The last-returned page ID.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#binarydatabyfilter>`_.
         """
@@ -611,15 +765,17 @@ class DataClient:
             binary_data = await data_client.binary_data_by_ids(my_ids)
 
         Args:
-            binary_ids (Union[List[BinaryID], List[str]]): Binary data id strings specifying the desired data or `BinaryID` objects. Must be non-empty.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field instead.
+            binary_ids (Union[List[~viam.proto.app.data.BinaryID], List[str]]): Binary data ID strings specifying the desired data or
+                :class:`BinaryID` objects. Must be non-empty.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
             dest (str): Optional filepath for writing retrieved data.
 
         Raises:
-            GRPCError: If no binary data id strings or `BinaryID` objects are provided.
+            GRPCError: If no binary data ID strings or :class:`BinaryID` objects are provided.
 
         Returns:
-            List[viam.proto.app.data.BinaryData]: The binary data.
+            List[~viam.proto.app.data.BinaryData]: The binary data.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#binarydatabyids>`_.
         """
@@ -651,10 +807,10 @@ class DataClient:
             )
 
         Args:
-            organization_id (str): ID of organization to delete data from.
-                You can obtain your organization ID from the Viam app's organization settings page.
-            delete_older_than_days (int): Delete data that was captured up to this many days ago. For example if `delete_older_than_days`
-                is 10, this deletes any data that was captured up to 10 days ago. If it is 0, all existing data is deleted.
+            organization_id (str): The ID of the organization to delete the data from.
+                To find your organization ID, visit the organization settings page in the Viam app.
+            delete_older_than_days (int): Delete data that was captured up to *this many* days ago. For example, a value of
+                10 deletes any data that was captured up to 10 days ago. A value of 0 deletes *all* existing data.
 
         Returns:
             int: The number of items deleted.
@@ -666,7 +822,7 @@ class DataClient:
         return response.deleted_count
 
     async def delete_tabular_data_by_filter(self, filter: Optional[Filter]) -> int:
-        """Deprecated: use delete_tabular_data instead."""
+        """Deprecated: use :meth:`delete_tabular_data` instead."""
         raise NotImplementedError()
 
     async def delete_binary_data_by_filter(self, filter: Optional[Filter]) -> int:
@@ -681,9 +837,10 @@ class DataClient:
             res = await data_client.delete_binary_data_by_filter(my_filter)
 
         Args:
-            filter (viam.proto.app.data.Filter): Optional `Filter` specifying binary data to delete. Passing an empty `Filter` will lead to
-                all data being deleted. Exercise caution when using this option. You must specify an organization ID with
-                "organization_ids" when using this option.
+            filter (~viam.proto.app.data.Filter): Optional, specifies binary data to delete.
+                **CAUTION: Passing an empty** ``Filter`` **deletes all binary data!**
+                You must specify an organization ID with ``organization_ids`` when using this option.
+                To find your organization ID, visit the organization settings page in the Viam app.
 
         Returns:
             int: The number of items deleted.
@@ -720,13 +877,13 @@ class DataClient:
             binary_data = await data_client.delete_binary_data_by_ids(my_ids)
 
         Args:
-            binary_ids (Union[List[BinaryID], List[str]]): Binary data id strings specifying the data to be deleted or `BinaryID` objects.
-            Must be non-empty.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
+            binary_ids (Union[List[~viam.proto.app.data.BinaryID], List[str]]): Binary data ID strings specifying the data to be deleted or
+                :class:`BinaryID` objects. Must be non-empty.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
 
         Raises:
-            GRPCError: If no binary data id strings or `BinaryID` objects are provided.
+            GRPCError: If no binary data ID strings or :class:`BinaryID` objects are provided.
 
         Returns:
             int: The number of items deleted.
@@ -770,13 +927,13 @@ class DataClient:
 
         Args:
             tags (List[str]): List of tags to add to specified binary data. Must be non-empty.
-            binary_ids (Union[List[BinaryID], List[str]]): Binary data id strings specifying the data to be tagged or `BinaryID` objects.
-                Must be non-empty.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
+            binary_ids (Union[List[~viam.proto.app.data.BinaryID], List[str]]): Binary data ID strings specifying the data to be tagged or
+                :class:`BinaryID` objects. Must be non-empty.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
 
         Raises:
-            GRPCError: If no binary data id strings or `BinaryID` objects are provided.
+            GRPCError: If no binary data ID strings or :class:`BinaryID` objects are provided.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#addtagstobinarydatabyids>`_.
         """
@@ -802,8 +959,7 @@ class DataClient:
 
         Args:
             tags (List[str]): List of tags to add to specified binary data. Must be non-empty.
-            filter (viam.proto.app.data.Filter): `Filter` specifying binary data to tag. If no `Filter` is provided, all data will be
-                tagged.
+            filter (~viam.proto.app.data.Filter): Specifies binary data to tag. If none is provided, tags all data.
 
         Raises:
             GRPCError: If no tags are provided.
@@ -843,13 +999,13 @@ class DataClient:
 
         Args:
             tags (List[str]): List of tags to remove from specified binary data. Must be non-empty.
-            binary_ids (Union[List[BinaryID], List[str]]): Binary data id strings specifying the data to be untagged or `BinaryID` objects.
-                Must be non-empty.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
+            binary_ids (Union[List[~viam.proto.app.data.BinaryID], List[str]]): Binary data ID strings specifying the data to be untagged
+                or `BinaryID` objects. Must be non-empty.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
 
         Raises:
-            GRPCError: If no binary_ids or tags are provided.
+            GRPCError: If no binary data ID strings, :class:`BinaryID` objects, or tags are provided.
 
         Returns:
             int: The number of tags removed.
@@ -881,8 +1037,7 @@ class DataClient:
 
         Args:
             tags (List[str]): List of tags to remove from specified binary data.
-            filter (viam.proto.app.data.Filter): `Filter` specifying binary data to untag. If no `Filter` is provided, all data will be
-                untagged.
+            filter (~viam.proto.app.data.Filter): Specifies binary data to untag. If none is provided, removes tags from all data.
 
         Raises:
             GRPCError: If no tags are provided.
@@ -910,8 +1065,7 @@ class DataClient:
             tags = await data_client.tags_by_filter(my_filter)
 
         Args:
-            filter (viam.proto.app.data.Filter): `Filter` specifying data to retrieve from. If no `Filter` is provided, all data tags will
-                return.
+            filter (~viam.proto.app.data.Filter): Specifies subset ofdata to retrieve tags from. If none is provided, returns all tags.
 
         Returns:
             List[str]: The list of tags.
@@ -948,9 +1102,9 @@ class DataClient:
             print(bbox_id)
 
         Args:
-            binary_id (Union[viam.proto.app.data.BinaryID, str]): The binary data id or `BinaryID` of the image to add the bounding box to.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
+            binary_id (Union[~viam.proto.app.data.BinaryID, str]): The binary data ID or :class:`BinaryID` of the image to add the bounding
+                box to. *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data
+                IDs as a list of strings.*
             label (str): A label for the bounding box.
             x_min_normalized (float): Min X value of the bounding box normalized from 0 to 1.
             y_min_normalized (float): Min Y value of the bounding box normalized from 0 to 1.
@@ -999,10 +1153,10 @@ class DataClient:
 
         Args:
             bbox_id (str): The ID of the bounding box to remove.
-            binary_id (Union[viam.proto.app.data.BinaryID, str]): The binary data id or `BinaryID` of the image to remove the bounding box
-            from.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
+            binary_id (Union[~viam.proto.app.data.BinaryID, str]): The binary data ID or :class:`BinaryID` of the image to remove the
+                bounding box from.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#removeboundingboxfromimagebyid>`_.
         """
@@ -1028,8 +1182,8 @@ class DataClient:
             print(bounding_box_labels)
 
         Args:
-            filter (viam.proto.app.data.Filter): `Filter` specifying data to retrieve from. If no `Filter` is provided, all labels will
-                return.
+            filter (~viam.proto.app.data.Filter): Specifies data to retrieve bounding box labels from. If none is provided, returns labels
+            from all data.
 
         Returns:
             List[str]: The list of bounding box labels.
@@ -1049,8 +1203,8 @@ class DataClient:
             hostname = await data_client.get_database_connection(organization_id="<YOUR-ORG-ID>")
 
         Args:
-            organization_id (str): Organization to retrieve the connection for.
-                You can obtain your organization ID from the Viam app's organization settings page.
+            organization_id (str): The ID of the organization you'd like to connect to.
+                To find your organization ID, visit the organization settings page in the Viam app.
 
         Returns:
             str: The hostname of the federated database.
@@ -1073,8 +1227,8 @@ class DataClient:
             )
 
         Args:
-            organization_id (str): The ID of the organization.
-                You can obtain your organization ID from the Viam app's organization settings page.
+            organization_id (str): The ID of the organization you'd like to configure a database user for.
+                To find your organization ID, visit the organization settings page in the Viam app.
             password (str): The password of the user.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#configuredatabaseuser>`_.
@@ -1096,7 +1250,7 @@ class DataClient:
         Args:
             name (str): The name of the dataset being created.
             organization_id (str): The ID of the organization where the dataset is being created.
-                You can obtain your organization ID from the Viam app's organization settings page.
+                To find your organization ID, visit the organization settings page in the Viam app.
 
         Returns:
             str: The dataset ID of the created dataset.
@@ -1118,9 +1272,12 @@ class DataClient:
             print(datasets)
 
         Args:
-            ids (List[str]): The IDs of the datasets being called for. To retrieve these IDs,
-                navigate to your dataset's page in the Viam app,
-                click **...** in the left-hand menu, and click **Copy dataset ID**.
+            ids (List[str]): The IDs of the datasets that you would like to retrieve information about. To retrieve a dataset ID:
+
+                - Navigate to the **DATASETS** tab of the **DATA** page.
+                - Click on the dataset.
+                - Click the **...** menu.
+                - Select **Copy dataset ID**.
 
         Returns:
             Sequence[Dataset]: The list of datasets.
@@ -1143,8 +1300,8 @@ class DataClient:
             print(datasets)
 
         Args:
-            organization_id (str): The ID of the organization.
-                You can obtain your organization ID from the Viam app's organization settings page.
+            organization_id (str): The ID of the organization you'd like to retrieve datasets from.
+                To find your organization ID, visit the organization settings page in the Viam app.
 
         Returns:
             Sequence[Dataset]: The list of datasets in the organization.
@@ -1169,8 +1326,12 @@ class DataClient:
             )
 
         Args:
-            id (str): The ID of the dataset. You can retrieve this by navigating to the **DATASETS** sub-tab of the **DATA** tab,
-                clicking on the dataset, clicking the **...** menu and selecting **Copy dataset ID**.
+            id (str): The ID of the dataset. To retrieve the dataset ID:
+
+                - Navigate to the **DATASETS** tab of the **DATA** page.
+                - Click on the dataset.
+                - Click the **...** menu.
+                - Select **Copy dataset ID**.
             name (str): The new name of the dataset.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#renamedataset>`_.
@@ -1188,8 +1349,12 @@ class DataClient:
             )
 
         Args:
-            id (str): The ID of the dataset. You can retrieve this by navigating to the **DATASETS** sub-tab of the **DATA** tab,
-                clicking on the dataset, clicking the **...** menu and selecting **Copy dataset ID**.
+            id (str): The ID of the dataset. To retrieve the dataset ID:
+
+                    - Navigate to the **DATASETS** tab of the **DATA** page.
+                    - Click on the dataset.
+                    - Click the **...** menu.
+                    - Select **Copy dataset ID**.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#deletedataset>`_.
         """
@@ -1207,24 +1372,27 @@ class DataClient:
                 include_binary_data=False
             )
 
-            my_binary_ids = []
+            my_binary_data_ids = []
 
             for obj in binary_metadata:
-                my_binary_ids.append(
+                my_binary_data_ids.append(
                     obj.metadata.binary_data_id
                     )
 
             await data_client.add_binary_data_to_dataset_by_ids(
-                binary_ids=my_binary_ids,
+                binary_ids=my_binary_data_ids,
                 dataset_id="abcd-1234xyz-8765z-123abc"
             )
 
         Args:
-            binary_ids (List[BinaryID]): The IDs of binary data to add to dataset. To retrieve these IDs,
-                navigate to your data page, click on an image and copy its File ID from the details tab.
-                To retrieve the dataset ID, navigate to your dataset's page in the Viam app,
-                and use the left-hand menu to copy the dataset ID.
-            dataset_id (str): The ID of the dataset to be added to.
+            binary_ids (List[~viam.proto.app.data.BinaryID]): Unique identifiers for binary data to add to the dataset. To retrieve these IDs,
+                navigate to the DATA page, click on an image, and copy its Binary Data ID from the details tab.
+            dataset_id (str): The ID of the dataset to be added to.  To retrieve the dataset ID:
+
+                - Navigate to the **DATASETS** tab of the **DATA** page.
+                - Click on the dataset.
+                - Click the **...** menu.
+                - Select **Copy dataset ID**.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#addbinarydatatodatasetbyids>`_.
         """
@@ -1248,26 +1416,29 @@ class DataClient:
                 include_binary_data=False
             )
 
-            my_binary_ids = []
+            my_binary_data_ids = []
 
             for obj in binary_metadata:
-                my_binary_ids.append(
+                my_binary_data_ids.append(
                     obj.metadata.binary_data_id
                 )
 
             await data_client.remove_binary_data_from_dataset_by_ids(
-                binary_ids=my_binary_ids,
+                binary_ids=my_binary_data_ids,
                 dataset_id="abcd-1234xyz-8765z-123abc"
             )
 
         Args:
-            binary_ids (Union[List[BinaryID], List[str]]): The IDs of binary data to remove from dataset. To retrieve these IDs,
-                navigate to your data page, click on an image and copy its File ID from the details tab. To
-                retrieve the dataset ID, navigate to your dataset's page in the Viam app, and use the
-                left-hand menu to copy the dataset ID.
-                Note: `BinaryID` objects are deprecated and will be removed in a future release. Please use the binary data id field
-                instead.
-            dataset_id (str): The ID of the dataset to be removed from.
+            binary_ids (Union[List[~viam.proto.app.data.BinaryID], List[str]]): Unique identifiers for the binary data to remove from the dataset. To retrieve these IDs,
+                navigate to the DATA page, click on an image and copy its Binary Data ID from the details tab.
+                *DEPRECATED:* :class:`BinaryID` *is deprecated and will be removed in a future release. Instead, pass binary data IDs as a
+                list of strings.*
+            dataset_id (str): The ID of the dataset to be removed from. To retrieve the dataset ID:
+
+                - Navigate to the **DATASETS** tab of the **DATA** page.
+                - Click on the dataset.
+                - Click the **...** menu.
+                - Select **Copy dataset ID**.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#removebinarydatafromdatasetbyids>`_.
         """
@@ -1294,8 +1465,8 @@ class DataClient:
     ) -> str:
         """Upload binary sensor data.
 
-        Upload binary data collected on a robot through a specific component (for example, a motor) along with the relevant metadata to
-        app.viam.com. Binary data can be found under the "Files" subtab of the Data tab on app.viam.com.
+        Upload binary data collected on a robot through a specific component (for example, a motor), along with the relevant metadata.
+        Binary data can be found on the **DATA** page of the Viam app.
 
         ::
 
@@ -1320,19 +1491,19 @@ class DataClient:
             component_type (str): Type of the component used to capture the data (for example, "movement_sensor").
             component_name (str): Name of the component used to capture the data.
             method_name (str): Name of the method used to capture the data.
-            file_extension (str): The file extension of binary data including the period, for example .jpg, .png, .pcd.
-                The backend will route the binary to its corresponding mime type based on this extension. Files with a .jpeg, .jpg,
-                or .png extension will be saved to the images tab.
+            file_extension (str): The file extension of binary data, *including the period*, for example ``.jpg``, ``.png``, ``.pcd``.
+                The backend routes the binary to its corresponding mime type based on this extension. Files with a ``.jpeg``, ``.jpg``,
+                or ``.png`` extension will appear in the **Images** tab.
             method_parameters (Optional[Mapping[str, Any]]): Optional dictionary of method parameters. No longer in active use.
             tags (Optional[List[str]]): Optional list of tags to allow for tag-based data filtering when retrieving data.
             data_request_times (Optional[Tuple[datetime.datetime, datetime.datetime]]): Optional tuple containing datetime objects
-                denoting the times this data was requested[0] by the robot and received[1] from the appropriate sensor.
+                denoting the times this data was requested ``[0]`` by the robot and received ``[1]`` from the appropriate sensor.
 
         Raises:
             GRPCError: If an invalid part ID is passed.
 
         Returns:
-            str: The binary_data_id of the uploaded data.
+            str: The binary data ID of the uploaded data.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#binarydatacaptureupload>`_.
         """
@@ -1375,8 +1546,8 @@ class DataClient:
     ) -> str:
         """Upload tabular sensor data.
 
-        Upload tabular data collected on a robot through a specific component (for example, a motor) along with the relevant metadata to
-        app.viam.com. Tabular data can be found under the "Sensors" subtab of the Data tab on app.viam.com.
+        Upload tabular data collected on a robot through a specific component (for example, a motor), along with the relevant metadata.
+        Tabular data can be found under the **Sensors** tab of the **DATA** page.
 
         ::
 
@@ -1401,24 +1572,24 @@ class DataClient:
 
         Args:
             tabular_data (List[Mapping[str, Any]]): List of the data to be uploaded, represented tabularly as a collection of dictionaries.
-                Must include the key "readings" for sensors.
+                Must include the key ``readings`` for sensors.
             part_id (str): Part ID of the component used to capture the data.
-            component_type (str): Type of the component used to capture the data (for example, "rdk:component:movement_sensor").
+            component_type (str): Type of the component used to capture the data (for example, ``rdk:component:movement_sensor``).
             component_name (str): Name of the component used to capture the data.
             method_name (str): Name of the method used to capture the data.
-            data_request_times (List[Tuple[datetime.datetime, datetime.datetime]]): List of tuples, each containing `datetime` objects
-                denoting the times this data was requested[0] by the robot and received[1] from the appropriate sensor. Passing a list of
-                tabular data and Timestamps with length n > 1 will result in n datapoints being uploaded, all tied to the same metadata.
+            data_request_times (List[Tuple[datetime.datetime, datetime.datetime]]): List of tuples, each containing ``datetime`` objects
+                denoting the times this data was requested ``[0]`` by the robot and received ``[1]`` from the appropriate sensor.
+                Pass a list of tabular data and timestamps with length ``n > 1`` to upload ``n`` datapoints, all with the same metadata.
             method_parameters (Optional[Mapping[str, Any]]): Optional dictionary of method parameters. No longer in active use.
             tags (Optional[List[str]]): Optional list of tags to allow for tag-based data filtering when retrieving data.
 
         Raises:
             GRPCError: If an invalid part ID is passed.
-            ValueError: If a list of `Timestamp` objects is provided and its length does not match the length of the list of tabular
+            ValueError: If the provided list of `Timestamp` objects has a length that does not match the length of the list of tabular
                 data.
 
         Returns:
-            str: The file_id of the uploaded data.
+            str: The file ID of the uploaded data.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#tabulardatacaptureupload>`_.
         """
@@ -1493,22 +1664,22 @@ class DataClient:
             )
 
         Args:
-            data (bytes): the data to be uploaded.
+            data (bytes): The data to be uploaded.
             part_id (str): Part ID of the resource associated with the file.
-            file_ext (str): file extension type for the data. required for determining MIME type.
+            file_ext (str): File extension type for the data. required for determining MIME type.
             component_type (Optional[str]): Optional type of the component associated with the file (for example, "movement_sensor").
             component_name (Optional[str]): Optional name of the component associated with the file.
             method_name (Optional[str]): Optional name of the method associated with the file.
             method_parameters (Optional[str]): Optional dictionary of the method parameters. No longer in active use.
             data_request_times (Optional[Tuple[datetime.datetime, datetime.datetime]]): Optional tuple containing datetime objects
-                denoting the times this data was requested[0] by the robot and received[1] from the appropriate sensor.
+                denoting the times this data was requested ``[0]`` by the robot and received ``[1]`` from the appropriate sensor.
             tags (Optional[List[str]]): Optional list of tags to allow for tag-based filtering when retrieving data.
 
         Raises:
             GRPCError: If an invalid part ID is passed.
 
         Returns:
-            str: The binary_data_id of the uploaded data.
+            str: The binary data ID of the uploaded data.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#streamingdatacaptureupload>`_.
         """
@@ -1553,8 +1724,8 @@ class DataClient:
     ) -> str:
         """Upload arbitrary file data.
 
-        Upload file data that may be stored on a robot along with the relevant metadata to app.viam.com. File data can be found under the
-        "Files" subtab of the Data tab on app.viam.com.
+        Upload file data that may be stored on a robot along with the relevant metadata. File data can be found in the
+        **Files** tab of the **DATA** page.
 
         ::
 
@@ -1572,18 +1743,18 @@ class DataClient:
             component_type (Optional[str]): Optional type of the component associated with the file (for example, "movement_sensor").
             component_name (Optional[str]): Optional name of the component associated with the file.
             method_name (Optional[str]): Optional name of the method associated with the file.
-            file_name (Optional[str]): Optional name of the file. The empty string "" will be assigned as the file name if one isn't
+            file_name (Optional[str]): Optional name of the file. The empty string ``""`` will be assigned as the file name if one isn't
                 provided.
             method_parameters (Optional[str]): Optional dictionary of the method parameters. No longer in active use.
-            file_extension (Optional[str]): Optional file extension. The empty string "" will be assigned as the file extension if one isn't
-                provided. Files with a .jpeg, .jpg, or .png extension will be saved to the images tab.
+            file_extension (Optional[str]): Optional file extension. The empty string ``""`` will be assigned as the file extension if one
+                isn't provided. Files with a ``.jpeg``, ``.jpg``, or ``.png`` extension will be saved to the **Images** tab.
             tags (Optional[List[str]]): Optional list of tags to allow for tag-based filtering when retrieving data.
 
         Raises:
             GRPCError: If an invalid part ID is passed.
 
         Returns:
-            str: ID of the new file.
+            str: Binary data ID of the new file.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#fileupload>`_.
         """
@@ -1613,8 +1784,8 @@ class DataClient:
     ) -> str:
         """Upload arbitrary file data.
 
-        Upload file data that may be stored on a robot along with the relevant metadata to app.viam.com. File data can be found under the
-        "Files" subtab of the Data tab on app.viam.com.
+        Upload file data that may be stored on a robot along with the relevant metadata. File data can be found in the
+        **Files** tab of the **DATA** page.
 
         ::
 
@@ -1639,7 +1810,7 @@ class DataClient:
             FileNotFoundError: If the provided filepath is not found.
 
         Returns:
-            str: ID of the new file.
+            str: Binary data ID of the new file.
 
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#fileuploadfrompath>`_.
         """
@@ -1677,6 +1848,115 @@ class DataClient:
                 raise TypeError("Response cannot be empty")
             return response
 
+    async def get_data_pipeline(self, id: str) -> DataPipeline:
+        """Get a data pipeline by its ID.
+
+        ::
+
+            data_pipeline = await data_client.get_data_pipeline(id="<YOUR-DATA-PIPELINE-ID>")
+
+        Args:
+            id (str): The ID of the data pipeline to get.
+
+        Returns:
+            DataPipeline: The data pipeline with the given ID.
+        """
+        request = GetDataPipelineRequest(id=id)
+        response: GetDataPipelineResponse = await self._data_pipelines_client.GetDataPipeline(request, metadata=self._metadata)
+        return DataClient.DataPipeline.from_proto(response.data_pipeline)
+
+    async def list_data_pipelines(self, organization_id: str) -> List[DataPipeline]:
+        """List all of the data pipelines for an organization.
+
+        ::
+
+            data_pipelines = await data_client.list_data_pipelines(organization_id="<YOUR-ORGANIZATION-ID>")
+
+        Args:
+            organization_id (str): The ID of the organization that owns the pipelines.
+                You can obtain your organization ID from the Viam app's organization settings page.
+
+        Returns:
+            List[DataPipeline]: A list of all of the data pipelines for the given organization.
+        """
+        request = ListDataPipelinesRequest(organization_id=organization_id)
+        response: ListDataPipelinesResponse = await self._data_pipelines_client.ListDataPipelines(request, metadata=self._metadata)
+        return [DataClient.DataPipeline.from_proto(pipeline) for pipeline in response.data_pipelines]
+
+    async def create_data_pipeline(self, organization_id: str, name: str, mql_binary: List[Dict[str, Any]], schedule: str) -> str:
+        """Create a new data pipeline.
+
+        ::
+
+            data_pipeline_id = await data_client.create_data_pipeline(
+                organization_id="<YOUR-ORGANIZATION-ID>",
+                name="<YOUR-PIPELINE-NAME>",
+                mql_binary=[<YOUR-MQL-PIPELINE-AGGREGATION>],
+                schedule="<YOUR-SCHEDULE>"
+            )
+
+        Args:
+            organization_id (str): The ID of the organization that will own the pipeline.
+                You can obtain your organization ID from the Viam app's organization settings page.
+            name (str): The name of the pipeline.
+            mql_binary (List[Dict[str, Any]]):The MQL pipeline to run, as a list of MongoDB aggregation pipeline stages.
+            schedule (str): A cron expression representing the expected execution schedule in UTC (note this also
+                defines the input time window; an hourly schedule would process 1 hour of data at a time).
+
+        Returns:
+            str: The ID of the newly created pipeline.
+        """
+        binary: List[bytes] = [bson.encode(query) for query in mql_binary]
+        request = CreateDataPipelineRequest(organization_id=organization_id, name=name, mql_binary=binary, schedule=schedule)
+        response: CreateDataPipelineResponse = await self._data_pipelines_client.CreateDataPipeline(request, metadata=self._metadata)
+        return response.id
+
+    async def delete_data_pipeline(self, id: str) -> None:
+        """Delete a data pipeline by its ID.
+
+        ::
+
+            await data_client.delete_data_pipeline(id="<YOUR-DATA-PIPELINE-ID>")
+
+        Args:
+            id (str): The ID of the data pipeline to delete.
+        """
+        request = DeleteDataPipelineRequest(id=id)
+        await self._data_pipelines_client.DeleteDataPipeline(request, metadata=self._metadata)
+
+    async def list_data_pipeline_runs(self, id: str, page_size: int = 10) -> DataPipelineRunsPage:
+        """List all of the data pipeline runs for a data pipeline.
+
+        ::
+
+            data_pipeline_runs = await data_client.list_data_pipeline_runs(id="<YOUR-DATA-PIPELINE-ID>")
+            while len(data_pipeline_runs.runs) > 0:
+                data_pipeline_runs = await data_pipeline_runs.next_page()
+
+        Args:
+            id (str): The ID of the pipeline to list runs for
+            page_size (int): The number of runs to return per page. Defaults to 10.
+
+        Returns:
+            DataPipelineRunsPage: A page of data pipeline runs with pagination support
+        """
+        return await self._list_data_pipeline_runs(id, page_size)
+
+    async def _list_data_pipeline_runs(self, id: str, page_size: int, page_token: str = "") -> DataPipelineRunsPage:
+        """Internal method to list data pipeline runs with pagination.
+
+        Args:
+            id (str): The ID of the pipeline to list runs for
+            page_size (int): The number of runs to return per page
+            page_token (str): The token to use to get the next page of results
+
+        Returns:
+            DataPipelineRunsPage: A page of data pipeline runs with pagination support
+        """
+        request = ListDataPipelineRunsRequest(id=id, page_size=page_size, page_token=page_token)
+        response: ListDataPipelineRunsResponse = await self._data_pipelines_client.ListDataPipelineRuns(request, metadata=self._metadata)
+        return DataClient.DataPipelineRunsPage.from_proto(response, self, page_size)
+
     @staticmethod
     def create_filter(
         component_name: Optional[str] = None,