-
Notifications
You must be signed in to change notification settings - Fork 59
/
openapi.yaml
3350 lines (3346 loc) · 94.9 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
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
openapi: 3.1.0
info:
title: Mistral AI API
description: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.
version: 0.0.2
paths:
/v1/models:
get:
summary: List Models
description: List all models available to the user.
operationId: list_models_v1_models_get
responses:
"200":
description: Successful Response
content:
application/json:
schema:
$ref: "#/components/schemas/ModelList"
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- models
/v1/models/{model_id}:
get:
summary: Retrieve Model
description: Retrieve a model information.
operationId: retrieve_model_v1_models__model_id__get
parameters:
- name: model_id
in: path
required: true
schema:
type: string
title: Model Id
example: "ft:open-mistral-7b:587a6b29:20240514:7e773925"
description: The ID of the model to retrieve.
responses:
"200":
description: Successful Response
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/BaseModelCard"
- $ref: "#/components/schemas/FTModelCard"
discriminator:
propertyName: type
mapping:
base: "#/components/schemas/BaseModelCard"
fine-tuned: "#/components/schemas/FTModelCard"
title: Response Retrieve Model V1 Models Model Id Get
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- models
delete:
summary: Delete Model
description: Delete a fine-tuned model.
operationId: delete_model_v1_models__model_id__delete
parameters:
- name: model_id
in: path
required: true
schema:
type: string
title: Model Id
example: "ft:open-mistral-7b:587a6b29:20240514:7e773925"
description: The ID of the model to delete.
responses:
"200":
description: Successful Response
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteModelOut"
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- models
/v1/files:
post:
operationId: files_api_routes_upload_file
summary: Upload File
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/UploadFileOut"
description: "Upload a file that can be used across various endpoints.
The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files.
Please contact us if you need to increase these storage limits."
requestBody:
content:
multipart/form-data:
schema:
title: MultiPartBodyParams
type: object
properties:
purpose:
allOf:
- enum:
- fine-tune
- batch
title: FilePurpose
type: string
default: fine-tune
file:
format: binary
title: File
type: string
description: "The File object (not file name) to be uploaded.\n To upload a file and specify a custom file name you should format your request as such:\n ```bash\n file=@path/to/your/file.jsonl;filename=custom_name.jsonl\n ```\n Otherwise, you can just keep the original file name:\n ```bash\n file=@path/to/your/file.jsonl\n ```"
required:
- file
required: true
tags:
- files
get:
operationId: files_api_routes_list_files
summary: List Files
parameters:
- in: query
name: page
schema:
default: 0
title: Page
type: integer
required: false
- in: query
name: page_size
schema:
default: 100
title: Page Size
type: integer
required: false
- in: query
name: sample_type
schema:
anyOf:
- items:
$ref: "#/components/schemas/SampleType"
type: array
- type: "null"
title: Sample Type
required: false
- in: query
name: source
schema:
anyOf:
- items:
$ref: "#/components/schemas/Source"
type: array
- type: "null"
title: Source
required: false
- in: query
name: search
schema:
anyOf:
- type: string
- type: "null"
title: Search
required: false
- in: query
name: purpose
schema:
anyOf:
- $ref: "#/components/schemas/FilePurpose"
- type: "null"
required: false
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ListFilesOut"
description: Returns a list of files that belong to the user's organization.
tags:
- files
/v1/files/{file_id}:
get:
operationId: files_api_routes_retrieve_file
summary: Retrieve File
parameters:
- in: path
name: file_id
schema:
title: File Id
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RetrieveFileOut"
description: Returns information about a specific file.
tags:
- files
delete:
operationId: files_api_routes_delete_file
summary: Delete File
parameters:
- in: path
name: file_id
schema:
title: File Id
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteFileOut"
description: Delete a file.
tags:
- files
/v1/files/{file_id}/content:
get:
operationId: files_api_routes_download_file
summary: Download File
parameters:
- in: path
name: file_id
schema:
title: File Id
type: string
required: true
responses:
"200":
description: OK
content:
application/octet-stream:
schema:
type: string
format: binary
description: Download a file
tags:
- files
/v1/fine_tuning/jobs:
get:
operationId: jobs_api_routes_fine_tuning_get_fine_tuning_jobs
summary: Get Fine Tuning Jobs
parameters:
- in: query
name: page
schema:
default: 0
title: Page
type: integer
required: false
description: The page number of the results to be returned.
- in: query
name: page_size
schema:
default: 100
title: Page Size
type: integer
required: false
description: The number of items to return per page.
- in: query
name: model
schema:
anyOf:
- type: string
- type: "null"
title: Model
required: false
description: The model name used for fine-tuning to filter on. When set, the other results are not displayed.
- in: query
name: created_after
schema:
anyOf:
- format: date-time
type: string
- type: "null"
title: Created After
required: false
description: The date/time to filter on. When set, the results for previous creation times are not displayed.
- in: query
name: created_by_me
schema:
default: false
title: Created By Me
type: boolean
required: false
description: When set, only return results for jobs created by the API caller. Other results are not displayed.
- in: query
name: status
schema:
anyOf:
- enum:
- QUEUED
- STARTED
- VALIDATING
- VALIDATED
- RUNNING
- FAILED_VALIDATION
- FAILED
- SUCCESS
- CANCELLED
- CANCELLATION_REQUESTED
type: string
- type: "null"
title: Status
required: false
description: The current job state to filter on. When set, the other results are not displayed.
- in: query
name: wandb_project
schema:
anyOf:
- type: string
- type: "null"
title: Wandb Project
required: false
description: The Weights and Biases project to filter on. When set, the other results are not displayed.
- in: query
name: wandb_name
schema:
anyOf:
- type: string
- type: "null"
title: Wandb Name
required: false
description: The Weight and Biases run name to filter on. When set, the other results are not displayed.
- in: query
name: suffix
schema:
anyOf:
- type: string
- type: "null"
title: Suffix
required: false
description: The model suffix to filter on. When set, the other results are not displayed.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/JobsOut"
description: Get a list of fine-tuning jobs for your organization and user.
tags:
- fine-tuning
post:
operationId: jobs_api_routes_fine_tuning_create_fine_tuning_job
summary: Create Fine Tuning Job
parameters:
- in: query
name: dry_run
schema:
anyOf:
- type: boolean
- type: "null"
title: Dry Run
required: false
description: |
* If `true` the job is not spawned, instead the query returns a handful of useful metadata
for the user to perform sanity checks (see `LegacyJobMetadataOut` response).
* Otherwise, the job is started and the query returns the job ID along with some of the
input parameters (see `JobOut` response).
responses:
"200":
description: OK
content:
application/json:
schema:
anyOf:
- $ref: "#/components/schemas/JobOut"
- $ref: "#/components/schemas/LegacyJobMetadataOut"
title: Response
description: Create a new fine-tuning job, it will be queued for processing.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/JobIn"
required: true
tags:
- fine-tuning
/v1/fine_tuning/jobs/{job_id}:
get:
operationId: jobs_api_routes_fine_tuning_get_fine_tuning_job
summary: Get Fine Tuning Job
parameters:
- in: path
name: job_id
schema:
format: uuid
title: Job Id
type: string
required: true
description: The ID of the job to analyse.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DetailedJobOut"
description: Get a fine-tuned job details by its UUID.
tags:
- fine-tuning
/v1/fine_tuning/jobs/{job_id}/cancel:
post:
operationId: jobs_api_routes_fine_tuning_cancel_fine_tuning_job
summary: Cancel Fine Tuning Job
parameters:
- in: path
name: job_id
schema:
format: uuid
title: Job Id
type: string
required: true
description: The ID of the job to cancel.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DetailedJobOut"
description: Request the cancellation of a fine tuning job.
tags:
- fine-tuning
/v1/fine_tuning/jobs/{job_id}/start:
post:
operationId: jobs_api_routes_fine_tuning_start_fine_tuning_job
summary: Start Fine Tuning Job
parameters:
- in: path
name: job_id
schema:
format: uuid
title: Job Id
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/DetailedJobOut"
description: Request the start of a validated fine tuning job.
tags:
- fine-tuning
/v1/fine_tuning/models/{model_id}:
patch:
operationId: jobs_api_routes_fine_tuning_update_fine_tuned_model
summary: Update Fine Tuned Model
parameters:
- in: path
name: model_id
schema:
title: Model Id
type: string
required: true
example: "ft:open-mistral-7b:587a6b29:20240514:7e773925"
description: The ID of the model to update.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/FTModelOut"
description: Update a model name or description.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateFTModelIn"
required: true
tags:
- models
/v1/fine_tuning/models/{model_id}/archive:
post:
operationId: jobs_api_routes_fine_tuning_archive_fine_tuned_model
summary: Archive Fine Tuned Model
parameters:
- in: path
name: model_id
schema:
title: Model Id
type: string
required: true
example: "ft:open-mistral-7b:587a6b29:20240514:7e773925"
description: The ID of the model to archive.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/ArchiveFTModelOut"
description: Archive a fine-tuned model.
tags:
- models
delete:
operationId: jobs_api_routes_fine_tuning_unarchive_fine_tuned_model
summary: Unarchive Fine Tuned Model
parameters:
- in: path
name: model_id
schema:
title: Model Id
type: string
required: true
example: "ft:open-mistral-7b:587a6b29:20240514:7e773925"
description: The ID of the model to unarchive.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/UnarchiveFTModelOut"
description: Un-archive a fine-tuned model.
tags:
- models
/v1/batch/jobs:
get:
operationId: jobs_api_routes_batch_get_batch_jobs
summary: Get Batch Jobs
parameters:
- in: query
name: page
schema:
default: 0
title: Page
type: integer
required: false
- in: query
name: page_size
schema:
default: 100
title: Page Size
type: integer
required: false
- in: query
name: model
schema:
anyOf:
- type: string
- type: "null"
title: Model
required: false
- in: query
name: metadata
schema:
anyOf:
- type: object
additionalProperties: true
- type: "null"
title: Metadata
required: false
- in: query
name: created_after
schema:
anyOf:
- format: date-time
type: string
- type: "null"
title: Created After
required: false
- in: query
name: created_by_me
schema:
default: false
title: Created By Me
type: boolean
required: false
- in: query
name: status
schema:
anyOf:
- $ref: "#/components/schemas/BatchJobStatus"
- type: "null"
required: false
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BatchJobsOut"
description: Get a list of batch jobs for your organization and user.
tags:
- batch
post:
operationId: jobs_api_routes_batch_create_batch_job
summary: Create Batch Job
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BatchJobOut"
description: Create a new batch job, it will be queued for processing.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/BatchJobIn"
required: true
tags:
- batch
/v1/batch/jobs/{job_id}:
get:
operationId: jobs_api_routes_batch_get_batch_job
summary: Get Batch Job
parameters:
- in: path
name: job_id
schema:
format: uuid
title: Job Id
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BatchJobOut"
description: Get a batch job details by its UUID.
tags:
- batch
/v1/batch/jobs/{job_id}/cancel:
post:
operationId: jobs_api_routes_batch_cancel_batch_job
summary: Cancel Batch Job
parameters:
- in: path
name: job_id
schema:
format: uuid
title: Job Id
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/BatchJobOut"
description: Request the cancellation of a batch job.
tags:
- batch
/v1/chat/completions:
post:
summary: Chat Completion
operationId: chat_completion_v1_chat_completions_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ChatCompletionRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/ChatCompletionResponse" }
text/event-stream:
schema:
$ref: "#/components/schemas/CompletionEvent"
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- chat
/v1/fim/completions:
post:
summary: Fim Completion
description: FIM completion.
operationId: fim_completion_v1_fim_completions_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FIMCompletionRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/FIMCompletionResponse" }
text/event-stream:
schema:
$ref: "#/components/schemas/CompletionEvent"
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- fim
/v1/agents/completions:
post:
summary: Agents Completion
operationId: agents_completion_v1_agents_completions_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AgentsCompletionRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/ChatCompletionResponse" }
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- agents
/v1/embeddings:
post:
summary: Embeddings
description: "Embeddings"
operationId: embeddings_v1_embeddings_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/EmbeddingRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/EmbeddingResponse" }
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- embeddings
/v1/moderations:
post:
summary: Moderations
operationId: moderations_v1_moderations_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClassificationRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/ClassificationResponse" }
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- classifiers
/v1/chat/moderations:
post:
summary: Moderations Chat
operationId: moderations_chat_v1_chat_moderations_post
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ChatClassificationRequest"
responses:
"200":
description: Successful Response
content:
application/json:
schema: { $ref: "#/components/schemas/ClassificationResponse" }
"422":
description: Validation Error
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
tags:
- classifiers
components:
schemas:
BaseModelCard:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
default: mistralai
capabilities:
$ref: "#/components/schemas/ModelCapabilities"
name:
anyOf:
- type: string
- type: "null"
title: Name
description:
anyOf:
- type: string
- type: "null"
title: Description
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
items:
type: string
type: array
title: Aliases
default: []
deprecation:
anyOf:
- type: string
format: date-time
- type: "null"
title: Deprecation
default_model_temperature:
anyOf:
- type: number
- type: "null"
title: Default Model Temperature
type:
type: string
enum:
- base
const: base
title: Type
default: base
type: object
required:
- id
- capabilities
title: BaseModelCard
DeleteModelOut:
properties:
id:
type: string
title: Id
description: The ID of the deleted model.
examples:
- ft:open-mistral-7b:587a6b29:20240514:7e773925
object:
type: string
title: Object
default: model
description: The object type that was deleted
deleted:
type: boolean
title: Deleted
default: true
description: The deletion status
examples:
- True
type: object
required:
- id
title: DeleteModelOut
FTModelCard:
properties:
id:
type: string
title: Id
object:
type: string
title: Object
default: model
created:
type: integer
title: Created
owned_by:
type: string
title: Owned By
default: mistralai
capabilities:
$ref: "#/components/schemas/ModelCapabilities"
name:
anyOf:
- type: string
- type: "null"
title: Name
description:
anyOf:
- type: string
- type: "null"
title: Description
max_context_length:
type: integer
title: Max Context Length
default: 32768
aliases:
items:
type: string
type: array
title: Aliases
default: []
deprecation:
anyOf:
- type: string
format: date-time
- type: "null"
title: Deprecation
default_model_temperature:
anyOf:
- type: number
- type: "null"
title: Default Model Temperature
type:
type: string
enum:
- fine-tuned
const: fine-tuned
title: Type
default: fine-tuned
job:
type: string
title: Job
root:
type: string
title: Root
archived:
type: boolean
title: Archived
default: false
type: object
required:
- id
- capabilities
- job
- root
title: FTModelCard
description: Extra fields for fine-tuned models.
HTTPValidationError:
properties:
detail:
items:
$ref: "#/components/schemas/ValidationError"
type: array
title: Detail
type: object
title: HTTPValidationError
ModelCapabilities:
properties:
completion_chat: