-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathopenapi.yaml
764 lines (764 loc) · 26.6 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
openapi: 3.0.2
info:
title: qiskit-service
description: This is the API Specification of the qiskit-service (https://github.com/UST-QuAntiL/qiskit-service).
version: "0.1"
servers:
- url: /
tags:
- name: Transpile
description: "Send implementation, input, QPU information, and your access token\
\ to the API to get analyzed properties of the transpiled circuit and the transpiled\
\ OpenQASM circuit itself."
- name: Execute
description: "Send implementation, input, QPU information, and your access token\
\ for IonQ or IBMQ QPUs to the API to execute your circuit and get the result."
- name: Calibrate Matrix Calculation
description: "Send QPU information, optional shots, and your IBM Quantum Experience\
\ token to the API to calculate the calibration matrix for the given QPU."
- name: Benchmark Request
description: "Send QPU information, the width and depth of the circuit, the number\
\ of circuits you want to create, the number of shots and your IBM Quantum Experience\
\ token to the API to get the result on the IBM Quantum Simulator, and the stated\
\ QPU. The response also contains a link to the summary of the benchmark."
- name: Analysis Request
description: "Request an analysis of all benchmarks in the database that successfully\
\ returned a result. For those benchmarks, the histograms of the simulator's and\
\ the quantum computer's result are compared using the four metrics: Chi-Square-Distance,\
\ Correlation, Percentage Error and Histogram Intersection."
- name: Analysis of Original Circuit
description: Request an analysis of the original circuit.
- name: Wd Request
description: Request the wd-value of a specific Quantum Computer based on the clifford
gate circuit data in your database
- name: Get up-to-date data of QPUs
description: Get provider information.
- name: Results
description: Get execution results of an executed circuit.
- name: Generated Circuits
description: Request a generated circuit and its properties.
- name: Generate Circuit
description: Send implementation and input parameters to the API to generate your
circuit and get its properties.
paths:
/qiskit-service/api/v1.0/transpile:
post:
tags:
- Transpile
description: "*Note*: \"token\" should either be in \"input-params\" or extra.\
\ *Note*: \"url\", \"hub\", \"group\", \"project\" are optional such that\
\ otherwise the standard values are used."
requestBody:
description: " Transpile via URL:\n \"impl-url\"\
: \"URL-OF-IMPLEMENTATION\" \n Transpile via data:\n \
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n \
\ Transpile via OpenQASM-String\n \"qasm-string\"\
: \"OpenQASM String\"\n the \"input-params\"are of the form:\n\
\ \"input-params\": {\n \"PARAM-NAME-1\"\
: {\n \"rawValue\": \"YOUR-VALUE-1\",\n \
\ \"type\": \"Integer\"\n },\n\
\ \"PARAM-NAME-2\": {\n \
\ \"rawValue\": \"YOUR-VALUE-2\",\n \"type\"\
: \"String\"\n },\n ...\n\
\ \"token\": {\n \"rawValue\"\
: \"YOUR-IBMQ-TOKEN\",\n \"type\": \"Unknown\"\
\n },\n \"url\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-AUTHENTICATION-URL\",\n\
\ \"type\": \"Unknown\"\n \
\ },\n \"hub\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-HUB\",\n \"type\"\
: \"Unknown\"\n },\n \"group\"\
: {\n \"rawValue\": \"YOUR-IBMQ-GROUP\",\n \
\ \"type\": \"Unknown\"\n \
\ },\n \"project\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-PROJECT\",\n \
\ \"type\": \"Unknown\"\n }"
content:
application/json:
schema:
$ref: '#/components/schemas/TranspileRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-qiskit.py
qpu-name: ibmq_qasm_simulator
impl-language: qiskit
token: YOUR-IBMQ-TOKEN
input-params: {}
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TranspileResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/execute:
post:
tags:
- Execute
description: "*Note*: \"token\" should either be in \"input-params\" or extra.\
\ Both variants are combined here for illustration purposes. *Note*: \"url\"\
, \"hub\", \"group\", \"project\" are optional such that otherwise the standard\
\ values are used."
requestBody:
description: " Execution via URL:\n \"impl-url\"\
: \"URL-OF-IMPLEMENTATION\" \n Execution via data:\n \
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n \
\ Execution via OpenQASM-String:\n \"qasm-string\"\
: \"OpenQASM String\"\n Execution via transpiled OpenQASM\
\ String:\n \"transpiled-qasm\":\"TRANSPILED-QASM-STRING\"\
\ \n for Batch Execution of multiple circuits use:\n \
\ \"impl-url\": [\"URL-OF-IMPLEMENTATION-1\", \"URL-OF-IMPLEMENTATION-2\"\
]\n the \"input-params\"are of the form:\n \
\ \"input-params\": {\n \"PARAM-NAME-1\": {\n\
\ \"rawValue\": \"YOUR-VALUE-1\",\n \
\ \"type\": \"Integer\"\n },\n\
\ \"PARAM-NAME-2\": {\n \
\ \"rawValue\": \"YOUR-VALUE-2\",\n \"type\"\
: \"String\"\n },\n ...\n\
\ \"token\": {\n \"rawValue\"\
: \"YOUR-IBMQ-TOKEN\",\n \"type\": \"Unknown\"\
\n },\n \"url\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-AUTHENTICATION-URL\",\n\
\ \"type\": \"Unknown\"\n \
\ },\n \"hub\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-HUB\",\n \"type\"\
: \"Unknown\"\n },\n \"group\"\
: {\n \"rawValue\": \"YOUR-IBMQ-GROUP\",\n \
\ \"type\": \"Unknown\"\n \
\ },\n \"project\": {\n \
\ \"rawValue\": \"YOUR-IBMQ-PROJECT\",\n \
\ \"type\": \"Unknown\"\n }"
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-qiskit.py
qpu-name: ibmq_qasm_simulator
provider: ibmq
impl-language: qiskit
token: YOUR-IBMQ-TOKEN
input-params: {}
required: true
responses:
"200":
description: Returns a content location for the result. Access it via GET
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/calculate-calibration-matrix:
post:
tags:
- Calibrate Matrix Calculation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CalcCalibrationMatrixRequest'
example:
qpu-name: ibmq_qasm_simulator
shots: 1024
token: YOUR-IBMQ-TOKEN
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CalcCalibrationMatrixResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/randomize:
post:
tags:
- Benchmark Request
description: "Please make sure that \"number-of-qubits\", \"number-of-circuits\"\
\ and \"min-depth-of-circuit\" are greater than 0. Also, \"max-depth-of-cicuit\"\
\ has to be greater or equal to \"min-depth-of-circuit\""
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BenchmarkRequest'
example:
qpu-name: ibmq_qasm_simulator
number-of-qubits: 3
min-depth-of-circuit: 1
max-depth-of-circuit: 2
number-of-circuits: 3
shots: 1024
token: YOUR-IBMQ-TOKEN
clifford: false
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BenchmarkResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/benchmarks/{benchmark_id}:
get:
tags:
- Benchmark Request
parameters:
- name: benchmark_id
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/analysis:
get:
tags:
- Analysis Request
description: "- Chi-Square-Distance: Large values indicate a strong deviation\
\ between the two histogram, however it is not normalized and difficult to\
\ interpret. \n - Correlation: Normalized between -1 and 1, where values close\
\ to 1 indicate a strong correlation between the histograms. Since the histograms\
\ often have a similar shape even though the counts are erroneous, the correlation\
\ often suggests success even for bad results. \n- Percentage Error: Indicates\
\ the error in relation to the ideal value for each count separately. This\
\ metric does not provide a general view on the quality of the result.\n-\
\ Histogram Intersection: Returns a value that indicates how much of the histograms\
\ overlap.It is normalized between 0 and 1, where 1 would mean that the two\
\ histograms are the same.Therefore, it is a useful metric to judge the quality\
\ of the quantum computer's result."
responses:
"200":
description: OK
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/analysis/{qpu_name}:
get:
tags:
- Analysis Request
description: "- Chi-Square-Distance: Large values indicate a strong deviation\
\ between the two histogram, however it is not normalized and difficult to\
\ interpret. \n - Correlation: Normalized between -1 and 1, where values close\
\ to 1 indicate a strong correlation between the histograms. Since the histograms\
\ often have a similar shape even though the counts are erroneous, the correlation\
\ often suggests success even for bad results. \n- Percentage Error: Indicates\
\ the error in relation to the ideal value for each count separately. This\
\ metric does not provide a general view on the quality of the result.\n-\
\ Histogram Intersection: Returns a value that indicates how much of the histograms\
\ overlap.It is normalized between 0 and 1, where 1 would mean that the two\
\ histograms are the same.Therefore, it is a useful metric to judge the quality\
\ of the quantum computer's result."
parameters:
- name: qpu_name
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/analyze-original-circuit:
post:
tags:
- Analysis of Original Circuit
requestBody:
description: |2-
"input-params" should be of the form:
"input-params":{
"PARAM-NAME-1": {
"rawValue": "YOUR-VALUE-1",
"type": "Integer"
},
"PARAM-NAME-2": {
"rawValue": "YOUR-VALUE-2",
"type": "String"
}
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisOriginalCircuitRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-qiskit.py
impl-language: qiskit
input-params: {}
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisOriginalCircuitResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/calc-wd/{qpu_name}:
get:
tags:
- Wd Request
description: There needs to be at least 10 data points for each number of qubits
and depth to get a meaningful result.
parameters:
- name: qpu_name
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/providers:
get:
tags:
- Get up-to-date data of QPUs
responses:
"200":
description: OK
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/providers/f8f0c200-875d-0ff8-0352-1be4666c5829/qpus:
get:
tags:
- Get up-to-date data of QPUs
parameters:
- name: token
in: header
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: OK
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/results/{id}:
get:
tags:
- Results
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/generated-circuits/{id}:
get:
tags:
- Generated Circuits
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GeneratedCircuitsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/qiskit-service/api/v1.0/generate-circuit:
post:
tags:
- Generate Circuit
requestBody:
description: " Generation via URL:\n \"\
impl-url\": \"URL-OF-IMPLEMENTATION\" \n Generation via data:\n\
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n\
\ the \"input-params\"are of the form:\n \
\ \"input-params\": {\n \"PARAM-NAME-1\": {\n\
\ \"rawValue\": \"YOUR-VALUE-1\",\n \
\ \"type\": \"Integer\"\n },\n\
\ \"PARAM-NAME-2\": {\n \
\ \"rawValue\": \"YOUR-VALUE-2\",\n \"type\"\
: \"String\"\n },\n ...\n\
\ "
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateCircuitRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-qiskit.py
impl-language: qiskit
input-params: {}
required: true
responses:
"200":
description: Returns a content location for the generated circuit and its
properties. Access it via GET
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateCircuitResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
message:
type: string
description: Error message
errors:
type: object
description: Errors
status:
type: string
description: Error name
code:
type: integer
description: Error code
PaginationMetadata:
type: object
properties:
total:
type: integer
total_pages:
type: integer
first_page:
type: integer
last_page:
type: integer
page:
type: integer
previous_page:
type: integer
next_page:
type: integer
TranspileRequest:
type: object
properties:
impl_language:
type: string
qpu_name:
type: string
input_params:
type: array
items:
type: string
impl_url:
type: string
qasm_string:
type: string
token:
type: string
provider:
type: string
TranspileResponse:
type: object
properties:
depth:
type: integer
number_of_multi_qubit_gates:
type: integer
multi_qubit_gate_depth:
type: integer
width:
type: integer
total_number_of_operations:
type: integer
number_of_single_qubit_gates:
type: integer
number_of_measurement_operations:
type: integer
transpiled_qasm:
type: string
ExecuteRequest:
type: object
properties:
impl_language:
type: string
provider:
type: string
noise_model:
type: string
only_measurement_errors:
type: boolean
qpu_name:
type: string
correlation_id:
type: string
impl_url:
type: string
token:
type: string
input_params:
type: array
items:
type: string
ExecuteResponse:
type: object
properties:
location:
type: string
CalcCalibrationMatrixRequest:
type: object
properties:
token:
type: string
shots:
type: integer
qpu_name:
type: string
CalcCalibrationMatrixResponse:
type: object
properties:
location:
type: string
BenchmarkRequest:
type: object
properties:
min_depth:
type: integer
number_of_qubits:
type: integer
max_depth:
type: integer
number_of_circuits:
type: integer
qpu_name:
type: string
clifford:
type: boolean
shots:
type: integer
token:
type: string
BenchmarkResponse:
type: object
properties:
list:
type: array
items:
type: string
ResultsResponse:
type: object
properties:
post_processing_result:
type: array
items:
type: string
result:
type: array
items:
type: string
AnalysisOriginalCircuitRequest:
type: object
properties:
impl_language:
type: string
input_params:
type: array
items:
type: string
impl_url:
type: string
AnalysisOriginalCircuitResponse:
type: object
properties:
original_number_of_multi_qubit_gates:
type: integer
original_number_of_measurement_operations:
type: integer
original_total_number_of_operations:
type: integer
original_width:
type: integer
original_number_of_single_qubit_gates:
type: integer
original_multi_qubit_gate_depth:
type: integer
original_depth:
type: integer
GeneratedCircuitsResponse:
type: object
properties:
original_number_of_multi_qubit_gates:
type: integer
original_number_of_measurement_operations:
type: integer
generated_circuit:
type: string
original_total_number_of_operations:
type: integer
original_width:
type: integer
original_number_of_single_qubit_gates:
type: integer
original_multi_qubit_gate_depth:
type: integer
original_depth:
type: integer
GenerateCircuitRequest:
type: object
properties:
impl_language:
type: string
input_params:
type: array
items:
type: string
impl_url:
type: string
GenerateCircuitResponse:
type: object
properties:
location:
type: string
responses:
UNPROCESSABLE_ENTITY:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
DEFAULT_ERROR:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'