你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	支持的认知服务终结点 (例如 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	错误响应。

安全性

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	错误对象。
ErrorCode	用户可读的错误代码。
ErrorResponse	错误响应。
EvaluationKind	表示计算类型。 默认情况下，评估类型设置为百分比。
InnerErrorCode	用户可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TrainingMode	表示训练操作的模式。

ConversationalAnalysisAuthoringEvaluationOptions

表示运行评估所使用的选项。

名称	类型	说明
kind	EvaluationKind	表示计算类型。 默认情况下，评估类型设置为百分比。
testingSplitPercentage	integer	表示测试数据集拆分百分比。 仅在评估类型为百分比的情况下才需要。
trainingSplitPercentage	integer	表示训练数据集拆分百分比。 仅在评估类型为百分比的情况下才需要。

ConversationalAnalysisAuthoringTrainingJobOptions

表示用于启动新训练作业的选项。

名称	类型	说明
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	表示计算选项。 默认情况下，评估类型为百分比，训练拆分百分比为 80，测试拆分百分比为 20。
modelLabel	string	表示输出模型标签。
trainingConfigVersion	string	表示训练配置版本。 默认情况下，使用“latest”值，该值使用最新发布的训练配置版本。
trainingMode	TrainingMode	表示训练操作的模式。

Error

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的一组错误代码中的一个。
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	错误对象。

EvaluationKind

表示计算类型。 默认情况下，评估类型设置为百分比。

名称	类型	说明
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	服务器定义的一组错误代码中的一个。
details	object	错误详细信息。
innererror	InnerErrorModel	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误消息。
target	string	错误目标。

TrainingMode

表示训练操作的模式。

名称	类型	说明
advanced	string	使用微调的神经网络转换器模型进行训练。 可以训练多语言项目。
standard	string	更快的训练时间，以便更快地进行迭代。