Text Analysis Authoring List Training Config Versions - Text Analysis Authoring List Training Config Versions

服务:

Azure AI Services

API 版本:

2023-04-01

列出给定项目类型的支持训练配置版本。

GET {Endpoint}/language/authoring/analyze-text/projects/global/training-config-versions?api-version=2023-04-01

具有可选参数:

GET {Endpoint}/language/authoring/analyze-text/projects/global/training-config-versions?api-version=2023-04-01&projectKind={projectKind}&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (url)	支持的认知服务终结点，例如 https://< resource-name.api.cognitiveservices.azure.com>。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
maxpagesize	query		integer (int32)	每个页面的结果项的最大数目。
projectKind	query		ProjectKind	项目类型，默认值为 CustomSingleLabelClassification。
skip	query		integer (int32)	要跳过的结果项数。
top	query		integer (int32)	要返回的结果项数。

响应

名称	类型	说明
200 OK	PagedTextAnalysisAuthoringTrainingConfigVersion	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

SuccessfulGetSupportedTrainingConfigVersions

示例请求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/global/training-config-versions?api-version=2023-04-01&projectKind=CustomEntityRecognition

示例响应

状态代码:

200

{
  "value": [
    {
      "trainingConfigVersion": "2022-05-01",
      "modelExpirationDate": "2022-10-28"
    }
  ],
  "nextLink": null
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
PagedTextAnalysisAuthoringTrainingConfigVersion	TextAnalysisAuthoringTrainingConfigVersion 项的分页集合
ProjectKind
TextAnalysisAuthoringTrainingConfigVersion	表示训练配置版本。

Azure.Core.Foundations.Error

Object

错误对象。

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

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

PagedTextAnalysisAuthoringTrainingConfigVersion

Object

TextAnalysisAuthoringTrainingConfigVersion 项的分页集合

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	TextAnalysisAuthoringTrainingConfigVersion[]	此页上的 TextAnalysisAuthoringTrainingConfigVersion 项

ProjectKind

枚举

值	说明
CustomSingleLabelClassification	用于生成分类模型以使用自己的数据对文本进行分类。 每个文件将只有一个标签。 例如，文件 1 被分类为 A，文件 2 分类为 B。
CustomMultiLabelClassification	用于生成分类模型以使用自己的数据对文本进行分类。 每个文件可以有一个或多个标签。 例如，文件 1 分类为 A、B 和 C，文件 2 分类为 B 和 C。
CustomEntityRecognition	若要生成提取模型，以使用自己的数据标识域类别。

TextAnalysisAuthoringTrainingConfigVersion

Object

表示训练配置版本。

名称	类型	说明
modelExpirationDate	string (date)	表示训练配置版本的到期日期。
trainingConfigVersion	string	表示配置的版本。