From 68e5cd0687799b82d69ce1206f1fe662472c8faf Mon Sep 17 00:00:00 2001 From: "Lai, Weijian" Date: Tue, 18 Jun 2024 11:02:37 +0000 Subject: [PATCH] ModelArts API 23.3.0 Version. Reviewed-by: Pruthi, Vineet Co-authored-by: Lai, Weijian Co-committed-by: Lai, Weijian --- docs/modelarts/api-ref/ALL_META.TXT.json | 3443 ++++---- docs/modelarts/api-ref/AcceptSamples.html | 200 +- docs/modelarts/api-ref/AttachObs.html | 137 +- .../api-ref/AutoAnnotationProgress.html | 1463 ++-- .../api-ref/BatchDeletePoolNodes.html | 136 + ...teWorkers.html => BatchDeleteWorkers.html} | 124 +- docs/modelarts/api-ref/CLASS.TXT.json | 1662 ++-- docs/modelarts/api-ref/CancelObs.html | 107 +- docs/modelarts/api-ref/ChangeAlgorithm.html | 1433 ++-- .../api-ref/ChangeTrainingJobDescription.html | 62 +- docs/modelarts/api-ref/CreateAlgorithm.html | 1417 ++-- .../api-ref/CreateAuthorization.html | 128 +- docs/modelarts/api-ref/CreateDataset.html | 966 +-- .../api-ref/CreateDatasetVersion.html | 144 +- docs/modelarts/api-ref/CreateImage.html | 366 + docs/modelarts/api-ref/CreateLabels.html | 371 +- docs/modelarts/api-ref/CreateModel.html | 748 ++ .../api-ref/CreateModelArtsAgency.html | 64 +- docs/modelarts/api-ref/CreateNetwork.html | 753 ++ docs/modelarts/api-ref/CreateNotebook.html | 1059 ++- docs/modelarts/api-ref/CreatePool.html | 1414 ++++ .../api-ref/CreateProcessorTask.html | 401 +- .../api-ref/CreateProcessorTaskVersion.html | 482 +- docs/modelarts/api-ref/CreateService.html | 812 ++ docs/modelarts/api-ref/CreateTask.html | 1357 ++-- docs/modelarts/api-ref/CreateTrainingJob.html | 3173 ++++---- docs/modelarts/api-ref/CreateWorker.html | 86 +- docs/modelarts/api-ref/CreateWorkforce.html | 82 +- .../api-ref/CreateWorkforceTask.html | 329 +- docs/modelarts/api-ref/DeleteAlgorithm.html | 44 +- .../api-ref/DeleteAuthorizations.html | 64 +- docs/modelarts/api-ref/DeleteDataset.html | 50 +- .../api-ref/DeleteDatasetVersion.html | 58 +- docs/modelarts/api-ref/DeleteImage.html | 321 + .../api-ref/DeleteLabelAndSamples.html | 115 +- docs/modelarts/api-ref/DeleteLabels.html | 313 +- docs/modelarts/api-ref/DeleteModel.html | 187 + docs/modelarts/api-ref/DeleteNetwork.html | 533 ++ docs/modelarts/api-ref/DeleteNotebook.html | 534 +- docs/modelarts/api-ref/DeletePool.html | 944 +++ .../api-ref/DeleteProcessorTask.html | 50 +- .../api-ref/DeleteProcessorTaskVersion.html | 58 +- docs/modelarts/api-ref/DeleteSamples.html | 132 +- docs/modelarts/api-ref/DeleteService.html | 100 + docs/modelarts/api-ref/DeleteTrainingJob.html | 44 +- docs/modelarts/api-ref/DeleteWorker.html | 58 +- docs/modelarts/api-ref/DeleteWorkforce.html | 104 +- .../api-ref/DeleteWorkforceTask.html | 58 +- docs/modelarts/api-ref/DescDataset.html | 1762 +++-- docs/modelarts/api-ref/DescImportTask.html | 433 +- .../api-ref/DescProcessorTaskVersion.html | 299 +- docs/modelarts/api-ref/DescWorker.html | 116 +- docs/modelarts/api-ref/DescWorkforce.html | 102 +- docs/modelarts/api-ref/DescWorkforceTask.html | 1067 +-- .../api-ref/DescribeAutoAnnotationSample.html | 631 +- .../api-ref/DescribeDatasetVersion.html | 649 +- .../api-ref/DescribeProcessorTask.html | 345 +- docs/modelarts/api-ref/DescribeSample.html | 674 +- .../api-ref/DescribeWorkforceTaskSample.html | 681 +- docs/modelarts/api-ref/ExportTask.html | 1032 +-- docs/modelarts/api-ref/GetAuthorizations.html | 159 +- docs/modelarts/api-ref/GetDatasetMetrics.html | 98 +- docs/modelarts/api-ref/GetDatasetStats.html | 514 ++ .../api-ref/GetExportTaskStatusOfDataset.html | 492 +- .../GetExportTasksStatusOfDataset.html | 677 +- .../api-ref/GetProcessorTaskItems.html | 177 +- .../api-ref/GetWorkforceSamplingTask.html | 174 +- .../api-ref/GetWorkforceTaskMetrics.html | 74 +- docs/modelarts/api-ref/ImportTask.html | 680 +- docs/modelarts/api-ref/ListAlgorithms.html | 746 +- docs/modelarts/api-ref/ListAllWorkers.html | 166 +- ...amicMount.html => ListAttachableObSs.html} | 135 +- .../api-ref/ListAutoAnnotationSamples.html | 735 +- docs/modelarts/api-ref/ListClusters.html | 379 + .../api-ref/ListDatasetVersions.html | 613 +- docs/modelarts/api-ref/ListDatasets.html | 2075 ++--- docs/modelarts/api-ref/ListEvents.html | 425 + docs/modelarts/api-ref/ListFlavors.html | 477 ++ docs/modelarts/api-ref/ListImage.html | 674 +- docs/modelarts/api-ref/ListImageGroup.html | 315 + docs/modelarts/api-ref/ListImportTasks.html | 467 +- docs/modelarts/api-ref/ListLabels.html | 282 +- docs/modelarts/api-ref/ListModels.html | 487 ++ docs/modelarts/api-ref/ListNetworks.html | 590 ++ docs/modelarts/api-ref/ListNotebooks.html | 706 +- docs/modelarts/api-ref/ListPoolNodes.html | 474 ++ docs/modelarts/api-ref/ListPools.html | 987 +++ .../ListProcessorTaskVersionResults.html | 226 +- .../api-ref/ListProcessorTaskVersions.html | 349 +- .../modelarts/api-ref/ListProcessorTasks.html | 509 +- .../api-ref/ListResourceFlavors.html | 571 ++ docs/modelarts/api-ref/ListSamples.html | 810 +- docs/modelarts/api-ref/ListSearch.html | 252 +- .../api-ref/ListSearchAlgorithms.html | 218 - docs/modelarts/api-ref/ListServices.html | 484 ++ docs/modelarts/api-ref/ListStats.html | 479 -- docs/modelarts/api-ref/ListTasks.html | 1559 ++-- .../api-ref/ListTrainingJobEngines.html | 237 - .../api-ref/ListTrainingJobFlavors.html | 418 - docs/modelarts/api-ref/ListTrainingJobs.html | 1819 ++--- docs/modelarts/api-ref/ListWorkerTasks.html | 286 +- docs/modelarts/api-ref/ListWorkers.html | 166 +- .../api-ref/ListWorkforceTaskSamples.html | 745 +- .../api-ref/ListWorkforceTaskStats.html | 442 +- .../modelarts/api-ref/ListWorkforceTasks.html | 891 ++- docs/modelarts/api-ref/ListWorkforces.html | 168 +- docs/modelarts/api-ref/ListWorkloads.html | 446 ++ docs/modelarts/api-ref/PatchNetwork.html | 800 ++ docs/modelarts/api-ref/PatchPool.html | 1299 +++ docs/modelarts/api-ref/RegisterImage.html | 414 + docs/modelarts/api-ref/RenewLease.html | 149 +- docs/modelarts/api-ref/ReviewSamples.html | 200 +- docs/modelarts/api-ref/RunCodeLab.html | 509 -- docs/modelarts/api-ref/SendEmails.html | 132 +- .../api-ref/ShowAlgorithmByUuid.html | 636 +- docs/modelarts/api-ref/ShowAttachableObs.html | 107 +- ...ShowAutoSearchParamAnalysisResultPath.html | 109 - .../api-ref/ShowAutoSearchParamsAnalysis.html | 108 - .../api-ref/ShowAutoSearchPerTrial.html | 117 - .../api-ref/ShowAutoSearchTrialEarlyStop.html | 105 - .../api-ref/ShowAutoSearchTrials.html | 195 - .../ShowAutoSearchYamlTemplateContent.html | 113 - .../ShowAutoSearchYamlTemplatesInfo.html | 129 - docs/modelarts/api-ref/ShowImage.html | 294 + docs/modelarts/api-ref/ShowLease.html | 92 +- docs/modelarts/api-ref/ShowModel.html | 673 ++ docs/modelarts/api-ref/ShowNetwork.html | 521 ++ docs/modelarts/api-ref/ShowNotebook.html | 547 +- .../api-ref/ShowObsUrlOfTrainingJobLogs.html | 129 + docs/modelarts/api-ref/ShowOsConfig.html | 144 + docs/modelarts/api-ref/ShowOsQuota.html | 182 + .../modelarts/api-ref/ShowPluginTemplate.html | 256 + docs/modelarts/api-ref/ShowPool.html | 928 +++ docs/modelarts/api-ref/ShowPoolMonitor.html | 560 ++ .../api-ref/ShowPoolRuntimeMetrics.html | 319 + .../modelarts/api-ref/ShowPoolStatistics.html | 226 + docs/modelarts/api-ref/ShowService.html | 799 ++ docs/modelarts/api-ref/ShowServiceEvents.html | 308 + .../api-ref/ShowServiceMonitorInfo.html | 273 + .../api-ref/ShowServiceSpecifications.html | 290 + .../api-ref/ShowServiceUpdateLogs.html | 399 + .../api-ref/ShowSwitchableFlavors.html | 501 +- .../api-ref/ShowTrainingJobDetails.html | 2133 +++++ .../api-ref/ShowTrainingJobEngines.html | 237 + .../api-ref/ShowTrainingJobFlavors.html | 455 ++ .../api-ref/ShowTrainingJobInfomation.html | 2090 ----- .../api-ref/ShowTrainingJobLogsFromObs.html | 127 - .../api-ref/ShowTrainingJobLogsPreview.html | 78 +- .../api-ref/ShowTrainingJobMetrics.html | 82 +- .../api-ref/ShowWorkloadStatistics.html | 306 + docs/modelarts/api-ref/StartNotebook.html | 593 +- .../api-ref/StartWorkforceSamplingTask.html | 98 +- .../modelarts/api-ref/StartWorkforceTask.html | 326 +- .../modelarts/api-ref/StopAutoAnnotation.html | 64 +- docs/modelarts/api-ref/StopNotebook.html | 550 +- .../api-ref/StopProcessorTaskVersion.html | 64 +- docs/modelarts/api-ref/StopTrainingJob.html | 1580 ++-- docs/modelarts/api-ref/SyncDataSource.html | 54 +- .../api-ref/SyncDataSourceState.html | 120 +- docs/modelarts/api-ref/UpdateDataset.html | 339 +- docs/modelarts/api-ref/UpdateLabel.html | 167 +- docs/modelarts/api-ref/UpdateLabels.html | 371 +- docs/modelarts/api-ref/UpdateNotebook.html | 943 ++- .../api-ref/UpdateProcessorTask.html | 70 +- docs/modelarts/api-ref/UpdateSamples.html | 564 +- docs/modelarts/api-ref/UpdateService.html | 514 ++ docs/modelarts/api-ref/UpdateWorker.html | 86 +- docs/modelarts/api-ref/UpdateWorkforce.html | 78 +- .../api-ref/UpdateWorkforceSamplingTask.html | 706 +- .../api-ref/UpdateWorkforceTask.html | 362 +- .../api-ref/UpdateWorkforceTaskSamples.html | 543 +- docs/modelarts/api-ref/UploadSamplesJson.html | 820 +- docs/modelarts/api-ref/algorithms.html | 32 +- docs/modelarts/api-ref/authorization.html | 8 +- docs/modelarts/api-ref/auto_task.html | 26 - docs/modelarts/api-ref/config_management.html | 16 + docs/modelarts/api-ref/data_export.html | 20 - docs/modelarts/api-ref/data_import.html | 20 - docs/modelarts/api-ref/data_sync.html | 18 - .../modelarts/api-ref/dataset_management.html | 152 +- .../api-ref/dataset_version_management.html | 22 - .../api-ref/en-us_image_0000001815960734.png | Bin 107497 -> 0 bytes .../api-ref/en-us_image_0000001815961414.png | Bin 80660 -> 0 bytes .../api-ref/en-us_image_0000001816121182.png | Bin 50278 -> 0 bytes .../api-ref/en-us_image_0000001862465813.png | Bin 45697 -> 0 bytes .../api-ref/en-us_image_0000001862721045.png | Bin 93922 -> 0 bytes .../api-ref/en-us_image_0000001862721209.png | Bin 66530 -> 0 bytes docs/modelarts/api-ref/event_management.html | 16 + .../figure/en-us_image_0000001909848400.gif | Bin 0 -> 28628 bytes .../en-us_image_0000001910008396.png} | Bin .../figure/en-us_image_0000001910008400.gif | Bin 0 -> 42932 bytes .../en-us_image_0000001943967489.png} | Bin .../figure/en-us_image_0000001943967573.gif | Bin 0 -> 51879 bytes .../figure/en-us_image_0000001943967577.gif | Bin 0 -> 48314 bytes .../figure/en-us_image_0000001943967581.gif | Bin 0 -> 33277 bytes docs/modelarts/api-ref/label_management.html | 26 - .../api-ref/label_task_management.html | 34 - .../api-ref/manual_annotation_management.html | 16 - .../modelarts/api-ref/metrics_management.html | 16 + docs/modelarts/api-ref/modelarts_03_0001.html | 5 +- docs/modelarts/api-ref/modelarts_03_0002.html | 1196 ++- docs/modelarts/api-ref/modelarts_03_0003.html | 28 +- docs/modelarts/api-ref/modelarts_03_0004.html | 120 +- docs/modelarts/api-ref/modelarts_03_0005.html | 175 +- docs/modelarts/api-ref/modelarts_03_0006.html | 14 +- docs/modelarts/api-ref/modelarts_03_0076.html | 782 -- docs/modelarts/api-ref/modelarts_03_0077.html | 421 - docs/modelarts/api-ref/modelarts_03_0078.html | 652 -- docs/modelarts/api-ref/modelarts_03_0079.html | 149 - docs/modelarts/api-ref/modelarts_03_0081.html | 27 - docs/modelarts/api-ref/modelarts_03_0082.html | 556 -- docs/modelarts/api-ref/modelarts_03_0083.html | 484 -- docs/modelarts/api-ref/modelarts_03_0084.html | 783 -- docs/modelarts/api-ref/modelarts_03_0086.html | 408 - docs/modelarts/api-ref/modelarts_03_0087.html | 222 - docs/modelarts/api-ref/modelarts_03_0088.html | 346 - docs/modelarts/api-ref/modelarts_03_0089.html | 59 - docs/modelarts/api-ref/modelarts_03_0093.html | 4 +- docs/modelarts/api-ref/modelarts_03_0094.html | 286 +- docs/modelarts/api-ref/modelarts_03_0095.html | 6963 ++++++++++------- docs/modelarts/api-ref/modelarts_03_0097.html | 17 +- docs/modelarts/api-ref/modelarts_03_0107.html | 17 - docs/modelarts/api-ref/modelarts_03_0108.html | 8 +- docs/modelarts/api-ref/modelarts_03_0109.html | 83 - docs/modelarts/api-ref/modelarts_03_0110.html | 1057 +-- docs/modelarts/api-ref/modelarts_03_0111.html | 847 +- docs/modelarts/api-ref/modelarts_03_0112.html | 782 +- docs/modelarts/api-ref/modelarts_03_0113.html | 857 +- docs/modelarts/api-ref/modelarts_03_0114.html | 61 +- docs/modelarts/api-ref/modelarts_03_0115.html | 85 +- docs/modelarts/api-ref/modelarts_03_0119.html | 19 - docs/modelarts/api-ref/modelarts_03_0138.html | 14 +- docs/modelarts/api-ref/modelarts_03_0139.html | 4 +- docs/modelarts/api-ref/modelarts_03_0140.html | 4 +- docs/modelarts/api-ref/modelarts_03_0141.html | 40 +- docs/modelarts/api-ref/modelarts_03_0142.html | 11 + docs/modelarts/api-ref/modelarts_03_0143.html | 12 +- docs/modelarts/api-ref/modelarts_03_0144.html | 2 +- docs/modelarts/api-ref/modelarts_03_0146.html | 16 +- docs/modelarts/api-ref/modelarts_03_0147.html | 16 +- docs/modelarts/api-ref/modelarts_03_0148.html | 10 +- docs/modelarts/api-ref/modelarts_03_0153.html | 18 - docs/modelarts/api-ref/modelarts_03_0155.html | 270 - docs/modelarts/api-ref/modelarts_03_0161.html | 1186 +-- docs/modelarts/api-ref/modelarts_03_0162.html | 87 +- docs/modelarts/api-ref/modelarts_03_0163.html | 334 - docs/modelarts/api-ref/modelarts_03_0164.html | 54 +- docs/modelarts/api-ref/modelarts_03_0165.html | 104 +- docs/modelarts/api-ref/modelarts_03_0166.html | 126 - docs/modelarts/api-ref/modelarts_03_0200.html | 211 - docs/modelarts/api-ref/modelarts_03_0202.html | 39 - docs/modelarts/api-ref/modelarts_03_0234.html | 115 - docs/modelarts/api-ref/modelarts_03_0299.html | 414 - docs/modelarts/api-ref/modelarts_03_0364.html | 159 + docs/modelarts/api-ref/modelarts_03_0365.html | 226 + .../modelarts/api-ref/network_management.html | 24 + docs/modelarts/api-ref/notebook.html | 36 +- docs/modelarts/api-ref/process_task.html | 38 - .../api-ref/resource_flavor_management.html | 16 + docs/modelarts/api-ref/resources.html | 18 - docs/modelarts/api-ref/sample_management.html | 28 - docs/modelarts/api-ref/storage.html | 22 - docs/modelarts/api-ref/topic_300000001.html | 16 + docs/modelarts/api-ref/topic_300000003.html | 18 + docs/modelarts/api-ref/topic_300000004.html | 18 + docs/modelarts/api-ref/topic_300000005.html | 16 + docs/modelarts/api-ref/topic_300000006.html | 33 + docs/modelarts/api-ref/topic_300000007.html | 18 + docs/modelarts/api-ref/topic_300000008.html | 28 + docs/modelarts/api-ref/topic_300000009.html | 30 + docs/modelarts/api-ref/trainingJobs.html | 46 - .../api-ref/workforce_management.html | 24 - .../api-ref/workforce_process_management.html | 20 - .../api-ref/workforce_worker_management.html | 30 - 274 files changed, 65012 insertions(+), 43287 deletions(-) create mode 100644 docs/modelarts/api-ref/BatchDeletePoolNodes.html rename docs/modelarts/api-ref/{DeleteWorkers.html => BatchDeleteWorkers.html} (58%) create mode 100644 docs/modelarts/api-ref/CreateImage.html create mode 100644 docs/modelarts/api-ref/CreateModel.html create mode 100644 docs/modelarts/api-ref/CreateNetwork.html create mode 100644 docs/modelarts/api-ref/CreatePool.html create mode 100644 docs/modelarts/api-ref/CreateService.html create mode 100644 docs/modelarts/api-ref/DeleteImage.html create mode 100644 docs/modelarts/api-ref/DeleteModel.html create mode 100644 docs/modelarts/api-ref/DeleteNetwork.html create mode 100644 docs/modelarts/api-ref/DeletePool.html create mode 100644 docs/modelarts/api-ref/DeleteService.html create mode 100644 docs/modelarts/api-ref/GetDatasetStats.html rename docs/modelarts/api-ref/{ListDynamicMount.html => ListAttachableObSs.html} (57%) create mode 100644 docs/modelarts/api-ref/ListClusters.html create mode 100644 docs/modelarts/api-ref/ListEvents.html create mode 100644 docs/modelarts/api-ref/ListFlavors.html create mode 100644 docs/modelarts/api-ref/ListImageGroup.html create mode 100644 docs/modelarts/api-ref/ListModels.html create mode 100644 docs/modelarts/api-ref/ListNetworks.html create mode 100644 docs/modelarts/api-ref/ListPoolNodes.html create mode 100644 docs/modelarts/api-ref/ListPools.html create mode 100644 docs/modelarts/api-ref/ListResourceFlavors.html delete mode 100644 docs/modelarts/api-ref/ListSearchAlgorithms.html create mode 100644 docs/modelarts/api-ref/ListServices.html delete mode 100644 docs/modelarts/api-ref/ListStats.html delete mode 100644 docs/modelarts/api-ref/ListTrainingJobEngines.html delete mode 100644 docs/modelarts/api-ref/ListTrainingJobFlavors.html create mode 100644 docs/modelarts/api-ref/ListWorkloads.html create mode 100644 docs/modelarts/api-ref/PatchNetwork.html create mode 100644 docs/modelarts/api-ref/PatchPool.html create mode 100644 docs/modelarts/api-ref/RegisterImage.html delete mode 100644 docs/modelarts/api-ref/RunCodeLab.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchParamAnalysisResultPath.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchParamsAnalysis.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchPerTrial.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchTrialEarlyStop.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchTrials.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchYamlTemplateContent.html delete mode 100644 docs/modelarts/api-ref/ShowAutoSearchYamlTemplatesInfo.html create mode 100644 docs/modelarts/api-ref/ShowImage.html create mode 100644 docs/modelarts/api-ref/ShowModel.html create mode 100644 docs/modelarts/api-ref/ShowNetwork.html create mode 100644 docs/modelarts/api-ref/ShowObsUrlOfTrainingJobLogs.html create mode 100644 docs/modelarts/api-ref/ShowOsConfig.html create mode 100644 docs/modelarts/api-ref/ShowOsQuota.html create mode 100644 docs/modelarts/api-ref/ShowPluginTemplate.html create mode 100644 docs/modelarts/api-ref/ShowPool.html create mode 100644 docs/modelarts/api-ref/ShowPoolMonitor.html create mode 100644 docs/modelarts/api-ref/ShowPoolRuntimeMetrics.html create mode 100644 docs/modelarts/api-ref/ShowPoolStatistics.html create mode 100644 docs/modelarts/api-ref/ShowService.html create mode 100644 docs/modelarts/api-ref/ShowServiceEvents.html create mode 100644 docs/modelarts/api-ref/ShowServiceMonitorInfo.html create mode 100644 docs/modelarts/api-ref/ShowServiceSpecifications.html create mode 100644 docs/modelarts/api-ref/ShowServiceUpdateLogs.html create mode 100644 docs/modelarts/api-ref/ShowTrainingJobDetails.html create mode 100644 docs/modelarts/api-ref/ShowTrainingJobEngines.html create mode 100644 docs/modelarts/api-ref/ShowTrainingJobFlavors.html delete mode 100644 docs/modelarts/api-ref/ShowTrainingJobInfomation.html delete mode 100644 docs/modelarts/api-ref/ShowTrainingJobLogsFromObs.html create mode 100644 docs/modelarts/api-ref/ShowWorkloadStatistics.html create mode 100644 docs/modelarts/api-ref/UpdateService.html delete mode 100644 docs/modelarts/api-ref/auto_task.html create mode 100644 docs/modelarts/api-ref/config_management.html delete mode 100644 docs/modelarts/api-ref/data_export.html delete mode 100644 docs/modelarts/api-ref/data_import.html delete mode 100644 docs/modelarts/api-ref/data_sync.html delete mode 100644 docs/modelarts/api-ref/dataset_version_management.html delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001815960734.png delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001815961414.png delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001816121182.png delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001862465813.png delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001862721045.png delete mode 100644 docs/modelarts/api-ref/en-us_image_0000001862721209.png create mode 100644 docs/modelarts/api-ref/event_management.html create mode 100644 docs/modelarts/api-ref/figure/en-us_image_0000001909848400.gif rename docs/modelarts/api-ref/{en-us_image_0000001815626418.png => figure/en-us_image_0000001910008396.png} (100%) create mode 100644 docs/modelarts/api-ref/figure/en-us_image_0000001910008400.gif rename docs/modelarts/api-ref/{en-us_image_0000001846140993.png => figure/en-us_image_0000001943967489.png} (100%) create mode 100644 docs/modelarts/api-ref/figure/en-us_image_0000001943967573.gif create mode 100644 docs/modelarts/api-ref/figure/en-us_image_0000001943967577.gif create mode 100644 docs/modelarts/api-ref/figure/en-us_image_0000001943967581.gif delete mode 100644 docs/modelarts/api-ref/label_management.html delete mode 100644 docs/modelarts/api-ref/label_task_management.html delete mode 100644 docs/modelarts/api-ref/manual_annotation_management.html create mode 100644 docs/modelarts/api-ref/metrics_management.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0076.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0077.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0078.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0079.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0081.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0082.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0083.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0084.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0086.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0087.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0088.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0089.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0107.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0109.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0119.html create mode 100644 docs/modelarts/api-ref/modelarts_03_0142.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0153.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0155.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0163.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0166.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0200.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0202.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0234.html delete mode 100644 docs/modelarts/api-ref/modelarts_03_0299.html create mode 100644 docs/modelarts/api-ref/modelarts_03_0364.html create mode 100644 docs/modelarts/api-ref/modelarts_03_0365.html create mode 100644 docs/modelarts/api-ref/network_management.html delete mode 100644 docs/modelarts/api-ref/process_task.html create mode 100644 docs/modelarts/api-ref/resource_flavor_management.html delete mode 100644 docs/modelarts/api-ref/resources.html delete mode 100644 docs/modelarts/api-ref/sample_management.html delete mode 100644 docs/modelarts/api-ref/storage.html create mode 100644 docs/modelarts/api-ref/topic_300000001.html create mode 100644 docs/modelarts/api-ref/topic_300000003.html create mode 100644 docs/modelarts/api-ref/topic_300000004.html create mode 100644 docs/modelarts/api-ref/topic_300000005.html create mode 100644 docs/modelarts/api-ref/topic_300000006.html create mode 100644 docs/modelarts/api-ref/topic_300000007.html create mode 100644 docs/modelarts/api-ref/topic_300000008.html create mode 100644 docs/modelarts/api-ref/topic_300000009.html delete mode 100644 docs/modelarts/api-ref/trainingJobs.html delete mode 100644 docs/modelarts/api-ref/workforce_management.html delete mode 100644 docs/modelarts/api-ref/workforce_process_management.html delete mode 100644 docs/modelarts/api-ref/workforce_worker_management.html diff --git a/docs/modelarts/api-ref/ALL_META.TXT.json b/docs/modelarts/api-ref/ALL_META.TXT.json index 7960f2f6..5db35e68 100644 --- a/docs/modelarts/api-ref/ALL_META.TXT.json +++ b/docs/modelarts/api-ref/ALL_META.TXT.json @@ -1,10 +1,10 @@ [ { - "dockw":"API Reference" + "dockw":"03 ModelArts API Reference" }, { "uri":"modelarts_03_0139.html", - "node_id":"modelarts_03_0139.xml", + "node_id":"en-us_topic_0000001910008112.xml", "product_code":"modelarts", "code":"1", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -14,8 +14,9 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Before You Start", @@ -23,18 +24,19 @@ }, { "uri":"modelarts_03_0001.html", - "node_id":"modelarts_03_0001.xml", + "node_id":"en-us_topic_0000001909848208.xml", "product_code":"modelarts", "code":"2", "des":"ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy model", "doc_type":"api", - "kw":"Overview,Before You Start,API Reference", + "kw":"Overview,Before You Start,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Overview", @@ -42,18 +44,19 @@ }, { "uri":"modelarts_03_0140.html", - "node_id":"modelarts_03_0140.xml", + "node_id":"en-us_topic_0000001910008104.xml", "product_code":"modelarts", "code":"3", "des":"ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", "doc_type":"api", - "kw":"API Calling,Before You Start,API Reference", + "kw":"API Calling,Before You Start,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"API Calling", @@ -61,37 +64,59 @@ }, { "uri":"modelarts_03_0141.html", - "node_id":"modelarts_03_0141.xml", + "node_id":"en-us_topic_0000001909848136.xml", "product_code":"modelarts", "code":"4", - "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise admin", "doc_type":"api", - "kw":"Endpoint,Before You Start,API Reference", + "kw":"Endpoint,Before You Start,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Endpoint", "githuburl":"" }, { - "uri":"modelarts_03_0143.html", - "node_id":"modelarts_03_0143.xml", + "uri":"modelarts_03_0142.html", + "node_id":"en-us_topic_0000001943967321.xml", "product_code":"modelarts", "code":"5", - "des":"AccountAn account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It", + "des":"For more constraints, see API description.", "doc_type":"api", - "kw":"Basic Concepts,Before You Start,API Reference", + "kw":"Constraints,Before You Start,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"modelarts_03_0143.html", + "node_id":"en-us_topic_0000001910008116.xml", + "product_code":"modelarts", + "code":"6", + "des":"AccountAn account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It", + "doc_type":"api", + "kw":"Basic Concepts,Before You Start,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Basic Concepts", @@ -99,18 +124,19 @@ }, { "uri":"modelarts_03_0002.html", - "node_id":"modelarts_03_0002.xml", + "node_id":"en-us_topic_0000001910007984.xml", "product_code":"modelarts", - "code":"6", - "des":"All ModelArts APIs are proprietary.Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets a", + "code":"7", + "des":"All ModelArts APIs are proprietary.You can use these APIs to manage datasets, training jobs, models, and services.", "doc_type":"api", - "kw":"API Overview,API Reference", + "kw":"API Overview,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"API Overview", @@ -118,9 +144,9 @@ }, { "uri":"modelarts_03_0144.html", - "node_id":"modelarts_03_0144.xml", + "node_id":"en-us_topic_0000001943967393.xml", "product_code":"modelarts", - "code":"7", + "code":"8", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Calling APIs", @@ -128,8 +154,9 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Calling APIs", @@ -137,18 +164,19 @@ }, { "uri":"modelarts_03_0005.html", - "node_id":"modelarts_03_0005.xml", + "node_id":"en-us_topic_0000001910008156.xml", "product_code":"modelarts", - "code":"8", + "code":"9", "des":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", "doc_type":"api", - "kw":"Making an API Request,Calling APIs,API Reference", + "kw":"Making an API Request,Calling APIs,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Making an API Request", @@ -156,18 +184,19 @@ }, { "uri":"modelarts_03_0004.html", - "node_id":"modelarts_03_0004.xml", + "node_id":"en-us_topic_0000001910008084.xml", "product_code":"modelarts", - "code":"9", + "code":"10", "des":"Requests for calling an API can be authenticated using either of the following methods: AK/SK-based authentication: Requests are authenticated by encrypting the request b", "doc_type":"api", - "kw":"Authentication,Calling APIs,API Reference", + "kw":"Authentication,Calling APIs,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Authentication", @@ -175,28 +204,29 @@ }, { "uri":"modelarts_03_0003.html", - "node_id":"modelarts_03_0003.xml", + "node_id":"en-us_topic_0000001910007948.xml", "product_code":"modelarts", - "code":"10", + "code":"11", "des":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", "doc_type":"api", - "kw":"Response,Calling APIs,API Reference", + "kw":"Response,Calling APIs,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Response", "githuburl":"" }, { - "uri":"modelarts_03_0202.html", - "node_id":"modelarts_03_0202.xml", + "uri":"dataset_management.html", + "node_id":"en-us_topic_0000001909848060.xml", "product_code":"modelarts", - "code":"11", + "code":"12", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Data Management", @@ -204,65 +234,29 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Data Management", "githuburl":"" }, { - "uri":"modelarts_03_0299.html", - "node_id":"modelarts_03_0299.xml", - "product_code":"modelarts", - "code":"12", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Data Management APIs,Data Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Data Management APIs", - "githuburl":"" - }, - { - "uri":"dataset_management.html", - "node_id":"dataset_management.xml", + "uri":"ListDatasets.html", + "node_id":"en-us_topic_0000001910007904.xml", "product_code":"modelarts", "code":"13", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"This API is used to query the created datasets that meet the search criteria by page.You can debug this API through automatic authentication in or use the SDK sample cod", "doc_type":"api", - "kw":"Dataset Management", + "kw":"Querying the Dataset List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Dataset Management", - "githuburl":"" - }, - { - "uri":"ListDatasets.html", - "node_id":"listdatasets.xml", - "product_code":"modelarts", - "code":"14", - "des":"This API is used to query the created datasets that meet the search criteria by page.GET /v2/{project_id}/datasetsNoneStatus code: 200Querying the Dataset ListStatus code", - "doc_type":"api", - "kw":"Querying the Dataset List,Dataset Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Dataset List", @@ -270,18 +264,19 @@ }, { "uri":"CreateDataset.html", - "node_id":"createdataset.xml", + "node_id":"en-us_topic_0000001909848056.xml", "product_code":"modelarts", - "code":"15", - "des":"This API is used to create a dataset.POST /v2/{project_id}/datasetsStatus code: 201Creating an Image Classification Dataset{\n \"workspace_id\" : \"0\",\n \"dataset_name\" : \"d", + "code":"14", + "des":"This API is used to create a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{project_id", "doc_type":"api", - "kw":"Creating a Dataset,Dataset Management,API Reference", + "kw":"Creating a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Dataset", @@ -289,18 +284,19 @@ }, { "uri":"DescDataset.html", - "node_id":"descdataset.xml", + "node_id":"en-us_topic_0000001910007960.xml", "product_code":"modelarts", - "code":"16", - "des":"This API is used to query details about a dataset.GET /v2/{project_id}/datasets/{dataset_id}NoneStatus code: 200Querying Details About a DatasetStatus code: 200OKSee Erro", + "code":"15", + "des":"This API is used to query details about a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "doc_type":"api", - "kw":"Querying Details About a Dataset,Dataset Management,API Reference", + "kw":"Querying Details About a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Dataset", @@ -308,18 +304,19 @@ }, { "uri":"UpdateDataset.html", - "node_id":"updatedataset.xml", + "node_id":"en-us_topic_0000001943967161.xml", "product_code":"modelarts", - "code":"17", - "des":"This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels.PUT /v2/{project_id}/datasets/{dataset_id", + "code":"16", + "des":"This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels.You can debug this API through automatic ", "doc_type":"api", - "kw":"Modifying a Dataset,Dataset Management,API Reference", + "kw":"Modifying a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Modifying a Dataset", @@ -327,37 +324,39 @@ }, { "uri":"DeleteDataset.html", - "node_id":"deletedataset.xml", + "node_id":"en-us_topic_0000001943967245.xml", "product_code":"modelarts", - "code":"18", - "des":"This API is used to delete a dataset without deleting the source data of the dataset.DELETE /v2/{project_id}/datasets/{dataset_id}NoneNoneDeleting a DatasetStatus code: 2", + "code":"17", + "des":"This API is used to delete a dataset without deleting the source data of the dataset.You can debug this API through automatic authentication in or use the SDK sample cod", "doc_type":"api", - "kw":"Deleting a Dataset,Dataset Management,API Reference", + "kw":"Deleting a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Dataset", "githuburl":"" }, { - "uri":"ListStats.html", - "node_id":"liststats.xml", + "uri":"GetDatasetStats.html", + "node_id":"en-us_topic_0000001910008052.xml", "product_code":"modelarts", - "code":"19", - "des":"This API is used to query dataset statistics.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/statsNoneStatus code: 200Querying Dataset StatisticsStatus code: ", + "code":"18", + "des":"This API is used to query dataset statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{pro", "doc_type":"api", - "kw":"Querying Dataset Statistics,Dataset Management,API Reference", + "kw":"Querying Dataset Statistics,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Dataset Statistics", @@ -365,94 +364,39 @@ }, { "uri":"GetDatasetMetrics.html", - "node_id":"getdatasetmetrics.xml", + "node_id":"en-us_topic_0000001909848200.xml", "product_code":"modelarts", - "code":"20", - "des":"This API is used to query the monitoring data of a dataset within a specified time range.GET /v2/{project_id}/datasets/{dataset_id}/metricsNoneStatus code: 200Querying th", + "code":"19", + "des":"This API is used to query the monitoring data of a dataset within a specified time range.You can debug this API through automatic authentication in or use the SDK sample", "doc_type":"api", - "kw":"Querying the Monitoring Data of a Dataset,Dataset Management,API Reference", + "kw":"Querying the Monitoring Data of a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Monitoring Data of a Dataset", "githuburl":"" }, - { - "uri":"ListWorkforceTaskStats.html", - "node_id":"listworkforcetaskstats.xml", - "product_code":"modelarts", - "code":"21", - "des":"This API is used to query details about team labeling task statistics.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/stat", - "doc_type":"api", - "kw":"Querying Details About Team Labeling Task Statistics,Dataset Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Details About Team Labeling Task Statistics", - "githuburl":"" - }, - { - "uri":"GetWorkforceTaskMetrics.html", - "node_id":"getworkforcetaskmetrics.xml", - "product_code":"modelarts", - "code":"22", - "des":"This API is used to query details about the progress of a team labeling task member.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics", - "doc_type":"api", - "kw":"Querying Details About the Progress of a Team Labeling Task Member,Dataset Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Details About the Progress of a Team Labeling Task Member", - "githuburl":"" - }, - { - "uri":"dataset_version_management.html", - "node_id":"dataset_version_management.xml", - "product_code":"modelarts", - "code":"23", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Dataset Version Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Dataset Version Management", - "githuburl":"" - }, { "uri":"ListDatasetVersions.html", - "node_id":"listdatasetversions.xml", + "node_id":"en-us_topic_0000001943967281.xml", "product_code":"modelarts", - "code":"24", - "des":"This API is used to query the version list of a specific dataset.GET /v2/{project_id}/datasets/{dataset_id}/versionsNoneStatus code: 200Querying the Version List of a Spe", + "code":"20", + "des":"This API is used to query the version list of a specific dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "doc_type":"api", - "kw":"Querying the Dataset Version List,Dataset Version Management,API Reference", + "kw":"Querying the Dataset Version List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Dataset Version List", @@ -460,18 +404,19 @@ }, { "uri":"CreateDatasetVersion.html", - "node_id":"createdatasetversion.xml", + "node_id":"en-us_topic_0000001910007952.xml", "product_code":"modelarts", - "code":"25", - "des":"This API is used to create a dataset labeling version.POST /v2/{project_id}/datasets/{dataset_id}/versionsStatus code: 201Creating a Dataset Labeling VersionStatus code: ", + "code":"21", + "des":"This API is used to create a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POS", "doc_type":"api", - "kw":"Creating a Dataset Labeling Version,Dataset Version Management,API Reference", + "kw":"Creating a Dataset Labeling Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Dataset Labeling Version", @@ -479,18 +424,19 @@ }, { "uri":"DescribeDatasetVersion.html", - "node_id":"describedatasetversion.xml", + "node_id":"en-us_topic_0000001909848100.xml", "product_code":"modelarts", - "code":"26", - "des":"This API is used to query the details about a dataset version.GET /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneStatus code: 200Querying Details About a", + "code":"22", + "des":"This API is used to query the details about a dataset version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "doc_type":"api", - "kw":"Querying Details About a Dataset Version,Dataset Version Management,API Reference", + "kw":"Querying Details About a Dataset Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Dataset Version", @@ -498,56 +444,39 @@ }, { "uri":"DeleteDatasetVersion.html", - "node_id":"deletedatasetversion.xml", + "node_id":"en-us_topic_0000001910007892.xml", "product_code":"modelarts", - "code":"27", - "des":"This API is used to delete a dataset labeling version.DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneNoneDeleting a Dataset Labeling VersionStatus", + "code":"23", + "des":"This API is used to delete a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DEL", "doc_type":"api", - "kw":"Deleting a Dataset Labeling Version,Dataset Version Management,API Reference", + "kw":"Deleting a Dataset Labeling Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Dataset Labeling Version", "githuburl":"" }, - { - "uri":"sample_management.html", - "node_id":"sample_management.xml", - "product_code":"modelarts", - "code":"28", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Sample Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Sample Management", - "githuburl":"" - }, { "uri":"ListSamples.html", - "node_id":"listsamples.xml", + "node_id":"en-us_topic_0000001910007932.xml", "product_code":"modelarts", - "code":"29", - "des":"This API is used to query the sample list by page.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesNoneStatus code: 200Querying the Sample List by PageS", + "code":"24", + "des":"This API is used to query the sample list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "doc_type":"api", - "kw":"Querying the Sample List,Sample Management,API Reference", + "kw":"Querying the Sample List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Sample List", @@ -555,18 +484,19 @@ }, { "uri":"UploadSamplesJson.html", - "node_id":"uploadsamplesjson.xml", + "node_id":"en-us_topic_0000001943967185.xml", "product_code":"modelarts", - "code":"30", - "des":"This API is used to add samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesStatus code: 200Adding Samples in BatchesStatus code: 200OK", + "code":"25", + "des":"This API is used to add samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "doc_type":"api", - "kw":"Adding Samples in Batches,Sample Management,API Reference", + "kw":"Adding Samples in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Adding Samples in Batches", @@ -574,18 +504,19 @@ }, { "uri":"DeleteSamples.html", - "node_id":"deletesamples.xml", + "node_id":"en-us_topic_0000001910008092.xml", "product_code":"modelarts", - "code":"31", - "des":"This API is used to delete samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/deleteStatus code: 200Deleting Samples in BatchesStatus", + "code":"26", + "des":"This API is used to delete samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{p", "doc_type":"api", - "kw":"Deleting Samples in Batches,Sample Management,API Reference", + "kw":"Deleting Samples in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting Samples in Batches", @@ -593,18 +524,19 @@ }, { "uri":"DescribeSample.html", - "node_id":"describesample.xml", + "node_id":"en-us_topic_0000001943967077.xml", "product_code":"modelarts", - "code":"32", - "des":"Query details about a sample.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}NoneStatus code: 200Querying Details About a SampleStatus code", + "code":"27", + "des":"Query details about a sample.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project_id}/dataset", "doc_type":"api", - "kw":"Querying Details About a Sample,Sample Management,API Reference", + "kw":"Querying Details About a Sample,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Sample", @@ -612,18 +544,19 @@ }, { "uri":"ListSearch.html", - "node_id":"listsearch.xml", + "node_id":"en-us_topic_0000001943967213.xml", "product_code":"modelarts", - "code":"33", - "des":"This API is used to obtain sample search condition.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-conditionNoneStatus code: 200Obtaining Sample Search", + "code":"28", + "des":"This API is used to obtain sample search condition.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v", "doc_type":"api", - "kw":"Obtaining Sample Search Condition,Sample Management,API Reference", + "kw":"Obtaining Sample Search Condition,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining Sample Search Condition", @@ -631,18 +564,19 @@ }, { "uri":"ListWorkforceTaskSamples.html", - "node_id":"listworkforcetasksamples.xml", + "node_id":"en-us_topic_0000001943967061.xml", "product_code":"modelarts", - "code":"34", - "des":"This API is used to query the sample list of a team labeling task by page.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/", + "code":"29", + "des":"This API is used to query the sample list of a team labeling task by page.You can debug this API through automatic authentication in or use the SDK sample code generated", "doc_type":"api", - "kw":"Querying the Sample List of a Team Labeling Task by Page,Sample Management,API Reference", + "kw":"Querying the Sample List of a Team Labeling Task by Page,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Sample List of a Team Labeling Task by Page", @@ -650,56 +584,39 @@ }, { "uri":"DescribeWorkforceTaskSample.html", - "node_id":"describeworkforcetasksample.xml", + "node_id":"en-us_topic_0000001943967209.xml", "product_code":"modelarts", - "code":"35", - "des":"This API is used to query details about team labeling samples.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sam", + "code":"30", + "des":"This API is used to obtain samples labeled by a team. The API can be called only after an acceptance task is initiated.You can debug this API through automatic authentica", "doc_type":"api", - "kw":"Querying Details About Team Labeling Samples,Sample Management,API Reference", + "kw":"Querying Details About Team Labeling Samples,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About Team Labeling Samples", "githuburl":"" }, - { - "uri":"label_management.html", - "node_id":"label_management.xml", - "product_code":"modelarts", - "code":"36", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Label Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Label Management", - "githuburl":"" - }, { "uri":"ListLabels.html", - "node_id":"listlabels.xml", + "node_id":"en-us_topic_0000001910007936.xml", "product_code":"modelarts", - "code":"37", - "des":"This API is used to query all labels of a dataset.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsNoneStatus code: 200Querying All Labels of a DatasetSt", + "code":"31", + "des":"This API is used to query all labels of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "doc_type":"api", - "kw":"Querying the Dataset Label List,Label Management,API Reference", + "kw":"Querying the Dataset Label List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Dataset Label List", @@ -707,18 +624,19 @@ }, { "uri":"CreateLabels.html", - "node_id":"createlabels.xml", + "node_id":"en-us_topic_0000001909847860.xml", "product_code":"modelarts", - "code":"38", - "des":"This API is used to create a dataset label.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Creating a Dataset LabelStatus code: 200OKSe", + "code":"32", + "des":"This API is used to create a dataset label.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "doc_type":"api", - "kw":"Creating a Dataset Label,Label Management,API Reference", + "kw":"Creating a Dataset Label,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Dataset Label", @@ -726,18 +644,19 @@ }, { "uri":"UpdateLabels.html", - "node_id":"updatelabels.xml", + "node_id":"en-us_topic_0000001943967225.xml", "product_code":"modelarts", - "code":"39", - "des":"This API is used to modify labels in batches.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Modifying Labels in BatchesStatus code: 200", + "code":"33", + "des":"This API is used to modify labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{pro", "doc_type":"api", - "kw":"Modifying Labels in Batches,Label Management,API Reference", + "kw":"Modifying Labels in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Modifying Labels in Batches", @@ -745,18 +664,19 @@ }, { "uri":"DeleteLabels.html", - "node_id":"deletelabels.xml", + "node_id":"en-us_topic_0000001909848028.xml", "product_code":"modelarts", - "code":"40", - "des":"This API is used to delete labels in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/deleteStatus code: 200Deleting Labels in BatchesStatus co", + "code":"34", + "des":"This API is used to delete labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{pr", "doc_type":"api", - "kw":"Deleting Labels in Batches,Label Management,API Reference", + "kw":"Deleting Labels in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting Labels in Batches", @@ -764,18 +684,19 @@ }, { "uri":"UpdateLabel.html", - "node_id":"updatelabel.xml", + "node_id":"en-us_topic_0000001943967125.xml", "product_code":"modelarts", - "code":"41", - "des":"This API is used to update a label by label names.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}Status code: 204Updating a Label by Label", + "code":"35", + "des":"This API is used to update a label by label names.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2", "doc_type":"api", - "kw":"Updating a Label by Label Names,Label Management,API Reference", + "kw":"Updating a Label by Label Names,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Label by Label Names", @@ -783,94 +704,59 @@ }, { "uri":"DeleteLabelAndSamples.html", - "node_id":"deletelabelandsamples.xml", + "node_id":"en-us_topic_0000001909848072.xml", "product_code":"modelarts", - "code":"42", - "des":"This API is used to delete a label and the files that only contain this label.DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}NoneStatus", + "code":"36", + "des":"This API is used to delete a label and the files that only contain this label.You can debug this API through automatic authentication in or use the SDK sample code gener", "doc_type":"api", - "kw":"Deleting a Label and the Files that Only Contain the Label,Label Management,API Reference", + "kw":"Deleting a Label and the Files that Only Contain the Label,Data Management,03 ModelArts API Referenc", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Label and the Files that Only Contain the Label", "githuburl":"" }, - { - "uri":"manual_annotation_management.html", - "node_id":"manual_annotation_management.xml", - "product_code":"modelarts", - "code":"43", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Manual Labeling", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Manual Labeling", - "githuburl":"" - }, { "uri":"UpdateSamples.html", - "node_id":"updatesamples.xml", + "node_id":"en-us_topic_0000001909847936.xml", "product_code":"modelarts", - "code":"44", + "code":"37", "des":"This API is used to update sample labels in batches, including adding, modifying, and deleting sample labels. If the parameter Labels of a sample in the request body is n", "doc_type":"api", - "kw":"Updating Sample Labels in Batches,Manual Labeling,API Reference", + "kw":"Updating Sample Labels in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating Sample Labels in Batches", "githuburl":"" }, - { - "uri":"label_task_management.html", - "node_id":"label_task_management.xml", - "product_code":"modelarts", - "code":"45", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Labeling Task Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Labeling Task Management", - "githuburl":"" - }, { "uri":"ListWorkforceTasks.html", - "node_id":"listworkforcetasks.xml", + "node_id":"en-us_topic_0000001943967361.xml", "product_code":"modelarts", - "code":"46", - "des":"This API is used to query the team labeling task list of a dataset.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasksNoneStatus code: 200Querying the Team Labelin", + "code":"38", + "des":"This API is used to query the team labeling task list of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API", "doc_type":"api", - "kw":"Querying the Team Labeling Task List of a Dataset,Labeling Task Management,API Reference", + "kw":"Querying the Team Labeling Task List of a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Team Labeling Task List of a Dataset", @@ -878,18 +764,19 @@ }, { "uri":"CreateWorkforceTask.html", - "node_id":"createworkforcetask.xml", + "node_id":"en-us_topic_0000001910007860.xml", "product_code":"modelarts", - "code":"47", - "des":"This API is used to create a team labeling task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasksStatus code: 200Creating a Team Labeling TaskStatus code: 200OK", + "code":"39", + "des":"This API is used to create a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/", "doc_type":"api", - "kw":"Creating a Team Labeling Task,Labeling Task Management,API Reference", + "kw":"Creating a Team Labeling Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Team Labeling Task", @@ -897,18 +784,19 @@ }, { "uri":"DescWorkforceTask.html", - "node_id":"descworkforcetask.xml", + "node_id":"en-us_topic_0000001910007908.xml", "product_code":"modelarts", - "code":"48", - "des":"This API is used to query the details about a team labeling task.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneStatus code: 200Queryin", + "code":"40", + "des":"This API is used to query the details about a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "doc_type":"api", - "kw":"Querying Details About a Team Labeling Task,Labeling Task Management,API Reference", + "kw":"Querying Details About a Team Labeling Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Team Labeling Task", @@ -916,18 +804,19 @@ }, { "uri":"StartWorkforceTask.html", - "node_id":"startworkforcetask.xml", + "node_id":"en-us_topic_0000001910008080.xml", "product_code":"modelarts", - "code":"49", - "des":"This API is used to start a team labeling task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneStarting a Team Labeling TaskStatus code", + "code":"41", + "des":"This API is used to start a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{", "doc_type":"api", - "kw":"Starting a Team Labeling Task,Labeling Task Management,API Reference", + "kw":"Starting a Team Labeling Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Starting a Team Labeling Task", @@ -935,18 +824,19 @@ }, { "uri":"UpdateWorkforceTask.html", - "node_id":"updateworkforcetask.xml", + "node_id":"en-us_topic_0000001909848012.xml", "product_code":"modelarts", - "code":"50", - "des":"This API is used to update a team labeling task.PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneUpdating a Team Labeling TaskStatus code", + "code":"42", + "des":"This API is used to update a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{", "doc_type":"api", - "kw":"Updating a Team Labeling Task,Labeling Task Management,API Reference", + "kw":"Updating a Team Labeling Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Team Labeling Task", @@ -954,18 +844,19 @@ }, { "uri":"DeleteWorkforceTask.html", - "node_id":"deleteworkforcetask.xml", + "node_id":"en-us_topic_0000001943967045.xml", "product_code":"modelarts", - "code":"51", - "des":"This API is used to delete a team labeling task.DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneNoneDeleting a Team Labeling TaskStat", + "code":"43", + "des":"This API is used to delete a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v", "doc_type":"api", - "kw":"Deleting a Team Labeling Task,Labeling Task Management,API Reference", + "kw":"Deleting a Team Labeling Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Team Labeling Task", @@ -973,18 +864,19 @@ }, { "uri":"StartWorkforceSamplingTask.html", - "node_id":"startworkforcesamplingtask.xml", + "node_id":"en-us_topic_0000001943967069.xml", "product_code":"modelarts", - "code":"52", - "des":"This API is used to create a team labeling acceptance task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptanceStatus code: 200Creat", + "code":"44", + "des":"This API is used to create a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explore", "doc_type":"api", - "kw":"Creating a Team Labeling Acceptance Task,Labeling Task Management,API Reference", + "kw":"Creating a Team Labeling Acceptance Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Team Labeling Acceptance Task", @@ -992,18 +884,19 @@ }, { "uri":"GetWorkforceSamplingTask.html", - "node_id":"getworkforcesamplingtask.xml", + "node_id":"en-us_topic_0000001910007972.xml", "product_code":"modelarts", - "code":"53", - "des":"This API is used to query the report of a team labeling acceptance task.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/reportNo", + "code":"45", + "des":"This API is used to query the report of a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b", "doc_type":"api", - "kw":"Querying the Report of a Team Labeling Acceptance Task,Labeling Task Management,API Reference", + "kw":"Querying the Report of a Team Labeling Acceptance Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Report of a Team Labeling Acceptance Task", @@ -1011,75 +904,99 @@ }, { "uri":"UpdateWorkforceSamplingTask.html", - "node_id":"updateworkforcesamplingtask.xml", + "node_id":"en-us_topic_0000001910008196.xml", "product_code":"modelarts", - "code":"54", + "code":"46", "des":"This API is used to update the sample status by confirming the acceptance scope and whether the labeled data is overwritten before the acceptance of the team labeling tas", "doc_type":"api", - "kw":"Updating the Status of a Team Labeling Acceptance Task,Labeling Task Management,API Reference", + "kw":"Updating the Status of a Team Labeling Acceptance Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating the Status of a Team Labeling Acceptance Task", "githuburl":"" }, { - "uri":"ListWorkerTasks.html", - "node_id":"listworkertasks.xml", + "uri":"ListWorkforceTaskStats.html", + "node_id":"en-us_topic_0000001943967093.xml", "product_code":"modelarts", - "code":"55", - "des":"This API is used to query the team labeling task list by a team member.GET /v2/{project_id}/workforces/worker-tasksNoneStatus code: 200Querying the Team Labeling Task Lis", + "code":"47", + "des":"This API is used to query details about team labeling task statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by ", "doc_type":"api", - "kw":"Querying the Team Labeling Task List by a Team Member,Labeling Task Management,API Reference", + "kw":"Querying Details About Team Labeling Task Statistics,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying Details About Team Labeling Task Statistics", + "githuburl":"" + }, + { + "uri":"GetWorkforceTaskMetrics.html", + "node_id":"en-us_topic_0000001909847940.xml", + "product_code":"modelarts", + "code":"48", + "des":"This API is used to query details about the progress of a team labeling task member.You can debug this API through automatic authentication in or use the SDK sample code", + "doc_type":"api", + "kw":"Querying Details About the Progress of a Team Labeling Task Member,Data Management,03 ModelArts API ", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying Details About the Progress of a Team Labeling Task Member", + "githuburl":"" + }, + { + "uri":"ListWorkerTasks.html", + "node_id":"en-us_topic_0000001909848088.xml", + "product_code":"modelarts", + "code":"49", + "des":"This API is used to query the team labeling task list by a team member.You can debug this API through automatic authentication in or use the SDK sample code generated by", + "doc_type":"api", + "kw":"Querying the Team Labeling Task List by a Team Member,Data Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Team Labeling Task List by a Team Member", "githuburl":"" }, - { - "uri":"workforce_process_management.html", - "node_id":"workforce_process_management.xml", - "product_code":"modelarts", - "code":"56", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Team Labeling Process Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Team Labeling Process Management", - "githuburl":"" - }, { "uri":"AcceptSamples.html", - "node_id":"acceptsamples.xml", + "node_id":"en-us_topic_0000001943967057.xml", "product_code":"modelarts", - "code":"57", - "des":"This API is used to submit sample review comments of an acceptance task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-c", + "code":"50", + "des":"This API is used to submit sample review comments of an acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b", "doc_type":"api", - "kw":"Submitting Sample Review Comments of an Acceptance Task,Team Labeling Process Management,API Referen", + "kw":"Submitting Sample Review Comments of an Acceptance Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Submitting Sample Review Comments of an Acceptance Task", @@ -1087,18 +1004,19 @@ }, { "uri":"ReviewSamples.html", - "node_id":"reviewsamples.xml", + "node_id":"en-us_topic_0000001910007864.xml", "product_code":"modelarts", - "code":"58", - "des":"This API is used to review team labeling results.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/reviewNoneReviewing Team", + "code":"51", + "des":"This API is used to review team labeling results.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2", "doc_type":"api", - "kw":"Reviewing Team Labeling Results,Team Labeling Process Management,API Reference", + "kw":"Reviewing Team Labeling Results,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Reviewing Team Labeling Results", @@ -1106,56 +1024,39 @@ }, { "uri":"UpdateWorkforceTaskSamples.html", - "node_id":"updateworkforcetasksamples.xml", + "node_id":"en-us_topic_0000001910007888.xml", "product_code":"modelarts", - "code":"59", - "des":"This API is used to update labels of team labeling samples in batches.PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samp", + "code":"52", + "des":"This API is used to update labels of team labeling samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by ", "doc_type":"api", - "kw":"Updating Labels of Team Labeling Samples in Batches,Team Labeling Process Management,API Reference", + "kw":"Updating Labels of Team Labeling Samples in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating Labels of Team Labeling Samples in Batches", "githuburl":"" }, - { - "uri":"workforce_management.html", - "node_id":"workforce_management.xml", - "product_code":"modelarts", - "code":"60", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Labeling Team Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Labeling Team Management", - "githuburl":"" - }, { "uri":"ListWorkforces.html", - "node_id":"listworkforces.xml", + "node_id":"en-us_topic_0000001910008028.xml", "product_code":"modelarts", - "code":"61", - "des":"This API is used to query the labeling team list.GET /v2/{project_id}/workforcesNoneStatus code: 200Querying the Labeling Team ListStatus code: 200OKSee Error Codes.", + "code":"53", + "des":"This API is used to query the labeling team list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/", "doc_type":"api", - "kw":"Querying the Labeling Team List,Labeling Team Management,API Reference", + "kw":"Querying the Labeling Team List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Labeling Team List", @@ -1163,18 +1064,19 @@ }, { "uri":"CreateWorkforce.html", - "node_id":"createworkforce.xml", + "node_id":"en-us_topic_0000001909847976.xml", "product_code":"modelarts", - "code":"62", - "des":"This API is used to create a labeling team.POST /v2/{project_id}/workforcesStatus code: 201Creating a Labeling TeamStatus code: 201CreatedSee Error Codes.", + "code":"54", + "des":"This API is used to create a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "doc_type":"api", - "kw":"Creating a Labeling Team,Labeling Team Management,API Reference", + "kw":"Creating a Labeling Team,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Labeling Team", @@ -1182,18 +1084,19 @@ }, { "uri":"DescWorkforce.html", - "node_id":"descworkforce.xml", + "node_id":"en-us_topic_0000001909847968.xml", "product_code":"modelarts", - "code":"63", - "des":"This API is used to query the details about a labeling team.GET /v2/{project_id}/workforces/{workforce_id}NoneStatus code: 200Querying Details About a Labeling TeamStatus", + "code":"55", + "des":"This API is used to query the details about a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "doc_type":"api", - "kw":"Querying Details About a Labeling Team,Labeling Team Management,API Reference", + "kw":"Querying Details About a Labeling Team,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Labeling Team", @@ -1201,18 +1104,19 @@ }, { "uri":"UpdateWorkforce.html", - "node_id":"updateworkforce.xml", + "node_id":"en-us_topic_0000001909847964.xml", "product_code":"modelarts", - "code":"64", - "des":"This API is used to update a labeling team.PUT /v2/{project_id}/workforces/{workforce_id}NoneUpdating a Labeling TeamStatus code: 200OKSee Error Codes.", + "code":"56", + "des":"This API is used to update a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{proje", "doc_type":"api", - "kw":"Updating a Labeling Team,Labeling Team Management,API Reference", + "kw":"Updating a Labeling Team,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Labeling Team", @@ -1220,56 +1124,39 @@ }, { "uri":"DeleteWorkforce.html", - "node_id":"deleteworkforce.xml", + "node_id":"en-us_topic_0000001909848184.xml", "product_code":"modelarts", - "code":"65", - "des":"This API is used to delete a labeling team.DELETE /v2/{project_id}/workforces/{workforce_id}NoneStatus code: 204Deleting a Labeling TeamStatus code: 204No ContentSee Erro", + "code":"57", + "des":"This API is used to delete a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{pr", "doc_type":"api", - "kw":"Deleting a Labeling Team,Labeling Team Management,API Reference", + "kw":"Deleting a Labeling Team,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Labeling Team", "githuburl":"" }, - { - "uri":"workforce_worker_management.html", - "node_id":"workforce_worker_management.xml", - "product_code":"modelarts", - "code":"66", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Labeling Team Member Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Labeling Team Member Management", - "githuburl":"" - }, { "uri":"SendEmails.html", - "node_id":"sendemails.xml", + "node_id":"en-us_topic_0000001909847932.xml", "product_code":"modelarts", - "code":"67", - "des":"This API is used to send an email to a labeling team member.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/notifyStatus code: 200Sending ", + "code":"58", + "des":"This API is used to send an email to a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "doc_type":"api", - "kw":"Sending an Email to a Labeling Team Member,Labeling Team Member Management,API Reference", + "kw":"Sending an Email to a Labeling Team Member,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Sending an Email to a Labeling Team Member", @@ -1277,18 +1164,19 @@ }, { "uri":"ListAllWorkers.html", - "node_id":"listallworkers.xml", + "node_id":"en-us_topic_0000001943967149.xml", "product_code":"modelarts", - "code":"68", - "des":"This API is used to query the list of all labeling team members.GET /v2/{project_id}/workforces/workersNoneStatus code: 200Querying All Labeling Team AdministratorsStatus", + "code":"59", + "des":"This API is used to query the list of all labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex", "doc_type":"api", - "kw":"Querying the List of All Labeling Team Members,Labeling Team Member Management,API Reference", + "kw":"Querying the List of All Labeling Team Members,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the List of All Labeling Team Members", @@ -1296,18 +1184,19 @@ }, { "uri":"ListWorkers.html", - "node_id":"listworkers.xml", + "node_id":"en-us_topic_0000001910007980.xml", "product_code":"modelarts", - "code":"69", - "des":"This API is used to query the list of labeling team members.GET /v2/{project_id}/workforces/{workforce_id}/workersNoneStatus code: 200Querying the List of Labeling Team M", + "code":"60", + "des":"This API is used to query the list of labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "doc_type":"api", - "kw":"Querying the List of Labeling Team Members,Labeling Team Member Management,API Reference", + "kw":"Querying the List of Labeling Team Members,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the List of Labeling Team Members", @@ -1315,37 +1204,39 @@ }, { "uri":"CreateWorker.html", - "node_id":"createworker.xml", + "node_id":"en-us_topic_0000001909848152.xml", "product_code":"modelarts", - "code":"70", - "des":"This API is used to create a labeling team member.POST /v2/{project_id}/workforces/{workforce_id}/workersNoneCreating a Labeling Team MemberStatus code: 201CreatedSee Err", + "code":"61", + "des":"This API is used to create a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v", "doc_type":"api", - "kw":"Creating a Labeling Team Member,Labeling Team Member Management,API Reference", + "kw":"Creating a Labeling Team Member,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Labeling Team Member", "githuburl":"" }, { - "uri":"DeleteWorkers.html", - "node_id":"deleteworkers.xml", + "uri":"BatchDeleteWorkers.html", + "node_id":"en-us_topic_0000001909847956.xml", "product_code":"modelarts", - "code":"71", - "des":"This API is used to delete labeling team members in batches.POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-deleteStatus code: 200Deleting Labeling Team Mem", + "code":"62", + "des":"This API is used to delete labeling team members in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "doc_type":"api", - "kw":"Deleting Labeling Team Members in Batches,Labeling Team Member Management,API Reference", + "kw":"Deleting Labeling Team Members in Batches,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting Labeling Team Members in Batches", @@ -1353,18 +1244,19 @@ }, { "uri":"DescWorker.html", - "node_id":"descworker.xml", + "node_id":"en-us_topic_0000001909847944.xml", "product_code":"modelarts", - "code":"72", - "des":"This API is used to query details about labeling team members.GET /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneStatus code: 200Querying Details About", + "code":"63", + "des":"This API is used to query details about labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "doc_type":"api", - "kw":"Querying Details About Labeling Team Members,Labeling Team Member Management,API Reference", + "kw":"Querying Details About Labeling Team Members,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About Labeling Team Members", @@ -1372,18 +1264,19 @@ }, { "uri":"UpdateWorker.html", - "node_id":"updateworker.xml", + "node_id":"en-us_topic_0000001943967121.xml", "product_code":"modelarts", - "code":"73", - "des":"This API is used to update a labeling team member.PUT /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneUpdating a Labeling Team MemberStatus code: 200OKS", + "code":"64", + "des":"This API is used to update a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2", "doc_type":"api", - "kw":"Updating a Labeling Team Member,Labeling Team Member Management,API Reference", + "kw":"Updating a Labeling Team Member,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Labeling Team Member", @@ -1391,56 +1284,39 @@ }, { "uri":"DeleteWorker.html", - "node_id":"deleteworker.xml", + "node_id":"en-us_topic_0000001943967357.xml", "product_code":"modelarts", - "code":"74", - "des":"This API is used to delete a labeling team member.DELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneNoneDeleting a Labeling Team MemberStatus code:", + "code":"65", + "des":"This API is used to delete a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE ", "doc_type":"api", - "kw":"Deleting a Labeling Team Member,Labeling Team Member Management,API Reference", + "kw":"Deleting a Labeling Team Member,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Labeling Team Member", "githuburl":"" }, - { - "uri":"data_import.html", - "node_id":"data_import.xml", - "product_code":"modelarts", - "code":"75", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Data Import Task", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Data Import Task", - "githuburl":"" - }, { "uri":"ListImportTasks.html", - "node_id":"listimporttasks.xml", + "node_id":"en-us_topic_0000001909847904.xml", "product_code":"modelarts", - "code":"76", - "des":"This API is used to query the dataset import task list by page.GET /v2/{project_id}/datasets/{dataset_id}/import-tasksNoneStatus code: 200Obtaining the Dataset Import Tas", + "code":"66", + "des":"This API is used to query the dataset import task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "doc_type":"api", - "kw":"Querying the Dataset Import Task List,Data Import Task,API Reference", + "kw":"Querying the Dataset Import Task List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Dataset Import Task List", @@ -1448,18 +1324,19 @@ }, { "uri":"ImportTask.html", - "node_id":"importtask.xml", + "node_id":"en-us_topic_0000001910007896.xml", "product_code":"modelarts", - "code":"77", - "des":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/import-ta", + "code":"67", + "des":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.You can debug this API through automatic authenticati", "doc_type":"api", - "kw":"Creating an Import Task,Data Import Task,API Reference", + "kw":"Creating an Import Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating an Import Task", @@ -1467,56 +1344,39 @@ }, { "uri":"DescImportTask.html", - "node_id":"descimporttask.xml", + "node_id":"en-us_topic_0000001909847908.xml", "product_code":"modelarts", - "code":"78", - "des":"This API is used to query details about a dataset import task.GET /v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id}NoneStatus code: 200Querying Details About ", + "code":"68", + "des":"This API is used to query details about a dataset import task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "doc_type":"api", - "kw":"Querying Details About a Dataset Import Task,Data Import Task,API Reference", + "kw":"Querying Details About a Dataset Import Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Dataset Import Task", "githuburl":"" }, - { - "uri":"data_export.html", - "node_id":"data_export.xml", - "product_code":"modelarts", - "code":"79", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Data Export Task", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Data Export Task", - "githuburl":"" - }, { "uri":"GetExportTasksStatusOfDataset.html", - "node_id":"getexporttasksstatusofdataset.xml", + "node_id":"en-us_topic_0000001910008176.xml", "product_code":"modelarts", - "code":"80", - "des":"This API is used to query the dataset export task list by page.GET /v2/{project_id}/datasets/{dataset_id}/export-tasksNoneStatus code: 200Querying the Export Task List by", + "code":"69", + "des":"This API is used to query the dataset export task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "doc_type":"api", - "kw":"Querying the Dataset Export Task List,Data Export Task,API Reference", + "kw":"Querying the Dataset Export Task List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Dataset Export Task List", @@ -1524,18 +1384,19 @@ }, { "uri":"ExportTask.html", - "node_id":"exporttask.xml", + "node_id":"en-us_topic_0000001909847884.xml", "product_code":"modelarts", - "code":"81", - "des":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.POST /v2/{project_id}/datasets/{dataset_id}/export-tasksStatus code: 200Creati", + "code":"70", + "des":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.You can debug this API through automatic authentication in or use the SDK sam", "doc_type":"api", - "kw":"Creating a Dataset Export Task,Data Export Task,API Reference", + "kw":"Creating a Dataset Export Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Dataset Export Task", @@ -1543,56 +1404,39 @@ }, { "uri":"GetExportTaskStatusOfDataset.html", - "node_id":"getexporttaskstatusofdataset.xml", + "node_id":"en-us_topic_0000001909848004.xml", "product_code":"modelarts", - "code":"82", - "des":"This API is used to query the status of a dataset export task.GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id}NoneStatus code: 200Querying the Status of", + "code":"71", + "des":"This API is used to query the status of a dataset export task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "doc_type":"api", - "kw":"Querying the Status of a Dataset Export Task,Data Export Task,API Reference", + "kw":"Querying the Status of a Dataset Export Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Status of a Dataset Export Task", "githuburl":"" }, - { - "uri":"data_sync.html", - "node_id":"data_sync.xml", - "product_code":"modelarts", - "code":"83", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Data Synchronization Task", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Data Synchronization Task", - "githuburl":"" - }, { "uri":"SyncDataSource.html", - "node_id":"syncdatasource.xml", + "node_id":"en-us_topic_0000001943967037.xml", "product_code":"modelarts", - "code":"84", - "des":"This API is used to synchronize samples and labeling information from the input dataset path to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/sync-dataNoneNoneS", + "code":"72", + "des":"This API is used to synchronize samples and labeling information from the input dataset path to the dataset.You can debug this API through automatic authentication in or", "doc_type":"api", - "kw":"Synchronizing a Dataset,Data Synchronization Task,API Reference", + "kw":"Synchronizing a Dataset,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Synchronizing a Dataset", @@ -1600,56 +1444,39 @@ }, { "uri":"SyncDataSourceState.html", - "node_id":"syncdatasourcestate.xml", + "node_id":"en-us_topic_0000001910008192.xml", "product_code":"modelarts", - "code":"85", - "des":"This API is used to query the status of a dataset synchronization task.GET /v2/{project_id}/datasets/{dataset_id}/sync-data/statusNoneStatus code: 200Obtaining the Status", + "code":"73", + "des":"This API is used to query the status of a dataset synchronization task.You can debug this API through automatic authentication in or use the SDK sample code generated by", "doc_type":"api", - "kw":"Querying the Status of a Dataset Synchronization Task,Data Synchronization Task,API Reference", + "kw":"Querying the Status of a Dataset Synchronization Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Status of a Dataset Synchronization Task", "githuburl":"" }, - { - "uri":"auto_task.html", - "node_id":"auto_task.xml", - "product_code":"modelarts", - "code":"86", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Intelligent Task", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Intelligent Task", - "githuburl":"" - }, { "uri":"ListAutoAnnotationSamples.html", - "node_id":"listautoannotationsamples.xml", + "node_id":"en-us_topic_0000001909847952.xml", "product_code":"modelarts", - "code":"87", - "des":"This API is used to query auto labeling samples in a dataset.GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samplesNoneStatus code: 200Querying Auto Labeling", + "code":"74", + "des":"This API is used to query auto labeling samples in a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explo", "doc_type":"api", - "kw":"Querying Auto Labeling Sample List,Intelligent Task,API Reference", + "kw":"Querying Auto Labeling Sample List,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Auto Labeling Sample List", @@ -1657,18 +1484,19 @@ }, { "uri":"DescribeAutoAnnotationSample.html", - "node_id":"describeautoannotationsample.xml", + "node_id":"en-us_topic_0000001910007940.xml", "product_code":"modelarts", - "code":"88", - "des":"This API is used to query details about an auto labeling sample.GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id}NoneStatus code: 200Queryin", + "code":"75", + "des":"This API is used to query details about an auto labeling sample.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex", "doc_type":"api", - "kw":"Querying Details About an Auto Labeling Sample,Intelligent Task,API Reference", + "kw":"Querying Details About an Auto Labeling Sample,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About an Auto Labeling Sample", @@ -1676,18 +1504,19 @@ }, { "uri":"ListTasks.html", - "node_id":"listtasks.xml", + "node_id":"en-us_topic_0000001909847960.xml", "product_code":"modelarts", - "code":"89", - "des":"This API is used to query the intelligent task list by page, including auto labeling and auto grouping tasks. You can specify the type parameter to query the list of a sp", + "code":"76", + "des":"This interface is used to query the intelligent task list by page, including intelligent labeling and automatic grouping tasks. You can specify the type parameter to quer", "doc_type":"api", - "kw":"Querying the Intelligent Task List by Page,Intelligent Task,API Reference", + "kw":"Querying the Intelligent Task List by Page,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Intelligent Task List by Page", @@ -1695,18 +1524,19 @@ }, { "uri":"CreateTask.html", - "node_id":"createtask.xml", + "node_id":"en-us_topic_0000001909848204.xml", "product_code":"modelarts", - "code":"90", - "des":"This API is used to start an intelligent task, which can be an auto labeling task or an auto grouping task. You can specify task_type in the request body to start a type ", + "code":"77", + "des":"This interface is used to start an intelligent task. Two types of intelligent tasks are supported: intelligent labeling and automatic grouping. You can specify the task_t", "doc_type":"api", - "kw":"Starting Intelligent Tasks,Intelligent Task,API Reference", + "kw":"Starting Intelligent Tasks,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Starting Intelligent Tasks", @@ -1714,18 +1544,19 @@ }, { "uri":"AutoAnnotationProgress.html", - "node_id":"autoannotationprogress.xml", + "node_id":"en-us_topic_0000001910007928.xml", "product_code":"modelarts", - "code":"91", - "des":"This API is used to obtain information about intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the task_id ", + "code":"78", + "des":"This interface is used to obtain details about intelligent tasks. Intelligent labeling and automatic grouping tasks can be queried. You can specify the task_id parameter ", "doc_type":"api", - "kw":"Obtaining Information About Intelligent Tasks,Intelligent Task,API Reference", + "kw":"Obtaining Information About Intelligent Tasks,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining Information About Intelligent Tasks", @@ -1733,56 +1564,39 @@ }, { "uri":"StopAutoAnnotation.html", - "node_id":"stopautoannotation.xml", + "node_id":"en-us_topic_0000001910008040.xml", "product_code":"modelarts", - "code":"92", - "des":"This API is used to stop intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the task_id parameter to stop a ", + "code":"79", + "des":"This interface is used to stop an intelligent task. Intelligent labeling and automatic grouping tasks can be stopped. You can specify the task_id parameter to stop a spec", "doc_type":"api", - "kw":"Stopping an Intelligent Task,Intelligent Task,API Reference", + "kw":"Stopping an Intelligent Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Stopping an Intelligent Task", "githuburl":"" }, - { - "uri":"process_task.html", - "node_id":"process_task.xml", - "product_code":"modelarts", - "code":"93", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Processing Task", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Processing Task", - "githuburl":"" - }, { "uri":"ListProcessorTasks.html", - "node_id":"listprocessortasks.xml", + "node_id":"en-us_topic_0000001909847912.xml", "product_code":"modelarts", - "code":"94", - "des":"This API is used to query the list of a processing task. You can specify the task_type parameter to query the list of a specific type of tasks.- Data processing refers to", + "code":"80", + "des":"This API is used to obtain processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_type parameter to obtain a specific type", "doc_type":"api", - "kw":"Querying the List of a Processing Task,Processing Task,API Reference", + "kw":"Querying the List of a Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the List of a Processing Task", @@ -1790,18 +1604,19 @@ }, { "uri":"CreateProcessorTask.html", - "node_id":"createprocessortask.xml", + "node_id":"en-us_topic_0000001909848020.xml", "product_code":"modelarts", - "code":"95", - "des":"This API is used to create a processing task. You can create data processing tasks. You can specify the id field of template composite parameter in the request body to cr", + "code":"81", + "des":"This API is used to create a processing task, including feature analysis tasks and data processing tasks. You can specify the id field of template composite parameter in ", "doc_type":"api", - "kw":"Creating a Processing Task,Processing Task,API Reference", + "kw":"Creating a Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Processing Task", @@ -1809,18 +1624,19 @@ }, { "uri":"GetProcessorTaskItems.html", - "node_id":"getprocessortaskitems.xml", + "node_id":"en-us_topic_0000001910007880.xml", "product_code":"modelarts", - "code":"96", - "des":"This API is used to query the algorithm type for data processing.GET /v2/{project_id}/processor-tasks/itemsNoneStatus code: 200Querying the List of the Algorithm Type for", + "code":"82", + "des":"This API is used to query the algorithm type for data processing.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "doc_type":"api", - "kw":"Querying the Algorithm Type for Data Processing,Processing Task,API Reference", + "kw":"Querying the Algorithm Type for Data Processing,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Algorithm Type for Data Processing", @@ -1828,18 +1644,19 @@ }, { "uri":"DescribeProcessorTask.html", - "node_id":"describeprocessortask.xml", + "node_id":"en-us_topic_0000001909847868.xml", "product_code":"modelarts", - "code":"97", - "des":"This API is used to query the details about processing tasks. You can query feature analysis tasks and data processing tasks. You can specify the task_id parameter to que", + "code":"83", + "des":"This API is used to obtain details about processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_id parameter to obtain the", "doc_type":"api", - "kw":"Querying Details About a Processing Task,Processing Task,API Reference", + "kw":"Querying Details About a Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details About a Processing Task", @@ -1847,18 +1664,19 @@ }, { "uri":"UpdateProcessorTask.html", - "node_id":"updateprocessortask.xml", + "node_id":"en-us_topic_0000001943967337.xml", "product_code":"modelarts", - "code":"98", - "des":"This API is used to update a processing task. You can update feature analysis tasks and data processing tasks. Only the description of updated tasks is supported. You can", + "code":"84", + "des":"This API is used to update a processing task, including feature analysis tasks and data processing tasks. Only the description of tasks can be updated. You can specify th", "doc_type":"api", - "kw":"Updating a Processing Task,Processing Task,API Reference", + "kw":"Updating a Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Processing Task", @@ -1866,18 +1684,19 @@ }, { "uri":"DeleteProcessorTask.html", - "node_id":"deleteprocessortask.xml", + "node_id":"en-us_topic_0000001909848032.xml", "product_code":"modelarts", - "code":"99", - "des":"This API is used to delete a processing task. You can delete feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id pa", + "code":"85", + "des":"This API is used to delete a processing task, including feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id paramet", "doc_type":"api", - "kw":"Deleting a Processing Task,Processing Task,API Reference", + "kw":"Deleting a Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Processing Task", @@ -1885,18 +1704,19 @@ }, { "uri":"ListProcessorTaskVersions.html", - "node_id":"listprocessortaskversions.xml", + "node_id":"en-us_topic_0000001943967157.xml", "product_code":"modelarts", - "code":"100", - "des":"This API is used to query the version list of a data processing task.GET /v2/{project_id}/processor-tasks/{task_id}/versionsNoneStatus code: 200Querying the Version List ", + "code":"86", + "des":"This API is used to query the version list of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by A", "doc_type":"api", - "kw":"Querying the Version List of a Data Processing Task,Processing Task,API Reference", + "kw":"Querying the Version List of a Data Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Version List of a Data Processing Task", @@ -1904,18 +1724,19 @@ }, { "uri":"CreateProcessorTaskVersion.html", - "node_id":"createprocessortaskversion.xml", + "node_id":"en-us_topic_0000001943967261.xml", "product_code":"modelarts", - "code":"101", - "des":"This API is used to create a data processing task version.POST /v2/{project_id}/processor-tasks/{task_id}/versionsStatus code: 200Creating a Data Validation Task VersionS", + "code":"87", + "des":"This API is used to create a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", "doc_type":"api", - "kw":"Creating a Data Processing Task Version,Processing Task,API Reference", + "kw":"Creating a Data Processing Task Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Data Processing Task Version", @@ -1923,18 +1744,19 @@ }, { "uri":"DescProcessorTaskVersion.html", - "node_id":"descprocessortaskversion.xml", + "node_id":"en-us_topic_0000001943967145.xml", "product_code":"modelarts", - "code":"102", - "des":"This API is used to query the details about the version of a data processing task.GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}NoneStatus code: 200", + "code":"88", + "des":"This API is used to query the details about the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code g", "doc_type":"api", - "kw":"Querying the Details About the Version of a Data Processing Task,Processing Task,API Reference", + "kw":"Querying the Details About the Version of a Data Processing Task,Data Management,03 ModelArts API Re", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Details About the Version of a Data Processing Task", @@ -1942,18 +1764,19 @@ }, { "uri":"DeleteProcessorTaskVersion.html", - "node_id":"deleteprocessortaskversion.xml", + "node_id":"en-us_topic_0000001910008064.xml", "product_code":"modelarts", - "code":"103", - "des":"This API is used to delete a data processing task version.DELETE /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}NoneNoneDeleting a Data Processing Task V", + "code":"89", + "des":"This API is used to delete a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", "doc_type":"api", - "kw":"Deleting a Data Processing Task Version,Processing Task,API Reference", + "kw":"Deleting a Data Processing Task Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Data Processing Task Version", @@ -1961,18 +1784,19 @@ }, { "uri":"ListProcessorTaskVersionResults.html", - "node_id":"listprocessortaskversionresults.xml", + "node_id":"en-us_topic_0000001943967109.xml", "product_code":"modelarts", - "code":"104", - "des":"This API is used to query the result of a data processing task version.GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/resultsNoneStatus code: 200Que", + "code":"90", + "des":"This API is used to query the result of a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by", "doc_type":"api", - "kw":"Querying the Result of a Data Processing Task Version,Processing Task,API Reference", + "kw":"Querying the Result of a Data Processing Task Version,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Result of a Data Processing Task Version", @@ -1980,28 +1804,29 @@ }, { "uri":"StopProcessorTaskVersion.html", - "node_id":"stopprocessortaskversion.xml", + "node_id":"en-us_topic_0000001910007916.xml", "product_code":"modelarts", - "code":"105", - "des":"This API is used to stop the version of a data processing task.POST /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/stopNoneNoneThis API is used to stop ", + "code":"91", + "des":"This API is used to stop the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "doc_type":"api", - "kw":"Stopping the Version of a Data Processing Task,Processing Task,API Reference", + "kw":"Stopping the Version of a Data Processing Task,Data Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Stopping the Version of a Data Processing Task", "githuburl":"" }, { - "uri":"modelarts_03_0107.html", - "node_id":"modelarts_03_0107.xml", + "uri":"notebook.html", + "node_id":"en-us_topic_0000001909848176.xml", "product_code":"modelarts", - "code":"106", + "code":"92", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DevEnviron (New Version)", @@ -2009,65 +1834,29 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"DevEnviron (New Version)", "githuburl":"" }, - { - "uri":"notebook.html", - "node_id":"notebook.xml", - "product_code":"modelarts", - "code":"107", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"DevEnviron Instance Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"DevEnviron Instance Management", - "githuburl":"" - }, - { - "uri":"ListImage.html", - "node_id":"listimage.xml", - "product_code":"modelarts", - "code":"108", - "des":"This API is used to query all images by page based on specified conditions.NoneGET /v1/{project_id}/imagesNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", - "doc_type":"api", - "kw":"Querying Supported Images,DevEnviron Instance Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Supported Images", - "githuburl":"" - }, { "uri":"ListNotebooks.html", - "node_id":"listnotebooks.xml", + "node_id":"en-us_topic_0000001910008160.xml", "product_code":"modelarts", - "code":"109", - "des":"This API is used to query notebook instances based on specified search criteria.NoneGET /v1/{project_id}/notebooksNoneStatus code: 200NoneStatus code: 200OKSee Error Code", + "code":"93", + "des":"This API is used to query notebook instances based on specified search criteria.NoneYou can debug this API through automatic authentication in or use the SDK sample code", "doc_type":"api", - "kw":"Querying Notebook Instances,DevEnviron Instance Management,API Reference", + "kw":"Querying Notebook Instances,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Notebook Instances", @@ -2075,56 +1864,39 @@ }, { "uri":"CreateNotebook.html", - "node_id":"createnotebook.xml", + "node_id":"en-us_topic_0000001910008056.xml", "product_code":"modelarts", - "code":"110", - "des":"This API is used to create a notebook instance based on the specified flavor, AI engine images, and storage. You can access the instance through a web page or SSH client.", + "code":"94", + "des":"This API is used to create a notebook instance based on the specified flavor, AI engine image, and storage. You can access the instance through a web page or SSH client. ", "doc_type":"api", - "kw":"Creating a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Creating a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Notebook Instance", "githuburl":"" }, - { - "uri":"RunCodeLab.html", - "node_id":"runcodelab.xml", - "product_code":"modelarts", - "code":"111", - "des":"This API is used to open a free CodeLab instance. After opening it, you can switch to another instance as required.NonePOST /v1/{project_id}/notebooks/openStatus code: 20", - "doc_type":"api", - "kw":"Opening a CodeLab Instance,DevEnviron Instance Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Opening a CodeLab Instance", - "githuburl":"" - }, { "uri":"ShowNotebook.html", - "node_id":"shownotebook.xml", + "node_id":"en-us_topic_0000001943967377.xml", "product_code":"modelarts", - "code":"112", - "des":"This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.NoneGET /v1/{project_id}/notebooks/{id}Non", + "code":"95", + "des":"This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.NoneYou can debug this API through automat", "doc_type":"api", - "kw":"Querying Details of a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Querying Details of a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Details of a Notebook Instance", @@ -2132,18 +1904,19 @@ }, { "uri":"UpdateNotebook.html", - "node_id":"updatenotebook.xml", + "node_id":"en-us_topic_0000001943967141.xml", "product_code":"modelarts", - "code":"113", - "des":"This API is used to update the name, description, flavor, and image ID of a stopped notebook instance.NonePUT /v1/{project_id}/notebooks/{id}Status code: 200Status code: ", + "code":"96", + "des":"This API is used to update the name, description, flavor, and image ID of a stopped notebook instance.NoneYou can debug this API through automatic authentication in or u", "doc_type":"api", - "kw":"Updating a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Updating a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating a Notebook Instance", @@ -2151,37 +1924,79 @@ }, { "uri":"DeleteNotebook.html", - "node_id":"deletenotebook.xml", + "node_id":"en-us_topic_0000001943967129.xml", "product_code":"modelarts", - "code":"114", - "des":"This API is used to delete the container and all storage resources of a notebook instance.NoneDELETE /v1/{project_id}/notebooks/{id}NoneStatus code: 200NoneStatus code: 2", + "code":"97", + "des":"This API is used to delete the container and all storage resources of a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK s", "doc_type":"api", - "kw":"Deleting a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Deleting a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Notebook Instance", "githuburl":"" }, { - "uri":"ShowSwitchableFlavors.html", - "node_id":"showswitchableflavors.xml", + "uri":"CreateImage.html", + "node_id":"en-us_topic_0000001909848168.xml", "product_code":"modelarts", - "code":"115", - "des":"This API is used to query the flavors available for a notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/flavorsNoneStatus code: 200NoneStatus code: 200OKSee Error", + "code":"98", + "des":"Save the running instance as a container image. In the saved image, the installed dependency package (pip package) is not lost. In VS Code remote development, the plug-in", "doc_type":"api", - "kw":"Querying Flavors Available for a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Saving a Running Instance as a Container Image,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Saving a Running Instance as a Container Image", + "githuburl":"" + }, + { + "uri":"ListFlavors.html", + "node_id":"en-us_topic_0000001910007956.xml", + "product_code":"modelarts", + "code":"99", + "des":"Obtain the available flavors.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/not", + "doc_type":"api", + "kw":"Obtaining the Available Flavors,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining the Available Flavors", + "githuburl":"" + }, + { + "uri":"ShowSwitchableFlavors.html", + "node_id":"en-us_topic_0000001943967253.xml", + "product_code":"modelarts", + "code":"100", + "des":"This API is used to query the flavors available for a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generat", + "doc_type":"api", + "kw":"Querying Flavors Available for a Notebook Instance,DevEnviron (New Version),03 ModelArts API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Flavors Available for a Notebook Instance", @@ -2189,18 +2004,19 @@ }, { "uri":"ShowLease.html", - "node_id":"showlease.xml", + "node_id":"en-us_topic_0000001910007884.xml", "product_code":"modelarts", - "code":"116", - "des":"This API is used to query the available duration of a running notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/leaseNoneStatus code: 200NoneStatus code: 200OKSee", + "code":"101", + "des":"This API is used to query the available duration of a running notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code", "doc_type":"api", - "kw":"Querying the Available Duration of a Running Notebook Instance,DevEnviron Instance Management,API Re", + "kw":"Querying the Available Duration of a Running Notebook Instance,DevEnviron (New Version),03 ModelArts", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Available Duration of a Running Notebook Instance", @@ -2208,18 +2024,19 @@ }, { "uri":"RenewLease.html", - "node_id":"renewlease.xml", + "node_id":"en-us_topic_0000001943967137.xml", "product_code":"modelarts", - "code":"117", - "des":"This API is used to prolong a notebook instance.NonePATCH /v1/{project_id}/notebooks/{id}/leaseNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "code":"102", + "des":"This API is used to prolong a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PATCH", "doc_type":"api", - "kw":"Prolonging a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Prolonging a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Prolonging a Notebook Instance", @@ -2227,18 +2044,19 @@ }, { "uri":"StartNotebook.html", - "node_id":"startnotebook.xml", + "node_id":"en-us_topic_0000001909847892.xml", "product_code":"modelarts", - "code":"118", - "des":"This API is used to start a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/startStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "code":"103", + "des":"This API is used to start a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v", "doc_type":"api", - "kw":"Starting a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Starting a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Starting a Notebook Instance", @@ -2246,56 +2064,39 @@ }, { "uri":"StopNotebook.html", - "node_id":"stopnotebook.xml", + "node_id":"en-us_topic_0000001909847924.xml", "product_code":"modelarts", - "code":"119", - "des":"This API is used to stop a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/stopNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "code":"104", + "des":"This API is used to stop a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1", "doc_type":"api", - "kw":"Stopping a Notebook Instance,DevEnviron Instance Management,API Reference", + "kw":"Stopping a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Stopping a Notebook Instance", "githuburl":"" }, { - "uri":"storage.html", - "node_id":"storage.xml", + "uri":"ListAttachableObSs.html", + "node_id":"en-us_topic_0000001909847916.xml", "product_code":"modelarts", - "code":"120", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"105", + "des":"This API is used to obtain the notebook instances with OBS storage mounted.NoneYou can debug this API through automatic authentication in or use the SDK sample code gene", "doc_type":"api", - "kw":"OBS Storage Mounting", + "kw":"Obtaining the Notebook Instances with OBS Storage Mounted,DevEnviron (New Version),03 ModelArts API ", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"OBS Storage Mounting", - "githuburl":"" - }, - { - "uri":"ListDynamicMount.html", - "node_id":"listdynamicmount.xml", - "product_code":"modelarts", - "code":"121", - "des":"This API is used to obtain the notebook instances with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storageNoneStatus code: 200NoneStatus code: 20", - "doc_type":"api", - "kw":"Obtaining the Notebook Instances with OBS Storage Mounted,OBS Storage Mounting,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining the Notebook Instances with OBS Storage Mounted", @@ -2303,18 +2104,19 @@ }, { "uri":"AttachObs.html", - "node_id":"attachobs.xml", + "node_id":"en-us_topic_0000001943967085.xml", "product_code":"modelarts", - "code":"122", - "des":"This API is used to mount OBS storage to a running notebook instance so that the application layer can operate OBS parallel file system in the container.NonePOST /v1/{pro", + "code":"106", + "des":"An OBS parallel file system can be mounted to a specified file directory of a running notebook instance. After the mounting, objects in the OBS parallel file system can b", "doc_type":"api", - "kw":"OBS Storage Mounting,OBS Storage Mounting,API Reference", + "kw":"OBS Storage Mounting,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"OBS Storage Mounting", @@ -2322,18 +2124,19 @@ }, { "uri":"ShowAttachableObs.html", - "node_id":"showattachableobs.xml", + "node_id":"en-us_topic_0000001909847900.xml", "product_code":"modelarts", - "code":"123", - "des":"This API is used to obtain details about a notebook instance with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}NoneStatus code", + "code":"107", + "des":"This API is used to obtain details about a notebook instance with OBS storage mounted.NoneYou can debug this API through automatic authentication in or use the SDK sampl", "doc_type":"api", - "kw":"Obtaining Details About a Notebook Instance with OBS Storage Mounted,OBS Storage Mounting,API Refere", + "kw":"Obtaining Details About a Notebook Instance with OBS Storage Mounted,DevEnviron (New Version),03 Mod", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining Details About a Notebook Instance with OBS Storage Mounted", @@ -2341,28 +2144,129 @@ }, { "uri":"CancelObs.html", - "node_id":"cancelobs.xml", + "node_id":"en-us_topic_0000001910008032.xml", "product_code":"modelarts", - "code":"124", + "code":"108", "des":"This API is used to unmount OBS storage from a notebook instance. After OBS storage is unmounted, OBS objects remain unchanged but cannot be operated in the notebook cont", "doc_type":"api", - "kw":"Unmounting OBS Storage from a Notebook Instance,OBS Storage Mounting,API Reference", + "kw":"Unmounting OBS Storage from a Notebook Instance,DevEnviron (New Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Unmounting OBS Storage from a Notebook Instance", "githuburl":"" }, { - "uri":"modelarts_03_0108.html", - "node_id":"modelarts_03_0108.xml", + "uri":"ListImage.html", + "node_id":"en-us_topic_0000001943967113.xml", "product_code":"modelarts", - "code":"125", + "code":"109", + "des":"This API is used to query all images by page based on specified conditions.NoneYou can debug this API through automatic authentication in or use the SDK sample code gene", + "doc_type":"api", + "kw":"Querying Supported Images,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying Supported Images", + "githuburl":"" + }, + { + "uri":"RegisterImage.html", + "node_id":"en-us_topic_0000001943967089.xml", + "product_code":"modelarts", + "code":"110", + "des":"Register a custom image with ModelArts Image Management.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", + "doc_type":"api", + "kw":"Registering a Custom Image,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Registering a Custom Image", + "githuburl":"" + }, + { + "uri":"ListImageGroup.html", + "node_id":"en-us_topic_0000001910008012.xml", + "product_code":"modelarts", + "code":"111", + "des":"Obtain the overview of user image information. The image name is used as the aggregated information.NoneYou can debug this API through automatic authentication in or use", + "doc_type":"api", + "kw":"Obtaining User Image Groups,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining User Image Groups", + "githuburl":"" + }, + { + "uri":"ShowImage.html", + "node_id":"en-us_topic_0000001909848192.xml", + "product_code":"modelarts", + "code":"112", + "des":"Obtain the details of an image.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/i", + "doc_type":"api", + "kw":"Obtaining Details of an Image,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Details of an Image", + "githuburl":"" + }, + { + "uri":"DeleteImage.html", + "node_id":"en-us_topic_0000001943967373.xml", + "product_code":"modelarts", + "code":"113", + "des":"Delete an image object. For a private image, you can also delete the image content from SWR using parameters.NoneYou can debug this API through automatic authentication i", + "doc_type":"api", + "kw":"Deleting an Image,DevEnviron (New Version),03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Deleting an Image", + "githuburl":"" + }, + { + "uri":"modelarts_03_0108.html", + "node_id":"en-us_topic_0000001910007992.xml", + "product_code":"modelarts", + "code":"114", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DevEnviron (Old Version)", @@ -2370,46 +2274,29 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"DevEnviron (Old Version)", "githuburl":"" }, - { - "uri":"modelarts_03_0109.html", - "node_id":"modelarts_03_0109.xml", - "product_code":"modelarts", - "code":"126", - "des":"This API is used to query the authentication information of a development environment instance, which is used to open the development environment instance.GET /v1/{projec", - "doc_type":"api", - "kw":"Querying the Authentication Information of a Development Environment Instance,DevEnviron (Old Versio", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying the Authentication Information of a Development Environment Instance", - "githuburl":"" - }, { "uri":"modelarts_03_0110.html", - "node_id":"modelarts_03_0110.xml", + "node_id":"en-us_topic_0000001910008100.xml", "product_code":"modelarts", - "code":"127", + "code":"115", "des":"This API is used to create a development environment instance for code development.Calling this API is an asynchronous operation. The job status can be obtained by callin", "doc_type":"api", - "kw":"Creating a Development Environment Instance,DevEnviron (Old Version),API Reference", + "kw":"Creating a Development Environment Instance,DevEnviron (Old Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Development Environment Instance", @@ -2417,56 +2304,59 @@ }, { "uri":"modelarts_03_0111.html", - "node_id":"modelarts_03_0111.xml", + "node_id":"en-us_topic_0000001943967097.xml", "product_code":"modelarts", - "code":"128", - "des":"This API is used to query the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={p", + "code":"116", + "des":"This API is used to obtain the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={", "doc_type":"api", - "kw":"Querying a List of Development Environment Instances,DevEnviron (Old Version),API Reference", + "kw":"Obtaining Development Environment Instances,DevEnviron (Old Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying a List of Development Environment Instances", + "title":"Obtaining Development Environment Instances", "githuburl":"" }, { "uri":"modelarts_03_0112.html", - "node_id":"modelarts_03_0112.xml", + "node_id":"en-us_topic_0000001943967201.xml", "product_code":"modelarts", - "code":"129", - "des":"This API is used to query the details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parame", + "code":"117", + "des":"This API is used to obtain details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameter", "doc_type":"api", - "kw":"Querying Details About a Development Environment Instance,DevEnviron (Old Version),API Reference", + "kw":"Obtaining Details About a Development Environment Instance,DevEnviron (Old Version),03 ModelArts API", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying Details About a Development Environment Instance", + "title":"Obtaining Details About a Development Environment Instance", "githuburl":"" }, { "uri":"modelarts_03_0113.html", - "node_id":"modelarts_03_0113.xml", + "node_id":"en-us_topic_0000001910008168.xml", "product_code":"modelarts", - "code":"130", + "code":"118", "des":"This API is used to modify the description of a development environment instance or information about the auto stop function.PUT /v1/{project_id}/demanager/instances/{ins", "doc_type":"api", - "kw":"Modifying the Description of a Development Environment Instance,DevEnviron (Old Version),API Referen", + "kw":"Modifying the Description of a Development Environment Instance,DevEnviron (Old Version),03 ModelArt", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Modifying the Description of a Development Environment Instance", @@ -2474,18 +2364,19 @@ }, { "uri":"modelarts_03_0114.html", - "node_id":"modelarts_03_0114.xml", + "node_id":"en-us_topic_0000001909848112.xml", "product_code":"modelarts", - "code":"131", + "code":"119", "des":"This API is used to delete a development environment instance.DELETE /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameters.Parameter", "doc_type":"api", - "kw":"Deleting a Development Environment Instance,DevEnviron (Old Version),API Reference", + "kw":"Deleting a Development Environment Instance,DevEnviron (Old Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Development Environment Instance", @@ -2493,75 +2384,59 @@ }, { "uri":"modelarts_03_0115.html", - "node_id":"modelarts_03_0115.xml", + "node_id":"en-us_topic_0000001943967301.xml", "product_code":"modelarts", - "code":"132", + "code":"120", "des":"This API is used to startor stop a notebook instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required parameters.ParametersPar", "doc_type":"api", - "kw":"Managing a Development Environment Instance,DevEnviron (Old Version),API Reference", + "kw":"Managing a Development Environment Instance,DevEnviron (Old Version),03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Managing a Development Environment Instance", "githuburl":"" }, - { - "uri":"modelarts_03_0119.html", - "node_id":"modelarts_03_0119.xml", - "product_code":"modelarts", - "code":"133", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Training Management (New Version)", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Training Management (New Version)", - "githuburl":"" - }, { "uri":"algorithms.html", - "node_id":"algorithms.xml", + "node_id":"en-us_topic_0000001943967133.xml", "product_code":"modelarts", - "code":"134", + "code":"121", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Algorithm Management", + "kw":"Training Management", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Algorithm Management", + "title":"Training Management", "githuburl":"" }, { "uri":"CreateAlgorithm.html", - "node_id":"createalgorithm.xml", + "node_id":"en-us_topic_0000001943967105.xml", "product_code":"modelarts", - "code":"135", - "des":"This API is used to create an algorithm.POST /v2/{project_id}/algorithmsStatus code: 201The following shows how to create an algorithm whose name is TestModelArtsalgorith", + "code":"122", + "des":"This API is used to create an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{project", "doc_type":"api", - "kw":"Creating an Algorithm,Algorithm Management,API Reference", + "kw":"Creating an Algorithm,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating an Algorithm", @@ -2569,18 +2444,19 @@ }, { "uri":"ListAlgorithms.html", - "node_id":"listalgorithms.xml", + "node_id":"en-us_topic_0000001909847984.xml", "product_code":"modelarts", - "code":"136", - "des":"This API is used to query the algorithm list.GET /v2/{project_id}/algorithmsNoneStatus code: 200The following shows how to query all algorithms in jobs whose names contai", + "code":"123", + "des":"This API is used to query the algorithm list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{pro", "doc_type":"api", - "kw":"Querying the Algorithm List,Algorithm Management,API Reference", + "kw":"Querying the Algorithm List,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Algorithm List", @@ -2588,18 +2464,19 @@ }, { "uri":"ShowAlgorithmByUuid.html", - "node_id":"showalgorithmbyuuid.xml", + "node_id":"en-us_topic_0000001909847872.xml", "product_code":"modelarts", - "code":"137", - "des":"This API is used to query a specified algorithm based on the algorithm ID.GET /v2/{project_id}/algorithms/{algorithm_id}NoneStatus code: 200The following shows how to que", + "code":"124", + "des":"This API is used to query a specified algorithm based on the algorithm ID.You can debug this API through automatic authentication in or use the SDK sample code generated", "doc_type":"api", - "kw":"Querying Algorithm Details,Algorithm Management,API Reference", + "kw":"Querying Algorithm Details,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying Algorithm Details", @@ -2607,18 +2484,19 @@ }, { "uri":"ChangeAlgorithm.html", - "node_id":"changealgorithm.xml", + "node_id":"en-us_topic_0000001943967081.xml", "product_code":"modelarts", - "code":"138", - "des":"This API is used to modify an algorithm.PUT /v2/{project_id}/algorithms/{algorithm_id}Status code: 201The following shows how to modify the algorithm whose UUID is 2e5451", + "code":"125", + "des":"This API is used to modify an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{project_", "doc_type":"api", - "kw":"Modifying an Algorithm,Algorithm Management,API Reference", + "kw":"Modifying an Algorithm,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Modifying an Algorithm", @@ -2626,94 +2504,59 @@ }, { "uri":"DeleteAlgorithm.html", - "node_id":"deletealgorithm.xml", + "node_id":"en-us_topic_0000001909848044.xml", "product_code":"modelarts", - "code":"139", - "des":"This API is used to delete an algorithm.DELETE /v2/{project_id}/algorithms/{algorithm_id}NoneNoneThe following shows how to modify the algorithm whose UUID is 2e5451fe-91", + "code":"126", + "des":"This API is used to delete an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{proje", "doc_type":"api", - "kw":"Deleting an Algorithm,Algorithm Management,API Reference", + "kw":"Deleting an Algorithm,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting an Algorithm", "githuburl":"" }, - { - "uri":"ListSearchAlgorithms.html", - "node_id":"listsearchalgorithms.xml", - "product_code":"modelarts", - "code":"140", - "des":"This API is used tp query the hyperparameter search algorithm list.GET /v2/{project_id}/search-algorithmsNoneStatus code: 200The following shows how to query information ", - "doc_type":"api", - "kw":"Querying the Hyperparameter Search Algorithm List,Algorithm Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying the Hyperparameter Search Algorithm List", - "githuburl":"" - }, - { - "uri":"trainingJobs.html", - "node_id":"trainingjobs.xml", - "product_code":"modelarts", - "code":"141", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Training Job Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Training Job Management", - "githuburl":"" - }, { "uri":"CreateTrainingJob.html", - "node_id":"createtrainingjob.xml", + "node_id":"en-us_topic_0000001909847972.xml", "product_code":"modelarts", - "code":"142", - "des":"This API is used to create a training job.POST /v2/{project_id}/training-jobsStatus code: 201The following shows how to create a training job named TestModelArtsJob. The ", + "code":"127", + "des":"This API is used to create a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proje", "doc_type":"api", - "kw":"Creating a Training Job,Training Job Management,API Reference", + "kw":"Creating a Training Job,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a Training Job", "githuburl":"" }, { - "uri":"ShowTrainingJobInfomation.html", - "node_id":"showtrainingjobinfomation.xml", + "uri":"ShowTrainingJobDetails.html", + "node_id":"en-us_topic_0000001943967165.xml", "product_code":"modelarts", - "code":"143", - "des":"This API is used to query the details about a training job.GET /v2/{project_id}/training-jobs/{training_job_id}NoneStatus code: 200The following shows how to query a trai", + "code":"128", + "des":"This API is used to query the details about a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explore", "doc_type":"api", - "kw":"Querying the Details About a Training Job,Training Job Management,API Reference", + "kw":"Querying the Details About a Training Job,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Details About a Training Job", @@ -2721,18 +2564,19 @@ }, { "uri":"ChangeTrainingJobDescription.html", - "node_id":"changetrainingjobdescription.xml", + "node_id":"en-us_topic_0000001943967049.xml", "product_code":"modelarts", - "code":"144", - "des":"This API is used to modify the description of a training job.PUT /v2/{project_id}/training-jobs/{training_job_id}NoneThe following shows how to modify a training job whos", + "code":"129", + "des":"This API is used to modify the description of a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explo", "doc_type":"api", - "kw":"Modifying the Description of a Training Job,Training Job Management,API Reference", + "kw":"Modifying the Description of a Training Job,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Modifying the Description of a Training Job", @@ -2740,18 +2584,19 @@ }, { "uri":"DeleteTrainingJob.html", - "node_id":"deletetrainingjob.xml", + "node_id":"en-us_topic_0000001910008152.xml", "product_code":"modelarts", - "code":"145", - "des":"This API is used to delete a training job.DELETE /v2/{project_id}/training-jobs/{training_job_id}NoneNoneThe following shows how to delete a training job whose UUID is 3f", + "code":"130", + "des":"This API is used to delete a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{pro", "doc_type":"api", - "kw":"Deleting a Training Job,Training Job Management,API Reference", + "kw":"Deleting a Training Job,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Training Job", @@ -2759,18 +2604,19 @@ }, { "uri":"StopTrainingJob.html", - "node_id":"stoptrainingjob.xml", + "node_id":"en-us_topic_0000001910008020.xml", "product_code":"modelarts", - "code":"146", - "des":"This API is used to terminate a training job. Only jobs in the Creating, Waiting, or Running state can be terminated.POST /v2/{project_id}/training-jobs/{training_job_id}", + "code":"131", + "des":"This API is used to terminate a training job. Only jobs in the Creating, Waiting, or Running state can be terminated.You can debug this API through automatic authenticati", "doc_type":"api", - "kw":"Terminating a Training Job,Training Job Management,API Reference", + "kw":"Terminating a Training Job,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Terminating a Training Job", @@ -2778,56 +2624,59 @@ }, { "uri":"ShowTrainingJobLogsPreview.html", - "node_id":"showtrainingjoblogspreview.xml", + "node_id":"en-us_topic_0000001943967353.xml", "product_code":"modelarts", - "code":"147", - "des":"This API is used to query the logs of a specified task in a given training job (preview).GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/logs/preview", + "code":"132", + "des":"This API is used to query the logs of a specified task in a given training job (preview).You can debug this API through automatic authentication in or use the SDK sample", "doc_type":"api", - "kw":"Querying the Logs of a Specified Task in a Given Training Job (Preview),Training Job Management,API ", + "kw":"Querying the Logs of a Specified Task in a Given Training Job (Preview),Training Management,03 Model", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Logs of a Specified Task in a Given Training Job (Preview)", "githuburl":"" }, { - "uri":"ShowTrainingJobLogsFromObs.html", - "node_id":"showtrainingjoblogsfromobs.xml", + "uri":"ShowObsUrlOfTrainingJobLogs.html", + "node_id":"en-us_topic_0000001943967385.xml", "product_code":"modelarts", - "code":"148", - "des":"This API is used to query the logs of a specified task in a given training job (OBS URL). You can view or download all logs.GET /v2/{project_id}/training-jobs/{training_j", + "code":"133", + "des":"This API is used to obtain the logs of a specified task of a training job (temporary OBS link, which is valid for 5 minutes). You can view all logs or download the logs.Y", "doc_type":"api", - "kw":"Querying the Logs of a Specified Taks in a Given Training Job (OBS URL),Training Job Management,API ", + "kw":"Querying the Logs of a Specified Task in a Training Job (OBS Link),Training Management,03 ModelArts ", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying the Logs of a Specified Taks in a Given Training Job (OBS URL)", + "title":"Querying the Logs of a Specified Task in a Training Job (OBS Link)", "githuburl":"" }, { "uri":"ShowTrainingJobMetrics.html", - "node_id":"showtrainingjobmetrics.xml", + "node_id":"en-us_topic_0000001909848080.xml", "product_code":"modelarts", - "code":"149", - "des":"This API is used to query the running metrics of a specified task in a training job.GET /v2/{project_id}/training-jobs/{training_job_id}/metrics/{task_id}NoneStatus code:", + "code":"134", + "des":"This API is used to query the running metrics of a specified task in a training job.You can debug this API through automatic authentication in or use the SDK sample code", "doc_type":"api", - "kw":"Querying the Running Metrics of a Specified Task in a Training Job,Training Job Management,API Refer", + "kw":"Querying the Running Metrics of a Specified Task in a Training Job,Training Management,03 ModelArts ", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying the Running Metrics of a Specified Task in a Training Job", @@ -2835,218 +2684,69 @@ }, { "uri":"ListTrainingJobs.html", - "node_id":"listtrainingjobs.xml", + "node_id":"en-us_topic_0000001943967193.xml", "product_code":"modelarts", - "code":"150", - "des":"This API is used to query the the created training jobs that meet the search criteria.POST /v2/{project_id}/training-job-searchesStatus code: 200The following shows how t", + "code":"135", + "des":"This API is used to query the the created training jobs that meet the search criteria.You can debug this API through automatic authentication in or use the SDK sample co", "doc_type":"api", - "kw":"Querying a Training Job List,Training Job Management,API Reference", + "kw":"Querying a Training Job List,Training Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Querying a Training Job List", "githuburl":"" }, { - "uri":"ShowAutoSearchTrials.html", - "node_id":"showautosearchtrials.xml", + "uri":"ShowTrainingJobFlavors.html", + "node_id":"en-us_topic_0000001909848160.xml", "product_code":"modelarts", - "code":"151", - "des":"This API is used to query all trails using hyperparameter search.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trialsNoneStatus code: 200The following s", + "code":"136", + "des":"This API is used to obtain the public flavors supported by a training job.GET /v2/{project_id}/training-job-flavorsNoneStatus code: 200The following shows how to query th", "doc_type":"api", - "kw":"Querying All Trials Using Hyperparameter Search,Training Job Management,API Reference", + "kw":"Obtaining the General Specifications Supported by a Training Job,Training Management,03 ModelArts AP", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying All Trials Using Hyperparameter Search", + "title":"Obtaining the General Specifications Supported by a Training Job", "githuburl":"" }, { - "uri":"ShowAutoSearchPerTrial.html", - "node_id":"showautosearchpertrial.xml", + "uri":"ShowTrainingJobEngines.html", + "node_id":"en-us_topic_0000001910008144.xml", "product_code":"modelarts", - "code":"152", - "des":"This API is used to query information about a trial using hyperparameter search based on the trial_id.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-tria", + "code":"137", + "des":"This API is used to obtain the preset AI frameworks supported by a training job.GET /v2/{project_id}/training-job-enginesNoneStatus code: 200The following shows how to qu", "doc_type":"api", - "kw":"Querying Information About a Trial Using Hyperparameter Search,Training Job Management,API Reference", + "kw":"Obtaining the Preset AI Frameworks Supported by a Training Job,Training Management,03 ModelArts API ", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying Information About a Trial Using Hyperparameter Search", + "title":"Obtaining the Preset AI Frameworks Supported by a Training Job", "githuburl":"" }, { - "uri":"ShowAutoSearchParamsAnalysis.html", - "node_id":"showautosearchparamsanalysis.xml", + "uri":"topic_300000004.html", + "node_id":"en-us_topic_0000001910007964.xml", "product_code":"modelarts", - "code":"153", - "des":"This API is used to obtain the summary of hyperparameter sensitivity analysis results.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-analysisNo", - "doc_type":"api", - "kw":"Obtaining the Hyperparameter Sensitivity Analysis Result,Training Job Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Obtaining the Hyperparameter Sensitivity Analysis Result", - "githuburl":"" - }, - { - "uri":"ShowAutoSearchParamAnalysisResultPath.html", - "node_id":"showautosearchparamanalysisresultpath.xml", - "product_code":"modelarts", - "code":"154", - "des":"This API is used to obtain the path for storing a hyperparameter sensitivity analysis image.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-anal", - "doc_type":"api", - "kw":"Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image,Training Job Management,A", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image", - "githuburl":"" - }, - { - "uri":"ShowAutoSearchTrialEarlyStop.html", - "node_id":"showautosearchtrialearlystop.xml", - "product_code":"modelarts", - "code":"155", - "des":"This API is used to early stop a trial of an auto search job.POST /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trial-earlystop/{trial_id}NoneStatus code: 2", - "doc_type":"api", - "kw":"Early Stopping a Trial of an Auto Search Job,Training Job Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Early Stopping a Trial of an Auto Search Job", - "githuburl":"" - }, - { - "uri":"ShowAutoSearchYamlTemplatesInfo.html", - "node_id":"showautosearchyamltemplatesinfo.xml", - "product_code":"modelarts", - "code":"156", - "des":"This API is used to obtain information about the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templatesNoneStatus code: 200The f", - "doc_type":"api", - "kw":"Obtaining Information About the YAML Template of an Auto Search Job,Training Job Management,API Refe", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Obtaining Information About the YAML Template of an Auto Search Job", - "githuburl":"" - }, - { - "uri":"ShowAutoSearchYamlTemplateContent.html", - "node_id":"showautosearchyamltemplatecontent.xml", - "product_code":"modelarts", - "code":"157", - "des":"This API is used to obtain the content of the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templates/{algorithm_type}/{algorithm", - "doc_type":"api", - "kw":"Obtaining the Content of the YAML Template of an Auto Search Job,Training Job Management,API Referen", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Obtaining the Content of the YAML Template of an Auto Search Job", - "githuburl":"" - }, - { - "uri":"resources.html", - "node_id":"resources.xml", - "product_code":"modelarts", - "code":"158", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Resource and Engine Specifications", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Resource and Engine Specifications", - "githuburl":"" - }, - { - "uri":"ListTrainingJobFlavors.html", - "node_id":"listtrainingjobflavors.xml", - "product_code":"modelarts", - "code":"159", - "des":"This API is used to query the list of public flavors supported by a training job.GET /v2/{project_id}/training-job-flavorsNoneStatus code: 200The following shows how to q", - "doc_type":"api", - "kw":"Querying the Public Flavor List Supported by a Training Job,Resource and Engine Specifications,API R", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying the Public Flavor List Supported by a Training Job", - "githuburl":"" - }, - { - "uri":"ListTrainingJobEngines.html", - "node_id":"listtrainingjobengines.xml", - "product_code":"modelarts", - "code":"160", - "des":"This API is used to query the list of AI engines supported by a training job.GET /v2/{project_id}/training-job-enginesNoneStatus code: 200The following shows how to query", - "doc_type":"api", - "kw":"Querying the AI Engine List Supported by a Training Job,Resource and Engine Specifications,API Refer", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying the AI Engine List Supported by a Training Job", - "githuburl":"" - }, - { - "uri":"modelarts_03_0153.html", - "node_id":"modelarts_03_0153.xml", - "product_code":"modelarts", - "code":"161", + "code":"138", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Model Management", @@ -3054,94 +2754,99 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Model Management", "githuburl":"" }, { - "uri":"modelarts_03_0076.html", - "node_id":"modelarts_03_0076.xml", + "uri":"ListModels.html", + "node_id":"en-us_topic_0000001909848068.xml", "product_code":"modelarts", - "code":"162", - "des":"You can use the API to import a model.Ensure that the execution code and model have been uploaded to OBS. By default, the models generated by a training job are stored in", + "code":"139", + "des":"This API is used to obtain the models that meet the search criteria.You can debug this API through automatic authentication in or use the SDK sample code generated by AP", "doc_type":"api", - "kw":"Importing a Model,Model Management,API Reference", + "kw":"Obtaining Models,Model Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Importing a Model", + "title":"Obtaining Models", "githuburl":"" }, { - "uri":"modelarts_03_0077.html", - "node_id":"modelarts_03_0077.xml", + "uri":"CreateModel.html", + "node_id":"en-us_topic_0000001909847888.xml", "product_code":"modelarts", - "code":"163", - "des":"This API is used to query the models that meet the search criteria.GET /v1/{project_id}/modelsTable 1 describes the required parameters.ParametersParameterMandatoryTypeDe", + "code":"140", + "des":"This API is used to import a model. The execution code and model must be uploaded to OBS first. By default, the model generated by a training job is stored in OBS.The bod", "doc_type":"api", - "kw":"Querying a Model List,Model Management,API Reference", + "kw":"Importing Models,Model Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying a Model List", + "title":"Importing Models", "githuburl":"" }, { - "uri":"modelarts_03_0078.html", - "node_id":"modelarts_03_0078.xml", + "uri":"ShowModel.html", + "node_id":"en-us_topic_0000001910008044.xml", "product_code":"modelarts", - "code":"164", - "des":"This API is used to query details about a model based on the model ID.GET /v1/{project_id}/models/{model_id}Table 1 describes the required parameters.ParametersParameterM", + "code":"141", + "des":"This API is used to obtain details about a model based on the model ID.You can debug this API through automatic authentication in or use the SDK sample code generated by", "doc_type":"api", - "kw":"Querying the Details About a Model,Model Management,API Reference", + "kw":"Viewing Details About a Model,Model Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying the Details About a Model", + "title":"Viewing Details About a Model", "githuburl":"" }, { - "uri":"modelarts_03_0079.html", - "node_id":"modelarts_03_0079.xml", + "uri":"DeleteModel.html", + "node_id":"en-us_topic_0000001943967073.xml", "product_code":"modelarts", - "code":"165", + "code":"142", "des":"This API is used to delete a model based on the model ID. When cascade is set to true, the model specified by the model ID and models of different versions with the same ", "doc_type":"api", - "kw":"Deleting a Model,Model Management,API Reference", + "kw":"Deleting a Model,Model Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Model", "githuburl":"" }, { - "uri":"modelarts_03_0081.html", - "node_id":"modelarts_03_0081.xml", + "uri":"topic_300000009.html", + "node_id":"en-us_topic_0000001909848064.xml", "product_code":"modelarts", - "code":"166", + "code":"143", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Service Management", @@ -3149,189 +2854,879 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Service Management", "githuburl":"" }, { - "uri":"modelarts_03_0082.html", - "node_id":"modelarts_03_0082.xml", + "uri":"ShowServiceMonitorInfo.html", + "node_id":"en-us_topic_0000001909847948.xml", "product_code":"modelarts", - "code":"167", - "des":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject", + "code":"144", + "des":"This API is used to obtain service monitoring information.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", "doc_type":"api", - "kw":"Deploying a Model as a Service,Service Management,API Reference", + "kw":"Obtaining Service Monitoring,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Deploying a Model as a Service", + "title":"Obtaining Service Monitoring", "githuburl":"" }, { - "uri":"modelarts_03_0083.html", - "node_id":"modelarts_03_0083.xml", + "uri":"ListServices.html", + "node_id":"en-us_topic_0000001943967345.xml", "product_code":"modelarts", - "code":"168", - "des":"This API is used to obtain model services.GET /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_idYesS", + "code":"145", + "des":"This API is used to obtain model services.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{projec", "doc_type":"api", - "kw":"Querying a Service List,Service Management,API Reference", + "kw":"Obtaining Services,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying a Service List", + "title":"Obtaining Services", "githuburl":"" }, { - "uri":"modelarts_03_0084.html", - "node_id":"modelarts_03_0084.xml", + "uri":"CreateService.html", + "node_id":"en-us_topic_0000001909847876.xml", "product_code":"modelarts", - "code":"169", - "des":"This API is used to query the details about a model service based on the service ID.GET /v1/{project_id}/services/{service_id}Table 1 describes the required parameters.Pa", + "code":"146", + "des":"This API is used to deploy a model as a service.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1/", "doc_type":"api", - "kw":"Querying the Details About a Service,Service Management,API Reference", + "kw":"Deploying Services,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying the Details About a Service", + "title":"Deploying Services", "githuburl":"" }, { - "uri":"modelarts_03_0086.html", - "node_id":"modelarts_03_0086.xml", + "uri":"ShowServiceSpecifications.html", + "node_id":"en-us_topic_0000001943967265.xml", "product_code":"modelarts", - "code":"170", - "des":"This API is used to update configurations of a model service. It can also be used to start or stop a service.PUT /v1/{project_id}/services/{service_id}Table 1 describes t", + "code":"147", + "des":"This API is used to obtain supported service deployment specifications.You can debug this API through automatic authentication in or use the SDK sample code generated by", "doc_type":"api", - "kw":"Updating Service Configurations,Service Management,API Reference", + "kw":"Obtaining Supported Service Deployment Specifications,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Supported Service Deployment Specifications", + "githuburl":"" + }, + { + "uri":"ShowService.html", + "node_id":"en-us_topic_0000001909848156.xml", + "product_code":"modelarts", + "code":"148", + "des":"This API is used to obtain the details about a model service based on the service ID.You can debug this API through automatic authentication in or use the SDK sample cod", + "doc_type":"api", + "kw":"Obtaining Service Details,Service Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Service Details", + "githuburl":"" + }, + { + "uri":"UpdateService.html", + "node_id":"en-us_topic_0000001943967241.xml", + "product_code":"modelarts", + "code":"149", + "des":"This API is used to update configurations of a model service. It can also be used to start or stop a service.You can debug this API through automatic authentication in o", + "doc_type":"api", + "kw":"Updating Service Configurations,Service Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Updating Service Configurations", "githuburl":"" }, { - "uri":"modelarts_03_0087.html", - "node_id":"modelarts_03_0087.xml", + "uri":"DeleteService.html", + "node_id":"en-us_topic_0000001909847864.xml", "product_code":"modelarts", - "code":"171", - "des":"This API is used to query service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorTable 1 describes the required parameters.ParametersParameterMa", + "code":"150", + "des":"This API is used to delete a model service. You can delete your own services only.You can debug this API through automatic authentication in or use the SDK sample code g", "doc_type":"api", - "kw":"Querying Service Monitoring Information,Service Management,API Reference", + "kw":"Deleting a Service,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Service Monitoring Information", - "githuburl":"" - }, - { - "uri":"modelarts_03_0088.html", - "node_id":"modelarts_03_0088.xml", - "product_code":"modelarts", - "code":"172", - "des":"This API is used to query the update logs of a real-time service.GET /v1/{project_id}/services/{service_id}/logsTable 1 describes the required parameters.ParametersParame", - "doc_type":"api", - "kw":"Querying Service Update Logs,Service Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Service Update Logs", - "githuburl":"" - }, - { - "uri":"modelarts_03_0155.html", - "node_id":"modelarts_03_0155.xml", - "product_code":"modelarts", - "code":"173", - "des":"This API is used to query service event logs, including service operation records, key actions during deployment, and deployment failure causes.GET /v1/{project_id}/servi", - "doc_type":"api", - "kw":"Querying Service Event Logs,Service Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Querying Service Event Logs", - "githuburl":"" - }, - { - "uri":"modelarts_03_0089.html", - "node_id":"modelarts_03_0089.xml", - "product_code":"modelarts", - "code":"174", - "des":"This API is used to delete a service. You can delete your own services only.Table 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_i", - "doc_type":"api", - "kw":"Deleting a Service,Service Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting a Service", "githuburl":"" }, { - "uri":"modelarts_03_0200.html", - "node_id":"modelarts_03_0200.xml", + "uri":"ListClusters.html", + "node_id":"en-us_topic_0000001943967221.xml", "product_code":"modelarts", - "code":"175", - "des":"This API is used to query supported service deployment specifications.URIGET /v1/{project_id}/services/specificationsNoneSample requestGET https://endpoint/v1/{project", + "code":"151", + "des":"This API is used to obtain dedicated resource pools.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /", "doc_type":"api", - "kw":"Querying Supported Service Deployment Specifications,Service Management,API Reference", + "kw":"Obtaining Dedicated Resource Pools,Service Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Querying Supported Service Deployment Specifications", + "title":"Obtaining Dedicated Resource Pools", + "githuburl":"" + }, + { + "uri":"ShowServiceEvents.html", + "node_id":"en-us_topic_0000001909847896.xml", + "product_code":"modelarts", + "code":"152", + "des":"This API is used to obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.You can debug this API th", + "doc_type":"api", + "kw":"Obtaining Service Event Logs,Service Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Service Event Logs", + "githuburl":"" + }, + { + "uri":"ShowServiceUpdateLogs.html", + "node_id":"en-us_topic_0000001943967333.xml", + "product_code":"modelarts", + "code":"153", + "des":"This API is used to obtain the update logs of a real-time service.You can debug this API through automatic authentication in or use the SDK sample code generated by API ", + "doc_type":"api", + "kw":"Obtaining Service Update Logs,Service Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Service Update Logs", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"en-us_topic_0000001943967273.xml", + "product_code":"modelarts", + "code":"154", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource Management", + "githuburl":"" + }, + { + "uri":"config_management.html", + "node_id":"en-us_topic_0000001943967153.xml", + "product_code":"modelarts", + "code":"155", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Configuration management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Configuration management", + "githuburl":"" + }, + { + "uri":"ShowOsConfig.html", + "node_id":"en-us_topic_0000001909848096.xml", + "product_code":"modelarts", + "code":"156", + "des":"Obtain the configuration parameters of the ModelArts OS service, such as the CIDR block and user resource quota.You can debug this API through automatic authentication in", + "doc_type":"api", + "kw":"Querying OS Configuration Parameters,Configuration management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying OS Configuration Parameters", + "githuburl":"" + }, + { + "uri":"topic_300000001.html", + "node_id":"en-us_topic_0000001943967197.xml", + "product_code":"modelarts", + "code":"157", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Quota management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Quota management", + "githuburl":"" + }, + { + "uri":"ShowOsQuota.html", + "node_id":"en-us_topic_0000001910008068.xml", + "product_code":"modelarts", + "code":"158", + "des":"Obtain the quotas of some resources in the ModelArts OS service, such as the resource pool quota and network quota.You can debug this API through automatic authentication", + "doc_type":"api", + "kw":"Querying OS Quotas,Quota management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying OS Quotas", + "githuburl":"" + }, + { + "uri":"event_management.html", + "node_id":"en-us_topic_0000001909848016.xml", + "product_code":"modelarts", + "code":"159", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Event management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Event management", + "githuburl":"" + }, + { + "uri":"ListEvents.html", + "node_id":"en-us_topic_0000001943967341.xml", + "product_code":"modelarts", + "code":"160", + "des":"Obtain events.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/eventsNoneStatus code:", + "doc_type":"api", + "kw":"Querying a Trace List,Event management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying a Trace List", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "node_id":"en-us_topic_0000001910008060.xml", + "product_code":"modelarts", + "code":"161", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Pool Job Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource Pool Job Management", + "githuburl":"" + }, + { + "uri":"ListWorkloads.html", + "node_id":"en-us_topic_0000001909848024.xml", + "product_code":"modelarts", + "code":"162", + "des":"Obtain dedicated resource pool jobs.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project_id}/", + "doc_type":"api", + "kw":"Querying the dedicated resource pool Job List,Resource Pool Job Management,03 ModelArts API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying the dedicated resource pool Job List", + "githuburl":"" + }, + { + "uri":"ShowWorkloadStatistics.html", + "node_id":"en-us_topic_0000001910007900.xml", + "product_code":"modelarts", + "code":"163", + "des":"This API is used to query dedicated resource pool job statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", + "doc_type":"api", + "kw":"Querying dedicated resource pool Job Statistics,Resource Pool Job Management,03 ModelArts API Refere", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying dedicated resource pool Job Statistics", + "githuburl":"" + }, + { + "uri":"metrics_management.html", + "node_id":"en-us_topic_0000001943967205.xml", + "product_code":"modelarts", + "code":"164", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource indicators", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource indicators", + "githuburl":"" + }, + { + "uri":"ShowPoolRuntimeMetrics.html", + "node_id":"en-us_topic_0000001909848040.xml", + "product_code":"modelarts", + "code":"165", + "des":"Obtain the real-time usage of all resource pools in the current project.You can debug this API through automatic authentication in or use the SDK sample code generated b", + "doc_type":"api", + "kw":"Querying the Real-Time Resource Usage,Resource indicators,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying the Real-Time Resource Usage", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "node_id":"en-us_topic_0000001943967189.xml", + "product_code":"modelarts", + "code":"166", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Plug-in template management API", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Plug-in template management API", + "githuburl":"" + }, + { + "uri":"ShowPluginTemplate.html", + "node_id":"en-us_topic_0000001909848104.xml", + "product_code":"modelarts", + "code":"167", + "des":"This interface is used to obtain details about a specified plug-in template.You can debug this API through automatic authentication in or use the SDK sample code generat", + "doc_type":"api", + "kw":"Querying a Plug-in Template,Plug-in template management API,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Querying a Plug-in Template", + "githuburl":"" + }, + { + "uri":"network_management.html", + "node_id":"en-us_topic_0000001910008180.xml", + "product_code":"modelarts", + "code":"168", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Networking", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Networking", + "githuburl":"" + }, + { + "uri":"CreateNetwork.html", + "node_id":"en-us_topic_0000001943967217.xml", + "product_code":"modelarts", + "code":"169", + "des":"This API is used to create network resources.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1/{pr", + "doc_type":"api", + "kw":"Creating Network Resources,Networking,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Creating Network Resources", + "githuburl":"" + }, + { + "uri":"ListNetworks.html", + "node_id":"en-us_topic_0000001910008004.xml", + "product_code":"modelarts", + "code":"170", + "des":"This API is used to obtain network resources.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{pro", + "doc_type":"api", + "kw":"Obtaining Network Resources,Networking,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Network Resources", + "githuburl":"" + }, + { + "uri":"ShowNetwork.html", + "node_id":"en-us_topic_0000001910007944.xml", + "product_code":"modelarts", + "code":"171", + "des":"This API is used to obtain details about a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by ", + "doc_type":"api", + "kw":"Obtaining a Network Resource,Networking,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining a Network Resource", + "githuburl":"" + }, + { + "uri":"DeleteNetwork.html", + "node_id":"en-us_topic_0000001943967249.xml", + "product_code":"modelarts", + "code":"172", + "des":"This API is used to delete a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.D", + "doc_type":"api", + "kw":"Deleting a Network Resource,Networking,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Deleting a Network Resource", + "githuburl":"" + }, + { + "uri":"PatchNetwork.html", + "node_id":"en-us_topic_0000001943967257.xml", + "product_code":"modelarts", + "code":"173", + "des":"This API is used to update a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.P", + "doc_type":"api", + "kw":"Updating a Network Resource,Networking,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Updating a Network Resource", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"en-us_topic_0000001943967229.xml", + "product_code":"modelarts", + "code":"174", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Node management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Node management", + "githuburl":"" + }, + { + "uri":"ListPoolNodes.html", + "node_id":"en-us_topic_0000001910008036.xml", + "product_code":"modelarts", + "code":"175", + "des":"This API is used to obtain nodes in a resource pool.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /", + "doc_type":"api", + "kw":"Obtaining Nodes,Node management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Nodes", + "githuburl":"" + }, + { + "uri":"BatchDeletePoolNodes.html", + "node_id":"en-us_topic_0000001910008204.xml", + "product_code":"modelarts", + "code":"176", + "des":"Delete nodes in a specific resource pool. At least one node must be reserved in the resource pool.You can debug this API through automatic authentication in or use the S", + "doc_type":"api", + "kw":"Deleting nodes in batches,Node management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Deleting nodes in batches", + "githuburl":"" + }, + { + "uri":"topic_300000008.html", + "node_id":"en-us_topic_0000001910008072.xml", + "product_code":"modelarts", + "code":"177", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource pool management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource pool management", + "githuburl":"" + }, + { + "uri":"CreatePool.html", + "node_id":"en-us_topic_0000001909848048.xml", + "product_code":"modelarts", + "code":"178", + "des":"This API is used to create a resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK code and pr", + "doc_type":"api", + "kw":"Creating a Resource Pool,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Creating a Resource Pool", + "githuburl":"" + }, + { + "uri":"ListPools.html", + "node_id":"en-us_topic_0000001910007924.xml", + "product_code":"modelarts", + "code":"179", + "des":"This API is used to obtain resource pools.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK code and pro", + "doc_type":"api", + "kw":"Obtaining Resource Pools,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Resource Pools", + "githuburl":"" + }, + { + "uri":"ShowPool.html", + "node_id":"en-us_topic_0000001909848008.xml", + "product_code":"modelarts", + "code":"180", + "des":"This API is used to obtain details about a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generate", + "doc_type":"api", + "kw":"Obtaining Details About a Resource Pool,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Details About a Resource Pool", + "githuburl":"" + }, + { + "uri":"DeletePool.html", + "node_id":"en-us_topic_0000001910008016.xml", + "product_code":"modelarts", + "code":"181", + "des":"This API is used to delete a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK c", + "doc_type":"api", + "kw":"Delete a Resource Pool,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Delete a Resource Pool", + "githuburl":"" + }, + { + "uri":"PatchPool.html", + "node_id":"en-us_topic_0000001943967277.xml", + "product_code":"modelarts", + "code":"182", + "des":"This API is used to update a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK c", + "doc_type":"api", + "kw":"Updating a Resource Pool,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Updating a Resource Pool", + "githuburl":"" + }, + { + "uri":"ShowPoolMonitor.html", + "node_id":"en-us_topic_0000001909848076.xml", + "product_code":"modelarts", + "code":"183", + "des":"This API is used to obtain the monitored resource pool information.You can debug this API through automatic authentication in or use the SDK sample code generated by API", + "doc_type":"api", + "kw":"Monitoring a Resource Pool,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Monitoring a Resource Pool", + "githuburl":"" + }, + { + "uri":"ShowPoolStatistics.html", + "node_id":"en-us_topic_0000001910008164.xml", + "product_code":"modelarts", + "code":"184", + "des":"Obtain the statistics of a resource pool.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project", + "doc_type":"api", + "kw":"Resource Pool Statistics,Resource pool management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource Pool Statistics", + "githuburl":"" + }, + { + "uri":"resource_flavor_management.html", + "node_id":"en-us_topic_0000001943967365.xml", + "product_code":"modelarts", + "code":"185", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource flavor management APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Resource flavor management APIs", + "githuburl":"" + }, + { + "uri":"ListResourceFlavors.html", + "node_id":"en-us_topic_0000001910008088.xml", + "product_code":"modelarts", + "code":"186", + "des":"Obtain resource specifications.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/resou", + "doc_type":"api", + "kw":"Obtaining Resource Specifications,Resource flavor management APIs,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Obtaining Resource Specifications", "githuburl":"" }, { "uri":"authorization.html", - "node_id":"authorization.xml", + "node_id":"en-us_topic_0000001910008184.xml", "product_code":"modelarts", - "code":"176", + "code":"187", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Authorization Management", @@ -3339,65 +3734,69 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Authorization Management", "githuburl":"" }, - { - "uri":"CreateAuthorization.html", - "node_id":"createauthorization.xml", - "product_code":"modelarts", - "code":"177", - "des":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", - "doc_type":"api", - "kw":"Configuring Authorization,Authorization Management,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Configuring Authorization", - "githuburl":"" - }, { "uri":"GetAuthorizations.html", - "node_id":"getauthorizations.xml", + "node_id":"en-us_topic_0000001909847980.xml", "product_code":"modelarts", - "code":"178", - "des":"This API is used to view an authorization list.GET /v2/{project_id}/authorizationsNoneStatus code: 200View an authorization list.Status code: 200OKSee Error Codes.", + "code":"188", + "des":"This API is used to view an authorization list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{p", "doc_type":"api", - "kw":"Viewing an Authorization List,Authorization Management,API Reference", + "kw":"Viewing an Authorization List,Authorization Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Viewing an Authorization List", "githuburl":"" }, { - "uri":"DeleteAuthorizations.html", - "node_id":"deleteauthorizations.xml", + "uri":"CreateAuthorization.html", + "node_id":"en-us_topic_0000001943967237.xml", "product_code":"modelarts", - "code":"179", - "des":"This API is used to delete the authorization of a specified user or all users.DELETE /v2/{project_id}/authorizationsNoneNoneDelete the authorization of a specified user.S", + "code":"189", + "des":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", "doc_type":"api", - "kw":"Deleting Authorization,Authorization Management,API Reference", + "kw":"Configuring Authorization,Authorization Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"Configuring Authorization", + "githuburl":"" + }, + { + "uri":"DeleteAuthorizations.html", + "node_id":"en-us_topic_0000001910007912.xml", + "product_code":"modelarts", + "code":"190", + "des":"This API is used to delete the authorization of a specified user or all users.You can debug this API through automatic authentication in or use the SDK sample code gener", + "doc_type":"api", + "kw":"Deleting Authorization,Authorization Management,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Deleting Authorization", @@ -3405,18 +3804,19 @@ }, { "uri":"CreateModelArtsAgency.html", - "node_id":"createmodelartsagency.xml", + "node_id":"en-us_topic_0000001909848172.xml", "product_code":"modelarts", - "code":"180", - "des":"This API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneCreate a ModelArts agency.Status code: 200O", + "code":"191", + "des":"This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.You can debug this API through automatic authentication in ", "doc_type":"api", - "kw":"Creating a ModelArts Agency,Authorization Management,API Reference", + "kw":"Creating a ModelArts Agency,Authorization Management,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Creating a ModelArts Agency", @@ -3424,9 +3824,9 @@ }, { "uri":"modelarts_03_0138.html", - "node_id":"modelarts_03_0138.xml", + "node_id":"en-us_topic_0000001910008212.xml", "product_code":"modelarts", - "code":"181", + "code":"192", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", @@ -3434,8 +3834,9 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Permissions Policies and Supported Actions", @@ -3443,94 +3844,99 @@ }, { "uri":"modelarts_03_0146.html", - "node_id":"modelarts_03_0146.xml", + "node_id":"en-us_topic_0000001910008076.xml", "product_code":"modelarts", - "code":"182", + "code":"193", "des":"This section describes fine-grained permissions management for your ModelArts. If your account does not require individual IAM users, skip this section.By default, new IA", "doc_type":"api", - "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "kw":"Introduction,Permissions Policies and Supported Actions,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Introduction", "githuburl":"" }, - { - "uri":"modelarts_03_0234.html", - "node_id":"modelarts_03_0234.xml", - "product_code":"modelarts", - "code":"183", - "des":"ExeML APIs are inaccessible to external systems. To use ExeML functions on the console and manage permissions, perform the operations described in the following table.", - "doc_type":"api", - "kw":"ExeML Permissions,Permissions Policies and Supported Actions,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"ExeML Permissions", - "githuburl":"" - }, { "uri":"modelarts_03_0161.html", - "node_id":"modelarts_03_0161.xml", + "node_id":"en-us_topic_0000001909848224.xml", "product_code":"modelarts", - "code":"184", + "code":"194", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Data Management Permissions,Permissions Policies and Supported Actions,API Reference", + "kw":"Data Management Permissions,Permissions Policies and Supported Actions,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Data Management Permissions", "githuburl":"" }, { - "uri":"modelarts_03_0162.html", - "node_id":"modelarts_03_0162.xml", + "uri":"modelarts_03_0365.html", + "node_id":"en-us_topic_0000001909848116.xml", "product_code":"modelarts", - "code":"185", + "code":"195", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"DevEnviron Permissions,Permissions Policies and Supported Actions,API Reference", + "kw":"DevEnviron Permissions (New Version),Permissions Policies and Supported Actions,03 ModelArts API Ref", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"DevEnviron Permissions", + "title":"DevEnviron Permissions (New Version)", "githuburl":"" }, { - "uri":"modelarts_03_0163.html", - "node_id":"modelarts_03_0163.xml", + "uri":"modelarts_03_0162.html", + "node_id":"en-us_topic_0000001909848220.xml", "product_code":"modelarts", - "code":"186", + "code":"196", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Training Job Permissions,Permissions Policies and Supported Actions,API Reference", + "kw":"DevEnviron Permissions (Old Version),Permissions Policies and Supported Actions,03 ModelArts API Ref", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" + } + ], + "title":"DevEnviron Permissions (Old Version)", + "githuburl":"" + }, + { + "uri":"modelarts_03_0364.html", + "node_id":"en-us_topic_0000001910008048.xml", + "product_code":"modelarts", + "code":"197", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Training Job Permissions,Permissions Policies and Supported Actions,03 ModelArts API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "opensource":"true", + "prodname":"modelarts", + "operation_id":"ShowTrainingJobEngines" } ], "title":"Training Job Permissions", @@ -3538,18 +3944,19 @@ }, { "uri":"modelarts_03_0164.html", - "node_id":"modelarts_03_0164.xml", + "node_id":"en-us_topic_0000001943967309.xml", "product_code":"modelarts", - "code":"187", + "code":"198", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Model Management Permissions,Permissions Policies and Supported Actions,API Reference", + "kw":"Model Management Permissions,Permissions Policies and Supported Actions,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Model Management Permissions", @@ -3557,47 +3964,29 @@ }, { "uri":"modelarts_03_0165.html", - "node_id":"modelarts_03_0165.xml", + "node_id":"en-us_topic_0000001943967233.xml", "product_code":"modelarts", - "code":"188", + "code":"199", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Service Management Permissions,Permissions Policies and Supported Actions,API Reference", + "kw":"Service Management Permissions,Permissions Policies and Supported Actions,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Service Management Permissions", "githuburl":"" }, - { - "uri":"modelarts_03_0166.html", - "node_id":"modelarts_03_0166.xml", - "product_code":"modelarts", - "code":"189", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Workspace Management Permissions,Permissions Policies and Supported Actions,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" - } - ], - "title":"Workspace Management Permissions", - "githuburl":"" - }, { "uri":"modelarts_03_0093.html", - "node_id":"modelarts_03_0093.xml", + "node_id":"en-us_topic_0000001943967169.xml", "product_code":"modelarts", - "code":"190", + "code":"200", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Common Parameters", @@ -3605,8 +3994,9 @@ "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Common Parameters", @@ -3614,18 +4004,19 @@ }, { "uri":"modelarts_03_0094.html", - "node_id":"modelarts_03_0094.xml", + "node_id":"en-us_topic_0000001943967181.xml", "product_code":"modelarts", - "code":"191", + "code":"201", "des":"Table 1 describes the status codes.", "doc_type":"api", - "kw":"Status Code,Common Parameters,API Reference", + "kw":"Status Code,Common Parameters,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Status Code", @@ -3633,18 +4024,19 @@ }, { "uri":"modelarts_03_0095.html", - "node_id":"modelarts_03_0095.xml", + "node_id":"en-us_topic_0000001910007968.xml", "product_code":"modelarts", - "code":"192", + "code":"202", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Error Codes,Common Parameters,API Reference", + "kw":"Error Codes,Common Parameters,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Error Codes", @@ -3652,18 +4044,19 @@ }, { "uri":"modelarts_03_0147.html", - "node_id":"modelarts_03_0147.xml", + "node_id":"en-us_topic_0000001943967381.xml", "product_code":"modelarts", - "code":"193", + "code":"203", "des":"A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following me", "doc_type":"api", - "kw":"Obtaining a Project ID and Name,Common Parameters,API Reference", + "kw":"Obtaining a Project ID and Name,Common Parameters,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining a Project ID and Name", @@ -3671,37 +4064,39 @@ }, { "uri":"modelarts_03_0148.html", - "node_id":"modelarts_03_0148.xml", + "node_id":"en-us_topic_0000001909848052.xml", "product_code":"modelarts", - "code":"194", - "des":"When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows:Log in to the console.Hover the cursor on the userna", + "code":"204", + "des":"When you call APIs, certain requests require the domain name and ID. To obtain a domain name and ID, do as follows:Log in to the ModelArts console.In the upper right corn", "doc_type":"api", - "kw":"Obtaining the Account Name and Account ID,Common Parameters,API Reference", + "kw":"Obtaining a Tenant Name and ID,Common Parameters,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], - "title":"Obtaining the Account Name and Account ID", + "title":"Obtaining a Tenant Name and ID", "githuburl":"" }, { "uri":"modelarts_03_0006.html", - "node_id":"modelarts_03_0006.xml", + "node_id":"en-us_topic_0000001910008024.xml", "product_code":"modelarts", - "code":"195", - "des":"When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:Log in to the console.Hover the cursor on the username and ch", + "code":"205", + "des":"When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:Log in to the management console after registration.In the up", "doc_type":"api", - "kw":"Obtaining a Username and ID,Common Parameters,API Reference", + "kw":"Obtaining a Username and ID,Common Parameters,03 ModelArts API Reference", "search_title":"", "metedata":[ { "documenttype":"api", + "opensource":"true", "prodname":"modelarts", - "opensource":"true" + "operation_id":"ShowTrainingJobEngines" } ], "title":"Obtaining a Username and ID", @@ -3709,18 +4104,16 @@ }, { "uri":"modelarts_03_0097.html", - "node_id":"modelarts_03_0097.xml", - "product_code":"modelarts", - "code":"196", + "node_id":"en-us_topic_0000001916086016.xml", + "product_code":"", + "code":"206", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Change History,API Reference", + "doc_type":"", + "kw":"Change History,03 ModelArts API Reference", "search_title":"", "metedata":[ { - "documenttype":"api", - "prodname":"modelarts", - "opensource":"true" + } ], "title":"Change History", diff --git a/docs/modelarts/api-ref/AcceptSamples.html b/docs/modelarts/api-ref/AcceptSamples.html index 099ad636..b20c4615 100644 --- a/docs/modelarts/api-ref/AcceptSamples.html +++ b/docs/modelarts/api-ref/AcceptSamples.html @@ -1,76 +1,13 @@ - +

Submitting Sample Review Comments of an Acceptance Task

-

Function

This API is used to submit sample review comments of an acceptance task.

+

Function

This API is used to submit sample review comments of an acceptance task.

-

URI

POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-comment

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-comment

-
- - - - - - - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

dataset_id

-

Yes

-

String

-

Dataset ID.

-

project_id

-

Yes

-

String

-

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

-

workforce_task_id

-

Yes

-

String

-

ID of a labeling task.

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

comments

-

No

-

Array of SampleComment objects

-

Review comment list.

-
-
- -
Table 3 SampleComment

Parameter

+
@@ -80,52 +17,117 @@ - - - + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

Mandatory

accept

+

dataset_id

Yes

Boolean

+

String

Whether the submitted sample review comments are passed. The options are as follows:

+

Dataset ID.

+

project_id

+

Yes

+

String

+

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

+

workforce_task_id

+

Yes

+

String

+

ID of a labeling task.

+
+
+ +

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

comments

+

Yes

+

Array of SampleComment objects

+

Review comment list.

+
+
+ +
+ + + + + + + + + - - - - - - - - - - - - - - - - @@ -150,30 +152,30 @@
{ }

Status Codes

-
Table 3 SampleComment

Parameter

+

Mandatory

+

Type

+

Description

+

accept

+

Yes

+

Boolean

+

Whether the submitted sample review comments are passed. Options:

  • true: passed

  • false: not passed

comment

+

comment

No

+

No

String

+

String

Review comment, which contains 0 to 256 characters, excluding special characters (!<>=&"'').

+

Review comment, which contains 0 to 256 characters, excluding special characters (!<>=&"'').

sample_id

+

sample_id

No

+

No

String

+

String

Sample ID.

+

Sample ID.

score

+

score

No

+

No

String

+

String

Review score, whose value can be A, B, C, or D, in descending order.

+

Review score, whose value can be A, B, C, or D, in descending order.

worker_id

+

worker_id

No

+

No

String

+

String

ID of a labeling team member.

+

ID of a labeling team member.

Status Code

+
- - - - - - - - - @@ -185,7 +187,7 @@
diff --git a/docs/modelarts/api-ref/AttachObs.html b/docs/modelarts/api-ref/AttachObs.html index 7e3b9db7..8276c9aa 100644 --- a/docs/modelarts/api-ref/AttachObs.html +++ b/docs/modelarts/api-ref/AttachObs.html @@ -1,38 +1,40 @@ - +

OBS Storage Mounting

-

Function

This API is used to mount OBS storage to a running notebook instance so that the application layer can operate OBS parallel file system in the container.

+

Function

An OBS parallel file system can be mounted to a specified file directory of a running notebook instance. After the mounting, objects in the OBS parallel file system can be read and written in the container as a file system.

Constraints

None

-

URI

POST /v1/{project_id}/notebooks/{instance_id}/storage

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

POST /v1/{project_id}/notebooks/{instance_id}/storage

-

Status Code

Description

+

Description

200

+

200

OK

+

OK

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

404

+

404

Not Found

+

Not Found

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - @@ -40,41 +42,43 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Notebook instance ID.

+

Notebook instance ID.

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details, see Obtaining a Project ID.

+

Project ID. For details, see Obtaining a Project ID and Name.

Table 2 Request body parameters

Parameter

+
- - - - - - - - - - - - - - - @@ -83,47 +87,56 @@

Response Parameters

Status code: 200

-
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

category

+

category

No

+

No

String

+

String

Storage category. Options: - OBS

+

Storage category. Options:

+
  • OBS

    +

mount_path

+

mount_path

No

+

No

String

+

String

Path where OBS storage is mounted, which must be in a subdirectory of /data/ of the notebook instance.

+

Path where OBS storage is mounted, which must be in a subdirectory of /data/ of the notebook instance.

uri

+

uri

No

+

No

String

+

String

OBS parallel file system path, for example, obs://modelarts/notebook/.

+

OBS object path, for example, obs://modelarts/notebook/

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - - - - - - - - @@ -147,35 +160,35 @@ }

Status Codes

-
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

category

+

category

String

+

String

Storage category. Options: - OBS

+

Storage category. Options:

+
  • OBS

    +

id

+

id

String

+

String

ID of the instance with OBS storage mounted.

+

ID of the instance with OBS storage mounted.

mount_path

+

mount_path

String

+

String

Path where OBS storage is mounted to a notebook instance.

+

Path where OBS storage is mounted to a notebook instance.

status

+

status

String

+

String

Status of OBS storage to be mounted. Options: \r\n-MOUNTING: OBS storage is being mounted. \r\n-MOUNT_FAILED: OBS storage fails to be mounted. \r\n-MOUNTED: OBS storage is mounted. \r\n-UNMOUNTING: OBS storage is being unmounted.\r\n-UNMOUNT_FAILED: OBS storage fails to be unmounted.\r\n-UNMOUNTED: OBS is unmounted.

+

Status of OBS storage to be mounted. Options:

+
  • MOUNTING: being mounted

    +
  • MOUNT_FAILED: mounting failed

    +
  • MOUNTED: mounted

    +
  • UNMOUNTING: being unmounted

    +
  • UNMOUNT_FAILED: unmounting failed

    +
  • UNMOUNTED: unmounted

    +

uri

+

uri

String

+

String

OBS parallel file system path.

+

OBS object path

Status Code

+
- - - - - - - - - - - @@ -187,7 +200,7 @@
diff --git a/docs/modelarts/api-ref/AutoAnnotationProgress.html b/docs/modelarts/api-ref/AutoAnnotationProgress.html index 4adf8fe9..30b2394f 100644 --- a/docs/modelarts/api-ref/AutoAnnotationProgress.html +++ b/docs/modelarts/api-ref/AutoAnnotationProgress.html @@ -1,1488 +1,1690 @@ - +

Obtaining Information About Intelligent Tasks

-

Function

This API is used to obtain information about intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the task_id parameter to query the details about a specific task.

+

Function

This interface is used to obtain details about intelligent tasks. Intelligent labeling and automatic grouping tasks can be queried. You can specify the task_id parameter to query the details about a specific task.

-

URI

GET /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

GET /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}

-

Status Code

Description

+

Description

200

+

200

OK

+

OK

201

+

201

Created

+

Created

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

404

+

404

Not Found

+

Not Found

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

dataset_id

+

dataset_id

Yes

+

Yes

String

+

String

Dataset ID.

+

Dataset ID.

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

task_id

+

task_id

Yes

+

Yes

String

+

String

Task ID.

+

Task ID.

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 2 Response body parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

Task running status code.

+

Task running status code.

config

+

config

SmartTaskConfig object

+

SmartTaskConfig object

Task configuration.

+

Task configuration.

create_time

+

create_time

String

+

String

Task creation time.

+

Task creation time.

elapsed_time

+

elapsed_time

Long

+

Long

Execution time.

+

Execution time.

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_detail

+

error_detail

String

+

String

Error details.

+

Error details.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.

message

+

message

String

+

String

Task running information.

+

Task running information.

progress

+

progress

Float

+

Float

Task progress percentage.

+

Task progress percentage.

resource_id

+

resource_id

String

+

String

Resource ID.

+

Resource ID.

result

+

result

Result object

+

Result object

Task result.

+

Task result.

status

+

status

Integer

+

Integer

Task status. Options:

-
  • -1: queuing
  • 0: initialized
  • 1: running
  • 2: failed
  • 3: succeeded
  • 4: stopping
  • 5: stopped
+

Task status. Options:

+
  • -1: queuing

    +
  • 0: initialized

    +
  • 1: running

    +
  • 2: failed

    +
  • 3: succeeded

    +
  • 4: stopping

    +
  • 5: stopped

    +

task_id

+

task_id

String

+

String

Task ID.

+

Task ID.

task_name

+

task_name

String

+

String

Task name.

+

Task name.

+

export_type

+

Integer

+

Export type. Options:

+
  • 0: Exported to OBS.

    +
  • 1: Exported to sample attributes.

    +
-
Table 3 SmartTaskConfig

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 SmartTaskConfig

Parameter

Type

+

Type

Description

+

Description

algorithm_type

+

algorithm_type

String

+

String

Algorithm type for auto labeling. Options:

-
  • fast: Only labeled samples are used for training. This type of algorithm achieves faster labeling.
  • accurate: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling.
+

Algorithm type for auto labeling. Options:

+
  • fast: Only labeled samples are used for training. This type of algorithm achieves faster labeling.

    +
  • accurate: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling.

    +

ambiguity

+

ambiguity

Boolean

+

Boolean

Whether to perform clustering based on the image blurring degree.

+

Whether to perform clustering based on the image blurring degree.

annotation_output

+

annotation_output

String

+

String

Output path of the active learning labeling result.

+

Output path of the active learning labeling result.

collect_rule

+

collect_rule

String

+

String

Sample collection rule. The default value is all, indicating full collection. Currently, only value all is available.

+

Sample collection rule. The default value is all, indicating full collection. Currently, only value all is available.

collect_sample

+

collect_sample

Boolean

+

Boolean

Whether to enable sample collection. The options are as follows:

-
  • true: Enable sample collection. (Default value)
  • false: Do not enable sample collection.
+

Whether to enable sample collection. Options:

+
  • true: Enable sample collection. (Default value)

    +
  • false: Do not enable sample collection.

    +

confidence_scope

+

confidence_scope

String

+

String

Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90.

+

Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90.

description

+

description

String

+

String

Task description.

+

Task description.

engine_name

+

engine_name

String

+

String

Engine name.

+

Engine name.

export_format

+

export_format

Integer

+

Integer

Format of the exported directory. The options are as follows:

-
  • 1: tree structure. For example: cat/1.jpg,rabbit/2.jpg.
  • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.
+

Format of the exported directory. Options:

+
  • 1: tree structure. Example: rabbits/1.jpg,bees/2.jpg.

    +
  • 2: tile structure. Example: 1.jpg, 1.txt; 2.jpg,2.txt.

    +

export_params

+

export_params

ExportParams object

+

ExportParams object

Parameters of a dataset export task.

+

Parameters of a dataset export task.

flavor

+

flavor

Flavor object

+

Flavor object

Training resource flavor.

+

Training resource flavor.

image_brightness

+

image_brightness

Boolean

+

Boolean

Whether to perform clustering based on the image brightness.

+

Whether to perform clustering based on the image brightness.

image_colorfulness

+

image_colorfulness

Boolean

+

Boolean

Whether to perform clustering based on the image color.

+

Whether to perform clustering based on the image color.

inf_cluster_id

+

inf_cluster_id

String

+

String

ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the vpc_id parameter does not take effect.

+

ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the vpc_id parameter does not take effect.

inf_config_list

+

inf_config_list

Array of InfConfig objects

+

Array of InfConfig objects

Configuration list required for running an inference task, which is optional and left blank by default.

+

Configuration list required for running an inference task, which is optional and left blank by default.

inf_output

+

inf_output

String

+

String

Output path of inference in active learning.

+

Output path of inference in active learning.

infer_result_output_dir

+

infer_result_output_dir

String

+

String

OBS directory for storing sample prediction results. This parameter is optional. The {service_id}-infer-result subdirectory in the output_dir directory is used by default.

+

OBS directory for storing sample prediction results. This parameter is optional. The {service_id}-infer-result subdirectory in the output_dir directory is used by default.

key_sample_output

+

key_sample_output

String

+

String

Output path of hard examples in active learning.

+

Output path of hard examples in active learning.

log_url

+

log_url

String

+

String

OBS URL of the logs of a training job. By default, this parameter is left blank.

+

OBS URL of the logs of a training job. By default, this parameter is left blank.

manifest_path

+

manifest_path

String

+

String

Path of the manifest file, which is used as the input for training and inference.

+

Path of the manifest file, which is used as the input for training and inference.

model_id

+

model_id

String

+

String

Model ID.

+

Model ID.

model_name

+

model_name

String

+

String

Model name.

+

Model name.

model_parameter

+

model_parameter

String

+

String

Model parameter.

+

Model parameter.

model_version

+

model_version

String

+

String

Model version.

+

Model version.

n_clusters

+

n_clusters

Integer

+

Integer

Number of clusters.

+

Number of clusters.

name

+

name

String

+

String

Task name.

+

Task name.

output_dir

+

output_dir

String

+

String

Sample output path. The format is as follows: Dataset output path/Dataset name-Dataset ID/annotation/auto-deploy/. Example: /test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/.

+

Sample output path. The format is as follows: Dataset output path/Dataset name-Dataset ID/annotation/auto-deploy/. Example: /test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/.

parameters

+

parameters

Array of TrainingParameter objects

+

Array of TrainingParameter objects

Runtime parameters of a training job

+

Runtime parameters of a training job

pool_id

+

pool_id

String

+

String

ID of a resource pool.

+

ID of a resource pool.

property

+

property

String

+

String

Attribute name.

+

Attribute name.

req_uri

+

req_uri

String

+

String

Inference path of a batch job.

+

Inference path of a batch job.

result_type

+

result_type

Integer

+

Integer

Processing mode of auto grouping results. The options are as follows:

-
  • 0: Save to OBS.
  • 1: Save to samples.
+

Processing mode of auto grouping results. Options:

+
  • 0: Save to OBS.

    +
  • 1: Save to samples.

    +

samples

+

samples

Array of SampleLabels objects

+

Array of SampleLabels objects

List of labeling information for samples to be auto labeled.

+

List of labeling information for samples to be auto labeled.

stop_time

+

stop_time

Integer

+

Integer

Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos.

+

Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos.

time

+

time

String

+

String

Timestamp in active learning.

+

Timestamp in active learning.

train_data_path

+

train_data_path

String

+

String

Path for storing existing training datasets.

+

Path for storing existing training datasets.

train_url

+

train_url

String

+

String

URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank.

+

URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank.

version_format

+

version_format

String

+

String

Format of a dataset version. The options are as follows:

-
  • Default: default format
  • CarbonData: CarbonData (supported only by table datasets)
  • CSV: CSV
+

Format of a dataset version. Options:

+
  • Default: default format

    +
  • CarbonData: CarbonData (supported only by table datasets)

    +
  • CSV: CSV

    +

worker_server_num

+

worker_server_num

Integer

+

Integer

Number of workers in a training job.

+

Number of workers in a training job.

-
Table 4 ExportParams

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ExportParams

Parameter

Type

+

Type

Description

+

Description

clear_hard_property

+

clear_hard_property

Boolean

+

Boolean

Whether to clear hard example attributes. The options are as follows:

-
  • true: Clear hard example attributes. (Default value)
  • false: Do not clear hard example attributes.
+

Whether to clear hard example attributes. Options:

+
  • true: Clear hard example attributes. (Default value)

    +
  • false: Do not clear hard example attributes.

    +

export_dataset_version_format

+

export_dataset_version_format

String

+

String

Format of the dataset version to which data is exported.

+

Format of the dataset version to which data is exported.

export_dataset_version_name

+

export_dataset_version_name

String

+

String

Name of the dataset version to which data is exported.

+

Name of the dataset version to which data is exported.

export_dest

+

export_dest

String

+

String

Export destination. The options are as follows:

-
  • DIR: Export data to OBS. (Default value)
  • NEW_DATASET: Export data to a new dataset.
+

Export destination. Options:

+
  • DIR: Export data to OBS. (Default value)

    +
  • NEW_DATASET: Export data to a new dataset.

    +

export_new_dataset_name

+

export_new_dataset_name

String

+

String

Name of the new dataset to which data is exported.

+

Name of the new dataset to which data is exported.

export_new_dataset_work_path

+

export_new_dataset_work_path

String

+

String

Working directory of the new dataset to which data is exported.

+

Working directory of the new dataset to which data is exported.

ratio_sample_usage

+

ratio_sample_usage

Boolean

+

Boolean

Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows:

-
  • true: Allocate the training set and validation set.
  • false: Do not allocate the training set and validation set. (Default value)
+

Whether to randomly allocate the training set and validation set based on the specified ratio. Options:

+
  • true: Allocate the training set and validation set.

    +
  • false: Do not allocate the training set and validation set. (Default value)

    +

sample_state

+

sample_state

String

+

String

Sample status. The options are as follows:

-
  • ALL: labeled
  • NONE: unlabeled
  • UNCHECK: pending acceptance
  • ACCEPTED: accepted
  • REJECTED: rejected
  • UNREVIEWED: pending review
  • REVIEWED: reviewed
  • WORKFORCE_SAMPLED: sampled
  • WORKFORCE_SAMPLED_UNCHECK: sampling unchecked
  • WORKFORCE_SAMPLED_CHECKED: sampling checked
  • WORKFORCE_SAMPLED_ACCEPTED: sampling accepted
  • WORKFORCE_SAMPLED_REJECTED: sampling rejected
  • AUTO_ANNOTATION: to be confirmed
+

Sample status. Options:

+
  • __ALL__: labeled

    +
  • __NONE__: unlabeled

    +
  • __UNCHECK__: to be checked

    +
  • __ACCEPTED__: accepted

    +
  • __REJECTED__: rejected

    +
  • __UNREVIEWED__: to be reviewed

    +
  • __REVIEWED__: reviewed

    +
  • __WORKFORCE_SAMPLED__: reviewed data sampled

    +
  • __WORKFORCE_SAMPLED_UNCHECK__: samples to be checked

    +
  • __WORKFORCE_SAMPLED_CHECKED__: samples checked

    +
  • __WORKFORCE_SAMPLED_ACCEPTED__: samples accepted

    +
  • __WORKFORCE_SAMPLED_REJECTED__: samples rejected

    +
  • __AUTO_ANNOTATION__: to be checked

    +

samples

+

samples

Array of strings

+

Array of strings

ID list of exported samples.

+

ID list of exported samples.

search_conditions

+

search_conditions

Array of SearchCondition objects

+

Array of SearchCondition objects

Exported search conditions. The relationship between multiple search conditions is OR.

+

Exported search conditions. The relationship between multiple search conditions is OR.

train_sample_ratio

+

train_sample_ratio

String

+

String

Split ratio of training set and verification set during specified version release. The default value is 1.00, indicating that all released versions are training sets.

+

Split ratio of training set and verification set during specified version release. The default value is 1.00, indicating that all released versions are training sets.

-
Table 5 SearchCondition

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SearchCondition

Parameter

Type

+

Type

Description

+

Description

coefficient

+

coefficient

String

+

String

Filter by coefficient of difficulty.

+

Filter by coefficient of difficulty.

frame_in_video

+

frame_in_video

Integer

+

Integer

A frame in the video.

+

A frame in the video.

hard

+

hard

String

+

String

Whether a sample is a hard sample. The options are as follows:

-
  • 0: non-hard sample
  • 1: hard sample
+

Whether a sample is a hard sample. Options:

+
  • 0: non-hard sample

    +
  • 1: hard sample

    +

import_origin

+

import_origin

String

+

String

Filter by data source.

+

Filter by data source.

kvp

+

kvp

String

+

String

CT dosage, filtered by dosage.

+

CT dosage, filtered by dosage.

label_list

+

label_list

SearchLabels object

+

SearchLabels object

Label search criteria.

+

Label search criteria.

labeler

+

labeler

String

+

String

Labeler.

+

Labeler.

metadata

+

metadata

SearchProp object

+

SearchProp object

Search by sample attribute.

+

Search by sample attribute.

parent_sample_id

+

parent_sample_id

String

+

String

Parent sample ID.

+

Parent sample ID.

sample_dir

+

sample_dir

String

+

String

Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported.

+

Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported.

sample_name

+

sample_name

String

+

String

Search by sample name, including the file name extension.

+

Search by sample name, including the file name extension.

sample_time

+

sample_time

String

+

String

When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows:- month: Search for samples added from 30 days ago to the current day.- day: Search for samples added from yesterday (one day ago) to the current day.- yyyyMMdd-yyyyMMdd: Search for samples added in a specified period (at most 30 days), in the format of Start date-End date. For example, 20190901-2019091501 indicates that samples generated from September 1 to September 15, 2019 are searched.

+

When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. Options:

+
  • month: Search for samples added from 30 days ago to the current day.

    +
  • day: Search for samples added from yesterday (one day ago) to the current day.

    +
  • yyyyMMdd-yyyyMMdd: Search for samples added in a specified period (at most 30 days), in the format of Start date-End date. For example, 20190901-2019091501 indicates that samples generated from September 1 to September 15, 2019 are searched.

    +

score

+

score

String

+

String

Search by confidence.

+

Search by confidence.

slice_thickness

+

slice_thickness

String

+

String

DICOM layer thickness. Samples are filtered by layer thickness.

+

DICOM layer thickness. Samples are filtered by layer thickness.

study_date

+

study_date

String

+

String

DICOM scanning time.

+

DICOM scanning time.

time_in_video

+

time_in_video

String

+

String

A time point in the video.

+

A time point in the video.

-
Table 6 SearchLabels

Parameter

+
- - - - - - - -
Table 6 SearchLabels

Parameter

Type

+

Type

Description

+

Description

labels

+

labels

Array of SearchLabel objects

+

Array of SearchLabel objects

List of label search criteria.

+

List of label search criteria.

op

+

op

String

+

String

If you want to search for multiple labels, op must be specified. If you search for only one label, op can be left blank. The options are as follows:

-
  • OR: OR operation
  • AND: AND operation
+

If you want to search for multiple labels, op must be specified. If you search for only one label, op can be left blank. Options:

+
  • OR: OR operation

    +
  • AND: AND operation

    +
-
Table 7 SearchLabel

Parameter

+
- - - - - - - - - - - - - -
Table 7 SearchLabel

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Label name.

+

Label name.

op

+

op

String

+

String

Operation type between multiple attributes. The options are as follows:

-
  • OR: OR operation
  • AND: AND operation
+

Operation type between multiple attributes. Options:

+
  • OR: OR operation

    +
  • AND: AND operation

    +

property

+

property

Map<String,Array<String>>

+

Map<String,Array<String>>

Label attribute, which is in the Object format and stores any key-value pairs. key indicates the attribute name, and value indicates the value list. If value is null, the search is not performed by value. Otherwise, the search value can be any value in the list.

+

Label attribute, which is in the Object format and stores any key-value pairs. key indicates the attribute name, and value indicates the value list. If value is null, the search is not performed by value. Otherwise, the search value can be any value in the list.

type

+

type

Integer

+

Integer

Label type. The options are as follows:

-
  • 0: image classification
  • 1: object detection
  • 100: text classification
  • 101: named entity recognition
  • 102: text triplet relationship
  • 103: text triplet entity
  • 200: speech classification
  • 201: speech content
  • 202: speech paragraph labeling
  • 600: video classification
+

Label type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet relationship

    +
  • 103: text triplet entity

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 600: video labeling

    +
-
Table 8 SearchProp

Parameter

+
- - - - - - - -
Table 8 SearchProp

Parameter

Type

+

Type

Description

+

Description

op

+

op

String

+

String

Relationship between attribute values. The options are as follows:

-
  • AND: AND relationship
  • OR: OR relationship
+

Relationship between attribute values. Options:

+
  • AND: AND relationship

    +
  • OR: OR relationship

    +

props

+

props

Map<String,Array<String>>

+

Map<String,Array<String>>

Search criteria of an attribute. Multiple search criteria can be set.

+

Search criteria of an attribute. Multiple search criteria can be set.

-
Table 9 Flavor

Parameter

+
- - - - -
Table 9 Flavor

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

Attribute code of a resource specification, which is used for task creating.

+

Attribute code of a resource specification, which is used for task creating.

-
Table 10 InfConfig

Parameter

+
- - - - - - - - - - - - - - - - -
Table 10 InfConfig

Parameter

Type

+

Type

Description

+

Description

envs

+

envs

Map<String,String>

+

Map<String,String>

(Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables.

+

(Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information in environment variables.

instance_count

+

instance_count

Integer

+

Integer

Instance number of model deployment, that is, the number of compute nodes.

+

Instance number of model deployment, that is, the number of compute nodes.

model_id

+

model_id

String

+

String

Model ID.

+

Model ID.

specification

+

specification

String

+

String

Resource specifications of real-time services. For details, see Deploying Services.

+

Resource specifications of real-time services. For details, see Deploying Services.

weight

+

weight

Integer

+

Integer

Traffic weight allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of the weights must be 100.

+

Traffic weight allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of the weights must be 100.

-
Table 11 TrainingParameter

Parameter

+
- - - - - - - -
Table 11 TrainingParameter

Parameter

Type

+

Type

Description

+

Description

label

+

label

String

+

String

Parameter name.

+

Parameter name.

value

+

value

String

+

String

Parameter value.

+

Parameter value.

-
Table 12 Result

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 Result

Parameter

Type

+

Type

Description

+

Description

annotated_sample_count

+

annotated_sample_count

Integer

+

Integer

Number of labeled samples.

+

Number of labeled samples.

confidence_scope

+

confidence_scope

String

+

String

Confidence range.

+

Confidence range.

dataset_name

+

dataset_name

String

+

String

Dataset name.

+

Dataset name.

dataset_type

+

dataset_type

String

+

String

Dataset type. The options are as follows:

-
  • 0: image classification
  • 1: object detection
  • 100: text classification
  • 101: named entity recognition
  • 102: text triplet
  • 200: sound classification
  • 201: speech content
  • 202: speech paragraph labeling
  • 400: table dataset
  • 600: video labeling
  • 900: custom format
+

Dataset type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 400: table dataset

    +
  • 600: video labeling

    +
  • 900: custom format

    +

description

+

description

String

+

String

Description.

+

Description.

dlf_model_job_name

+

dlf_model_job_name

String

+

String

Name of a DLF model inference job.

+

Name of a DLF model inference job.

dlf_service_job_name

+

dlf_service_job_name

String

+

String

Name of a DLF real-time service job.

+

Name of a DLF real-time service job.

dlf_train_job_name

+

dlf_train_job_name

String

+

String

Name of a DLF training job.

+

Name of a DLF training job.

events

+

events

Array of Event objects

+

Array of Event objects

Event.

+

Event.

hard_example_path

+

hard_example_path

String

+

String

Path for storing hard examples.

+

Path for storing hard examples.

hard_select_tasks

+

hard_select_tasks

Array of HardSelectTask objects

+

Array of HardSelectTask objects

Selected task list of hard examples.

+

Selected task list of hard examples.

manifest_path

+

manifest_path

String

+

String

Path for storing the manifest files.

+

Path for storing the manifest files.

model_id

+

model_id

String

+

String

Model ID.

+

Model ID.

model_name

+

model_name

String

+

String

Model name.

+

Model name.

model_version

+

model_version

String

+

String

Model version.

+

Model version.

samples

+

samples

Array of SampleLabels objects

+

Array of SampleLabels objects

Inference result of the real-time video service.

+

Inference result of the real-time video service.

service_id

+

service_id

String

+

String

ID of a real-time service.

+

ID of a real-time service.

service_name

+

service_name

String

+

String

Name of a real-time service.

+

Name of a real-time service.

service_resource

+

service_resource

String

+

String

ID of the real-time service bound to a user.

+

ID of the real-time service bound to a user.

total_sample_count

+

total_sample_count

Integer

+

Integer

Total number of samples.

+

Total number of samples.

train_data_path

+

train_data_path

String

+

String

Path for storing training data.

+

Path for storing training data.

train_job_id

+

train_job_id

String

+

String

ID of a training job.

+

ID of a training job.

train_job_name

+

train_job_name

String

+

String

Name of a training job.

+

Name of a training job.

unconfirmed_sample_count

+

unconfirmed_sample_count

Integer

+

Integer

Number of samples to be confirmed.

+

Number of samples to be confirmed.

version_id

+

version_id

String

+

String

Dataset version ID.

+

Dataset version ID.

version_name

+

version_name

String

+

String

Dataset version name.

+

Dataset version name.

workspace_id

+

workspace_id

String

+

String

Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

+

Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

-
Table 13 Event

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 13 Event

Parameter

Type

+

Type

Description

+

Description

create_time

+

create_time

Long

+

Long

Time when an event is created.

+

Time when an event is created.

description

+

description

String

+

String

Description.

+

Description.

elapsed_time

+

elapsed_time

Long

+

Long

Time when an event is executed.

+

Time when an event is executed

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_message

+

error_message

String

+

String

Error message.

+

Error message.

events

+

events

Array of Event objects

+

Array of Event objects

Subevent list.

+

Subevent list.

level

+

level

Integer

+

Integer

Event severity.

+

Event severity.

name

+

name

String

+

String

Event name.

+

Event name.

ordinal

+

ordinal

Integer

+

Integer

Sequence number.

+

Sequence number.

parent_name

+

parent_name

String

+

String

Parent event name.

+

Parent event name.

status

+

status

String

+

String

Status. The options are as follows:

-
  • waiting: waiting
  • running: running
  • failed: failed
  • success: successful
+

Status. Options:

+
  • waiting: waiting

    +
  • running: running

    +
  • failed: failed

    +
  • success: successful

    +
-
Table 14 HardSelectTask

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 14 HardSelectTask

Parameter

Type

+

Type

Description

+

Description

create_at

+

create_at

Long

+

Long

Creation time.

+

Creation time.

dataset_id

+

dataset_id

String

+

String

Dataset ID.

+

Dataset ID.

dataset_name

+

dataset_name

String

+

String

Dataset name.

+

Dataset name.

hard_select_task_id

+

hard_select_task_id

String

+

String

ID of a hard example filtering task.

+

ID of a hard example filtering task.

task_status

+

task_status

String

+

String

Task status.

+

Task status.

time

+

time

Long

+

Long

Execution time.

+

Execution time.

update_at

+

update_at

Long

+

Long

Update time.

+

Update time.

-
Table 15 SampleLabels

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 15 SampleLabels

Parameter

Type

+

Type

Description

+

Description

labels

+

labels

Array of SampleLabel objects

+

Array of SampleLabel objects

Sample label list. If this parameter is left blank, all sample labels are deleted.

+

Sample label list. If this parameter is left blank, all sample labels are deleted.

metadata

+

metadata

SampleMetadata object

+

SampleMetadata object

Key-value pair of the sample metadata attribute.

+

Key-value pair of the sample metadata attribute.

sample_id

+

sample_id

String

+

String

Sample ID.

+

Sample ID.

sample_type

+

sample_type

Integer

+

Integer

Sample type. The options are as follows:

-
  • 0: image
  • 1: text
  • 2: speech
  • 4: table
  • 6: video
  • 9: custom format
+

Sample type. Options:

+
  • 0: image

    +
  • 1: text

    +
  • 2: speech

    +
  • 4: table

    +
  • 6: video

    +
  • 9: custom format

    +

sample_usage

+

sample_usage

String

+

String

Sample usage. The options are as follows:

-
  • TRAIN: training
  • EVAL: evaluation
  • TEST: test
  • INFERENCE: inference
+

Sample usage. Options:

+
  • TRAIN: training

    +
  • EVAL: evaluation

    +
  • TEST: test

    +
  • INFERENCE: inference

    +

source

+

source

String

+

String

Source address of sample data.

+

Source address of sample data.

worker_id

+

worker_id

String

+

String

ID of a labeling team member.

+

ID of a labeling team member.

-
Table 16 SampleLabel

Parameter

+
- - - - - - - - - - - - - - - - - - - -
Table 16 SampleLabel

Parameter

Type

+

Type

Description

+

Description

annotated_by

+

annotated_by

String

+

String

Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows:

-
  • human: manual labeling
  • auto: automatic labeling
+

Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. Options:

+
  • human: manual labeling

    +
  • auto: automatic labeling

    +

id

+

id

String

+

String

Label ID.

+

Label ID.

name

+

name

String

+

String

Label name.

+

Label name.

property

+

property

SampleLabelProperty object

+

SampleLabelProperty object

Attribute key-value pair of the sample label, such as the object shape and shape feature.

+

Attribute key-value pair of the sample label, such as the object shape and shape feature.

score

+

score

Float

+

Float

Confidence.

+

Confidence.

type

+

type

Integer

+

Integer

Label type. The options are as follows:

-
  • 0: image classification
  • 1: object detection
  • 100: text classification
  • 101: named entity recognition
  • 102: text triplet relationship
  • 103: text triplet entity
  • 200: speech classification
  • 201: speech content
  • 202: speech paragraph labeling
  • 600: video classification
+

Label type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet relationship

    +
  • 103: text triplet entity

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 600: video labeling

    +
-
Table 17 SampleLabelProperty

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 SampleLabelProperty

Parameter

Type

+

Type

Description

+

Description

@modelarts:content

+

@modelarts:content

String

+

String

Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points).

+

Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points).

@modelarts:end_index

+

@modelarts:end_index

Integer

+

Integer

End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Examples are as follows.- If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the start_index and end_index values of "Barack Hussein Obama II" are 0 and 23, respectively.- If the text content is "By the end of 2018, the company has more than 100 employees.", the start_index and end_index values of "By the end of 2018" are 0 and 18, respectively.

+

End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Example:

+
  • If the text is "Barack Hussein Obama II (born August 4, 1961) is an attorney and politician.", start_index and end_index of Barack Hussein Obama II are 0 and 23, respectively.

    +
  • If the text is "Hope is the thing with feathers", start_index and end_index of Hope are 0 and 4, respectively.

    +

@modelarts:end_time

+

@modelarts:end_time

String

+

String

Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

+

Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

@modelarts:feature

+

@modelarts:feature

Object

+

Object

Shape feature, which is a default attribute dedicated to the object detection label, with type of List. The upper left corner of an image is used as the coordinate origin [0,0]. Each coordinate point is represented by [x, y]. x indicates the horizontal coordinate, and y indicates the vertical coordinate (both x and y are greater than or equal to 0). The format of each shape is as follows:- bndbox: consists of two points, for example, [[0,10],[50,95]]. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point.- polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].- circle: consists of the center point and radius, for example, [[100,100],[50]].- line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- point: consists of one point, for example, [[0,100]].- polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]].

+

Shape feature, which is a default attribute dedicated to the object detection label, with type of List. The upper left corner of the image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y], where x indicates the horizontal coordinate and y indicates the vertical coordinate (both x and y are >=0). The format of each shape is as follows:

