共用方式為

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 參數

名稱 位於 必要 類型 Description
Endpoint
 path True

string

支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
projectName
 path True

string

要使用的項目名稱。
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

範例要求

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 One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TrainingMode

表示定型作業的模式。

ConversationalAnalysisAuthoringEvaluationOptions

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

名稱 類型 Description
kind

EvaluationKind

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

integer

表示測試數據集分割百分比。 只有在評估種類為百分比時才需要。
trainingSplitPercentage

integer

表示定型數據集分割百分比。 只有在評估種類為百分比時才需要。

ConversationalAnalysisAuthoringTrainingJobOptions

表示啟動新訓練作業的選項。

名稱 類型 Description
evaluationOptions

ConversationalAnalysisAuthoringEvaluationOptions

表示評估選項。 根據預設，評估種類為百分比，定型分割百分比為80，並將分割百分比測試為20。
modelLabel

string

表示輸出模型標籤。
trainingConfigVersion

string

表示定型組態版本。 根據預設，會使用最新發行的訓練組態版本來使用 「latest」 值。
trainingMode

TrainingMode

表示定型作業的模式。

Error

error 物件。

名稱 類型 Description
code

ErrorCode

其中一組伺服器定義的錯誤碼。
details

Error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

InnerErrorModel

物件，包含比目前對象有關錯誤更具體的資訊。
message

string

人類可讀取的錯誤表示法。
target

string

錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

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

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

EvaluationKind

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

名稱 類型 Description
manual

string

根據所選取資料集分割數據，以取得資料中的每個範例。
percentage

string

根據使用者定義的百分比，將數據分割成定型和測試集。

InnerErrorCode

人類可讀取的錯誤碼。

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

名稱 類型 Description
code

InnerErrorCode

其中一組伺服器定義的錯誤碼。
details

object

錯誤詳細數據。
innererror

InnerErrorModel

物件，包含比目前對象有關錯誤更具體的資訊。
message

string

錯誤訊息。
target

string

錯誤目標。

TrainingMode

表示定型作業的模式。

名稱 類型 Description
advanced

string

使用微調的類神經網路轉換器模型來定型。 可以定型多語系專案。
standard

string

更快速反覆運算的定型時間。