Transcriptions - Transcribe

服務:

Azure AI Services

API 版本:

2024-11-15

音訊檔案的同步轉譯。

POST {endpoint}/speechtotext/transcriptions:transcribe?api-version=2024-11-15

URI 參數

名稱	位於	必要	類型	Description
audio	formData	True	file binary	要轉譯之音訊檔案的內容。 音訊檔案的音訊持續時間必須少於 2 小時，且大小小於 250 MB。
definition	formData		string	轉譯要求的元數據。 此欄位包含類型為 TranscribeDefinition的 JSON 串行化物件。
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
api-version	query	True	string	要求的 API 版本。

要求標頭

Media Types: "multipart/form-data"

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	在這裡提供您的認知服務帳戶金鑰。

回應

名稱	類型	Description
200 OK	TranscribeResult	還行
Other Status Codes	Error	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的認知服務帳戶金鑰。

類型: apiKey
位於: header

範例

Transcribe an audio file

範例要求

HTTP

POST {endpoint}/speechtotext/transcriptions:transcribe?api-version=2024-11-15

範例回覆

狀態碼:

200

{
  "durationMilliseconds": 2000,
  "combinedPhrases": [
    {
      "text": "Weather"
    }
  ],
  "phrases": [
    {
      "offsetMilliseconds": 40,
      "durationMilliseconds": 320,
      "text": "Weather",
      "words": [
        {
          "text": "weather",
          "offsetMilliseconds": 40,
          "durationMilliseconds": 320
        }
      ],
      "locale": "en-US",
      "confidence": 0.78983736
    }
  ]
}

定義

名稱	Description
ChannelCombinedPhrases	每個通道的完整文字記錄。
DetailedErrorCode	DetailedErrorCode
Error	錯誤
ErrorCode	ErrorCode
InnerError	InnerError
Phrase	已轉譯的片語。
TranscribeResult	轉譯作業的結果。
Word	顯示表單的時間戳字組。

ChannelCombinedPhrases

每個通道的完整文字記錄。

名稱	類型	Description
channel	integer	以 0 為基礎的通道索引。 只有在啟用通道分離時才存在。
text	string	已轉譯的文字。

DetailedErrorCode

DetailedErrorCode

名稱	類型	Description
AudioLengthLimitExceeded	string	音訊檔案超過允許的持續時間上限。
BadChannelConfiguration	string	數據中的音訊通道、組態或應用程式的需求不符。
DataImportFailed	string	數據匯入失敗。
DeleteNotAllowed	string	不允許刪除。
DeployNotAllowed	string	不允許部署。
DeployingFailedModel	string	部署失敗的模型。
EmptyAudioFile	string	音訊檔案是空的。
EmptyRequest	string	空白要求。
EndpointCannotBeDefault	string	端點不可為預設值。
EndpointLoggingNotSupported	string	不支援端點記錄。
EndpointNotUpdatable	string	端點無法更新。
EndpointWithoutLogging	string	沒有記錄的端點。
ExceededNumberOfRecordingsUris	string	超過錄製 URI 的數目。
FailedDataset	string	失敗的數據集。
Forbidden	string	禁止。
InUseViolation	string	在使用違規中。
InaccessibleCustomerStorage	string	無法存取的客戶記憶體。
InvalidAdaptationMapping	string	無效的適應對應。
InvalidAudioFormat	string	不支援輸入音訊的格式。
InvalidBaseModel	string	基底模型無效。
InvalidCallbackUri	string	無效的回呼 URI。
InvalidChannelSpecification	string	不支援在轉譯要求中選取通道（例如，未選取 0 或 1）。
InvalidChannels	string	無效的通道。
InvalidCollection	string	無效的集合。
InvalidDataset	string	無效的數據集。
InvalidDocument	string	無效的檔。
InvalidDocumentBatch	string	檔批次無效。
InvalidLocale	string	地區設定無效。
InvalidLogDate	string	無效的記錄日期。
InvalidLogEndTime	string	無效的記錄結束時間。
InvalidLogId	string	無效的記錄標識碼。
InvalidLogStartTime	string	無效的記錄開始時間。
InvalidModel	string	無效的模型。
InvalidModelUri	string	無效的模型 URI。
InvalidParameter	string	無效的參數。
InvalidParameterValue	string	無效的參數值。
InvalidPayload	string	無效的承載。
InvalidPermissions	string	許可權無效。
InvalidPrerequisite	string	無效的必要條件。
InvalidProductId	string	無效的產品標識碼。
InvalidProject	string	無效的專案。
InvalidProjectKind	string	無效的項目種類。
InvalidRecordingsUri	string	無效的錄製 URI。
InvalidRequestBodyFormat	string	要求本文格式無效。
InvalidSasValidityDuration	string	無效的 sas 有效性持續時間。
InvalidSkipTokenForLogs	string	記錄的略過令牌無效。
InvalidSourceAzureResourceId	string	來源 Azure 資源標識碼無效。
InvalidSubscription	string	無效的訂用帳戶。
InvalidTest	string	無效的測試。
InvalidTimeToLive	string	存留時間無效。
InvalidTopForLogs	string	記錄的頂端無效。
InvalidTranscription	string	無效的轉譯。
InvalidWebHookEventKind	string	無效的 Web 攔截事件種類。
MissingInputRecords	string	遺漏輸入記錄。
ModelCopyAuthorizationExpired	string	過期的 ModelCopyAuthorization。
ModelDeploymentNotCompleteState	string	模型部署未完成狀態。
ModelDeprecated	string	模型已被取代。
ModelExists	string	模型存在。
ModelMismatch	string	模型不符。
ModelNotDeployable	string	模型不可部署。
ModelVersionIncorrect	string	模型版本不正確。
MultipleLanguagesIdentified	string	語言識別可辨識多種語言。 無法判斷任何佔主導地位的語言。
NoLanguageIdentified	string	語言識別無法辨識任何語言。
NoUtf8WithBom	string	沒有 utf8 與 bom。
OnlyOneOfUrlsOrContainerOrDataset	string	只有一個 URL 或容器或數據集。
ProjectGenderMismatch	string	專案性別不符。
QuotaViolation	string	配額違規。
SingleDefaultEndpoint	string	單一預設端點。
SkuLimitsExist	string	Sku 限制存在。
SubscriptionNotFound	string	找不到訂用帳戶。
UnexpectedError	string	未預期的錯誤。
UnsupportedClassBasedAdaptation	string	不支援的類別型調整。
UnsupportedDelta	string	不支持的差異。
UnsupportedDynamicConfiguration	string	不支援的動態設定。
UnsupportedFilter	string	不支援的篩選。
UnsupportedLanguageCode	string	不支援的語言代碼。
UnsupportedOrderBy	string	不支援的順序依據。
UnsupportedPagination	string	不支援的分頁。
UnsupportedTimeRange	string	不支援的時間範圍。