+
  • bndbox consists of two points, for example, [[0,10],[50,95]]. The upper left vertex of the rectangle is the first point, and the lower right vertex is the second point. That is, the x-coordinate of the first point must be less than the x-coordinate of the second point, and the y-coordinate of the first point must be less than the y-coordinate of the second point.

    +
  • polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].

    +
  • circle: consists of the center and radius, for example, [[100,100],[50]].

    +
  • line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    +
  • dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    +
  • point: consists of one point, for example, [[0,100]].

    +
  • polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]].

    +

@modelarts:from

+

@modelarts:from

String

+

String

ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.

+

ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.

@modelarts:hard

+

@modelarts:hard

String

+

String

Sample labeled as a hard sample or not, which is a default attribute. Options:

-
  • 0/false: not a hard example
  • 1/true: hard example
+

Sample labeled as a hard sample or not, which is a default attribute. Options:

+
  • 0/false: not a hard example

    +
  • 1/true: hard example

    +

@modelarts:hard_coefficient

+

@modelarts:hard_coefficient

String

+

String

Coefficient of difficulty of each label level, which is a default attribute. The value range is [0,1].

+

Coefficient of difficulty of each label level, which is a default attribute. The value range is [0,1].

@modelarts:hard_reasons

+

@modelarts:hard_reasons

