Conversational Analysis Authoring - Train

リファレンス

サービス:: Cognitive Services - Language

API バージョン:: 2022-05-01

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

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

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string	言語サービスリソースのサブスクリプションキー。

要求本文

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

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

例

Successful Train Project

要求のサンプル

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2022-05-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=2022-05-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	トレーニングデータセットの分割率を表します。評価の種類がパーセントの場合にのみ必要です。

ConversationalAnalysisAuthoringTrainingJobOptions

新しいトレーニングジョブを開始するためのオプションを表します。

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

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 オブジェクト。

EvaluationKind

評価の種類を表します。既定では、評価の種類は percentage に設定されています。

名前	型	説明
manual	string	データ内のすべての例について、選択したデータセットに従ってデータを分割します。
percentage	string	ユーザー定義の割合に従って、データをトレーニングセットとテストセットに分割します。

InnerErrorCode

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

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

名前	型	説明
code	InnerErrorCode	サーバー定義のエラーコードのセットの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

TrainingMode

トレーニング操作のモードを表します。

名前	型	説明
advanced	string	微調整されたニューラルネットワークトランスフォーマーモデルを使用してトレーニングします。多言語プロジェクトをトレーニングできる。
standard	string	より迅速な反復のためのより速いトレーニング時間。

次の方法で共有

Conversational Analysis Authoring - Train

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

例

Successful Train Project

要求のサンプル

応答のサンプル

定義

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

その他のリソース