Conversational Analysis Authoring - Get Training Status

リファレンス

サービス:: Cognitive Services - Language

API バージョン:: 2023-04-01

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

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

URI パラメーター

名前	/	必須	型	説明
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 バージョン。

応答

名前	型	説明
200 OK	ConversationalAnalysisAuthoringTrainingJobState	トレーニングジョブの結果。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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-conversations/projects/EmailApp/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

応答のサンプル

状態コード:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "trainingMode": "standard",
    "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"
}

定義

名前	説明
ConversationalAnalysisAuthoringSubTrainingJobState	トレーニングサブ操作の詳細な状態を表します。
ConversationalAnalysisAuthoringTrainingJobResult	トレーニングジョブの出力を表します。
ConversationalAnalysisAuthoringTrainingJobState	トレーニングジョブの状態を表します。
ConversationalAnalysisAuthoringWarning	要求の実行中に発生した警告を表します。
Error	error オブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobStatus	ジョブの状態。
TrainingMode	トレーニング操作のモードを表します。

ConversationalAnalysisAuthoringSubTrainingJobState

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

名前	型	説明
endDateTime	string	終了日時を表します。
percentComplete	integer	進行状況の割合を表します。
startDateTime	string	開始時刻を表します。
status	JobStatus	サブ操作の状態を表します。

ConversationalAnalysisAuthoringTrainingJobResult

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

名前	型	説明
estimatedEndDateTime	string	トレーニングと評価の推定終了日時を表します。
evaluationStatus	ConversationalAnalysisAuthoringSubTrainingJobState	モデル評価の状態を表します。
modelLabel	string	トレーニング済みのモデルラベルを表します。
trainingConfigVersion	string	トレーニング構成バージョンを表します。
trainingMode	TrainingMode	トレーニング操作のモードを表します。
trainingStatus	ConversationalAnalysisAuthoringSubTrainingJobState	モデルのトレーニング状態を表します。

ConversationalAnalysisAuthoringTrainingJobState

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

名前	型	説明
createdDateTime	string	ジョブの作成日時。
errors	Error[]	ジョブの実行中に発生したエラー。
expirationDateTime	string	ジョブの有効期限の日付時刻。
jobId	string	ジョブ ID。
lastUpdatedDateTime	string	ジョブが更新された最後の日付時刻。
result	ConversationalAnalysisAuthoringTrainingJobResult	トレーニングタスクの詳細な結果を表します。
status	JobStatus	ジョブの状態。
warnings	ConversationalAnalysisAuthoringWarning[]	ジョブの実行中に発生した警告。

ConversationalAnalysisAuthoringWarning

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

名前	型	説明
code	string	警告コード。
message	string	警告メッセージ。

Error

error オブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義のエラーコードのセットの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

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

名前	型	説明
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

エラー応答。

名前	型	説明
error	Error	error オブジェクト。

InnerErrorCode