String

+

String

Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, 3-20-21-19. The options are as follows:

-
  • 0: No target objects are identified.
  • 1: The confidence is low.
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.
  • 4: The prediction results of multiple consecutive similar images are inconsistent.
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.
  • 19: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image.
  • 20: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image.
  • 21: The data enhancement result based on Crop is inconsistent with the prediction result of the original image.
  • 22: The data enhancement result based on flipud is inconsistent with the prediction result of the original image.
  • 23: The data enhancement result based on scale is inconsistent with the prediction result of the original image.
  • 24: The data enhancement result based on translate is inconsistent with the prediction result of the original image.
  • 25: The data enhancement result based on shear is inconsistent with the prediction result of the original image.
  • 26: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image.
  • 27: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image.
  • 28: The data enhancement result based on add is inconsistent with the prediction result of the original image.
  • 29: The data enhancement result based on invert is inconsistent with the prediction result of the original image.
  • 30: The data is predicted to be abnormal.
+

Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, 3-20-21-19. Options:

+
  • 0: No target objects are identified.

    +
  • 1: The confidence is low.

    +
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    +
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    +
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    +
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    +
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    +
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    +
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    +
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    +
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    +
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    +
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    +
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    +
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    +
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    +
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    +
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    +
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    +
  • 19: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image.

    +
  • 20: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image.

    +
  • 21: The data enhancement result based on Crop is inconsistent with the prediction result of the original image.

    +
  • 22: The data enhancement result based on flipud is inconsistent with the prediction result of the original image.

    +
  • 23: The data enhancement result based on scale is inconsistent with the prediction result of the original image.

    +
  • 24: The data enhancement result based on translate is inconsistent with the prediction result of the original image.

    +
  • 25: The data enhancement result based on shear is inconsistent with the prediction result of the original image.

    +
  • 26: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image.

    +
  • 27: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image.

    +
  • 28: The data enhancement result based on add is inconsistent with the prediction result of the original image.

    +
  • 29: The data enhancement result based on invert is inconsistent with the prediction result of the original image.

    +
  • 30: The data is predicted to be abnormal.

    +

