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

Text Analysis Authoring - Train

服务:

Azure AI Services

API 版本:

2022-05-01

触发项目的训练作业。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	要使用的项目的名称。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	语言服务资源的订阅密钥。

请求正文

名称	必需	类型	说明
modelLabel	True	string	表示输出模型标签。
trainingConfigVersion	True	string	表示训练配置版本。
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	表示评估选项。 默认情况下，评估类型为百分比，训练拆分百分比为 80，测试拆分百分比为 20。

响应

名称	类型	说明
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-text/projects/LoanAgreements/:train?api-version=2022-05-01


{
  "modelLabel": "model1",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

示例响应

状态代码:

202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

定义

名称	说明
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
EvaluationKind	表示计算类型。 默认情况下，计算类型设置为百分比。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TextAnalysisAuthoringEvaluationOptions	表示用于运行评估的选项。
TextAnalysisAuthoringTrainingJobOptions	表示用于启动新训练作业的选项。

Error

Object

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

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

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

EvaluationKind

枚举

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

值	说明
manual	根据数据中的每个示例选择的数据集拆分数据。
percentage	根据用户定义的百分比将数据拆分为训练集和测试集。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
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。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误信息。
target	string	错误目标。

TextAnalysisAuthoringEvaluationOptions

Object

表示用于运行评估的选项。

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

TextAnalysisAuthoringTrainingJobOptions

Object

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

名称	类型	说明
evaluationOptions	TextAnalysisAuthoringEvaluationOptions	表示评估选项。 默认情况下，评估类型为百分比，训练拆分百分比为 80，测试拆分百分比为 20。
modelLabel	string	表示输出模型标签。
trainingConfigVersion	string	表示训练配置版本。