IBMExperimentService.analysis_results#

IBMExperimentService.analysis_results(limit=10, json_decoder=<class 'json.decoder.JSONDecoder'>, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', creation_datetime_after=None, creation_datetime_before=None, sort_by=None, **filters)[source]#

Retrieve all analysis results, with optional filtering.

Parameters:

  • limit (Optional[int]) – Number of analysis results to retrieve.

  • json_decoder (Type[JSONDecoder]) – Custom JSON decoder to use to decode the retrieved analysis results.

  • device_components (Optional[List[Union[str, DeviceComponent]]]) – Filter by device components.

  • device_components_operator (Optional[str]) –

    Operator used when filtering by device components. Valid values are None and “contains”:

    • If None, an analysis result’s device components must match exactly for it to be included.

    • If “contains” is specified, an analysis result’s device components must contain at least the values specified by the device_components filter.

  • experiment_id (Optional[str]) – Experiment ID used for filtering.

  • result_type (Optional[str]) – Analysis result type used for filtering.

  • result_type_operator (Optional[str]) –

    Operator used when filtering by result type. Valid values are None and “like”:

    • If None is specified, an analysis result’s type value must match exactly for it to be included.

    • If “like” is specified, an analysis result’s type value must contain the value specified by result_type. For example, result_type="foo", result_type_operator="like" will match both foo1 and 1foo.

  • backend_name (Optional[str]) – Backend name used for filtering.

  • quality (Union[List[Union[ResultQuality, str]], ResultQuality, str, None]) – Quality value used for filtering. If a list is given, analysis results whose quality value is in the list will be included.

  • verified (Optional[bool]) – Indicates whether this result has been verified..

  • tags (Optional[List[str]]) – Filter by tags assigned to analysis results. This can be used with tags_operator for granular filtering.

  • tags_operator (Optional[str]) –

    Logical operator to use when filtering by tags. Valid values are “AND” and “OR”:

    • If “AND” is specified, then an analysis result must have all of the tags specified in tags to be included.

    • If “OR” is specified, then an analysis result only needs to have any of the tags specified in tags to be included.

  • creation_datetime_after (Optional[datetime]) – Filter by the given creation timestamp, in local time. This is used to find analysis results whose creation date/time is after (greater than or equal to) this local timestamp.

  • creation_datetime_before (Optional[datetime]) – Filter by the given creation timestamp, in local time. This is used to find analysis results whose creation date/time is before (less than or equal to) this local timestamp.

  • sort_by (Union[str, List[str], None]) – Specifies how the output should be sorted. This can be a single sorting option or a list of options. Each option should contain a sort key and a direction. Valid sort keys are “creation_datetime”, “device_components”, and “result_type”. Valid directions are “asc” for ascending or “desc” for descending. For example, sort_by=["result_type: asc", "creation_datetime:desc"] will return an output list that is first sorted by result type in ascending order, then by creation datetime by descending order. By default, analysis results are sorted by creation_datetime descending and result_id ascending.

  • **filters (Any) – Additional filtering keywords that are not supported and will be ignored.

Return type:

List[AnalysisResultData]

Returns:

A list of analysis results. Each analysis result is a dictionary containing the retrieved analysis result.

Raises:

  • ValueError – If an invalid parameter value is specified.

  • IBMApiError – If the request to the server failed.