@modelarts:shape

+

@modelarts:shape

String

+

String

Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows:

-
  • bndbox: rectangle
  • polygon: polygon
  • circle: circle
  • line: straight line
  • dashed: dotted line
  • point: point
  • polyline: polyline
+

Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. Options:

+
  • bndbox: rectangle

    +
  • polygon: polygon

    +
  • circle: circle

    +
  • line: straight line

    +
  • dashed: dotted line

    +
  • point: point

    +
  • polyline: polyline

    +

@modelarts:source

+

@modelarts:source

String

+

String

Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator.

+

Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator.

@modelarts:start_index

+

@modelarts:start_index

Integer

+

Integer

Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index.

+

Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index.

@modelarts:start_time

+

@modelarts:start_time

String

+

String

Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

+

Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

@modelarts:to

+

@modelarts:to

String

+

String

ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.

+

ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label.

-
Table 18 SampleMetadata

Parameter

+
- - - - - - - - - - - - - - + + + +
Table 18 SampleMetadata

Parameter

Type

+

Type

Description

+

Description

@modelarts:hard

+

@modelarts:import_origin

Double

+

Integer

Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows:

-
  • 0: non-hard sample
  • 1: hard sample
+

Sample source, which is a built-in attribute.

@modelarts:hard_coefficient

+

@modelarts:hard

