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

Text Analysis Authoring - List Training Jobs

参考

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Lists为项目创建的未过期训练作业。

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?api-version=2023-04-01

With optional parameters:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/train/jobs?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点 (例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string	要使用的项目的名称。
api-version	query	True	string	客户端 API 版本。
maxpagesize	query		integer int32	要包含在单个响应中的资源的最大数量。
skip	query		integer int32	要返回的第一个资源的集合中的偏移量。
top	query		integer int32	要从集合返回的最大资源数。

响应

名称	类型	说明
200 OK	TextAnalysisAuthoringTrainingJobs	训练作业列表。
Other Status Codes	ErrorResponse	错误响应。

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。与 Azure 基于角色的访问控制配对后，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限，以Azure Maps REST API。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一个解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问哪个Azure Maps资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 可以针对多个用例基于配置设置应用程序。

目前，Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

语言服务资源的订阅密钥。

Type: apiKey
In: header

示例

Successful List Training Jobs

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "result": {
        "modelLabel": "model1",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:45:06.8190649Z",
          "endDateTime": "2022-04-18T15:47:19.2639682Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T15:47:19.2734976Z",
          "endDateTime": "2022-04-18T15:47:23.8378892Z",
          "status": "succeeded"
        }
      },
      "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
      "createdDateTime": "2022-04-18T15:44:44Z",
      "lastUpdatedDateTime": "2022-04-18T15:47:50Z",
      "expirationDateTime": "2022-04-25T15:44:44Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:22:39.3663023Z",
          "endDateTime": "2022-04-18T17:24:51.9440947Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:24:51.9571747Z",
          "endDateTime": "2022-04-18T17:24:58.1427823Z",
          "status": "succeeded"
        }
      },
      "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000",
      "createdDateTime": "2022-04-18T17:22:11Z",
      "lastUpdatedDateTime": "2022-04-18T17:25:23Z",
      "expirationDateTime": "2022-04-25T17:22:11Z",
      "status": "succeeded"
    },
    {
      "result": {
        "modelLabel": "model2",
        "trainingConfigVersion": "2022-05-01",
        "trainingStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:44:41.388358Z",
          "endDateTime": "2022-04-18T17:50:29.5675101Z",
          "status": "succeeded"
        },
        "evaluationStatus": {
          "percentComplete": 100,
          "startDateTime": "2022-04-18T17:50:29.5808461Z",
          "endDateTime": "2022-04-18T17:50:35.3482185Z",
          "status": "succeeded"
        }
      },
      "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000",
      "createdDateTime": "2022-04-18T17:44:04Z",
      "lastUpdatedDateTime": "2022-04-18T17:51:11Z",
      "expirationDateTime": "2022-04-25T17:44:04Z",
      "status": "succeeded"
    }
  ],
  "nextLink": null
}

定义

名称	说明
Error	错误对象。
ErrorCode	人类可读的错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人类可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobStatus	作业状态。
TextAnalysisAuthoringSubTrainingJobState	表示训练子操作的详细状态。
TextAnalysisAuthoringTrainingJobResult	表示训练作业的输出。
TextAnalysisAuthoringTrainingJobs	表示检索到的训练作业的列表。
TextAnalysisAuthoringTrainingJobState	表示训练作业的状态。
TextAnalysisAuthoringWarning	表示在执行请求时遇到的警告。

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	错误对象。

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	错误目标。

JobStatus

作业状态。

名称	类型	说明
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

TextAnalysisAuthoringSubTrainingJobState

表示训练子操作的详细状态。

名称	类型	说明
endDateTime	string	表示结束日期时间。
percentComplete	integer	表示进度百分比。
startDateTime	string	表示开始日期时间。
status	JobStatus	表示子操作的状态。

TextAnalysisAuthoringTrainingJobResult

表示训练作业的输出。

名称	类型	说明
estimatedEndDateTime	string	表示训练和评估的估计结束日期时间。
evaluationStatus	TextAnalysisAuthoringSubTrainingJobState	表示模型评估状态。
modelLabel	string	表示训练的模型标签。
trainingConfigVersion	string	表示训练配置版本。
trainingStatus	TextAnalysisAuthoringSubTrainingJobState	表示模型训练状态。

TextAnalysisAuthoringTrainingJobs

表示检索到的训练作业的列表。

名称	类型	说明
nextLink	string	下一页链接。
value	TextAnalysisAuthoringTrainingJobState[]	作业的列表。

TextAnalysisAuthoringTrainingJobState

表示训练作业的状态。

名称	类型	说明
createdDateTime	string	作业的创建日期时间。
errors	Error[]	执行作业时遇到的错误。
expirationDateTime	string	作业的到期日期时间。
jobId	string	作业 ID。
lastUpdatedDateTime	string	上次更新作业的日期时间。
result	TextAnalysisAuthoringTrainingJobResult	表示训练任务的详细结果。
status	JobStatus	作业状态。
warnings	TextAnalysisAuthoringWarning[]	执行作业时遇到的警告。

TextAnalysisAuthoringWarning

表示在执行请求时遇到的警告。

名称	类型	说明
code	string	警告代码。
message	string	警告消息。