-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
transcribee-openapi.yaml
1826 lines (1826 loc) · 45.4 KB
/
transcribee-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
components:
schemas:
AlignTask:
properties:
document_id:
format: uuid
title: Document Id
type: string
task_parameters:
title: Task Parameters
type: object
task_type:
default: ALIGN
enum:
- ALIGN
title: Task Type
type: string
required:
- task_parameters
- document_id
title: AlignTask
type: object
ApiDocumentWithTasks:
properties:
changed_at:
title: Changed At
type: string
created_at:
title: Created At
type: string
id:
title: Id
type: string
media_files:
items:
$ref: '#/components/schemas/DocumentMedia'
title: Media Files
type: array
name:
title: Name
type: string
tasks:
items:
$ref: '#/components/schemas/TaskResponse'
title: Tasks
type: array
required:
- id
- name
- created_at
- changed_at
- media_files
- tasks
title: ApiDocumentWithTasks
type: object
AssignedTaskResponse:
properties:
current_attempt:
$ref: '#/components/schemas/TaskAttemptResponse'
dependencies:
items:
format: uuid
type: string
title: Dependencies
type: array
document:
$ref: '#/components/schemas/Document'
document_id:
format: uuid
title: Document Id
type: string
id:
format: uuid
title: Id
type: string
state:
$ref: '#/components/schemas/TaskState'
task_parameters:
title: Task Parameters
type: object
task_type:
$ref: '#/components/schemas/TaskType'
required:
- task_type
- task_parameters
- document_id
- id
- state
- dependencies
- document
title: AssignedTaskResponse
type: object
Body_add_media_file_api_v1_documents__document_id__add_media_file__post:
properties:
file:
format: binary
title: File
type: string
tags:
items:
type: string
title: Tags
type: array
required:
- tags
- file
title: Body_add_media_file_api_v1_documents__document_id__add_media_file__post
type: object
Body_create_document_api_v1_documents__post:
properties:
file:
format: binary
title: File
type: string
language:
title: Language
type: string
model:
title: Model
type: string
name:
title: Name
type: string
number_of_speakers:
title: Number Of Speakers
type: integer
required:
- name
- model
- language
- file
title: Body_create_document_api_v1_documents__post
type: object
Body_import_document_api_v1_documents_import__post:
properties:
media_file:
format: binary
title: Media File
type: string
name:
title: Name
type: string
required:
- media_file
- name
title: Body_import_document_api_v1_documents_import__post
type: object
ChangePasswordRequest:
properties:
new_password:
minLength: 6
title: New Password
type: string
old_password:
title: Old Password
type: string
required:
- old_password
- new_password
title: ChangePasswordRequest
type: object
CreateShareToken:
properties:
can_write:
title: Can Write
type: boolean
name:
title: Name
type: string
valid_until:
format: date-time
title: Valid Until
type: string
required:
- name
- can_write
title: CreateShareToken
type: object
CreateUser:
properties:
password:
title: Password
type: string
username:
title: Username
type: string
required:
- username
- password
title: CreateUser
type: object
CreateWorker:
properties:
name:
title: Name
type: string
required:
- name
title: CreateWorker
type: object
DeactivateWorker:
properties:
id:
format: uuid
title: Id
type: string
required:
- id
title: DeactivateWorker
type: object
Document:
properties:
changed_at:
title: Changed At
type: string
created_at:
title: Created At
type: string
id:
title: Id
type: string
media_files:
items:
$ref: '#/components/schemas/DocumentMedia'
title: Media Files
type: array
name:
title: Name
type: string
required:
- id
- name
- created_at
- changed_at
- media_files
title: Document
type: object
DocumentMedia:
properties:
content_type:
title: Content Type
type: string
tags:
items:
type: string
title: Tags
type: array
url:
title: Url
type: string
required:
- url
- content_type
- tags
title: DocumentMedia
type: object
DocumentShareTokenBase:
properties:
can_write:
title: Can Write
type: boolean
document_id:
format: uuid
title: Document Id
type: string
id:
format: uuid
title: Id
type: string
name:
title: Name
type: string
token:
title: Token
type: string
valid_until:
format: date-time
title: Valid Until
type: string
required:
- id
- name
- document_id
- token
- can_write
title: DocumentShareTokenBase
type: object
DocumentUpdateRequest:
properties:
name:
title: Name
type: string
title: DocumentUpdateRequest
type: object
DocumentWithAccessInfo:
properties:
can_write:
title: Can Write
type: boolean
changed_at:
title: Changed At
type: string
created_at:
title: Created At
type: string
has_full_access:
title: Has Full Access
type: boolean
id:
title: Id
type: string
media_files:
items:
$ref: '#/components/schemas/DocumentMedia'
title: Media Files
type: array
name:
title: Name
type: string
required:
- id
- name
- created_at
- changed_at
- media_files
- can_write
- has_full_access
title: DocumentWithAccessInfo
type: object
ExportError:
properties:
error:
title: Error
type: string
required:
- error
title: ExportError
type: object
ExportFormat:
description: An enumeration.
enum:
- VTT
- SRT
title: ExportFormat
type: string
ExportResult:
properties:
result:
title: Result
type: string
required:
- result
title: ExportResult
type: object
ExportTask:
properties:
document_id:
format: uuid
title: Document Id
type: string
task_parameters:
$ref: '#/components/schemas/ExportTaskParameters'
task_type:
default: EXPORT
enum:
- EXPORT
title: Task Type
type: string
required:
- task_parameters
- document_id
title: ExportTask
type: object
ExportTaskParameters:
properties:
format:
$ref: '#/components/schemas/ExportFormat'
include_speaker_names:
title: Include Speaker Names
type: boolean
include_word_timing:
title: Include Word Timing
type: boolean
max_line_length:
title: Max Line Length
type: integer
required:
- format
- include_speaker_names
- include_word_timing
title: ExportTaskParameters
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
KeepaliveBody:
properties:
progress:
title: Progress
type: number
title: KeepaliveBody
type: object
LoginResponse:
properties:
token:
title: Token
type: string
required:
- token
title: LoginResponse
type: object
ModelConfig:
properties:
id:
title: Id
type: string
languages:
items:
type: string
title: Languages
type: array
name:
title: Name
type: string
required:
- id
- name
- languages
title: ModelConfig
type: object
PageConfig:
properties:
footer_position:
title: Footer Position
type: integer
name:
title: Name
type: string
text:
title: Text
type: string
required:
- name
- text
title: PageConfig
type: object
PublicConfig:
properties:
logged_out_redirect_url:
title: Logged Out Redirect Url
type: string
models:
additionalProperties:
$ref: '#/components/schemas/ModelConfig'
title: Models
type: object
required:
- models
title: PublicConfig
type: object
SetDurationRequest:
properties:
duration:
title: Duration
type: number
required:
- duration
title: SetDurationRequest
type: object
ShortPageConfig:
properties:
footer_position:
title: Footer Position
type: integer
name:
title: Name
type: string
required:
- name
title: ShortPageConfig
type: object
SpeakerIdentificationTask:
properties:
document_id:
format: uuid
title: Document Id
type: string
task_parameters:
title: Task Parameters
type: object
task_type:
default: IDENTIFY_SPEAKERS
enum:
- IDENTIFY_SPEAKERS
title: Task Type
type: string
required:
- task_parameters
- document_id
title: SpeakerIdentificationTask
type: object
TaskAttemptResponse:
properties:
progress:
title: Progress
type: number
title: TaskAttemptResponse
type: object
TaskQueueInfoResponse:
properties:
open_tasks:
items:
$ref: '#/components/schemas/TaskQueueInfoTaskEntry'
title: Open Tasks
type: array
required:
- open_tasks
title: TaskQueueInfoResponse
type: object
TaskQueueInfoTaskEntry:
properties:
id:
format: uuid
title: Id
type: string
remaining_cost:
title: Remaining Cost
type: number
state:
$ref: '#/components/schemas/TaskState'
task_type:
$ref: '#/components/schemas/TaskType'
required:
- id
- task_type
- state
- remaining_cost
title: TaskQueueInfoTaskEntry
type: object
TaskResponse:
properties:
current_attempt:
$ref: '#/components/schemas/TaskAttemptResponse'
dependencies:
items:
format: uuid
type: string
title: Dependencies
type: array
document_id:
format: uuid
title: Document Id
type: string
id:
format: uuid
title: Id
type: string
state:
$ref: '#/components/schemas/TaskState'
task_parameters:
title: Task Parameters
type: object
task_type:
$ref: '#/components/schemas/TaskType'
required:
- task_type
- task_parameters
- document_id
- id
- state
- dependencies
title: TaskResponse
type: object
TaskState:
description: An enumeration.
enum:
- NEW
- ASSIGNED
- COMPLETED
- FAILED
title: TaskState
TaskType:
description: An enumeration.
enum:
- IDENTIFY_SPEAKERS
- TRANSCRIBE
- ALIGN
- REENCODE
- EXPORT
title: TaskType
type: string
TranscribeTask:
properties:
document_id:
format: uuid
title: Document Id
type: string
task_parameters:
$ref: '#/components/schemas/TranscribeTaskParameters'
task_type:
default: TRANSCRIBE
enum:
- TRANSCRIBE
title: Task Type
type: string
required:
- task_parameters
- document_id
title: TranscribeTask
type: object
TranscribeTaskParameters:
properties:
lang:
title: Lang
type: string
model:
title: Model
type: string
required:
- lang
- model
title: TranscribeTaskParameters
type: object
UnknownTask:
properties:
document_id:
format: uuid
title: Document Id
type: string
task_parameters:
title: Task Parameters
type: object
task_type:
title: Task Type
type: string
required:
- task_type
- task_parameters
- document_id
title: UnknownTask
type: object
UserBase:
properties:
username:
title: Username
type: string
required:
- username
title: UserBase
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
Worker:
properties:
deactivated_at:
format: date-time
title: Deactivated At
type: string
id:
format: uuid
title: Id
type: string
last_seen:
format: date-time
title: Last Seen
type: string
name:
title: Name
type: string
token:
title: Token
type: string
required:
- name
- token
title: Worker
type: object
WorkerWithId:
properties:
deactivated_at:
format: date-time
title: Deactivated At
type: string
id:
format: uuid
title: Id
type: string
last_seen:
format: date-time
title: Last Seen
type: string
name:
title: Name
type: string
required:
- name
title: WorkerWithId
type: object
securitySchemes:
HTTPBasic:
scheme: basic
type: http
info:
title: FastAPI
version: 0.1.0
openapi: 3.1.0
paths:
/:
get:
operationId: root__get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Root
/api/v1/config/:
get:
operationId: get_config_api_v1_config__get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PublicConfig'
description: Successful Response
summary: Get Config
/api/v1/documents/:
get:
operationId: list_documents_api_v1_documents__get
parameters:
- in: header
name: authorization
required: true
schema:
title: Authorization
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiDocumentWithTasks'
title: Response List Documents Api V1 Documents Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: List Documents
post:
operationId: create_document_api_v1_documents__post
parameters:
- in: header
name: authorization
required: true
schema:
title: Authorization
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_create_document_api_v1_documents__post'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Create Document
/api/v1/documents/import/:
post:
operationId: import_document_api_v1_documents_import__post
parameters:
- in: header
name: authorization
required: true
schema:
title: Authorization
type: string
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_import_document_api_v1_documents_import__post'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Import Document
/api/v1/documents/{document_id}/:
delete:
operationId: delete_document_api_v1_documents__document_id___delete
parameters:
- in: path
name: document_id
required: true
schema:
format: uuid
title: Document Id
type: string
- in: header
name: authorization
required: false
schema:
title: Authorization
type: string
- in: header
name: Share-Token
required: false
schema:
title: Share-Token
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Delete Document
get:
operationId: get_document_api_v1_documents__document_id___get
parameters:
- in: path
name: document_id
required: true
schema:
format: uuid
title: Document Id
type: string
- in: header
name: authorization
required: false
schema:
title: Authorization
type: string
- in: header
name: Share-Token
required: false
schema:
title: Share-Token
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentWithAccessInfo'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get Document
patch:
operationId: update_document_api_v1_documents__document_id___patch
parameters:
- in: path
name: document_id
required: true
schema:
format: uuid
title: Document Id
type: string
- in: header
name: authorization
required: false
schema:
title: Authorization
type: string
- in: header
name: Share-Token
required: false
schema:
title: Share-Token
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Update Document
/api/v1/documents/{document_id}/add_export_result/:
post:
operationId: add_export_result_api_v1_documents__document_id__add_export_result__post
parameters:
- in: path
name: document_id
required: true
schema:
format: uuid
title: Document Id
type: string
- in: query
name: task_id
required: true
schema:
title: Task Id
type: string
- in: header
name: authorization
required: false
schema:
title: Authorization
type: string
- in: header
name: Share-Token
required: false
schema:
title: Share-Token
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ExportResult'
- $ref: '#/components/schemas/ExportError'
title: Result
required: true
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json: