Conversational Analysis Authoring - Train

服務:

Azure AI Services

API 版本:

2022-05-01

觸發項目的訓練作業。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 （例如，https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	語言服務資源的訂用帳戶金鑰。

要求本文

名稱	必要	類型	Description
modelLabel	True	string	表示輸出模型標籤。
trainingMode	True	TrainingMode	表示定型作業的模式。
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	表示評估選項。 根據預設，評估種類為百分比，定型分割百分比為80，而測試分割百分比為20。
trainingConfigVersion		string	表示定型組態版本。 根據預設，會使用最新發行的訓練組態版本「latest」 值。

回應

名稱	類型	Description
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

定義

名稱	Description
ConversationalAnalysisAuthoringEvaluationOptions	表示執行評估所使用的選項。
ConversationalAnalysisAuthoringTrainingJobOptions	表示啟動新定型作業的選項。
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
EvaluationKind	表示評估種類。 根據預設，評估種類會設定為百分比。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TrainingMode	表示定型作業的模式。

ConversationalAnalysisAuthoringEvaluationOptions

Object

表示執行評估所使用的選項。

名稱	類型	Description
kind	EvaluationKind	表示評估種類。 根據預設，評估種類會設定為百分比。
testingSplitPercentage	integer (int32)	表示測試數據集分割百分比。 只有在評估種類為百分比時才需要。
trainingSplitPercentage	integer (int32)	表示定型數據集分割百分比。 只有在評估種類為百分比時才需要。

ConversationalAnalysisAuthoringTrainingJobOptions

Object

表示啟動新定型作業的選項。

名稱	類型	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	表示評估選項。 根據預設，評估種類為百分比，定型分割百分比為80，而測試分割百分比為20。
modelLabel	string	表示輸出模型標籤。
trainingConfigVersion	string	表示定型組態版本。 根據預設，會使用最新發行的訓練組態版本「latest」 值。
trainingMode	TrainingMode	表示定型作業的模式。

Error

Object

error 物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

ErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
error	Error	error 物件。

EvaluationKind

列舉型別

表示評估種類。 根據預設，評估種類會設定為百分比。

值	Description
manual	根據所選取資料集分割數據，以取得資料中的每個範例。
percentage	根據使用者定義的百分比，將數據分割成定型集和測試集。

InnerErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤資訊。
target	string	錯誤目標。

TrainingMode

列舉型別

表示定型作業的模式。

值	Description
advanced	使用微調的神經網路轉換器模型來定型。 可以訓練多語系專案。
standard	更快速反覆運算的定型時間。