qi-compute-api-client 0.27.0__py3-none-any.whl → 0.32.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of qi-compute-api-client might be problematic. Click here for more details.
- compute_api_client/api/algorithms_api.py +5 -27
- compute_api_client/api/backend_api.py +3 -6
- compute_api_client/api/backend_types_api.py +2 -4
- compute_api_client/api/batch_jobs_api.py +4 -25
- compute_api_client/api/commits_api.py +4 -8
- compute_api_client/api/files_api.py +4 -8
- compute_api_client/api/final_results_api.py +3 -6
- compute_api_client/api/jobs_api.py +5 -10
- compute_api_client/api/languages_api.py +2 -4
- compute_api_client/api/members_api.py +4 -25
- compute_api_client/api/metadata_api.py +2 -4
- compute_api_client/api/permissions_api.py +4 -8
- compute_api_client/api/projects_api.py +6 -12
- compute_api_client/api/reservations_api.py +4 -8
- compute_api_client/api/results_api.py +549 -6
- compute_api_client/api/teams_api.py +2 -4
- compute_api_client/api/transactions_api.py +32 -34
- compute_api_client/api/users_api.py +4 -8
- compute_api_client/configuration.py +0 -9
- compute_api_client/docs/AlgorithmIn.md +1 -1
- compute_api_client/docs/AlgorithmsApi.md +7 -44
- compute_api_client/docs/BackendApi.md +3 -24
- compute_api_client/docs/BackendTypesApi.md +2 -16
- compute_api_client/docs/BatchJobsApi.md +6 -36
- compute_api_client/docs/CommitsApi.md +4 -32
- compute_api_client/docs/FilesApi.md +4 -32
- compute_api_client/docs/FinalResultsApi.md +3 -24
- compute_api_client/docs/JobsApi.md +5 -40
- compute_api_client/docs/LanguagesApi.md +2 -16
- compute_api_client/docs/MembersApi.md +6 -36
- compute_api_client/docs/MetadataApi.md +2 -16
- compute_api_client/docs/PermissionsApi.md +4 -32
- compute_api_client/docs/ProjectsApi.md +6 -48
- compute_api_client/docs/ReservationsApi.md +4 -32
- compute_api_client/docs/Result.md +0 -1
- compute_api_client/docs/ResultIn.md +0 -1
- compute_api_client/docs/ResultsApi.md +109 -16
- compute_api_client/docs/TeamsApi.md +2 -16
- compute_api_client/docs/Transaction.md +1 -1
- compute_api_client/docs/TransactionsApi.md +8 -22
- compute_api_client/docs/UsersApi.md +4 -32
- compute_api_client/models/algorithm.py +1 -6
- compute_api_client/models/algorithm_in.py +1 -6
- compute_api_client/models/result.py +1 -5
- compute_api_client/models/result_in.py +1 -5
- compute_api_client/models/transaction.py +6 -6
- {qi_compute_api_client-0.27.0.dist-info → qi_compute_api_client-0.32.0.dist-info}/METADATA +3 -14
- {qi_compute_api_client-0.27.0.dist-info → qi_compute_api_client-0.32.0.dist-info}/RECORD +50 -50
- {qi_compute_api_client-0.27.0.dist-info → qi_compute_api_client-0.32.0.dist-info}/WHEEL +1 -1
- {qi_compute_api_client-0.27.0.dist-info → qi_compute_api_client-0.32.0.dist-info}/LICENSE.md +0 -0
|
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**create_result_results_post**](ResultsApi.md#create_result_results_post) | **POST** /results | Create result
|
|
8
8
|
[**delete_results_by_job_id_results_job_job_id_delete**](ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete) | **DELETE** /results/job/{job_id} | Delete results by job ID
|
|
9
9
|
[**read_result_results_id_get**](ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
|
|
10
|
+
[**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID
|
|
10
11
|
[**read_results_by_job_id_results_job_job_id_get**](ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve results by job ID
|
|
11
12
|
|
|
12
13
|
|
|
@@ -177,7 +178,6 @@ Get result by ID.
|
|
|
177
178
|
### Example
|
|
178
179
|
|
|
179
180
|
* OAuth Authentication (user_bearer):
|
|
180
|
-
* Api Key Authentication (user):
|
|
181
181
|
```python
|
|
182
182
|
import time
|
|
183
183
|
import os
|
|
@@ -199,12 +199,6 @@ configuration = compute_api_client.Configuration(
|
|
|
199
199
|
|
|
200
200
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
201
201
|
|
|
202
|
-
# Configure API key authorization: user
|
|
203
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
204
|
-
|
|
205
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
206
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
207
|
-
|
|
208
202
|
# Enter a context with an instance of the API client
|
|
209
203
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
210
204
|
# Create an instance of the API class
|
|
@@ -234,7 +228,7 @@ Name | Type | Description | Notes
|
|
|
234
228
|
|
|
235
229
|
### Authorization
|
|
236
230
|
|
|
237
|
-
[user_bearer](../README.md#user_bearer)
|
|
231
|
+
[user_bearer](../README.md#user_bearer)
|
|
238
232
|
|
|
239
233
|
### HTTP request headers
|
|
240
234
|
|
|
@@ -250,6 +244,112 @@ Name | Type | Description | Notes
|
|
|
250
244
|
|
|
251
245
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
252
246
|
|
|
247
|
+
# **read_results_by_algorithm_id_results_algorithm_algorithm_id_get**
|
|
248
|
+
> List[Result] read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body)
|
|
249
|
+
|
|
250
|
+
Retrieve results by algorithm ID
|
|
251
|
+
|
|
252
|
+
Get results by algorithm ID.
|
|
253
|
+
|
|
254
|
+
### Example
|
|
255
|
+
|
|
256
|
+
* OAuth Authentication (user_bearer):
|
|
257
|
+
```python
|
|
258
|
+
import time
|
|
259
|
+
import os
|
|
260
|
+
import compute_api_client
|
|
261
|
+
from compute_api_client.models.result import Result
|
|
262
|
+
from compute_api_client.rest import ApiException
|
|
263
|
+
from pprint import pprint
|
|
264
|
+
|
|
265
|
+
# Defining the host is optional and defaults to http://localhost
|
|
266
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
267
|
+
configuration = compute_api_client.Configuration(
|
|
268
|
+
host = "http://localhost"
|
|
269
|
+
)
|
|
270
|
+
|
|
271
|
+
# The client must configure the authentication and authorization parameters
|
|
272
|
+
# in accordance with the API server security policy.
|
|
273
|
+
# Examples for each auth method are provided below, use the example that
|
|
274
|
+
# satisfies your auth use case.
|
|
275
|
+
|
|
276
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
277
|
+
|
|
278
|
+
# Enter a context with an instance of the API client
|
|
279
|
+
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
280
|
+
# Create an instance of the API class
|
|
281
|
+
api_instance = compute_api_client.ResultsApi(api_client)
|
|
282
|
+
algorithm_id = 56 # int |
|
|
283
|
+
latest = True # bool | (optional)
|
|
284
|
+
sort_by = 'sort_by_example' # str | (optional)
|
|
285
|
+
page_number = 56 # int | (optional)
|
|
286
|
+
items_per_page = 56 # int | (optional)
|
|
287
|
+
id = 56 # int | (optional)
|
|
288
|
+
created_on = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
289
|
+
job_id = 56 # int | (optional)
|
|
290
|
+
metadata_id = 56 # int | (optional)
|
|
291
|
+
execution_time_in_seconds = 3.4 # float | (optional)
|
|
292
|
+
shots_requested__isnull = True # bool | (optional)
|
|
293
|
+
shots_requested = 56 # int | (optional)
|
|
294
|
+
shots_done__isnull = True # bool | (optional)
|
|
295
|
+
shots_done = 56 # int | (optional)
|
|
296
|
+
results__isnull = True # bool | (optional)
|
|
297
|
+
body = None # object | (optional)
|
|
298
|
+
|
|
299
|
+
try:
|
|
300
|
+
# Retrieve results by algorithm ID
|
|
301
|
+
api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, body=body)
|
|
302
|
+
print("The response of ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get:\n")
|
|
303
|
+
pprint(api_response)
|
|
304
|
+
except Exception as e:
|
|
305
|
+
print("Exception when calling ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get: %s\n" % e)
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
### Parameters
|
|
311
|
+
|
|
312
|
+
Name | Type | Description | Notes
|
|
313
|
+
------------- | ------------- | ------------- | -------------
|
|
314
|
+
**algorithm_id** | **int**| |
|
|
315
|
+
**latest** | **bool**| | [optional]
|
|
316
|
+
**sort_by** | **str**| | [optional]
|
|
317
|
+
**page_number** | **int**| | [optional]
|
|
318
|
+
**items_per_page** | **int**| | [optional]
|
|
319
|
+
**id** | **int**| | [optional]
|
|
320
|
+
**created_on** | **datetime**| | [optional]
|
|
321
|
+
**job_id** | **int**| | [optional]
|
|
322
|
+
**metadata_id** | **int**| | [optional]
|
|
323
|
+
**execution_time_in_seconds** | **float**| | [optional]
|
|
324
|
+
**shots_requested__isnull** | **bool**| | [optional]
|
|
325
|
+
**shots_requested** | **int**| | [optional]
|
|
326
|
+
**shots_done__isnull** | **bool**| | [optional]
|
|
327
|
+
**shots_done** | **int**| | [optional]
|
|
328
|
+
**results__isnull** | **bool**| | [optional]
|
|
329
|
+
**body** | **object**| | [optional]
|
|
330
|
+
|
|
331
|
+
### Return type
|
|
332
|
+
|
|
333
|
+
[**List[Result]**](Result.md)
|
|
334
|
+
|
|
335
|
+
### Authorization
|
|
336
|
+
|
|
337
|
+
[user_bearer](../README.md#user_bearer)
|
|
338
|
+
|
|
339
|
+
### HTTP request headers
|
|
340
|
+
|
|
341
|
+
- **Content-Type**: application/json
|
|
342
|
+
- **Accept**: application/json
|
|
343
|
+
|
|
344
|
+
### HTTP response details
|
|
345
|
+
| Status code | Description | Response headers |
|
|
346
|
+
|-------------|-------------|------------------|
|
|
347
|
+
**200** | Successful Response | - |
|
|
348
|
+
**404** | Not Found | - |
|
|
349
|
+
**422** | Validation Error | - |
|
|
350
|
+
|
|
351
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
352
|
+
|
|
253
353
|
# **read_results_by_job_id_results_job_job_id_get**
|
|
254
354
|
> List[Result] read_results_by_job_id_results_job_job_id_get(job_id)
|
|
255
355
|
|
|
@@ -260,7 +360,6 @@ Get results by job ID.
|
|
|
260
360
|
### Example
|
|
261
361
|
|
|
262
362
|
* OAuth Authentication (user_bearer):
|
|
263
|
-
* Api Key Authentication (user):
|
|
264
363
|
```python
|
|
265
364
|
import time
|
|
266
365
|
import os
|
|
@@ -282,12 +381,6 @@ configuration = compute_api_client.Configuration(
|
|
|
282
381
|
|
|
283
382
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
284
383
|
|
|
285
|
-
# Configure API key authorization: user
|
|
286
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
287
|
-
|
|
288
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
289
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
290
|
-
|
|
291
384
|
# Enter a context with an instance of the API client
|
|
292
385
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
293
386
|
# Create an instance of the API class
|
|
@@ -317,7 +410,7 @@ Name | Type | Description | Notes
|
|
|
317
410
|
|
|
318
411
|
### Authorization
|
|
319
412
|
|
|
320
|
-
[user_bearer](../README.md#user_bearer)
|
|
413
|
+
[user_bearer](../README.md#user_bearer)
|
|
321
414
|
|
|
322
415
|
### HTTP request headers
|
|
323
416
|
|
|
@@ -18,7 +18,6 @@ Get team by ID.
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
20
20
|
* OAuth Authentication (user_bearer):
|
|
21
|
-
* Api Key Authentication (user):
|
|
22
21
|
```python
|
|
23
22
|
import time
|
|
24
23
|
import os
|
|
@@ -40,12 +39,6 @@ configuration = compute_api_client.Configuration(
|
|
|
40
39
|
|
|
41
40
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
42
41
|
|
|
43
|
-
# Configure API key authorization: user
|
|
44
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
45
|
-
|
|
46
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
47
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
48
|
-
|
|
49
42
|
# Enter a context with an instance of the API client
|
|
50
43
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
51
44
|
# Create an instance of the API class
|
|
@@ -75,7 +68,7 @@ Name | Type | Description | Notes
|
|
|
75
68
|
|
|
76
69
|
### Authorization
|
|
77
70
|
|
|
78
|
-
[user_bearer](../README.md#user_bearer)
|
|
71
|
+
[user_bearer](../README.md#user_bearer)
|
|
79
72
|
|
|
80
73
|
### HTTP request headers
|
|
81
74
|
|
|
@@ -101,7 +94,6 @@ Read teams.
|
|
|
101
94
|
### Example
|
|
102
95
|
|
|
103
96
|
* OAuth Authentication (user_bearer):
|
|
104
|
-
* Api Key Authentication (user):
|
|
105
97
|
```python
|
|
106
98
|
import time
|
|
107
99
|
import os
|
|
@@ -123,12 +115,6 @@ configuration = compute_api_client.Configuration(
|
|
|
123
115
|
|
|
124
116
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
125
117
|
|
|
126
|
-
# Configure API key authorization: user
|
|
127
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
128
|
-
|
|
129
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
130
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
131
|
-
|
|
132
118
|
# Enter a context with an instance of the API client
|
|
133
119
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
134
120
|
# Create an instance of the API class
|
|
@@ -172,7 +158,7 @@ Name | Type | Description | Notes
|
|
|
172
158
|
|
|
173
159
|
### Authorization
|
|
174
160
|
|
|
175
|
-
[user_bearer](../README.md#user_bearer)
|
|
161
|
+
[user_bearer](../README.md#user_bearer)
|
|
176
162
|
|
|
177
163
|
### HTTP request headers
|
|
178
164
|
|
|
@@ -18,7 +18,6 @@ Get transaction by ID.
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
20
20
|
* OAuth Authentication (user_bearer):
|
|
21
|
-
* Api Key Authentication (user):
|
|
22
21
|
```python
|
|
23
22
|
import time
|
|
24
23
|
import os
|
|
@@ -40,12 +39,6 @@ configuration = compute_api_client.Configuration(
|
|
|
40
39
|
|
|
41
40
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
42
41
|
|
|
43
|
-
# Configure API key authorization: user
|
|
44
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
45
|
-
|
|
46
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
47
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
48
|
-
|
|
49
42
|
# Enter a context with an instance of the API client
|
|
50
43
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
51
44
|
# Create an instance of the API class
|
|
@@ -75,7 +68,7 @@ Name | Type | Description | Notes
|
|
|
75
68
|
|
|
76
69
|
### Authorization
|
|
77
70
|
|
|
78
|
-
[user_bearer](../README.md#user_bearer)
|
|
71
|
+
[user_bearer](../README.md#user_bearer)
|
|
79
72
|
|
|
80
73
|
### HTTP request headers
|
|
81
74
|
|
|
@@ -92,7 +85,7 @@ Name | Type | Description | Notes
|
|
|
92
85
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
93
86
|
|
|
94
87
|
# **read_transactions_transactions_get**
|
|
95
|
-
> List[Transaction] read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id,
|
|
88
|
+
> List[Transaction] read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp)
|
|
96
89
|
|
|
97
90
|
List transactions
|
|
98
91
|
|
|
@@ -101,7 +94,6 @@ Read transactions.
|
|
|
101
94
|
### Example
|
|
102
95
|
|
|
103
96
|
* OAuth Authentication (user_bearer):
|
|
104
|
-
* Api Key Authentication (user):
|
|
105
97
|
```python
|
|
106
98
|
import time
|
|
107
99
|
import os
|
|
@@ -124,12 +116,6 @@ configuration = compute_api_client.Configuration(
|
|
|
124
116
|
|
|
125
117
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
126
118
|
|
|
127
|
-
# Configure API key authorization: user
|
|
128
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
129
|
-
|
|
130
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
131
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
132
|
-
|
|
133
119
|
# Enter a context with an instance of the API client
|
|
134
120
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
135
121
|
# Create an instance of the API class
|
|
@@ -144,14 +130,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
|
|
|
144
130
|
job__isnull = True # bool | (optional)
|
|
145
131
|
job = 56 # int | (optional)
|
|
146
132
|
team_id = 56 # int | (optional)
|
|
147
|
-
|
|
148
|
-
|
|
133
|
+
member_id__isnull = True # bool | (optional)
|
|
134
|
+
member_id = 56 # int | (optional)
|
|
149
135
|
change = 56 # int | (optional)
|
|
150
136
|
timestamp = '2013-10-20T19:20:30+01:00' # datetime | (optional)
|
|
151
137
|
|
|
152
138
|
try:
|
|
153
139
|
# List transactions
|
|
154
|
-
api_response = await api_instance.read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id,
|
|
140
|
+
api_response = await api_instance.read_transactions_transactions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, domain__isnull=domain__isnull, domain=domain, job__isnull=job__isnull, job=job, team_id=team_id, member_id__isnull=member_id__isnull, member_id=member_id, change=change, timestamp=timestamp)
|
|
155
141
|
print("The response of TransactionsApi->read_transactions_transactions_get:\n")
|
|
156
142
|
pprint(api_response)
|
|
157
143
|
except Exception as e:
|
|
@@ -174,8 +160,8 @@ Name | Type | Description | Notes
|
|
|
174
160
|
**job__isnull** | **bool**| | [optional]
|
|
175
161
|
**job** | **int**| | [optional]
|
|
176
162
|
**team_id** | **int**| | [optional]
|
|
177
|
-
**
|
|
178
|
-
**
|
|
163
|
+
**member_id__isnull** | **bool**| | [optional]
|
|
164
|
+
**member_id** | **int**| | [optional]
|
|
179
165
|
**change** | **int**| | [optional]
|
|
180
166
|
**timestamp** | **datetime**| | [optional]
|
|
181
167
|
|
|
@@ -185,7 +171,7 @@ Name | Type | Description | Notes
|
|
|
185
171
|
|
|
186
172
|
### Authorization
|
|
187
173
|
|
|
188
|
-
[user_bearer](../README.md#user_bearer)
|
|
174
|
+
[user_bearer](../README.md#user_bearer)
|
|
189
175
|
|
|
190
176
|
### HTTP request headers
|
|
191
177
|
|
|
@@ -20,7 +20,6 @@ Create new user.
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
22
22
|
* OAuth Authentication (user_bearer):
|
|
23
|
-
* Api Key Authentication (user):
|
|
24
23
|
```python
|
|
25
24
|
import time
|
|
26
25
|
import os
|
|
@@ -43,12 +42,6 @@ configuration = compute_api_client.Configuration(
|
|
|
43
42
|
|
|
44
43
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
45
44
|
|
|
46
|
-
# Configure API key authorization: user
|
|
47
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
48
|
-
|
|
49
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
50
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
51
|
-
|
|
52
45
|
# Enter a context with an instance of the API client
|
|
53
46
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
54
47
|
# Create an instance of the API class
|
|
@@ -78,7 +71,7 @@ Name | Type | Description | Notes
|
|
|
78
71
|
|
|
79
72
|
### Authorization
|
|
80
73
|
|
|
81
|
-
[user_bearer](../README.md#user_bearer)
|
|
74
|
+
[user_bearer](../README.md#user_bearer)
|
|
82
75
|
|
|
83
76
|
### HTTP request headers
|
|
84
77
|
|
|
@@ -103,7 +96,6 @@ Delete a user.
|
|
|
103
96
|
### Example
|
|
104
97
|
|
|
105
98
|
* OAuth Authentication (user_bearer):
|
|
106
|
-
* Api Key Authentication (user):
|
|
107
99
|
```python
|
|
108
100
|
import time
|
|
109
101
|
import os
|
|
@@ -124,12 +116,6 @@ configuration = compute_api_client.Configuration(
|
|
|
124
116
|
|
|
125
117
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
126
118
|
|
|
127
|
-
# Configure API key authorization: user
|
|
128
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
129
|
-
|
|
130
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
131
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
132
|
-
|
|
133
119
|
# Enter a context with an instance of the API client
|
|
134
120
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
135
121
|
# Create an instance of the API class
|
|
@@ -157,7 +143,7 @@ void (empty response body)
|
|
|
157
143
|
|
|
158
144
|
### Authorization
|
|
159
145
|
|
|
160
|
-
[user_bearer](../README.md#user_bearer)
|
|
146
|
+
[user_bearer](../README.md#user_bearer)
|
|
161
147
|
|
|
162
148
|
### HTTP request headers
|
|
163
149
|
|
|
@@ -183,7 +169,6 @@ Get user by ID.
|
|
|
183
169
|
### Example
|
|
184
170
|
|
|
185
171
|
* OAuth Authentication (user_bearer):
|
|
186
|
-
* Api Key Authentication (user):
|
|
187
172
|
```python
|
|
188
173
|
import time
|
|
189
174
|
import os
|
|
@@ -205,12 +190,6 @@ configuration = compute_api_client.Configuration(
|
|
|
205
190
|
|
|
206
191
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
207
192
|
|
|
208
|
-
# Configure API key authorization: user
|
|
209
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
210
|
-
|
|
211
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
212
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
213
|
-
|
|
214
193
|
# Enter a context with an instance of the API client
|
|
215
194
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
216
195
|
# Create an instance of the API class
|
|
@@ -240,7 +219,7 @@ Name | Type | Description | Notes
|
|
|
240
219
|
|
|
241
220
|
### Authorization
|
|
242
221
|
|
|
243
|
-
[user_bearer](../README.md#user_bearer)
|
|
222
|
+
[user_bearer](../README.md#user_bearer)
|
|
244
223
|
|
|
245
224
|
### HTTP request headers
|
|
246
225
|
|
|
@@ -266,7 +245,6 @@ Read users.
|
|
|
266
245
|
### Example
|
|
267
246
|
|
|
268
247
|
* OAuth Authentication (user_bearer):
|
|
269
|
-
* Api Key Authentication (user):
|
|
270
248
|
```python
|
|
271
249
|
import time
|
|
272
250
|
import os
|
|
@@ -288,12 +266,6 @@ configuration = compute_api_client.Configuration(
|
|
|
288
266
|
|
|
289
267
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
290
268
|
|
|
291
|
-
# Configure API key authorization: user
|
|
292
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
293
|
-
|
|
294
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
295
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
296
|
-
|
|
297
269
|
# Enter a context with an instance of the API client
|
|
298
270
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
299
271
|
# Create an instance of the API class
|
|
@@ -345,7 +317,7 @@ Name | Type | Description | Notes
|
|
|
345
317
|
|
|
346
318
|
### Authorization
|
|
347
319
|
|
|
348
|
-
[user_bearer](../README.md#user_bearer)
|
|
320
|
+
[user_bearer](../README.md#user_bearer)
|
|
349
321
|
|
|
350
322
|
### HTTP request headers
|
|
351
323
|
|
|
@@ -38,7 +38,7 @@ class Algorithm(BaseModel):
|
|
|
38
38
|
type: AlgorithmType
|
|
39
39
|
shared: ShareType
|
|
40
40
|
link: Optional[Annotated[str, Field(strict=True, max_length=255)]]
|
|
41
|
-
name:
|
|
41
|
+
name: Annotated[str, Field(strict=True, max_length=255)]
|
|
42
42
|
__properties: ClassVar[List[str]] = ["id", "project_id", "type", "shared", "link", "name"]
|
|
43
43
|
|
|
44
44
|
model_config = {
|
|
@@ -82,11 +82,6 @@ class Algorithm(BaseModel):
|
|
|
82
82
|
if self.link is None and "link" in self.model_fields_set:
|
|
83
83
|
_dict['link'] = None
|
|
84
84
|
|
|
85
|
-
# set to None if name (nullable) is None
|
|
86
|
-
# and model_fields_set contains the field
|
|
87
|
-
if self.name is None and "name" in self.model_fields_set:
|
|
88
|
-
_dict['name'] = None
|
|
89
|
-
|
|
90
85
|
return _dict
|
|
91
86
|
|
|
92
87
|
@classmethod
|
|
@@ -37,7 +37,7 @@ class AlgorithmIn(BaseModel):
|
|
|
37
37
|
type: AlgorithmType
|
|
38
38
|
shared: ShareType
|
|
39
39
|
link: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
|
|
40
|
-
name:
|
|
40
|
+
name: Annotated[str, Field(strict=True, max_length=255)]
|
|
41
41
|
__properties: ClassVar[List[str]] = ["project_id", "type", "shared", "link", "name"]
|
|
42
42
|
|
|
43
43
|
model_config = {
|
|
@@ -81,11 +81,6 @@ class AlgorithmIn(BaseModel):
|
|
|
81
81
|
if self.link is None and "link" in self.model_fields_set:
|
|
82
82
|
_dict['link'] = None
|
|
83
83
|
|
|
84
|
-
# set to None if name (nullable) is None
|
|
85
|
-
# and model_fields_set contains the field
|
|
86
|
-
if self.name is None and "name" in self.model_fields_set:
|
|
87
|
-
_dict['name'] = None
|
|
88
|
-
|
|
89
84
|
return _dict
|
|
90
85
|
|
|
91
86
|
@classmethod
|
|
@@ -20,8 +20,6 @@ import json
|
|
|
20
20
|
from datetime import datetime
|
|
21
21
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
22
22
|
from pydantic import BaseModel, StrictFloat, StrictInt
|
|
23
|
-
from pydantic import Field
|
|
24
|
-
from typing_extensions import Annotated
|
|
25
23
|
try:
|
|
26
24
|
from typing import Self
|
|
27
25
|
except ImportError:
|
|
@@ -35,12 +33,11 @@ class Result(BaseModel):
|
|
|
35
33
|
created_on: datetime
|
|
36
34
|
job_id: StrictInt
|
|
37
35
|
metadata_id: StrictInt
|
|
38
|
-
number_of_qubits: Annotated[int, Field(strict=True, ge=-32768)]
|
|
39
36
|
execution_time_in_seconds: Union[StrictFloat, StrictInt]
|
|
40
37
|
shots_requested: Optional[StrictInt]
|
|
41
38
|
shots_done: Optional[StrictInt]
|
|
42
39
|
results: Optional[Union[str, Any]]
|
|
43
|
-
__properties: ClassVar[List[str]] = ["id", "created_on", "job_id", "metadata_id", "
|
|
40
|
+
__properties: ClassVar[List[str]] = ["id", "created_on", "job_id", "metadata_id", "execution_time_in_seconds", "shots_requested", "shots_done", "results"]
|
|
44
41
|
|
|
45
42
|
model_config = {
|
|
46
43
|
"populate_by_name": True,
|
|
@@ -109,7 +106,6 @@ class Result(BaseModel):
|
|
|
109
106
|
"created_on": obj.get("created_on"),
|
|
110
107
|
"job_id": obj.get("job_id"),
|
|
111
108
|
"metadata_id": obj.get("metadata_id"),
|
|
112
|
-
"number_of_qubits": obj.get("number_of_qubits"),
|
|
113
109
|
"execution_time_in_seconds": obj.get("execution_time_in_seconds"),
|
|
114
110
|
"shots_requested": obj.get("shots_requested"),
|
|
115
111
|
"shots_done": obj.get("shots_done"),
|
|
@@ -20,8 +20,6 @@ import json
|
|
|
20
20
|
|
|
21
21
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
22
22
|
from pydantic import BaseModel, StrictFloat, StrictInt
|
|
23
|
-
from pydantic import Field
|
|
24
|
-
from typing_extensions import Annotated
|
|
25
23
|
try:
|
|
26
24
|
from typing import Self
|
|
27
25
|
except ImportError:
|
|
@@ -33,12 +31,11 @@ class ResultIn(BaseModel):
|
|
|
33
31
|
""" # noqa: E501
|
|
34
32
|
job_id: StrictInt
|
|
35
33
|
metadata_id: Optional[StrictInt] = None
|
|
36
|
-
number_of_qubits: Annotated[int, Field(strict=True, ge=-32768)]
|
|
37
34
|
execution_time_in_seconds: Union[StrictFloat, StrictInt]
|
|
38
35
|
shots_requested: Optional[StrictInt] = None
|
|
39
36
|
shots_done: Optional[StrictInt] = None
|
|
40
37
|
results: Optional[Union[str, Any]] = None
|
|
41
|
-
__properties: ClassVar[List[str]] = ["job_id", "metadata_id", "
|
|
38
|
+
__properties: ClassVar[List[str]] = ["job_id", "metadata_id", "execution_time_in_seconds", "shots_requested", "shots_done", "results"]
|
|
42
39
|
|
|
43
40
|
model_config = {
|
|
44
41
|
"populate_by_name": True,
|
|
@@ -110,7 +107,6 @@ class ResultIn(BaseModel):
|
|
|
110
107
|
_obj = cls.model_validate({
|
|
111
108
|
"job_id": obj.get("job_id"),
|
|
112
109
|
"metadata_id": obj.get("metadata_id"),
|
|
113
|
-
"number_of_qubits": obj.get("number_of_qubits"),
|
|
114
110
|
"execution_time_in_seconds": obj.get("execution_time_in_seconds"),
|
|
115
111
|
"shots_requested": obj.get("shots_requested"),
|
|
116
112
|
"shots_done": obj.get("shots_done"),
|
|
@@ -36,10 +36,10 @@ class Transaction(BaseModel):
|
|
|
36
36
|
domain: Optional[Domain]
|
|
37
37
|
job: Optional[StrictInt]
|
|
38
38
|
team_id: StrictInt
|
|
39
|
-
|
|
39
|
+
member_id: Optional[StrictInt]
|
|
40
40
|
change: Annotated[int, Field(strict=True, ge=-32768)]
|
|
41
41
|
timestamp: datetime
|
|
42
|
-
__properties: ClassVar[List[str]] = ["id", "domain", "job", "team_id", "
|
|
42
|
+
__properties: ClassVar[List[str]] = ["id", "domain", "job", "team_id", "member_id", "change", "timestamp"]
|
|
43
43
|
|
|
44
44
|
model_config = {
|
|
45
45
|
"populate_by_name": True,
|
|
@@ -87,10 +87,10 @@ class Transaction(BaseModel):
|
|
|
87
87
|
if self.job is None and "job" in self.model_fields_set:
|
|
88
88
|
_dict['job'] = None
|
|
89
89
|
|
|
90
|
-
# set to None if
|
|
90
|
+
# set to None if member_id (nullable) is None
|
|
91
91
|
# and model_fields_set contains the field
|
|
92
|
-
if self.
|
|
93
|
-
_dict['
|
|
92
|
+
if self.member_id is None and "member_id" in self.model_fields_set:
|
|
93
|
+
_dict['member_id'] = None
|
|
94
94
|
|
|
95
95
|
return _dict
|
|
96
96
|
|
|
@@ -108,7 +108,7 @@ class Transaction(BaseModel):
|
|
|
108
108
|
"domain": obj.get("domain"),
|
|
109
109
|
"job": obj.get("job"),
|
|
110
110
|
"team_id": obj.get("team_id"),
|
|
111
|
-
"
|
|
111
|
+
"member_id": obj.get("member_id"),
|
|
112
112
|
"change": obj.get("change"),
|
|
113
113
|
"timestamp": obj.get("timestamp")
|
|
114
114
|
})
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: qi-compute-api-client
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.32.0
|
|
4
4
|
Summary: An API client for the Compute Job Manager of Quantum Inspire.
|
|
5
5
|
Home-page: https://github.com/QuTech-Delft/compute-api-client
|
|
6
6
|
License: Apache-2.0
|
|
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.8
|
|
|
14
14
|
Classifier: Programming Language :: Python :: 3.9
|
|
15
15
|
Classifier: Programming Language :: Python :: 3.10
|
|
16
16
|
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
18
|
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
|
|
18
19
|
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
|
|
19
20
|
Requires-Dist: urllib3 (>=1.25.3,<2.0.0)
|
|
@@ -69,12 +70,6 @@ configuration = compute_api_client.Configuration(
|
|
|
69
70
|
|
|
70
71
|
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
71
72
|
|
|
72
|
-
# Configure API key authorization: user
|
|
73
|
-
configuration.api_key['user'] = os.environ["API_KEY"]
|
|
74
|
-
|
|
75
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
76
|
-
# configuration.api_key_prefix['user'] = 'Bearer'
|
|
77
|
-
|
|
78
73
|
|
|
79
74
|
# Enter a context with an instance of the API client
|
|
80
75
|
async with compute_api_client.ApiClient(configuration) as api_client:
|
|
@@ -159,6 +154,7 @@ Class | Method | HTTP request | Description
|
|
|
159
154
|
*ResultsApi* | [**create_result_results_post**](compute_api_client/docs/ResultsApi.md#create_result_results_post) | **POST** /results | Create result
|
|
160
155
|
*ResultsApi* | [**delete_results_by_job_id_results_job_job_id_delete**](compute_api_client/docs/ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete) | **DELETE** /results/job/{job_id} | Delete results by job ID
|
|
161
156
|
*ResultsApi* | [**read_result_results_id_get**](compute_api_client/docs/ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
|
|
157
|
+
*ResultsApi* | [**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID
|
|
162
158
|
*ResultsApi* | [**read_results_by_job_id_results_job_job_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve results by job ID
|
|
163
159
|
*TeamsApi* | [**read_team_teams_id_get**](compute_api_client/docs/TeamsApi.md#read_team_teams_id_get) | **GET** /teams/{id} | Retrieve teams
|
|
164
160
|
*TeamsApi* | [**read_teams_teams_get**](compute_api_client/docs/TeamsApi.md#read_teams_teams_get) | **GET** /teams/ | List teams
|
|
@@ -227,13 +223,6 @@ Class | Method | HTTP request | Description
|
|
|
227
223
|
|
|
228
224
|
|
|
229
225
|
Authentication schemes defined for the API:
|
|
230
|
-
<a id="user"></a>
|
|
231
|
-
### user
|
|
232
|
-
|
|
233
|
-
- **Type**: API key
|
|
234
|
-
- **API key parameter name**: X-userid
|
|
235
|
-
- **Location**: HTTP header
|
|
236
|
-
|
|
237
226
|
<a id="user_bearer"></a>
|
|
238
227
|
### user_bearer
|
|
239
228
|
|