共用方式為


Projects - List Transcriptions

取得指定項目的轉譯清單。

GET {endpoint}/speechtotext/v3.1/projects/{id}/transcriptions
GET {endpoint}/speechtotext/v3.1/projects/{id}/transcriptions?skip={skip}&top={top}&filter={filter}

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

支援的認知服務端點 (通訊協定和主機名,例如: https://westus.api.cognitive.microsoft.com) 。

id
path True

string

uuid

項目的標識碼。

filter
query

string

用於選取可用轉譯子集的篩選表達式。

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=createdDateTime gt 2022-02-01T11:00:00Z
skip
query

integer

int32

將略過的數據集數目。

top
query

integer

int32

略過之後將包含的數據集數目。

回應

名稱 類型 Description
200 OK

PaginatedTranscriptions

確定

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

Authorization

從此區域的 STS 傳回的 JWT 提供存取令牌。 請務必將下列查詢字串新增至 STS URL,將管理範圍新增至令牌:?scope=speechservicesmanagement

類型: apiKey
位於: header

範例

Get all transcriptions

範例要求

GET {endpoint}/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

範例回覆

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": false,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

定義

名稱 Description
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

錯誤

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

PaginatedTranscriptions

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

PunctuationMode

Status

狀態

Transcription

轉譯

TranscriptionLinks

轉譯連結

TranscriptionProperties

TranscriptionProperties

DetailedErrorCode

DetailedErrorCode

名稱 類型 Description
DataImportFailed

string

數據匯入失敗。

DeleteNotAllowed

string

不允許刪除。

DeployNotAllowed

string

不允許部署。

DeployingFailedModel

string

部署失敗的模型。

EmptyRequest

string

空白要求。

EndpointCannotBeDefault

string

端點不可為預設值。

EndpointNotUpdatable

string

端點無法更新。

EndpointWithoutLogging

string

沒有記錄的端點。

ExceededNumberOfRecordingsUris

string

超過錄製 URI 的數目。

FailedDataset

string

失敗的數據集。

Forbidden

string

禁止。

InUseViolation

string

在使用違規中。

InaccessibleCustomerStorage

string

無法存取的客戶記憶體。

InvalidAdaptationMapping

string

調整對應無效。

InvalidBaseModel

string

基底模型無效。

InvalidCallbackUri

string

無效的回呼 URI。

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

記錄的略過令牌無效。

InvalidSubscription

string

無效的訂用帳戶。

InvalidTest

string

測試無效。

InvalidTimeToLive

string

存留時間無效。

InvalidTopForLogs

string

記錄的頂端無效。

InvalidTranscription

string

無效的轉譯。

InvalidWebHookEventKind

string

無效的 Web 攔截事件種類。

MissingInputRecords

string

遺漏輸入記錄。

ModelDeploymentNotCompleteState

string

模型部署未完成狀態。

ModelDeprecated

string

模型已被取代。

ModelExists

string

模型存在。

ModelMismatch

string

模型不符。

ModelNotDeployable

string

模型無法部署。

ModelVersionIncorrect

string

模型版本不正確。

NoUtf8WithBom

string

沒有 bom 的 utf8。

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

DiarizationProperties

名稱 類型 Description
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

名稱 類型 Description
maxCount

integer

用於 diarization 的說話者數目上限。 必須小於 36 且大於或等於 minSpeakers 屬性。

minCount

integer

用於 diarization 之說話者數目下限的提示。 必須小於或等於 maxSpeakers 屬性。

EntityError

EntityError

名稱 類型 Description
code

string

此錯誤的程序代碼。

message

string

此錯誤的訊息。

EntityReference

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、訊息和選用屬性目標、詳細資訊 (機碼值組)、內部錯誤 (可為巢狀)。

message

string

高階錯誤訊息。

target

string

錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。

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、訊息和選用屬性目標、詳細資訊 (機碼值組)、內部錯誤 (可為巢狀)。

message

string

高階錯誤訊息。

target

string

錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。

LanguageIdentificationProperties

LanguageIdentificationProperties

名稱 類型 Description
candidateLocales

string[]

語言識別的候選地區設定 (範例 [“en-US”、“de-DE”、“es-ES”]) 。 至少支援 2 個候選地區設定和最多 10 個候選地區設定,包括謄寫的主要地區設定。

speechModelMapping

<string,  EntityReference>

地區設定與語音模型實體的選擇性對應。 如果未為地區設定指定任何模型,則會使用預設基底模型。 索引鍵必須是候選地區設定中包含的地區設定,值是個別地區設定模型的實體。

PaginatedTranscriptions

PaginatedTranscriptions

名稱 類型 Description
@nextLink

string

如果有更多實體可用,則為下一組編頁結果的連結;否則為 null。

values

Transcription[]

受限於傳遞查詢參數 『skip』 和 『top』 或其預設值的實體清單。

使用分頁和平行刪除實體逐一查看清單時,會在結果中略過某些實體。 建議您在用戶端上建置清單,並在擷取完整清單之後刪除。

ProfanityFilterMode

ProfanityFilterMode

名稱 類型 Description
Masked

string

使用 * 遮罩粗話,但第一個字母除外,例如 f≦

None

string

停用不雅內容篩選。

Removed

string

拿掉粗話。

Tags

string

新增「不雅內容」XML 標籤</粗話>

PunctuationMode

PunctuationMode

名稱 類型 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' (讀取) 和 'l' (清單) 許可權。 這個屬性不會在回應中傳回。

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

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranscriptionProperties

self

string

這個實體的位置。

status

Status

狀態
描述 API 的目前狀態

轉譯連結

名稱 類型 Description
files

string

取得此實體所有檔案的位置。 如需詳細資訊,請參閱作業“Transcriptions_ListFiles”。

TranscriptionProperties

TranscriptionProperties

名稱 類型 Description
channels

integer[]

要求的通道編號集合。 在預設情況下,會考慮通道 0 和 1。

destinationContainerUrl

string

要求的目的地容器。

備註

當目的地容器與 搭配 timeToLive使用時,通常會刪除轉譯的元數據,但儲存在目的地容器中的數據,包括轉譯結果,將會保持不變,因為此容器不需要任何刪除許可權。
若要支援自動清除,請在容器上設定 Blob 存留期,或使用「攜帶您自己的記憶體 (BYOS) 」,而不是 destinationContainerUrl,其中可以清除 Blob。

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

值,指出是否要求 (說話者辨識) 。 預設值是 false。 如果此欄位設定為 true,而且已藉由指定 DiarizationProperties來設定改善的 diarization 系統,則改善的 diarization 系統將會為可設定的喇叭範圍提供 diarization。 如果此欄位設定為 true,且未指定 DiarizationProperties) (未啟用改良的 diarization 系統,則基本 diarization 系統將區分最多兩個喇叭。 基本 diarization 不會收取額外費用。

基本 diarization 系統已被取代,將在下一個主要版本的 API 中移除。 此 diarizationEnabled 設定也會移除。

displayFormWordLevelTimestampsEnabled

boolean

值,指出是否要求顯示表單的字組層級時間戳。 預設值是 false

duration

string

轉譯的持續時間。 持續時間會編碼為 ISO 8601 持續時間 (“PnYnMnDTnHnMnS”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。

email

string

在作業完成時,傳送電子郵件通知的電子郵件位址。 成功傳送電子郵件之後,將會移除此值。

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
粗話篩選模式。

punctuationMode

PunctuationMode

PunctuationMode
用於標點符號的模式。

timeToLive

string

轉譯在系統完成之後會保留多久的時間。 一旦轉譯在完成之後到達存留時間, (成功或失敗) 系統就會自動刪除。 未將此值設定為 0,將會停用自動刪除。 最長支持的持續時間為31天。 持續時間會編碼為 ISO 8601 持續時間 (“PnYnMnDTnHnMnS”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。

wordLevelTimestampsEnabled

boolean

值,指出是否要求字組層級時間戳。 預設值是 false