ni.datastore 0.1.0.dev4__tar.gz → 0.1.0.dev5__tar.gz

{ni_datastore-0.1.0.dev4 → ni_datastore-0.1.0.dev5}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.3
 Name: ni.datastore
-Version: 0.1.0.dev4
-Summary: APIs for publishing and retrieving data from the NI Measurement Data Store
+Version: 0.1.0.dev5
+Summary: APIs for publishing and retrieving data from NI Measurement Data Services
 License: MIT
 Keywords: datastore
 Author: NI
 Author-email: opensource@ni.com
 Maintainer: Johann Scholtz
 Maintainer-email: johann.scholtz@emerson.com
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Manufacturing
@@ -17,16 +17,16 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: hightime (>=0.3.0.dev0)
 Requires-Dist: ni-datamonikers-v1-client (>=0.1.0.dev1)
-Requires-Dist: ni-measurements-data-v1-client (>=0.1.0.dev2)
-Requires-Dist: ni-measurements-metadata-v1-client (>=0.1.0.dev2)
+Requires-Dist: ni-measurements-data-v1-client (>=0.2.0.dev1)
+Requires-Dist: ni-measurements-metadata-v1-client (>=0.2.0.dev1)
 Requires-Dist: ni-protobuf-types (>=1.0.1.dev0)
 Requires-Dist: protobuf (>=4.21)
 Description-Content-Type: text/markdown