Double

+

Double

Coefficient of difficulty of each sample level, which is a default attribute. The value range is [0,1].

+

Whether the sample is labeled as a hard sample, which is a default attribute. Options:

+
  • 0: non-hard sample

    +
  • 1: hard sample

    +

@modelarts:hard_reasons

+

@modelarts:hard_coefficient

Array of integers

+

Double

ID of a hard sample reason, which is a default attribute. The options are as follows:

-
  • 0: No target objects are identified.
  • 1: The confidence is low.
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.
  • 4: The prediction results of multiple consecutive similar images are inconsistent.
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.
  • 19: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image.
  • 20: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image.
  • 21: The data enhancement result based on Crop is inconsistent with the prediction result of the original image.
  • 22: The data enhancement result based on flipud is inconsistent with the prediction result of the original image.
  • 23: The data enhancement result based on scale is inconsistent with the prediction result of the original image.
  • 24: The data enhancement result based on translate is inconsistent with the prediction result of the original image.
  • 25: The data enhancement result based on shear is inconsistent with the prediction result of the original image.
  • 26: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image.
  • 27: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image.
  • 28: The data enhancement result based on add is inconsistent with the prediction result of the original image.
  • 29: The data enhancement result based on invert is inconsistent with the prediction result of the original image.
  • 30: The data is predicted to be abnormal.
