Train - Get Status

  • 參考
Service:
Cognitive Services - LUIS
API Version:
3.0-preview

取得指定 LUIS 應用程式) 的所有模型 (意圖和實體的定型狀態。 您必須先呼叫定型 API 來訓練 LUIS 應用程式，才能呼叫此 API 以取得定型狀態。 “appID” 指定 LUIS 應用程式識別碼。 “versionId” 指定 LUIS 應用程式的版本號碼。 例如，“0.1”。

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/train

URI 參數

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

string

uuid

應用程式識別碼。
Endpoint
 path True

string

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

string

版本識別碼。

要求標頭

名稱 必要 類型 Description
Ocp-Apim-Subscription-Key True

string

回應

名稱 類型 Description
200 OK

ModelTrainingInfo[]

成功的回應會提供您提交訓練的 LUIS 應用程式定型狀態詳細數據數位。 響應陣中的每個元素都會提供 LUIS 應用程式中模型 (意圖或實體) 的定型狀態。 注意：預先定型的實體未提供定型狀態。 “modelId” 屬性會識別定型狀態對應的意圖或實體。 若要取得每個模型的名稱和類型，請使用具有此格式要求 URL 的模型 API：每個模型的詳細數據屬性可以包含下列欄位： https://westus.api.cognitive.microsoft.com/luis/api/v3.0-preview/apps/{appId}/versions/{versionId}/models “statusId”：從 0 到 3 的整數，其對應於狀態字段的值。 “status”：具有下列其中一個值的字串：“Success”、“UpToDate”、“InProgress”、“Fail”。 如果狀態為 “Fail”，“failureReason” 屬性會提供失敗的原因。 “exampleCount”：用於定型的範例數目。 如果是 None 意圖或預先建置的網域意圖和實體，此數位包括系統內部提供的範例，以及您新增至 LUIS 應用程式的範例。 “failureReason”：指出定型失敗原因的字串串。 值 “FewLabels” 表示未針對定型提供任何標記的範例語句。 “trainingDateTime”：字串，指出模型上次定型的時間。 此值會使用 ISO 8601 格式，以 UTC (國際標準時間) ，搭配 UTC 指示項 (“Z”) ，例如：“2017-08-10T01：08：34Z”。

Media Types: "application/json", "JSON"
Other Status Codes

ErrorResponse

錯誤回應。

Media Types: "application/json", "JSON"

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

範例

Successful Get Application Version Training Status request

Sample Request

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/train

Sample Response

Status code:
200 
[
  {
    "modelId": "f9b00d5b-1f2d-421e-bc99-5ff192d0b998",
    "details": {
      "statusId": 3,
      "status": "InProgress",
      "exampleCount": 0
    }
  },
  {
    "modelId": "51403af3-5342-4926-abaa-91172a42e075",
    "details": {
      "statusId": 2,
      "status": "UpToDate",
      "exampleCount": 12,
      "trainingDateTime": "2017-01-31T21:42:02Z"
    }
  },
  {
    "modelId": "b4cf6402-dc79-4ca3-8666-b0007337e92b",
    "details": {
      "statusId": 1,
      "status": "Fail",
      "exampleCount": 12,
      "failureReason": "FewLabels"
    }
  },
  {
    "modelId": "e8e3135a-acd9-4164-a65c-e2fedbe78cfa",
    "details": {
      "statusId": 3,
      "status": "InProgress",
      "exampleCount": 0
    }
  },
  {
    "modelId": "3291fac9-6368-4c87-9562-e78cae0fa7c6",
    "details": {
      "statusId": 0,
      "status": "Success",
      "exampleCount": 12,
      "trainingDateTime": "2017-01-31T21:42:02Z"
    }
  },
  {
    "modelId": "a193efac-ab02-49d7-b005-ee717d45c4f1",
    "details": {
      "statusId": 3,
      "status": "InProgress",
      "exampleCount": 0
    }
  }
]

定義

名稱 Description
ErrorResponse

叫用 API 上的作業時發生錯誤回應。
ModelTrainingDetails

模型定型詳細數據。
ModelTrainingInfo

模型定型資訊。
TrainingStatus

訓練狀態。

ErrorResponse

叫用 API 上的作業時發生錯誤回應。

名稱 類型 Description
errorType

string

ModelTrainingDetails

模型定型詳細數據。

名稱 類型 Description
exampleCount

integer

用來定型模型的範例計數。
failureReason

string

定型失敗的原因。
status

TrainingStatus

訓練狀態。
statusId

integer

訓練要求狀態標識碼。
trainingDateTime

string

模型定型時。

ModelTrainingInfo

模型定型資訊。

名稱 類型 Description
details

ModelTrainingDetails

模型定型詳細數據。
modelId

string

模型的標識碼 (GUID) 。

TrainingStatus

訓練狀態。

名稱 類型 Description
Fail

string

InProgress

string

Queued

string

Success

string

UpToDate

string