Text Analysis Authoring - Get Training Status

參考

服務:: Cognitive Services - Language

API 版本:: 2023-04-01

取得定型作業的狀態。

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
jobId	path	True	string	作業識別碼。
projectName	path	True	string	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	TextAnalysisAuthoringTrainingJobState	定型作業結果。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式的組態。

Azure Active Directory v1.0 或 v2.0 目前支援公司、學校和來賓，但不支持個人帳戶。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

語言服務資源的訂用帳戶金鑰。

類型: apiKey
位於: header

範例

Successful Get Train Status

範例要求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

範例回覆

狀態碼:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含錯誤的詳細資訊。根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobStatus	作業狀態。
TextAnalysisAuthoringSubTrainingJobState	表示定型子作業的詳細狀態。
TextAnalysisAuthoringTrainingJobResult	表示定型作業的輸出。
TextAnalysisAuthoringTrainingJobState	表示定型作業的狀態。
TextAnalysisAuthoringWarning	表示在執行要求時遇到的警告。

Error

error 物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤更具體的資訊。
message	string	人類可讀取的錯誤表示法。
target	string	錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

錯誤回應。

名稱	類型	Description
error	Error	error 物件。

InnerErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

物件，包含錯誤的詳細資訊。根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤更具體的資訊。
message	string	錯誤訊息。
target	string	錯誤目標。

JobStatus

作業狀態。

名稱	類型	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

表示定型子作業的詳細狀態。

名稱	類型	Description
endDateTime	string	表示結束日期時間。
percentComplete	integer	表示進度百分比。
startDateTime	string	表示開始日期時間。
status	JobStatus	表示子作業的狀態。

TextAnalysisAuthoringTrainingJobResult

表示定型作業的輸出。

名稱	類型	Description
estimatedEndDateTime	string	表示定型和評估的估計結束日期時間。
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	表示模型評估狀態。
modelLabel	string	表示定型的模型標籤。
trainingConfigVersion	string	表示定型組態版本。
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	表示模型定型狀態。

TextAnalysisAuthoringTrainingJobState

表示定型作業的狀態。

名稱	類型	Description
createdDateTime	string	作業的建立日期時間。
errors	Error[]	執行作業時遇到的錯誤。
expirationDateTime	string	作業的到期日期時間。
jobId	string	作業識別碼。
lastUpdatedDateTime	string	上次更新作業的日期時間。
result	TextAnalysisAuthoringTrainingJobResult	代表訓練工作的詳細結果。
status	JobStatus	作業狀態。
warnings	TextAnalysisAuthoringWarning[]	執行作業時遇到的警告。

TextAnalysisAuthoringWarning

表示在執行要求時遇到的警告。

名稱	類型	Description
code	string	警告碼。
message	string	警告訊息。

共用方式為