+

Coefficient of difficulty of each sample level, which is a default attribute. The value range is [0,1].

@modelarts:size

+

@modelarts:hard_reasons

Array of objects

+

Array of integers

Image size (width, height, and depth of the image), which is a default attribute, with type of List. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label.

+

ID of a hard sample reason, which is a default attribute. Options:

+
  • 0: No object is identified.

    +
  • 1: The confidence is low.

    +
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    +
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    +
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    +
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    +
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    +
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    +
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    +
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    +
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    +
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    +
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    +
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    +
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    +
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    +
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    +
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    +
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    +
  • 19: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image.

    +
  • 20: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image.

    +
  • 21: The data enhancement result based on Crop is inconsistent with the prediction result of the original image.

    +
  • 22: The data enhancement result based on flipud is inconsistent with the prediction result of the original image.

    +
  • 23: The data enhancement result based on scale is inconsistent with the prediction result of the original image.

    +
  • 24: The data enhancement result based on translate is inconsistent with the prediction result of the original image.

    +
  • 25: The data enhancement result based on shear is inconsistent with the prediction result of the original image.

    +
  • 26: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image.

    +
  • 27: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image.

    +
  • 28: The data enhancement result based on add is inconsistent with the prediction result of the original image.

    +
  • 29: The data enhancement result based on invert is inconsistent with the prediction result of the original image.

    +
  • 30: The data is predicted to be abnormal.

    +
+

@modelarts:size

+

Array of objects

+

Image size (width, height, and depth of the image), which is a default attribute, with type of List<Integer>. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label.

-

Example Requests

Obtaining Information About an Auto Labeling (Active Learning) Task

-
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}
+

Example Requests

Obtaining Information About an Auto Labeling (Active Learning) Task

+
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}
-

Example Responses

Status code: 200

-

OK

