From 4532cfeae847873e6a12324bc55af2e15f8d17d3 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Tue, 25 Nov 2025 15:01:14 +0000 Subject: [PATCH] feat: update generated APIs --- .../scaleway_async/qaas/v1alpha1/api.py | 26 +++++++++---------- .../scaleway_async/qaas/v1alpha1/types.py | 10 +++---- scaleway/scaleway/qaas/v1alpha1/api.py | 26 +++++++++---------- scaleway/scaleway/qaas/v1alpha1/types.py | 10 +++---- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/scaleway-async/scaleway_async/qaas/v1alpha1/api.py b/scaleway-async/scaleway_async/qaas/v1alpha1/api.py index aef7f5a6d..24342817d 100644 --- a/scaleway-async/scaleway_async/qaas/v1alpha1/api.py +++ b/scaleway-async/scaleway_async/qaas/v1alpha1/api.py @@ -95,7 +95,7 @@ class QaasV1Alpha1API(API): """ - This API allows you to manage Scaleway Quantum as a Service. + This API allows you to allocate and program Quantum Processing Units (QPUs) to run quantum algorithms. """ async def get_job( @@ -105,7 +105,7 @@ async def get_job( ) -> Job: """ Get job information. - Retrieve information about the provided **job ID**, such as status, payload, and result. + Retrieve information about the provided **job ID**, mainly used to get the current status. :param job_id: Unique ID of the job you want to get. :return: :class:`Job ` @@ -135,7 +135,7 @@ async def wait_for_job( ) -> Job: """ Get job information. - Retrieve information about the provided **job ID**, such as status, payload, and result. + Retrieve information about the provided **job ID**, mainly used to get the current status. :param job_id: Unique ID of the job you want to get. :return: :class:`Job ` @@ -173,7 +173,7 @@ async def list_jobs( ) -> ListJobsResponse: """ List all jobs within a project or session. - Retrieve information about all jobs within a given project or session. + Retrieve information about all jobs within a given session. :param session_id: List jobs with this session ID. One-Of ('resource_id'): at most one of 'session_id', 'project_id' could be set. :param project_id: List jobs with this project ID. @@ -222,7 +222,7 @@ async def list_jobs_all( ) -> list[Job]: """ List all jobs within a project or session. - Retrieve information about all jobs within a given project or session. + Retrieve information about all jobs within a given session. :param session_id: List jobs with this session ID. One-Of ('resource_id'): at most one of 'session_id', 'project_id' could be set. :param project_id: List jobs with this project ID. @@ -343,7 +343,7 @@ async def create_job( ) -> Job: """ Create a job. - Create a job to be executed inside a session. + Create a job to be executed inside a QPU session. :param name: Name of the job. :param session_id: Session in which the job is executed. :param circuit: Quantum circuit that should be executed. @@ -642,7 +642,7 @@ async def get_session( ) -> Session: """ Get session information. - Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs. + Retrieve information about the provided **session ID**, such as name and status. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -672,7 +672,7 @@ async def wait_for_session( ) -> Session: """ Get session information. - Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs. + Retrieve information about the provided **session ID**, such as name and status. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -710,7 +710,7 @@ async def list_sessions( ) -> ListSessionsResponse: """ List all sessions. - Retrieve information about all sessions. + Retrieve information about all QPU sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. @@ -753,7 +753,7 @@ async def list_sessions_all( ) -> list[Session]: """ List all sessions. - Retrieve information about all sessions. + Retrieve information about all QPU sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. @@ -798,7 +798,7 @@ async def create_session( ) -> Session: """ Create a session. - Create a dedicated session for the specified platform. + Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session. :param platform_id: ID of the Platform for which the session was created. :param project_id: ID of the Project in which the session was created. :param name: Name of the session. @@ -896,7 +896,7 @@ async def terminate_session( ) -> Session: """ Terminate an existing session. - Terminate a session by its unique ID and cancel all its attached jobs and booking. + Terminate a session by its unique ID and cancel all its attached jobs and bookings. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -926,7 +926,7 @@ async def delete_session( ) -> None: """ Delete an existing session. - Delete a session by its unique ID and delete all its attached job and booking. + Delete a session by its unique ID and delete all its attached jobs and bookings. :param session_id: Unique ID of the session. Usage: diff --git a/scaleway-async/scaleway_async/qaas/v1alpha1/types.py b/scaleway-async/scaleway_async/qaas/v1alpha1/types.py index 3b3f19276..271abfd32 100644 --- a/scaleway-async/scaleway_async/qaas/v1alpha1/types.py +++ b/scaleway-async/scaleway_async/qaas/v1alpha1/types.py @@ -535,27 +535,27 @@ class Platform: provider_name: str """ - Provider name of the platform. + Name of the technological provider of the platform in lowercase (quandela, pasqal...). """ backend_name: str """ - Name of the running backend over the platform (ascella, qsim, aer...). + Name of the running emulation backend or QPU model of the platform in lowercase (mosaiq, qsim, aer...). """ type_: PlatformType """ - Type of the platform. + Type of the platform (emulator or qpu). """ technology: PlatformTechnology """ - Technology used by the platform. + Quantum technology used by the platform (trapped-ion, photonic, superconducting qubits...). """ max_qubit_count: int """ - Estimated maximum number of qubits supported by the platform. + Maximum number of qubits supported by the platform (estimated for emulator). """ max_shot_count: int diff --git a/scaleway/scaleway/qaas/v1alpha1/api.py b/scaleway/scaleway/qaas/v1alpha1/api.py index 3b895f072..28df3cfa5 100644 --- a/scaleway/scaleway/qaas/v1alpha1/api.py +++ b/scaleway/scaleway/qaas/v1alpha1/api.py @@ -95,7 +95,7 @@ class QaasV1Alpha1API(API): """ - This API allows you to manage Scaleway Quantum as a Service. + This API allows you to allocate and program Quantum Processing Units (QPUs) to run quantum algorithms. """ def get_job( @@ -105,7 +105,7 @@ def get_job( ) -> Job: """ Get job information. - Retrieve information about the provided **job ID**, such as status, payload, and result. + Retrieve information about the provided **job ID**, mainly used to get the current status. :param job_id: Unique ID of the job you want to get. :return: :class:`Job ` @@ -135,7 +135,7 @@ def wait_for_job( ) -> Job: """ Get job information. - Retrieve information about the provided **job ID**, such as status, payload, and result. + Retrieve information about the provided **job ID**, mainly used to get the current status. :param job_id: Unique ID of the job you want to get. :return: :class:`Job ` @@ -173,7 +173,7 @@ def list_jobs( ) -> ListJobsResponse: """ List all jobs within a project or session. - Retrieve information about all jobs within a given project or session. + Retrieve information about all jobs within a given session. :param session_id: List jobs with this session ID. One-Of ('resource_id'): at most one of 'session_id', 'project_id' could be set. :param project_id: List jobs with this project ID. @@ -222,7 +222,7 @@ def list_jobs_all( ) -> list[Job]: """ List all jobs within a project or session. - Retrieve information about all jobs within a given project or session. + Retrieve information about all jobs within a given session. :param session_id: List jobs with this session ID. One-Of ('resource_id'): at most one of 'session_id', 'project_id' could be set. :param project_id: List jobs with this project ID. @@ -343,7 +343,7 @@ def create_job( ) -> Job: """ Create a job. - Create a job to be executed inside a session. + Create a job to be executed inside a QPU session. :param name: Name of the job. :param session_id: Session in which the job is executed. :param circuit: Quantum circuit that should be executed. @@ -642,7 +642,7 @@ def get_session( ) -> Session: """ Get session information. - Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs. + Retrieve information about the provided **session ID**, such as name and status. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -672,7 +672,7 @@ def wait_for_session( ) -> Session: """ Get session information. - Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs. + Retrieve information about the provided **session ID**, such as name and status. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -710,7 +710,7 @@ def list_sessions( ) -> ListSessionsResponse: """ List all sessions. - Retrieve information about all sessions. + Retrieve information about all QPU sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. @@ -753,7 +753,7 @@ def list_sessions_all( ) -> list[Session]: """ List all sessions. - Retrieve information about all sessions. + Retrieve information about all QPU sessions. :param platform_id: List sessions that have been created for this platform. :param tags: List sessions with these tags. :param page: Page number. @@ -798,7 +798,7 @@ def create_session( ) -> Session: """ Create a session. - Create a dedicated session for the specified platform. + Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session. :param platform_id: ID of the Platform for which the session was created. :param project_id: ID of the Project in which the session was created. :param name: Name of the session. @@ -896,7 +896,7 @@ def terminate_session( ) -> Session: """ Terminate an existing session. - Terminate a session by its unique ID and cancel all its attached jobs and booking. + Terminate a session by its unique ID and cancel all its attached jobs and bookings. :param session_id: Unique ID of the session. :return: :class:`Session ` @@ -926,7 +926,7 @@ def delete_session( ) -> None: """ Delete an existing session. - Delete a session by its unique ID and delete all its attached job and booking. + Delete a session by its unique ID and delete all its attached jobs and bookings. :param session_id: Unique ID of the session. Usage: diff --git a/scaleway/scaleway/qaas/v1alpha1/types.py b/scaleway/scaleway/qaas/v1alpha1/types.py index 3b3f19276..271abfd32 100644 --- a/scaleway/scaleway/qaas/v1alpha1/types.py +++ b/scaleway/scaleway/qaas/v1alpha1/types.py @@ -535,27 +535,27 @@ class Platform: provider_name: str """ - Provider name of the platform. + Name of the technological provider of the platform in lowercase (quandela, pasqal...). """ backend_name: str """ - Name of the running backend over the platform (ascella, qsim, aer...). + Name of the running emulation backend or QPU model of the platform in lowercase (mosaiq, qsim, aer...). """ type_: PlatformType """ - Type of the platform. + Type of the platform (emulator or qpu). """ technology: PlatformTechnology """ - Technology used by the platform. + Quantum technology used by the platform (trapped-ion, photonic, superconducting qubits...). """ max_qubit_count: int """ - Estimated maximum number of qubits supported by the platform. + Maximum number of qubits supported by the platform (estimated for emulator). """ max_shot_count: int