-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
apiDefinition.swagger.json
1201 lines (1201 loc) · 45.2 KB
/
apiDefinition.swagger.json
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
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Azure OpenAI Service",
"description": "Azure OpenAI Service provides access to OpenAI's powerful language models including the GPT-3, Codex and Embeddings model series. These models can be easily adapted to your specific task including but not limited to content generation, summarization, semantic search, and natural language to code translation.",
"version": "1.0",
"contact": {
"name": "Daniel Laskewitz",
"url": "https://aka.ms/laskewitz",
"email": "connectorsupport@laskewitz.io"
}
},
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://azure.microsoft.com/en-us/products/cognitive-services/openai-service"
},
{
"propertyName": "Privacy policy",
"propertyValue": "https://privacy.microsoft.com/en-us/privacystatement"
},
{
"propertyName": "Categories",
"propertyValue": "AI"
}
],
"host": "openai.azure.com",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/openai/deployments/{deployment-id}/chat/completions": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"description": "The completion returned by the OpenAI Chat endpoint"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/message"
},
"description": "The messages passed to the OpenAI Chat endpoint, with the answer received appended"
},
"raw-result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the completion.",
"title": "ID",
"x-ms-visibility": "advanced"
},
"object": {
"type": "string",
"description": "The type of model that was used for the completion.",
"title": "Object",
"x-ms-visibility": "important"
},
"created": {
"type": "integer",
"format": "int32",
"description": "Timestamp of the creation date.",
"title": "Created",
"x-ms-visibility": "advanced"
},
"model": {
"type": "string",
"description": "The model that was used for the completion.",
"title": "Model",
"x-ms-visibility": "important"
},
"choices": {
"type": "array",
"description": "Array of choices generated for the prompt.",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"format": "int32",
"description": "The index of the predicted completion.",
"title": "Index",
"x-ms-visibility": "advanced"
},
"finish_reason": {
"type": "string",
"description": "The reason why the completion finished.",
"title": "Finish reason",
"x-ms-visibility": "advanced"
},
"message": {
"$ref": "#/definitions/message"
}
}
}
},
"usage": {
"type": "object",
"description": "The tokens used in this request.",
"properties": {
"completion_tokens": {
"type": "integer",
"format": "int32",
"description": "The number of tokens used for the completion.",
"title": "Completion tokens",
"x-ms-visibility": "advanced"
},
"prompt_tokens": {
"type": "integer",
"format": "int32",
"description": "The number of tokens used for the prompt.",
"title": "Prompt tokens",
"x-ms-visibility": "advanced"
},
"total_tokens": {
"type": "integer",
"format": "int32",
"description": "The total number of tokens used for the request.",
"title": "Total tokens",
"x-ms-visibility": "advanced"
}
}
}
},
"description": "The raw result returned by the OpenAI Chat endpoint"
}
}
}
}
},
"summary": "Chat Completion (Preview)",
"description": "This operation generates completions for a given prompt. The prompt is a conversation between two or more people. The completion is generated by the model for the given conversation.",
"operationId": "ChatCompletion",
"parameters": [
{
"name": "deployment-id",
"in": "path",
"required": true,
"type": "string",
"x-ms-visibility": "important",
"description": "The ID of the deployment to use for this request (must use a deployment with a chat model).",
"x-ms-summary": "Deployment ID",
"x-ms-url-encoding": "single",
"x-ms-dynamic-values": {
"operationId": "ListDeployments",
"value-path": "id",
"value-collection": "data",
"value-title": "model",
"parameters": {
"api-version": "2022-12-01"
}
}
},
{
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"default": "2023-03-15-preview",
"x-ms-visibility": "advanced",
"description": "The API version for this REST call to Azure OpenAI. Must be 2023-03-15-preview or later",
"x-ms-summary": "Azure OpenAI API Version (must be 2023-03-15-preview or later)"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/message"
},
"description": "The messages (context) passed to and from the API prior to this in the conversation"
},
"user_message": {
"type": "string",
"description": "Message for the chat API to respond to",
"title": "User message",
"x-ms-visibility": "important",
"default": "Tell me more about that"
},
"system_instruction": {
"type": "string",
"description": "The initial prompt or instructions to the model",
"title": "System Instructions",
"x-ms-visibility": "important",
"default": "You are a helpful assistant. Answer in a friendly, informal tone."
},
"max_tokens": {
"type": "integer",
"format": "int32",
"description": "The maximum number of tokens to generate.",
"title": "Max tokens",
"x-ms-visibility": "advanced",
"default": 2048
},
"temperature": {
"type": "number",
"format": "float",
"description": "The temperature of the model. Higher values will result in more random completions. Lower values will result in more predictable completions.",
"title": "Temperature",
"x-ms-visibility": "advanced",
"default": 0.9
},
"presence_penalty": {
"type": "number",
"format": "float",
"description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.",
"title": "Presence penalty",
"x-ms-visibility": "advanced",
"default": 0
},
"frequency_penalty": {
"type": "number",
"format": "float",
"description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.",
"title": "Frequency penalty",
"x-ms-visibility": "advanced",
"default": 0
},
"top_p": {
"type": "number",
"format": "float",
"description": "The cumulative probability for top-k sampling. The higher the value, the more constrained the completions will be.",
"title": "Top p",
"x-ms-visibility": "advanced",
"default": 1
},
"n": {
"type": "integer",
"format": "int32",
"description": "The number of choices to return.",
"title": "N",
"x-ms-visibility": "advanced",
"default": 1
},
"stream": {
"type": "boolean",
"description": "Whether to stream the response.",
"title": "Stream",
"x-ms-visibility": "advanced",
"default": false
},
"stop": {
"type": "string",
"description": "Up to 4 sequences where the API will stop generating further tokens.",
"title": "Stop",
"x-ms-visibility": "advanced",
"default": "None"
},
"user": {
"type": "string",
"description": "The user ID to associate with this request. This is used to prevent the same user from generating the same response multiple times.",
"title": "User",
"x-ms-visibility": "advanced",
"default": "None"
}
},
"description": "The body of the request",
"title": "",
"x-ms-visibility": "important",
"x-ms-summary": "Request body"
}
}
]
}
},
"/openai/deployments/{deployment-id}/completions": {
"post": {
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"raw-result": {
"type": "object",
"description": "The raw result from the API call",
"title": "Raw result",
"x-ms-visibility": "advanced",
"properties": {
"id": {
"type": "string",
"description": "ID of the completion.",
"title": "ID",
"x-ms-visibility": "advanced"
},
"object": {
"type": "string",
"description": "The type of model that was used for the completion.",
"title": "Object",
"x-ms-visibility": "important"
},
"created": {
"type": "integer",
"format": "int32",
"description": "Timestamp of the creation date.",
"title": "Created",
"x-ms-visibility": "advanced"
},
"model": {
"type": "string",
"description": "The model that was used for the completion.",
"title": "Model",
"x-ms-visibility": "important"
},
"choices": {
"type": "array",
"description": "Array of choices generated for the prompt.",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The text of the completion.",
"title": "Completion text",
"x-ms-visibility": "important"
},
"index": {
"type": "integer",
"format": "int32",
"description": "The index of the predicted completion.",
"title": "Index",
"x-ms-visibility": "important"
},
"finish_reason": {
"type": "string",
"description": "The reason why the completion finished.",
"title": "Finish reason",
"x-ms-visibility": "advanced"
},
"logprobs": {
"type": "string",
"description": "The probability that the token occurs next given the prompt.",
"title": "Logprobs",
"x-ms-visibility": "advanced"
}
}
}
},
"usage": {
"type": "object",
"description": "The tokens used in this request.",
"properties": {
"completion_tokens": {
"type": "integer",
"format": "int32",
"description": "The amount of completion tokens used in this request.",
"title": "Completion tokens"
},
"prompt_tokens": {
"type": "integer",
"format": "int32",
"description": "The amount of prompt tokens used in this request.",
"title": "Prompt tokens"
},
"total_tokens": {
"type": "integer",
"format": "int32",
"description": "The total amount of tokens used in this request.",
"title": "Total tokens"
}
}
}
}
},
"initial_scope": {
"type": "string",
"description": "The initial scope of the request",
"title": "Initial scope",
"x-ms-visibility": "important"
},
"answer": {
"type": "string",
"description": "The answer to the prompt",
"title": "Answer",
"x-ms-visibility": "important"
},
"history": {
"type": "array",
"items": {
"$ref": "#/definitions/qapair"
},
"description": "The history of the request",
"title": "History",
"x-ms-visibility": "important"
}
}
}
}
},
"summary": "Create a completion",
"description": "The model will generate one or more predicted completions based on a provided prompt. The service can also return the probabilities of alternative tokens at each position.",
"operationId": "CreateCompletion",
"x-ms-visibility": "important",
"parameters": [
{
"$ref": "#/parameters/deployment"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "body",
"in": "body",
"required": false,
"schema": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "The prompt to generate the completion for",
"title": "Prompt",
"x-ms-visibility": "important"
},
"max_tokens": {
"type": "integer",
"format": "int32",
"description": "Set a limit on the number of tokens per model response. The API supports a maximum of 2048 tokens shared between the prompt (including system message, examples, message history, and user query) and the model's response. One token is roughly 4 characters for typical English text.",
"title": "Max length (tokens)",
"default": 256,
"x-ms-visibility": "advanced"
},
"temperature": {
"type": "number",
"format": "float",
"description": "What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. We generally recommend altering this or top_p but not both.",
"title": "Temperature",
"x-ms-visibility": "advanced",
"default": 0.2
},
"top_p": {
"type": "number",
"format": "float",
"description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.",
"title": "Top Probabilities",
"x-ms-visibility": "advanced",
"default": 1
},
"n": {
"type": "integer",
"format": "int32",
"description": "How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.",
"title": "N",
"x-ms-visibility": "advanced",
"default": 1
},
"stream": {
"type": "boolean",
"description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.",
"title": "Stream",
"x-ms-visibility": "advanced",
"enum": [
true,
false
]
},
"logprobs": {
"type": "integer",
"format": "int32",
"description": "Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 10, the API will return a list of the 10 most likely tokens. the API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.",
"title": "Logprobs",
"x-ms-visibility": "advanced"
},
"echo": {
"type": "boolean",
"description": "Echo back the prompt in addition to the completion.",
"title": "Echo",
"x-ms-visibility": "advanced",
"enum": [
true,
false
],
"default": false
},
"stop": {
"type": "string",
"description": "Make responses stop at a desired point, such as the end of a sentence or list. Specify up to four sequences where the model will stop generating further tokens in a response. The returned text will not contain the stop sequence.",
"title": "Stop sequences",
"x-ms-visibility": "advanced"
},
"presence_penalty": {
"type": "number",
"format": "float",
"description": "Reduce the chance of repeating any token that has appeared in the text at all so far. This increases the likelihood of introducing new topics in a response. (Number between 0 and 2)",
"title": "Presence penalty",
"x-ms-visibility": "advanced",
"default": 0
},
"frequency_penalty": {
"type": "number",
"format": "float",
"description": "Reduce the chance of repeating a token proportionally based on how often it has appeared in the text so far. This decreases the likelihood of repeating the exact same text in a response.",
"title": "Frequency penalty",
"x-ms-visibility": "advanced",
"default": 0
},
"best_of": {
"type": "integer",
"format": "int32",
"description": "Generates best_of completions server-side and returns the \"best\" (the one with the lowest log probability per token). Results can't be streamed. When used with n, best_of controls the number of candidate completions and n specifies how many to return \u2013 best_of must be greater than n. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.",
"title": "Best of",
"x-ms-visibility": "advanced",
"default": 1
},
"logit_bias": {
"type": "object",
"properties": { },
"description": "logit_bias",
"x-ms-visibility": "advanced"
},
"initial_scope": {
"type": "string",
"description": "Initial scope or instruction to the model",
"x-ms-visibility": "important",
"title": "Initial scope",
"default": "You are a helpful assistant"
},
"history": {
"type": "array",
"items": {
"$ref": "#/definitions/qapair"
},
"description": "The history of the request",
"title": "History",
"x-ms-visibility": "important"
}
}
}
}
]
}
},
"/openai/deployments/{deployment-id}/embeddings": {
"post": {
"responses": {
"200": {
"description": "default",
"schema": {
"type": "object",
"properties": {
"object": {
"type": "string",
"description": "object"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"type": "string",
"description": "object"
},
"embedding": {
"type": "array",
"items": {
"type": "number",
"format": "float"
},
"description": "Created embedding vector"
},
"index": {
"type": "integer",
"format": "int32",
"description": "index"
}
}
},
"description": "data"
},
"model": {
"type": "string",
"description": "The used OpenAI model"
}
}
}
}
},
"summary": "Embeddings",
"description": "Creates an embedding vector representing the input text",
"operationId": "Embeddings",
"parameters": [
{
"$ref": "#/parameters/deployment"
},
{
"$ref": "#/parameters/api-version"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"input": {
"type": "string",
"description": "Input text to get embeddings for",
"title": "input"
}
},
"required": [
"input"
]
}
}
]
}
},
"/openai/deployments": {
"get": {
"summary": "List deployments",
"description": "List Azure OpenAI Service Deployments",
"operationId": "ListDeployments",
"x-ms-visibility": "advanced",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/deployment"
},
"title": "Data",
"description": "The list of items."
},
"object": {
"type": "string",
"title": "Object",
"description": "The type of object."
}
}
}
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "CreateDeployment",
"description": "Creates a new deployment for the Azure OpenAI resource according to the given specification.",
"x-ms-visibility": "advanced",
"responses": {
"201": {
"$ref": "#/responses/createdeployment201"
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"name": "body",
"in": "body",
"required": false,
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "The Azure OpenAI Service model identifier (model-id) to deploy. Can be a base model or a fine tune.",
"title": "Model",
"x-ms-visibility": "important",
"x-ms-dynamic-values": {
"operationId": "ListModels",
"value-path": "id",
"value-collection": "data",
"value-title": "id",
"parameters": {
"api-version": "2022-12-01"
}
}
},
"scale_settings": {
"$ref": "#/definitions/scale_settings"
}
},
"required": [
"scale_settings",
"model"
]
}
}
]
}
},
"/openai/deployments/{deployment-id}": {
"get": {
"summary": "Get deployment",
"operationId": "GetDeployment",
"description": "Gets details for a single deployment specified by the given deployment.",
"x-ms-visibility": "important",
"responses": {
"200": {
"description": "default",
"schema": {
"$ref": "#/definitions/models"
}
}
},
"parameters": [
{
"$ref": "#/parameters/deployment"
},
{
"$ref": "#/parameters/api-version"
}
]
},
"delete": {
"summary": "Delete deployment",
"description": "Deletes the specified deployment.",
"operationId": "DeleteDeployment",
"x-ms-visibility": "advanced",
"responses": {
"204": {
"description": "Deleted",
"schema": { }
}
},
"parameters": [
{
"$ref": "#/parameters/deployment"
},
{
"$ref": "#/parameters/api-version"
}
]
}
},
"/openai/deployments/{deployment-id}/images/generations": {
"post": {
"responses": {
"202": {
"description": "202 Accepted",
"schema": {
"type": "object",
"properties": {
"created": {
"type": "integer",
"title": "Created",
"format": "int32",
"description": "The unix timestamp when the operation was created."
},
"data": {
"type": "array",
"items": {
"type": "object",
"description": "The image url or encoded image if successful, and an error otherwise.",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "The image url."
},
"b64_json": {
"type": "string",
"title": "B64 JSON",
"description": "The base64 encoded image"
},
"revised_prompt": {
"type": "string",
"title": "Revised Prompt",
"description": "The prompt that was used to generate the image, if there was any revision to the prompt."
}
}
},
"description": "The result data of the operation, if successful"
}
}
}
}
},
"summary": "Request a generated image with DALL-E 3 (preview)",
"description": "Generates an image from a text caption on a given DALL-E 3 model deployment",
"operationId": "ImageGenerations_Create",
"parameters": [
{
"$ref": "#/parameters/deployment"
},
{
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"default": "2023-12-01-preview",
"x-ms-visibility": "internal",
"description": "The API version for this REST call to Azure OpenAI. Must be 2023-12-01-preview or later",
"x-ms-summary": "Azure OpenAI API Version (must be 2023-12-01-preview or later)"
},
{
"name": "body",
"in": "body",
"required": false,
"schema": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "A text description of the desired image(s). The maximum length is 4000 characters.",
"title": "Prompt",
"x-ms-visibility": "important"
},
"n": {
"type": "integer",
"format": "int32",
"description": "The number of images to generate. Only one is supported for DALL-E 3.",
"title": "N",
"default": 1,
"x-ms-visibility": "internal"
},
"size": {
"type": "string",
"description": "size",
"title": "Size",
"enum": [
"1024x1024",
"1024x1792",
"1792x1024"
],
"default": "1024x1024",
"x-ms-visibility": "advanced"
},
"quality": {
"type": "string",
"description": "The quality of the generated images. Must be hd or standard.",
"title": "Quality",
"default": "standard",
"enum": [
"standard",
"hd"
],
"x-ms-visibility": "advanced"
},
"response_format": {
"type": "string",
"description": "The format in which the generated images are returned Must be url (a URL pointing to the image) or b64_json (the base 64 byte code in JSON format).",
"title": "Response Format",
"default": "url",
"enum": [
"url",
"b64_json"
],
"x-ms-visibility": "advanced"
},
"style": {
"type": "string",
"description": "The style of the generated images. Must be natural or vivid (for hyper-realistic / dramatic images).",
"title": "Style",
"default": "vivid",
"x-ms-visibility": "advanced",
"enum": [
"vivid",
"natural"
]
}
},
"required": [
"prompt",
"n"
]
}
}
]
}
},
"/openai/models": {
"get": {
"summary": "List models",
"operationId": "ListModels",
"description": "Gets a list of all models that are accessible by the Azure OpenAI resource. These include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.",
"x-ms-visibility": "advanced",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models"
}
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
}
]
}
}
},
"definitions": {
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "The role of the author of this message",
"title": "",
"enum": [
"system",
"user",
"assistant"
]
},
"content": {
"type": "string",
"description": "The contents of the message",
"title": ""
}
},
"required": [
"content",
"role"
]
},
"qapair": {
"type": "object",
"properties": {
"question": {
"type": "string",
"description": "the question or prompt",
"title": "Question"
},
"answer": {
"type": "string",
"description": "the answer to the question or prompt",
"title": "Answer"
}
}
},
"capabilities": {
"title": "Capabilities",
"description": "The capabilities of a base or fine tune model.",
"type": "object",
"properties": {
"fine_tune": {
"type": "boolean",
"title": "Fine tune",
"description": "A value indicating whether a model can be used for fine tuning."
},
"inference": {
"type": "boolean",
"title": "Inference",
"description": "A value indicating whether a model can be deployed."
},
"completion": {
"type": "boolean",
"title": "Completion",
"description": "A value indicating whether a model supports completion."
},
"embeddings": {
"type": "boolean",
"title": "Embeddings",
"description": "A value indicating whether a model supports embeddings."
},
"scale_types": {
"type": "array",
"title": "Scale types",
"description": "The supported scale types for deployments of this model.",
"items": {
"type": "string"
}
}
}
},
"deployment": {
"title": "Deployment",
"type": "object",
"properties": {
"created_at": {
"type": "integer",
"format": "int32",
"title": "Created at",
"description": "A timestamp when this job or item was created (in unix epochs)."
},
"id": {
"type": "string",