Merge pull request #3 from ionq/add-get-job-probabilities

splch · web-flow · commit 303802991b31 · 2026-04-09T20:58:51.000+09:00
Add get_job_probabilities endpoint via overlay
diff --git a/.github/workflows/generated.yml b/.github/workflows/generated.yml
@@ -36,6 +36,7 @@ jobs:
             --path /tmp/patched-spec.json \
             --meta none \
             --config openapi-python-client-config.yaml \
+            --custom-template-path custom-templates \
             --output-path ionq_core \
             --overwrite
       - name: Check for uncommitted changes
diff --git a/custom-templates/package_init.py.jinja b/custom-templates/package_init.py.jinja
@@ -0,0 +1,53 @@
+{% from "helpers.jinja" import safe_docstring %}
+
+{{ safe_docstring(package_description) }}
+from ._exceptions import (
+    APIConnectionError,
+    APIError,
+    APITimeoutError,
+    AuthenticationError,
+    BadRequestError,
+    IonQError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    ServerError,
+)
+from ._extensions import AsyncEventHook, ClientExtension, EventHook
+from ._pagination import aiter_jobs, aiter_session_jobs, iter_jobs, iter_session_jobs
+from ._polling import (
+    JobFailedError,
+    JobTimeoutError,
+    async_wait_for_job,
+    wait_for_job,
+)
+from .client import AuthenticatedClient, Client
+from .ionq_client import IonQClient, __version__
+
+__all__ = (
+    "APIConnectionError",
+    "APIError",
+    "APITimeoutError",
+    "AsyncEventHook",
+    "AuthenticatedClient",
+    "AuthenticationError",
+    "BadRequestError",
+    "Client",
+    "ClientExtension",
+    "EventHook",
+    "IonQClient",
+    "IonQError",
+    "JobFailedError",
+    "JobTimeoutError",
+    "NotFoundError",
+    "PermissionDeniedError",
+    "RateLimitError",
+    "ServerError",
+    "__version__",
+    "aiter_jobs",
+    "aiter_session_jobs",
+    "async_wait_for_job",
+    "iter_jobs",
+    "iter_session_jobs",
+    "wait_for_job",
+)
diff --git a/ionq_core/api/default/get_job_probabilities.py b/ionq_core/api/default/get_job_probabilities.py
@@ -0,0 +1,175 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.get_job_probabilities_response_200 import GetJobProbabilitiesResponse200
+from typing import cast
+
+
+
+def _get_kwargs(
+    uuid: str,
+
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/jobs/{uuid}/results/probabilities".format(uuid=quote(str(uuid), safe=""),),
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | GetJobProbabilitiesResponse200 | None:
+    if response.status_code == 200:
+        response_200 = GetJobProbabilitiesResponse200.from_dict(response.json())
+
+
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any | GetJobProbabilitiesResponse200]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    uuid: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Any | GetJobProbabilitiesResponse200]:
+    """ Fetch the probability distribution for a completed job.
+
+    Args:
+        uuid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | GetJobProbabilitiesResponse200]
+     """
+
+
+    kwargs = _get_kwargs(
+        uuid=uuid,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    uuid: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Any | GetJobProbabilitiesResponse200 | None:
+    """ Fetch the probability distribution for a completed job.
+
+    Args:
+        uuid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | GetJobProbabilitiesResponse200
+     """
+
+
+    return sync_detailed(
+        uuid=uuid,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    uuid: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Any | GetJobProbabilitiesResponse200]:
+    """ Fetch the probability distribution for a completed job.
+
+    Args:
+        uuid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | GetJobProbabilitiesResponse200]
+     """
+
+
+    kwargs = _get_kwargs(
+        uuid=uuid,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    uuid: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Any | GetJobProbabilitiesResponse200 | None:
+    """ Fetch the probability distribution for a completed job.
+
+    Args:
+        uuid (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | GetJobProbabilitiesResponse200
+     """
+
+
+    return (await asyncio_detailed(
+        uuid=uuid,
+client=client,
+
+    )).parsed
diff --git a/ionq_core/models/__init__.py b/ionq_core/models/__init__.py
@@ -43,6 +43,7 @@
 from .get_job_estimate_query_params import GetJobEstimateQueryParams
 from .get_job_estimate_response import GetJobEstimateResponse
 from .get_job_estimate_response_rate_information import GetJobEstimateResponseRateInformation
+from .get_job_probabilities_response_200 import GetJobProbabilitiesResponse200
 from .get_job_response import GetJobResponse
 from .get_jobs_query_params import GetJobsQueryParams
 from .get_jobs_response import GetJobsResponse
@@ -155,6 +156,7 @@
     "GetJobEstimateQueryParams",
     "GetJobEstimateResponse",
     "GetJobEstimateResponseRateInformation",
+    "GetJobProbabilitiesResponse200",
     "GetJobResponse",
     "GetJobsQueryParams",
     "GetJobsResponse",
diff --git a/ionq_core/models/get_job_probabilities_response_200.py b/ionq_core/models/get_job_probabilities_response_200.py
@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+
+
+
+
+
+T = TypeVar("T", bound="GetJobProbabilitiesResponse200")
+
+
+
+@_attrs_define
+class GetJobProbabilitiesResponse200:
+    """ 
+     """
+
+    additional_properties: dict[str, float] = _attrs_field(init=False, factory=dict)
+
+
+
+
+
+    def to_dict(self) -> dict[str, Any]:
+        
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        get_job_probabilities_response_200 = cls(
+        )
+
+
+        get_job_probabilities_response_200.additional_properties = d
+        return get_job_probabilities_response_200
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> float:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: float) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties
diff --git a/openapi-overlay.yaml b/openapi-overlay.yaml
@@ -112,3 +112,33 @@ actions:
   - target: $.components.schemas.Gate_NativeGate_
     update:
       required: [gate]
+
+  # Results endpoints: API v0.4 returns results as URLs that must be
+  # fetched separately.  The spec omits these endpoints entirely.
+  - target: $.paths
+    update:
+      /jobs/{UUID}/results/probabilities:
+        get:
+          operationId: getJobProbabilities
+          summary: Fetch the probability distribution for a completed job.
+          tags: [default]
+          parameters:
+            - description: The UUID of the job.
+              in: path
+              name: UUID
+              required: true
+              schema:
+                type: string
+          responses:
+            "200":
+              description: Probability distribution keyed by decimal qubit state.
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    additionalProperties:
+                      type: number
+            "404":
+              description: Job not found or not yet completed.
+          security:
+            - apiKeyAuth: []
