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

Text Analysis Authoring - List Training Jobs

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

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

URI 参数

Name In Required Type Description
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

要从集合返回的最大资源数。

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

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

响应

Name Type Description
200 OK

训练作业的列表。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

示例

Successful List Training Jobs

Sample Request

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

Sample Response

{
  "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

错误对象。

Name Type Description
code

服务器定义的错误代码集之一。

details

有关导致此错误的特定错误的详细信息数组。

innererror

包含与当前对象有关错误的更具体信息的对象。

message
  • string

错误的可读表示形式。

target
  • string

错误的目标。

ErrorCode

可读错误代码。

Name Type Description
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

错误响应。

Name Type Description
error

错误对象。

InnerErrorCode

可读错误代码。

Name Type Description
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.

Name Type Description
code

服务器定义的错误代码集之一。

details
  • object

错误详细信息。

innererror

包含与当前对象有关错误的更具体信息的对象。

message
  • string

错误消息。

target
  • string

错误目标。

JobStatus

作业状态。

Name Type Description
cancelled
  • string
cancelling
  • string
failed
  • string
notStarted
  • string
partiallyCompleted
  • string
running
  • string
succeeded
  • string

TextAnalysisAuthoringSubTrainingJobState

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

Name Type Description
endDateTime
  • string

表示结束日期时间。

percentComplete
  • integer

表示进度百分比。

startDateTime
  • string

表示开始日期时间。

status

表示子操作的状态。

TextAnalysisAuthoringTrainingJobResult

表示训练作业的输出。

Name Type Description
estimatedEndDateTime
  • string

表示训练和评估的估计结束日期时间。

evaluationStatus

表示模型评估状态。

modelLabel
  • string

表示已训练的模型标签。

trainingConfigVersion
  • string

表示训练配置版本。

trainingStatus

表示模型训练状态。

TextAnalysisAuthoringTrainingJobs

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

Name Type Description
nextLink
  • string

下一页链接。

value

作业的列表。

TextAnalysisAuthoringTrainingJobState

表示训练作业的状态。

Name Type Description
createdDateTime
  • string

作业的创建日期时间。

errors

执行作业时遇到的错误。

expirationDateTime
  • string

作业的到期日期时间。

jobId
  • string

作业 ID。

lastUpdatedDateTime
  • string

更新作业的最后一个日期时间。

result

表示训练任务详细结果。

status

作业状态。

warnings

执行作业时遇到的警告。

TextAnalysisAuthoringWarning

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

Name Type Description
code
  • string

警告代码。

message
  • string

警告消息。