Train - Get Status
指定した LUIS アプリのすべてのモデル (意図とエンティティ) のトレーニング状態を取得します。 トレーニング状態を取得するには、この API を呼び出す前に、トレーニング API を呼び出して LUIS アプリをトレーニングする必要があります。 "appID" は LUIS アプリ ID を指定します。 "versionId" は、LUIS アプリのバージョン番号を指定します。 たとえば、"0.1" とします。
GET {Endpoint}/luis/api/v2.0/apps/{appId}/versions/{versionId}/train
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
app
|
path | True |
string (uuid) |
アプリケーション ID。 |
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。 |
version
|
path | True |
string |
バージョン ID。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
成功した応答は、トレーニング用に送信した LUIS アプリのトレーニング状態の詳細の配列を提供します。 応答配列内の各要素は、LUIS アプリのモデル (意図またはエンティティ) のトレーニング状態を提供します。 注: 事前トレーニング済みのエンティティは事前トレーニングされているため、トレーニング状態は提供されません。 "modelId" プロパティは、トレーニング状態が対応する意図またはエンティティを識別します。 各モデルの名前と型を取得するには、次の形式の要求 URL を持つ models API を使用します。https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/{versionId}/models 各モデルの details プロパティには、"statusId": 状態フィールドの値に対応する 0 から 3 までの整数を含めることができます。 "status": "Success"、"UpToDate"、"InProgress"、"Fail" のいずれかの値を持つ文字列。 状態が "Fail" の場合、"failureReason" プロパティはエラーの理由を示します。 "exampleCount": トレーニングに使用される例の数。 None 意図または事前構築済みドメインの意図とエンティティの場合、この数には、システムによって内部的に提供される例と、LUIS アプリに追加した例が含まれます。 "failureReason": トレーニングが失敗した理由を示す文字列。 値 "FewLabels" は、トレーニング用にラベル付けされた発話の例が提供されなかったことを意味します。 "trainingDateTime": モデルが最後にトレーニングされた時刻を示す文字列。 この値では、UTC 指定子 ("Z") を使用して UTC (協定世界時) で時刻を表す ISO 8601 形式を使用します (例: "2017-08-10T01:08:34Z")。 Media Types: "application/json", "JSON" |
|
Other Status Codes |
エラー応答。 Media Types: "application/json", "JSON" |
セキュリティ
Ocp-Apim-Subscription-Key
型:
apiKey
/:
header
例
Successful Get Application Version Training Status request
要求のサンプル
GET {Endpoint}/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/train
応答のサンプル
[
{
"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
}
}
]
定義
名前 | 説明 |
---|---|
Error |
API で操作を呼び出すときのエラー応答。 |
Model |
モデル トレーニングの詳細。 |
Model |
モデルトレーニング情報。 |
Training |
トレーニングの状態。 |
ErrorResponse
API で操作を呼び出すときのエラー応答。
名前 | 型 | 説明 |
---|---|---|
errorType |
string |
ModelTrainingDetails
モデル トレーニングの詳細。
名前 | 型 | 説明 |
---|---|---|
exampleCount |
integer |
モデルのトレーニングに使用される例の数。 |
failureReason |
string |
トレーニングの失敗の理由。 |
status |
トレーニングの状態。 |
|
statusId |
integer |
トレーニング要求の状態 ID。 |
trainingDateTime |
string (date-time) |
モデルがトレーニングされたとき。 |
ModelTrainingInfo
モデルトレーニング情報。
名前 | 型 | 説明 |
---|---|---|
details |
モデル トレーニングの詳細。 |
|
modelId |
string (uuid) |
モデルの ID (GUID)。 |
TrainingStatus
トレーニングの状態。
値 | 説明 |
---|---|
Fail | |
InProgress | |
Queued | |
Success | |
UpToDate |