Evaluations - List

參考

服務:: Azure AI Services

API 版本:: v3.1

取得已驗證訂用帳戶的評估清單。

GET {endpoint}/speechtotext/v3.1/evaluations

含選擇性參數:

GET {endpoint}/speechtotext/v3.1/evaluations?skip={skip}&top={top}&filter={filter}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus.api.cognitive.microsoft.com）。
filter	query		string	用於選取可用評估子集的篩選表達式。 `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and 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=displayName eq 'My evaluation'`
skip	query		integer (int32)	將會略過的數據集數目。
top	query		integer (int32)	略過之後將包含的數據集數目。

回應

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

名稱

類型

Description

200 OK

PaginatedEvaluations

還行

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

Authorization

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

類型: apiKey
位於: header

範例

Get all evaluations

Get all evaluations with where status is equal to 'Running'

Get all evaluations

範例要求

HTTP

GET {endpoint}/speechtotext/v3.1/evaluations?skip=0&top=2

範例回覆

狀態碼:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/a55a327b-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2"
}

Get all evaluations with where status is equal to 'Running'

範例要求

HTTP

GET {endpoint}/speechtotext/v3.1/evaluations?skip=0&top=2&filter=status%20eq%20'Running'

範例回覆

狀態碼:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/f85a328c-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.98,
        "wordErrorRate1": 0.89,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    }
  ]
}

定義

名稱	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	錯誤
ErrorCode	錯誤代碼
Evaluation	評估
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
InnerError	InnerError
PaginatedEvaluations	PaginatedEvaluations
Status	地位

DetailedErrorCode

列舉型別

DetailedErrorCode

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

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

名稱	類型	Description
self	string (uri)	參考實體的位置。

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

Evaluation

Object

評估

名稱	類型	Description
createdDateTime	string (date-time)	物件建立時的時間戳。時間戳會編碼為 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 minLength: 1	對象的顯示名稱。
lastActionDateTime	string (date-time)	輸入目前狀態時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
links	EvaluationLinks	EvaluationLinks
locale	string minLength: 1	自主數據的地區設定。
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string (uri)	此實體的位置。
status	Status	地位描述 API 的目前狀態
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Object

EvaluationLinks

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

EvaluationProperties

Object

EvaluationProperties

名稱	類型	Description
correctWordCount1	integer (int32)	model1 正確辨識的字數。
correctWordCount2	integer (int32)	model2 正確辨識的字數。
email	string	傳送電子郵件通知的電子郵件位址，以防作業完成。成功傳送電子郵件之後，將會移除此值。
error	EntityError	EntityError
sentenceCount1	integer (int32)	model1 所處理的句子數目。
sentenceCount2	integer (int32)	model2 所處理的句子數目。
sentenceErrorRate1	number (double)	model1 辨識的句子錯誤率。
sentenceErrorRate2	number (double)	使用model2辨識的句子錯誤率。
wordCount1	integer (int32)	model1 所處理的字數。
wordCount2	integer (int32)	model2 所處理的字數。
wordDeletionCount1	integer (int32)	model1 所辨識的字數，即刪除。
wordDeletionCount2	integer (int32)	依model2辨識的字數，這是刪除。
wordErrorRate1	number (double)	model1 辨識的字組錯誤率。
wordErrorRate2	number (double)	model2 辨識的字組錯誤率。
wordInsertionCount1	integer (int32)	插入的model1所辨識字數。
wordInsertionCount2	integer (int32)	插入的model2所辨識字數。
wordSubstitutionCount1	integer (int32)	model1 所辨識的字數，即替代字組。
wordSubstitutionCount2	integer (int32)	model2 所辨識的字數，也就是替代專案。

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

PaginatedEvaluations

Object

PaginatedEvaluations

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

名稱

類型

Description

@nextLink

string (uri)

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

values

Evaluation[]

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

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

Status

列舉型別

地位

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

共用方式為

Evaluations - List

URI 參數

回應

安全性

Ocp-Apim-Subscription-Key

Authorization

範例

Get all evaluations

範例要求

範例回覆

Get all evaluations with where status is equal to 'Running'

範例要求

範例回覆

定義

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

PaginatedEvaluations

Status

其他資源