Transcriptions - Update

參考

服務:: Azure AI Services

API 版本:: 2024-11-15

更新其標識碼所識別之轉譯的可變詳細數據。

PATCH {endpoint}/speechtotext/transcriptions/{id}?api-version=2024-11-15

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
id	path	True	string uuid	轉譯的標識碼。
api-version	query	True	string	要求的 API 版本。

要求標頭

Media Types: "application/json", "application/merge-patch+json"

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

要求本文

Media Types: "application/json", "application/merge-patch+json"

名稱	類型	Description
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
description	string	物件的描述。
displayName	string	物件的名稱。

回應

名稱	類型	Description
200 OK	Transcription	還行標題 Retry-After: integer
Other Status Codes	Error	發生錯誤。

名稱

類型

Description

200 OK

Transcription

還行

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Update a transcription

範例要求

HTTP

PATCH {endpoint}/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15


{
  "displayName": "Updated transcription name",
  "description": "Updated transcription description",
  "customProperties": {
    "key": "value"
  }
}

範例回覆

狀態碼:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  },
  "locale": "en-US",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
  },
  "properties": {
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "timeToLiveHours": 48,
    "durationMilliseconds": 42000
  },
  "status": "Succeeded"
}

定義

名稱	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
EntityError	EntityError
EntityReference	EntityReference
Error	錯誤
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	標點符號Mode
Status	地位
Transcription	轉錄
TranscriptionLinks	轉譯連結
TranscriptionProperties	轉譯屬性
TranscriptionUpdate	轉譯Update

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	不支援的時間範圍。

DiarizationProperties

名稱	類型	Description
enabled	boolean	值，指出是否啟用說話者讀音。
maxSpeakers	integer	用於進行 diarization 之說話者數目上限的提示。必須大於 1 且小於 36。

EntityError

名稱	類型	Description
code	string	此錯誤的程序代碼。
message	string	此錯誤的訊息。

EntityReference

名稱	類型	Description
self	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

名稱	類型	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

名稱	類型	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	錯誤的來源。例如，如果檔無效，則會是「檔」或「文件標識碼」。

LanguageIdentificationMode

名稱	類型	Description
Continuous	string	連續語言識別（預設值）。
Single	string	單一語言識別。如果無法識別任何語言，則會將錯誤碼 NoLanguageIdentified 傳回給使用者。如果多種語言之間模棱兩可，則會將錯誤碼 MultipleLanguagesIdentified 傳回給使用者。

LanguageIdentificationProperties

名稱	類型	預設值	Description
candidateLocales	string[]		語言識別的候選地區設定（例如 [“en-US”， “de-DE”， “es-ES”]]。連續模式支援至少 2 個和最多 10 個候選地區設定，包括轉譯的主要地區設定。針對單一語言識別，候選地區設定的最大數目是未系結的。
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode 用於語言識別的模式。
speechModelMapping	<string, EntityReference>		地區設定與語音模型實體的選擇性對應。如果未提供地區設定的模型，則會使用預設基底模型。索引鍵必須是候選地區設定中包含的地區設定，值是個別地區設定模型的實體。

ProfanityFilterMode

名稱	類型	Description
Masked	string	使用 * 遮罩粗話，但第一個字母除外，例如 f***
None	string	停用粗話篩選。
Removed	string	拿掉粗話。
Tags	string	</Profanity> 新增「不雅話」XML 標籤

PunctuationMode

標點符號Mode

名稱	類型	Description
Automatic	string	自動標點符號。
Dictated	string	僅指定標點符號標記，也就是明確的標點符號。
DictatedAndAutomatic	string	指定標點符號或自動標點符號。
None	string	沒有標點符號。

Status

地位

名稱	類型	Description
Failed	string	長時間執行的作業失敗。
NotStarted	string	長時間執行的作業尚未啟動。
Running	string	長時間執行的作業目前正在處理中。
Succeeded	string	長時間執行的作業已順利完成。

