Text Analysis Authoring - Get Training Status

トレーニング ジョブの状態を取得します。

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

URI パラメーター

Name In Required Type Description
Endpoint
path True
  • string

サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).

jobId
path True
  • string

ジョブ ID。

projectName
path True
  • string

使用するプロジェクトの名前。

api-version
query True
  • string

クライアント API バージョン。

要求ヘッダー

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

言語サービス リソースのサブスクリプション キー。

応答

Name Type Description
200 OK

トレーニング ジョブの結果。

Other Status Codes

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

言語サービス リソースのサブスクリプション キー。

Type: apiKey
In: header

Successful Get Train Status

Sample Request

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

Sample Response

{
  "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"
}

定義

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

エラー オブジェクト。

Name Type Description
code

サーバー定義のエラー コードのセットの 1 つ。

details

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

message
  • string

エラーの人間が判読できる表現。

target
  • string

エラーのターゲット。

ErrorCode

人間が判読できるエラー コード。

Name Type 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

エラー応答。

Name Type Description
error

エラー オブジェクト。

InnerErrorCode

人間が判読できるエラー コード。

Name Type 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.

Name Type Description
code

サーバー定義のエラー コードのセットの 1 つ。

details
  • object

エラーの詳細。

innererror

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

message
  • string

エラー メッセージ。

target
  • string

エラーのターゲット。

JobStatus

ジョブの状態。

Name Type Description
cancelled
  • string
cancelling
  • string
failed
  • string
notStarted
  • string
partiallyCompleted
  • string
running
  • string
succeeded
  • string

TextAnalysisAuthoringSubTrainingJobState

トレーニング サブ操作の詳細な状態を表します。

Name Type Description
endDateTime
  • string

終了日時を表します。

percentComplete
  • integer

進行状況の割合を表します。

startDateTime
  • string

開始時刻を表します。

status

サブ操作の状態を表します。

TextAnalysisAuthoringTrainingJobResult

トレーニング ジョブの出力を表します。

Name Type Description
estimatedEndDateTime
  • string

トレーニングと評価の見積もり終了日時を表します。

evaluationStatus

モデルの評価状態を表します。

modelLabel
  • string

トレーニング済みのモデル ラベルを表します。

trainingConfigVersion
  • string

トレーニング構成バージョンを表します。

trainingStatus

モデルのトレーニングの状態を表します。

TextAnalysisAuthoringTrainingJobState

トレーニング ジョブの状態を表します。

Name Type Description
createdDateTime
  • string

ジョブの作成日時。

errors

ジョブの実行中に発生したエラー。

expirationDateTime
  • string

ジョブの有効期限日時。

jobId
  • string

ジョブ ID。

lastUpdatedDateTime
  • string

ジョブが更新された最後の日付。

result

トレーニング タスクの詳細な結果を表します。

status

ジョブの状態。

warnings

ジョブの実行中に発生した警告。

TextAnalysisAuthoringWarning

要求の実行中に発生した警告を表します。

Name Type Description
code
  • string

警告コード。

message
  • string

警告メッセージ。