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

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

要求本文

名稱	必要	類型	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	錯誤回應。

名稱

類型

Description

202 Accepted

成功呼叫的結果是用於檢查作業狀態的 Operation-Location 標頭。

標題

operation-location: string

Other Status Codes

ErrorResponse

錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。與 Azure 角色型存取控制配對時，可用來控制對 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式設定。

目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

定義

名稱	Description
ConversationalAnalysisAuthoringEvaluationOptions	表示執行評估所使用的選項。
ConversationalAnalysisAuthoringTrainingJobOptions	表示啟動新定型作業的選項。
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	表示定型數據集分割百分比。只有在評估種類為百分比時才需要。