data/tingwu/2023-09-30/api-docs.php


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

<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'tingwu', 'version' => '2023-09-30'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'CreateTask' => [
            'path' => '/openapi/tingwu/v2/tasks',
            'methods' => ['put'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'type',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'operation',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'AppKey' => ['type' => 'string', 'required' => false],
                            'Input' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'SourceLanguage' => ['type' => 'string', 'required' => true],
                                    'FileUrl' => ['type' => 'string', 'required' => false],
                                    'TaskKey' => ['type' => 'string', 'required' => false],
                                    'Format' => ['type' => 'string', 'required' => false],
                                    'SampleRate' => [
                                        'type' => 'integer',
                                        'format' => 'int32',
                                        'required' => false,
                                        'enum' => ['16000', '8000'],
                                    ],
                                    'ProgressiveCallbacksEnabled' => ['type' => 'boolean', 'required' => false],
                                    'MultipleStreamsEnabled' => ['type' => 'boolean', 'required' => false],
                                    'TaskId' => ['type' => 'string', 'required' => false],
                                    'OutputPath' => ['type' => 'string', 'required' => false],
                                    'LanguageHints' => [
                                        'type' => 'array',
                                        'required' => false,
                                        'items' => ['type' => 'string', 'required' => false],
                                    ],
                                    'AudioChannelMode' => ['type' => 'string', 'required' => false],
                                ],
                            ],
                            'Parameters' => [
                                'type' => 'object',
                                'required' => false,
                                'properties' => [
                                    'Transcoding' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'TargetAudioFormat' => [
                                                'type' => 'string',
                                                'required' => false,
                                                'enum' => ['mp3'],
                                            ],
                                            'TargetVideoFormat' => [
                                                'type' => 'string',
                                                'required' => false,
                                                'enum' => ['mp4'],
                                            ],
                                            'VideoThumbnailEnabled' => ['type' => 'boolean', 'required' => false],
                                            'SpectrumEnabled' => ['type' => 'boolean', 'required' => false],
                                        ],
                                    ],
                                    'Transcription' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'AudioEventDetectionEnabled' => ['type' => 'boolean', 'required' => false],
                                            'DiarizationEnabled' => ['type' => 'boolean', 'required' => false],
                                            'Diarization' => [
                                                'type' => 'object',
                                                'required' => false,
                                                'properties' => [
                                                    'SpeakerCount' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                                ],
                                            ],
                                            'OutputLevel' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                            'AdditionalStreamOutputLevel' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                            'PhraseId' => ['type' => 'string', 'required' => false],
                                            'Model' => ['type' => 'string', 'required' => false],
                                            'RealtimeDiarizationEnabled' => ['type' => 'boolean', 'required' => false],
                                            'ProfanityFilterEnabled' => ['type' => 'boolean', 'required' => false],
                                        ],
                                    ],
                                    'Translation' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'TargetLanguages' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => ['type' => 'string', 'required' => false],
                                            ],
                                            'OutputLevel' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                            'AdditionalStreamOutputLevel' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                        ],
                                    ],
                                    'TranslationEnabled' => ['type' => 'boolean', 'required' => false],
                                    'AutoChaptersEnabled' => ['type' => 'boolean', 'required' => false],
                                    'MeetingAssistanceEnabled' => ['type' => 'boolean', 'required' => false],
                                    'MeetingAssistance' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'Types' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => ['type' => 'string', 'required' => false],
                                                'minItems' => 1,
                                            ],
                                        ],
                                    ],
                                    'SummarizationEnabled' => ['type' => 'boolean', 'required' => false],
                                    'Summarization' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'Types' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => ['type' => 'string', 'required' => false],
                                            ],
                                        ],
                                    ],
                                    'PptExtractionEnabled' => ['type' => 'boolean', 'required' => false],
                                    'TextPolishEnabled' => ['type' => 'boolean', 'required' => false],
                                    'ServiceInspectionEnabled' => ['type' => 'boolean', 'required' => false],
                                    'ServiceInspection' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'SceneIntroduction' => ['type' => 'string', 'required' => false],
                                            'InspectionIntroduction' => ['type' => 'string', 'required' => false],
                                            'InspectionContents' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => [
                                                    'type' => 'object',
                                                    'required' => false,
                                                    'properties' => [
                                                        'Title' => ['type' => 'string', 'required' => false],
                                                        'Content' => ['type' => 'string', 'required' => false],
                                                    ],
                                                ],
                                            ],
                                            'SpeakerMap' => ['type' => 'object', 'required' => false],
                                        ],
                                    ],
                                    'CustomPromptEnabled' => ['type' => 'boolean', 'required' => false],
                                    'CustomPrompt' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'Contents' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => [
                                                    'type' => 'object',
                                                    'required' => false,
                                                    'properties' => [
                                                        'Name' => ['type' => 'string', 'required' => true],
                                                        'Prompt' => ['type' => 'string', 'required' => true],
                                                        'Model' => ['type' => 'string', 'required' => false],
                                                        'TransType' => ['type' => 'string', 'required' => false],
                                                    ],
                                                ],
                                            ],
                                        ],
                                    ],
                                    'ExtraParams' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'NfixEnabled' => ['type' => 'boolean', 'required' => false],
                                            'MaxKeywords' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                            'DomainEducationEnabled' => ['type' => 'boolean', 'required' => false],
                                            'OcrAuxiliaryEnabled' => ['type' => 'boolean', 'required' => false],
                                            'TranslateLlmSceneEnabled' => ['type' => 'boolean', 'required' => false],
                                            'FullTextSummaryFormat' => ['type' => 'string', 'required' => false],
                                            'TranslationHotwordMap' => [
                                                'type' => 'object',
                                                'properties' => [
                                                    'bizUserId' => ['type' => 'string'],
                                                    'bizType' => ['type' => 'string'],
                                                ],
                                            ],
                                        ],
                                    ],
                                    'ContentExtractionEnabled' => ['type' => 'boolean', 'required' => false],
                                    'ContentExtraction' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'SceneIntroduction' => ['type' => 'string', 'required' => false],
                                            'ExtractionContents' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => [
                                                    'type' => 'object',
                                                    'required' => false,
                                                    'properties' => [
                                                        'Title' => ['type' => 'string', 'required' => false],
                                                        'Content' => ['type' => 'string', 'required' => false],
                                                        'Identity' => ['type' => 'string', 'required' => false],
                                                    ],
                                                ],
                                            ],
                                            'SpeakerMap' => ['type' => 'object', 'required' => false],
                                        ],
                                    ],
                                    'IdentityRecognitionEnabled' => ['type' => 'boolean', 'required' => false],
                                    'IdentityRecognition' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'SceneIntroduction' => ['type' => 'string', 'required' => false],
                                            'IdentityContents' => [
                                                'type' => 'array',
                                                'required' => false,
                                                'items' => [
                                                    'type' => 'object',
                                                    'required' => false,
                                                    'properties' => [
                                                        'Name' => ['type' => 'string', 'required' => false],
                                                        'Description' => ['type' => 'string', 'required' => false],
                                                    ],
                                                ],
                                            ],
                                        ],
                                    ],
                                    'AutoChapters' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'ChapterGranularity' => ['type' => 'string', 'required' => false],
                                        ],
                                    ],
                                    'Model' => ['type' => 'string', 'required' => false],
                                    'LlmOutputLanguage' => ['type' => 'string', 'required' => false],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'CreateTranscriptionPhrases' => [
            'path' => '/openapi/tingwu/v2/resources/phrases',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'Name' => ['type' => 'string', 'required' => true, 'minLength' => 1, 'maxLength' => 50],
                            'Description' => ['type' => 'string', 'required' => false, 'minLength' => 1, 'maxLength' => 250],
                            'WordWeights' => ['type' => 'string', 'required' => true],
                        ],
                    ],
                ],
            ],
        ],
        'DeleteTranscriptionPhrases' => [
            'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}',
            'methods' => ['delete'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PhraseId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'GetTaskInfo' => [
            'path' => '/openapi/tingwu/v2/tasks/{TaskId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'TaskId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'GetTranscriptionPhrases' => [
            'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PhraseId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListTranscriptionPhrases' => [
            'path' => '/openapi/tingwu/v2/resources/phrases',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [],
        ],
        'UpdateTranscriptionPhrases' => [
            'path' => '/openapi/tingwu/v2/resources/phrases/{PhraseId}',
            'methods' => ['put'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'PhraseId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'body',
                    'in' => 'body',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'Name' => ['type' => 'string', 'required' => true, 'minLength' => 1, 'maxLength' => 50],
                            'Description' => ['type' => 'string', 'required' => false, 'minLength' => 1, 'maxLength' => 250],
                            'WordWeights' => ['type' => 'string', 'required' => true],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'tingwu.cn-beijing.aliyuncs.com', 'endpoint' => 'tingwu.cn-beijing.aliyuncs.com', 'vpc' => 'tingwu-vpc.cn-beijing.aliyuncs.com'],
    ],
];