Endpoints - List Logs

服務:: Azure AI Services

API 版本:: v3.2-preview.2

取得已針對指定端點儲存的音訊和轉譯記錄清單。

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}/files/logs

含選擇性參數:

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}/files/logs?sasValidityInSeconds={sasValidityInSeconds}&skipToken={skipToken}&top={top}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
id	path	True	string (uuid)	端點的標識碼。
sasValidityInSeconds	query		integer (int32)	SAS URL 應有效以秒為單位的持續時間。默認持續時間為12小時。使用 BYOS 時（https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging）：值為 0 表示會產生不含 SAS 令牌的一般 Blob URI。
skipToken	query		string	用來略過先前要求中已擷取的記錄的令牌。當未定義時，分頁會從開頭開始。
top	query		integer (int32)	略過之後將包含的數據集數目。

回應

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

名稱

類型

Description

200 OK

PaginatedFiles

還行

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

Authorization

提供來自此區域 STS 所傳回之 JWT 的存取令牌。請務必將下列查詢字串新增至 STS URL，將管理範圍新增至令牌：？scope=speechservicesmanagement

類型: apiKey
位於: header

範例

Get all endpoint logs

範例要求

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?sasValidityInSeconds=120&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&top=2

範例回覆

狀態碼:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
      "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
      "kind": "Audio",
      "properties": {
        "size": 12345
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
      "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
      "kind": "Transcription",
      "properties": {
        "size": 12345
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--"
}

定義

名稱	Description
DetailedErrorCode	DetailedErrorCode
Error	錯誤
ErrorCode	錯誤代碼
File	檔案
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError
PaginatedFiles	PaginatedFiles

DetailedErrorCode

列舉型別

DetailedErrorCode

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

Error

Object

錯誤

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

File

Object

檔案

名稱	類型	Description
createdDateTime	string (date-time)	這個檔案的建立時間。時間戳會編碼為 ISO 8601 日期和時間格式（請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
kind	FileKind	FileKind 數據類型。
links	FileLinks	FileLinks
name	string	這個檔案的名稱。
properties	FileProperties	FileProperties
self	string (uri)	此實體的位置。

FileKind

列舉型別

FileKind

值	Description
DatasetReport	數據類型為數據集報表。
Audio	數據類型為音訊。
LanguageData	數據類型為語言數據。
PronunciationData	數據類型是發音數據。
AcousticDataArchive	數據類型為原音數據封存。
AcousticDataTranscriptionV2	數據類型為原音數據轉譯 v2。
Transcription	數據類型為轉譯。
TranscriptionReport	數據類型為轉譯報表。
EvaluationDetails	數據類型是評估詳細數據。
ModelReport	數據類型為模型報表。
OutputFormattingData	數據類型是輸出格式輸入檔。

FileLinks

Object

FileLinks

名稱	類型	Description
contentUrl	string (uri)	要擷取此檔案內容的URL。

FileProperties

Object

FileProperties

名稱	類型	Description
duration	string	如果這個檔案是音訊檔案，則持續時間。持續時間會編碼為 ISO 8601 持續時間（“PnYnMnDTnHnMnS”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations）。
size	integer (int64)	以位元組為單位的數據大小。

InnerError

Object

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

PaginatedFiles

Object

PaginatedFiles

名稱	類型	Description
@nextLink	string (uri)	如果有更多實體可用，則為下一組編頁結果的連結;否則為 null。
values	File[]	由傳遞的查詢參數『skip』和『top』或其預設值所限制的實體清單。使用分頁和平行刪除實體逐一查看清單時，結果中會略過某些實體。建議在用戶端上建置清單，並在擷取完整清單之後刪除。

名稱

類型

Description

@nextLink

string (uri)

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

values

File[]

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

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