Skip to content

feat(qaas): update documentation #1403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 25, 2025
Merged

feat(qaas): update documentation #1403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4532cfe
feat: update generated APIs
scaleway-bot Nov 25, 2025
eec761c
Merge branch 'main' into v1.7365.0
estellesoulard Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions scaleway-async/scaleway_async/qaas/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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 <Job>`

Expand Down Expand Up @@ -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 <Job>`

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions scaleway-async/scaleway_async/qaas/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions scaleway/scaleway/qaas/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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 <Job>`

Expand Down Expand Up @@ -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 <Job>`

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <Session>`

Expand Down Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions scaleway/scaleway/qaas/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down