Transcription

轉錄

名稱	類型	Description
contentContainerUrl	string	包含音訊檔案的 Azure Blob 容器 URL。容器的大小上限為 5GB，且最大數目為 10000 個 Blob。 Blob 的大小上限為 2.5GB。容器 SAS 應包含 'r' （read）和 'l' （list）許可權。這個屬性不會在回應中傳回。
contentUrls	string[]	要取得要轉譯之音訊檔案的內容 URL 清單。最多允許 1000 個 URL。這個屬性不會在回應中傳回。
createdDateTime	string	物件建立時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
dataset	EntityReference	EntityReference
description	string	物件的描述。
displayName	string	對象的顯示名稱。
lastActionDateTime	string	輸入目前狀態時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
links	TranscriptionLinks	轉譯連結
locale	string	自主數據的地區設定。如果使用語言識別，則會使用此地區設定來轉譯無法偵測到任何語言的語音。
model	EntityReference	EntityReference
properties	TranscriptionProperties	轉譯屬性
self	string	此實體的位置。
status	Status	地位描述 API 的目前狀態。

TranscriptionLinks

轉譯連結

名稱	類型	Description
files	string	取得此實體所有檔案的位置。如需詳細資訊，請參閱作業「Transcriptions_ListFiles」。

TranscriptionProperties

轉譯屬性

名稱	類型	預設值	Description
channels	integer[]		要求的通道編號集合。在預設案例中，會考慮通道 0 和 1。
destinationContainerUrl	string		要求的目的地容器。言論當目的地容器與 `timeToLive`搭配使用時，通常會刪除轉譯的元數據，但儲存在目的地容器中的數據，包括轉譯結果，將會維持不變，因為此容器不需要刪除許可權。若要支援自動清除，請在容器上設定 Blob 存留期，或使用「攜帶您自己的記憶體（BYOS）」，而不是 `destinationContainerUrl`，其中可以清除 Blob。
diarization	DiarizationProperties		DiarizationProperties
displayFormWordLevelTimestampsEnabled	boolean		值，指出是否要求顯示表單的文字層級時間戳。預設值為 `false`。
durationMilliseconds	integer	0	轉譯的持續時間，以毫秒為單位。不支援大於 2^53-1 的持續時間，以確保與 JavaScript 整數相容。
error	EntityError		EntityError
languageIdentification	LanguageIdentificationProperties		LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode		ProfanityFilterMode 粗話篩選模式。
punctuationMode	PunctuationMode		標點符號Mode 用於標點符號的模式。
timeToLiveHours	integer		謄寫在系統完成之後會保留多久。一旦轉譯到達完成後存留時間（成功或失敗），系統就會自動刪除。注意：使用 BYOS 時（攜帶您自己的記憶體），也會刪除客戶擁有記憶體帳戶上的結果檔案。使用 destinationContainerUrl 為結果檔案指定個別的容器，當 timeToLive 到期時將不會刪除，或透過 API 擷取結果檔案，並視需要加以儲存。最短支持的持續時間為 6 小時，支援持續時間最長為 31 天。直接取用數據時，建議使用 2 天（48 小時）的預設值。
wordLevelTimestampsEnabled	boolean		值，指出是否要求文字層級時間戳。預設值為 `false`。

TranscriptionUpdate

轉譯Update

名稱	類型	Description
customProperties	object	此實體的自定義屬性。允許的索引鍵長度上限為 64 個字元，允許的最大值長度為 256 個字元，允許的項目計數為 10。
description	string	物件的描述。
displayName	string	物件的名稱。

共用方式為

Transcriptions - Update

URI 參數

要求標頭

要求本文

回應

安全性

Ocp-Apim-Subscription-Key

範例

Update a transcription

範例要求

範例回覆

定義

DetailedErrorCode

DiarizationProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

言論

TranscriptionUpdate

其他資源