Error

錯誤

名稱	類型	Description
code	ErrorCode	ErrorCode 高階錯誤碼。
details	Error[]	有關錯誤和/或預期原則的其他支持詳細數據。
innerError	InnerError	InnerError 符合認知服務 API 指導方針的新內部錯誤格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow取得。 這包括必要的屬性 ErrorCode、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。 例如，如果檔無效，則會是「檔」或「文件標識碼」。

ErrorCode

ErrorCode

名稱	類型	Description
Conflict	string	表示衝突錯誤碼。
Forbidden	string	表示禁止的錯誤碼。
InternalCommunicationFailed	string	表示內部通訊失敗的錯誤碼。
InternalServerError	string	表示內部伺服器錯誤碼。
InvalidArgument	string	表示無效的自變數錯誤碼。
InvalidRequest	string	表示無效的要求錯誤碼。
NotAllowed	string	表示不允許的錯誤碼。
NotFound	string	表示找不到的錯誤碼。
PipelineError	string	表示管線錯誤碼。
ServiceUnavailable	string	表示服務無法使用的錯誤碼。
TooManyRequests	string	表示太多要求錯誤碼。
Unauthorized	string	表示未經授權的錯誤碼。
UnprocessableEntity	string	表示無法處理的實體錯誤碼。
UnsupportedMediaType	string	表示不支援的媒體類型錯誤碼。

InnerError

InnerError

名稱	類型	Description
code	DetailedErrorCode	DetailedErrorCode 詳細的錯誤碼列舉。
details	object	有關錯誤和/或預期原則的其他支持詳細數據。
innerError	InnerError	InnerError 符合認知服務 API 指導方針的新內部錯誤格式，可在 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow取得。 這包括必要的屬性 ErrorCode、訊息和選擇性屬性目標、details（索引鍵值組）、內部錯誤（這可以是巢狀的）。
message	string	高階錯誤訊息。
target	string	錯誤的來源。 例如，如果檔無效，則會是「檔」或「文件標識碼」。

Phrase

已轉譯的片語。

名稱	類型	Description
channel	integer	以 0 為基礎的通道索引。 只有在啟用通道分離時才存在。
confidence	number	片語的信賴值。
durationMilliseconds	integer	以毫秒為單位的片語持續時間。
locale	string	片語的地區設定。
offsetMilliseconds	integer	片語的開始位移以毫秒為單位。
speaker	integer	指派給音訊中偵測到且沒有特定順序之每個喇叭的唯一整數號碼。 只有在已啟用說話者聽寫時，才會存在。
text	string	片語的轉譯文字。
words	Word[]	構成片語的字組。 只有在啟用文字層級時間戳時，才會存在。

TranscribeResult

轉譯作業的結果。

名稱	類型	Description
combinedPhrases	ChannelCombinedPhrases[]	每個通道的完整文字記錄。
durationMilliseconds	integer	以毫秒為單位的音訊持續時間。
phrases	Phrase[]	謄寫結果分成詞組。

Word

顯示表單的時間戳字組。

名稱	類型	Description
durationMilliseconds	integer	以毫秒為單位的字組持續時間。
offsetMilliseconds	integer	以毫秒為單位的字組開始位移。
text	string	可辨識的字組，包括標點符號。