-
{
+

Example Responses

Status code: 200

+

OK

+
{
   "resource_id" : "XGrRZuCV1qmMxnsmD5u",
   "create_time" : "2020-11-23 11:08:20",
   "progress" : 10.0,
@@ -1492,8 +1694,7 @@
   "elapsed_time" : 0,
   "result" : {
     "total_sample_count" : 49,
-    "annotated_sample_count" : 30,
-    "continuity" : false
+    "annotated_sample_count" : 30
   },
   "export_type" : 0,
   "config" : {
@@ -1506,43 +1707,43 @@
   }
 }
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

404

+

404

Not Found

+

Not Found

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/modelarts/api-ref/BatchDeletePoolNodes.html b/docs/modelarts/api-ref/BatchDeletePoolNodes.html new file mode 100644 index 00000000..3e3c4f50 --- /dev/null +++ b/docs/modelarts/api-ref/BatchDeletePoolNodes.html @@ -0,0 +1,136 @@ + + +

Deleting nodes in batches

+

Function

Delete nodes in a specific resource pool. At least one node must be reserved in the resource pool.

+
+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

pool_name

+

Yes

+

String

+

Resource pool name.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

deleteNodeNames

+

Yes

+

Array of strings

+

Names of the nodes to be deleted.

+
+
+
+

Response Parameters

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Requests

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-delete
+
+{
+  "deleteNodeNames" : [ "os-node-created-mnmcf" ]
+}
+
+

Example Responses

Status code: 404

+

Not Found.

+
{
+  "error_code" : "ModelArts.50015001",
+  "error_msg" : "pool not found"
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

OK.

+

404

+

Not Found.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/modelarts/api-ref/DeleteWorkers.html b/docs/modelarts/api-ref/BatchDeleteWorkers.html similarity index 58% rename from docs/modelarts/api-ref/DeleteWorkers.html rename to docs/modelarts/api-ref/BatchDeleteWorkers.html index bdb3cb3b..d8a156b5 100644 --- a/docs/modelarts/api-ref/DeleteWorkers.html +++ b/docs/modelarts/api-ref/BatchDeleteWorkers.html @@ -1,36 +1,38 @@ - +

Deleting Labeling Team Members in Batches

-

Function

This API is used to delete labeling team members in batches.

+

Function

This API is used to delete labeling team members in batches.

-

URI

POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete

-
Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - @@ -38,23 +40,23 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

workforce_id

+

workforce_id

Yes

+

Yes

String

+

String

ID of a labeling team.

+

ID of a labeling team.

Table 2 Request body parameters

Parameter

+
- - - - - - - @@ -63,40 +65,40 @@

Response Parameters

Status code: 200

-
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

workers

+

workers

No

+

Yes

Array of strings

+

Array of strings

Team member ID list.

+

Team member ID list.

Table 3 Response body parameters

Parameter

+
- - - - - - - - - - - - - -
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.

results

+

results

Array of BatchResponse objects

+

Array of BatchResponse objects

Result of deleting team members in batches.

+

Result of deleting team members in batches.

success

+

success

Boolean

+

Boolean

Check whether the operation is successful. The options are as follows:

+

Check whether the operation is successful. Options:

  • true: The operation is successful.

  • false: The operation is failed.

@@ -106,33 +108,33 @@
-
Table 4 BatchResponse

Parameter

+
- - - - - - - - - - -
Table 4 BatchResponse

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.

success

+

success

Boolean

+

Boolean

Check whether the operation is successful. The options are as follows:

+

Check whether the operation is successful. Options:

  • true: The operation is successful.

  • false: The operation is failed.

@@ -159,30 +161,30 @@ }

Status Codes

-

Status Code

+
- - - - - - - - - @@ -194,7 +196,7 @@
diff --git a/docs/modelarts/api-ref/CLASS.TXT.json b/docs/modelarts/api-ref/CLASS.TXT.json index fbde4b31..3ef11c4e 100644 --- a/docs/modelarts/api-ref/CLASS.TXT.json +++ b/docs/modelarts/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise admin", "product_code":"modelarts", "title":"Endpoint", "uri":"modelarts_03_0141.html", @@ -35,6 +35,15 @@ "p_code":"1", "code":"4" }, + { + "desc":"For more constraints, see API description.", + "product_code":"modelarts", + "title":"Constraints", + "uri":"modelarts_03_0142.html", + "doc_type":"api", + "p_code":"1", + "code":"5" + }, { "desc":"AccountAn account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It", "product_code":"modelarts", @@ -42,16 +51,16 @@ "uri":"modelarts_03_0143.html", "doc_type":"api", "p_code":"1", - "code":"5" + "code":"6" }, { - "desc":"All ModelArts APIs are proprietary.Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets a", + "desc":"All ModelArts APIs are proprietary.You can use these APIs to manage datasets, training jobs, models, and services.", "product_code":"modelarts", "title":"API Overview", "uri":"modelarts_03_0002.html", "doc_type":"api", "p_code":"", - "code":"6" + "code":"7" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -60,7 +69,7 @@ "uri":"modelarts_03_0144.html", "doc_type":"api", "p_code":"", - "code":"7" + "code":"8" }, { "desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", @@ -68,8 +77,8 @@ "title":"Making an API Request", "uri":"modelarts_03_0005.html", "doc_type":"api", - "p_code":"7", - "code":"8" + "p_code":"8", + "code":"9" }, { "desc":"Requests for calling an API can be authenticated using either of the following methods: AK/SK-based authentication: Requests are authenticated by encrypting the request b", @@ -77,8 +86,8 @@ "title":"Authentication", "uri":"modelarts_03_0004.html", "doc_type":"api", - "p_code":"7", - "code":"9" + "p_code":"8", + "code":"10" }, { "desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", @@ -86,305 +95,233 @@ "title":"Response", "uri":"modelarts_03_0003.html", "doc_type":"api", - "p_code":"7", - "code":"10" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Data Management", - "uri":"modelarts_03_0202.html", - "doc_type":"api", - "p_code":"", + "p_code":"8", "code":"11" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", - "title":"Data Management APIs", - "uri":"modelarts_03_0299.html", + "title":"Data Management", + "uri":"dataset_management.html", "doc_type":"api", - "p_code":"11", + "p_code":"", "code":"12" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Dataset Management", - "uri":"dataset_management.html", - "doc_type":"api", - "p_code":"11", - "code":"13" - }, - { - "desc":"This API is used to query the created datasets that meet the search criteria by page.GET /v2/{project_id}/datasetsNoneStatus code: 200Querying the Dataset ListStatus code", + "desc":"This API is used to query the created datasets that meet the search criteria by page.You can debug this API through automatic authentication in or use the SDK sample cod", "product_code":"modelarts", "title":"Querying the Dataset List", "uri":"ListDatasets.html", "doc_type":"api", - "p_code":"13", - "code":"14" + "p_code":"12", + "code":"13" }, { - "desc":"This API is used to create a dataset.POST /v2/{project_id}/datasetsStatus code: 201Creating an Image Classification Dataset{\n \"workspace_id\" : \"0\",\n \"dataset_name\" : \"d", + "desc":"This API is used to create a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{project_id", "product_code":"modelarts", "title":"Creating a Dataset", "uri":"CreateDataset.html", "doc_type":"api", - "p_code":"13", - "code":"15" + "p_code":"12", + "code":"14" }, { - "desc":"This API is used to query details about a dataset.GET /v2/{project_id}/datasets/{dataset_id}NoneStatus code: 200Querying Details About a DatasetStatus code: 200OKSee Erro", + "desc":"This API is used to query details about a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "product_code":"modelarts", "title":"Querying Details About a Dataset", "uri":"DescDataset.html", "doc_type":"api", - "p_code":"13", - "code":"16" + "p_code":"12", + "code":"15" }, { - "desc":"This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels.PUT /v2/{project_id}/datasets/{dataset_id", + "desc":"This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels.You can debug this API through automatic ", "product_code":"modelarts", "title":"Modifying a Dataset", "uri":"UpdateDataset.html", "doc_type":"api", - "p_code":"13", - "code":"17" + "p_code":"12", + "code":"16" }, { - "desc":"This API is used to delete a dataset without deleting the source data of the dataset.DELETE /v2/{project_id}/datasets/{dataset_id}NoneNoneDeleting a DatasetStatus code: 2", + "desc":"This API is used to delete a dataset without deleting the source data of the dataset.You can debug this API through automatic authentication in or use the SDK sample cod", "product_code":"modelarts", "title":"Deleting a Dataset", "uri":"DeleteDataset.html", "doc_type":"api", - "p_code":"13", + "p_code":"12", + "code":"17" + }, + { + "desc":"This API is used to query dataset statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{pro", + "product_code":"modelarts", + "title":"Querying Dataset Statistics", + "uri":"GetDatasetStats.html", + "doc_type":"api", + "p_code":"12", "code":"18" }, { - "desc":"This API is used to query dataset statistics.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/statsNoneStatus code: 200Querying Dataset StatisticsStatus code: ", - "product_code":"modelarts", - "title":"Querying Dataset Statistics", - "uri":"ListStats.html", - "doc_type":"api", - "p_code":"13", - "code":"19" - }, - { - "desc":"This API is used to query the monitoring data of a dataset within a specified time range.GET /v2/{project_id}/datasets/{dataset_id}/metricsNoneStatus code: 200Querying th", + "desc":"This API is used to query the monitoring data of a dataset within a specified time range.You can debug this API through automatic authentication in or use the SDK sample", "product_code":"modelarts", "title":"Querying the Monitoring Data of a Dataset", "uri":"GetDatasetMetrics.html", "doc_type":"api", - "p_code":"13", - "code":"20" + "p_code":"12", + "code":"19" }, { - "desc":"This API is used to query details about team labeling task statistics.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/stat", - "product_code":"modelarts", - "title":"Querying Details About Team Labeling Task Statistics", - "uri":"ListWorkforceTaskStats.html", - "doc_type":"api", - "p_code":"13", - "code":"21" - }, - { - "desc":"This API is used to query details about the progress of a team labeling task member.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics", - "product_code":"modelarts", - "title":"Querying Details About the Progress of a Team Labeling Task Member", - "uri":"GetWorkforceTaskMetrics.html", - "doc_type":"api", - "p_code":"13", - "code":"22" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Dataset Version Management", - "uri":"dataset_version_management.html", - "doc_type":"api", - "p_code":"11", - "code":"23" - }, - { - "desc":"This API is used to query the version list of a specific dataset.GET /v2/{project_id}/datasets/{dataset_id}/versionsNoneStatus code: 200Querying the Version List of a Spe", + "desc":"This API is used to query the version list of a specific dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "product_code":"modelarts", "title":"Querying the Dataset Version List", "uri":"ListDatasetVersions.html", "doc_type":"api", - "p_code":"23", - "code":"24" + "p_code":"12", + "code":"20" }, { - "desc":"This API is used to create a dataset labeling version.POST /v2/{project_id}/datasets/{dataset_id}/versionsStatus code: 201Creating a Dataset Labeling VersionStatus code: ", + "desc":"This API is used to create a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POS", "product_code":"modelarts", "title":"Creating a Dataset Labeling Version", "uri":"CreateDatasetVersion.html", "doc_type":"api", - "p_code":"23", - "code":"25" + "p_code":"12", + "code":"21" }, { - "desc":"This API is used to query the details about a dataset version.GET /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneStatus code: 200Querying Details About a", + "desc":"This API is used to query the details about a dataset version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "product_code":"modelarts", "title":"Querying Details About a Dataset Version", "uri":"DescribeDatasetVersion.html", "doc_type":"api", - "p_code":"23", - "code":"26" + "p_code":"12", + "code":"22" }, { - "desc":"This API is used to delete a dataset labeling version.DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneNoneDeleting a Dataset Labeling VersionStatus", + "desc":"This API is used to delete a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DEL", "product_code":"modelarts", "title":"Deleting a Dataset Labeling Version", "uri":"DeleteDatasetVersion.html", "doc_type":"api", - "p_code":"23", - "code":"27" + "p_code":"12", + "code":"23" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Sample Management", - "uri":"sample_management.html", - "doc_type":"api", - "p_code":"11", - "code":"28" - }, - { - "desc":"This API is used to query the sample list by page.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesNoneStatus code: 200Querying the Sample List by PageS", + "desc":"This API is used to query the sample list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "product_code":"modelarts", "title":"Querying the Sample List", "uri":"ListSamples.html", "doc_type":"api", - "p_code":"28", - "code":"29" + "p_code":"12", + "code":"24" }, { - "desc":"This API is used to add samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesStatus code: 200Adding Samples in BatchesStatus code: 200OK", + "desc":"This API is used to add samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "product_code":"modelarts", "title":"Adding Samples in Batches", "uri":"UploadSamplesJson.html", "doc_type":"api", - "p_code":"28", - "code":"30" + "p_code":"12", + "code":"25" }, { - "desc":"This API is used to delete samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/deleteStatus code: 200Deleting Samples in BatchesStatus", + "desc":"This API is used to delete samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{p", "product_code":"modelarts", "title":"Deleting Samples in Batches", "uri":"DeleteSamples.html", "doc_type":"api", - "p_code":"28", - "code":"31" + "p_code":"12", + "code":"26" }, { - "desc":"Query details about a sample.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}NoneStatus code: 200Querying Details About a SampleStatus code", + "desc":"Query details about a sample.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project_id}/dataset", "product_code":"modelarts", "title":"Querying Details About a Sample", "uri":"DescribeSample.html", "doc_type":"api", - "p_code":"28", - "code":"32" + "p_code":"12", + "code":"27" }, { - "desc":"This API is used to obtain sample search condition.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-conditionNoneStatus code: 200Obtaining Sample Search", + "desc":"This API is used to obtain sample search condition.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v", "product_code":"modelarts", "title":"Obtaining Sample Search Condition", "uri":"ListSearch.html", "doc_type":"api", - "p_code":"28", - "code":"33" + "p_code":"12", + "code":"28" }, { - "desc":"This API is used to query the sample list of a team labeling task by page.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/", + "desc":"This API is used to query the sample list of a team labeling task by page.You can debug this API through automatic authentication in or use the SDK sample code generated", "product_code":"modelarts", "title":"Querying the Sample List of a Team Labeling Task by Page", "uri":"ListWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"28", - "code":"34" + "p_code":"12", + "code":"29" }, { - "desc":"This API is used to query details about team labeling samples.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sam", + "desc":"This API is used to obtain samples labeled by a team. The API can be called only after an acceptance task is initiated.You can debug this API through automatic authentica", "product_code":"modelarts", "title":"Querying Details About Team Labeling Samples", "uri":"DescribeWorkforceTaskSample.html", "doc_type":"api", - "p_code":"28", - "code":"35" + "p_code":"12", + "code":"30" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Label Management", - "uri":"label_management.html", - "doc_type":"api", - "p_code":"11", - "code":"36" - }, - { - "desc":"This API is used to query all labels of a dataset.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsNoneStatus code: 200Querying All Labels of a DatasetSt", + "desc":"This API is used to query all labels of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2", "product_code":"modelarts", "title":"Querying the Dataset Label List", "uri":"ListLabels.html", "doc_type":"api", - "p_code":"36", - "code":"37" + "p_code":"12", + "code":"31" }, { - "desc":"This API is used to create a dataset label.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Creating a Dataset LabelStatus code: 200OKSe", + "desc":"This API is used to create a dataset label.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "product_code":"modelarts", "title":"Creating a Dataset Label", "uri":"CreateLabels.html", "doc_type":"api", - "p_code":"36", - "code":"38" + "p_code":"12", + "code":"32" }, { - "desc":"This API is used to modify labels in batches.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Modifying Labels in BatchesStatus code: 200", + "desc":"This API is used to modify labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{pro", "product_code":"modelarts", "title":"Modifying Labels in Batches", "uri":"UpdateLabels.html", "doc_type":"api", - "p_code":"36", - "code":"39" + "p_code":"12", + "code":"33" }, { - "desc":"This API is used to delete labels in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/deleteStatus code: 200Deleting Labels in BatchesStatus co", + "desc":"This API is used to delete labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{pr", "product_code":"modelarts", "title":"Deleting Labels in Batches", "uri":"DeleteLabels.html", "doc_type":"api", - "p_code":"36", - "code":"40" + "p_code":"12", + "code":"34" }, { - "desc":"This API is used to update a label by label names.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}Status code: 204Updating a Label by Label", + "desc":"This API is used to update a label by label names.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2", "product_code":"modelarts", "title":"Updating a Label by Label Names", "uri":"UpdateLabel.html", "doc_type":"api", - "p_code":"36", - "code":"41" + "p_code":"12", + "code":"35" }, { - "desc":"This API is used to delete a label and the files that only contain this label.DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}NoneStatus", + "desc":"This API is used to delete a label and the files that only contain this label.You can debug this API through automatic authentication in or use the SDK sample code gener", "product_code":"modelarts", "title":"Deleting a Label and the Files that Only Contain the Label", "uri":"DeleteLabelAndSamples.html", "doc_type":"api", - "p_code":"36", - "code":"42" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Manual Labeling", - "uri":"manual_annotation_management.html", - "doc_type":"api", - "p_code":"11", - "code":"43" + "p_code":"12", + "code":"36" }, { "desc":"This API is used to update sample labels in batches, including adding, modifying, and deleting sample labels. If the parameter Labels of a sample in the request body is n", @@ -392,89 +329,80 @@ "title":"Updating Sample Labels in Batches", "uri":"UpdateSamples.html", "doc_type":"api", - "p_code":"43", - "code":"44" + "p_code":"12", + "code":"37" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Labeling Task Management", - "uri":"label_task_management.html", - "doc_type":"api", - "p_code":"11", - "code":"45" - }, - { - "desc":"This API is used to query the team labeling task list of a dataset.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasksNoneStatus code: 200Querying the Team Labelin", + "desc":"This API is used to query the team labeling task list of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API", "product_code":"modelarts", "title":"Querying the Team Labeling Task List of a Dataset", "uri":"ListWorkforceTasks.html", "doc_type":"api", - "p_code":"45", - "code":"46" + "p_code":"12", + "code":"38" }, { - "desc":"This API is used to create a team labeling task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasksStatus code: 200Creating a Team Labeling TaskStatus code: 200OK", + "desc":"This API is used to create a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/", "product_code":"modelarts", "title":"Creating a Team Labeling Task", "uri":"CreateWorkforceTask.html", "doc_type":"api", - "p_code":"45", - "code":"47" + "p_code":"12", + "code":"39" }, { - "desc":"This API is used to query the details about a team labeling task.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneStatus code: 200Queryin", + "desc":"This API is used to query the details about a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "product_code":"modelarts", "title":"Querying Details About a Team Labeling Task", "uri":"DescWorkforceTask.html", "doc_type":"api", - "p_code":"45", - "code":"48" + "p_code":"12", + "code":"40" }, { - "desc":"This API is used to start a team labeling task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneStarting a Team Labeling TaskStatus code", + "desc":"This API is used to start a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{", "product_code":"modelarts", "title":"Starting a Team Labeling Task", "uri":"StartWorkforceTask.html", "doc_type":"api", - "p_code":"45", - "code":"49" + "p_code":"12", + "code":"41" }, { - "desc":"This API is used to update a team labeling task.PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneUpdating a Team Labeling TaskStatus code", + "desc":"This API is used to update a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{", "product_code":"modelarts", "title":"Updating a Team Labeling Task", "uri":"UpdateWorkforceTask.html", "doc_type":"api", - "p_code":"45", - "code":"50" + "p_code":"12", + "code":"42" }, { - "desc":"This API is used to delete a team labeling task.DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}NoneNoneDeleting a Team Labeling TaskStat", + "desc":"This API is used to delete a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v", "product_code":"modelarts", "title":"Deleting a Team Labeling Task", "uri":"DeleteWorkforceTask.html", "doc_type":"api", - "p_code":"45", - "code":"51" + "p_code":"12", + "code":"43" }, { - "desc":"This API is used to create a team labeling acceptance task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptanceStatus code: 200Creat", + "desc":"This API is used to create a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explore", "product_code":"modelarts", "title":"Creating a Team Labeling Acceptance Task", "uri":"StartWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"45", - "code":"52" + "p_code":"12", + "code":"44" }, { - "desc":"This API is used to query the report of a team labeling acceptance task.GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/reportNo", + "desc":"This API is used to query the report of a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b", "product_code":"modelarts", "title":"Querying the Report of a Team Labeling Acceptance Task", "uri":"GetWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"45", - "code":"53" + "p_code":"12", + "code":"45" }, { "desc":"This API is used to update the sample status by confirming the acceptance scope and whether the labeled data is overwritten before the acceptance of the team labeling tas", @@ -482,629 +410,557 @@ "title":"Updating the Status of a Team Labeling Acceptance Task", "uri":"UpdateWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"45", - "code":"54" + "p_code":"12", + "code":"46" }, { - "desc":"This API is used to query the team labeling task list by a team member.GET /v2/{project_id}/workforces/worker-tasksNoneStatus code: 200Querying the Team Labeling Task Lis", + "desc":"This API is used to query details about team labeling task statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by ", + "product_code":"modelarts", + "title":"Querying Details About Team Labeling Task Statistics", + "uri":"ListWorkforceTaskStats.html", + "doc_type":"api", + "p_code":"12", + "code":"47" + }, + { + "desc":"This API is used to query details about the progress of a team labeling task member.You can debug this API through automatic authentication in or use the SDK sample code", + "product_code":"modelarts", + "title":"Querying Details About the Progress of a Team Labeling Task Member", + "uri":"GetWorkforceTaskMetrics.html", + "doc_type":"api", + "p_code":"12", + "code":"48" + }, + { + "desc":"This API is used to query the team labeling task list by a team member.You can debug this API through automatic authentication in or use the SDK sample code generated by", "product_code":"modelarts", "title":"Querying the Team Labeling Task List by a Team Member", "uri":"ListWorkerTasks.html", "doc_type":"api", - "p_code":"45", - "code":"55" + "p_code":"12", + "code":"49" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Team Labeling Process Management", - "uri":"workforce_process_management.html", - "doc_type":"api", - "p_code":"11", - "code":"56" - }, - { - "desc":"This API is used to submit sample review comments of an acceptance task.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-c", + "desc":"This API is used to submit sample review comments of an acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b", "product_code":"modelarts", "title":"Submitting Sample Review Comments of an Acceptance Task", "uri":"AcceptSamples.html", "doc_type":"api", - "p_code":"56", - "code":"57" + "p_code":"12", + "code":"50" }, { - "desc":"This API is used to review team labeling results.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/reviewNoneReviewing Team", + "desc":"This API is used to review team labeling results.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2", "product_code":"modelarts", "title":"Reviewing Team Labeling Results", "uri":"ReviewSamples.html", "doc_type":"api", - "p_code":"56", - "code":"58" + "p_code":"12", + "code":"51" }, { - "desc":"This API is used to update labels of team labeling samples in batches.PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samp", + "desc":"This API is used to update labels of team labeling samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by ", "product_code":"modelarts", "title":"Updating Labels of Team Labeling Samples in Batches", "uri":"UpdateWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"56", - "code":"59" + "p_code":"12", + "code":"52" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Labeling Team Management", - "uri":"workforce_management.html", - "doc_type":"api", - "p_code":"11", - "code":"60" - }, - { - "desc":"This API is used to query the labeling team list.GET /v2/{project_id}/workforcesNoneStatus code: 200Querying the Labeling Team ListStatus code: 200OKSee Error Codes.", + "desc":"This API is used to query the labeling team list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/", "product_code":"modelarts", "title":"Querying the Labeling Team List", "uri":"ListWorkforces.html", "doc_type":"api", - "p_code":"60", - "code":"61" + "p_code":"12", + "code":"53" }, { - "desc":"This API is used to create a labeling team.POST /v2/{project_id}/workforcesStatus code: 201Creating a Labeling TeamStatus code: 201CreatedSee Error Codes.", + "desc":"This API is used to create a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj", "product_code":"modelarts", "title":"Creating a Labeling Team", "uri":"CreateWorkforce.html", "doc_type":"api", - "p_code":"60", - "code":"62" + "p_code":"12", + "code":"54" }, { - "desc":"This API is used to query the details about a labeling team.GET /v2/{project_id}/workforces/{workforce_id}NoneStatus code: 200Querying Details About a Labeling TeamStatus", + "desc":"This API is used to query the details about a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "product_code":"modelarts", "title":"Querying Details About a Labeling Team", "uri":"DescWorkforce.html", "doc_type":"api", - "p_code":"60", - "code":"63" + "p_code":"12", + "code":"55" }, { - "desc":"This API is used to update a labeling team.PUT /v2/{project_id}/workforces/{workforce_id}NoneUpdating a Labeling TeamStatus code: 200OKSee Error Codes.", + "desc":"This API is used to update a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{proje", "product_code":"modelarts", "title":"Updating a Labeling Team", "uri":"UpdateWorkforce.html", "doc_type":"api", - "p_code":"60", - "code":"64" + "p_code":"12", + "code":"56" }, { - "desc":"This API is used to delete a labeling team.DELETE /v2/{project_id}/workforces/{workforce_id}NoneStatus code: 204Deleting a Labeling TeamStatus code: 204No ContentSee Erro", + "desc":"This API is used to delete a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{pr", "product_code":"modelarts", "title":"Deleting a Labeling Team", "uri":"DeleteWorkforce.html", "doc_type":"api", - "p_code":"60", - "code":"65" + "p_code":"12", + "code":"57" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Labeling Team Member Management", - "uri":"workforce_worker_management.html", - "doc_type":"api", - "p_code":"11", - "code":"66" - }, - { - "desc":"This API is used to send an email to a labeling team member.POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/notifyStatus code: 200Sending ", + "desc":"This API is used to send an email to a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "product_code":"modelarts", "title":"Sending an Email to a Labeling Team Member", "uri":"SendEmails.html", "doc_type":"api", - "p_code":"66", - "code":"67" + "p_code":"12", + "code":"58" }, { - "desc":"This API is used to query the list of all labeling team members.GET /v2/{project_id}/workforces/workersNoneStatus code: 200Querying All Labeling Team AdministratorsStatus", + "desc":"This API is used to query the list of all labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex", "product_code":"modelarts", "title":"Querying the List of All Labeling Team Members", "uri":"ListAllWorkers.html", "doc_type":"api", - "p_code":"66", - "code":"68" + "p_code":"12", + "code":"59" }, { - "desc":"This API is used to query the list of labeling team members.GET /v2/{project_id}/workforces/{workforce_id}/workersNoneStatus code: 200Querying the List of Labeling Team M", + "desc":"This API is used to query the list of labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "product_code":"modelarts", "title":"Querying the List of Labeling Team Members", "uri":"ListWorkers.html", "doc_type":"api", - "p_code":"66", - "code":"69" + "p_code":"12", + "code":"60" }, { - "desc":"This API is used to create a labeling team member.POST /v2/{project_id}/workforces/{workforce_id}/workersNoneCreating a Labeling Team MemberStatus code: 201CreatedSee Err", + "desc":"This API is used to create a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v", "product_code":"modelarts", "title":"Creating a Labeling Team Member", "uri":"CreateWorker.html", "doc_type":"api", - "p_code":"66", - "code":"70" + "p_code":"12", + "code":"61" }, { - "desc":"This API is used to delete labeling team members in batches.POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-deleteStatus code: 200Deleting Labeling Team Mem", + "desc":"This API is used to delete labeling team members in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", "product_code":"modelarts", "title":"Deleting Labeling Team Members in Batches", - "uri":"DeleteWorkers.html", + "uri":"BatchDeleteWorkers.html", "doc_type":"api", - "p_code":"66", - "code":"71" + "p_code":"12", + "code":"62" }, { - "desc":"This API is used to query details about labeling team members.GET /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneStatus code: 200Querying Details About", + "desc":"This API is used to query details about labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "product_code":"modelarts", "title":"Querying Details About Labeling Team Members", "uri":"DescWorker.html", "doc_type":"api", - "p_code":"66", - "code":"72" + "p_code":"12", + "code":"63" }, { - "desc":"This API is used to update a labeling team member.PUT /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneUpdating a Labeling Team MemberStatus code: 200OKS", + "desc":"This API is used to update a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2", "product_code":"modelarts", "title":"Updating a Labeling Team Member", "uri":"UpdateWorker.html", "doc_type":"api", - "p_code":"66", - "code":"73" + "p_code":"12", + "code":"64" }, { - "desc":"This API is used to delete a labeling team member.DELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}NoneNoneDeleting a Labeling Team MemberStatus code:", + "desc":"This API is used to delete a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE ", "product_code":"modelarts", "title":"Deleting a Labeling Team Member", "uri":"DeleteWorker.html", "doc_type":"api", - "p_code":"66", - "code":"74" + "p_code":"12", + "code":"65" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Data Import Task", - "uri":"data_import.html", - "doc_type":"api", - "p_code":"11", - "code":"75" - }, - { - "desc":"This API is used to query the dataset import task list by page.GET /v2/{project_id}/datasets/{dataset_id}/import-tasksNoneStatus code: 200Obtaining the Dataset Import Tas", + "desc":"This API is used to query the dataset import task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "product_code":"modelarts", "title":"Querying the Dataset Import Task List", "uri":"ListImportTasks.html", "doc_type":"api", - "p_code":"75", - "code":"76" + "p_code":"12", + "code":"66" }, { - "desc":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/import-ta", + "desc":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.You can debug this API through automatic authenticati", "product_code":"modelarts", "title":"Creating an Import Task", "uri":"ImportTask.html", "doc_type":"api", - "p_code":"75", - "code":"77" + "p_code":"12", + "code":"67" }, { - "desc":"This API is used to query details about a dataset import task.GET /v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id}NoneStatus code: 200Querying Details About ", + "desc":"This API is used to query details about a dataset import task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "product_code":"modelarts", "title":"Querying Details About a Dataset Import Task", "uri":"DescImportTask.html", "doc_type":"api", - "p_code":"75", - "code":"78" + "p_code":"12", + "code":"68" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Data Export Task", - "uri":"data_export.html", - "doc_type":"api", - "p_code":"11", - "code":"79" - }, - { - "desc":"This API is used to query the dataset export task list by page.GET /v2/{project_id}/datasets/{dataset_id}/export-tasksNoneStatus code: 200Querying the Export Task List by", + "desc":"This API is used to query the dataset export task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "product_code":"modelarts", "title":"Querying the Dataset Export Task List", "uri":"GetExportTasksStatusOfDataset.html", "doc_type":"api", - "p_code":"79", - "code":"80" + "p_code":"12", + "code":"69" }, { - "desc":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.POST /v2/{project_id}/datasets/{dataset_id}/export-tasksStatus code: 200Creati", + "desc":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.You can debug this API through automatic authentication in or use the SDK sam", "product_code":"modelarts", "title":"Creating a Dataset Export Task", "uri":"ExportTask.html", "doc_type":"api", - "p_code":"79", - "code":"81" + "p_code":"12", + "code":"70" }, { - "desc":"This API is used to query the status of a dataset export task.GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id}NoneStatus code: 200Querying the Status of", + "desc":"This API is used to query the status of a dataset export task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl", "product_code":"modelarts", "title":"Querying the Status of a Dataset Export Task", "uri":"GetExportTaskStatusOfDataset.html", "doc_type":"api", - "p_code":"79", - "code":"82" + "p_code":"12", + "code":"71" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Data Synchronization Task", - "uri":"data_sync.html", - "doc_type":"api", - "p_code":"11", - "code":"83" - }, - { - "desc":"This API is used to synchronize samples and labeling information from the input dataset path to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/sync-dataNoneNoneS", + "desc":"This API is used to synchronize samples and labeling information from the input dataset path to the dataset.You can debug this API through automatic authentication in or", "product_code":"modelarts", "title":"Synchronizing a Dataset", "uri":"SyncDataSource.html", "doc_type":"api", - "p_code":"83", - "code":"84" + "p_code":"12", + "code":"72" }, { - "desc":"This API is used to query the status of a dataset synchronization task.GET /v2/{project_id}/datasets/{dataset_id}/sync-data/statusNoneStatus code: 200Obtaining the Status", + "desc":"This API is used to query the status of a dataset synchronization task.You can debug this API through automatic authentication in or use the SDK sample code generated by", "product_code":"modelarts", "title":"Querying the Status of a Dataset Synchronization Task", "uri":"SyncDataSourceState.html", "doc_type":"api", - "p_code":"83", - "code":"85" + "p_code":"12", + "code":"73" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Intelligent Task", - "uri":"auto_task.html", - "doc_type":"api", - "p_code":"11", - "code":"86" - }, - { - "desc":"This API is used to query auto labeling samples in a dataset.GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samplesNoneStatus code: 200Querying Auto Labeling", + "desc":"This API is used to query auto labeling samples in a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explo", "product_code":"modelarts", "title":"Querying Auto Labeling Sample List", "uri":"ListAutoAnnotationSamples.html", "doc_type":"api", - "p_code":"86", - "code":"87" + "p_code":"12", + "code":"74" }, { - "desc":"This API is used to query details about an auto labeling sample.GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id}NoneStatus code: 200Queryin", + "desc":"This API is used to query details about an auto labeling sample.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex", "product_code":"modelarts", "title":"Querying Details About an Auto Labeling Sample", "uri":"DescribeAutoAnnotationSample.html", "doc_type":"api", - "p_code":"86", - "code":"88" + "p_code":"12", + "code":"75" }, { - "desc":"This API is used to query the intelligent task list by page, including auto labeling and auto grouping tasks. You can specify the type parameter to query the list of a sp", + "desc":"This interface is used to query the intelligent task list by page, including intelligent labeling and automatic grouping tasks. You can specify the type parameter to quer", "product_code":"modelarts", "title":"Querying the Intelligent Task List by Page", "uri":"ListTasks.html", "doc_type":"api", - "p_code":"86", - "code":"89" + "p_code":"12", + "code":"76" }, { - "desc":"This API is used to start an intelligent task, which can be an auto labeling task or an auto grouping task. You can specify task_type in the request body to start a type ", + "desc":"This interface is used to start an intelligent task. Two types of intelligent tasks are supported: intelligent labeling and automatic grouping. You can specify the task_t", "product_code":"modelarts", "title":"Starting Intelligent Tasks", "uri":"CreateTask.html", "doc_type":"api", - "p_code":"86", - "code":"90" + "p_code":"12", + "code":"77" }, { - "desc":"This API is used to obtain information about intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the task_id ", + "desc":"This interface is used to obtain details about intelligent tasks. Intelligent labeling and automatic grouping tasks can be queried. You can specify the task_id parameter ", "product_code":"modelarts", "title":"Obtaining Information About Intelligent Tasks", "uri":"AutoAnnotationProgress.html", "doc_type":"api", - "p_code":"86", - "code":"91" + "p_code":"12", + "code":"78" }, { - "desc":"This API is used to stop intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the task_id parameter to stop a ", + "desc":"This interface is used to stop an intelligent task. Intelligent labeling and automatic grouping tasks can be stopped. You can specify the task_id parameter to stop a spec", "product_code":"modelarts", "title":"Stopping an Intelligent Task", "uri":"StopAutoAnnotation.html", "doc_type":"api", - "p_code":"86", - "code":"92" + "p_code":"12", + "code":"79" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Processing Task", - "uri":"process_task.html", - "doc_type":"api", - "p_code":"11", - "code":"93" - }, - { - "desc":"This API is used to query the list of a processing task. You can specify the task_type parameter to query the list of a specific type of tasks.- Data processing refers to", + "desc":"This API is used to obtain processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_type parameter to obtain a specific type", "product_code":"modelarts", "title":"Querying the List of a Processing Task", "uri":"ListProcessorTasks.html", "doc_type":"api", - "p_code":"93", - "code":"94" + "p_code":"12", + "code":"80" }, { - "desc":"This API is used to create a processing task. You can create data processing tasks. You can specify the id field of template composite parameter in the request body to cr", + "desc":"This API is used to create a processing task, including feature analysis tasks and data processing tasks. You can specify the id field of template composite parameter in ", "product_code":"modelarts", "title":"Creating a Processing Task", "uri":"CreateProcessorTask.html", "doc_type":"api", - "p_code":"93", - "code":"95" + "p_code":"12", + "code":"81" }, { - "desc":"This API is used to query the algorithm type for data processing.GET /v2/{project_id}/processor-tasks/itemsNoneStatus code: 200Querying the List of the Algorithm Type for", + "desc":"This API is used to query the algorithm type for data processing.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", "product_code":"modelarts", "title":"Querying the Algorithm Type for Data Processing", "uri":"GetProcessorTaskItems.html", "doc_type":"api", - "p_code":"93", - "code":"96" + "p_code":"12", + "code":"82" }, { - "desc":"This API is used to query the details about processing tasks. You can query feature analysis tasks and data processing tasks. You can specify the task_id parameter to que", + "desc":"This API is used to obtain details about processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_id parameter to obtain the", "product_code":"modelarts", "title":"Querying Details About a Processing Task", "uri":"DescribeProcessorTask.html", "doc_type":"api", - "p_code":"93", - "code":"97" + "p_code":"12", + "code":"83" }, { - "desc":"This API is used to update a processing task. You can update feature analysis tasks and data processing tasks. Only the description of updated tasks is supported. You can", + "desc":"This API is used to update a processing task, including feature analysis tasks and data processing tasks. Only the description of tasks can be updated. You can specify th", "product_code":"modelarts", "title":"Updating a Processing Task", "uri":"UpdateProcessorTask.html", "doc_type":"api", - "p_code":"93", - "code":"98" + "p_code":"12", + "code":"84" }, { - "desc":"This API is used to delete a processing task. You can delete feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id pa", + "desc":"This API is used to delete a processing task, including feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id paramet", "product_code":"modelarts", "title":"Deleting a Processing Task", "uri":"DeleteProcessorTask.html", "doc_type":"api", - "p_code":"93", - "code":"99" + "p_code":"12", + "code":"85" }, { - "desc":"This API is used to query the version list of a data processing task.GET /v2/{project_id}/processor-tasks/{task_id}/versionsNoneStatus code: 200Querying the Version List ", + "desc":"This API is used to query the version list of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by A", "product_code":"modelarts", "title":"Querying the Version List of a Data Processing Task", "uri":"ListProcessorTaskVersions.html", "doc_type":"api", - "p_code":"93", - "code":"100" + "p_code":"12", + "code":"86" }, { - "desc":"This API is used to create a data processing task version.POST /v2/{project_id}/processor-tasks/{task_id}/versionsStatus code: 200Creating a Data Validation Task VersionS", + "desc":"This API is used to create a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", "product_code":"modelarts", "title":"Creating a Data Processing Task Version", "uri":"CreateProcessorTaskVersion.html", "doc_type":"api", - "p_code":"93", - "code":"101" + "p_code":"12", + "code":"87" }, { - "desc":"This API is used to query the details about the version of a data processing task.GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}NoneStatus code: 200", + "desc":"This API is used to query the details about the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code g", "product_code":"modelarts", "title":"Querying the Details About the Version of a Data Processing Task", "uri":"DescProcessorTaskVersion.html", "doc_type":"api", - "p_code":"93", - "code":"102" + "p_code":"12", + "code":"88" }, { - "desc":"This API is used to delete a data processing task version.DELETE /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}NoneNoneDeleting a Data Processing Task V", + "desc":"This API is used to delete a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", "product_code":"modelarts", "title":"Deleting a Data Processing Task Version", "uri":"DeleteProcessorTaskVersion.html", "doc_type":"api", - "p_code":"93", - "code":"103" + "p_code":"12", + "code":"89" }, { - "desc":"This API is used to query the result of a data processing task version.GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/resultsNoneStatus code: 200Que", + "desc":"This API is used to query the result of a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by", "product_code":"modelarts", "title":"Querying the Result of a Data Processing Task Version", "uri":"ListProcessorTaskVersionResults.html", "doc_type":"api", - "p_code":"93", - "code":"104" + "p_code":"12", + "code":"90" }, { - "desc":"This API is used to stop the version of a data processing task.POST /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/stopNoneNoneThis API is used to stop ", + "desc":"This API is used to stop the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp", "product_code":"modelarts", "title":"Stopping the Version of a Data Processing Task", "uri":"StopProcessorTaskVersion.html", "doc_type":"api", - "p_code":"93", - "code":"105" + "p_code":"12", + "code":"91" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"DevEnviron (New Version)", - "uri":"modelarts_03_0107.html", - "doc_type":"api", - "p_code":"", - "code":"106" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"DevEnviron Instance Management", "uri":"notebook.html", "doc_type":"api", - "p_code":"106", - "code":"107" + "p_code":"", + "code":"92" }, { - "desc":"This API is used to query all images by page based on specified conditions.NoneGET /v1/{project_id}/imagesNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", - "product_code":"modelarts", - "title":"Querying Supported Images", - "uri":"ListImage.html", - "doc_type":"api", - "p_code":"107", - "code":"108" - }, - { - "desc":"This API is used to query notebook instances based on specified search criteria.NoneGET /v1/{project_id}/notebooksNoneStatus code: 200NoneStatus code: 200OKSee Error Code", + "desc":"This API is used to query notebook instances based on specified search criteria.NoneYou can debug this API through automatic authentication in or use the SDK sample code", "product_code":"modelarts", "title":"Querying Notebook Instances", "uri":"ListNotebooks.html", "doc_type":"api", - "p_code":"107", - "code":"109" + "p_code":"92", + "code":"93" }, { - "desc":"This API is used to create a notebook instance based on the specified flavor, AI engine images, and storage. You can access the instance through a web page or SSH client.", + "desc":"This API is used to create a notebook instance based on the specified flavor, AI engine image, and storage. You can access the instance through a web page or SSH client. ", "product_code":"modelarts", "title":"Creating a Notebook Instance", "uri":"CreateNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"110" + "p_code":"92", + "code":"94" }, { - "desc":"This API is used to open a free CodeLab instance. After opening it, you can switch to another instance as required.NonePOST /v1/{project_id}/notebooks/openStatus code: 20", - "product_code":"modelarts", - "title":"Opening a CodeLab Instance", - "uri":"RunCodeLab.html", - "doc_type":"api", - "p_code":"107", - "code":"111" - }, - { - "desc":"This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.NoneGET /v1/{project_id}/notebooks/{id}Non", + "desc":"This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.NoneYou can debug this API through automat", "product_code":"modelarts", "title":"Querying Details of a Notebook Instance", "uri":"ShowNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"112" + "p_code":"92", + "code":"95" }, { - "desc":"This API is used to update the name, description, flavor, and image ID of a stopped notebook instance.NonePUT /v1/{project_id}/notebooks/{id}Status code: 200Status code: ", + "desc":"This API is used to update the name, description, flavor, and image ID of a stopped notebook instance.NoneYou can debug this API through automatic authentication in or u", "product_code":"modelarts", "title":"Updating a Notebook Instance", "uri":"UpdateNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"113" + "p_code":"92", + "code":"96" }, { - "desc":"This API is used to delete the container and all storage resources of a notebook instance.NoneDELETE /v1/{project_id}/notebooks/{id}NoneStatus code: 200NoneStatus code: 2", + "desc":"This API is used to delete the container and all storage resources of a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK s", "product_code":"modelarts", "title":"Deleting a Notebook Instance", "uri":"DeleteNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"114" + "p_code":"92", + "code":"97" }, { - "desc":"This API is used to query the flavors available for a notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/flavorsNoneStatus code: 200NoneStatus code: 200OKSee Error", + "desc":"Save the running instance as a container image. In the saved image, the installed dependency package (pip package) is not lost. In VS Code remote development, the plug-in", + "product_code":"modelarts", + "title":"Saving a Running Instance as a Container Image", + "uri":"CreateImage.html", + "doc_type":"api", + "p_code":"92", + "code":"98" + }, + { + "desc":"Obtain the available flavors.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/not", + "product_code":"modelarts", + "title":"Obtaining the Available Flavors", + "uri":"ListFlavors.html", + "doc_type":"api", + "p_code":"92", + "code":"99" + }, + { + "desc":"This API is used to query the flavors available for a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generat", "product_code":"modelarts", "title":"Querying Flavors Available for a Notebook Instance", "uri":"ShowSwitchableFlavors.html", "doc_type":"api", - "p_code":"107", - "code":"115" + "p_code":"92", + "code":"100" }, { - "desc":"This API is used to query the available duration of a running notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/leaseNoneStatus code: 200NoneStatus code: 200OKSee", + "desc":"This API is used to query the available duration of a running notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code", "product_code":"modelarts", "title":"Querying the Available Duration of a Running Notebook Instance", "uri":"ShowLease.html", "doc_type":"api", - "p_code":"107", - "code":"116" + "p_code":"92", + "code":"101" }, { - "desc":"This API is used to prolong a notebook instance.NonePATCH /v1/{project_id}/notebooks/{id}/leaseNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "desc":"This API is used to prolong a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PATCH", "product_code":"modelarts", "title":"Prolonging a Notebook Instance", "uri":"RenewLease.html", "doc_type":"api", - "p_code":"107", - "code":"117" + "p_code":"92", + "code":"102" }, { - "desc":"This API is used to start a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/startStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "desc":"This API is used to start a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v", "product_code":"modelarts", "title":"Starting a Notebook Instance", "uri":"StartNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"118" + "p_code":"92", + "code":"103" }, { - "desc":"This API is used to stop a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/stopNoneStatus code: 200NoneStatus code: 200OKSee Error Codes.", + "desc":"This API is used to stop a notebook instance.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1", "product_code":"modelarts", "title":"Stopping a Notebook Instance", "uri":"StopNotebook.html", "doc_type":"api", - "p_code":"107", - "code":"119" + "p_code":"92", + "code":"104" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"OBS Storage Mounting", - "uri":"storage.html", - "doc_type":"api", - "p_code":"106", - "code":"120" - }, - { - "desc":"This API is used to obtain the notebook instances with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storageNoneStatus code: 200NoneStatus code: 20", + "desc":"This API is used to obtain the notebook instances with OBS storage mounted.NoneYou can debug this API through automatic authentication in or use the SDK sample code gene", "product_code":"modelarts", "title":"Obtaining the Notebook Instances with OBS Storage Mounted", - "uri":"ListDynamicMount.html", + "uri":"ListAttachableObSs.html", "doc_type":"api", - "p_code":"120", - "code":"121" + "p_code":"92", + "code":"105" }, { - "desc":"This API is used to mount OBS storage to a running notebook instance so that the application layer can operate OBS parallel file system in the container.NonePOST /v1/{pro", + "desc":"An OBS parallel file system can be mounted to a specified file directory of a running notebook instance. After the mounting, objects in the OBS parallel file system can b", "product_code":"modelarts", "title":"OBS Storage Mounting", "uri":"AttachObs.html", "doc_type":"api", - "p_code":"120", - "code":"122" + "p_code":"92", + "code":"106" }, { - "desc":"This API is used to obtain details about a notebook instance with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}NoneStatus code", + "desc":"This API is used to obtain details about a notebook instance with OBS storage mounted.NoneYou can debug this API through automatic authentication in or use the SDK sampl", "product_code":"modelarts", "title":"Obtaining Details About a Notebook Instance with OBS Storage Mounted", "uri":"ShowAttachableObs.html", "doc_type":"api", - "p_code":"120", - "code":"123" + "p_code":"92", + "code":"107" }, { "desc":"This API is used to unmount OBS storage from a notebook instance. After OBS storage is unmounted, OBS objects remain unchanged but cannot be operated in the notebook cont", @@ -1112,8 +968,53 @@ "title":"Unmounting OBS Storage from a Notebook Instance", "uri":"CancelObs.html", "doc_type":"api", - "p_code":"120", - "code":"124" + "p_code":"92", + "code":"108" + }, + { + "desc":"This API is used to query all images by page based on specified conditions.NoneYou can debug this API through automatic authentication in or use the SDK sample code gene", + "product_code":"modelarts", + "title":"Querying Supported Images", + "uri":"ListImage.html", + "doc_type":"api", + "p_code":"92", + "code":"109" + }, + { + "desc":"Register a custom image with ModelArts Image Management.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explor", + "product_code":"modelarts", + "title":"Registering a Custom Image", + "uri":"RegisterImage.html", + "doc_type":"api", + "p_code":"92", + "code":"110" + }, + { + "desc":"Obtain the overview of user image information. The image name is used as the aggregated information.NoneYou can debug this API through automatic authentication in or use", + "product_code":"modelarts", + "title":"Obtaining User Image Groups", + "uri":"ListImageGroup.html", + "doc_type":"api", + "p_code":"92", + "code":"111" + }, + { + "desc":"Obtain the details of an image.NoneYou can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/i", + "product_code":"modelarts", + "title":"Obtaining Details of an Image", + "uri":"ShowImage.html", + "doc_type":"api", + "p_code":"92", + "code":"112" + }, + { + "desc":"Delete an image object. For a private image, you can also delete the image content from SWR using parameters.NoneYou can debug this API through automatic authentication i", + "product_code":"modelarts", + "title":"Deleting an Image", + "uri":"DeleteImage.html", + "doc_type":"api", + "p_code":"92", + "code":"113" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1122,16 +1023,7 @@ "uri":"modelarts_03_0108.html", "doc_type":"api", "p_code":"", - "code":"125" - }, - { - "desc":"This API is used to query the authentication information of a development environment instance, which is used to open the development environment instance.GET /v1/{projec", - "product_code":"modelarts", - "title":"Querying the Authentication Information of a Development Environment Instance", - "uri":"modelarts_03_0109.html", - "doc_type":"api", - "p_code":"125", - "code":"126" + "code":"114" }, { "desc":"This API is used to create a development environment instance for code development.Calling this API is an asynchronous operation. The job status can be obtained by callin", @@ -1139,26 +1031,26 @@ "title":"Creating a Development Environment Instance", "uri":"modelarts_03_0110.html", "doc_type":"api", - "p_code":"125", - "code":"127" + "p_code":"114", + "code":"115" }, { - "desc":"This API is used to query the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={p", + "desc":"This API is used to obtain the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={", "product_code":"modelarts", - "title":"Querying a List of Development Environment Instances", + "title":"Obtaining Development Environment Instances", "uri":"modelarts_03_0111.html", "doc_type":"api", - "p_code":"125", - "code":"128" + "p_code":"114", + "code":"116" }, { - "desc":"This API is used to query the details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parame", + "desc":"This API is used to obtain details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameter", "product_code":"modelarts", - "title":"Querying Details About a Development Environment Instance", + "title":"Obtaining Details About a Development Environment Instance", "uri":"modelarts_03_0112.html", "doc_type":"api", - "p_code":"125", - "code":"129" + "p_code":"114", + "code":"117" }, { "desc":"This API is used to modify the description of a development environment instance or information about the auto stop function.PUT /v1/{project_id}/demanager/instances/{ins", @@ -1166,8 +1058,8 @@ "title":"Modifying the Description of a Development Environment Instance", "uri":"modelarts_03_0113.html", "doc_type":"api", - "p_code":"125", - "code":"130" + "p_code":"114", + "code":"118" }, { "desc":"This API is used to delete a development environment instance.DELETE /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameters.Parameter", @@ -1175,8 +1067,8 @@ "title":"Deleting a Development Environment Instance", "uri":"modelarts_03_0114.html", "doc_type":"api", - "p_code":"125", - "code":"131" + "p_code":"114", + "code":"119" }, { "desc":"This API is used to startor stop a notebook instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required parameters.ParametersPar", @@ -1184,396 +1076,603 @@ "title":"Managing a Development Environment Instance", "uri":"modelarts_03_0115.html", "doc_type":"api", - "p_code":"125", - "code":"132" + "p_code":"114", + "code":"120" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", - "title":"Training Management (New Version)", - "uri":"modelarts_03_0119.html", - "doc_type":"api", - "p_code":"", - "code":"133" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Algorithm Management", + "title":"Training Management", "uri":"algorithms.html", "doc_type":"api", - "p_code":"133", - "code":"134" + "p_code":"", + "code":"121" }, { - "desc":"This API is used to create an algorithm.POST /v2/{project_id}/algorithmsStatus code: 201The following shows how to create an algorithm whose name is TestModelArtsalgorith", + "desc":"This API is used to create an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{project", "product_code":"modelarts", "title":"Creating an Algorithm", "uri":"CreateAlgorithm.html", "doc_type":"api", - "p_code":"134", - "code":"135" + "p_code":"121", + "code":"122" }, { - "desc":"This API is used to query the algorithm list.GET /v2/{project_id}/algorithmsNoneStatus code: 200The following shows how to query all algorithms in jobs whose names contai", + "desc":"This API is used to query the algorithm list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{pro", "product_code":"modelarts", "title":"Querying the Algorithm List", "uri":"ListAlgorithms.html", "doc_type":"api", - "p_code":"134", - "code":"136" + "p_code":"121", + "code":"123" }, { - "desc":"This API is used to query a specified algorithm based on the algorithm ID.GET /v2/{project_id}/algorithms/{algorithm_id}NoneStatus code: 200The following shows how to que", + "desc":"This API is used to query a specified algorithm based on the algorithm ID.You can debug this API through automatic authentication in or use the SDK sample code generated", "product_code":"modelarts", "title":"Querying Algorithm Details", "uri":"ShowAlgorithmByUuid.html", "doc_type":"api", - "p_code":"134", - "code":"137" + "p_code":"121", + "code":"124" }, { - "desc":"This API is used to modify an algorithm.PUT /v2/{project_id}/algorithms/{algorithm_id}Status code: 201The following shows how to modify the algorithm whose UUID is 2e5451", + "desc":"This API is used to modify an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{project_", "product_code":"modelarts", "title":"Modifying an Algorithm", "uri":"ChangeAlgorithm.html", "doc_type":"api", - "p_code":"134", - "code":"138" + "p_code":"121", + "code":"125" }, { - "desc":"This API is used to delete an algorithm.DELETE /v2/{project_id}/algorithms/{algorithm_id}NoneNoneThe following shows how to modify the algorithm whose UUID is 2e5451fe-91", + "desc":"This API is used to delete an algorithm.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{proje", "product_code":"modelarts", "title":"Deleting an Algorithm", "uri":"DeleteAlgorithm.html", "doc_type":"api", - "p_code":"134", - "code":"139" + "p_code":"121", + "code":"126" }, { - "desc":"This API is used tp query the hyperparameter search algorithm list.GET /v2/{project_id}/search-algorithmsNoneStatus code: 200The following shows how to query information ", - "product_code":"modelarts", - "title":"Querying the Hyperparameter Search Algorithm List", - "uri":"ListSearchAlgorithms.html", - "doc_type":"api", - "p_code":"134", - "code":"140" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Training Job Management", - "uri":"trainingJobs.html", - "doc_type":"api", - "p_code":"133", - "code":"141" - }, - { - "desc":"This API is used to create a training job.POST /v2/{project_id}/training-jobsStatus code: 201The following shows how to create a training job named TestModelArtsJob. The ", + "desc":"This API is used to create a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proje", "product_code":"modelarts", "title":"Creating a Training Job", "uri":"CreateTrainingJob.html", "doc_type":"api", - "p_code":"141", - "code":"142" + "p_code":"121", + "code":"127" }, { - "desc":"This API is used to query the details about a training job.GET /v2/{project_id}/training-jobs/{training_job_id}NoneStatus code: 200The following shows how to query a trai", + "desc":"This API is used to query the details about a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explore", "product_code":"modelarts", "title":"Querying the Details About a Training Job", - "uri":"ShowTrainingJobInfomation.html", + "uri":"ShowTrainingJobDetails.html", "doc_type":"api", - "p_code":"141", - "code":"143" + "p_code":"121", + "code":"128" }, { - "desc":"This API is used to modify the description of a training job.PUT /v2/{project_id}/training-jobs/{training_job_id}NoneThe following shows how to modify a training job whos", + "desc":"This API is used to modify the description of a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explo", "product_code":"modelarts", "title":"Modifying the Description of a Training Job", "uri":"ChangeTrainingJobDescription.html", "doc_type":"api", - "p_code":"141", - "code":"144" + "p_code":"121", + "code":"129" }, { - "desc":"This API is used to delete a training job.DELETE /v2/{project_id}/training-jobs/{training_job_id}NoneNoneThe following shows how to delete a training job whose UUID is 3f", + "desc":"This API is used to delete a training job.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{pro", "product_code":"modelarts", "title":"Deleting a Training Job", "uri":"DeleteTrainingJob.html", "doc_type":"api", - "p_code":"141", - "code":"145" + "p_code":"121", + "code":"130" }, { - "desc":"This API is used to terminate a training job. Only jobs in the Creating, Waiting, or Running state can be terminated.POST /v2/{project_id}/training-jobs/{training_job_id}", + "desc":"This API is used to terminate a training job. Only jobs in the Creating, Waiting, or Running state can be terminated.You can debug this API through automatic authenticati", "product_code":"modelarts", "title":"Terminating a Training Job", "uri":"StopTrainingJob.html", "doc_type":"api", - "p_code":"141", - "code":"146" + "p_code":"121", + "code":"131" }, { - "desc":"This API is used to query the logs of a specified task in a given training job (preview).GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/logs/preview", + "desc":"This API is used to query the logs of a specified task in a given training job (preview).You can debug this API through automatic authentication in or use the SDK sample", "product_code":"modelarts", "title":"Querying the Logs of a Specified Task in a Given Training Job (Preview)", "uri":"ShowTrainingJobLogsPreview.html", "doc_type":"api", - "p_code":"141", - "code":"147" + "p_code":"121", + "code":"132" }, { - "desc":"This API is used to query the logs of a specified task in a given training job (OBS URL). You can view or download all logs.GET /v2/{project_id}/training-jobs/{training_j", + "desc":"This API is used to obtain the logs of a specified task of a training job (temporary OBS link, which is valid for 5 minutes). You can view all logs or download the logs.Y", "product_code":"modelarts", - "title":"Querying the Logs of a Specified Taks in a Given Training Job (OBS URL)", - "uri":"ShowTrainingJobLogsFromObs.html", + "title":"Querying the Logs of a Specified Task in a Training Job (OBS Link)", + "uri":"ShowObsUrlOfTrainingJobLogs.html", "doc_type":"api", - "p_code":"141", - "code":"148" + "p_code":"121", + "code":"133" }, { - "desc":"This API is used to query the running metrics of a specified task in a training job.GET /v2/{project_id}/training-jobs/{training_job_id}/metrics/{task_id}NoneStatus code:", + "desc":"This API is used to query the running metrics of a specified task in a training job.You can debug this API through automatic authentication in or use the SDK sample code", "product_code":"modelarts", "title":"Querying the Running Metrics of a Specified Task in a Training Job", "uri":"ShowTrainingJobMetrics.html", "doc_type":"api", - "p_code":"141", - "code":"149" + "p_code":"121", + "code":"134" }, { - "desc":"This API is used to query the the created training jobs that meet the search criteria.POST /v2/{project_id}/training-job-searchesStatus code: 200The following shows how t", + "desc":"This API is used to query the the created training jobs that meet the search criteria.You can debug this API through automatic authentication in or use the SDK sample co", "product_code":"modelarts", "title":"Querying a Training Job List", "uri":"ListTrainingJobs.html", "doc_type":"api", - "p_code":"141", - "code":"150" + "p_code":"121", + "code":"135" }, { - "desc":"This API is used to query all trails using hyperparameter search.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trialsNoneStatus code: 200The following s", + "desc":"This API is used to obtain the public flavors supported by a training job.GET /v2/{project_id}/training-job-flavorsNoneStatus code: 200The following shows how to query th", "product_code":"modelarts", - "title":"Querying All Trials Using Hyperparameter Search", - "uri":"ShowAutoSearchTrials.html", + "title":"Obtaining the General Specifications Supported by a Training Job", + "uri":"ShowTrainingJobFlavors.html", "doc_type":"api", - "p_code":"141", - "code":"151" + "p_code":"121", + "code":"136" }, { - "desc":"This API is used to query information about a trial using hyperparameter search based on the trial_id.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-tria", + "desc":"This API is used to obtain the preset AI frameworks supported by a training job.GET /v2/{project_id}/training-job-enginesNoneStatus code: 200The following shows how to qu", "product_code":"modelarts", - "title":"Querying Information About a Trial Using Hyperparameter Search", - "uri":"ShowAutoSearchPerTrial.html", + "title":"Obtaining the Preset AI Frameworks Supported by a Training Job", + "uri":"ShowTrainingJobEngines.html", "doc_type":"api", - "p_code":"141", - "code":"152" - }, - { - "desc":"This API is used to obtain the summary of hyperparameter sensitivity analysis results.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-analysisNo", - "product_code":"modelarts", - "title":"Obtaining the Hyperparameter Sensitivity Analysis Result", - "uri":"ShowAutoSearchParamsAnalysis.html", - "doc_type":"api", - "p_code":"141", - "code":"153" - }, - { - "desc":"This API is used to obtain the path for storing a hyperparameter sensitivity analysis image.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-anal", - "product_code":"modelarts", - "title":"Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image", - "uri":"ShowAutoSearchParamAnalysisResultPath.html", - "doc_type":"api", - "p_code":"141", - "code":"154" - }, - { - "desc":"This API is used to early stop a trial of an auto search job.POST /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trial-earlystop/{trial_id}NoneStatus code: 2", - "product_code":"modelarts", - "title":"Early Stopping a Trial of an Auto Search Job", - "uri":"ShowAutoSearchTrialEarlyStop.html", - "doc_type":"api", - "p_code":"141", - "code":"155" - }, - { - "desc":"This API is used to obtain information about the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templatesNoneStatus code: 200The f", - "product_code":"modelarts", - "title":"Obtaining Information About the YAML Template of an Auto Search Job", - "uri":"ShowAutoSearchYamlTemplatesInfo.html", - "doc_type":"api", - "p_code":"141", - "code":"156" - }, - { - "desc":"This API is used to obtain the content of the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templates/{algorithm_type}/{algorithm", - "product_code":"modelarts", - "title":"Obtaining the Content of the YAML Template of an Auto Search Job", - "uri":"ShowAutoSearchYamlTemplateContent.html", - "doc_type":"api", - "p_code":"141", - "code":"157" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Resource and Engine Specifications", - "uri":"resources.html", - "doc_type":"api", - "p_code":"133", - "code":"158" - }, - { - "desc":"This API is used to query the list of public flavors supported by a training job.GET /v2/{project_id}/training-job-flavorsNoneStatus code: 200The following shows how to q", - "product_code":"modelarts", - "title":"Querying the Public Flavor List Supported by a Training Job", - "uri":"ListTrainingJobFlavors.html", - "doc_type":"api", - "p_code":"158", - "code":"159" - }, - { - "desc":"This API is used to query the list of AI engines supported by a training job.GET /v2/{project_id}/training-job-enginesNoneStatus code: 200The following shows how to query", - "product_code":"modelarts", - "title":"Querying the AI Engine List Supported by a Training Job", - "uri":"ListTrainingJobEngines.html", - "doc_type":"api", - "p_code":"158", - "code":"160" + "p_code":"121", + "code":"137" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Model Management", - "uri":"modelarts_03_0153.html", + "uri":"topic_300000004.html", "doc_type":"api", "p_code":"", - "code":"161" + "code":"138" }, { - "desc":"You can use the API to import a model.Ensure that the execution code and model have been uploaded to OBS. By default, the models generated by a training job are stored in", + "desc":"This API is used to obtain the models that meet the search criteria.You can debug this API through automatic authentication in or use the SDK sample code generated by AP", "product_code":"modelarts", - "title":"Importing a Model", - "uri":"modelarts_03_0076.html", + "title":"Obtaining Models", + "uri":"ListModels.html", "doc_type":"api", - "p_code":"161", - "code":"162" + "p_code":"138", + "code":"139" }, { - "desc":"This API is used to query the models that meet the search criteria.GET /v1/{project_id}/modelsTable 1 describes the required parameters.ParametersParameterMandatoryTypeDe", + "desc":"This API is used to import a model. The execution code and model must be uploaded to OBS first. By default, the model generated by a training job is stored in OBS.The bod", "product_code":"modelarts", - "title":"Querying a Model List", - "uri":"modelarts_03_0077.html", + "title":"Importing Models", + "uri":"CreateModel.html", "doc_type":"api", - "p_code":"161", - "code":"163" + "p_code":"138", + "code":"140" }, { - "desc":"This API is used to query details about a model based on the model ID.GET /v1/{project_id}/models/{model_id}Table 1 describes the required parameters.ParametersParameterM", + "desc":"This API is used to obtain details about a model based on the model ID.You can debug this API through automatic authentication in or use the SDK sample code generated by", "product_code":"modelarts", - "title":"Querying the Details About a Model", - "uri":"modelarts_03_0078.html", + "title":"Viewing Details About a Model", + "uri":"ShowModel.html", "doc_type":"api", - "p_code":"161", - "code":"164" + "p_code":"138", + "code":"141" }, { "desc":"This API is used to delete a model based on the model ID. When cascade is set to true, the model specified by the model ID and models of different versions with the same ", "product_code":"modelarts", "title":"Deleting a Model", - "uri":"modelarts_03_0079.html", + "uri":"DeleteModel.html", "doc_type":"api", - "p_code":"161", - "code":"165" + "p_code":"138", + "code":"142" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Service Management", - "uri":"modelarts_03_0081.html", + "uri":"topic_300000009.html", "doc_type":"api", "p_code":"", + "code":"143" + }, + { + "desc":"This API is used to obtain service monitoring information.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer", + "product_code":"modelarts", + "title":"Obtaining Service Monitoring", + "uri":"ShowServiceMonitorInfo.html", + "doc_type":"api", + "p_code":"143", + "code":"144" + }, + { + "desc":"This API is used to obtain model services.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{projec", + "product_code":"modelarts", + "title":"Obtaining Services", + "uri":"ListServices.html", + "doc_type":"api", + "p_code":"143", + "code":"145" + }, + { + "desc":"This API is used to deploy a model as a service.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1/", + "product_code":"modelarts", + "title":"Deploying Services", + "uri":"CreateService.html", + "doc_type":"api", + "p_code":"143", + "code":"146" + }, + { + "desc":"This API is used to obtain supported service deployment specifications.You can debug this API through automatic authentication in or use the SDK sample code generated by", + "product_code":"modelarts", + "title":"Obtaining Supported Service Deployment Specifications", + "uri":"ShowServiceSpecifications.html", + "doc_type":"api", + "p_code":"143", + "code":"147" + }, + { + "desc":"This API is used to obtain the details about a model service based on the service ID.You can debug this API through automatic authentication in or use the SDK sample cod", + "product_code":"modelarts", + "title":"Obtaining Service Details", + "uri":"ShowService.html", + "doc_type":"api", + "p_code":"143", + "code":"148" + }, + { + "desc":"This API is used to update configurations of a model service. It can also be used to start or stop a service.You can debug this API through automatic authentication in o", + "product_code":"modelarts", + "title":"Updating Service Configurations", + "uri":"UpdateService.html", + "doc_type":"api", + "p_code":"143", + "code":"149" + }, + { + "desc":"This API is used to delete a model service. You can delete your own services only.You can debug this API through automatic authentication in or use the SDK sample code g", + "product_code":"modelarts", + "title":"Deleting a Service", + "uri":"DeleteService.html", + "doc_type":"api", + "p_code":"143", + "code":"150" + }, + { + "desc":"This API is used to obtain dedicated resource pools.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /", + "product_code":"modelarts", + "title":"Obtaining Dedicated Resource Pools", + "uri":"ListClusters.html", + "doc_type":"api", + "p_code":"143", + "code":"151" + }, + { + "desc":"This API is used to obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.You can debug this API th", + "product_code":"modelarts", + "title":"Obtaining Service Event Logs", + "uri":"ShowServiceEvents.html", + "doc_type":"api", + "p_code":"143", + "code":"152" + }, + { + "desc":"This API is used to obtain the update logs of a real-time service.You can debug this API through automatic authentication in or use the SDK sample code generated by API ", + "product_code":"modelarts", + "title":"Obtaining Service Update Logs", + "uri":"ShowServiceUpdateLogs.html", + "doc_type":"api", + "p_code":"143", + "code":"153" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Resource Management", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"", + "code":"154" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Configuration management", + "uri":"config_management.html", + "doc_type":"api", + "p_code":"154", + "code":"155" + }, + { + "desc":"Obtain the configuration parameters of the ModelArts OS service, such as the CIDR block and user resource quota.You can debug this API through automatic authentication in", + "product_code":"modelarts", + "title":"Querying OS Configuration Parameters", + "uri":"ShowOsConfig.html", + "doc_type":"api", + "p_code":"155", + "code":"156" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Quota management", + "uri":"topic_300000001.html", + "doc_type":"api", + "p_code":"154", + "code":"157" + }, + { + "desc":"Obtain the quotas of some resources in the ModelArts OS service, such as the resource pool quota and network quota.You can debug this API through automatic authentication", + "product_code":"modelarts", + "title":"Querying OS Quotas", + "uri":"ShowOsQuota.html", + "doc_type":"api", + "p_code":"157", + "code":"158" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Event management", + "uri":"event_management.html", + "doc_type":"api", + "p_code":"154", + "code":"159" + }, + { + "desc":"Obtain events.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/eventsNoneStatus code:", + "product_code":"modelarts", + "title":"Querying a Trace List", + "uri":"ListEvents.html", + "doc_type":"api", + "p_code":"159", + "code":"160" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Resource Pool Job Management", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"154", + "code":"161" + }, + { + "desc":"Obtain dedicated resource pool jobs.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project_id}/", + "product_code":"modelarts", + "title":"Querying the dedicated resource pool Job List", + "uri":"ListWorkloads.html", + "doc_type":"api", + "p_code":"161", + "code":"162" + }, + { + "desc":"This API is used to query dedicated resource pool job statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by API E", + "product_code":"modelarts", + "title":"Querying dedicated resource pool Job Statistics", + "uri":"ShowWorkloadStatistics.html", + "doc_type":"api", + "p_code":"161", + "code":"163" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Resource indicators", + "uri":"metrics_management.html", + "doc_type":"api", + "p_code":"154", + "code":"164" + }, + { + "desc":"Obtain the real-time usage of all resource pools in the current project.You can debug this API through automatic authentication in or use the SDK sample code generated b", + "product_code":"modelarts", + "title":"Querying the Real-Time Resource Usage", + "uri":"ShowPoolRuntimeMetrics.html", + "doc_type":"api", + "p_code":"164", + "code":"165" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Plug-in template management API", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"154", "code":"166" }, { - "desc":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject", + "desc":"This interface is used to obtain details about a specified plug-in template.You can debug this API through automatic authentication in or use the SDK sample code generat", "product_code":"modelarts", - "title":"Deploying a Model as a Service", - "uri":"modelarts_03_0082.html", + "title":"Querying a Plug-in Template", + "uri":"ShowPluginTemplate.html", "doc_type":"api", "p_code":"166", "code":"167" }, { - "desc":"This API is used to obtain model services.GET /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_idYesS", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", - "title":"Querying a Service List", - "uri":"modelarts_03_0083.html", + "title":"Networking", + "uri":"network_management.html", "doc_type":"api", - "p_code":"166", + "p_code":"154", "code":"168" }, { - "desc":"This API is used to query the details about a model service based on the service ID.GET /v1/{project_id}/services/{service_id}Table 1 describes the required parameters.Pa", + "desc":"This API is used to create network resources.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v1/{pr", "product_code":"modelarts", - "title":"Querying the Details About a Service", - "uri":"modelarts_03_0084.html", + "title":"Creating Network Resources", + "uri":"CreateNetwork.html", "doc_type":"api", - "p_code":"166", + "p_code":"168", "code":"169" }, { - "desc":"This API is used to update configurations of a model service. It can also be used to start or stop a service.PUT /v1/{project_id}/services/{service_id}Table 1 describes t", + "desc":"This API is used to obtain network resources.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{pro", "product_code":"modelarts", - "title":"Updating Service Configurations", - "uri":"modelarts_03_0086.html", + "title":"Obtaining Network Resources", + "uri":"ListNetworks.html", "doc_type":"api", - "p_code":"166", + "p_code":"168", "code":"170" }, { - "desc":"This API is used to query service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorTable 1 describes the required parameters.ParametersParameterMa", + "desc":"This API is used to obtain details about a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by ", "product_code":"modelarts", - "title":"Querying Service Monitoring Information", - "uri":"modelarts_03_0087.html", + "title":"Obtaining a Network Resource", + "uri":"ShowNetwork.html", "doc_type":"api", - "p_code":"166", + "p_code":"168", "code":"171" }, { - "desc":"This API is used to query the update logs of a real-time service.GET /v1/{project_id}/services/{service_id}/logsTable 1 describes the required parameters.ParametersParame", + "desc":"This API is used to delete a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.D", "product_code":"modelarts", - "title":"Querying Service Update Logs", - "uri":"modelarts_03_0088.html", + "title":"Deleting a Network Resource", + "uri":"DeleteNetwork.html", "doc_type":"api", - "p_code":"166", + "p_code":"168", "code":"172" }, { - "desc":"This API is used to query service event logs, including service operation records, key actions during deployment, and deployment failure causes.GET /v1/{project_id}/servi", + "desc":"This API is used to update a specified network resource.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.P", "product_code":"modelarts", - "title":"Querying Service Event Logs", - "uri":"modelarts_03_0155.html", + "title":"Updating a Network Resource", + "uri":"PatchNetwork.html", "doc_type":"api", - "p_code":"166", + "p_code":"168", "code":"173" }, { - "desc":"This API is used to delete a service. You can delete your own services only.Table 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_i", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", - "title":"Deleting a Service", - "uri":"modelarts_03_0089.html", + "title":"Node management", + "uri":"topic_300000007.html", "doc_type":"api", - "p_code":"166", + "p_code":"154", "code":"174" }, { - "desc":"This API is used to query supported service deployment specifications.URIGET /v1/{project_id}/services/specificationsNoneSample requestGET https://endpoint/v1/{project", + "desc":"This API is used to obtain nodes in a resource pool.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /", "product_code":"modelarts", - "title":"Querying Supported Service Deployment Specifications", - "uri":"modelarts_03_0200.html", + "title":"Obtaining Nodes", + "uri":"ListPoolNodes.html", "doc_type":"api", - "p_code":"166", + "p_code":"174", "code":"175" }, + { + "desc":"Delete nodes in a specific resource pool. At least one node must be reserved in the resource pool.You can debug this API through automatic authentication in or use the S", + "product_code":"modelarts", + "title":"Deleting nodes in batches", + "uri":"BatchDeletePoolNodes.html", + "doc_type":"api", + "p_code":"174", + "code":"176" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Resource pool management", + "uri":"topic_300000008.html", + "doc_type":"api", + "p_code":"154", + "code":"177" + }, + { + "desc":"This API is used to create a resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK code and pr", + "product_code":"modelarts", + "title":"Creating a Resource Pool", + "uri":"CreatePool.html", + "doc_type":"api", + "p_code":"177", + "code":"178" + }, + { + "desc":"This API is used to obtain resource pools.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK code and pro", + "product_code":"modelarts", + "title":"Obtaining Resource Pools", + "uri":"ListPools.html", + "doc_type":"api", + "p_code":"177", + "code":"179" + }, + { + "desc":"This API is used to obtain details about a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generate", + "product_code":"modelarts", + "title":"Obtaining Details About a Resource Pool", + "uri":"ShowPool.html", + "doc_type":"api", + "p_code":"177", + "code":"180" + }, + { + "desc":"This API is used to delete a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK c", + "product_code":"modelarts", + "title":"Delete a Resource Pool", + "uri":"DeletePool.html", + "doc_type":"api", + "p_code":"177", + "code":"181" + }, + { + "desc":"This API is used to update a specified resource pool.You can debug this API in which supports automatic authentication. API Explorer automatically generates sample SDK c", + "product_code":"modelarts", + "title":"Updating a Resource Pool", + "uri":"PatchPool.html", + "doc_type":"api", + "p_code":"177", + "code":"182" + }, + { + "desc":"This API is used to obtain the monitored resource pool information.You can debug this API through automatic authentication in or use the SDK sample code generated by API", + "product_code":"modelarts", + "title":"Monitoring a Resource Pool", + "uri":"ShowPoolMonitor.html", + "doc_type":"api", + "p_code":"177", + "code":"183" + }, + { + "desc":"Obtain the statistics of a resource pool.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{project", + "product_code":"modelarts", + "title":"Resource Pool Statistics", + "uri":"ShowPoolStatistics.html", + "doc_type":"api", + "p_code":"177", + "code":"184" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"Resource flavor management APIs", + "uri":"resource_flavor_management.html", + "doc_type":"api", + "p_code":"154", + "code":"185" + }, + { + "desc":"Obtain resource specifications.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v1/{project_id}/resou", + "product_code":"modelarts", + "title":"Obtaining Resource Specifications", + "uri":"ListResourceFlavors.html", + "doc_type":"api", + "p_code":"185", + "code":"186" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", @@ -1581,7 +1680,16 @@ "uri":"authorization.html", "doc_type":"api", "p_code":"", - "code":"176" + "code":"187" + }, + { + "desc":"This API is used to view an authorization list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/{p", + "product_code":"modelarts", + "title":"Viewing an Authorization List", + "uri":"GetAuthorizations.html", + "doc_type":"api", + "p_code":"187", + "code":"188" }, { "desc":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", @@ -1589,35 +1697,26 @@ "title":"Configuring Authorization", "uri":"CreateAuthorization.html", "doc_type":"api", - "p_code":"176", - "code":"177" + "p_code":"187", + "code":"189" }, { - "desc":"This API is used to view an authorization list.GET /v2/{project_id}/authorizationsNoneStatus code: 200View an authorization list.Status code: 200OKSee Error Codes.", - "product_code":"modelarts", - "title":"Viewing an Authorization List", - "uri":"GetAuthorizations.html", - "doc_type":"api", - "p_code":"176", - "code":"178" - }, - { - "desc":"This API is used to delete the authorization of a specified user or all users.DELETE /v2/{project_id}/authorizationsNoneNoneDelete the authorization of a specified user.S", + "desc":"This API is used to delete the authorization of a specified user or all users.You can debug this API through automatic authentication in or use the SDK sample code gener", "product_code":"modelarts", "title":"Deleting Authorization", "uri":"DeleteAuthorizations.html", "doc_type":"api", - "p_code":"176", - "code":"179" + "p_code":"187", + "code":"190" }, { - "desc":"This API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneCreate a ModelArts agency.Status code: 200O", + "desc":"This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.You can debug this API through automatic authentication in ", "product_code":"modelarts", "title":"Creating a ModelArts Agency", "uri":"CreateModelArtsAgency.html", "doc_type":"api", - "p_code":"176", - "code":"180" + "p_code":"187", + "code":"191" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1626,7 +1725,7 @@ "uri":"modelarts_03_0138.html", "doc_type":"api", "p_code":"", - "code":"181" + "code":"192" }, { "desc":"This section describes fine-grained permissions management for your ModelArts. If your account does not require individual IAM users, skip this section.By default, new IA", @@ -1634,17 +1733,8 @@ "title":"Introduction", "uri":"modelarts_03_0146.html", "doc_type":"api", - "p_code":"181", - "code":"182" - }, - { - "desc":"ExeML APIs are inaccessible to external systems. To use ExeML functions on the console and manage permissions, perform the operations described in the following table.", - "product_code":"modelarts", - "title":"ExeML Permissions", - "uri":"modelarts_03_0234.html", - "doc_type":"api", - "p_code":"181", - "code":"183" + "p_code":"192", + "code":"193" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1652,26 +1742,35 @@ "title":"Data Management Permissions", "uri":"modelarts_03_0161.html", "doc_type":"api", - "p_code":"181", - "code":"184" + "p_code":"192", + "code":"194" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", - "title":"DevEnviron Permissions", + "title":"DevEnviron Permissions (New Version)", + "uri":"modelarts_03_0365.html", + "doc_type":"api", + "p_code":"192", + "code":"195" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"modelarts", + "title":"DevEnviron Permissions (Old Version)", "uri":"modelarts_03_0162.html", "doc_type":"api", - "p_code":"181", - "code":"185" + "p_code":"192", + "code":"196" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Training Job Permissions", - "uri":"modelarts_03_0163.html", + "uri":"modelarts_03_0364.html", "doc_type":"api", - "p_code":"181", - "code":"186" + "p_code":"192", + "code":"197" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1679,8 +1778,8 @@ "title":"Model Management Permissions", "uri":"modelarts_03_0164.html", "doc_type":"api", - "p_code":"181", - "code":"187" + "p_code":"192", + "code":"198" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1688,17 +1787,8 @@ "title":"Service Management Permissions", "uri":"modelarts_03_0165.html", "doc_type":"api", - "p_code":"181", - "code":"188" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"modelarts", - "title":"Workspace Management Permissions", - "uri":"modelarts_03_0166.html", - "doc_type":"api", - "p_code":"181", - "code":"189" + "p_code":"192", + "code":"199" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1707,7 +1797,7 @@ "uri":"modelarts_03_0093.html", "doc_type":"api", "p_code":"", - "code":"190" + "code":"200" }, { "desc":"Table 1 describes the status codes.", @@ -1715,8 +1805,8 @@ "title":"Status Code", "uri":"modelarts_03_0094.html", "doc_type":"api", - "p_code":"190", - "code":"191" + "p_code":"200", + "code":"201" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1724,8 +1814,8 @@ "title":"Error Codes", "uri":"modelarts_03_0095.html", "doc_type":"api", - "p_code":"190", - "code":"192" + "p_code":"200", + "code":"202" }, { "desc":"A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following me", @@ -1733,26 +1823,26 @@ "title":"Obtaining a Project ID and Name", "uri":"modelarts_03_0147.html", "doc_type":"api", - "p_code":"190", - "code":"193" + "p_code":"200", + "code":"203" }, { - "desc":"When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows:Log in to the console.Hover the cursor on the userna", + "desc":"When you call APIs, certain requests require the domain name and ID. To obtain a domain name and ID, do as follows:Log in to the ModelArts console.In the upper right corn", "product_code":"modelarts", - "title":"Obtaining the Account Name and Account ID", + "title":"Obtaining a Tenant Name and ID", "uri":"modelarts_03_0148.html", "doc_type":"api", - "p_code":"190", - "code":"194" + "p_code":"200", + "code":"204" }, { - "desc":"When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:Log in to the console.Hover the cursor on the username and ch", + "desc":"When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:Log in to the management console after registration.In the up", "product_code":"modelarts", "title":"Obtaining a Username and ID", "uri":"modelarts_03_0006.html", "doc_type":"api", - "p_code":"190", - "code":"195" + "p_code":"200", + "code":"205" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1761,6 +1851,6 @@ "uri":"modelarts_03_0097.html", "doc_type":"api", "p_code":"", - "code":"196" + "code":"206" } ] \ No newline at end of file diff --git a/docs/modelarts/api-ref/CancelObs.html b/docs/modelarts/api-ref/CancelObs.html index b57da3f3..fe10cf3d 100644 --- a/docs/modelarts/api-ref/CancelObs.html +++ b/docs/modelarts/api-ref/CancelObs.html @@ -1,47 +1,49 @@ - +

Unmounting OBS Storage from a Notebook Instance

-

Function

This API is used to unmount OBS storage from a notebook instance. After OBS storage is unmounted, OBS objects remain unchanged but cannot be operated in the notebook container.

+

Function

This API is used to unmount OBS storage from a notebook instance. After OBS storage is unmounted, OBS objects remain unchanged but cannot be operated in the notebook container.

Constraints

None

-

URI

DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

-

Status Code

Description

+

Description

200

+

200

OK

+

OK

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

404

+

404

Not Found

+

Not Found

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - - - - - @@ -52,47 +54,56 @@

Response Parameters

Status code: 200

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

instance_id

+

instance_id

Yes

+

Yes

String

+

String

Notebook instance ID.

+

Notebook instance ID.

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details, see Obtaining a Project ID.

+

Project ID. For details, see Obtaining a Project ID and Name.

storage_id

+

storage_id

Yes

+

Yes

String

+

String

OBS storage ID.

+

OBS storage ID.

Table 2 Response body parameters

Parameter

+
- - - - - - - - - - - - - - - - - @@ -112,30 +123,30 @@ }

Status Codes

-
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

category

+

category

String

+

String

Storage category. Options: - OBS

+

Storage category. Options:

+
  • OBS

    +

id

+

id

String

+

String

ID of the instance with OBS storage mounted.

+

ID of the instance with OBS storage mounted.

mount_path

+

mount_path

String

+

String

Path where OBS storage is mounted to a notebook instance.

+

Path where OBS storage is mounted to a notebook instance.

status

+

status

String

+

String

Status of OBS storage to be mounted. Options: \r\n-MOUNTING: OBS storage is being mounted. \r\n-MOUNT_FAILED: OBS storage fails to be mounted. \r\n-MOUNTED: OBS storage is mounted. \r\n-UNMOUNTING: OBS storage is being unmounted.\r\n-UNMOUNT_FAILED: OBS storage fails to be unmounted.\r\n-UNMOUNTED: OBS is unmounted.

+

Status of OBS storage to be mounted. Options:

+
  • MOUNTING: being mounted

    +
  • MOUNT_FAILED: mounting failed

    +
  • MOUNTED: mounted

    +
  • UNMOUNTING: being unmounted

    +
  • UNMOUNT_FAILED: unmounting failed

    +
  • UNMOUNTED: unmounted

    +

uri

+

uri

String

+

String

OBS parallel file system path.

+

OBS object path

Status Code

+
- - - - - - - - - @@ -147,7 +158,7 @@
diff --git a/docs/modelarts/api-ref/ChangeAlgorithm.html b/docs/modelarts/api-ref/ChangeAlgorithm.html index 886c22d6..124db388 100644 --- a/docs/modelarts/api-ref/ChangeAlgorithm.html +++ b/docs/modelarts/api-ref/ChangeAlgorithm.html @@ -1,94 +1,13 @@ - +

Modifying an Algorithm

-

Function

This API is used to modify an algorithm.

+

Function

This API is used to modify an algorithm.

-

URI

PUT /v2/{project_id}/algorithms/{algorithm_id}

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+
+

URI

PUT /v2/{project_id}/algorithms/{algorithm_id}

-

Status Code

Description

+

Description

200

+

200

OK

+

OK

204

+

204

No Content

+

No Content

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

- - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID. For details, see Obtaining a Project ID.

-

algorithm_id

-

Yes

-

String

-

Algorithm ID.

-
-
- -

Request Parameters

-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 2 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

metadata

-

No

-

metadata object

-

Algorithm metadata, which describes basic algorithm information.

-

job_config

-

No

-

job_config object

-

Algorithm configuration, such as the boot file.

-

resource_requirements

-

No

-

Array of resource_requirements objects

-

Algorithm resource constraint. You can disable this function by not setting this parameter.

-

advanced_config

-

No

-

advanced_config object

-

Advanced algorithm configuration. Currently, autosearch is supported.

-
-
- -
Table 3 metadata

Parameter

+
@@ -98,367 +17,450 @@ - - - - - - - - - - - +
Table 1 Path Parameters

Parameter

Mandatory

id

-

No

-

Integer

-

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

-

name

+

project_id

Yes

String

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

+

Project ID. For details, see Obtaining a Project ID and Name.

description

+

algorithm_id

No

+

Yes

String

Algorithm description. The value must contain 0 to 256 characters. The default value is NULL.

+

Algorithm ID.

workspace_id

+
+
+ +

Request Parameters

+
+ + + + + + - - - - - - - + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

metadata

No

+

No

String

+

metadata object

Workspace where a specified algorithm is located. The default value is 0.

+

Algorithm metadata, which describes basic algorithm information.

ai_project

+

job_config

No

+

No

String

+

job_config object

AI project to which a specified algorithm belongs. The default value is default-ai-project.

+

Algorithm configuration, such as the boot file.

+

resource_requirements

+

No

+

Array of resource_requirements objects

+

Algorithm resource constraint. You can disable this function by not setting this parameter.

+

advanced_config

+

No

+

advanced_config object

+

Advanced algorithm configuration. Currently, autosearch is supported.

-
Table 4 job_config

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 metadata

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

code_dir

+

id

No

+

No

String

+

Integer

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

+

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

boot_file

+

name

No

+

Yes

String

+

String

Code boot file of the algorithm, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with code_dir.

+

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

command

+

description

No

+

No

String

+

String

Container startup command of a custom image algorithm.

+

Algorithm description, which consists of 0 to 256 characters. The default value is NULL.

parameters

+

workspace_id

No

+

No

Array of Parameter objects

+

String

Running parameter of an algorithm.

+

Workspace where a specified algorithm is located. The default value is 0.

inputs

+

ai_project

No

+

No

Array of inputs objects

+

String

Data input of an algorithm.

-

outputs

-

No

-

Array of outputs objects

-

Data output of an algorithm.

-

engine

-

No

-

engine object

-

Algorithm engine.

-

parameters_customization

-

No

-

Boolean

-

Whether the algorithm allows hyperparameter customization during training job creation.

+

AI project to which a specified algorithm belongs. The default value is default-ai-project.

-
Table 5 Parameter

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + +
Table 4 job_config

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

code_dir

No

+

No

String

+

String

Parameter name.

+

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

value

+

boot_file

No

+

No

String

+

String

Parameter value.

+

Code boot file of the algorithm, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with code_dir.

description

+

command

No

+

No

String

+

String

Parameter description.

+

Container startup command of a custom image algorithm.

constraint

+

parameters

No

+

No

constraint object

+

Array of Parameter objects

Parameter constraint.

+

Running parameter of an algorithm.

i18n_description

+

inputs

No

+

No

i18n_description object

+

Array of inputs objects

Internationalization description.

+

Data input of an algorithm.

+

outputs

+

No

+

Array of outputs objects

+

Data output of an algorithm.

+

engine

+

No

+

engine object

+

Algorithm engine.

+

parameters_customization

+

No

+

Boolean

+

Whether the algorithm allows hyperparameter customization during training job creation.

-
Table 6 constraint

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 Parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

name

No

+

No

String

+

String

Parameter type.

+

Parameter name.

editable

+

value

No

+

No

Boolean

+

String

Whether the parameter is editable.

+

Parameter value.

required

+

description

No

+

No

Boolean

+

String

Whether the parameter is mandatory.

+

Parameter description.

sensitive

+

constraint

No

+

No

Boolean

+

constraint object

Whether the parameter is sensitive.

+

Parameter constraint.

valid_type

+

i18n_description

No

+

No

String

+

i18n_description object

Valid type.

-

valid_range

-

No

-

Array of strings

-

Valid range.

+

Internationalization description.

-
Table 7 i18n_description

Parameter

+
- - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
Table 6 constraint

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

language

+

type

No

+

No

String

+

String

Internationalization language.

+

Parameter type.

description

+

editable

No

+

No

String

+

Boolean

Description.

+

Whether the parameter is editable.

+

required

+

No

+

Boolean

+

Whether the parameter is mandatory.

+

sensitive

+

No

+

Boolean

+

Whether the parameter is sensitive.

+

valid_type

+

No

+

String

+

Valid type.

+

valid_range

+

No

+

Array of strings

+

Valid range.

-
Table 8 inputs

Parameter

+
- - - - - - - - - - - - - - - -
Table 7 i18n_description

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

language

Yes

+

No

String

+

String

Name of the data input channel.

+

Internationalization language.

description

+

description

No

+

No

String

+

String

Description of the data input channel.

-

remote_constraints

-

No

-

Array of remote_constraints objects

-

Data input constraint.

+

Description.

-
Table 9 remote_constraints

Parameter

+
- - - - - - - - - - - + + + + + + + +
Table 8 inputs

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

data_type

+

name

No

+

Yes

String

+

String

Data input type, including the data storage location and dataset.

+

Name of the data input channel.

attributes

+

description

No

+

No

Array of Map<String,String> objects

+

String

Attributes if a dataset is used as the data input. Options:

+

Description of the data input channel.

+

remote_constraints

+

No

+

Array of remote_constraints objects

+

Data input constraint.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 remote_constraints

Parameter

+

Mandatory

+

Type

+

Description

+

data_type

+

No

+

String

+

Data input type, including the data storage location and dataset.

+

attributes

+

No

+

Array of Map<String,String> objects

+

Attributes if a dataset is used as the data input. Options:

  • data_format: Data format

  • data_segmentation: Data segmentation

  • dataset_type: Labeling type

    @@ -469,384 +471,388 @@
-
Table 10 outputs

Parameter

+
- - - - - - - - - - -
Table 10 outputs

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

String

Name of the data output channel.

+

Name of the data output channel.

description

+

description

No

+

No

String

+

String

Description of the data output channel.

+

Description of the data output channel.

-
Table 11 engine

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 11 engine

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

engine_id

+

engine_id

No

+

No

String

+

String

Engine ID selected for an algorithm.

+

Engine ID selected for an algorithm.

engine_name

+

engine_name

No

+

No

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

engine_version

+

engine_version

No

+

No

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

image_url

+

image_url

No

+

No

String

+

String

Custom image URL selected by an algorithm.

+

Custom image URL selected by an algorithm.

-
Table 12 resource_requirements

Parameter

+
- - - - - - - - - - - - - - -
Table 12 resource_requirements

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

No

+

No

String

+

String

Resource constraint. The options are as follows:- flavor_type: flavor type. The value can be CPU or GPU.- device_distributed_mode: whether to support multi-device training. The value can be multiple (supported) or singular (not supported).-host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

+

Resource constraints. Options:

+
  • flavor_type: flavor type, which can be CPU or GPU.

    +
  • device_distributed_mode: whether to support multi-card training. The value can be multiple (supported) or singular (not supported).

    +
  • host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

    +

values

+

values

No

+

No

Array of strings

+

Array of strings

Value of the resource constraint key.

+

Value of the resource constraint key.

operator

+

operator

No

+

No

String

+

String

Relationship between keys and values. Currently, only in is supported. For example: flavor_type in [CPU,GPU].

+

Relationship between keys and values. Currently, only in is supported. For example: flavor_type in [CPU,GPU].

-
Table 13 advanced_config

Parameter

+
- - - - - - -
Table 13 advanced_config

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

auto_search

+

auto_search

No

+

No

auto_search object

+

auto_search object

Hyperparameter search policy.

+

Hyperparameter search policy.

-