Conversational Analysis Authoring - Train

リファレンス

サービス:: Cognitive Services - Language

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

プロジェクトのトレーニングジョブをトリガーします。

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?api-version=2023-04-01

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName	path	True	string	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API バージョン。

要求本文

名前	必須	型	説明
modelLabel	True	string	出力モデルラベルを表します。
trainingMode	True	TrainingMode	トレーニング操作のモードを表します。
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	評価オプションを表します。既定では、評価の種類はパーセンテージで、トレーニング分割の割合は 80、テスト分割の割合は 20 です。
trainingConfigVersion		string	トレーニング構成バージョンを表します。既定では、最新リリースのトレーニング構成バージョンを使用する "latest" 値が使用されます。

応答

名前	型	説明
202 Accepted		呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。ヘッダー operation-location: string
Other Status Codes	ErrorResponse	エラー応答。

名前

型

説明

202 Accepted

呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。

ヘッダー

operation-location: string

Other Status Codes

ErrorResponse

エラー応答。

セキュリティ

AADToken

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

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の 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 Train Project

要求のサンプル

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2023-04-01

{
  "modelLabel": "model1",
  "trainingMode": "standard",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

応答のサンプル

状態コード:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

定義

名前	説明
ConversationalAnalysisAuthoringEvaluationOptions	評価の実行に使用されるオプションを表します。
ConversationalAnalysisAuthoringTrainingJobOptions	新しいトレーニングジョブを開始するためのオプションを表します。
Error	error オブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
EvaluationKind	評価の種類を表します。既定では、評価の種類は percentage に設定されています。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TrainingMode	トレーニング操作のモードを表します。

ConversationalAnalysisAuthoringEvaluationOptions

評価の実行に使用されるオプションを表します。

名前	型	説明
kind	EvaluationKind	評価の種類を表します。既定では、評価の種類は percentage に設定されています。
testingSplitPercentage	integer	テストデータセットの分割率を表します。評価の種類がパーセントの場合にのみ必要です。
trainingSplitPercentage	integer	トレーニングデータセットの分割率を表します。評価の種類がパーセントの場合にのみ必要です。