@@ -34,21 +34,23 @@ Description-Content-Type: text/markdown
 # Table of Contents
 
 - [Table of Contents](#table-of-contents)
+- [Measurement Data Services API for Python](#measurement-data-services-api-for-python)
 - [About](#about)
   - [Operating System Support](#operating-system-support)
   - [Python Version Support](#python-version-support)
+  - [Installation](#installation)
 
-# Measurement Data Store API for Python
+# Measurement Data Services API for Python
 
 `datastore-python` contains Python code for writing to and reading from
-the [NI Measurement Data Store](https://github.com/ni/datastore-service).
+[NI Measurement Data Services](https://github.com/ni/datastore-service).
 It will include examples of how to use the Python API.
 
 # About
 
 `ni.datastore` is the main Python package in this repo that
 provides APIs for publishing and retrieving data from the NI
-Measurement Data Store
+Measurement Data Services
 
 NI created and supports this package.
 
@@ -58,10 +60,14 @@ NI created and supports this package.
 
 ## Python Version Support
 
-`ni.datastore` supports CPython 3.9+.
+`ni.datastore` supports CPython 3.10+.
 
 ## Installation
 
+As a prerequisite to using the `ni.datastore` module, you must install Measurement Data Services
+Software 2026 Q1 or later on your system. You can download and install this software using
+[NI Package Manager](https://www.ni.com/en/support/downloads/software-products/download.package-manager.html).
+
 You can directly install the `ni.datastore` package using `pip` or by listing it as a
 dependency in your project's `pyproject.toml` file.
 

{ni_datastore-0.1.0.dev4 → ni_datastore-0.1.0.dev5}/README.md

@@ -1,21 +1,23 @@
 # Table of Contents
 
 - [Table of Contents](#table-of-contents)
+- [Measurement Data Services API for Python](#measurement-data-services-api-for-python)
 - [About](#about)
   - [Operating System Support](#operating-system-support)
   - [Python Version Support](#python-version-support)
+  - [Installation](#installation)
 
-# Measurement Data Store API for Python
+# Measurement Data Services API for Python
 
 `datastore-python` contains Python code for writing to and reading from
-the [NI Measurement Data Store](https://github.com/ni/datastore-service).
+[NI Measurement Data Services](https://github.com/ni/datastore-service).
 It will include examples of how to use the Python API.
 
 # About
 
 `ni.datastore` is the main Python package in this repo that
 provides APIs for publishing and retrieving data from the NI
-Measurement Data Store
+Measurement Data Services
 
 NI created and supports this package.
 
@@ -25,9 +27,13 @@ NI created and supports this package.
 
 ## Python Version Support
 
-`ni.datastore` supports CPython 3.9+.
+`ni.datastore` supports CPython 3.10+.
 
 ## Installation
 
+As a prerequisite to using the `ni.datastore` module, you must install Measurement Data Services
+Software 2026 Q1 or later on your system. You can download and install this software using
+[NI Package Manager](https://www.ni.com/en/support/downloads/software-products/download.package-manager.html).
+
 You can directly install the `ni.datastore` package using `pip` or by listing it as a
 dependency in your project's `pyproject.toml` file.

{ni_datastore-0.1.0.dev4 → ni_datastore-0.1.0.dev5}/pyproject.toml

@@ -1,8 +1,8 @@
 [project]
 name = "ni.datastore"
-version = "0.1.0.dev4"
+version = "0.1.0.dev5"
 license = "MIT"
-description = "APIs for publishing and retrieving data from the NI Measurement Data Store"
+description = "APIs for publishing and retrieving data from NI Measurement Data Services"
 authors = [{name = "NI", email = "opensource@ni.com"}]
 maintainers = [
   {name = "Johann Scholtz", email = "johann.scholtz@emerson.com"},
@@ -20,26 +20,26 @@ classifiers = [
   "Operating System :: Microsoft :: Windows",
   "Operating System :: POSIX",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: Implementation :: CPython",
 ]
 dynamic = ["dependencies"]
-requires-python = '>=3.9,<4.0'
+requires-python = '>=3.10,<4.0'
 
 [tool.poetry]
 packages = [{include = "ni", from = "src"}]
 requires-poetry = '>=2.1,<3.0'
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 protobuf = {version=">=4.21"}
 ni-datamonikers-v1-client = { version = ">=0.1.0.dev1", allow-prereleases = true }
-ni-measurements-data-v1-client = { version = ">=0.1.0.dev2", allow-prereleases = true }
-ni-measurements-metadata-v1-client = { version = ">=0.1.0.dev2", allow-prereleases = true }
+ni-measurements-data-v1-client = { version = ">=0.2.0.dev1", allow-prereleases = true }
+ni-measurements-metadata-v1-client = { version = ">=0.2.0.dev1", allow-prereleases = true }
 ni-protobuf-types = { version = ">=1.0.1.dev0", allow-prereleases = true }
 hightime = { version = ">=0.3.0.dev0", allow-prereleases = true }
 
@@ -70,7 +70,6 @@ optional = true
 [tool.poetry.group.docs.dependencies]
 # The latest Sphinx requires a recent Python version.
 Sphinx = [
-  { version = ">=7.4", python = ">=3.9,<3.10" },
   { version = ">=8.1", python = ">=3.10,<3.11" },
   { version = ">=8.2", python = "^3.11" },
 ]

{ni_datastore-0.1.0.dev4 → ni_datastore-0.1.0.dev5}/src/ni/datastore/data/__init__.py

@@ -1,12 +1,13 @@
 """Public API for accessing the NI Data Store."""
 
-from ni.datamonikers.v1.data_moniker_pb2 import Moniker
 from ni.datastore.data._data_store_client import DataStoreClient
+from ni.datastore.data._types._error_information import ErrorInformation
+from ni.datastore.data._types._moniker import Moniker
+from ni.datastore.data._types._outcome import Outcome
 from ni.datastore.data._types._published_condition import PublishedCondition
 from ni.datastore.data._types._published_measurement import PublishedMeasurement
 from ni.datastore.data._types._step import Step
 from ni.datastore.data._types._test_result import TestResult
-from ni.measurements.data.v1.data_store_pb2 import ErrorInformation, Outcome
 
 __all__ = [
     "DataStoreClient",

{ni_datastore-0.1.0.dev4 → ni_datastore-0.1.0.dev5}/src/ni/datastore/data/_data_store_client.py

@@ -13,7 +13,6 @@ from urllib.parse import urlparse
 import hightime as ht
 from grpc import Channel
 from ni.datamonikers.v1.client import MonikerClient
-from ni.datamonikers.v1.data_moniker_pb2 import Moniker
 from ni.datastore.data._grpc_conversion import (
     get_publish_measurement_timestamp,
     populate_publish_condition_batch_request_values,
@@ -22,16 +21,15 @@ from ni.datastore.data._grpc_conversion import (
     populate_publish_measurement_request_value,
     unpack_and_convert_from_protobuf_any,
 )
+from ni.datastore.data._types._error_information import ErrorInformation
+from ni.datastore.data._types._moniker import Moniker
+from ni.datastore.data._types._outcome import Outcome
 from ni.datastore.data._types._published_condition import PublishedCondition
 from ni.datastore.data._types._published_measurement import PublishedMeasurement
 from ni.datastore.data._types._step import Step
 from ni.datastore.data._types._test_result import TestResult
 from ni.measurementlink.discovery.v1.client import DiscoveryClient
 from ni.measurements.data.v1.client import DataStoreClient as DataStoreServiceClient
-from ni.measurements.data.v1.data_store_pb2 import (
-    ErrorInformation,
-    Outcome,
-)
 from ni.measurements.data.v1.data_store_service_pb2 import (
     CreateStepRequest,
     CreateTestResultRequest,
@@ -151,7 +149,30 @@ class DataStoreClient:
         value: object,
         step_id: str,
     ) -> PublishedCondition:
-        """Publish a condition value to the data store."""
+        """Publish a condition value to the data store.
+
+        Args:
+            condition_name: An identifier describing the condition value.
+                For example, "Voltage" or "Temperature".
+
+            type: The type of this condition. For example, "Upper Limit",
+                "Environment", or "Setup".
+
+            value: The single value for this condition to publish on the test
+                step. This should be a scalar value that can be converted to
+                the appropriate protobuf scalar type.
+
+            step_id: The ID of the step associated with this condition. This
+                value is expected to be a parsable GUID.
+
+        Returns:
+            PublishedCondition: The published condition containing:
+                - A moniker for retrieving the condition data (returns a
+                  Vector)
+                - The unique ID of the condition for referencing in queries
+                - Metadata including condition name, type, step ID and test
+                  result ID
+        """
         publish_request = PublishConditionRequest(
             condition_name=condition_name,
             type=type,
@@ -164,7 +185,31 @@ class DataStoreClient:
     def publish_condition_batch(
         self, condition_name: str, type: str, values: object, step_id: str
     ) -> PublishedCondition:
-        """Publish a batch of N values for a condition to the data store."""
+        """Publish a batch of N values for a condition to the data store.
+
+        Args:
+            condition_name: An identifier describing the condition values.
+                For example, "Voltage" or "Temperature".
+
+            type: The type of this condition. For example, "Upper Limit",
+                "Environment", or "Setup".
+
+            values: The values for this condition across all publishes on the
+                test step. This should be a Vector of N values.
+
+            step_id: The ID of the step associated with this batch of condition
+                values. This value is expected to be a parsable GUID.
+
+        Returns:
+            PublishedCondition: Represents all the values published with
+                this call, containing:
+
+                - A moniker for retrieving the condition data (returns a
+                  Vector)
+                - The unique ID of the condition for referencing in queries
+                - Metadata including condition name, type, step ID and test
+                  result ID
+        """
         publish_request = PublishConditionBatchRequest(
             condition_name=condition_name,
             type=type,
@@ -180,19 +225,74 @@ class DataStoreClient:
         value: object,  # More strongly typed Union[bool, AnalogWaveform] can be used if needed
         step_id: str,
         timestamp: ht.datetime | None = None,
-        outcome: Outcome.ValueType = Outcome.OUTCOME_UNSPECIFIED,
+        outcome: Outcome = Outcome.UNSPECIFIED,
         error_information: ErrorInformation | None = None,
         hardware_item_ids: Iterable[str] = tuple(),
         test_adapter_ids: Iterable[str] = tuple(),
         software_item_ids: Iterable[str] = tuple(),
         notes: str = "",
     ) -> PublishedMeasurement:
-        """Publish a measurement value to the data store."""
+        """Publish a single measurement value associated with a test step.
+
+        Args:
+            measurement_name: The name used for associating/grouping
+                conceptually alike measurements across multiple publish
+                iterations. For example, "Temperature" can be used for
+                associating temperature readings across multiple iterations.
+
+            value: The value of the measurement being published. Supported types:
+
+                - Scalar: Single float, int, str or boolean
+                - Vector: Array of float, int, str or boolean values
+                - DoubleAnalogWaveform: Analog waveform with double precision
+                - DoubleXYData: XY coordinate data with double precision
+                - I16AnalogWaveform: Analog waveform with 16-bit integer precision
+                - DoubleComplexWaveform: Complex waveform with double precision
+                - I16ComplexWaveform: Complex waveform with 16-bit integer precision
+                - DoubleSpectrum: Frequency spectrum data with double precision
+                - DigitalWaveform: Digital waveform data
+
+            step_id: The ID of the step associated with this measurement. This
+                value is expected to be a parsable GUID.
+
+            timestamp: The timestamp of the measurement. If None, the current
+                time will be used.
+
+            outcome: The outcome of the measurement (PASSED, FAILED,
+                INDETERMINATE, or UNSPECIFIED).
+
+            error_information: Error or exception information in case of
+                measurement failure.
+
+            hardware_item_ids: The IDs of the hardware items associated with
+                this measurement. These values are expected to be parsable
+                GUIDs or aliases.
+
+            test_adapter_ids: The IDs of the test adapters associated with this
+                measurement. These values are expected to be parsable GUIDs or
+                aliases.
+
+            software_item_ids: The IDs of the software items associated with
+                this measurement. These values are expected to be parsable
+                GUIDs or aliases.
+
+            notes: Any notes to be associated with the captured measurement.
+
+        Returns:
+            PublishedMeasurement: The moniker of the published measurement and
+                its metadata, including:
+                - A moniker for retrieving the measurement data
+                - Associated conditions from the test step
+                - Measurement metadata (name, type, timestamps, outcome)
+                - Associated hardware, software, and test adapter IDs
+        """
         publish_request = PublishMeasurementRequest(
             measurement_name=measurement_name,
             step_id=step_id,
-            outcome=outcome,
-            error_information=error_information,
+            outcome=outcome.to_protobuf(),
+            error_information=(
+                error_information.to_protobuf() if error_information is not None else None
+            ),
             hardware_item_ids=hardware_item_ids,
             test_adapter_ids=test_adapter_ids,
             software_item_ids=software_item_ids,
@@ -211,22 +311,75 @@ class DataStoreClient:
         values: object,
         step_id: str,
         timestamps: Iterable[ht.datetime] = tuple(),
-        outcomes: Iterable[Outcome.ValueType] = tuple(),
+        outcomes: Iterable[Outcome] = tuple(),
         error_information: Iterable[ErrorInformation] = tuple(),
         hardware_item_ids: Iterable[str] = tuple(),
         test_adapter_ids: Iterable[str] = tuple(),
         software_item_ids: Iterable[str] = tuple(),
+        notes: str = "",
     ) -> Sequence[PublishedMeasurement]:
-        """Publish a batch of N values of a measurement to the data store."""
+        """Publish multiple scalar measurements at once for parametric sweeps.
+
+        Args:
+            measurement_name: The name used for associating/grouping
+                conceptually alike measurements across multiple publish
+                iterations. For example, "Temperature" can be used for
+                associating temperature readings across multiple iterations.
+
+            values: The values of the (scalar) measurement being published
+                across N iterations.
+
+            step_id: The ID of the step associated with this measurement. This
+                value is expected to be a parsable GUID.
+
+            timestamps: The timestamps corresponding to the N iterations of
+                batched measurement being published. Can be empty (no timestamp
+                info), single value (applied to all), or N values (one per
+                measurement).
+
+            outcomes: The outcomes corresponding to the N iterations of batched
+                measurement being published. Can be empty (no outcome info),
+                single value (applied to all), or N values (one per
+                measurement).
+
+            error_information: The error information corresponding to the N
+                iterations of batched measurement being published. Can be empty
+                (no error info), single value (applied to all), or N values
+                (one per measurement).
+
+            hardware_item_ids: The IDs of the hardware items associated with
+                this measurement. These values are expected to be parsable
+                GUIDs or aliases.
+
+            test_adapter_ids: The IDs of the test adapters associated with this
+                measurement. These values are expected to be parsable GUIDs or
+                aliases.
+
+            software_item_ids: The IDs of the software items associated with
+                this measurement. These values are expected to be parsable
+                GUIDs or aliases.
+
+            notes: Any notes to be associated with the published measurements.
+
+        Returns:
+            Sequence[PublishedMeasurement]: The monikers of the published
+                measurements and their corresponding metadata. NOTE: Using
+                a Sequence is for future flexibility. This sequence
+                will currently always have a single PublishedMeasurement
+                returned.
+        """
         publish_request = PublishMeasurementBatchRequest(
             measurement_name=measurement_name,
             step_id=step_id,
-            timestamp=[hightime_datetime_to_protobuf(ts) for ts in timestamps],
-            outcome=outcomes,
-            error_information=error_information,
+            timestamps=[hightime_datetime_to_protobuf(ts) for ts in timestamps],
+            outcomes=[outcome.to_protobuf() for outcome in outcomes],
+            error_information=(
+                [ei.to_protobuf() for ei in (error_information or [])] if error_information else []
+            ),
             hardware_item_ids=hardware_item_ids,
             test_adapter_ids=test_adapter_ids,
             software_item_ids=software_item_ids,
+            notes=notes,
         )
         populate_publish_measurement_batch_request_values(publish_request, values)
         publish_response = self._get_data_store_client().publish_measurement_batch(publish_request)
@@ -252,51 +405,132 @@ class DataStoreClient:
         moniker_source: Moniker | PublishedMeasurement | PublishedCondition,
         expected_type: Type[TRead] | None = None,
     ) -> TRead | object:
-        """Read data published to the data store."""
+        """Read data published to the data store.
+
+        Args:
+            moniker_source: The source from which to read data. Can be:
+                - A Moniker (wrapper type) directly
+                - A PublishedMeasurement (uses its moniker)
+                - A PublishedCondition (uses its moniker)
+
+            expected_type: Optional type to validate the returned data against.
+                If provided, a TypeError will be raised if the actual data type
+                doesn't match.
+
+        Returns:
+            The data retrieved from the data store. The return type depends on
+            what was originally published:
+            - Scalar measurements return as Vectors
+            - Other types are returned as originally published
+            If expected_type is specified, the return value is guaranteed to be
+            of that type.
+
+        Raises:
+            ValueError: If the moniker_source doesn't have a valid moniker.
+            TypeError: If expected_type is provided and the actual data type
+                doesn't match.
+        """
+        from ni.datamonikers.v1.data_moniker_pb2 import Moniker as MonikerProto
+
+        moniker_proto: MonikerProto
+
         if isinstance(moniker_source, Moniker):
-            moniker = moniker_source
+            moniker_proto = moniker_source.to_protobuf()
         elif isinstance(moniker_source, PublishedMeasurement):
             if moniker_source.moniker is None:
                 raise ValueError("PublishedMeasurement must have a Moniker to read data")
-            moniker = moniker_source.moniker
+            moniker_proto = moniker_source.moniker.to_protobuf()
         elif isinstance(moniker_source, PublishedCondition):
             if moniker_source.moniker is None:
                 raise ValueError("PublishedCondition must have a Moniker to read data")
-            moniker = moniker_source.moniker
+            moniker_proto = moniker_source.moniker.to_protobuf()
+        else:
+            raise TypeError(f"Unsupported moniker_source type: {type(moniker_source)}")
 
-        moniker_client = self._get_moniker_client(moniker.service_location)
-        read_result = moniker_client.read_from_moniker(moniker)
+        moniker_client = self._get_moniker_client(moniker_proto.service_location)
+        read_result = moniker_client.read_from_moniker(moniker_proto)
         converted_data = unpack_and_convert_from_protobuf_any(read_result.value)
         if expected_type is not None and not isinstance(converted_data, expected_type):
             raise TypeError(f"Expected type {expected_type}, got {type(converted_data)}")
         return converted_data
 
     def create_step(self, step: Step) -> str:
-        """Create a step in the data store."""
+        """Create a new step in the data store.
+
+        A step is owned by a test result and is a logical grouping of published
+        measurements and conditions. All measurements and conditions must be
+        associated with a step.
+
+        Args:
+            step: The metadata of the step to be created.
+
+        Returns:
+            str: The identifier of the created step.
+        """
         create_request = CreateStepRequest(step=step.to_protobuf())
         create_response = self._get_data_store_client().create_step(create_request)
         return create_response.step_id
 
     def get_step(self, step_id: str) -> Step:
-        """Get a step from the data store."""
+        """Get the step associated with the given identifier.
+
+        Args:
+            step_id: The identifier of the desired step.
+
+        Returns:
+            Step: The metadata of the requested step.
+        """
         get_request = GetStepRequest(step_id=step_id)
         get_response = self._get_data_store_client().get_step(get_request)
         return Step.from_protobuf(get_response.step)
 
     def create_test_result(self, test_result: TestResult) -> str:
-        """Create a test result in the data store."""
+        """Create a test result object for publishing measurements.
+
+        Once a test result is created, you can publish an arbitrary number of
+        measurements and conditions to a step which is owned by the test result.
+
+        Args:
+            test_result: The metadata of the test result to be created.
+
+        Returns:
+            str: The test result ID. Generated if not specified in the request.
+        """
         create_request = CreateTestResultRequest(test_result=test_result.to_protobuf())
         create_response = self._get_data_store_client().create_test_result(create_request)
         return create_response.test_result_id
 
     def get_test_result(self, test_result_id: str) -> TestResult:
-        """Get a test result from the data store."""
+        """Get the test result associated with the given identifier.
+
+        Args:
+            test_result_id: The ID of the desired test result. This value is
+                expected to be a parsable GUID.
+
+        Returns:
+            TestResult: The TestResult object that corresponds to the
+                requested ID.
+        """
         get_request = GetTestResultRequest(test_result_id=test_result_id)
         get_response = self._get_data_store_client().get_test_result(get_request)
         return TestResult.from_protobuf(get_response.test_result)
 
     def query_conditions(self, odata_query: str = "") -> Sequence[PublishedCondition]:
-        """Query conditions from the data store."""
+        """Query conditions using OData query syntax.
+
+        Args:
+            odata_query: An OData query string. Example: "$filter=name eq
+                'Value'". An empty string will return all conditions. $expand,
+                $count, and $select are not supported. For more information,
+                see https://learn.microsoft.com/en-us/odata/concepts/
+                queryoptions-overview.
+
+        Returns:
+            Sequence[PublishedCondition]: The list of matching conditions. Each
+                item contains a moniker for retrieving the condition
+                measurements, as well as the metadata associated with the
+                condition.
+        """
         query_request = QueryConditionsRequest(odata_query=odata_query)
         query_response = self._get_data_store_client().query_conditions(query_request)
         return [
@@ -305,7 +539,20 @@ class DataStoreClient:
         ]
 
     def query_measurements(self, odata_query: str = "") -> Sequence[PublishedMeasurement]:
-        """Query measurements from the data store."""
+        """Query measurements using OData query syntax.
+
+        Args:
+            odata_query: An OData query string. Example: "$filter=name eq
+                'Value'". An empty string will return all measurements.
+                $expand, $count, and $select are not supported. For more
+                information, see https://learn.microsoft.com/en-us/odata/
+                concepts/queryoptions-overview.
+
+        Returns:
+            Sequence[PublishedMeasurement]: The list of matching measurements.
+                Each item contains a moniker for retrieving the measurement, as
+                well as the metadata associated with the measurement.
+        """
         query_request = QueryMeasurementsRequest(odata_query=odata_query)
         query_response = self._get_data_store_client().query_measurements(query_request)
         return [
@@ -314,7 +561,21 @@ class DataStoreClient:
         ]
 
     def query_test_results(self, odata_query: str = "") -> Sequence[TestResult]:
-        """Query test results from the data store."""
+        """Query test results using OData query syntax.
+
+        Args:
+            odata_query: An OData query string. Example: "$filter=name eq
+                'Value'". An empty string will return all test results.
+                $expand, $count, and $select are not supported. For more
+                information, see https://learn.microsoft.com/en-us/odata/
+                concepts/queryoptions-overview.
+
+        Returns:
+            Sequence[TestResult]: The list of matching test results. Each
+                item contains the metadata associated with the test result,
+                including test result ID, name, timestamps, and other
+                properties.
+        """
         query_request = QueryTestResultsRequest(odata_query=odata_query)
         query_response = self._get_data_store_client().query_test_results(query_request)
         return [
@@ -322,7 +583,18 @@ class DataStoreClient:
         ]
 
     def query_steps(self, odata_query: str = "") -> Sequence[Step]:
-        """Query steps from the data store."""
+        """Query for steps matching the given OData query.
+
+        Args:
+            odata_query: An OData query string. Example: "$filter=name eq
+                'Value'". An empty string will return all steps. $expand,
+                $count, and $select are not supported. For more information,
+                see https://learn.microsoft.com/en-us/odata/concepts/
+                queryoptions-overview.
+
+        Returns:
+            Sequence[Step]: The list of steps that match the query.
+        """
         query_request = QueryStepsRequest(odata_query=odata_query)
         query_response = self._get_data_store_client().query_steps(query_request)
         return [Step.from_protobuf(step) for step in query_response.steps]