@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
8
8
9
9
# QiskitRuntimeService
10
10
11
- <Class id = " qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage = { true } github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L49-L1228 " signature = " QiskitRuntimeService(*args, **kwargs)" modifiers = " class" >
11
+ <Class id = " qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage = { true } github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L49-L1241 " signature = " QiskitRuntimeService(*args, **kwargs)" modifiers = " class" >
12
12
Bases: ` object `
13
13
14
14
Class for interacting with the Qiskit Runtime service.
@@ -75,7 +75,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
75
75
76
76
### active\_ account
77
77
78
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.active_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L622-L628 " signature = " active_account()" >
78
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.active_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L621-L627 " signature = " active_account()" >
79
79
Return the IBM Quantum account currently in use for the session.
80
80
81
81
** Returns**
@@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
89
89
90
90
### active\_ instance
91
91
92
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.active_instance" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1207-L1209 " signature = " active_instance()" >
92
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.active_instance" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1220-L1222 " signature = " active_instance()" >
93
93
Return the crn of the current active instance.
94
94
95
95
** Return type**
@@ -99,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
99
99
100
100
### backend
101
101
102
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.backend" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L744-L782 " signature = " backend(name, instance=None, use_fractional_gates=False)" >
102
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.backend" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L743-L781 " signature = " backend(name, instance=None, use_fractional_gates=False)" >
103
103
Return a single backend matching the specified filtering.
104
104
105
105
** Parameters**
@@ -123,7 +123,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
123
123
124
124
### backends
125
125
126
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.backends" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L403-L509 " signature = " backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)" >
126
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.backends" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L402-L508 " signature = " backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)" >
127
127
Return all backends accessible via this account, subject to optional filtering.
128
128
129
129
** Parameters**
@@ -184,7 +184,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
184
184
185
185
### check\_ pending\_ jobs
186
186
187
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1105-L1140 " signature = " check_pending_jobs()" >
187
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1104-L1139 " signature = " check_pending_jobs()" >
188
188
(DEPRECATED) Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.
189
189
190
190
** Return type**
@@ -194,7 +194,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
194
194
195
195
### delete\_ account
196
196
197
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L630-L648 " signature = " delete_account(filename=None, name=None, channel=None)" modifiers = " static" >
197
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L629-L647 " signature = " delete_account(filename=None, name=None, channel=None)" modifiers = " static" >
198
198
Delete a saved account from disk.
199
199
200
200
** Parameters**
@@ -214,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
214
214
215
215
### delete\_ job
216
216
217
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1005-L1030 " signature = " delete_job(job_id)" >
217
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1004-L1029 " signature = " delete_job(job_id)" >
218
218
(DEPRECATED) Delete a runtime job.
219
219
220
220
Note that this operation cannot be reversed.
@@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
235
235
236
236
### instances
237
237
238
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.instances" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1196-L1205 " signature = " instances()" >
238
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.instances" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1209-L1218 " signature = " instances()" >
239
239
** Return a list that contains a series of dictionaries with the**
240
240
241
241
following instance identifiers per instance: “crn”, “plan”, “name”.
@@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
251
251
252
252
### job
253
253
254
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.job" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L879-L910 " signature = " job(job_id)" >
254
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.job" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L878-L909 " signature = " job(job_id)" >
255
255
Retrieve a runtime job.
256
256
257
257
** Parameters**
@@ -274,7 +274,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
274
274
275
275
### jobs
276
276
277
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.jobs" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L912-L1003 " signature = " jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)" >
277
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.jobs" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L911-L1002 " signature = " jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)" >
278
278
Retrieve all runtime jobs, subject to optional filtering.
279
279
280
280
** Parameters**
@@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
306
306
307
307
### least\_ busy
308
308
309
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1142-L1194 " signature = " least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)" >
309
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1141-L1207 " signature = " least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)" >
310
310
Return the least busy available backend.
311
311
312
312
** Parameters**
@@ -340,7 +340,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
340
340
341
341
### save\_ account
342
342
343
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.save_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L650-L712 " signature = " save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None, tags=None)" modifiers = " static" >
343
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.save_account" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L649-L711 " signature = " save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False, region=None, plans_preference=None, tags=None)" modifiers = " static" >
344
344
Save the account to disk for future use.
345
345
346
346
** Parameters**
@@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
367
367
368
368
### saved\_ accounts
369
369
370
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L714-L742 " signature = " saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers = " static" >
370
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L713-L741 " signature = " saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers = " static" >
371
371
List the accounts saved on disk.
372
372
373
373
** Parameters**
@@ -392,7 +392,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
392
392
393
393
### usage
394
394
395
- <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.usage" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1032-L1046 " signature = " usage()" >
395
+ <Function id = " qiskit_ibm_runtime.QiskitRuntimeService.usage" github = " https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.41/qiskit_ibm_runtime/qiskit_runtime_service.py#L1031-L1045 " signature = " usage()" >
396
396
Return usage information for the current active instance.
397
397
398
398
** Returns**
0 commit comments