|
61 | 61 | "paths": { |
62 | 62 | "/deployments/{deploymentId}/audio/transcriptions": { |
63 | 63 | "post": { |
64 | | - "operationId": "GetAudioTranscriptionAsResponseObject", |
| 64 | + "operationId": "GetAudioTranscriptionAsPlainText", |
65 | 65 | "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", |
66 | | - "consumes": [ |
67 | | - "multipart/form-data" |
68 | | - ], |
69 | 66 | "parameters": [ |
70 | 67 | { |
71 | 68 | "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" |
|
78 | 75 | "type": "string" |
79 | 76 | }, |
80 | 77 | { |
81 | | - "$ref": "#/parameters/AudioTranscriptionOptions.file" |
82 | | - }, |
83 | | - { |
84 | | - "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" |
85 | | - }, |
86 | | - { |
87 | | - "$ref": "#/parameters/AudioTranscriptionOptions.language" |
88 | | - }, |
89 | | - { |
90 | | - "$ref": "#/parameters/AudioTranscriptionOptions.prompt" |
91 | | - }, |
92 | | - { |
93 | | - "$ref": "#/parameters/AudioTranscriptionOptions.temperature" |
94 | | - }, |
95 | | - { |
96 | | - "$ref": "#/parameters/AudioTranscriptionOptions.model" |
| 78 | + "name": "body", |
| 79 | + "in": "body", |
| 80 | + "required": true, |
| 81 | + "schema": { |
| 82 | + "$ref": "#/definitions/AudioTranscriptionOptions" |
| 83 | + } |
97 | 84 | } |
98 | 85 | ], |
99 | 86 | "responses": { |
100 | 87 | "200": { |
101 | 88 | "description": "The request has succeeded.", |
102 | 89 | "schema": { |
103 | | - "$ref": "#/definitions/AudioTranscription" |
| 90 | + "type": "string" |
104 | 91 | } |
105 | 92 | }, |
106 | 93 | "default": { |
|
118 | 105 | }, |
119 | 106 | "x-ms-examples": { |
120 | 107 | "Gets transcribed text and associated metadata from provided spoken audio data.": { |
121 | | - "$ref": "./examples/audio_transcription_object.json" |
| 108 | + "$ref": "./examples/audio_transcription_text.json" |
122 | 109 | } |
123 | 110 | } |
124 | 111 | } |
125 | 112 | }, |
126 | 113 | "/deployments/{deploymentId}/audio/translations": { |
127 | 114 | "post": { |
128 | | - "operationId": "GetAudioTranslationAsResponseObject", |
| 115 | + "operationId": "GetAudioTranslationAsPlainText", |
129 | 116 | "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", |
130 | | - "consumes": [ |
131 | | - "multipart/form-data" |
132 | | - ], |
133 | 117 | "parameters": [ |
134 | 118 | { |
135 | 119 | "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" |
|
142 | 126 | "type": "string" |
143 | 127 | }, |
144 | 128 | { |
145 | | - "$ref": "#/parameters/AudioTranslationOptions.file" |
146 | | - }, |
147 | | - { |
148 | | - "$ref": "#/parameters/AudioTranslationOptions.responseFormat" |
149 | | - }, |
150 | | - { |
151 | | - "$ref": "#/parameters/AudioTranslationOptions.prompt" |
152 | | - }, |
153 | | - { |
154 | | - "$ref": "#/parameters/AudioTranslationOptions.temperature" |
155 | | - }, |
156 | | - { |
157 | | - "$ref": "#/parameters/AudioTranslationOptions.model" |
| 129 | + "name": "body", |
| 130 | + "in": "body", |
| 131 | + "required": true, |
| 132 | + "schema": { |
| 133 | + "$ref": "#/definitions/AudioTranslationOptions" |
| 134 | + } |
158 | 135 | } |
159 | 136 | ], |
160 | 137 | "responses": { |
161 | 138 | "200": { |
162 | 139 | "description": "The request has succeeded.", |
163 | 140 | "schema": { |
164 | | - "$ref": "#/definitions/AudioTranslation" |
| 141 | + "type": "string" |
165 | 142 | } |
166 | 143 | }, |
167 | 144 | "default": { |
|
179 | 156 | }, |
180 | 157 | "x-ms-examples": { |
181 | 158 | "Gets English language transcribed text and associated metadata from provided spoken audio data.": { |
182 | | - "$ref": "./examples/audio_translation_object.json" |
| 159 | + "$ref": "./examples/audio_translation_text.json" |
183 | 160 | } |
184 | 161 | } |
185 | 162 | } |
|
484 | 461 | } |
485 | 462 | } |
486 | 463 | }, |
| 464 | + "x-ms-paths": { |
| 465 | + "/deployments/{deploymentId}/audio/transcriptions?api-version={apiVersion}": { |
| 466 | + "post": { |
| 467 | + "operationId": "GetAudioTranscriptionAsResponseObject", |
| 468 | + "description": "Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the\nwritten language corresponding to the language it was spoken in.", |
| 469 | + "consumes": [ |
| 470 | + "multipart/form-data" |
| 471 | + ], |
| 472 | + "parameters": [ |
| 473 | + { |
| 474 | + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" |
| 475 | + }, |
| 476 | + { |
| 477 | + "name": "deploymentId", |
| 478 | + "in": "path", |
| 479 | + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", |
| 480 | + "required": true, |
| 481 | + "type": "string" |
| 482 | + }, |
| 483 | + { |
| 484 | + "$ref": "#/parameters/AudioTranscriptionOptions.file" |
| 485 | + }, |
| 486 | + { |
| 487 | + "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" |
| 488 | + }, |
| 489 | + { |
| 490 | + "$ref": "#/parameters/AudioTranscriptionOptions.language" |
| 491 | + }, |
| 492 | + { |
| 493 | + "$ref": "#/parameters/AudioTranscriptionOptions.prompt" |
| 494 | + }, |
| 495 | + { |
| 496 | + "$ref": "#/parameters/AudioTranscriptionOptions.temperature" |
| 497 | + }, |
| 498 | + { |
| 499 | + "$ref": "#/parameters/AudioTranscriptionOptions.model" |
| 500 | + } |
| 501 | + ], |
| 502 | + "responses": { |
| 503 | + "200": { |
| 504 | + "description": "The request has succeeded.", |
| 505 | + "schema": { |
| 506 | + "$ref": "#/definitions/AudioTranscription" |
| 507 | + } |
| 508 | + }, |
| 509 | + "default": { |
| 510 | + "description": "An unexpected error response.", |
| 511 | + "schema": { |
| 512 | + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" |
| 513 | + }, |
| 514 | + "headers": { |
| 515 | + "x-ms-error-code": { |
| 516 | + "type": "string", |
| 517 | + "description": "String error code indicating what went wrong." |
| 518 | + } |
| 519 | + } |
| 520 | + } |
| 521 | + }, |
| 522 | + "x-ms-examples": { |
| 523 | + "Gets transcribed text and associated metadata from provided spoken audio data.": { |
| 524 | + "$ref": "./examples/audio_transcription_object.json" |
| 525 | + } |
| 526 | + } |
| 527 | + } |
| 528 | + }, |
| 529 | + "/deployments/{deploymentId}/audio/translations?api-version={apiVersion}": { |
| 530 | + "post": { |
| 531 | + "operationId": "GetAudioTranslationAsResponseObject", |
| 532 | + "description": "Gets English language transcribed text and associated metadata from provided spoken audio data.", |
| 533 | + "consumes": [ |
| 534 | + "multipart/form-data" |
| 535 | + ], |
| 536 | + "parameters": [ |
| 537 | + { |
| 538 | + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" |
| 539 | + }, |
| 540 | + { |
| 541 | + "name": "deploymentId", |
| 542 | + "in": "path", |
| 543 | + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", |
| 544 | + "required": true, |
| 545 | + "type": "string" |
| 546 | + }, |
| 547 | + { |
| 548 | + "$ref": "#/parameters/AudioTranslationOptions.file" |
| 549 | + }, |
| 550 | + { |
| 551 | + "$ref": "#/parameters/AudioTranslationOptions.responseFormat" |
| 552 | + }, |
| 553 | + { |
| 554 | + "$ref": "#/parameters/AudioTranslationOptions.prompt" |
| 555 | + }, |
| 556 | + { |
| 557 | + "$ref": "#/parameters/AudioTranslationOptions.temperature" |
| 558 | + }, |
| 559 | + { |
| 560 | + "$ref": "#/parameters/AudioTranslationOptions.model" |
| 561 | + } |
| 562 | + ], |
| 563 | + "responses": { |
| 564 | + "200": { |
| 565 | + "description": "The request has succeeded.", |
| 566 | + "schema": { |
| 567 | + "$ref": "#/definitions/AudioTranslation" |
| 568 | + } |
| 569 | + }, |
| 570 | + "default": { |
| 571 | + "description": "An unexpected error response.", |
| 572 | + "schema": { |
| 573 | + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" |
| 574 | + }, |
| 575 | + "headers": { |
| 576 | + "x-ms-error-code": { |
| 577 | + "type": "string", |
| 578 | + "description": "String error code indicating what went wrong." |
| 579 | + } |
| 580 | + } |
| 581 | + } |
| 582 | + }, |
| 583 | + "x-ms-examples": { |
| 584 | + "Gets English language transcribed text and associated metadata from provided spoken audio data.": { |
| 585 | + "$ref": "./examples/audio_translation_object.json" |
| 586 | + } |
| 587 | + } |
| 588 | + } |
| 589 | + } |
| 590 | + }, |
487 | 591 | "definitions": { |
488 | 592 | "AudioTaskLabel": { |
489 | 593 | "type": "string", |
|
0 commit comments