diff --git a/docs/modelarts/api-ref/ALL_META.TXT.json b/docs/modelarts/api-ref/ALL_META.TXT.json index 6b9ee5469..08939aeee 100644 --- a/docs/modelarts/api-ref/ALL_META.TXT.json +++ b/docs/modelarts/api-ref/ALL_META.TXT.json @@ -13,7 +13,7 @@ "uri":"modelarts_03_0001.html", "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", + "des":"Before calling a ModelArts API, ensure that you have fully understood the concepts related to ModelArts. For details, see the Service Overview.", "doc_type":"api", "kw":"Overview,Before You Start,API Reference", "title":"Overview", @@ -23,7 +23,7 @@ "uri":"modelarts_03_0140.html", "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.", + "des":"ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.In addition, ModelA", "doc_type":"api", "kw":"API Calling,Before You Start,API Reference", "title":"API Calling", @@ -33,7 +33,7 @@ "uri":"modelarts_03_0141.html", "product_code":"modelarts", "code":"4", - "des":"Endpoints are request address for calling APIs. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrato", + "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.If a", "doc_type":"api", "kw":"Endpoints,Before You Start,API Reference", "title":"Endpoints", @@ -99,100 +99,10 @@ "title":"Response", "githuburl":"" }, - { - "uri":"modelarts_03_0108.html", - "product_code":"modelarts", - "code":"11", - "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", - "title":"DevEnviron", - "githuburl":"" - }, - { - "uri":"modelarts_03_0109.html", - "product_code":"modelarts", - "code":"12", - "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,API Referen", - "title":"Querying the Authentication Information of a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0110.html", - "product_code":"modelarts", - "code":"13", - "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,API Reference", - "title":"Creating a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0111.html", - "product_code":"modelarts", - "code":"14", - "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", - "doc_type":"api", - "kw":"Querying a List of Development Environment Instances,DevEnviron,API Reference", - "title":"Querying a List of Development Environment Instances", - "githuburl":"" - }, - { - "uri":"modelarts_03_0112.html", - "product_code":"modelarts", - "code":"15", - "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", - "doc_type":"api", - "kw":"Querying the Details About a Development Environment Instance,DevEnviron,API Reference", - "title":"Querying the Details About a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0113.html", - "product_code":"modelarts", - "code":"16", - "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,API Reference", - "title":"Modifying the Description of a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0114.html", - "product_code":"modelarts", - "code":"17", - "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,API Reference", - "title":"Deleting a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0115.html", - "product_code":"modelarts", - "code":"18", - "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,API Reference", - "title":"Managing a Development Environment Instance", - "githuburl":"" - }, - { - "uri":"modelarts_03_0152.html", - "product_code":"modelarts", - "code":"19", - "des":"This API is used to restart an ML Studio development environment instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required par", - "doc_type":"api", - "kw":"Restarting an ML Studio Instance,DevEnviron,API Reference", - "title":"Restarting an ML Studio Instance", - "githuburl":"" - }, { "uri":"modelarts_03_0202.html", "product_code":"modelarts", - "code":"20", + "code":"11", "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", @@ -202,7 +112,7 @@ { "uri":"modelarts_03_0299.html", "product_code":"modelarts", - "code":"21", + "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", @@ -211,8 +121,8 @@ }, { "uri":"dataset_management.html", - "product_code":"modelarts", - "code":"22", + "product_code":"", + "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.", "doc_type":"api", "kw":"Dataset Management", @@ -221,8 +131,8 @@ }, { "uri":"ListDatasets.html", - "product_code":"modelarts", - "code":"23", + "product_code":"", + "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":"Response body for querying the dataset list.,Dataset Management,API Reference", @@ -231,8 +141,8 @@ }, { "uri":"CreateDataset.html", - "product_code":"modelarts", - "code":"24", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Dataset,Dataset Management,API Reference", @@ -241,8 +151,8 @@ }, { "uri":"DescDataset.html", - "product_code":"modelarts", - "code":"25", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About a Dataset,Dataset Management,API Reference", @@ -251,8 +161,8 @@ }, { "uri":"UpdateDataset.html", - "product_code":"modelarts", - "code":"26", + "product_code":"", + "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", "doc_type":"api", "kw":"Modifying a Dataset,Dataset Management,API Reference", @@ -261,8 +171,8 @@ }, { "uri":"DeleteDataset.html", - "product_code":"modelarts", - "code":"27", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting a Dataset,Dataset Management,API Reference", @@ -271,8 +181,8 @@ }, { "uri":"ListStats.html", - "product_code":"modelarts", - "code":"28", + "product_code":"", + "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: ", "doc_type":"api", "kw":"Querying Dataset Statistics,Dataset Management,API Reference", @@ -281,8 +191,8 @@ }, { "uri":"GetDatasetMetrics.html", - "product_code":"modelarts", - "code":"29", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Monitoring Data of a Dataset,Dataset Management,API Reference", @@ -291,8 +201,8 @@ }, { "uri":"ListWorkforceTaskStats.html", - "product_code":"modelarts", - "code":"30", + "product_code":"", + "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", @@ -301,8 +211,8 @@ }, { "uri":"GetWorkforceTaskMetrics.html", - "product_code":"modelarts", - "code":"31", + "product_code":"", + "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", @@ -311,8 +221,8 @@ }, { "uri":"dataset_version_management.html", - "product_code":"modelarts", - "code":"32", + "product_code":"", + "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", @@ -321,8 +231,8 @@ }, { "uri":"ListDatasetVersions.html", - "product_code":"modelarts", - "code":"33", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Dataset Version List,Dataset Version Management,API Reference", @@ -331,8 +241,8 @@ }, { "uri":"CreateDatasetVersion.html", - "product_code":"modelarts", - "code":"34", + "product_code":"", + "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: ", "doc_type":"api", "kw":"Creating a Dataset Labeling Version,Dataset Version Management,API Reference", @@ -341,8 +251,8 @@ }, { "uri":"DescribeDatasetVersion.html", - "product_code":"modelarts", - "code":"35", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About a Dataset Version,Dataset Version Management,API Reference", @@ -351,8 +261,8 @@ }, { "uri":"DeleteDatasetVersion.html", - "product_code":"modelarts", - "code":"36", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting a Dataset Labeling Version,Dataset Version Management,API Reference", @@ -361,8 +271,8 @@ }, { "uri":"sample_management.html", - "product_code":"modelarts", - "code":"37", + "product_code":"", + "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", @@ -371,8 +281,8 @@ }, { "uri":"ListSamples.html", - "product_code":"modelarts", - "code":"38", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Sample List,Sample Management,API Reference", @@ -381,8 +291,8 @@ }, { "uri":"UploadSamplesJson.html", - "product_code":"modelarts", - "code":"39", + "product_code":"", + "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", "doc_type":"api", "kw":"Adding Samples in Batches,Sample Management,API Reference", @@ -391,8 +301,8 @@ }, { "uri":"DeleteSamples.html", - "product_code":"modelarts", - "code":"40", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting Samples in Batches,Sample Management,API Reference", @@ -401,8 +311,8 @@ }, { "uri":"DescribeSample.html", - "product_code":"modelarts", - "code":"41", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About a Sample,Sample Management,API Reference", @@ -411,8 +321,8 @@ }, { "uri":"ListSearch.html", - "product_code":"modelarts", - "code":"42", + "product_code":"", + "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", "doc_type":"api", "kw":"Obtaining Sample Search Condition,Sample Management,API Reference", @@ -421,8 +331,8 @@ }, { "uri":"ListWorkforceTaskSamples.html", - "product_code":"modelarts", - "code":"43", + "product_code":"", + "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/", "doc_type":"api", "kw":"Querying the Sample List of a Team Labeling Task by Page,Sample Management,API Reference", @@ -431,8 +341,8 @@ }, { "uri":"DescribeWorkforceTaskSample.html", - "product_code":"modelarts", - "code":"44", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About Team Labeling Samples,Sample Management,API Reference", @@ -441,8 +351,8 @@ }, { "uri":"label_management.html", - "product_code":"modelarts", - "code":"45", + "product_code":"", + "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", @@ -451,8 +361,8 @@ }, { "uri":"ListLabels.html", - "product_code":"modelarts", - "code":"46", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Dataset Label List,Label Management,API Reference", @@ -461,8 +371,8 @@ }, { "uri":"CreateLabels.html", - "product_code":"modelarts", - "code":"47", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Dataset Label,Label Management,API Reference", @@ -471,8 +381,8 @@ }, { "uri":"UpdateLabels.html", - "product_code":"modelarts", - "code":"48", + "product_code":"", + "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", "doc_type":"api", "kw":"Modifying Labels in Batches,Label Management,API Reference", @@ -481,8 +391,8 @@ }, { "uri":"DeleteLabels.html", - "product_code":"modelarts", - "code":"49", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting Labels in Batches,Label Management,API Reference", @@ -491,8 +401,8 @@ }, { "uri":"UpdateLabel.html", - "product_code":"modelarts", - "code":"50", + "product_code":"", + "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", "doc_type":"api", "kw":"Updating a Label by Label Names,Label Management,API Reference", @@ -501,8 +411,8 @@ }, { "uri":"DeleteLabelAndSamples.html", - "product_code":"modelarts", - "code":"51", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting a Label and the Files that Only Contain the Label,Label Management,API Reference", @@ -511,8 +421,8 @@ }, { "uri":"manual_annotation_management.html", - "product_code":"modelarts", - "code":"52", + "product_code":"", + "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", @@ -521,8 +431,8 @@ }, { "uri":"UpdateSamples.html", - "product_code":"modelarts", - "code":"53", + "product_code":"", + "code":"44", "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", @@ -531,8 +441,8 @@ }, { "uri":"label_task_management.html", - "product_code":"modelarts", - "code":"54", + "product_code":"", + "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", @@ -541,8 +451,8 @@ }, { "uri":"ListWorkforceTasks.html", - "product_code":"modelarts", - "code":"55", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Team Labeling Task List of a Dataset,Labeling Task Management,API Reference", @@ -551,8 +461,8 @@ }, { "uri":"CreateWorkforceTask.html", - "product_code":"modelarts", - "code":"56", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Team Labeling Task,Labeling Task Management,API Reference", @@ -561,8 +471,8 @@ }, { "uri":"DescWorkforceTask.html", - "product_code":"modelarts", - "code":"57", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About a Team Labeling Task,Labeling Task Management,API Reference", @@ -571,8 +481,8 @@ }, { "uri":"StartWorkforceTask.html", - "product_code":"modelarts", - "code":"58", + "product_code":"", + "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", "doc_type":"api", "kw":"Starting a Team Labeling Task,Labeling Task Management,API Reference", @@ -581,8 +491,8 @@ }, { "uri":"UpdateWorkforceTask.html", - "product_code":"modelarts", - "code":"59", + "product_code":"", + "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", "doc_type":"api", "kw":"Updating a Team Labeling Task,Labeling Task Management,API Reference", @@ -591,8 +501,8 @@ }, { "uri":"DeleteWorkforceTask.html", - "product_code":"modelarts", - "code":"60", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting a Team Labeling Task,Labeling Task Management,API Reference", @@ -601,8 +511,8 @@ }, { "uri":"StartWorkforceSamplingTask.html", - "product_code":"modelarts", - "code":"61", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Team Labeling Acceptance Task,Labeling Task Management,API Reference", @@ -611,8 +521,8 @@ }, { "uri":"GetWorkforceSamplingTask.html", - "product_code":"modelarts", - "code":"62", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Report of a Team Labeling Acceptance Task,Labeling Task Management,API Reference", @@ -621,8 +531,8 @@ }, { "uri":"UpdateWorkforceSamplingTask.html", - "product_code":"modelarts", - "code":"63", + "product_code":"", + "code":"54", "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", @@ -631,8 +541,8 @@ }, { "uri":"ListWorkerTasks.html", - "product_code":"modelarts", - "code":"64", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Team Labeling Task List by a Team Member,Labeling Task Management,API Reference", @@ -641,8 +551,8 @@ }, { "uri":"workforce_process_management.html", - "product_code":"modelarts", - "code":"65", + "product_code":"", + "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", @@ -651,8 +561,8 @@ }, { "uri":"AcceptSamples.html", - "product_code":"modelarts", - "code":"66", + "product_code":"", + "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", "doc_type":"api", "kw":"Submitting Sample Review Comments of an Acceptance Task,Team Labeling Process Management,API Referen", @@ -661,8 +571,8 @@ }, { "uri":"ReviewSamples.html", - "product_code":"modelarts", - "code":"67", + "product_code":"", + "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", "doc_type":"api", "kw":"Reviewing Team Labeling Results,Team Labeling Process Management,API Reference", @@ -671,8 +581,8 @@ }, { "uri":"UpdateWorkforceTaskSamples.html", - "product_code":"modelarts", - "code":"68", + "product_code":"", + "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", "doc_type":"api", "kw":"Updating Labels of Team Labeling Samples in Batches,Team Labeling Process Management,API Reference", @@ -681,8 +591,8 @@ }, { "uri":"workforce_management.html", - "product_code":"modelarts", - "code":"69", + "product_code":"", + "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", @@ -691,8 +601,8 @@ }, { "uri":"ListWorkforces.html", - "product_code":"modelarts", - "code":"70", + "product_code":"", + "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.", "doc_type":"api", "kw":"Querying the Labeling Team List,Labeling Team Management,API Reference", @@ -701,8 +611,8 @@ }, { "uri":"CreateWorkforce.html", - "product_code":"modelarts", - "code":"71", + "product_code":"", + "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.", "doc_type":"api", "kw":"Creating a Labeling Team,Labeling Team Management,API Reference", @@ -711,8 +621,8 @@ }, { "uri":"DescWorkforce.html", - "product_code":"modelarts", - "code":"72", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About a Labeling Team,Labeling Team Management,API Reference", @@ -721,8 +631,8 @@ }, { "uri":"UpdateWorkforce.html", - "product_code":"modelarts", - "code":"73", + "product_code":"", + "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.", "doc_type":"api", "kw":"Updating a Labeling Team,Labeling Team Management,API Reference", @@ -731,8 +641,8 @@ }, { "uri":"DeleteWorkforce.html", - "product_code":"modelarts", - "code":"74", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting a Labeling Team,Labeling Team Management,API Reference", @@ -741,8 +651,8 @@ }, { "uri":"workforce_worker_management.html", - "product_code":"modelarts", - "code":"75", + "product_code":"", + "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", @@ -751,8 +661,8 @@ }, { "uri":"SendEmails.html", - "product_code":"modelarts", - "code":"76", + "product_code":"", + "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 ", "doc_type":"api", "kw":"Sending an Email to a Labeling Team Member,Labeling Team Member Management,API Reference", @@ -761,8 +671,8 @@ }, { "uri":"ListAllWorkers.html", - "product_code":"modelarts", - "code":"77", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the List of All Labeling Team Members,Labeling Team Member Management,API Reference", @@ -771,8 +681,8 @@ }, { "uri":"ListWorkers.html", - "product_code":"modelarts", - "code":"78", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the List of Labeling Team Members,Labeling Team Member Management,API Reference", @@ -781,8 +691,8 @@ }, { "uri":"CreateWorker.html", - "product_code":"modelarts", - "code":"79", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Labeling Team Member,Labeling Team Member Management,API Reference", @@ -791,8 +701,8 @@ }, { "uri":"DeleteWorkers.html", - "product_code":"modelarts", - "code":"80", + "product_code":"", + "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", "doc_type":"api", "kw":"Deleting Labeling Team Members in Batches,Labeling Team Member Management,API Reference", @@ -801,8 +711,8 @@ }, { "uri":"DescWorker.html", - "product_code":"modelarts", - "code":"81", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying Details About Labeling Team Members,Labeling Team Member Management,API Reference", @@ -811,8 +721,8 @@ }, { "uri":"UpdateWorker.html", - "product_code":"modelarts", - "code":"82", + "product_code":"", + "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", "doc_type":"api", "kw":"Updating a Labeling Team Member,Labeling Team Member Management,API Reference", @@ -821,8 +731,8 @@ }, { "uri":"DeleteWorker.html", - "product_code":"modelarts", - "code":"83", + "product_code":"", + "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:", "doc_type":"api", "kw":"Deleting a Labeling Team Member,Labeling Team Member Management,API Reference", @@ -831,8 +741,8 @@ }, { "uri":"data_import.html", - "product_code":"modelarts", - "code":"84", + "product_code":"", + "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", @@ -841,8 +751,8 @@ }, { "uri":"ListImportTasks.html", - "product_code":"modelarts", - "code":"85", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Dataset Import Task List,Data Import Task,API Reference", @@ -851,8 +761,8 @@ }, { "uri":"ImportTask.html", - "product_code":"modelarts", - "code":"86", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating an Import Task,Data Import Task,API Reference", @@ -861,8 +771,8 @@ }, { "uri":"DescImportTask.html", - "product_code":"modelarts", - "code":"87", + "product_code":"", + "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 ", "doc_type":"api", "kw":"Querying Details About a Dataset Import Task,Data Import Task,API Reference", @@ -871,8 +781,8 @@ }, { "uri":"data_export.html", - "product_code":"modelarts", - "code":"88", + "product_code":"", + "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", @@ -881,8 +791,8 @@ }, { "uri":"GetExportTasksStatusOfDataset.html", - "product_code":"modelarts", - "code":"89", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Dataset Export Task List,Data Export Task,API Reference", @@ -891,8 +801,8 @@ }, { "uri":"ExportTask.html", - "product_code":"modelarts", - "code":"90", + "product_code":"", + "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", "doc_type":"api", "kw":"Creating a Dataset Export Task,Data Export Task,API Reference", @@ -901,8 +811,8 @@ }, { "uri":"GetExportTaskStatusOfDataset.html", - "product_code":"modelarts", - "code":"91", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Status of a Dataset Export Task,Data Export Task,API Reference", @@ -911,8 +821,8 @@ }, { "uri":"data_sync.html", - "product_code":"modelarts", - "code":"92", + "product_code":"", + "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", @@ -921,8 +831,8 @@ }, { "uri":"SyncDataSource.html", - "product_code":"modelarts", - "code":"93", + "product_code":"", + "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", "doc_type":"api", "kw":"Synchronizing a Dataset,Data Synchronization Task,API Reference", @@ -931,8 +841,8 @@ }, { "uri":"SyncDataSourceState.html", - "product_code":"modelarts", - "code":"94", + "product_code":"", + "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", "doc_type":"api", "kw":"Querying the Status of a Dataset Synchronization Task,Data Synchronization Task,API Reference", @@ -940,209 +850,79 @@ "githuburl":"" }, { - "uri":"auto_task.html", + "uri":"modelarts_03_0108.html", "product_code":"modelarts", - "code":"95", + "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", - "title":"Intelligent Task", + "kw":"DevEnviron", + "title":"DevEnviron", "githuburl":"" }, { - "uri":"ListAutoAnnotationSamples.html", + "uri":"modelarts_03_0110.html", "product_code":"modelarts", - "code":"96", - "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":"87", + "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":"Querying Auto Labeling Sample List,Intelligent Task,API Reference", - "title":"Querying Auto Labeling Sample List", + "kw":"Creating a Development Environment Instance,DevEnviron,API Reference", + "title":"Creating a Development Environment Instance", "githuburl":"" }, { - "uri":"DescribeAutoAnnotationSample.html", + "uri":"modelarts_03_0111.html", "product_code":"modelarts", - "code":"97", - "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":"88", + "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", "doc_type":"api", - "kw":"Querying Details About an Auto Labeling Sample,Intelligent Task,API Reference", - "title":"Querying Details About an Auto Labeling Sample", + "kw":"Querying a List of Development Environment Instances,DevEnviron,API Reference", + "title":"Querying a List of Development Environment Instances", "githuburl":"" }, { - "uri":"ListTasks.html", + "uri":"modelarts_03_0112.html", "product_code":"modelarts", - "code":"98", - "des":"This API is used to query the intelligent task list by page, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the type parame", + "code":"89", + "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", "doc_type":"api", - "kw":"Querying the Intelligent Task List by Page,Intelligent Task,API Reference", - "title":"Querying the Intelligent Task List by Page", + "kw":"Querying Details About a Development Environment Instance,DevEnviron,API Reference", + "title":"Querying Details About a Development Environment Instance", "githuburl":"" }, { - "uri":"CreateTask.html", + "uri":"modelarts_03_0113.html", "product_code":"modelarts", - "code":"99", - "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":"90", + "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":"Starting Intelligent Tasks,Intelligent Task,API Reference", - "title":"Starting Intelligent Tasks", + "kw":"Modifying the Description of a Development Environment Instance,DevEnviron,API Reference", + "title":"Modifying the Description of a Development Environment Instance", "githuburl":"" }, { - "uri":"AutoAnnotationProgress.html", + "uri":"modelarts_03_0114.html", "product_code":"modelarts", - "code":"100", - "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":"91", + "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":"Obtaining Information About Intelligent Tasks,Intelligent Task,API Reference", - "title":"Obtaining Information About Intelligent Tasks", + "kw":"Deleting a Development Environment Instance,DevEnviron,API Reference", + "title":"Deleting a Development Environment Instance", "githuburl":"" }, { - "uri":"StopAutoAnnotation.html", + "uri":"modelarts_03_0115.html", "product_code":"modelarts", - "code":"101", - "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":"92", + "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":"Stopping an Intelligent Task,Intelligent Task,API Reference", - "title":"Stopping an Intelligent Task", - "githuburl":"" - }, - { - "uri":"process_task.html", - "product_code":"modelarts", - "code":"102", - "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", - "title":"Processing Task", - "githuburl":"" - }, - { - "uri":"ListProcessorTasks.html", - "product_code":"modelarts", - "code":"103", - "des":"This API is used to query the list of a processing task. You can query the feature analysis tasks and data processing tasks. You can specify the task_type parameter to qu", - "doc_type":"api", - "kw":"Querying the List of a Processing Task,Processing Task,API Reference", - "title":"Querying the List of a Processing Task", - "githuburl":"" - }, - { - "uri":"CreateProcessorTask.html", - "product_code":"modelarts", - "code":"104", - "des":"This API is used to create a processing task. You can create feature analysis tasks and data processing tasks. You can specify the id field of template composite paramete", - "doc_type":"api", - "kw":"Creating a Processing Task,Processing Task,API Reference", - "title":"Creating a Processing Task", - "githuburl":"" - }, - { - "uri":"GetProcessorTaskItems.html", - "product_code":"modelarts", - "code":"105", - "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", - "doc_type":"api", - "kw":"Querying the Algorithm Type for Data Processing,Processing Task,API Reference", - "title":"Querying the Algorithm Type for Data Processing", - "githuburl":"" - }, - { - "uri":"DescribeProcessorTask.html", - "product_code":"modelarts", - "code":"106", - "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", - "doc_type":"api", - "kw":"Querying Details About a Processing Task,Processing Task,API Reference", - "title":"Querying Details About a Processing Task", - "githuburl":"" - }, - { - "uri":"UpdateProcessorTask.html", - "product_code":"modelarts", - "code":"107", - "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", - "doc_type":"api", - "kw":"Updating a Processing Task,Processing Task,API Reference", - "title":"Updating a Processing Task", - "githuburl":"" - }, - { - "uri":"DeleteProcessorTask.html", - "product_code":"modelarts", - "code":"108", - "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", - "doc_type":"api", - "kw":"Deleting a Processing Task,Processing Task,API Reference", - "title":"Deleting a Processing Task", - "githuburl":"" - }, - { - "uri":"ListProcessorTaskVersions.html", - "product_code":"modelarts", - "code":"109", - "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 ", - "doc_type":"api", - "kw":"Querying the Version List of a Data Processing Task,Processing Task,API Reference", - "title":"Querying the Version List of a Data Processing Task", - "githuburl":"" - }, - { - "uri":"CreateProcessorTaskVersion.html", - "product_code":"modelarts", - "code":"110", - "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", - "doc_type":"api", - "kw":"Creating a Data Processing Task Version,Processing Task,API Reference", - "title":"Creating a Data Processing Task Version", - "githuburl":"" - }, - { - "uri":"DescProcessorTaskVersion.html", - "product_code":"modelarts", - "code":"111", - "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", - "doc_type":"api", - "kw":"Querying the Details About the Version of a Data Processing Task,Processing Task,API Reference", - "title":"Querying the Details About the Version of a Data Processing Task", - "githuburl":"" - }, - { - "uri":"DeleteProcessorTaskVersion.html", - "product_code":"modelarts", - "code":"112", - "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", - "doc_type":"api", - "kw":"Deleting a Data Processing Task Version,Processing Task,API Reference", - "title":"Deleting a Data Processing Task Version", - "githuburl":"" - }, - { - "uri":"ListProcessorTaskVersionResults.html", - "product_code":"modelarts", - "code":"113", - "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", - "doc_type":"api", - "kw":"Querying the Result of a Data Processing Task Version,Processing Task,API Reference", - "title":"Querying the Result of a Data Processing Task Version", - "githuburl":"" - }, - { - "uri":"StopProcessorTaskVersion.html", - "product_code":"modelarts", - "code":"114", - "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 ", - "doc_type":"api", - "kw":"Stopping the Version of a Data Processing Task,Processing Task,API Reference", - "title":"Stopping the Version of a Data Processing Task", + "kw":"Managing a Development Environment Instance,DevEnviron,API Reference", + "title":"Managing a Development Environment Instance", "githuburl":"" }, { "uri":"modelarts_03_0043.html", "product_code":"modelarts", - "code":"115", + "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":"Training Management", @@ -1152,7 +932,7 @@ { "uri":"modelarts_03_0044.html", "product_code":"modelarts", - "code":"116", + "code":"94", "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 Jobs", @@ -1162,7 +942,7 @@ { "uri":"modelarts_03_0045.html", "product_code":"modelarts", - "code":"117", + "code":"95", "des":"This API is used to create a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", "doc_type":"api", "kw":"Creating a Training Job,Training Jobs,API Reference", @@ -1172,8 +952,8 @@ { "uri":"modelarts_03_0046.html", "product_code":"modelarts", - "code":"118", - "des":"This API is used to query the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.ParametersPa", + "code":"96", + "des":"This API is used to query the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.URI paramete", "doc_type":"api", "kw":"Querying a Training Job List,Training Jobs,API Reference", "title":"Querying a Training Job List", @@ -1182,7 +962,7 @@ { "uri":"modelarts_03_0047.html", "product_code":"modelarts", - "code":"119", + "code":"97", "des":"This API is used to query the details about a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}Table 1 describe", "doc_type":"api", "kw":"Querying the Details About a Training Job Version,Training Jobs,API Reference", @@ -1192,7 +972,7 @@ { "uri":"modelarts_03_0048.html", "product_code":"modelarts", - "code":"120", + "code":"98", "des":"This API is used to delete a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", "doc_type":"api", "kw":"Deleting a Version of a Training Job,Training Jobs,API Reference", @@ -1202,7 +982,7 @@ { "uri":"modelarts_03_0049.html", "product_code":"modelarts", - "code":"121", + "code":"99", "des":"This API is used to query the version of a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versionsTable 1 describes the required p", "doc_type":"api", "kw":"Querying a List of Training Job Versions,Training Jobs,API Reference", @@ -1212,7 +992,7 @@ { "uri":"modelarts_03_0050.html", "product_code":"modelarts", - "code":"122", + "code":"100", "des":"This API is used to create a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", "doc_type":"api", "kw":"Creating a Version of a Training Job,Training Jobs,API Reference", @@ -1222,7 +1002,7 @@ { "uri":"modelarts_03_0051.html", "product_code":"modelarts", - "code":"123", + "code":"101", "des":"This API is used to stop a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training", "doc_type":"api", "kw":"Stopping a Training Job,Training Jobs,API Reference", @@ -1232,7 +1012,7 @@ { "uri":"modelarts_03_0052.html", "product_code":"modelarts", - "code":"124", + "code":"102", "des":"This API is used to modify the description of a training job.PUT /v1/{project_id}/training-jobs/{job_id}Table 1 describes the required parameters.ParametersParameterManda", "doc_type":"api", "kw":"Modifying the Description of a Training Job,Training Jobs,API Reference", @@ -1242,7 +1022,7 @@ { "uri":"modelarts_03_0053.html", "product_code":"modelarts", - "code":"125", + "code":"103", "des":"This API is used to delete a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", "doc_type":"api", "kw":"Deleting a Training Job,Training Jobs,API Reference", @@ -1252,7 +1032,7 @@ { "uri":"modelarts_03_0054.html", "product_code":"modelarts", - "code":"126", + "code":"104", "des":"This API is used to obtain the name of a training job log file.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/log/file-namesTable 1 describes the requi", "doc_type":"api", "kw":"Obtaining the Name of a Training Job Log File,Training Jobs,API Reference", @@ -1262,7 +1042,7 @@ { "uri":"modelarts_03_0056.html", "product_code":"modelarts", - "code":"127", + "code":"105", "des":"This API is used to query the details about a built-in model.GET /v1/{project_id}/built-in-algorithmsTable 1 describes the required parameters.ParametersParameterMandator", "doc_type":"api", "kw":"Querying a Built-in Algorithm,Training Jobs,API Reference", @@ -1272,47 +1052,17 @@ { "uri":"modelarts_03_0149.html", "product_code":"modelarts", - "code":"128", + "code":"106", "des":"This API is used to query detailed information about training job logs by row.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-logTable 1 describes t", "doc_type":"api", "kw":"Querying Training Job Logs,Training Jobs,API Reference", "title":"Querying Training Job Logs", "githuburl":"" }, - { - "uri":"modelarts_03_0150.html", - "product_code":"modelarts", - "code":"129", - "des":"This API is used to query monitoring information about a single container of a job.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/pod/{pod_name}/metr", - "doc_type":"api", - "kw":"Querying Monitoring Information About a Single Container of a Job,Training Jobs,API Reference", - "title":"Querying Monitoring Information About a Single Container of a Job", - "githuburl":"" - }, - { - "uri":"modelarts_03_0151.html", - "product_code":"modelarts", - "code":"130", - "des":"This API is used to query monitoring information about resource pool nodes.GET /v1/{project_id}/pools/{pool_id}/nodes/{node_ip}/metric-statisticTable 1 describes the re", - "doc_type":"api", - "kw":"Querying Monitoring Information About Resource Pool Nodes,Training Jobs,API Reference", - "title":"Querying Monitoring Information About Resource Pool Nodes", - "githuburl":"" - }, - { - "uri":"en-us_topic_0000001147936839.html", - "product_code":"modelarts", - "code":"131", - "des":"You can use this API to query the overview information about all job versions created by a user based on specified conditions, including the statuses and GPU quantity of ", - "doc_type":"api", - "kw":"Querying the Statuses and GPU Quantity of All Job Versions,Training Jobs,API Reference", - "title":"Querying the Statuses and GPU Quantity of All Job Versions", - "githuburl":"" - }, { "uri":"modelarts_03_0057.html", "product_code":"modelarts", - "code":"132", + "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":"Training Job Parameter Configuration", @@ -1322,7 +1072,7 @@ { "uri":"modelarts_03_0058.html", "product_code":"modelarts", - "code":"133", + "code":"108", "des":"This API is used to create a training job configuration.POST /v1/{project_id}/training-job-configsTable 1 describes the required parameters.ParametersParameterMandatoryTy", "doc_type":"api", "kw":"Creating a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -1332,7 +1082,7 @@ { "uri":"modelarts_03_0059.html", "product_code":"modelarts", - "code":"134", + "code":"109", "des":"This API is used to query the created training job configurations that meet the search criteria.GET /v1/{project_id}/training-job-configsTable 1 describes the required pa", "doc_type":"api", "kw":"Querying a List of Training Job Configurations,Training Job Parameter Configuration,API Reference", @@ -1342,7 +1092,7 @@ { "uri":"modelarts_03_0060.html", "product_code":"modelarts", - "code":"135", + "code":"110", "des":"This API is used to modify a training job configuration.PUT /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.ParametersParamet", "doc_type":"api", "kw":"Modifying a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -1352,7 +1102,7 @@ { "uri":"modelarts_03_0061.html", "product_code":"modelarts", - "code":"136", + "code":"111", "des":"This API is used to delete a training job configuration.DELETE /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.Parameter desc", "doc_type":"api", "kw":"Deleting a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -1362,7 +1112,7 @@ { "uri":"modelarts_03_0062.html", "product_code":"modelarts", - "code":"137", + "code":"112", "des":"This API is used to query the details about a specified training job configuration.GET /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required p", "doc_type":"api", "kw":"Querying the Details About a Training Job Configuration,Training Job Parameter Configuration,API Ref", @@ -1372,7 +1122,7 @@ { "uri":"modelarts_03_0063.html", "product_code":"modelarts", - "code":"138", + "code":"113", "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":"Visualization Jobs", @@ -1382,7 +1132,7 @@ { "uri":"modelarts_03_0064.html", "product_code":"modelarts", - "code":"139", + "code":"114", "des":"This API is used to create a visualization job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a V", "doc_type":"api", "kw":"Creating a Visualization Job,Visualization Jobs,API Reference", @@ -1392,7 +1142,7 @@ { "uri":"modelarts_03_0065.html", "product_code":"modelarts", - "code":"140", + "code":"115", "des":"This API is used to query the visualization jobs that meet the search criteria.GET /v1/{project_id}/visualization-jobsTable 1 describes the required parameters.Parameters", "doc_type":"api", "kw":"Querying a Visualization Job List,Visualization Jobs,API Reference", @@ -1402,7 +1152,7 @@ { "uri":"modelarts_03_0066.html", "product_code":"modelarts", - "code":"141", + "code":"116", "des":"This API is used to query the details about a specified visualization job based on the job name.GET /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the requ", "doc_type":"api", "kw":"Querying the Details About a Visualization Job,Visualization Jobs,API Reference", @@ -1412,7 +1162,7 @@ { "uri":"modelarts_03_0067.html", "product_code":"modelarts", - "code":"142", + "code":"117", "des":"This API is used to modify the description of a visualization job.PUT /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the required parameters.ParametersPara", "doc_type":"api", "kw":"Modifying the Description of a Visualization Job,Visualization Jobs,API Reference", @@ -1422,7 +1172,7 @@ { "uri":"modelarts_03_0068.html", "product_code":"modelarts", - "code":"143", + "code":"118", "des":"This API is used to delete a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a ", "doc_type":"api", "kw":"Deleting a Visualization Job,Visualization Jobs,API Reference", @@ -1432,7 +1182,7 @@ { "uri":"modelarts_03_0069.html", "product_code":"modelarts", - "code":"144", + "code":"119", "des":"This API is used to stop a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Vi", "doc_type":"api", "kw":"Stopping a Visualization Job,Visualization Jobs,API Reference", @@ -1442,7 +1192,7 @@ { "uri":"modelarts_03_0070.html", "product_code":"modelarts", - "code":"145", + "code":"120", "des":"This API is used to restart a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a", "doc_type":"api", "kw":"Restarting a Visualization Job,Visualization Jobs,API Reference", @@ -1452,7 +1202,7 @@ { "uri":"modelarts_03_0071.html", "product_code":"modelarts", - "code":"146", + "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":"Resource and Engine Specifications", @@ -1462,7 +1212,7 @@ { "uri":"modelarts_03_0072.html", "product_code":"modelarts", - "code":"147", + "code":"122", "des":"This API is used to query the resource specifications of a specified job.You must specify the resource specifications when creating a training job or an inference job.GET", "doc_type":"api", "kw":"Querying Job Resource Specifications,Resource and Engine Specifications,API Reference", @@ -1472,7 +1222,7 @@ { "uri":"modelarts_03_0073.html", "product_code":"modelarts", - "code":"148", + "code":"123", "des":"This API is used to query the engine type and version of a specified job.You must specify the engine specifications when creating a training job or an inference job.GET /", "doc_type":"api", "kw":"Querying Job Engine Specifications,Resource and Engine Specifications,API Reference", @@ -1482,7 +1232,7 @@ { "uri":"modelarts_03_0074.html", "product_code":"modelarts", - "code":"149", + "code":"124", "des":"Table 1 describes the job statuses.", "doc_type":"api", "kw":"Job Statuses,Training Management,API Reference", @@ -1492,67 +1242,57 @@ { "uri":"modelarts_03_0075.html", "product_code":"modelarts", - "code":"150", + "code":"125", "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", "title":"Model Management", "githuburl":"" }, - { - "uri":"modelarts_03_0153.html", - "product_code":"modelarts", - "code":"151", - "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":"Models", - "title":"Models", - "githuburl":"" - }, { "uri":"modelarts_03_0076.html", "product_code":"modelarts", - "code":"152", + "code":"126", "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", "doc_type":"api", - "kw":"Importing a Model,Models,API Reference", + "kw":"Importing a Model,Model Management,API Reference", "title":"Importing a Model", "githuburl":"" }, { "uri":"modelarts_03_0077.html", "product_code":"modelarts", - "code":"153", + "code":"127", "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", "doc_type":"api", - "kw":"Querying a Model List,Models,API Reference", + "kw":"Querying a Model List,Model Management,API Reference", "title":"Querying a Model List", "githuburl":"" }, { "uri":"modelarts_03_0078.html", "product_code":"modelarts", - "code":"154", + "code":"128", "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", "doc_type":"api", - "kw":"Querying the Details About a Model,Models,API Reference", + "kw":"Querying the Details About a Model,Model Management,API Reference", "title":"Querying the Details About a Model", "githuburl":"" }, { "uri":"modelarts_03_0079.html", "product_code":"modelarts", - "code":"155", + "code":"129", "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,Models,API Reference", + "kw":"Deleting a Model,Model Management,API Reference", "title":"Deleting a Model", "githuburl":"" }, { "uri":"modelarts_03_0081.html", "product_code":"modelarts", - "code":"156", + "code":"130", "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", @@ -1562,7 +1302,7 @@ { "uri":"modelarts_03_0082.html", "product_code":"modelarts", - "code":"157", + "code":"131", "des":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject", "doc_type":"api", "kw":"Deploying a Model as a Service,Service Management,API Reference", @@ -1572,7 +1312,7 @@ { "uri":"modelarts_03_0083.html", "product_code":"modelarts", - "code":"158", + "code":"132", "des":"This API is used to obtain model services.GET /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_idYesS", "doc_type":"api", "kw":"Querying a Service List,Service Management,API Reference", @@ -1582,7 +1322,7 @@ { "uri":"modelarts_03_0084.html", "product_code":"modelarts", - "code":"159", + "code":"133", "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", "doc_type":"api", "kw":"Querying the Details About a Service,Service Management,API Reference", @@ -1592,7 +1332,7 @@ { "uri":"modelarts_03_0086.html", "product_code":"modelarts", - "code":"160", + "code":"134", "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", "doc_type":"api", "kw":"Updating Service Configurations,Service Management,API Reference", @@ -1602,7 +1342,7 @@ { "uri":"modelarts_03_0087.html", "product_code":"modelarts", - "code":"161", + "code":"135", "des":"This API is used to query service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorTable 1 describes the required parameters.ParametersParameterMa", "doc_type":"api", "kw":"Querying Service Monitoring Information,Service Management,API Reference", @@ -1612,7 +1352,7 @@ { "uri":"modelarts_03_0088.html", "product_code":"modelarts", - "code":"162", + "code":"136", "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", @@ -1622,7 +1362,7 @@ { "uri":"modelarts_03_0155.html", "product_code":"modelarts", - "code":"163", + "code":"137", "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", @@ -1632,7 +1372,7 @@ { "uri":"modelarts_03_0089.html", "product_code":"modelarts", - "code":"164", + "code":"138", "des":"This API is used to delete a model service. You can delete your own services only.Table 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionpro", "doc_type":"api", "kw":"Deleting a Service,Service Management,API Reference", @@ -1642,17 +1382,27 @@ { "uri":"modelarts_03_0200.html", "product_code":"modelarts", - "code":"165", + "code":"139", "des":"This API is used to query supported service deployment specifications.URIGET /v1/{project_id}/services/specificationsNoneSample requestGET https://endpoint/v1/{project", "doc_type":"api", "kw":"Querying Supported Service Deployment Specifications,Service Management,API Reference", "title":"Querying Supported Service Deployment Specifications", "githuburl":"" }, + { + "uri":"modelarts_03_0201.html", + "product_code":"modelarts", + "code":"140", + "des":"This API is used to query dedicated resource pools.GET /v1/{project_id}/clustersParametersParameterMandatoryTypeDescriptionproject_idYesStringProject ID. For details abou", + "doc_type":"api", + "kw":"Querying Dedicated Resource Pools,Service Management,API Reference", + "title":"Querying Dedicated Resource Pools", + "githuburl":"" + }, { "uri":"authorization.html", "product_code":"modelarts", - "code":"166", + "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":"Authorization Management", @@ -1662,7 +1412,7 @@ { "uri":"CreateAuthorization.html", "product_code":"modelarts", - "code":"167", + "code":"142", "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", @@ -1672,7 +1422,7 @@ { "uri":"GetAuthorizations.html", "product_code":"modelarts", - "code":"168", + "code":"143", "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.", "doc_type":"api", "kw":"Viewing an Authorization List,Authorization Management,API Reference", @@ -1682,7 +1432,7 @@ { "uri":"DeleteAuthorizations.html", "product_code":"modelarts", - "code":"169", + "code":"144", "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", "doc_type":"api", "kw":"Deleting Authorization,Authorization Management,API Reference", @@ -1692,97 +1442,17 @@ { "uri":"CreateModelArtsAgency.html", "product_code":"modelarts", - "code":"170", + "code":"145", "des":"This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneCreate a ModelArts agency.S", "doc_type":"api", "kw":"Creating a ModelArts Agency,Authorization Management,API Reference", "title":"Creating a ModelArts Agency", "githuburl":"" }, - { - "uri":"workspace.html", - "product_code":"modelarts", - "code":"171", - "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", - "title":"Workspace Management", - "githuburl":"" - }, - { - "uri":"CreateWorkspace.html", - "product_code":"modelarts", - "code":"172", - "des":"This API is used to create a workspace. The name of the created workspace cannot be default, which is the name of the default workspace reserved by the system.POST /v1/{p", - "doc_type":"api", - "kw":"Creating a Workspace,Workspace Management,API Reference", - "title":"Creating a Workspace", - "githuburl":"" - }, - { - "uri":"ListWorkspaces.html", - "product_code":"modelarts", - "code":"173", - "des":"This API is used to obtain a workspace list with detailed information contained in the response body.GET /v1/{project_id}/workspacesNoneStatus code: 200Querying a Workspa", - "doc_type":"api", - "kw":"Querying a Workspace List,Workspace Management,API Reference", - "title":"Querying a Workspace List", - "githuburl":"" - }, - { - "uri":"DeleteWorkspace.html", - "product_code":"modelarts", - "code":"174", - "des":"This API is used to delete a workspace.DELETE /v1/{project_id}/workspaces/{workspace_id}NoneStatus code: 200Deleting a WorkspaceStatus code: 200OKSee Error Codes.", - "doc_type":"api", - "kw":"Deleting a Workspace,Workspace Management,API Reference", - "title":"Deleting a Workspace", - "githuburl":"" - }, - { - "uri":"ShowWorkspaceInfo.html", - "product_code":"modelarts", - "code":"175", - "des":"This API is used to obtain details about a workspace.GET /v1/{project_id}/workspaces/{workspace_id}NoneStatus code: 200Querying Details About a WorkspaceStatus code: 200O", - "doc_type":"api", - "kw":"Querying Details About a Workspace,Workspace Management,API Reference", - "title":"Querying Details About a Workspace", - "githuburl":"" - }, - { - "uri":"UpdateWorkspace.html", - "product_code":"modelarts", - "code":"176", - "des":"This API is used to modify a workspace.PUT /v1/{project_id}/workspaces/{workspace_id}Status code: 200Modifying a WorkspaceStatus code: 200OKSee Error Codes.", - "doc_type":"api", - "kw":"Modifying a Workspace,Workspace Management,API Reference", - "title":"Modifying a Workspace", - "githuburl":"" - }, - { - "uri":"ListWorkspaceQuotas.html", - "product_code":"modelarts", - "code":"177", - "des":"This API is used to obtain workspace quotas.GET /v1/{project_id}/workspaces/{workspace_id}/quotasNoneStatus code: 200Querying Workspace QuotasStatus code: 200OKSee Error ", - "doc_type":"api", - "kw":"Querying a Workspace Quota,Workspace Management,API Reference", - "title":"Querying a Workspace Quota", - "githuburl":"" - }, - { - "uri":"UpdateWorkspaceQuotas.html", - "product_code":"modelarts", - "code":"178", - "des":"This API is used to modify a workspace quota.PUT /v1/{project_id}/workspaces/{workspace_id}/quotasStatus code: 200Modifying Workspace QuotasStatus code: 200OKSee Error Co", - "doc_type":"api", - "kw":"Modifying a Workspace Quota,Workspace Management,API Reference", - "title":"Modifying a Workspace Quota", - "githuburl":"" - }, { "uri":"modelarts_03_0400.html", "product_code":"modelarts", - "code":"179", + "code":"146", "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":"Application Cases", @@ -1792,17 +1462,97 @@ { "uri":"modelarts_03_0401.html", "product_code":"modelarts", - "code":"180", + "code":"147", "des":"This section describes how to train a model on ModelArts by calling a series of APIs.The process for creating a training job using the TensorFlow framework is as follows:", "doc_type":"api", "kw":"Creating a Training Job Using the TensorFlow Framework,Application Cases,API Reference", "title":"Creating a Training Job Using the TensorFlow Framework", "githuburl":"" }, + { + "uri":"modelarts_03_0138.html", + "product_code":"modelarts", + "code":"148", + "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", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0146.html", + "product_code":"modelarts", + "code":"149", + "des":"This section describes fine-grained permissions management for your ModelArts. If your current account does not require individual IAM users, skip this section.By default", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"modelarts_03_0234.html", + "product_code":"modelarts", + "code":"150", + "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", + "title":"ExeML Permissions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0161.html", + "product_code":"modelarts", + "code":"151", + "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", + "title":"Data Management Permissions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0162.html", + "product_code":"modelarts", + "code":"152", + "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", + "title":"DevEnviron Permissions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0163.html", + "product_code":"modelarts", + "code":"153", + "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", + "title":"Training Job Permissions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0164.html", + "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":"Model Management Permissions,Permissions Policies and Supported Actions,API Reference", + "title":"Model Management Permissions", + "githuburl":"" + }, + { + "uri":"modelarts_03_0165.html", + "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":"Service Management Permissions,Permissions Policies and Supported Actions,API Reference", + "title":"Service Management Permissions", + "githuburl":"" + }, { "uri":"modelarts_03_0093.html", "product_code":"modelarts", - "code":"181", + "code":"156", "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", @@ -1812,7 +1562,7 @@ { "uri":"modelarts_03_0094.html", "product_code":"modelarts", - "code":"182", + "code":"157", "des":"Table 1 describes the status codes.", "doc_type":"api", "kw":"Status Code,Common Parameters,API Reference", @@ -1822,7 +1572,7 @@ { "uri":"modelarts_03_0095.html", "product_code":"modelarts", - "code":"183", + "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":"Error Codes,Common Parameters,API Reference", @@ -1832,17 +1582,17 @@ { "uri":"modelarts_03_0147.html", "product_code":"modelarts", - "code":"184", - "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", + "code":"159", + "des":"A project ID is required for some requests when an API is called. Therefore, obtain the project ID before calling the API. Use either of the following methods:Obtaining a", "doc_type":"api", - "kw":"Obtaining a Project ID and Name,Common Parameters,API Reference", - "title":"Obtaining a Project ID and Name", + "kw":"Obtaining a Project ID,Common Parameters,API Reference", + "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"modelarts_03_0148.html", "product_code":"modelarts", - "code":"185", + "code":"160", "des":"When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows:Sign up and log in to the console.Hover the cursor o", "doc_type":"api", "kw":"Obtaining an Account Name and ID,Common Parameters,API Reference", @@ -1852,17 +1602,27 @@ { "uri":"modelarts_03_0006.html", "product_code":"modelarts", - "code":"186", - "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", + "code":"161", + "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.Hover the", "doc_type":"api", "kw":"Obtaining a Username and ID,Common Parameters,API Reference", "title":"Obtaining a Username and ID", "githuburl":"" }, + { + "uri":"modelarts_03_0247.html", + "product_code":"modelarts", + "code":"162", + "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.To do so, perform the following", + "doc_type":"api", + "kw":"Obtaining a Project Name,Common Parameters,API Reference", + "title":"Obtaining a Project Name", + "githuburl":"" + }, { "uri":"modelarts_03_0097.html", "product_code":"modelarts", - "code":"187", + "code":"163", "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", diff --git a/docs/modelarts/api-ref/AcceptSamples.html b/docs/modelarts/api-ref/AcceptSamples.html index b5f53ad7a..cd7e07f57 100644 --- a/docs/modelarts/api-ref/AcceptSamples.html +++ b/docs/modelarts/api-ref/AcceptSamples.html @@ -5,7 +5,7 @@

URI

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

-
Table 1 Path parameters

Parameter

+
@@ -86,10 +86,7 @@ -
Table 1 Path Parameters

Parameter

Mandatory

Boolean

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

-
  • true: passed

    -
  • false: not passed

    -
+

Whether the submitted sample review comments are passed. The options are as follows: - true: passed - false: not passed

comment

diff --git a/docs/modelarts/api-ref/CLASS.TXT.json b/docs/modelarts/api-ref/CLASS.TXT.json index 832da40fb..e9fa6793f 100644 --- a/docs/modelarts/api-ref/CLASS.TXT.json +++ b/docs/modelarts/api-ref/CLASS.TXT.json @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"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", + "desc":"Before calling a ModelArts API, ensure that you have fully understood the concepts related to ModelArts. For details, see the Service Overview.", "product_code":"modelarts", "title":"Overview", "uri":"modelarts_03_0001.html", @@ -18,7 +18,7 @@ "code":"2" }, { - "desc":"ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "desc":"ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.In addition, ModelA", "product_code":"modelarts", "title":"API Calling", "uri":"modelarts_03_0140.html", @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"Endpoints are request address for calling APIs. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrato", + "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.If a", "product_code":"modelarts", "title":"Endpoints", "uri":"modelarts_03_0141.html", @@ -89,87 +89,6 @@ "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":"DevEnviron", - "uri":"modelarts_03_0108.html", - "doc_type":"api", - "p_code":"", - "code":"11" - }, - { - "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":"11", - "code":"12" - }, - { - "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", - "product_code":"modelarts", - "title":"Creating a Development Environment Instance", - "uri":"modelarts_03_0110.html", - "doc_type":"api", - "p_code":"11", - "code":"13" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying a List of Development Environment Instances", - "uri":"modelarts_03_0111.html", - "doc_type":"api", - "p_code":"11", - "code":"14" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying the Details About a Development Environment Instance", - "uri":"modelarts_03_0112.html", - "doc_type":"api", - "p_code":"11", - "code":"15" - }, - { - "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", - "product_code":"modelarts", - "title":"Modifying the Description of a Development Environment Instance", - "uri":"modelarts_03_0113.html", - "doc_type":"api", - "p_code":"11", - "code":"16" - }, - { - "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", - "product_code":"modelarts", - "title":"Deleting a Development Environment Instance", - "uri":"modelarts_03_0114.html", - "doc_type":"api", - "p_code":"11", - "code":"17" - }, - { - "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", - "product_code":"modelarts", - "title":"Managing a Development Environment Instance", - "uri":"modelarts_03_0115.html", - "doc_type":"api", - "p_code":"11", - "code":"18" - }, - { - "desc":"This API is used to restart an ML Studio development environment instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required par", - "product_code":"modelarts", - "title":"Restarting an ML Studio Instance", - "uri":"modelarts_03_0152.html", - "doc_type":"api", - "p_code":"11", - "code":"19" - }, { "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", @@ -177,7 +96,7 @@ "uri":"modelarts_03_0202.html", "doc_type":"api", "p_code":"", - "code":"20" + "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.", @@ -185,8 +104,8 @@ "title":"Data Management APIs", "uri":"modelarts_03_0299.html", "doc_type":"api", - "p_code":"20", - "code":"21" + "p_code":"11", + "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.", @@ -194,8 +113,8 @@ "title":"Dataset Management", "uri":"dataset_management.html", "doc_type":"api", - "p_code":"20", - "code":"22" + "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", @@ -203,8 +122,8 @@ "title":"Response body for querying the dataset list.", "uri":"ListDatasets.html", "doc_type":"api", - "p_code":"22", - "code":"23" + "p_code":"13", + "code":"14" }, { "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", @@ -212,8 +131,8 @@ "title":"Creating a Dataset", "uri":"CreateDataset.html", "doc_type":"api", - "p_code":"22", - "code":"24" + "p_code":"13", + "code":"15" }, { "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", @@ -221,8 +140,8 @@ "title":"Querying Details About a Dataset", "uri":"DescDataset.html", "doc_type":"api", - "p_code":"22", - "code":"25" + "p_code":"13", + "code":"16" }, { "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", @@ -230,8 +149,8 @@ "title":"Modifying a Dataset", "uri":"UpdateDataset.html", "doc_type":"api", - "p_code":"22", - "code":"26" + "p_code":"13", + "code":"17" }, { "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", @@ -239,8 +158,8 @@ "title":"Deleting a Dataset", "uri":"DeleteDataset.html", "doc_type":"api", - "p_code":"22", - "code":"27" + "p_code":"13", + "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: ", @@ -248,8 +167,8 @@ "title":"Querying Dataset Statistics", "uri":"ListStats.html", "doc_type":"api", - "p_code":"22", - "code":"28" + "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", @@ -257,8 +176,8 @@ "title":"Querying the Monitoring Data of a Dataset", "uri":"GetDatasetMetrics.html", "doc_type":"api", - "p_code":"22", - "code":"29" + "p_code":"13", + "code":"20" }, { "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", @@ -266,8 +185,8 @@ "title":"Querying Details About Team Labeling Task Statistics", "uri":"ListWorkforceTaskStats.html", "doc_type":"api", - "p_code":"22", - "code":"30" + "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", @@ -275,8 +194,8 @@ "title":"Querying Details About the Progress of a Team Labeling Task Member", "uri":"GetWorkforceTaskMetrics.html", "doc_type":"api", - "p_code":"22", - "code":"31" + "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.", @@ -284,8 +203,8 @@ "title":"Dataset Version Management", "uri":"dataset_version_management.html", "doc_type":"api", - "p_code":"20", - "code":"32" + "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", @@ -293,8 +212,8 @@ "title":"Querying the Dataset Version List", "uri":"ListDatasetVersions.html", "doc_type":"api", - "p_code":"32", - "code":"33" + "p_code":"23", + "code":"24" }, { "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: ", @@ -302,8 +221,8 @@ "title":"Creating a Dataset Labeling Version", "uri":"CreateDatasetVersion.html", "doc_type":"api", - "p_code":"32", - "code":"34" + "p_code":"23", + "code":"25" }, { "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", @@ -311,8 +230,8 @@ "title":"Querying Details About a Dataset Version", "uri":"DescribeDatasetVersion.html", "doc_type":"api", - "p_code":"32", - "code":"35" + "p_code":"23", + "code":"26" }, { "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", @@ -320,8 +239,8 @@ "title":"Deleting a Dataset Labeling Version", "uri":"DeleteDatasetVersion.html", "doc_type":"api", - "p_code":"32", - "code":"36" + "p_code":"23", + "code":"27" }, { "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.", @@ -329,8 +248,8 @@ "title":"Sample Management", "uri":"sample_management.html", "doc_type":"api", - "p_code":"20", - "code":"37" + "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", @@ -338,8 +257,8 @@ "title":"Querying the Sample List", "uri":"ListSamples.html", "doc_type":"api", - "p_code":"37", - "code":"38" + "p_code":"28", + "code":"29" }, { "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", @@ -347,8 +266,8 @@ "title":"Adding Samples in Batches", "uri":"UploadSamplesJson.html", "doc_type":"api", - "p_code":"37", - "code":"39" + "p_code":"28", + "code":"30" }, { "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", @@ -356,8 +275,8 @@ "title":"Deleting Samples in Batches", "uri":"DeleteSamples.html", "doc_type":"api", - "p_code":"37", - "code":"40" + "p_code":"28", + "code":"31" }, { "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", @@ -365,8 +284,8 @@ "title":"Querying Details About a Sample", "uri":"DescribeSample.html", "doc_type":"api", - "p_code":"37", - "code":"41" + "p_code":"28", + "code":"32" }, { "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", @@ -374,8 +293,8 @@ "title":"Obtaining Sample Search Condition", "uri":"ListSearch.html", "doc_type":"api", - "p_code":"37", - "code":"42" + "p_code":"28", + "code":"33" }, { "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/", @@ -383,8 +302,8 @@ "title":"Querying the Sample List of a Team Labeling Task by Page", "uri":"ListWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"37", - "code":"43" + "p_code":"28", + "code":"34" }, { "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", @@ -392,8 +311,8 @@ "title":"Querying Details About Team Labeling Samples", "uri":"DescribeWorkforceTaskSample.html", "doc_type":"api", - "p_code":"37", - "code":"44" + "p_code":"28", + "code":"35" }, { "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.", @@ -401,8 +320,8 @@ "title":"Label Management", "uri":"label_management.html", "doc_type":"api", - "p_code":"20", - "code":"45" + "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", @@ -410,8 +329,8 @@ "title":"Querying the Dataset Label List", "uri":"ListLabels.html", "doc_type":"api", - "p_code":"45", - "code":"46" + "p_code":"36", + "code":"37" }, { "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", @@ -419,8 +338,8 @@ "title":"Creating a Dataset Label", "uri":"CreateLabels.html", "doc_type":"api", - "p_code":"45", - "code":"47" + "p_code":"36", + "code":"38" }, { "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", @@ -428,8 +347,8 @@ "title":"Modifying Labels in Batches", "uri":"UpdateLabels.html", "doc_type":"api", - "p_code":"45", - "code":"48" + "p_code":"36", + "code":"39" }, { "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", @@ -437,8 +356,8 @@ "title":"Deleting Labels in Batches", "uri":"DeleteLabels.html", "doc_type":"api", - "p_code":"45", - "code":"49" + "p_code":"36", + "code":"40" }, { "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", @@ -446,8 +365,8 @@ "title":"Updating a Label by Label Names", "uri":"UpdateLabel.html", "doc_type":"api", - "p_code":"45", - "code":"50" + "p_code":"36", + "code":"41" }, { "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", @@ -455,8 +374,8 @@ "title":"Deleting a Label and the Files that Only Contain the Label", "uri":"DeleteLabelAndSamples.html", "doc_type":"api", - "p_code":"45", - "code":"51" + "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.", @@ -464,8 +383,8 @@ "title":"Manual Labeling", "uri":"manual_annotation_management.html", "doc_type":"api", - "p_code":"20", - "code":"52" + "p_code":"11", + "code":"43" }, { "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", @@ -473,8 +392,8 @@ "title":"Updating Sample Labels in Batches", "uri":"UpdateSamples.html", "doc_type":"api", - "p_code":"52", - "code":"53" + "p_code":"43", + "code":"44" }, { "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.", @@ -482,8 +401,8 @@ "title":"Labeling Task Management", "uri":"label_task_management.html", "doc_type":"api", - "p_code":"20", - "code":"54" + "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", @@ -491,8 +410,8 @@ "title":"Querying the Team Labeling Task List of a Dataset", "uri":"ListWorkforceTasks.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"45", + "code":"46" }, { "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", @@ -500,8 +419,8 @@ "title":"Creating a Team Labeling Task", "uri":"CreateWorkforceTask.html", "doc_type":"api", - "p_code":"54", - "code":"56" + "p_code":"45", + "code":"47" }, { "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", @@ -509,8 +428,8 @@ "title":"Querying Details About a Team Labeling Task", "uri":"DescWorkforceTask.html", "doc_type":"api", - "p_code":"54", - "code":"57" + "p_code":"45", + "code":"48" }, { "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", @@ -518,8 +437,8 @@ "title":"Starting a Team Labeling Task", "uri":"StartWorkforceTask.html", "doc_type":"api", - "p_code":"54", - "code":"58" + "p_code":"45", + "code":"49" }, { "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", @@ -527,8 +446,8 @@ "title":"Updating a Team Labeling Task", "uri":"UpdateWorkforceTask.html", "doc_type":"api", - "p_code":"54", - "code":"59" + "p_code":"45", + "code":"50" }, { "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", @@ -536,8 +455,8 @@ "title":"Deleting a Team Labeling Task", "uri":"DeleteWorkforceTask.html", "doc_type":"api", - "p_code":"54", - "code":"60" + "p_code":"45", + "code":"51" }, { "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", @@ -545,8 +464,8 @@ "title":"Creating a Team Labeling Acceptance Task", "uri":"StartWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"54", - "code":"61" + "p_code":"45", + "code":"52" }, { "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", @@ -554,8 +473,8 @@ "title":"Querying the Report of a Team Labeling Acceptance Task", "uri":"GetWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"54", - "code":"62" + "p_code":"45", + "code":"53" }, { "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", @@ -563,8 +482,8 @@ "title":"Updating the Status of a Team Labeling Acceptance Task", "uri":"UpdateWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"54", - "code":"63" + "p_code":"45", + "code":"54" }, { "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", @@ -572,8 +491,8 @@ "title":"Querying the Team Labeling Task List by a Team Member", "uri":"ListWorkerTasks.html", "doc_type":"api", - "p_code":"54", - "code":"64" + "p_code":"45", + "code":"55" }, { "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.", @@ -581,8 +500,8 @@ "title":"Team Labeling Process Management", "uri":"workforce_process_management.html", "doc_type":"api", - "p_code":"20", - "code":"65" + "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", @@ -590,8 +509,8 @@ "title":"Submitting Sample Review Comments of an Acceptance Task", "uri":"AcceptSamples.html", "doc_type":"api", - "p_code":"65", - "code":"66" + "p_code":"56", + "code":"57" }, { "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", @@ -599,8 +518,8 @@ "title":"Reviewing Team Labeling Results", "uri":"ReviewSamples.html", "doc_type":"api", - "p_code":"65", - "code":"67" + "p_code":"56", + "code":"58" }, { "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", @@ -608,8 +527,8 @@ "title":"Updating Labels of Team Labeling Samples in Batches", "uri":"UpdateWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"65", - "code":"68" + "p_code":"56", + "code":"59" }, { "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.", @@ -617,8 +536,8 @@ "title":"Labeling Team Management", "uri":"workforce_management.html", "doc_type":"api", - "p_code":"20", - "code":"69" + "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.", @@ -626,8 +545,8 @@ "title":"Querying the Labeling Team List", "uri":"ListWorkforces.html", "doc_type":"api", - "p_code":"69", - "code":"70" + "p_code":"60", + "code":"61" }, { "desc":"This API is used to create a labeling team.POST /v2/{project_id}/workforcesStatus code: 201Creating a Labeling TeamStatus code: 201CreatedSee Error Codes.", @@ -635,8 +554,8 @@ "title":"Creating a Labeling Team", "uri":"CreateWorkforce.html", "doc_type":"api", - "p_code":"69", - "code":"71" + "p_code":"60", + "code":"62" }, { "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", @@ -644,8 +563,8 @@ "title":"Querying Details About a Labeling Team", "uri":"DescWorkforce.html", "doc_type":"api", - "p_code":"69", - "code":"72" + "p_code":"60", + "code":"63" }, { "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.", @@ -653,8 +572,8 @@ "title":"Updating a Labeling Team", "uri":"UpdateWorkforce.html", "doc_type":"api", - "p_code":"69", - "code":"73" + "p_code":"60", + "code":"64" }, { "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", @@ -662,8 +581,8 @@ "title":"Deleting a Labeling Team", "uri":"DeleteWorkforce.html", "doc_type":"api", - "p_code":"69", - "code":"74" + "p_code":"60", + "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.", @@ -671,8 +590,8 @@ "title":"Labeling Team Member Management", "uri":"workforce_worker_management.html", "doc_type":"api", - "p_code":"20", - "code":"75" + "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 ", @@ -680,8 +599,8 @@ "title":"Sending an Email to a Labeling Team Member", "uri":"SendEmails.html", "doc_type":"api", - "p_code":"75", - "code":"76" + "p_code":"66", + "code":"67" }, { "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", @@ -689,8 +608,8 @@ "title":"Querying the List of All Labeling Team Members", "uri":"ListAllWorkers.html", "doc_type":"api", - "p_code":"75", - "code":"77" + "p_code":"66", + "code":"68" }, { "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", @@ -698,8 +617,8 @@ "title":"Querying the List of Labeling Team Members", "uri":"ListWorkers.html", "doc_type":"api", - "p_code":"75", - "code":"78" + "p_code":"66", + "code":"69" }, { "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", @@ -707,8 +626,8 @@ "title":"Creating a Labeling Team Member", "uri":"CreateWorker.html", "doc_type":"api", - "p_code":"75", - "code":"79" + "p_code":"66", + "code":"70" }, { "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", @@ -716,8 +635,8 @@ "title":"Deleting Labeling Team Members in Batches", "uri":"DeleteWorkers.html", "doc_type":"api", - "p_code":"75", - "code":"80" + "p_code":"66", + "code":"71" }, { "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", @@ -725,8 +644,8 @@ "title":"Querying Details About Labeling Team Members", "uri":"DescWorker.html", "doc_type":"api", - "p_code":"75", - "code":"81" + "p_code":"66", + "code":"72" }, { "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", @@ -734,8 +653,8 @@ "title":"Updating a Labeling Team Member", "uri":"UpdateWorker.html", "doc_type":"api", - "p_code":"75", - "code":"82" + "p_code":"66", + "code":"73" }, { "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:", @@ -743,8 +662,8 @@ "title":"Deleting a Labeling Team Member", "uri":"DeleteWorker.html", "doc_type":"api", - "p_code":"75", - "code":"83" + "p_code":"66", + "code":"74" }, { "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.", @@ -752,8 +671,8 @@ "title":"Data Import Task", "uri":"data_import.html", "doc_type":"api", - "p_code":"20", - "code":"84" + "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", @@ -761,8 +680,8 @@ "title":"Querying the Dataset Import Task List", "uri":"ListImportTasks.html", "doc_type":"api", - "p_code":"84", - "code":"85" + "p_code":"75", + "code":"76" }, { "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", @@ -770,8 +689,8 @@ "title":"Creating an Import Task", "uri":"ImportTask.html", "doc_type":"api", - "p_code":"84", - "code":"86" + "p_code":"75", + "code":"77" }, { "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 ", @@ -779,8 +698,8 @@ "title":"Querying Details About a Dataset Import Task", "uri":"DescImportTask.html", "doc_type":"api", - "p_code":"84", - "code":"87" + "p_code":"75", + "code":"78" }, { "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.", @@ -788,8 +707,8 @@ "title":"Data Export Task", "uri":"data_export.html", "doc_type":"api", - "p_code":"20", - "code":"88" + "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", @@ -797,8 +716,8 @@ "title":"Querying the Dataset Export Task List", "uri":"GetExportTasksStatusOfDataset.html", "doc_type":"api", - "p_code":"88", - "code":"89" + "p_code":"79", + "code":"80" }, { "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", @@ -806,8 +725,8 @@ "title":"Creating a Dataset Export Task", "uri":"ExportTask.html", "doc_type":"api", - "p_code":"88", - "code":"90" + "p_code":"79", + "code":"81" }, { "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", @@ -815,8 +734,8 @@ "title":"Querying the Status of a Dataset Export Task", "uri":"GetExportTaskStatusOfDataset.html", "doc_type":"api", - "p_code":"88", - "code":"91" + "p_code":"79", + "code":"82" }, { "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.", @@ -824,8 +743,8 @@ "title":"Data Synchronization Task", "uri":"data_sync.html", "doc_type":"api", - "p_code":"20", - "code":"92" + "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", @@ -833,8 +752,8 @@ "title":"Synchronizing a Dataset", "uri":"SyncDataSource.html", "doc_type":"api", - "p_code":"92", - "code":"93" + "p_code":"83", + "code":"84" }, { "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", @@ -842,188 +761,71 @@ "title":"Querying the Status of a Dataset Synchronization Task", "uri":"SyncDataSourceState.html", "doc_type":"api", - "p_code":"92", - "code":"94" + "p_code":"83", + "code":"85" }, { "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", + "title":"DevEnviron", + "uri":"modelarts_03_0108.html", "doc_type":"api", - "p_code":"20", - "code":"95" + "p_code":"", + "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 create a development environment instance for code development.Calling this API is an asynchronous operation. The job status can be obtained by callin", "product_code":"modelarts", - "title":"Querying Auto Labeling Sample List", - "uri":"ListAutoAnnotationSamples.html", + "title":"Creating a Development Environment Instance", + "uri":"modelarts_03_0110.html", "doc_type":"api", - "p_code":"95", - "code":"96" + "p_code":"86", + "code":"87" }, { - "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 the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={p", "product_code":"modelarts", - "title":"Querying Details About an Auto Labeling Sample", - "uri":"DescribeAutoAnnotationSample.html", + "title":"Querying a List of Development Environment Instances", + "uri":"modelarts_03_0111.html", "doc_type":"api", - "p_code":"95", - "code":"97" + "p_code":"86", + "code":"88" }, { - "desc":"This API is used to query the intelligent task list by page, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the type parame", + "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", "product_code":"modelarts", - "title":"Querying the Intelligent Task List by Page", - "uri":"ListTasks.html", + "title":"Querying Details About a Development Environment Instance", + "uri":"modelarts_03_0112.html", "doc_type":"api", - "p_code":"95", - "code":"98" + "p_code":"86", + "code":"89" }, { - "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 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", "product_code":"modelarts", - "title":"Starting Intelligent Tasks", - "uri":"CreateTask.html", + "title":"Modifying the Description of a Development Environment Instance", + "uri":"modelarts_03_0113.html", "doc_type":"api", - "p_code":"95", - "code":"99" + "p_code":"86", + "code":"90" }, { - "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 API is used to delete a development environment instance.DELETE /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameters.Parameter", "product_code":"modelarts", - "title":"Obtaining Information About Intelligent Tasks", - "uri":"AutoAnnotationProgress.html", + "title":"Deleting a Development Environment Instance", + "uri":"modelarts_03_0114.html", "doc_type":"api", - "p_code":"95", - "code":"100" + "p_code":"86", + "code":"91" }, { - "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 API is used to startor stop a notebook instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required parameters.ParametersPar", "product_code":"modelarts", - "title":"Stopping an Intelligent Task", - "uri":"StopAutoAnnotation.html", + "title":"Managing a Development Environment Instance", + "uri":"modelarts_03_0115.html", "doc_type":"api", - "p_code":"95", - "code":"101" - }, - { - "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":"20", - "code":"102" - }, - { - "desc":"This API is used to query the list of a processing task. You can query the feature analysis tasks and data processing tasks. You can specify the task_type parameter to qu", - "product_code":"modelarts", - "title":"Querying the List of a Processing Task", - "uri":"ListProcessorTasks.html", - "doc_type":"api", - "p_code":"102", - "code":"103" - }, - { - "desc":"This API is used to create a processing task. You can create feature analysis tasks and data processing tasks. You can specify the id field of template composite paramete", - "product_code":"modelarts", - "title":"Creating a Processing Task", - "uri":"CreateProcessorTask.html", - "doc_type":"api", - "p_code":"102", - "code":"104" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying the Algorithm Type for Data Processing", - "uri":"GetProcessorTaskItems.html", - "doc_type":"api", - "p_code":"102", - "code":"105" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying Details About a Processing Task", - "uri":"DescribeProcessorTask.html", - "doc_type":"api", - "p_code":"102", - "code":"106" - }, - { - "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", - "product_code":"modelarts", - "title":"Updating a Processing Task", - "uri":"UpdateProcessorTask.html", - "doc_type":"api", - "p_code":"102", - "code":"107" - }, - { - "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", - "product_code":"modelarts", - "title":"Deleting a Processing Task", - "uri":"DeleteProcessorTask.html", - "doc_type":"api", - "p_code":"102", - "code":"108" - }, - { - "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 ", - "product_code":"modelarts", - "title":"Querying the Version List of a Data Processing Task", - "uri":"ListProcessorTaskVersions.html", - "doc_type":"api", - "p_code":"102", - "code":"109" - }, - { - "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", - "product_code":"modelarts", - "title":"Creating a Data Processing Task Version", - "uri":"CreateProcessorTaskVersion.html", - "doc_type":"api", - "p_code":"102", - "code":"110" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying the Details About the Version of a Data Processing Task", - "uri":"DescProcessorTaskVersion.html", - "doc_type":"api", - "p_code":"102", - "code":"111" - }, - { - "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", - "product_code":"modelarts", - "title":"Deleting a Data Processing Task Version", - "uri":"DeleteProcessorTaskVersion.html", - "doc_type":"api", - "p_code":"102", - "code":"112" - }, - { - "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", - "product_code":"modelarts", - "title":"Querying the Result of a Data Processing Task Version", - "uri":"ListProcessorTaskVersionResults.html", - "doc_type":"api", - "p_code":"102", - "code":"113" - }, - { - "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 ", - "product_code":"modelarts", - "title":"Stopping the Version of a Data Processing Task", - "uri":"StopProcessorTaskVersion.html", - "doc_type":"api", - "p_code":"102", - "code":"114" + "p_code":"86", + "code":"92" }, { "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.", @@ -1032,7 +834,7 @@ "uri":"modelarts_03_0043.html", "doc_type":"api", "p_code":"", - "code":"115" + "code":"93" }, { "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.", @@ -1040,8 +842,8 @@ "title":"Training Jobs", "uri":"modelarts_03_0044.html", "doc_type":"api", - "p_code":"115", - "code":"116" + "p_code":"93", + "code":"94" }, { "desc":"This API is used to create a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", @@ -1049,17 +851,17 @@ "title":"Creating a Training Job", "uri":"modelarts_03_0045.html", "doc_type":"api", - "p_code":"116", - "code":"117" + "p_code":"94", + "code":"95" }, { - "desc":"This API is used to query the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.ParametersPa", + "desc":"This API is used to query the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.URI paramete", "product_code":"modelarts", "title":"Querying a Training Job List", "uri":"modelarts_03_0046.html", "doc_type":"api", - "p_code":"116", - "code":"118" + "p_code":"94", + "code":"96" }, { "desc":"This API is used to query the details about a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}Table 1 describe", @@ -1067,8 +869,8 @@ "title":"Querying the Details About a Training Job Version", "uri":"modelarts_03_0047.html", "doc_type":"api", - "p_code":"116", - "code":"119" + "p_code":"94", + "code":"97" }, { "desc":"This API is used to delete a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", @@ -1076,8 +878,8 @@ "title":"Deleting a Version of a Training Job", "uri":"modelarts_03_0048.html", "doc_type":"api", - "p_code":"116", - "code":"120" + "p_code":"94", + "code":"98" }, { "desc":"This API is used to query the version of a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versionsTable 1 describes the required p", @@ -1085,8 +887,8 @@ "title":"Querying a List of Training Job Versions", "uri":"modelarts_03_0049.html", "doc_type":"api", - "p_code":"116", - "code":"121" + "p_code":"94", + "code":"99" }, { "desc":"This API is used to create a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", @@ -1094,8 +896,8 @@ "title":"Creating a Version of a Training Job", "uri":"modelarts_03_0050.html", "doc_type":"api", - "p_code":"116", - "code":"122" + "p_code":"94", + "code":"100" }, { "desc":"This API is used to stop a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training", @@ -1103,8 +905,8 @@ "title":"Stopping a Training Job", "uri":"modelarts_03_0051.html", "doc_type":"api", - "p_code":"116", - "code":"123" + "p_code":"94", + "code":"101" }, { "desc":"This API is used to modify the description of a training job.PUT /v1/{project_id}/training-jobs/{job_id}Table 1 describes the required parameters.ParametersParameterManda", @@ -1112,8 +914,8 @@ "title":"Modifying the Description of a Training Job", "uri":"modelarts_03_0052.html", "doc_type":"api", - "p_code":"116", - "code":"124" + "p_code":"94", + "code":"102" }, { "desc":"This API is used to delete a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", @@ -1121,8 +923,8 @@ "title":"Deleting a Training Job", "uri":"modelarts_03_0053.html", "doc_type":"api", - "p_code":"116", - "code":"125" + "p_code":"94", + "code":"103" }, { "desc":"This API is used to obtain the name of a training job log file.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/log/file-namesTable 1 describes the requi", @@ -1130,8 +932,8 @@ "title":"Obtaining the Name of a Training Job Log File", "uri":"modelarts_03_0054.html", "doc_type":"api", - "p_code":"116", - "code":"126" + "p_code":"94", + "code":"104" }, { "desc":"This API is used to query the details about a built-in model.GET /v1/{project_id}/built-in-algorithmsTable 1 describes the required parameters.ParametersParameterMandator", @@ -1139,8 +941,8 @@ "title":"Querying a Built-in Algorithm", "uri":"modelarts_03_0056.html", "doc_type":"api", - "p_code":"116", - "code":"127" + "p_code":"94", + "code":"105" }, { "desc":"This API is used to query detailed information about training job logs by row.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-logTable 1 describes t", @@ -1148,35 +950,8 @@ "title":"Querying Training Job Logs", "uri":"modelarts_03_0149.html", "doc_type":"api", - "p_code":"116", - "code":"128" - }, - { - "desc":"This API is used to query monitoring information about a single container of a job.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/pod/{pod_name}/metr", - "product_code":"modelarts", - "title":"Querying Monitoring Information About a Single Container of a Job", - "uri":"modelarts_03_0150.html", - "doc_type":"api", - "p_code":"116", - "code":"129" - }, - { - "desc":"This API is used to query monitoring information about resource pool nodes.GET /v1/{project_id}/pools/{pool_id}/nodes/{node_ip}/metric-statisticTable 1 describes the re", - "product_code":"modelarts", - "title":"Querying Monitoring Information About Resource Pool Nodes", - "uri":"modelarts_03_0151.html", - "doc_type":"api", - "p_code":"116", - "code":"130" - }, - { - "desc":"You can use this API to query the overview information about all job versions created by a user based on specified conditions, including the statuses and GPU quantity of ", - "product_code":"modelarts", - "title":"Querying the Statuses and GPU Quantity of All Job Versions", - "uri":"en-us_topic_0000001147936839.html", - "doc_type":"api", - "p_code":"116", - "code":"131" + "p_code":"94", + "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.", @@ -1184,8 +959,8 @@ "title":"Training Job Parameter Configuration", "uri":"modelarts_03_0057.html", "doc_type":"api", - "p_code":"115", - "code":"132" + "p_code":"93", + "code":"107" }, { "desc":"This API is used to create a training job configuration.POST /v1/{project_id}/training-job-configsTable 1 describes the required parameters.ParametersParameterMandatoryTy", @@ -1193,8 +968,8 @@ "title":"Creating a Training Job Configuration", "uri":"modelarts_03_0058.html", "doc_type":"api", - "p_code":"132", - "code":"133" + "p_code":"107", + "code":"108" }, { "desc":"This API is used to query the created training job configurations that meet the search criteria.GET /v1/{project_id}/training-job-configsTable 1 describes the required pa", @@ -1202,8 +977,8 @@ "title":"Querying a List of Training Job Configurations", "uri":"modelarts_03_0059.html", "doc_type":"api", - "p_code":"132", - "code":"134" + "p_code":"107", + "code":"109" }, { "desc":"This API is used to modify a training job configuration.PUT /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.ParametersParamet", @@ -1211,8 +986,8 @@ "title":"Modifying a Training Job Configuration", "uri":"modelarts_03_0060.html", "doc_type":"api", - "p_code":"132", - "code":"135" + "p_code":"107", + "code":"110" }, { "desc":"This API is used to delete a training job configuration.DELETE /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.Parameter desc", @@ -1220,8 +995,8 @@ "title":"Deleting a Training Job Configuration", "uri":"modelarts_03_0061.html", "doc_type":"api", - "p_code":"132", - "code":"136" + "p_code":"107", + "code":"111" }, { "desc":"This API is used to query the details about a specified training job configuration.GET /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required p", @@ -1229,8 +1004,8 @@ "title":"Querying the Details About a Training Job Configuration", "uri":"modelarts_03_0062.html", "doc_type":"api", - "p_code":"132", - "code":"137" + "p_code":"107", + "code":"112" }, { "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.", @@ -1238,8 +1013,8 @@ "title":"Visualization Jobs", "uri":"modelarts_03_0063.html", "doc_type":"api", - "p_code":"115", - "code":"138" + "p_code":"93", + "code":"113" }, { "desc":"This API is used to create a visualization job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a V", @@ -1247,8 +1022,8 @@ "title":"Creating a Visualization Job", "uri":"modelarts_03_0064.html", "doc_type":"api", - "p_code":"138", - "code":"139" + "p_code":"113", + "code":"114" }, { "desc":"This API is used to query the visualization jobs that meet the search criteria.GET /v1/{project_id}/visualization-jobsTable 1 describes the required parameters.Parameters", @@ -1256,8 +1031,8 @@ "title":"Querying a Visualization Job List", "uri":"modelarts_03_0065.html", "doc_type":"api", - "p_code":"138", - "code":"140" + "p_code":"113", + "code":"115" }, { "desc":"This API is used to query the details about a specified visualization job based on the job name.GET /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the requ", @@ -1265,8 +1040,8 @@ "title":"Querying the Details About a Visualization Job", "uri":"modelarts_03_0066.html", "doc_type":"api", - "p_code":"138", - "code":"141" + "p_code":"113", + "code":"116" }, { "desc":"This API is used to modify the description of a visualization job.PUT /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the required parameters.ParametersPara", @@ -1274,8 +1049,8 @@ "title":"Modifying the Description of a Visualization Job", "uri":"modelarts_03_0067.html", "doc_type":"api", - "p_code":"138", - "code":"142" + "p_code":"113", + "code":"117" }, { "desc":"This API is used to delete a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a ", @@ -1283,8 +1058,8 @@ "title":"Deleting a Visualization Job", "uri":"modelarts_03_0068.html", "doc_type":"api", - "p_code":"138", - "code":"143" + "p_code":"113", + "code":"118" }, { "desc":"This API is used to stop a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Vi", @@ -1292,8 +1067,8 @@ "title":"Stopping a Visualization Job", "uri":"modelarts_03_0069.html", "doc_type":"api", - "p_code":"138", - "code":"144" + "p_code":"113", + "code":"119" }, { "desc":"This API is used to restart a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a", @@ -1301,8 +1076,8 @@ "title":"Restarting a Visualization Job", "uri":"modelarts_03_0070.html", "doc_type":"api", - "p_code":"138", - "code":"145" + "p_code":"113", + "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.", @@ -1310,8 +1085,8 @@ "title":"Resource and Engine Specifications", "uri":"modelarts_03_0071.html", "doc_type":"api", - "p_code":"115", - "code":"146" + "p_code":"93", + "code":"121" }, { "desc":"This API is used to query the resource specifications of a specified job.You must specify the resource specifications when creating a training job or an inference job.GET", @@ -1319,8 +1094,8 @@ "title":"Querying Job Resource Specifications", "uri":"modelarts_03_0072.html", "doc_type":"api", - "p_code":"146", - "code":"147" + "p_code":"121", + "code":"122" }, { "desc":"This API is used to query the engine type and version of a specified job.You must specify the engine specifications when creating a training job or an inference job.GET /", @@ -1328,8 +1103,8 @@ "title":"Querying Job Engine Specifications", "uri":"modelarts_03_0073.html", "doc_type":"api", - "p_code":"146", - "code":"148" + "p_code":"121", + "code":"123" }, { "desc":"Table 1 describes the job statuses.", @@ -1337,8 +1112,8 @@ "title":"Job Statuses", "uri":"modelarts_03_0074.html", "doc_type":"api", - "p_code":"115", - "code":"149" + "p_code":"93", + "code":"124" }, { "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.", @@ -1347,16 +1122,7 @@ "uri":"modelarts_03_0075.html", "doc_type":"api", "p_code":"", - "code":"150" - }, - { - "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":"Models", - "uri":"modelarts_03_0153.html", - "doc_type":"api", - "p_code":"150", - "code":"151" + "code":"125" }, { "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", @@ -1364,8 +1130,8 @@ "title":"Importing a Model", "uri":"modelarts_03_0076.html", "doc_type":"api", - "p_code":"151", - "code":"152" + "p_code":"125", + "code":"126" }, { "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", @@ -1373,8 +1139,8 @@ "title":"Querying a Model List", "uri":"modelarts_03_0077.html", "doc_type":"api", - "p_code":"151", - "code":"153" + "p_code":"125", + "code":"127" }, { "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", @@ -1382,8 +1148,8 @@ "title":"Querying the Details About a Model", "uri":"modelarts_03_0078.html", "doc_type":"api", - "p_code":"151", - "code":"154" + "p_code":"125", + "code":"128" }, { "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 ", @@ -1391,8 +1157,8 @@ "title":"Deleting a Model", "uri":"modelarts_03_0079.html", "doc_type":"api", - "p_code":"151", - "code":"155" + "p_code":"125", + "code":"129" }, { "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.", @@ -1401,7 +1167,7 @@ "uri":"modelarts_03_0081.html", "doc_type":"api", "p_code":"", - "code":"156" + "code":"130" }, { "desc":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject", @@ -1409,8 +1175,8 @@ "title":"Deploying a Model as a Service", "uri":"modelarts_03_0082.html", "doc_type":"api", - "p_code":"156", - "code":"157" + "p_code":"130", + "code":"131" }, { "desc":"This API is used to obtain model services.GET /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_idYesS", @@ -1418,8 +1184,8 @@ "title":"Querying a Service List", "uri":"modelarts_03_0083.html", "doc_type":"api", - "p_code":"156", - "code":"158" + "p_code":"130", + "code":"132" }, { "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", @@ -1427,8 +1193,8 @@ "title":"Querying the Details About a Service", "uri":"modelarts_03_0084.html", "doc_type":"api", - "p_code":"156", - "code":"159" + "p_code":"130", + "code":"133" }, { "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", @@ -1436,8 +1202,8 @@ "title":"Updating Service Configurations", "uri":"modelarts_03_0086.html", "doc_type":"api", - "p_code":"156", - "code":"160" + "p_code":"130", + "code":"134" }, { "desc":"This API is used to query service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorTable 1 describes the required parameters.ParametersParameterMa", @@ -1445,8 +1211,8 @@ "title":"Querying Service Monitoring Information", "uri":"modelarts_03_0087.html", "doc_type":"api", - "p_code":"156", - "code":"161" + "p_code":"130", + "code":"135" }, { "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", @@ -1454,8 +1220,8 @@ "title":"Querying Service Update Logs", "uri":"modelarts_03_0088.html", "doc_type":"api", - "p_code":"156", - "code":"162" + "p_code":"130", + "code":"136" }, { "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", @@ -1463,8 +1229,8 @@ "title":"Querying Service Event Logs", "uri":"modelarts_03_0155.html", "doc_type":"api", - "p_code":"156", - "code":"163" + "p_code":"130", + "code":"137" }, { "desc":"This API is used to delete a model service. You can delete your own services only.Table 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionpro", @@ -1472,8 +1238,8 @@ "title":"Deleting a Service", "uri":"modelarts_03_0089.html", "doc_type":"api", - "p_code":"156", - "code":"164" + "p_code":"130", + "code":"138" }, { "desc":"This API is used to query supported service deployment specifications.URIGET /v1/{project_id}/services/specificationsNoneSample requestGET https://endpoint/v1/{project", @@ -1481,8 +1247,17 @@ "title":"Querying Supported Service Deployment Specifications", "uri":"modelarts_03_0200.html", "doc_type":"api", - "p_code":"156", - "code":"165" + "p_code":"130", + "code":"139" + }, + { + "desc":"This API is used to query dedicated resource pools.GET /v1/{project_id}/clustersParametersParameterMandatoryTypeDescriptionproject_idYesStringProject ID. For details abou", + "product_code":"modelarts", + "title":"Querying Dedicated Resource Pools", + "uri":"modelarts_03_0201.html", + "doc_type":"api", + "p_code":"130", + "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.", @@ -1491,7 +1266,7 @@ "uri":"authorization.html", "doc_type":"api", "p_code":"", - "code":"166" + "code":"141" }, { "desc":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", @@ -1499,8 +1274,8 @@ "title":"Configuring Authorization", "uri":"CreateAuthorization.html", "doc_type":"api", - "p_code":"166", - "code":"167" + "p_code":"141", + "code":"142" }, { "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.", @@ -1508,8 +1283,8 @@ "title":"Viewing an Authorization List", "uri":"GetAuthorizations.html", "doc_type":"api", - "p_code":"166", - "code":"168" + "p_code":"141", + "code":"143" }, { "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", @@ -1517,8 +1292,8 @@ "title":"Deleting Authorization", "uri":"DeleteAuthorizations.html", "doc_type":"api", - "p_code":"166", - "code":"169" + "p_code":"141", + "code":"144" }, { "desc":"This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneCreate a ModelArts agency.S", @@ -1526,80 +1301,8 @@ "title":"Creating a ModelArts Agency", "uri":"CreateModelArtsAgency.html", "doc_type":"api", - "p_code":"166", - "code":"170" - }, - { - "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", - "uri":"workspace.html", - "doc_type":"api", - "p_code":"", - "code":"171" - }, - { - "desc":"This API is used to create a workspace. The name of the created workspace cannot be default, which is the name of the default workspace reserved by the system.POST /v1/{p", - "product_code":"modelarts", - "title":"Creating a Workspace", - "uri":"CreateWorkspace.html", - "doc_type":"api", - "p_code":"171", - "code":"172" - }, - { - "desc":"This API is used to obtain a workspace list with detailed information contained in the response body.GET /v1/{project_id}/workspacesNoneStatus code: 200Querying a Workspa", - "product_code":"modelarts", - "title":"Querying a Workspace List", - "uri":"ListWorkspaces.html", - "doc_type":"api", - "p_code":"171", - "code":"173" - }, - { - "desc":"This API is used to delete a workspace.DELETE /v1/{project_id}/workspaces/{workspace_id}NoneStatus code: 200Deleting a WorkspaceStatus code: 200OKSee Error Codes.", - "product_code":"modelarts", - "title":"Deleting a Workspace", - "uri":"DeleteWorkspace.html", - "doc_type":"api", - "p_code":"171", - "code":"174" - }, - { - "desc":"This API is used to obtain details about a workspace.GET /v1/{project_id}/workspaces/{workspace_id}NoneStatus code: 200Querying Details About a WorkspaceStatus code: 200O", - "product_code":"modelarts", - "title":"Querying Details About a Workspace", - "uri":"ShowWorkspaceInfo.html", - "doc_type":"api", - "p_code":"171", - "code":"175" - }, - { - "desc":"This API is used to modify a workspace.PUT /v1/{project_id}/workspaces/{workspace_id}Status code: 200Modifying a WorkspaceStatus code: 200OKSee Error Codes.", - "product_code":"modelarts", - "title":"Modifying a Workspace", - "uri":"UpdateWorkspace.html", - "doc_type":"api", - "p_code":"171", - "code":"176" - }, - { - "desc":"This API is used to obtain workspace quotas.GET /v1/{project_id}/workspaces/{workspace_id}/quotasNoneStatus code: 200Querying Workspace QuotasStatus code: 200OKSee Error ", - "product_code":"modelarts", - "title":"Querying a Workspace Quota", - "uri":"ListWorkspaceQuotas.html", - "doc_type":"api", - "p_code":"171", - "code":"177" - }, - { - "desc":"This API is used to modify a workspace quota.PUT /v1/{project_id}/workspaces/{workspace_id}/quotasStatus code: 200Modifying Workspace QuotasStatus code: 200OKSee Error Co", - "product_code":"modelarts", - "title":"Modifying a Workspace Quota", - "uri":"UpdateWorkspaceQuotas.html", - "doc_type":"api", - "p_code":"171", - "code":"178" + "p_code":"141", + "code":"145" }, { "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.", @@ -1608,7 +1311,7 @@ "uri":"modelarts_03_0400.html", "doc_type":"api", "p_code":"", - "code":"179" + "code":"146" }, { "desc":"This section describes how to train a model on ModelArts by calling a series of APIs.The process for creating a training job using the TensorFlow framework is as follows:", @@ -1616,8 +1319,80 @@ "title":"Creating a Training Job Using the TensorFlow Framework", "uri":"modelarts_03_0401.html", "doc_type":"api", - "p_code":"179", - "code":"180" + "p_code":"146", + "code":"147" + }, + { + "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":"Permissions Policies and Supported Actions", + "uri":"modelarts_03_0138.html", + "doc_type":"api", + "p_code":"", + "code":"148" + }, + { + "desc":"This section describes fine-grained permissions management for your ModelArts. If your current account does not require individual IAM users, skip this section.By default", + "product_code":"modelarts", + "title":"Introduction", + "uri":"modelarts_03_0146.html", + "doc_type":"api", + "p_code":"148", + "code":"149" + }, + { + "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":"148", + "code":"150" + }, + { + "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 Permissions", + "uri":"modelarts_03_0161.html", + "doc_type":"api", + "p_code":"148", + "code":"151" + }, + { + "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", + "uri":"modelarts_03_0162.html", + "doc_type":"api", + "p_code":"148", + "code":"152" + }, + { + "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", + "doc_type":"api", + "p_code":"148", + "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":"Model Management Permissions", + "uri":"modelarts_03_0164.html", + "doc_type":"api", + "p_code":"148", + "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":"Service Management Permissions", + "uri":"modelarts_03_0165.html", + "doc_type":"api", + "p_code":"148", + "code":"155" }, { "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 +1401,7 @@ "uri":"modelarts_03_0093.html", "doc_type":"api", "p_code":"", - "code":"181" + "code":"156" }, { "desc":"Table 1 describes the status codes.", @@ -1634,8 +1409,8 @@ "title":"Status Code", "uri":"modelarts_03_0094.html", "doc_type":"api", - "p_code":"181", - "code":"182" + "p_code":"156", + "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.", @@ -1643,17 +1418,17 @@ "title":"Error Codes", "uri":"modelarts_03_0095.html", "doc_type":"api", - "p_code":"181", - "code":"183" + "p_code":"156", + "code":"158" }, { - "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", + "desc":"A project ID is required for some requests when an API is called. Therefore, obtain the project ID before calling the API. Use either of the following methods:Obtaining a", "product_code":"modelarts", - "title":"Obtaining a Project ID and Name", + "title":"Obtaining a Project ID", "uri":"modelarts_03_0147.html", "doc_type":"api", - "p_code":"181", - "code":"184" + "p_code":"156", + "code":"159" }, { "desc":"When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows:Sign up and log in to the console.Hover the cursor o", @@ -1661,17 +1436,26 @@ "title":"Obtaining an Account Name and ID", "uri":"modelarts_03_0148.html", "doc_type":"api", - "p_code":"181", - "code":"185" + "p_code":"156", + "code":"160" }, { - "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", + "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.Hover the", "product_code":"modelarts", "title":"Obtaining a Username and ID", "uri":"modelarts_03_0006.html", "doc_type":"api", - "p_code":"181", - "code":"186" + "p_code":"156", + "code":"161" + }, + { + "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.To do so, perform the following", + "product_code":"modelarts", + "title":"Obtaining a Project Name", + "uri":"modelarts_03_0247.html", + "doc_type":"api", + "p_code":"156", + "code":"162" }, { "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.", @@ -1680,6 +1464,6 @@ "uri":"modelarts_03_0097.html", "doc_type":"api", "p_code":"", - "code":"187" + "code":"163" } ] \ No newline at end of file diff --git a/docs/modelarts/api-ref/CreateDataset.html b/docs/modelarts/api-ref/CreateDataset.html index f5ddfa707..18653c115 100644 --- a/docs/modelarts/api-ref/CreateDataset.html +++ b/docs/modelarts/api-ref/CreateDataset.html @@ -1,1076 +1,984 @@

Creating a Dataset

-

Function

This API is used to create a dataset.

+

Function

This API is used to create a dataset.

-

URI

POST /v2/{project_id}/datasets

+

URI

POST /v2/{project_id}/datasets

-
Table 1 Path parameters

Parameter

+
- - - - - - -
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 the project ID, see Obtaining a Project ID.

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

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

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

data_format

+

data_format

No

+

No

String

+

String

Data format. The options are as follows:

-
  • Default: default format

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

    -
+

Data format. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets)

data_sources

+

data_sources

No

+

No

Array of DataSource objects

+

Array of DataSource objects

Input dataset path, which is used to synchronize source data (such as images, text files, and audio files) in the directory and its subdirectories to the dataset. For a table dataset, this parameter indicates the import directory. The work directory of a table dataset cannot be an OBS path in a KMS-encrypted bucket.

+

Input dataset path, which is used to synchronize source data (such as images, text files, and audio files) in the directory and its subdirectories to the dataset. For a table dataset, this parameter indicates the import directory. The work directory of a table dataset cannot be an OBS path in a KMS-encrypted bucket.

dataset_name

+

dataset_name

Yes

+

Yes

String

+

String

Dataset name. The value contains 1 to 100 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed, for example, dataset-9f3b.

+

Dataset name. The value contains 1 to 100 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed, for example, dataset-9f3b.

dataset_type

+

dataset_type

No

+

No

Integer

+

Integer

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. 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

description

+

description

No

+

No

String

+

String

Dataset description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

+

Dataset description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

import_annotations

+

import_annotations

No

+

No

Boolean

+

Boolean

Whether to automatically import the labeling information in the input directory, supporting detection, image classification, and text classification. The options are as follows:

-
  • true: Import labeling information in the input directory. (Default value)

    -
  • false: Do not import labeling information in the input directory.

    -
+

Whether to automatically import the labeling information in the input directory, supporting detection, image classification, and text classification. The options are as follows: - true: Import labeling information in the input directory. (Default value) - false: Do not import labeling information in the input directory.

import_data

+

import_data

No

+

No

Boolean

+

Boolean

Whether to import data. This parameter is used only for table datasets. The options are as follows:

-
  • true: Import data when creating a database.

    -
  • false: Do not import data when creating a database. (Default value)

    -
+

Whether to import data. This parameter is used only for table datasets. The options are as follows: - true: Import data when creating a database. - false: Do not import data when creating a database. (Default value)

label_format

+

label_format

No

+

No

LabelFormat object

+

LabelFormat object

Label format information. This parameter is used only for text datasets.

+

Label format information. This parameter is used only for text datasets.

labels

+

labels

No

+

No

Array of Label objects

+

Array of Label objects

Dataset label list.

+

Dataset label list.

managed

+

managed

No

+

No

Boolean

+

Boolean

Whether to host a dataset. The options are as follows:

-
  • true: Host a dataset.

    -
  • false: Do not host a dataset. (Default value)

    -
+

Whether to host a dataset. The options are as follows: - true: Host a dataset. - false: Do not host a dataset. (Default value)

schema

+

schema

No

+

No

Array of Field objects

+

Array of Field objects

Schema list.

+

Schema list.

work_path

+

work_path

Yes

+

Yes

String

+

String

Output dataset path, which is used to store output files such as label files.

-
  • The format is /Bucket name/File path, for example, /obs-bucket/flower/rose/. (The directory is used as the path.)

    -
  • A bucket cannot be directly used as a path.

    -
  • The output dataset path is different from the input dataset path or its subdirectory.

    -
  • The value contains 3 to 700 characters.

    -
+

Output dataset path, which is used to store output files such as label files. - The format is /Bucket name/File path, for example, /obs-bucket/flower/rose/. (The directory is used as the path.)- A bucket cannot be directly used as a path.- The output dataset path is different from the input dataset path or its subdirectory.- The value contains 3 to 700 characters.

work_path_type

+

work_path_type

Yes

+

Yes

Integer

+

Integer

Type of the dataset output path. The options are as follows:

-
  • 0: OBS bucket (default value)

    -
+

Type of the dataset output path. The options are as follows: - 0: OBS bucket (default value)

workforce_information

+

workforce_information

No

+

No

WorkforceInformation object

+

WorkforceInformation object

Team labeling information.

+

Team labeling information.

workspace_id

+

workspace_id

No

+

No

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 3 DataSource

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 3 DataSource

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

data_path

+

data_path

No

+

No

String

+

String

Data source path.

+

Data source path.

data_type

+

data_type

No

+

No

Integer

+

Integer

Data type. The options are as follows:

-
  • 0: OBS bucket (default value)

    -
  • 1: GaussDB(DWS)

    -
  • 2: DLI

    -
  • 3: RDS

    -
  • 4: MRS

    -
  • 5: AI Gallery

    -
  • 6: Inference service

    -
+

Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

schema_maps

+

schema_maps

No

+

No

Array of SchemaMap objects

+

Array of SchemaMap objects

Schema mapping information corresponding to the table data.

+

Schema mapping information corresponding to the table data.

source_info

+

source_info

No

+

No

SourceInfo object

+

SourceInfo object

Information required for importing a table data source.

+

Information required for importing a table data source.

with_column_header

+

with_column_header

No

+

No

Boolean

+

Boolean

Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

-
  • true: The first row in the file is the column name.

    -
  • false: The first row in the file is not the column name.

    -
+

Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

-
Table 4 SchemaMap

Parameter

+
- - - - - - - - - - -
Table 4 SchemaMap

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

dest_name

+

dest_name

No

+

No

String

+

String

Name of the destination column.

+

Name of the destination column.

src_name

+

src_name

No

+

No

String

+

String

Name of the source column.

+

Name of the source column.

-
Table 5 SourceInfo

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SourceInfo

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

cluster_id

+

cluster_id

No

+

No

String

+

String

ID of an MRS cluster.

+

ID of an MRS cluster.

cluster_mode

+

cluster_mode

No

+

No

String

+

String

Running mode of an MRS cluster. The options are as follows:

-
  • 0: normal cluster

    -
  • 1: security cluster

    -
+

Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

cluster_name

+

cluster_name

No

+

No

String

+

String

Name of an MRS cluster.

+

Name of an MRS cluster.

database_name

+

database_name

No

+

No

String

+

String

Name of the database to which the table dataset is imported.

+

Name of the database to which the table dataset is imported.

input

+

input

No

+

No

String

+

String

HDFS path of a table dataset.

+

HDFS path of a table dataset.

ip

+

ip

No

+

No

String

+

String

IP address of your GaussDB(DWS) cluster.

+

IP address of your GaussDB(DWS) cluster.

port

+

port

No

+

No

String

+

String

Port number of your GaussDB(DWS) cluster.

+

Port number of your GaussDB(DWS) cluster.

queue_name

+

queue_name

No

+

No

String

+

String

DLI queue name of a table dataset.

+

DLI queue name of a table dataset.

subnet_id

+

subnet_id

No

+

No

String

+

String

Subnet ID of an MRS cluster.

+

Subnet ID of an MRS cluster.

table_name

+

table_name

No

+

No

String

+

String

Name of the table to which a table dataset is imported.

+

Name of the table to which a table dataset is imported.

user_name

+

user_name

No

+

No

String

+

String

Username, which is mandatory for GaussDB(DWS) data.

+

Username, which is mandatory for GaussDB(DWS) data.

user_password

+

user_password

No

+

No

String

+

String

User password, which is mandatory for GaussDB(DWS) data.

+

User password, which is mandatory for GaussDB(DWS) data.

vpc_id

+

vpc_id

No

+

No

String

+

String

ID of the VPC where an MRS cluster resides.

+

ID of the VPC where an MRS cluster resides.

-
Table 6 LabelFormat

Parameter

+
- - - - - - - - - - - - - - -
Table 6 LabelFormat

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

label_type

+

label_type

No

+

No

String

+

String

Label type of text classification. The options are as follows:

-
  • 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt.

    -
  • 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

    -
+

Label type of text classification. The options are as follows: - 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt. - 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

text_label_separator

+

text_label_separator

No

+

No

String

+

String

Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

+

Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

text_sample_separator

+

text_sample_separator

No

+

No

String

+

String

Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

+

Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

-
Table 7 Label

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 7 Label

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

attributes

+

attributes

No

+

No

Array of LabelAttribute objects

+

Array of LabelAttribute objects

Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

+

Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

name

+

name

No

+

No

String

+

String

Label name.

+

Label name.

property

+

property

No

+

No

LabelProperty object

+

LabelProperty object

Basic attribute key-value pair of a label, such as color and shortcut keys.

+

Basic attribute key-value pair of a label, such as color and shortcut keys.

type

+

type

No

+

No

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. 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

-
Table 8 LabelAttribute

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 8 LabelAttribute

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

default_value

+

default_value

No

+

No

String

+

String

Default value of a label attribute.

+

Default value of a label attribute.

id

+

id

No

+

No

String

+

String

Label attribute ID.

+

Label attribute ID.

name

+

name

No

+

No

String

+

String

Label attribute name.

+

Label attribute name.

type

+

type

No

+

No

String

+

String

Label attribute type. The options are as follows:

-
  • text: text

    -
  • select: single-choice drop-down list

    -
+

Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

values

+

values

No

+

No

Array of LabelAttributeValue objects

+

Array of LabelAttributeValue objects

List of label attribute values.

+

List of label attribute values.

-
Table 9 LabelAttributeValue

Parameter

+
- - - - - - - - - - -
Table 9 LabelAttributeValue

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

id

+

id

No

+

No

String

+

String

Label attribute value ID.

+

Label attribute value ID.

value

+

value

No

+

No

String

+

String

Label attribute value.

+

Label attribute value.

-
Table 10 LabelProperty

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 LabelProperty

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

@modelarts:color

+

@modelarts:color

No

+

No

String

+

String

Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

+

Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

@modelarts:default_shape

+

@modelarts:default_shape

No

+

No

String

+

String

Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

-
  • bndbox: rectangle

    -
  • polygon: polygon

    -
  • circle: circle

    -
  • line: straight line

    -
  • dashed: dotted line

    -
  • point: point

    -
  • polyline: polyline

    -
+

Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

@modelarts:from_type

+

@modelarts:from_type

No

+

No

String

+

String

Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

+

Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

@modelarts:rename_to

+

@modelarts:rename_to

No

+

No

String

+

String

Default attribute: The new name of the label.

+

Default attribute: The new name of the label.

@modelarts:shortcut

+

@modelarts:shortcut

No

+

No

String

+

String

Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

+

Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

@modelarts:to_type

+

@modelarts:to_type

No

+

No

String

+

String

Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

+

Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

-
Table 11 Field

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 11 Field

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

description

+

description

No

+

No

String

+

String

Schema description.

+

Schema description.

name

+

name

No

+

No

String

+

String

Schema name.

+

Schema name.

schema_id

+

schema_id

No

+

No

Integer

+

Integer

Schema ID.

+

Schema ID.

type

+

type

No

+

No

String

+

String

Schema value type.

+

Schema value type.

-
Table 12 WorkforceInformation

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 WorkforceInformation

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

data_sync_type

+

data_sync_type

No

+

No

Integer

+

Integer

Synchronization type. The options are as follows:

-
  • 0: not to be synchronized

    -
  • 1: data to be synchronized

    -
  • 2: label to be synchronized

    -
  • 3: data and label to be synchronized

    -
+

Synchronization type. The options are as follows: - 0: not to be synchronized - 1: data to be synchronized - 2: label to be synchronized - 3: data and label to be synchronized

repetition

+

repetition

No

+

No

Integer

+

Integer

Number of persons who label each sample. The minimum value is 1.

+

Number of persons who label each sample. The minimum value is 1.

synchronize_auto_labeling_data

+

synchronize_auto_labeling_data

No

+

No

Boolean

+

Boolean

Whether to synchronously update auto labeling data. The options are as follows:

-
  • true: Update auto labeling data synchronously.

    -
  • false: Do not update auto labeling data synchronously.

    -
+

Whether to synchronously update auto labeling data. The options are as follows: - true: Update auto labeling data synchronously. - false: Do not update auto labeling data synchronously.

synchronize_data

+

synchronize_data

No

+

No

Boolean

+

Boolean

Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows:

-
  • true: Synchronize updated data to team members.

    -
  • false: Do not synchronize updated data to team members.

    -
+

Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: - true: Synchronize updated data to team members. - false: Do not synchronize updated data to team members.

task_id

+

task_id

No

+

No

String

+

String

ID of a team labeling task.

+

ID of a team labeling task.

task_name

+

task_name

Yes

+

Yes

String

+

String

Name of a team labeling task. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

+

Name of a team labeling task. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

workforces_config

+

workforces_config

No

+

No

WorkforcesConfig object

+

WorkforcesConfig object

Manpower assignment of a team labeling task. You can delegate the administrator to assign the manpower or do it by yourself.

+

Manpower assignment of a team labeling task. You can delegate the administrator to assign the manpower or do it by yourself.

-
Table 13 WorkforcesConfig

Parameter

+
- - - - - - - - - - -
Table 13 WorkforcesConfig

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

agency

+

agency

No

+

No

String

+

String

Administrator.

+

Team administrator.

workforces

+

workforces

No

+

No

Array of WorkforceConfig objects

+

Array of WorkforceConfig objects

List of teams that execute labeling tasks.

+

List of teams that execute labeling tasks.

-
Table 14 WorkforceConfig

Parameter

+
- - - - - - - - - - - - - - -
Table 14 WorkforceConfig

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

workers

+

workers

No

+

No

Array of Worker objects

+

Array of Worker objects

List of labeling team members.

+

List of labeling team members.

workforce_id

+

workforce_id

No

+

No

String

+

String

ID of a labeling team.

+

ID of a labeling team.

workforce_name

+

workforce_name

No

+

No

String

+

String

Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

+

Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

-
Table 15 Worker

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 15 Worker

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

create_time

+

create_time

No

+

No

Long

+

Long

Creation time.

+

Creation time.

description

+

description

No

+

No

String

+

String

Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

+

Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

email

+

email

No

+

No

String

+

String

Email address of a labeling team member.

+

Email address of a labeling team member.

role

+

role

No

+

No

Integer

+

Integer

Role. The options are as follows:

-
  • 0: labeling personnel

    -
  • 1: reviewer

    -
  • 2: team administrator

    -
  • 3: dataset owner

    -
+

Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

status

+

status

No

+

No

Integer

+

Integer

Current login status of a labeling team member. The options are as follows:

-
  • 0: The invitation email has not been sent.

    -
  • 1: The invitation email has been sent but the user has not logged in.

    -
  • 2: The user has logged in.

    -
  • 3: The labeling team member has been deleted.

    -
+

Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

update_time

+

update_time

No

+

No

Long

+

Long

Update time.

+

Update time.

worker_id

+

worker_id

No

+

No

String

+

String

ID of a labeling team member.

+

ID of a labeling team member.

workforce_id

+

workforce_id

No

+

No

String

+

String

ID of a labeling team.

+

ID of a labeling team.

-

Response Parameters

Status code: 201

+

Response Parameters

Status code: 201

-
Table 16 Response body parameters

Parameter

+
- - - - - - - - - - - - - -
Table 16 Response body parameters

Parameter

Type

+

Type

Description

+

Description

dataset_id

+

dataset_id

String

+

String

Dataset ID.

+

Dataset ID.

error_code

+

error_code

String

+

String

Error code.

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

+

Error message.

import_task_id

+

import_task_id

String

+

String

ID of an import task.

+

ID of an import task.

-

Example Requests

  • Creating an Image Classification Dataset

    -
    {
    +

    Example Requests

    • Creating an Image Classification Dataset
      {
         "workspace_id" : "0",
         "dataset_name" : "dataset-457f",
         "dataset_type" : 0,
      @@ -1095,8 +1003,7 @@
           }
         } ]
       }
      -
    • Creating an Object Detection Dataset

      -
      {
      +
    • Creating an Object Detection Dataset
      {
         "workspace_id" : "0",
         "dataset_name" : "dataset-95a6",
         "dataset_type" : 1,
      @@ -1121,8 +1028,7 @@
           }
         } ]
       }
      -
    • Creating a Table Dataset

      -
      {
      +
    • Creating a Table Dataset
      {
         "workspace_id" : "0",
         "dataset_name" : "dataset-de83",
         "dataset_type" : 400,
      @@ -1159,44 +1065,44 @@
       }
    -

    Example Responses

    Status code: 201

    -

    Created

    -
    {
    +

    Example Responses

    Status code: 201

    +

    Created

    +
    {
       "dataset_id" : "WxCREuCkBSAlQr9xrde"
     }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Created

    +

    Created

    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/CreateDatasetVersion.html b/docs/modelarts/api-ref/CreateDatasetVersion.html index e124cc910..09a181867 100644 --- a/docs/modelarts/api-ref/CreateDatasetVersion.html +++ b/docs/modelarts/api-ref/CreateDatasetVersion.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/versions

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -54,10 +54,7 @@ - - - - - diff --git a/docs/modelarts/api-ref/CreateLabels.html b/docs/modelarts/api-ref/CreateLabels.html index 31a02955c..ab8c61d42 100644 --- a/docs/modelarts/api-ref/CreateLabels.html +++ b/docs/modelarts/api-ref/CreateLabels.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

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

    -
    • true: Clear hard example properties. (Default value)

      -
    • false: Do not clear hard example properties.

      -
    +

    Whether to clear hard example properties. The options are as follows: - true: Clear hard example properties. (Default value) - false: Do not clear hard example properties.

    description

    @@ -75,10 +72,7 @@

    Boolean

    Whether to export images to the version output directory during release. The options are as follows:

    -
    • true: Export images to the version output directory.

      -
    • false: Do not export images to the version output directory. (Default value)

      -
    +

    Whether to export images to the version output directory during release. The options are as follows: - true: Export images to the version output directory. - false: Do not export images to the version output directory. (Default value)

    remove_sample_usage

    @@ -87,10 +81,7 @@

    Boolean

    Whether to clear the existing usage information of a dataset during release. The options are as follows:

    -
    • true: Clear the existing usage information of a dataset. (Default value)

      -
    • false: Do not clear the existing usage information of a dataset.

      -
    +

    Whether to clear the existing usage information of a dataset during release. The options are as follows: - true: Clear the existing usage information of a dataset. (Default value) - false: Do not clear the existing usage information of a dataset.

    train_evaluate_sample_ratio

    @@ -108,11 +99,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_name

    @@ -130,10 +117,7 @@

    Boolean

    Whether to write the column name in the first line of the CSV file during release. This field is valid for the table dataset. The options are as follows:

    -
    • true: Write the column name in the first line of the CSV file. (Default value)

      -
    • false: Do not write the column name in the first line of the CSV file.

      -
    +

    Whether to write the column name in the first line of the CSV file during release. This field is valid for the table dataset. The options are as follows: - true: Write the column name in the first line of the CSV file. (Default value) - false: Do not write the column name in the first line of the CSV file.

    Table 1 Path parameters

    Parameter

    +
    @@ -104,18 +104,7 @@ - @@ -165,10 +154,7 @@ - - - @@ -363,10 +338,7 @@ - diff --git a/docs/modelarts/api-ref/CreateWorker.html b/docs/modelarts/api-ref/CreateWorker.html index fb3e41eb0..c0213f57b 100644 --- a/docs/modelarts/api-ref/CreateWorker.html +++ b/docs/modelarts/api-ref/CreateWorker.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/workforces/{workforce_id}/workers

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -241,15 +227,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -327,10 +305,7 @@

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -72,11 +72,7 @@ - diff --git a/docs/modelarts/api-ref/CreateWorkforce.html b/docs/modelarts/api-ref/CreateWorkforce.html index a6c65e93a..56efe93af 100644 --- a/docs/modelarts/api-ref/CreateWorkforce.html +++ b/docs/modelarts/api-ref/CreateWorkforce.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/workforces

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

    Member role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    +

    Member role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/CreateWorkforceTask.html b/docs/modelarts/api-ref/CreateWorkforceTask.html index 117a30a76..978cbfa2a 100644 --- a/docs/modelarts/api-ref/CreateWorkforceTask.html +++ b/docs/modelarts/api-ref/CreateWorkforceTask.html @@ -1,314 +1,293 @@

    Creating a Team Labeling Task

    -

    Function

    This API is used to create a team labeling task.

    +

    Function

    This API is used to create a team labeling task.

    -

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks

    +

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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 the project ID, see Obtaining a Project ID.

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    auto_sync_dataset

    +

    auto_sync_dataset

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows:

    -
    • true: Automatically synchronize the result of a team labeling task to the dataset. (Default value)

      -
    • false: Do not automatically synchronize the result of a team labeling task to the dataset.

      -
    +

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: - true: Automatically synchronize the result of a team labeling task to the dataset. (Default value) - false: Do not automatically synchronize the result of a team labeling task to the dataset.

    data_sync_type

    +

    data_sync_type

    No

    +

    No

    Integer

    +

    Integer

    Synchronization type. The options are as follows:

    -
    • 0: not to be synchronized

      -
    • 1: data to be synchronized

      -
    • 2: label to be synchronized

      -
    • 3: data and label to be synchronized

      -
    +

    Synchronization type. The options are as follows: - 0: not to be synchronized - 1: data to be synchronized - 2: label to be synchronized - 3: data and label to be synchronized

    repetition

    +

    repetition

    No

    +

    No

    Integer

    +

    Integer

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    +

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    sample_conditions

    +

    sample_conditions

    No

    +

    No

    String

    +

    String

    Search conditions of dataset samples. Samples that meet the conditions are filtered for team labeling.

    +

    Search conditions of dataset samples. Samples that meet the conditions are filtered for team labeling.

    synchronize_auto_labeling_data

    +

    synchronize_auto_labeling_data

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows:

    -
    • true: Synchronize the results to be confirmed to team members after auto labeling is complete.

      -
    • false: Do not synchronize the auto labeling results. (Default value)

      -
    +

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: - true: Synchronize the results to be confirmed to team members after auto labeling is complete. - false: Do not synchronize the auto labeling results. (Default value)

    workforces_config

    +

    workforces_config

    No

    +

    No

    WorkforcesConfig object

    +

    WorkforcesConfig object

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    +

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    -
    Table 3 WorkforcesConfig

    Parameter

    +
    - - - - - - - - - - -
    Table 3 WorkforcesConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    No

    +

    No

    String

    +

    String

    Administrator.

    +

    Team administrator.

    workforces

    +

    workforces

    No

    +

    No

    Array of WorkforceConfig objects

    +

    Array of WorkforceConfig objects

    List of teams that execute labeling tasks.

    +

    List of teams that execute labeling tasks.

    -
    Table 4 WorkforceConfig

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 4 WorkforceConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    workers

    +

    workers

    No

    +

    No

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    No

    +

    No

    String

    +

    String

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    +

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    -
    Table 5 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Worker

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    No

    +

    No

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    No

    +

    No

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    No

    +

    No

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    No

    +

    No

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    No

    +

    No

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 6 Response body parameters

    Parameter

    +
    - - - - -
    Table 6 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    task_id

    +

    task_id

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    -

    Example Requests

    Creating a Team Labeling Task

    -
    {
    +

    Example Requests

    Creating a Team Labeling Task

    +
    {
       "workspace_id" : "0",
       "task_name" : "task-eb17",
       "task_type" : 0,
    @@ -344,44 +323,44 @@
       "auto_sync_dataset" : false
     }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "task_id" : "6phXEto29utpaMwbQkg"
     }
    -

    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/DeleteDataset.html b/docs/modelarts/api-ref/DeleteDataset.html index c72e82e01..c14174aad 100644 --- a/docs/modelarts/api-ref/DeleteDataset.html +++ b/docs/modelarts/api-ref/DeleteDataset.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/datasets/{dataset_id}

    -
    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/DeleteDatasetVersion.html b/docs/modelarts/api-ref/DeleteDatasetVersion.html index 594fa7b90..5ba51c16f 100644 --- a/docs/modelarts/api-ref/DeleteDatasetVersion.html +++ b/docs/modelarts/api-ref/DeleteDatasetVersion.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/DeleteLabelAndSamples.html b/docs/modelarts/api-ref/DeleteLabelAndSamples.html index 30e41ee10..510d72c6d 100644 --- a/docs/modelarts/api-ref/DeleteLabelAndSamples.html +++ b/docs/modelarts/api-ref/DeleteLabelAndSamples.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - - @@ -122,10 +108,7 @@ - diff --git a/docs/modelarts/api-ref/DeleteLabels.html b/docs/modelarts/api-ref/DeleteLabels.html index f38bed67c..689c5b9a8 100644 --- a/docs/modelarts/api-ref/DeleteLabels.html +++ b/docs/modelarts/api-ref/DeleteLabels.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/delete

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Boolean

    Whether to delete the sample source files. The options are as follows:

    -
    • true: Delete the sample source files.

      -
    • false: Do not delete the sample source files. (Default value)

      -
    +

    Whether to delete the sample source files. The options are as follows: - true: Delete the sample source files. - false: Do not delete the sample source files. (Default value)

    label_type

    @@ -74,18 +71,7 @@

    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. 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

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -53,11 +53,7 @@ - @@ -131,18 +127,7 @@ - @@ -192,10 +177,7 @@ - - - @@ -390,10 +361,7 @@ - diff --git a/docs/modelarts/api-ref/DeleteSamples.html b/docs/modelarts/api-ref/DeleteSamples.html index 8d3e810f6..34e6d7380 100644 --- a/docs/modelarts/api-ref/DeleteSamples.html +++ b/docs/modelarts/api-ref/DeleteSamples.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/delete

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Integer

    Whether to delete a label and samples containing the label. The options are as follows:

    -
    • 0: Delete the label.

      -
    • 1: Delete the label and the samples that only contain this label, but do not delete source files.

      -
    • 2: Delete the label and the samples that only contain this label and also delete source files.

      -
    +

    Whether to delete a label and samples containing the label. The options are as follows: - 0: Delete the label. - 1: Delete the label and the samples that only contain this label, but do not delete source files. - 2: Delete the label and the samples that only contain this label and also delete source files.

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -268,15 +250,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -354,10 +328,7 @@

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -54,10 +54,7 @@ - - @@ -144,10 +138,7 @@ - diff --git a/docs/modelarts/api-ref/DeleteWorker.html b/docs/modelarts/api-ref/DeleteWorker.html index 4a73aa297..746be3944 100644 --- a/docs/modelarts/api-ref/DeleteWorker.html +++ b/docs/modelarts/api-ref/DeleteWorker.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

    Whether to delete the source file. This field is valid for non-text datasets. (A text dataset is the entire text file. Therefore, deleting a piece of data from the text file does not affect the source text.) The options are as follows:

    -
    • false: Do not delete the source file. (Default value)

      -
    • true: Delete the source file. (Note: This operation may affect the dataset versions or other datasets that have used these files. As a result, the page display, training, or inference is abnormal.)

      -
    +

    Whether to delete the source file. This field is valid for non-text datasets. (A text dataset is the entire text file. Therefore, deleting a piece of data from the text file does not affect the source text.) The options are as follows: - false: Do not delete the source file. (Default value) - true: Delete the source file. (Note: This operation may affect the dataset versions or other datasets that have used these files. As a result, the page display, training, or inference is abnormal.)

    samples

    @@ -108,10 +105,7 @@

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/DeleteWorkers.html b/docs/modelarts/api-ref/DeleteWorkers.html index ec7325cb5..ef5525e30 100644 --- a/docs/modelarts/api-ref/DeleteWorkers.html +++ b/docs/modelarts/api-ref/DeleteWorkers.html @@ -5,7 +5,7 @@

    URI

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

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -96,10 +96,7 @@ - @@ -132,10 +129,7 @@ - diff --git a/docs/modelarts/api-ref/DeleteWorkforce.html b/docs/modelarts/api-ref/DeleteWorkforce.html index b6859e905..2a6fc8011 100644 --- a/docs/modelarts/api-ref/DeleteWorkforce.html +++ b/docs/modelarts/api-ref/DeleteWorkforce.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/workforces/{workforce_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -74,10 +74,7 @@ - @@ -110,10 +107,7 @@ - diff --git a/docs/modelarts/api-ref/DeleteWorkforceTask.html b/docs/modelarts/api-ref/DeleteWorkforceTask.html index f75e1906f..41a516fe4 100644 --- a/docs/modelarts/api-ref/DeleteWorkforceTask.html +++ b/docs/modelarts/api-ref/DeleteWorkforceTask.html @@ -5,7 +5,7 @@

    URI

    DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/DescDataset.html b/docs/modelarts/api-ref/DescDataset.html index cd6450a69..d4ac0c332 100644 --- a/docs/modelarts/api-ref/DescDataset.html +++ b/docs/modelarts/api-ref/DescDataset.html @@ -1,1534 +1,1353 @@

    Querying Details About a Dataset

    -

    Function

    This API is used to query details about a dataset.

    +

    Function

    This API is used to query details about a dataset.

    -

    URI

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

    +

    URI

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

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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 the project ID, see Obtaining a Project ID.

    -
    Table 2 Query parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    check_running_task

    +

    check_running_task

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows:

    -
    • true: Detect tasks (including initialization tasks) that are running in the dataset.

      -
    • false: Do not detect tasks that are running in the dataset. (Default value)

      -
    +

    Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows: - true: Detect tasks (including initialization tasks) that are running in the dataset. - false: Do not detect tasks that are running in the dataset. (Default value)

    running_task_type

    +

    running_task_type

    No

    +

    No

    Integer

    +

    Integer

    Type of the running tasks (including initialization tasks) to be detected. The options are as follows:

    -
    • 0: auto labeling

      -
    • 1: pre-labeling

      -
    • 2: export

      -
    • 3: version switch

      -
    • 4: manifest file export

      -
    • 5: manifest file import

      -
    • 6: version publishing

      -
    • 7: auto grouping

      -
    • 10: one-click model deployment (default value)

      -
    +

    Type of the running tasks (including initialization tasks) to be detected. The options are as follows: - 0: auto labeling - 1: pre-labeling - 2: export - 3: version switch - 4: manifest file export - 5: manifest file import - 6: version publishing - 7: auto grouping - 10: one-click model deployment (default value)

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    annotated_sample_count

    +

    annotated_sample_count

    Integer

    +

    Integer

    Number of labeled samples in a dataset.

    +

    Number of labeled samples in a dataset.

    annotated_sub_sample_count

    +

    annotated_sub_sample_count

    Integer

    +

    Integer

    Number of labeled subsamples.

    +

    Number of labeled subsamples.

    content_labeling

    +

    content_labeling

    Boolean

    +

    Boolean

    Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default.

    +

    Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a dataset is created.

    +

    Time when a dataset is created.

    current_version_id

    +

    current_version_id

    String

    +

    String

    Current version ID of a dataset.

    +

    Current version ID of a dataset.

    current_version_name

    +

    current_version_name

    String

    +

    String

    Current version name of a dataset.

    +

    Current version name of a dataset.

    data_format

    +

    data_format

    String

    +

    String

    Data format.

    +

    Data format.

    data_sources

    +

    data_sources

    Array of DataSource objects

    +

    Array of DataSource objects

    Data source list.

    +

    Data source list.

    data_statistics

    +

    data_statistics

    Map<String,Object>

    +

    Map<String,Object>

    Sample statistics on a dataset, including the statistics on sample metadata.

    +

    Sample statistics on a dataset, including the statistics on sample metadata.

    data_update_time

    +

    data_update_time

    Long

    +

    Long

    Time when a sample and a label are updated.

    +

    Time when a sample and a label are updated.

    dataset_format

    +

    dataset_format

    Integer

    +

    Integer

    Dataset format. The options are as follows:

    -
    • 0: file

      -
    • 1: table

      -
    +

    Dataset format. The options are as follows: - 0: file - 1: table

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID.

    +

    Dataset ID.

    dataset_name

    +

    dataset_name

    String

    +

    String

    Dataset name.

    +

    Dataset name.

    dataset_tags

    +

    dataset_tags

    Array of strings

    +

    Array of strings

    Key identifier list of a dataset, for example, ["Image","Object detection"].

    +

    Key identifier list of a dataset, for example, ["Image","Object detection"].

    dataset_type

    +

    dataset_type

    Integer

    +

    Integer

    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. 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_version_count

    +

    dataset_version_count

    Integer

    +

    Integer

    Number of dataset versions.

    +

    Number of dataset versions.

    deleted_sample_count

    +

    deleted_sample_count

    Integer

    +

    Integer

    Number of deleted samples.

    +

    Number of deleted samples.

    deletion_stats

    +

    deletion_stats

    Map<String,Integer>

    +

    Map<String,Integer>

    Deletion reason statistics.

    +

    Deletion reason statistics.

    description

    +

    description

    String

    +

    String

    Dataset description.

    +

    Dataset description.

    enterprise_project_id

    +

    enterprise_project_id

    String

    +

    String

    Enterprise project ID.

    +

    Enterprise project ID.

    exist_running_task

    +

    exist_running_task

    Boolean

    +

    Boolean

    Whether the dataset contains running (including initialization) tasks. The options are as follows:

    -
    • true: The dataset contains running tasks.

      -
    • false: The dataset does not contain running tasks.

      -
    +

    Whether the dataset contains running (including initialization) tasks. The options are as follows: - true: The dataset contains running tasks. - false: The dataset does not contain running tasks.

    exist_workforce_task

    +

    exist_workforce_task

    Boolean

    +

    Boolean

    Whether the dataset contains team labeling tasks. The options are as follows:

    -
    • true: The dataset contains team labeling tasks.

      -
    • false: The dataset does not contain team labeling tasks.

      -
    +

    Whether the dataset contains team labeling tasks. The options are as follows: - true: The dataset contains team labeling tasks. - false: The dataset does not contain team labeling tasks.

    feature_supports

    +

    feature_supports

    Array of strings

    +

    Array of strings

    List of features supported by the dataset. Currently, only the value 0 is supported, indicating that the OBS file size is limited.

    +

    List of features supported by the dataset. Currently, only the value 0 is supported, indicating that the OBS file size is limited.

    import_data

    +

    import_data

    Boolean

    +

    Boolean

    Whether to import data. The options are as follows:

    -
    • true: Import data.

      -
    • false: Do not import data.

      -
    +

    Whether to import data. The options are as follows: - true: Import data. - false: Do not import data.

    import_task_id

    +

    import_task_id

    String

    +

    String

    ID of an import task.

    +

    ID of an import task.

    inner_annotation_path

    +

    inner_annotation_path

    String

    +

    String

    Path for storing the labeling result of a dataset.

    +

    Path for storing the labeling result of a dataset.

    inner_data_path

    +

    inner_data_path

    String

    +

    String

    Path for storing the internal data of a dataset.

    +

    Path for storing the internal data of a dataset.

    inner_log_path

    +

    inner_log_path

    String

    +

    String

    Path for storing internal logs of a dataset.

    +

    Path for storing internal logs of a dataset.

    inner_task_path

    +

    inner_task_path

    String

    +

    String

    Path for internal task of a dataset.

    +

    Path for internal task of a dataset.

    inner_temp_path

    +

    inner_temp_path

    String

    +

    String

    Path for storing internal temporary files of a dataset.

    +

    Path for storing internal temporary files of a dataset.

    inner_work_path

    +

    inner_work_path

    String

    +

    String

    Output directory of a dataset.

    +

    Output directory of a dataset.

    label_task_count

    +

    label_task_count

    Integer

    +

    Integer

    Number of labeling tasks.

    +

    Number of labeling tasks.

    labels

    +

    labels

    Array of Label objects

    +

    Array of Label objects

    Dataset label list.

    +

    Dataset label list.

    loading_sample_count

    +

    loading_sample_count

    Integer

    +

    Integer

    Number of loading samples.

    +

    Number of loading samples.

    managed

    +

    managed

    Boolean

    +

    Boolean

    Whether a dataset is hosted. The options are as follows:

    -
    • true: The dataset is hosted.

      -
    • false: The dataset is not hosted.

      -
    +

    Whether a dataset is hosted. The options are as follows: - true: The dataset is hosted. - false: The dataset is not hosted.

    next_version_num

    +

    next_version_num

    Integer

    +

    Integer

    Number of next versions of a dataset.

    +

    Number of next versions of a dataset.

    running_tasks_id

    +

    running_tasks_id

    Array of strings

    +

    Array of strings

    ID list of running (including initialization) tasks.

    +

    ID list of running (including initialization) tasks.

    schema

    +

    schema

    Array of Field objects

    +

    Array of Field objects

    Schema list.

    +

    Schema list.

    status

    +

    status

    Integer

    +

    Integer

    Dataset status. The options are as follows:

    -
    • 0: creating dataset

      -
    • 1: normal dataset

      -
    • 2: deleting dataset

      -
    • 3: deleted dataset

      -
    • 4: abnormal dataset

      -
    • 5: synchronizing dataset

      -
    • 6: releasing dataset

      -
    • 7: dataset in version switching

      -
    • 8: importing dataset

      -
    +

    Dataset status. The options are as follows: - 0: creating dataset - 1: normal dataset - 2: deleting dataset - 3: deleted dataset - 4: abnormal dataset - 5: synchronizing dataset - 6: releasing dataset - 7: dataset in version switching - 8: importing dataset

    third_path

    +

    third_path

    String

    +

    String

    Third-party path.

    +

    Third-party path.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total number of dataset samples.

    +

    Total number of dataset samples.

    total_sub_sample_count

    +

    total_sub_sample_count

    Integer

    +

    Integer

    Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples.

    +

    Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples.

    unconfirmed_sample_count

    +

    unconfirmed_sample_count

    Integer

    +

    Integer

    Number of auto labeling samples to be confirmed.

    +

    Number of auto labeling samples to be confirmed.

    update_time

    +

    update_time

    Long

    +

    Long

    Time when a dataset is updated.

    +

    Time when a dataset is updated.

    versions

    +

    versions

    Array of DatasetVersion objects

    +

    Array of DatasetVersion objects

    Dataset version information. Currently, only the current version information of a dataset is recorded.

    +

    Dataset version information. Currently, only the current version information of a dataset is recorded.

    work_path

    +

    work_path

    String

    +

    String

    Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /Bucket name/File path. For example: /obs-bucket.

    +

    Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /Bucket name/File path. For example: /obs-bucket.

    work_path_type

    +

    work_path_type

    Integer

    +

    Integer

    Type of the dataset output path. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    +

    Type of the dataset output path. The options are as follows: - 0: OBS bucket (default value)

    workforce_descriptor

    +

    workforce_descriptor

    WorkforceDescriptor object

    +

    WorkforceDescriptor object

    Team labeling information.

    +

    Team labeling information.

    workforce_task_count

    +

    workforce_task_count

    Integer

    +

    Integer

    Number of team labeling tasks of a dataset.

    +

    Number of team labeling tasks of a dataset.

    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 4 DataSource

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 4 DataSource

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    data_path

    +

    data_path

    String

    +

    String

    Data source path.

    +

    Data source path.

    data_type

    +

    data_type

    Integer

    +

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    +

    schema_maps

    Array of SchemaMap objects

    +

    Array of SchemaMap objects

    Schema mapping information corresponding to the table data.

    +

    Schema mapping information corresponding to the table data.

    source_info

    +

    source_info

    SourceInfo object

    +

    SourceInfo object

    Information required for importing a table data source.

    +

    Information required for importing a table data source.

    with_column_header

    +

    with_column_header

    Boolean

    +

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    -
    Table 5 SchemaMap

    Parameter

    +
    - - - - - - - -
    Table 5 SchemaMap

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    dest_name

    +

    dest_name

    String

    +

    String

    Name of the destination column.

    +

    Name of the destination column.

    src_name

    +

    src_name

    String

    +

    String

    Name of the source column.

    +

    Name of the source column.

    -
    Table 6 SourceInfo

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 SourceInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    cluster_id

    +

    cluster_id

    String

    +

    String

    ID of an MRS cluster.

    +

    ID of an MRS cluster.

    cluster_mode

    +

    cluster_mode

    String

    +

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    +

    cluster_name

    String

    +

    String

    Name of an MRS cluster.

    +

    Name of an MRS cluster.

    database_name

    +

    database_name

    String

    +

    String

    Name of the database to which the table dataset is imported.

    +

    Name of the database to which the table dataset is imported.

    input

    +

    input

    String

    +

    String

    HDFS path of a table dataset.

    +

    HDFS path of a table dataset.

    ip

    +

    ip

    String

    +

    String

    IP address of your GaussDB(DWS) cluster.

    +

    IP address of your GaussDB(DWS) cluster.

    port

    +

    port

    String

    +

    String

    Port number of your GaussDB(DWS) cluster.

    +

    Port number of your GaussDB(DWS) cluster.

    queue_name

    +

    queue_name

    String

    +

    String

    DLI queue name of a table dataset.

    +

    DLI queue name of a table dataset.

    subnet_id

    +

    subnet_id

    String

    +

    String

    Subnet ID of an MRS cluster.

    +

    Subnet ID of an MRS cluster.

    table_name

    +

    table_name

    String

    +

    String

    Name of the table to which a table dataset is imported.

    +

    Name of the table to which a table dataset is imported.

    user_name

    +

    user_name

    String

    +

    String

    Username, which is mandatory for GaussDB(DWS) data.

    +

    Username, which is mandatory for GaussDB(DWS) data.

    user_password

    +

    user_password

    String

    +

    String

    User password, which is mandatory for GaussDB(DWS) data.

    +

    User password, which is mandatory for GaussDB(DWS) data.

    vpc_id

    +

    vpc_id

    String

    +

    String

    ID of the VPC where an MRS cluster resides.

    +

    ID of the VPC where an MRS cluster resides.

    -
    Table 7 Label

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 7 Label

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    attributes

    +

    attributes

    Array of LabelAttribute objects

    +

    Array of LabelAttribute objects

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    +

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    name

    +

    name

    String

    +

    String

    Label name.

    +

    Label name.

    property

    +

    property

    LabelProperty object

    +

    LabelProperty object

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    +

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    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. 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

    -
    Table 8 LabelProperty

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 8 LabelProperty

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    @modelarts:color

    +

    @modelarts:color

    String

    +

    String

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    +

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    @modelarts:default_shape

    +

    @modelarts:default_shape

    String

    +

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    +

    @modelarts:from_type

    String

    +

    String

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    @modelarts:rename_to

    +

    @modelarts:rename_to

    String

    +

    String

    Default attribute: The new name of the label.

    +

    Default attribute: The new name of the label.

    @modelarts:shortcut

    +

    @modelarts:shortcut

    String

    +

    String

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    +

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    @modelarts:to_type

    +

    @modelarts:to_type

    String

    +

    String

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    -
    Table 9 Field

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 9 Field

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    description

    +

    description

    String

    +

    String

    Schema description.

    +

    Schema description.

    name

    +

    name

    String

    +

    String

    Schema name.

    +

    Schema name.

    schema_id

    +

    schema_id

    Integer

    +

    Integer

    Schema ID.

    +

    Schema ID.

    type

    +

    type

    String

    +

    String

    Schema value type.

    +

    Schema value type.

    -
    Table 10 DatasetVersion

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 10 DatasetVersion

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    add_sample_count

    +

    add_sample_count

    Integer

    +

    Integer

    Number of added samples.

    +

    Number of added samples.

    annotated_sample_count

    +

    annotated_sample_count

    Integer

    +

    Integer

    Number of samples with labeled versions.

    +

    Number of samples with labeled versions.

    annotated_sub_sample_count

    +

    annotated_sub_sample_count

    Integer

    +

    Integer

    Number of labeled subsamples.

    +

    Number of labeled subsamples.

    clear_hard_property

    +

    clear_hard_property

    Boolean

    +

    Boolean

    Whether to clear hard example properties during release. The options are as follows:

    -
    • true: Clear hard example properties. (Default value)

      -
    • false: Do not clear hard example properties.

      -
    +

    Whether to clear hard example properties during release. The options are as follows: - true: Clear hard example properties. (Default value) - false: Do not clear hard example properties.

    code

    +

    code

    String

    +

    String

    Status code of a preprocessing task such as rotation and cropping.

    +

    Status code of a preprocessing task such as rotation and cropping.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a version is created.

    +

    Time when a version is created.

    crop

    +

    crop

    Boolean

    +

    Boolean

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:

    -
    • true: Crop the image.

      -
    • false: Do not crop the image. (Default value)

      -
    +

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: - true: Crop the image. - false: Do not crop the image. (Default value)

    crop_path

    +

    crop_path

    String

    +

    String

    Path for storing cropped files.

    +

    Path for storing cropped files.

    crop_rotate_cache_path

    +

    crop_rotate_cache_path

    String

    +

    String

    Temporary directory for executing the rotation and cropping task.

    +

    Temporary directory for executing the rotation and cropping task.

    data_path

    +

    data_path

    String

    +

    String

    Path for storing data.

    +

    Path for storing data.

    data_statistics

    +

    data_statistics

    Map<String,Object>

    +

    Map<String,Object>

    Sample statistics on a dataset, including the statistics on sample metadata in JSON format.

    +

    Sample statistics on a dataset, including the statistics on sample metadata in JSON format.

    data_validate

    +

    data_validate

    Boolean

    +

    Boolean

    Whether data is validated by the validation algorithm before release. The options are as follows:

    -
    • true: The data has been validated.

      -
    • false: The data has not been validated.

      -
    +

    Whether data is validated by the validation algorithm before release. The options are as follows: - true: The data has been validated. - false: The data has not been validated.

    deleted_sample_count

    +

    deleted_sample_count

    Integer

    +

    Integer

    Number of deleted samples.

    +

    Number of deleted samples.

    deletion_stats

    +

    deletion_stats

    Map<String,Integer>

    +

    Map<String,Integer>

    Deletion reason statistics.

    +

    Deletion reason statistics.

    description

    +

    description

    String

    +

    String

    Description of a version.

    +

    Description of a version.

    export_images

    +

    export_images

    Boolean

    +

    Boolean

    Whether to export images to the version output directory during release. The options are as follows:

    -
    • true: Export images to the version output directory.

      -
    • false: Do not export images to the version output directory. (Default value)

      -
    +

    Whether to export images to the version output directory during release. The options are as follows: - true: Export images to the version output directory. - false: Do not export images to the version output directory. (Default value)

    extract_serial_number

    +

    extract_serial_number

    Boolean

    +

    Boolean

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:

    -
    • true: Parse the subsample number.

      -
    • false: Do not parse the subsample number. (Default value)

      -
    +

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: - true: Parse the subsample number. - false: Do not parse the subsample number. (Default value)

    include_dataset_data

    +

    include_dataset_data

    Boolean

    +

    Boolean

    Whether to include the source data of a dataset during release. The options are as follows:

    -
    • true: The source data of a dataset is included.

      -
    • false: The source data of a dataset is not included.

      -
    +

    Whether to include the source data of a dataset during release. The options are as follows: - true: The source data of a dataset is included. - false: The source data of a dataset is not included.

    is_current

    +

    is_current

    Boolean

    +

    Boolean

    Whether the current dataset version is used. The options are as follows:

    -
    • true: The current dataset version is used.

      -
    • false: The current dataset version is not used.

      -
    +

    Whether the current dataset version is used. The options are as follows: - true: The current dataset version is used. - false: The current dataset version is not used.

    label_stats

    +

    label_stats

    Array of LabelStats objects

    +

    Array of LabelStats objects

    Label statistics list of a released version.

    +

    Label statistics list of a released version.

    label_type

    +

    label_type

    String

    +

    String

    Label type of a released version. The options are as follows:

    -
    • multi: Multi-label samples are included.

      -
    • single: All samples are single-labeled.

      -
    +

    Label type of a released version. The options are as follows: - multi: Multi-label samples are included. - single: All samples are single-labeled.

    manifest_cache_input_path

    +

    manifest_cache_input_path

    String

    +

    String

    Input path for the manifest file cache during version release.

    +

    Input path for the manifest file cache during version release.

    manifest_path

    +

    manifest_path

    String

    +

    String

    Path for storing the manifest file with the released version.

    +

    Path for storing the manifest file with the released version.

    message

    +

    message

    String

    +

    String

    Task information recorded during release (for example, error information).

    +

    Task information recorded during release (for example, error information).

    modified_sample_count

    +

    modified_sample_count

    Integer

    +

    Integer

    Number of modified samples.

    +

    Number of modified samples.

    previous_annotated_sample_count

    +

    previous_annotated_sample_count

    Integer

    +

    Integer

    Number of labeled samples of parent versions.

    +

    Number of labeled samples of parent versions.

    previous_total_sample_count

    +

    previous_total_sample_count

    Integer

    +

    Integer

    Total samples of parent versions.

    +

    Total samples of parent versions.

    previous_version_id

    +

    previous_version_id

    String

    +

    String

    Parent version ID

    +

    Parent version ID

    processor_task_id

    +

    processor_task_id

    String

    +

    String

    ID of a preprocessing task such as rotation and cropping.

    +

    ID of a preprocessing task such as rotation and cropping.

    processor_task_status

    +

    processor_task_status

    Integer

    +

    Integer

    Status of a preprocessing task such as rotation and cropping. The options are as follows:

    -
    • 0: initialized

      -
    • 1: running

      -
    • 2: completed

      -
    • 3: failed

      -
    • 4: stopped

      -
    • 5: timeout

      -
    • 6: deletion failed

      -
    • 7: stop failed

      -
    +

    Status of a preprocessing task such as rotation and cropping. The options are as follows: - 0: initialized - 1: running - 2: completed - 3: failed - 4: stopped - 5: timeout - 6: deletion failed - 7: stop failed

    remove_sample_usage

    +

    remove_sample_usage

    Boolean

    +

    Boolean

    Whether to clear the existing usage information of a dataset during release. The options are as follows:

    -
    • true: Clear the existing usage information of a dataset. (Default value)

      -
    • false: Do not clear the existing usage information of a dataset.

      -
    +

    Whether to clear the existing usage information of a dataset during release. The options are as follows: - true: Clear the existing usage information of a dataset. (Default value) - false: Do not clear the existing usage information of a dataset.

    rotate

    +

    rotate

    Boolean

    +

    Boolean

    Whether to rotate the image. The options are as follows:

    -
    • true: Rotate the image.

      -
    • false: Do not rotate the image. (Default value)

      -
    +

    Whether to rotate the image. The options are as follows: - true: Rotate the image. - false: Do not rotate the image. (Default value)

    rotate_path

    +

    rotate_path

    String

    +

    String

    Path for storing the rotated file.

    +

    Path for storing the rotated file.

    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. 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

    status

    +

    status

    Integer

    +

    Integer

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

    -
    • 0: creating

      -
    • 1: running

      -
    • 2: deleting

      -
    • 3: deleted

      -
    • 4: error

      -
    +

    Status of a dataset version. The options are as follows: - 0: creating - 1: running - 2: deleting - 3: deleted - 4: error

    tags

    +

    tags

    Array of strings

    +

    Array of strings

    Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"].

    +

    Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"].

    task_type

    +

    task_type

    Integer

    +

    Integer

    Labeling task type of the released version, which is the same as the dataset type.

    +

    Labeling task type of the released version, which is the same as the dataset type.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total number of version samples.

    +

    Total number of version samples.

    total_sub_sample_count

    +

    total_sub_sample_count

    Integer

    +

    Integer

    Total number of subsamples generated from the parent samples.

    +

    Total number of subsamples generated from the parent samples.

    train_evaluate_sample_ratio

    +

    train_evaluate_sample_ratio

    String

    +

    String

    Split training and verification ratio during version release. The default value is 1.00, indicating that all labeled samples are split into the training set.

    +

    Split training and verification ratio during version release. The default value is 1.00, indicating that all labeled samples are split into the training set.

    update_time

    +

    update_time

    Long

    +

    Long

    Time when a version is updated.

    +

    Time when a version is updated.

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    +

    version_id

    String

    +

    String

    Dataset version ID.

    +

    Dataset version ID.

    version_name

    +

    version_name

    String

    +

    String

    Dataset version name.

    +

    Dataset version name.

    with_column_header

    +

    with_column_header

    Boolean

    +

    Boolean

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the released CSV file is a column name.

      -
    • false: The first row in the released CSV file is not a column name.

      -
    +

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the released CSV file is a column name. - false: The first row in the released CSV file is not a column name.

    -
    Table 11 LabelStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 11 LabelStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    attributes

    +

    attributes

    Array of LabelAttribute objects

    +

    Array of LabelAttribute objects

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    +

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    count

    +

    count

    Integer

    +

    Integer

    Number of labels.

    +

    Number of labels.

    name

    +

    name

    String

    +

    String

    Label name.

    +

    Label name.

    property

    +

    property

    LabelProperty object

    +

    LabelProperty object

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    +

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    sample_count

    +

    sample_count

    Integer

    +

    Integer

    Number of samples containing the label.

    +

    Number of samples containing the label.

    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. 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

    -
    Table 12 LabelAttribute

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 12 LabelAttribute

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    default_value

    +

    default_value

    String

    +

    String

    Default value of a label attribute.

    +

    Default value of a label attribute.

    id

    +

    id

    String

    +

    String

    Label attribute ID.

    +

    Label attribute ID.

    name

    +

    name

    String

    +

    String

    Label attribute name.

    +

    Label attribute name.

    type

    +

    type

    String

    +

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    +

    values

    Array of LabelAttributeValue objects

    +

    Array of LabelAttributeValue objects

    List of label attribute values.

    +

    List of label attribute values.

    -
    Table 13 LabelAttributeValue

    Parameter

    +
    - - - - - - - -
    Table 13 LabelAttributeValue

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Label attribute value ID.

    +

    Label attribute value ID.

    value

    +

    value

    String

    +

    String

    Label attribute value.

    +

    Label attribute value.

    -
    Table 14 WorkforceDescriptor

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 14 WorkforceDescriptor

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    current_task_id

    +

    current_task_id

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    current_task_name

    +

    current_task_name

    String

    +

    String

    Name of a team labeling task.

    +

    Name of a team labeling task.

    reject_num

    +

    reject_num

    Integer

    +

    Integer

    Number of rejected samples.

    +

    Number of rejected samples.

    repetition

    +

    repetition

    Integer

    +

    Integer

    Number of persons who label each sample. The minimum value is 1.

    +

    Number of persons who label each sample. The minimum value is 1.

    is_synchronize_auto_labeling_data

    +

    is_synchronize_auto_labeling_data

    Boolean

    +

    Boolean

    Whether to synchronously update auto labeling data. The options are as follows:

    -
    • true: Update auto labeling data synchronously.

      -
    • false: Do not update auto labeling data synchronously.

      -
    +

    Whether to synchronously update auto labeling data. The options are as follows: - true: Update auto labeling data synchronously. - false: Do not update auto labeling data synchronously.

    is_synchronize_data

    +

    is_synchronize_data

    Boolean

    +

    Boolean

    Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows:

    -
    • true: Synchronize updated data to team members.

      -
    • false: Do not synchronize updated data to team members.

      -
    +

    Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: - true: Synchronize updated data to team members. - false: Do not synchronize updated data to team members.

    workers

    +

    workers

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    String

    +

    String

    Name of a labeling team.

    +

    Name of a labeling team.

    -
    Table 15 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 15 Worker

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Example Requests

    Querying Details About a Dataset

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

    Example Requests

    Querying Details About a Dataset

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

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "dataset_id" : "gfghHSokody6AJigS5A",
       "dataset_name" : "dataset-f9e8",
       "dataset_type" : 0,
    @@ -1582,38 +1401,38 @@
       } ]
     }
    -

    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/DescImportTask.html b/docs/modelarts/api-ref/DescImportTask.html index d254ef05b..2b5f7586a 100644 --- a/docs/modelarts/api-ref/DescImportTask.html +++ b/docs/modelarts/api-ref/DescImportTask.html @@ -5,7 +5,7 @@

    URI

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

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -132,20 +132,14 @@ - - - - - @@ -346,10 +322,7 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    OBS path or manifest path to be imported.

    -
    • When importing a manifest file, ensure that the path is accurate to the manifest file.

      -
    • When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

      -
    +

    OBS path or manifest path to be imported. - When importing a manifest file, ensure that the path is accurate to the manifest file.- When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

    import_type

    Integer

    Import mode. The options are as follows:

    -
    • 0: Import by directory.

      -
    • 1: Import by manifest file.

      -
    +

    Import mode. The options are as follows: - 0: Import by directory. - 1: Import by manifest file.

    imported_sample_count

    @@ -180,14 +174,7 @@

    String

    Status of an import task. The options are as follows:

    -
    • QUEUING: queuing

      -
    • STARTING: execution started

      -
    • RUNNING: running

      -
    • COMPLETED: completed

      -
    • FAILED: failed

      -
    • NOT_EXIST: not found

      -
    +

    Status of an import task. The options are as follows: - QUEUING: queuing - STARTING: execution started - RUNNING: running - COMPLETED: completed - FAILED: failed - NOT_EXIST: not found

    task_id

    @@ -262,15 +249,7 @@

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    @@ -291,10 +270,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    diff --git a/docs/modelarts/api-ref/DescWorker.html b/docs/modelarts/api-ref/DescWorker.html index 3aea055f3..9cb2fb107 100644 --- a/docs/modelarts/api-ref/DescWorker.html +++ b/docs/modelarts/api-ref/DescWorker.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -83,24 +83,14 @@ - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    diff --git a/docs/modelarts/api-ref/DescWorkforce.html b/docs/modelarts/api-ref/DescWorkforce.html index bf04d1196..deb5a7a9a 100644 --- a/docs/modelarts/api-ref/DescWorkforce.html +++ b/docs/modelarts/api-ref/DescWorkforce.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces/{workforce_id}

    -
    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/DescWorkforceTask.html b/docs/modelarts/api-ref/DescWorkforceTask.html index 2463b15de..dd55da92d 100644 --- a/docs/modelarts/api-ref/DescWorkforceTask.html +++ b/docs/modelarts/api-ref/DescWorkforceTask.html @@ -1,1266 +1,1163 @@

    Querying Details About a Team Labeling Task

    -

    Function

    This API is used to query the details about a team labeling task.

    +

    Function

    This API is used to query the details about a team labeling task.

    -

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

    +

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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 the project ID, see Obtaining a Project ID.

    workforce_task_id

    +

    workforce_task_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    -
    Table 2 Query parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    label_stats

    +

    label_stats

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to return label statistics. The options are as follows:

    -
    • true: Return label statistics.

      -
    • false: Do not return label statistics. (Default value)

      -
    +

    Whether to return label statistics. The options are as follows: - true: Return label statistics. - false: Do not return label statistics. (Default value)

    sample_stats

    +

    sample_stats

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to return sample statistics. The options are as follows:

    -
    • true: Return sample statistics.

      -
    • false: Do not return sample statistics. (Default value)

      -
    +

    Whether to return sample statistics. The options are as follows: - true: Return sample statistics. - false: Do not return sample statistics. (Default value)

    workforce_stats

    +

    workforce_stats

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to return personnel statistics. The options are as follows:

    -
    • true: Return personnel statistics.

      -
    • false: Do not return personnel statistics. (Default value)

      -
    +

    Whether to return personnel statistics. The options are as follows: - true: Return personnel statistics. - false: Do not return personnel statistics. (Default value)

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

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

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    auto_sync_dataset

    +

    auto_sync_dataset

    Boolean

    +

    Boolean

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows:

    -
    • true: Automatically synchronize the result of a team labeling task to the dataset.

      -
    • false: Do not automatically synchronize the result of a team labeling task to the dataset.

      -
    +

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: - true: Automatically synchronize the result of a team labeling task to the dataset. - false: Do not automatically synchronize the result of a team labeling task to the dataset.

    check_rate

    +

    check_rate

    Double

    +

    Double

    Acceptance ratio of a team labeling task.

    +

    Acceptance ratio of a team labeling task.

    checking_task_desc

    +

    checking_task_desc

    WorkforceSamplingTaskDesc object

    +

    WorkforceSamplingTaskDesc object

    Details about the current acceptance task of a team labeling task.

    +

    Details about the current acceptance task of a team labeling task.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a labeling task is created.

    +

    Time when a labeling task is created.

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID.

    +

    Dataset ID.

    description

    +

    description

    String

    +

    String

    Description of a labeling task.

    +

    Description of a labeling task.

    label_stats

    +

    label_stats

    Array of LabelStats objects

    +

    Array of LabelStats objects

    Label statistics of a labeling task.

    +

    Label statistics of a labeling task.

    pass_rate

    +

    pass_rate

    Double

    +

    Double

    Acceptance pass rate of a team labeling task.

    +

    Acceptance pass rate of a team labeling task.

    repetition

    +

    repetition

    Integer

    +

    Integer

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    +

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    sample_search_conditions

    +

    sample_search_conditions

    Array of SearchCondition objects

    +

    Array of SearchCondition objects

    Sample search conditions when creating a task.

    +

    Sample search conditions when creating a task.

    sample_stats

    +

    sample_stats

    SampleStats object

    +

    SampleStats object

    Sample statistics of a labeling task.

    +

    Sample statistics of a labeling task.

    score

    +

    score

    Double

    +

    Double

    Average acceptance score of a team labeling task.

    +

    Average acceptance score of a team labeling task.

    status

    +

    status

    Integer

    +

    Integer

    Status of a team labeling task. The options are as follows:

    -
    • 6: created. The owner has created a task but does not start it. Only the owner and manager can view the task list.

      -
    • 0: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started.

      -
    • 1: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again.

      -
    • 2: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed.

      -
    • 3: passed. The team labeling task has been completed.

      -
    • 4: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing.

      -
    • 5: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized.

      -
    • 7: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress.

      -
    +

    Status of a team labeling task. The options are as follows: - 6: created. The owner has created a task but does not start it. Only the owner and manager can view the task list. - 0: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started. - 1: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again. - 2: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed. - 3: passed. The team labeling task has been completed. - 4: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing. - 5: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized. - 7: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress.

    synchronize_auto_labeling_data

    +

    synchronize_auto_labeling_data

    Boolean

    +

    Boolean

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows:

    -
    • true: Synchronize the results to be confirmed to team members after auto labeling is complete.

      -
    • false: Do not synchronize the auto labeling results. (Default value)

      -
    +

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: - true: Synchronize the results to be confirmed to team members after auto labeling is complete. - false: Do not synchronize the auto labeling results. (Default value)

    synchronize_data

    +

    synchronize_data

    Boolean

    +

    Boolean

    Whether to synchronize the added data of a team labeling task. The options are as follows:

    -
    • true: Upload files, synchronize data sources, and synchronize imported unlabeled files to team members.

      -
    • false: Do not synchronize the added data. (Default value)

      -
    +

    Whether to synchronize the added data of a team labeling task. The options are as follows: - true: Upload files, synchronize data sources, and synchronize imported unlabeled files to team members. - false: Do not synchronize the added data. (Default value)

    task_id

    +

    task_id

    String

    +

    String

    ID of a labeling task.

    +

    ID of a labeling task.

    task_name

    +

    task_name

    String

    +

    String

    Name of a labeling task.

    +

    Name of a labeling task.

    update_time

    +

    update_time

    Long

    +

    Long

    Time when a labeling task is updated.

    +

    Time when a labeling task is updated.

    version_id

    +

    version_id

    String

    +

    String

    Version ID of the dataset associated with a labeling task.

    +

    Version ID of the dataset associated with a labeling task.

    worker_stats

    +

    worker_stats

    Array of WorkerTask objects

    +

    Array of WorkerTask objects

    Labeling progress statistics on team labeling task members.

    +

    Labeling progress statistics on team labeling task members.

    workforce_stats

    +

    workforce_stats

    WorkforceStats object

    +

    WorkforceStats object

    Statistics on team labeling task members.

    +

    Statistics on team labeling task members.

    workforces_config

    +

    workforces_config

    WorkforcesConfig object

    +

    WorkforcesConfig object

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    +

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    -
    Table 4 WorkforceSamplingTaskDesc

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 4 WorkforceSamplingTaskDesc

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    action

    +

    action

    Integer

    +

    Integer

    Action after the acceptance. The options are as follows:

    -
    • 0: Pass all samples when the acceptance is completed (including single-rejected samples)

      -
    • 1: Reject all samples when the acceptance is completed (including single-accepted samples)

      -
    • 4: Pass only single-accepted samples and unaccepted samples.

      -
    • 5: Reject only single-rejected samples and unaccepted samples.

      -
    +

    Action after the acceptance. The options are as follows: - 0: Pass all samples when the acceptance is completed (including single-rejected samples) - 1: Reject all samples when the acceptance is completed (including single-accepted samples) - 4: Pass only single-accepted samples and unaccepted samples. - 5: Reject only single-rejected samples and unaccepted samples.

    checking_stats

    +

    checking_stats

    CheckTaskStats object

    +

    CheckTaskStats object

    Real-time report of acceptance tasks.

    +

    Real-time report of acceptance tasks.

    checking_task_id

    +

    checking_task_id

    String

    +

    String

    ID of the current acceptance task.

    +

    ID of the current acceptance task.

    overwrite_last_result

    +

    overwrite_last_result

    Boolean

    +

    Boolean

    Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows:

    -
    • true: Overwrite the labeled result.

      -
    • false: Do not overwrite the labeled result. (Default value)

      -
    +

    Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows: - true: Overwrite the labeled result. - false: Do not overwrite the labeled result. (Default value)

    total_stats

    +

    total_stats

    CheckTaskStats object

    +

    CheckTaskStats object

    Overall report of historical acceptance tasks.

    +

    Overall report of historical acceptance tasks.

    -
    Table 5 CheckTaskStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 CheckTaskStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    accepted_sample_count

    +

    accepted_sample_count

    Integer

    +

    Integer

    Accepted samples.

    +

    Accepted samples.

    checked_sample_count

    +

    checked_sample_count

    Integer

    +

    Integer

    Checked samples.

    +

    Checked samples.

    pass_rate

    +

    pass_rate

    Double

    +

    Double

    Pass rate of samples.

    +

    Pass rate of samples.

    rejected_sample_count

    +

    rejected_sample_count

    Integer

    +

    Integer

    Rejected samples.

    +

    Rejected samples.

    sampled_sample_count

    +

    sampled_sample_count

    Integer

    +

    Integer

    Number of sampled samples.

    +

    Number of sampled samples.

    sampling_num

    +

    sampling_num

    Integer

    +

    Integer

    Samples of an acceptance task.

    +

    Samples of an acceptance task.

    sampling_rate

    +

    sampling_rate

    Double

    +

    Double

    Sampling rate of an acceptance task.

    +

    Sampling rate of an acceptance task.

    score

    +

    score

    String

    +

    String

    Acceptance score.

    +

    Acceptance score.

    task_id

    +

    task_id

    String

    +

    String

    ID of an acceptance task.

    +

    ID of an acceptance task.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total samples.

    +

    Total samples.

    total_score

    +

    total_score

    Long

    +

    Long

    Total acceptance score.

    +

    Total acceptance score.

    unchecked_sample_count

    +

    unchecked_sample_count

    Integer

    +

    Integer

    Unchecked samples.

    +

    Unchecked samples.

    -
    Table 6 LabelStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 6 LabelStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    attributes

    +

    attributes

    Array of LabelAttribute objects

    +

    Array of LabelAttribute objects

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    +

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    count

    +

    count

    Integer

    +

    Integer

    Number of labels.

    +

    Number of labels.

    name

    +

    name

    String

    +

    String

    Label name.

    +

    Label name.

    property

    +

    property

    LabelProperty object

    +

    LabelProperty object

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    +

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    sample_count

    +

    sample_count

    Integer

    +

    Integer

    Number of samples containing the label.

    +

    Number of samples containing the label.

    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. 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

    -
    Table 7 LabelAttribute

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 7 LabelAttribute

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    default_value

    +

    default_value

    String

    +

    String

    Default value of a label attribute.

    +

    Default value of a label attribute.

    id

    +

    id

    String

    +

    String

    Label attribute ID.

    +

    Label attribute ID.

    name

    +

    name

    String

    +

    String

    Label attribute name.

    +

    Label attribute name.

    type

    +

    type

    String

    +

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    +

    values

    Array of LabelAttributeValue objects

    +

    Array of LabelAttributeValue objects

    List of label attribute values.

    +

    List of label attribute values.

    -
    Table 8 LabelAttributeValue

    Parameter

    +
    - - - - - - - -
    Table 8 LabelAttributeValue

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Label attribute value ID.

    +

    Label attribute value ID.

    value

    +

    value

    String

    +

    String

    Label attribute value.

    +

    Label attribute value.

    -
    Table 9 LabelProperty

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 9 LabelProperty

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    @modelarts:color

    +

    @modelarts:color

    String

    +

    String

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    +

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    @modelarts:default_shape

    +

    @modelarts:default_shape

    String

    +

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    +

    @modelarts:from_type

    String

    +

    String

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    @modelarts:rename_to

    +

    @modelarts:rename_to

    String

    +

    String

    Default attribute: The new name of the label.

    +

    Default attribute: The new name of the label.

    @modelarts:shortcut

    +

    @modelarts:shortcut

    String

    +

    String

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    +

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    @modelarts:to_type

    +

    @modelarts:to_type

    String

    +

    String

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    -
    Table 10 SearchCondition

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 10 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. The options are as follows: - 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. 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.

    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 11 SearchLabels

    Parameter

    +
    - - - - - - - -
    Table 11 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. The options are as follows: - OR: OR operation - AND: AND operation

    -
    Table 12 SearchLabel

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 12 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. The options are as follows: - 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. 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

    -
    Table 13 SearchProp

    Parameter

    +
    - - - - - - - -
    Table 13 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. The options are as follows: - 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 14 SampleStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 14 SampleStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    accepted_sample_count

    +

    accepted_sample_count

    Integer

    +

    Integer

    Number of samples accepted by the owner.

    +

    Number of samples accepted by the owner.

    auto_annotation_sample_count

    +

    auto_annotation_sample_count

    Integer

    +

    Integer

    Number of samples to be confirmed after intelligent labeling.

    +

    Number of samples to be confirmed after intelligent labeling.

    deleted_sample_count

    +

    deleted_sample_count

    Integer

    +

    Integer

    Number of deleted samples.

    +

    Number of deleted samples.

    rejected_sample_count

    +

    rejected_sample_count

    Integer

    +

    Integer

    Number of samples that failed to pass the owner acceptance.

    +

    Number of samples that failed to pass the owner acceptance.

    sampled_sample_count

    +

    sampled_sample_count

    Integer

    +

    Integer

    Number of samples that are to be accepted by the owner and sampled.

    +

    Number of samples that are to be accepted by the owner and sampled.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total number of samples.

    +

    Total number of samples.

    unannotated_sample_count

    +

    unannotated_sample_count

    Integer

    +

    Integer

    Number of unlabeled samples.

    +

    Number of unlabeled samples.

    uncheck_sample_count

    +

    uncheck_sample_count

    Integer

    +

    Integer

    Number of samples that have been approved by the reviewer and are to be accepted by the owner.

    +

    Number of samples that have been approved by the reviewer and are to be accepted by the owner.

    unreviewed_sample_count

    +

    unreviewed_sample_count

    Integer

    +

    Integer

    Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer.

    +

    Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer.

    -
    Table 15 WorkerTask

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 15 WorkerTask

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a labeling team member's task is created.

    +

    Time when a labeling team member's task is created.

    dataset_id

    +

    dataset_id

    String

    +

    String

    ID of a dataset associated with a labeling team member's task.

    +

    ID of a dataset associated with a labeling team member's task.

    dataset_type

    +

    dataset_type

    Integer

    +

    Integer

    Labeling type of a team member's task.

    +

    Labeling type of a team member's task.

    email

    +

    email

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    email_status

    +

    email_status

    Integer

    +

    Integer

    Email notification status of a labeling team member's labeling task. The options are as follows:

    -
    • 0: The email has not been sent.

      -
    • 1: The email format is incorrect.

      -
    • 2: The email address is unreachable.

      -
    • 3: The email has been sent.

      -
    +

    Email notification status of a labeling team member's labeling task. The options are as follows: - 0: The email has not been sent. - 1: The email format is incorrect. - 2: The email address is unreachable. - 3: The email has been sent.

    last_notify_time

    +

    last_notify_time

    Long

    +

    Long

    Timestamp of the latest notification email sent to a labeling team member.

    +

    Timestamp of the latest notification email sent to a labeling team member.

    pass_rate

    +

    pass_rate

    Double

    +

    Double

    Pass rate of task acceptance review for a labeling team member.

    +

    Pass rate of task acceptance review for a labeling team member.

    role

    +

    role

    Integer

    +

    Integer

    Role of a labeling team member.

    +

    Role of a labeling team member.

    sample_stats

    +

    sample_stats

    SampleStats object

    +

    SampleStats object

    Sample statistics of a labeling team member's task.

    +

    Sample statistics of a labeling team member's task.

    score

    +

    score

    Double

    +

    Double

    Average acceptance score of labeling team members' task samples.

    +

    Average acceptance score of labeling team members' task samples.

    task_id

    +

    task_id

    String

    +

    String

    Team labeling task ID associated with a member's task.

    +

    Team labeling task ID associated with a member's task.

    task_status

    +

    task_status

    Integer

    +

    Integer

    Task status of a labeling team member. The options are as follows:

    -
    • 6: created

      -
    • 0: starting

      -
    • 1: running

      -
    • 2: under acceptance

      -
    • 3: approved, indicating the team labeling task is complete

      -
    • 4: rejected, indicating that the task needs to be labeled and reviewed again

      -
    +

    Task status of a labeling team member. The options are as follows: - 6: created - 0: starting - 1: running - 2: under acceptance - 3: approved, indicating the team labeling task is complete - 4: rejected, indicating that the task needs to be labeled and reviewed again

    update_time

    +

    update_time

    Long

    +

    Long

    Time when a labeling team member's task is updated.

    +

    Time when a labeling team member's task is updated.

    worker_id

    +

    worker_id

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_task_name

    +

    workforce_task_name

    String

    +

    String

    Team labeling task name associated with a member's task.

    +

    Team labeling task name associated with a member's task.

    -
    Table 16 WorkforceStats

    Parameter

    +
    - - - - - - - - - - -
    Table 16 WorkforceStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    labeler_count

    +

    labeler_count

    Integer

    +

    Integer

    Number of labeling persons.

    +

    Number of labeling persons.

    reviewer_count

    +

    reviewer_count

    Integer

    +

    Integer

    Number of reviewers.

    +

    Number of reviewers.

    workforce_count

    +

    workforce_count

    Integer

    +

    Integer

    Number of teams.

    +

    Number of teams.

    -
    Table 17 WorkforcesConfig

    Parameter

    +
    - - - - - - - -
    Table 17 WorkforcesConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    String

    +

    String

    Administrator.

    +

    Team administrator.

    workforces

    +

    workforces

    Array of WorkforceConfig objects

    +

    Array of WorkforceConfig objects

    List of teams that execute labeling tasks.

    +

    List of teams that execute labeling tasks.

    -
    Table 18 WorkforceConfig

    Parameter

    +
    - - - - - - - - - - -
    Table 18 WorkforceConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    workers

    +

    workers

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    String

    +

    String

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    +

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    -
    Table 19 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 19 Worker

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Example Requests

    Querying Details About a Team Labeling Task

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

    Example Requests

    Querying Details About a Team Labeling Task

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

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "dataset_id" : "WxCREuCkBSAlQr9xrde",
       "task_id" : "iYZx7gScPUozOXner9k",
       "task_name" : "task-e63f",
    @@ -1333,38 +1230,38 @@
       } ]
     }
    -

    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/DescribeDatasetVersion.html b/docs/modelarts/api-ref/DescribeDatasetVersion.html index daf3e7c04..f6531ca6b 100644 --- a/docs/modelarts/api-ref/DescribeDatasetVersion.html +++ b/docs/modelarts/api-ref/DescribeDatasetVersion.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -83,10 +83,7 @@ - - - - - - - - - - - - - - - @@ -490,18 +424,7 @@ - @@ -541,10 +464,7 @@ - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

    Whether to clear hard example properties during release. The options are as follows:

    -
    • true: Clear hard example properties. (Default value)

      -
    • false: Do not clear hard example properties.

      -
    +

    Whether to clear hard example properties during release. The options are as follows: - true: Clear hard example properties. (Default value) - false: Do not clear hard example properties.

    code

    @@ -107,10 +104,7 @@

    Boolean

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:

    -
    • true: Crop the image.

      -
    • false: Do not crop the image. (Default value)

      -
    +

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: - true: Crop the image. - false: Do not crop the image. (Default value)

    crop_path

    @@ -145,10 +139,7 @@

    Boolean

    Whether data is validated by the validation algorithm before release. The options are as follows:

    -
    • true: The data has been validated.

      -
    • false: The data has not been validated.

      -
    +

    Whether data is validated by the validation algorithm before release. The options are as follows: - true: The data has been validated. - false: The data has not been validated.

    deleted_sample_count

    @@ -176,40 +167,28 @@

    Boolean

    Whether to export images to the version output directory during release. The options are as follows:

    -
    • true: Export images to the version output directory.

      -
    • false: Do not export images to the version output directory. (Default value)

      -
    +

    Whether to export images to the version output directory during release. The options are as follows: - true: Export images to the version output directory. - false: Do not export images to the version output directory. (Default value)

    extract_serial_number

    Boolean

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:

    -
    • true: Parse the subsample number.

      -
    • false: Do not parse the subsample number. (Default value)

      -
    +

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: - true: Parse the subsample number. - false: Do not parse the subsample number. (Default value)

    include_dataset_data

    Boolean

    Whether to include the source data of a dataset during release. The options are as follows:

    -
    • true: The source data of a dataset is included.

      -
    • false: The source data of a dataset is not included.

      -
    +

    Whether to include the source data of a dataset during release. The options are as follows: - true: The source data of a dataset is included. - false: The source data of a dataset is not included.

    is_current

    Boolean

    Whether the current dataset version is used. The options are as follows:

    -
    • true: The current dataset version is used.

      -
    • false: The current dataset version is not used.

      -
    +

    Whether the current dataset version is used. The options are as follows: - true: The current dataset version is used. - false: The current dataset version is not used.

    label_stats

    @@ -223,10 +202,7 @@

    String

    Label type of a released version. The options are as follows:

    -
    • multi: Multi-label samples are included.

      -
    • single: All samples are single-labeled.

      -
    +

    Label type of a released version. The options are as follows: - multi: Multi-label samples are included. - single: All samples are single-labeled.

    manifest_cache_input_path

    @@ -289,36 +265,21 @@

    Integer

    Status of a preprocessing task such as rotation and cropping. The options are as follows:

    -
    • 0: initialized

      -
    • 1: running

      -
    • 2: completed

      -
    • 3: failed

      -
    • 4: stopped

      -
    • 5: timeout

      -
    • 6: deletion failed

      -
    • 7: stop failed

      -
    +

    Status of a preprocessing task such as rotation and cropping. The options are as follows: - 0: initialized - 1: running - 2: completed - 3: failed - 4: stopped - 5: timeout - 6: deletion failed - 7: stop failed

    remove_sample_usage

    Boolean

    Whether to clear the existing usage information of a dataset during release. The options are as follows:

    -
    • true: Clear the existing usage information of a dataset. (Default value)

      -
    • false: Do not clear the existing usage information of a dataset.

      -
    +

    Whether to clear the existing usage information of a dataset during release. The options are as follows: - true: Clear the existing usage information of a dataset. (Default value) - false: Do not clear the existing usage information of a dataset.

    rotate

    Boolean

    Whether to rotate the image. The options are as follows:

    -
    • true: Rotate the image.

      -
    • false: Do not rotate the image. (Default value)

      -
    +

    Whether to rotate the image. The options are as follows: - true: Rotate the image. - false: Do not rotate the image. (Default value)

    rotate_path

    @@ -332,34 +293,14 @@

    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. 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

    status

    Integer

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

    -
    • 0: creating

      -
    • 1: running

      -
    • 2: deleting

      -
    • 3: deleted

      -
    • 4: error

      -
    +

    Status of a dataset version. The options are as follows: - 0: creating - 1: running - 2: deleting - 3: deleted - 4: error

    tags

    @@ -408,11 +349,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -433,10 +370,7 @@

    Boolean

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the released CSV file is a column name.

      -
    • false: The first row in the released CSV file is not a column name.

      -
    +

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the released CSV file is a column name. - false: The first row in the released CSV file is not a column name.

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -603,15 +523,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    diff --git a/docs/modelarts/api-ref/DescribeSample.html b/docs/modelarts/api-ref/DescribeSample.html index 15add5d9a..c53588bff 100644 --- a/docs/modelarts/api-ref/DescribeSample.html +++ b/docs/modelarts/api-ref/DescribeSample.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - - - - @@ -179,10 +159,7 @@ - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    sample_state

    @@ -74,21 +71,7 @@

    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. 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

    worker_id

    @@ -120,10 +103,7 @@

    Boolean

    Whether the acceptance is passed, which is used for team labeling. The options are as follows:

    -
    • true: The acceptance is passed.

      -
    • false: The acceptance is not passed.

      -
    +

    Whether the acceptance is passed, which is used for team labeling. The options are as follows: - true: The acceptance is passed. - false: The acceptance is not passed.

    check_comment

    @@ -149,7 +129,7 @@

    hard_details

    Map<String,Object>

    +

    Map<String,HardDetail>

    Details about difficulties, including description, causes, and suggestions of difficult problems.

    Boolean

    Whether to accept the review, which is used for team labeling. The options are as follows:

    -
    • true: accepted

      -
    • false: rejected

      -
    +

    Whether to accept the review, which is used for team labeling. The options are as follows: - true: accepted - false: rejected

    review_comment

    @@ -238,21 +215,7 @@

    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. 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_time

    @@ -266,14 +229,7 @@

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    score

    @@ -308,7 +264,7 @@
    -
    Table 4 HardDetail

    Parameter

    +
    @@ -381,24 +337,14 @@ - - - - @@ -513,10 +445,7 @@ - - - - - -
    Table 4 HardDetail

    Parameter

    Type

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    @@ -438,10 +384,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -476,18 +419,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -530,15 +459,18 @@

    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 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]]**.

    @modelarts:from

    @@ -569,54 +501,14 @@

    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. 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.

    @modelarts:shape

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -663,10 +555,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -680,39 +569,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    diff --git a/docs/modelarts/api-ref/DescribeWorkforceTaskSample.html b/docs/modelarts/api-ref/DescribeWorkforceTaskSample.html index 2094fc5cc..510eedef5 100644 --- a/docs/modelarts/api-ref/DescribeWorkforceTaskSample.html +++ b/docs/modelarts/api-ref/DescribeWorkforceTaskSample.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sample_id}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -55,7 +55,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -71,10 +71,7 @@ - - - - @@ -188,10 +168,7 @@ - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    sample_state

    @@ -83,21 +80,7 @@

    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. 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

    worker_id

    @@ -129,10 +112,7 @@

    Boolean

    Whether the acceptance is passed, which is used for team labeling. The options are as follows:

    -
    • true: The acceptance is passed.

      -
    • false: The acceptance is not passed.

      -
    +

    Whether the acceptance is passed, which is used for team labeling. The options are as follows: - true: The acceptance is passed. - false: The acceptance is not passed.

    check_comment

    @@ -158,7 +138,7 @@

    hard_details

    Map<String,Object>

    +

    Map<String,HardDetail>

    Details about difficulties, including description, causes, and suggestions of difficult problems.

    Boolean

    Whether to accept the review, which is used for team labeling. The options are as follows:

    -
    • true: accepted

      -
    • false: rejected

      -
    +

    Whether to accept the review, which is used for team labeling. The options are as follows: - true: accepted - false: rejected

    review_comment

    @@ -247,21 +224,7 @@

    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. 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_time

    @@ -275,14 +238,7 @@

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    score

    @@ -317,7 +273,7 @@
    -
    Table 4 HardDetail

    Parameter

    +
    @@ -390,24 +346,14 @@ - - - - @@ -522,10 +454,7 @@ - - - - - -
    Table 4 HardDetail

    Parameter

    Type

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    @@ -447,10 +393,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -485,18 +428,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -539,15 +468,18 @@

    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 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]]**.

    @modelarts:from

    @@ -578,54 +510,14 @@

    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. 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.

    @modelarts:shape

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -672,10 +564,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -689,39 +578,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    diff --git a/docs/modelarts/api-ref/ExportTask.html b/docs/modelarts/api-ref/ExportTask.html index b8355ae77..e8017e828 100644 --- a/docs/modelarts/api-ref/ExportTask.html +++ b/docs/modelarts/api-ref/ExportTask.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/export-tasks

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -54,10 +54,7 @@ - - - - - - - @@ -238,10 +194,7 @@ - - - - - - - @@ -583,10 +509,7 @@ - - @@ -638,10 +550,7 @@ - - - - - - - - - - - - @@ -1084,10 +946,7 @@ - - @@ -1131,10 +979,7 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    Labeling format. The options are as follows:

    -
    • VOC: VOC

      -
    • COCO: COCO

      -
    +

    Labeling format. The options are as follows: - VOC: VOC - COCO: COCO

    dataset_id

    @@ -75,19 +72,7 @@

    Integer

    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. 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

    export_format

    @@ -96,10 +81,7 @@

    Integer

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

    -
    • 1: tree structure. For example: cat/1.jpg,dog/2.jpg.

      -
    • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

      -
    +

    Format of the exported directory. The options are as follows: - 1: tree structure. For example: cat/1.jpg,dog/2.jpg. - 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

    export_params

    @@ -117,12 +99,7 @@

    Integer

    Export type. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    path

    @@ -140,21 +117,7 @@

    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. 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

    source_type_header

    @@ -190,11 +153,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -212,10 +171,7 @@

    Boolean

    Whether to write the column name in the first line of the CSV file during export. This field is valid for the table dataset. The options are as follows:

    -
    • true: Write the column name in the first line of the CSV file. (Default value)

      -
    • false: Do not write the column name in the first line of the CSV file.

      -
    +

    Whether to write the column name in the first line of the CSV file during export. This field is valid for the table dataset. The options are as follows: - true: Write the column name in the first line of the CSV file. (Default value) - false: Do not write the column name in the first line of the CSV file.

    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. The options are as follows: - true: Clear hard example attributes. (Default value) - false: Do not clear hard example attributes.

    export_dataset_version_format

    @@ -268,10 +221,7 @@

    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. The options are as follows: - DIR: Export data to OBS. (Default value) - NEW_DATASET: Export data to a new dataset.

    export_new_dataset_name

    @@ -298,10 +248,7 @@

    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. 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)

    sample_state

    @@ -310,21 +257,7 @@

    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. 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

    samples

    @@ -392,10 +325,7 @@

    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. The options are as follows: - 0: non-hard sample - 1: hard sample

    import_origin

    @@ -476,11 +406,10 @@

    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. 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.

    score

    @@ -548,10 +477,7 @@

    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. The options are as follows: - OR: OR operation - AND: AND operation

    String

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

    -
    • OR: OR operation

      -
    • AND: AND operation

      -
    +

    Operation type between multiple attributes. The options are as follows: - OR: OR operation - AND: AND operation

    property

    @@ -604,18 +527,7 @@

    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. 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

    String

    Relationship between attribute values. The options are as follows:

    -
    • AND: AND relationship

      -
    • OR: OR relationship

      -
    +

    Relationship between attribute values. The options are as follows: - AND: AND relationship - OR: OR relationship

    props

    @@ -692,10 +601,7 @@

    Integer

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

    -
    • 1: tree structure. For example: cat/1.jpg,dog/2.jpg.

      -
    • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

      -
    +

    Format of the exported directory. The options are as follows: - 1: tree structure. For example: cat/1.jpg,dog/2.jpg. - 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

    export_params

    @@ -709,12 +615,7 @@

    Integer

    Export type. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    finished_sample_count

    @@ -742,12 +643,7 @@

    String

    Task status. The options are as follows:

    -
    • INIT: initialized

      -
    • RUNNING: running

      -
    • FAILED: failed

      -
    • SUCCESSED: completed

      -
    +

    Task status. The options are as follows: - INIT: initialized - RUNNING: running - FAILED: failed - SUCCESSED: completed

    task_id

    @@ -775,11 +671,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -805,10 +697,7 @@

    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. The options are as follows: - true: Clear hard example attributes. (Default value) - false: Do not clear hard example attributes.

    export_dataset_version_format

    @@ -829,10 +718,7 @@

    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. The options are as follows: - DIR: Export data to OBS. (Default value) - NEW_DATASET: Export data to a new dataset.

    export_new_dataset_name

    @@ -853,31 +739,14 @@

    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. 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)

    sample_state

    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. 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

    samples

    @@ -931,10 +800,7 @@

    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. The options are as follows: - 0: non-hard sample - 1: hard sample

    import_origin

    @@ -997,11 +863,10 @@

    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. 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.

    score

    @@ -1055,10 +920,7 @@

    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. The options are as follows: - OR: OR operation - AND: AND operation

    String

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

    -
    • OR: OR operation

      -
    • AND: AND operation

      -
    +

    Operation type between multiple attributes. The options are as follows: - OR: OR operation - AND: AND operation

    property

    @@ -1101,18 +960,7 @@

    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. 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

    String

    Relationship between attribute values. The options are as follows:

    -
    • AND: AND relationship

      -
    • OR: OR relationship

      -
    +

    Relationship between attribute values. The options are as follows: - AND: AND relationship - OR: OR relationship

    props

    diff --git a/docs/modelarts/api-ref/GetDatasetMetrics.html b/docs/modelarts/api-ref/GetDatasetMetrics.html index 8d85fec1b..8099d127a 100644 --- a/docs/modelarts/api-ref/GetDatasetMetrics.html +++ b/docs/modelarts/api-ref/GetDatasetMetrics.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/metrics

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html b/docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html index 312288806..cc07abfec 100644 --- a/docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html +++ b/docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id}

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -83,10 +83,7 @@ - - - - - - - - - - @@ -470,10 +428,7 @@ - - @@ -517,10 +461,7 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

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

    -
    • 1: tree structure. For example: cat/1.jpg,dog/2.jpg.

      -
    • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

      -
    +

    Format of the exported directory. The options are as follows: - 1: tree structure. For example: cat/1.jpg,dog/2.jpg. - 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

    export_params

    @@ -100,12 +97,7 @@

    Integer

    Export type. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    finished_sample_count

    @@ -161,11 +153,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -191,10 +179,7 @@

    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. The options are as follows: - true: Clear hard example attributes. (Default value) - false: Do not clear hard example attributes.

    export_dataset_version_format

    @@ -215,10 +200,7 @@

    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. The options are as follows: - DIR: Export data to OBS. (Default value) - NEW_DATASET: Export data to a new dataset.

    export_new_dataset_name

    @@ -239,31 +221,14 @@

    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. 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)

    sample_state

    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. 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

    samples

    @@ -317,10 +282,7 @@

    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. The options are as follows: - 0: non-hard sample - 1: hard sample

    import_origin

    @@ -383,11 +345,10 @@

    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. 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.

    score

    @@ -441,10 +402,7 @@

    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. The options are as follows: - OR: OR operation - AND: AND operation

    String

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

    -
    • OR: OR operation

      -
    • AND: AND operation

      -
    +

    Operation type between multiple attributes. The options are as follows: - OR: OR operation - AND: AND operation

    property

    @@ -487,18 +442,7 @@

    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. 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

    String

    Relationship between attribute values. The options are as follows:

    -
    • AND: AND relationship

      -
    • OR: OR relationship

      -
    +

    Relationship between attribute values. The options are as follows: - AND: AND relationship - OR: OR relationship

    props

    diff --git a/docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html b/docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html index 51df51610..82dc852a1 100644 --- a/docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html +++ b/docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/export-tasks

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -53,12 +53,7 @@ - - - - - - - - - - - - - - @@ -650,10 +591,7 @@ - - @@ -697,10 +624,7 @@ -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Integer

    Export type. If this parameter is not specified, all types of export tasks are queried by default. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. If this parameter is not specified, all types of export tasks are queried by default. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    limit

    @@ -120,10 +115,7 @@

    Integer

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

    -
    • 1: tree structure. For example: cat/1.jpg,dog/2.jpg.

      -
    • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

      -
    +

    Format of the exported directory. The options are as follows: - 1: tree structure. For example: cat/1.jpg,dog/2.jpg. - 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

    export_params

    @@ -144,12 +136,7 @@

    Integer

    Export type. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    finished_sample_count

    @@ -212,11 +199,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -242,10 +225,7 @@

    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. The options are as follows: - true: Clear hard example attributes. (Default value) - false: Do not clear hard example attributes.

    export_dataset_version_format

    @@ -266,10 +246,7 @@

    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. The options are as follows: - DIR: Export data to OBS. (Default value) - NEW_DATASET: Export data to a new dataset.

    export_new_dataset_name

    @@ -290,31 +267,14 @@

    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. 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)

    sample_state

    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. 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

    samples

    @@ -375,10 +335,7 @@

    Integer

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

    -
    • 1: tree structure. For example: cat/1.jpg,dog/2.jpg.

      -
    • 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

      -
    +

    Format of the exported directory. The options are as follows: - 1: tree structure. For example: cat/1.jpg,dog/2.jpg. - 2: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt.

    export_params

    @@ -392,12 +349,7 @@

    Integer

    Export type. The options are as follows:

    -
    • 0: labeled

      -
    • 1: unlabeled

      -
    • 2: all

      -
    • 3: conditional search

      -
    +

    Export type. The options are as follows: - 0: labeled - 1: unlabeled - 2: all - 3: conditional search

    finished_sample_count

    @@ -453,11 +405,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -497,10 +445,7 @@

    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. The options are as follows: - 0: non-hard sample - 1: hard sample

    import_origin

    @@ -563,11 +508,10 @@

    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. 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.

    score

    @@ -621,10 +565,7 @@

    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. The options are as follows: - OR: OR operation - AND: AND operation

    String

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

    -
    • OR: OR operation

      -
    • AND: AND operation

      -
    +

    Operation type between multiple attributes. The options are as follows: - OR: OR operation - AND: AND operation

    property

    @@ -667,18 +605,7 @@

    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. 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

    String

    Relationship between attribute values. The options are as follows:

    -
    • AND: AND relationship

      -
    • OR: OR relationship

      -
    +

    Relationship between attribute values. The options are as follows: - AND: AND relationship - OR: OR relationship

    props

    diff --git a/docs/modelarts/api-ref/GetWorkforceSamplingTask.html b/docs/modelarts/api-ref/GetWorkforceSamplingTask.html index 9478ce1db..33e06f794 100644 --- a/docs/modelarts/api-ref/GetWorkforceSamplingTask.html +++ b/docs/modelarts/api-ref/GetWorkforceSamplingTask.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/report

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/GetWorkforceTaskMetrics.html b/docs/modelarts/api-ref/GetWorkforceTaskMetrics.html index de738263d..ba4ccf86a 100644 --- a/docs/modelarts/api-ref/GetWorkforceTaskMetrics.html +++ b/docs/modelarts/api-ref/GetWorkforceTaskMetrics.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/ImportTask.html b/docs/modelarts/api-ref/ImportTask.html index 09b416448..f17732328 100644 --- a/docs/modelarts/api-ref/ImportTask.html +++ b/docs/modelarts/api-ref/ImportTask.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/import-tasks

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -54,10 +54,7 @@ - - - - - - - - - @@ -234,15 +203,7 @@ - - @@ -336,10 +294,7 @@ - - @@ -549,10 +493,7 @@ - - - - - diff --git a/docs/modelarts/api-ref/ListAllWorkers.html b/docs/modelarts/api-ref/ListAllWorkers.html index a4f42dd2e..c7fb50eec 100644 --- a/docs/modelarts/api-ref/ListAllWorkers.html +++ b/docs/modelarts/api-ref/ListAllWorkers.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces/workers

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    Format of the labeling information. Currently, only object detection is supported. The options are as follows:

    -
    • VOC: VOC

      -
    • COCO: COCO

      -
    +

    Format of the labeling information. Currently, only object detection is supported. The options are as follows: - VOC: VOC - COCO: COCO

    data_source

    @@ -75,10 +72,7 @@

    Boolean

    Whether to import only hard examples. The options are as follows:

    -
    • true: Only difficult samples are imported.

      -
    • false: All samples are imported. (Default value)

      -
    +

    Whether to import only hard examples. The options are as follows: - true: Only difficult samples are imported. - false: All samples are imported. (Default value)

    excluded_labels

    @@ -96,10 +90,7 @@

    Boolean

    Whether to import data to the final state. The options are as follows:

    -
    • true: Import data to the final state. (Default value)

      -
    • false: Do not import data to the final state.

      -
    +

    Whether to import data to the final state. The options are as follows: - true: Import data to the final state. (Default value) - false: Do not import data to the final state.

    import_annotations

    @@ -108,10 +99,7 @@

    Boolean

    Whether to import labels. The options are as follows:

    -
    • true: Import labels. (Default value)

      -
    • false: Do not import labels.

      -
    +

    Whether to import labels. The options are as follows: - true: Import labels. (Default value) - false: Do not import labels.

    import_folder

    @@ -129,14 +117,7 @@

    String

    Data source. The options are as follows:

    -
    • obs: OBS bucket (default value)

      -
    • dws: GaussDB(DWS)

      -
    • dli: DLI

      -
    • rds: RDS

      -
    • mrs: MRS

      -
    • inference: Inference service

      -
    +

    Data source. The options are as follows: - obs: OBS bucket (default value) - dws: GaussDB(DWS) - dli: DLI - rds: RDS - mrs: MRS - inference: Inference service

    import_path

    @@ -145,10 +126,7 @@

    String

    OBS path or manifest path to be imported.

    -
    • When importing a manifest file, ensure that the path is accurate to the manifest file.

      -
    • When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

      -
    +

    OBS path or manifest path to be imported. - When importing a manifest file, ensure that the path is accurate to the manifest file.- When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

    import_samples

    @@ -157,10 +135,7 @@

    Boolean

    Whether to import samples. The options are as follows:

    -
    • true: Import samples. (Default value)

      -
    • false: Do not import samples.

      -
    +

    Whether to import samples. The options are as follows: - true: Import samples. (Default value) - false: Do not import samples.

    import_type

    @@ -169,10 +144,7 @@

    String

    Import mode. The options are as follows:

    -
    • 0: Import by directory.

      -
    • 1: Import by manifest file.

      -
    +

    Import mode. The options are as follows: - 0: Import by directory. - 1: Import by manifest file.

    included_labels

    @@ -199,10 +171,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name. (Default value)

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name. (Default value)

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    @@ -269,10 +230,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    @@ -488,18 +443,7 @@

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -625,15 +566,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -692,10 +625,7 @@

    String

    Label type of text classification. The options are as follows:

    -
    • 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt.

      -
    • 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

      -
    +

    Label type of text classification. The options are as follows: - 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt. - 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

    text_label_separator

    @@ -704,7 +634,7 @@

    String

    Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

    +

    Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

    text_sample_separator

    @@ -713,7 +643,7 @@

    String

    Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

    +

    Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - - - @@ -160,24 +150,14 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Sorting sequence of the query. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting sequence of the query. The options are as follows: - asc: ascending order - desc: descending order (default value)

    role

    @@ -74,11 +71,7 @@

    Integer

    Filtering query based on the member role. The options are as follows:

    -
    • 0: labeling personnel (default value)

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    +

    Filtering query based on the member role. The options are as follows: - 0: labeling personnel (default value) - 1: reviewer - 2: team administrator

    sort_by

    @@ -87,10 +80,7 @@

    String

    Sorting mode of the query. The options are as follows:

    -
    • create_time: Sort by creation time. (Default value)

      -
    • email: Sort by email.

      -
    +

    Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - email: Sort by email.

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    diff --git a/docs/modelarts/api-ref/ListDatasetVersions.html b/docs/modelarts/api-ref/ListDatasetVersions.html index ee8fa84a2..12eddf73a 100644 --- a/docs/modelarts/api-ref/ListDatasetVersions.html +++ b/docs/modelarts/api-ref/ListDatasetVersions.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/versions

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -53,13 +53,7 @@ - - @@ -151,10 +141,7 @@ - - - - - - - - - - - - - - - @@ -558,18 +482,7 @@ - @@ -609,10 +522,7 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Integer

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

    -
    • 0: creating

      -
    • 1: running

      -
    • 2: deleting

      -
    • 3: deleted

      -
    • 4: error

      -
    +

    Status of a dataset version. The options are as follows: - 0: creating - 1: running - 2: deleting - 3: deleted - 4: error

    train_evaluate_ratio

    @@ -77,11 +71,7 @@

    Integer

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

    -
    • 0: default format

      -
    • 1: CarbonData (supported only by table datasets)

      -
    • 2: CSV

      -
    +

    Format of a dataset version. The options are as follows: - 0: default format - 1: CarbonData (supported only by table datasets) - 2: CSV

    Boolean

    Whether to clear hard example properties during release. The options are as follows:

    -
    • true: Clear hard example properties. (Default value)

      -
    • false: Do not clear hard example properties.

      -
    +

    Whether to clear hard example properties during release. The options are as follows: - true: Clear hard example properties. (Default value) - false: Do not clear hard example properties.

    code

    @@ -175,10 +162,7 @@

    Boolean

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:

    -
    • true: Crop the image.

      -
    • false: Do not crop the image. (Default value)

      -
    +

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: - true: Crop the image. - false: Do not crop the image. (Default value)

    crop_path

    @@ -213,10 +197,7 @@

    Boolean

    Whether data is validated by the validation algorithm before release. The options are as follows:

    -
    • true: The data has been validated.

      -
    • false: The data has not been validated.

      -
    +

    Whether data is validated by the validation algorithm before release. The options are as follows: - true: The data has been validated. - false: The data has not been validated.

    deleted_sample_count

    @@ -244,40 +225,28 @@

    Boolean

    Whether to export images to the version output directory during release. The options are as follows:

    -
    • true: Export images to the version output directory.

      -
    • false: Do not export images to the version output directory. (Default value)

      -
    +

    Whether to export images to the version output directory during release. The options are as follows: - true: Export images to the version output directory. - false: Do not export images to the version output directory. (Default value)

    extract_serial_number

    Boolean

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:

    -
    • true: Parse the subsample number.

      -
    • false: Do not parse the subsample number. (Default value)

      -
    +

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: - true: Parse the subsample number. - false: Do not parse the subsample number. (Default value)

    include_dataset_data

    Boolean

    Whether to include the source data of a dataset during release. The options are as follows:

    -
    • true: The source data of a dataset is included.

      -
    • false: The source data of a dataset is not included.

      -
    +

    Whether to include the source data of a dataset during release. The options are as follows: - true: The source data of a dataset is included. - false: The source data of a dataset is not included.

    is_current

    Boolean

    Whether the current dataset version is used. The options are as follows:

    -
    • true: The current dataset version is used.

      -
    • false: The current dataset version is not used.

      -
    +

    Whether the current dataset version is used. The options are as follows: - true: The current dataset version is used. - false: The current dataset version is not used.

    label_stats

    @@ -291,10 +260,7 @@

    String

    Label type of a released version. The options are as follows:

    -
    • multi: Multi-label samples are included.

      -
    • single: All samples are single-labeled.

      -
    +

    Label type of a released version. The options are as follows: - multi: Multi-label samples are included. - single: All samples are single-labeled.

    manifest_cache_input_path

    @@ -357,36 +323,21 @@

    Integer

    Status of a preprocessing task such as rotation and cropping. The options are as follows:

    -
    • 0: initialized

      -
    • 1: running

      -
    • 2: completed

      -
    • 3: failed

      -
    • 4: stopped

      -
    • 5: timeout

      -
    • 6: deletion failed

      -
    • 7: stop failed

      -
    +

    Status of a preprocessing task such as rotation and cropping. The options are as follows: - 0: initialized - 1: running - 2: completed - 3: failed - 4: stopped - 5: timeout - 6: deletion failed - 7: stop failed

    remove_sample_usage

    Boolean

    Whether to clear the existing usage information of a dataset during release. The options are as follows:

    -
    • true: Clear the existing usage information of a dataset. (Default value)

      -
    • false: Do not clear the existing usage information of a dataset.

      -
    +

    Whether to clear the existing usage information of a dataset during release. The options are as follows: - true: Clear the existing usage information of a dataset. (Default value) - false: Do not clear the existing usage information of a dataset.

    rotate

    Boolean

    Whether to rotate the image. The options are as follows:

    -
    • true: Rotate the image.

      -
    • false: Do not rotate the image. (Default value)

      -
    +

    Whether to rotate the image. The options are as follows: - true: Rotate the image. - false: Do not rotate the image. (Default value)

    rotate_path

    @@ -400,34 +351,14 @@

    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. 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

    status

    Integer

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

    -
    • 0: creating

      -
    • 1: running

      -
    • 2: deleting

      -
    • 3: deleted

      -
    • 4: error

      -
    +

    Status of a dataset version. The options are as follows: - 0: creating - 1: running - 2: deleting - 3: deleted - 4: error

    tags

    @@ -476,11 +407,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -501,10 +428,7 @@

    Boolean

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the released CSV file is a column name.

      -
    • false: The first row in the released CSV file is not a column name.

      -
    +

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the released CSV file is a column name. - false: The first row in the released CSV file is not a column name.

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -671,15 +581,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    diff --git a/docs/modelarts/api-ref/ListDatasets.html b/docs/modelarts/api-ref/ListDatasets.html index 6c8723da6..fa6b684fa 100644 --- a/docs/modelarts/api-ref/ListDatasets.html +++ b/docs/modelarts/api-ref/ListDatasets.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -44,10 +44,7 @@ - - - - - - - - - - - - - - - - - - - @@ -776,10 +682,7 @@ - - @@ -933,15 +825,7 @@ - - - - - - - - - - - - - - - - @@ -1545,18 +1363,7 @@ - @@ -1596,10 +1403,7 @@ - - - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Boolean

    Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows:

    -
    • true: Detect tasks (including initialization tasks) that are running in the dataset.

      -
    • false: Do not detect tasks (including initialization tasks) that are running in the dataset. (Default value)

      -
    +

    Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows: - true: Detect tasks (including initialization tasks) that are running in the dataset. - false: Do not detect tasks (including initialization tasks) that are running in the dataset. (Default value)

    contain_versions

    @@ -65,19 +62,7 @@

    Integer

    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. 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

    file_preview

    @@ -86,10 +71,7 @@

    Boolean

    Whether a dataset supports preview when it is queried. The options are as follows:

    -
    • true: Preview is supported and the list of four dataset files is returned.

      -
    • false: Preview is not supported. (Default value)

      -
    +

    Whether a dataset supports preview when it is queried. The options are as follows: - true: Preview is supported and the list of four dataset files is returned. - false: Preview is not supported. (Default value)

    limit

    @@ -116,10 +98,7 @@

    String

    Sorting sequence of the query. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting sequence of the query. The options are as follows: - asc: ascending order - desc: descending order (default value)

    running_task_type

    @@ -128,17 +107,7 @@

    Integer

    Type of the running tasks (including initialization tasks) to be detected. The options are as follows:

    -
    • 0: auto labeling

      -
    • 1: pre-labeling

      -
    • 2: export

      -
    • 3: version switch

      -
    • 4: manifest file export

      -
    • 5: manifest file import

      -
    • 6: version publishing

      -
    • 7: auto grouping

      -
    • 10: one-click model deployment (default value)

      -
    +

    Type of the running tasks (including initialization tasks) to be detected. The options are as follows: - 0: auto labeling - 1: pre-labeling - 2: export - 3: version switch - 4: manifest file export - 5: manifest file import - 6: version publishing - 7: auto grouping - 10: one-click model deployment (default value)

    search_content

    @@ -156,10 +125,7 @@

    String

    Sorting mode of the query. The options are as follows:

    -
    • create_time: Sort by creation time. (Default value)

      -
    • dataset_name: Sort by dataset name.

      -
    +

    Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - dataset_name: Sort by dataset name.

    support_export

    @@ -168,10 +134,7 @@

    Boolean

    Whether to filter datasets that can be exported only (including datasets of image classification, object detection, and custom format). If this parameter is left blank or the value is set to false, no filtering is performed. The options are as follows:

    -
    • true: Filter datasets that can be exported only.

      -
    • false: Do not filter datasets that can be exported only. (Default value)

      -
    +

    Whether to filter datasets that can be exported only (including datasets of image classification, object detection, and custom format). If this parameter is left blank or the value is set to false, no filtering is performed. The options are as follows: - true: Filter datasets that can be exported only. - false: Do not filter datasets that can be exported only. (Default value)

    train_evaluate_ratio

    @@ -189,11 +152,7 @@

    Integer

    Dataset version format for dataset filtering. This parameter is used to filter datasets that meet the filter criteria. The options are as follows:

    -
    • 0: default format

      -
    • 1: CarbonData (supported only by table datasets)

      -
    • 2: CSV

      -
    +

    Dataset version format for dataset filtering. This parameter is used to filter datasets that meet the filter criteria. The options are as follows: - 0: default format - 1: CarbonData (supported only by table datasets) - 2: CSV

    with_labels

    @@ -202,10 +161,7 @@

    Boolean

    Whether to return dataset labels. The options are as follows:

    -
    • true: Return label information.

      -
    • false: Do not return label information. (Default value)

      -
    +

    Whether to return dataset labels. The options are as follows: - true: Return label information. - false: Do not return label information. (Default value)

    workspace_id

    @@ -347,10 +303,7 @@

    Integer

    Dataset format. The options are as follows:

    -
    • 0: file

      -
    • 1: table

      -
    +

    Dataset format. The options are as follows: - 0: file - 1: table

    dataset_id

    @@ -378,19 +331,7 @@

    Integer

    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. 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_version_count

    @@ -432,20 +373,14 @@

    Boolean

    Whether the dataset contains running (including initialization) tasks. The options are as follows:

    -
    • true: The dataset contains running tasks.

      -
    • false: The dataset does not contain running tasks.

      -
    +

    Whether the dataset contains running (including initialization) tasks. The options are as follows: - true: The dataset contains running tasks. - false: The dataset does not contain running tasks.

    exist_workforce_task

    Boolean

    Whether the dataset contains team labeling tasks. The options are as follows:

    -
    • true: The dataset contains team labeling tasks.

      -
    • false: The dataset does not contain team labeling tasks.

      -
    +

    Whether the dataset contains team labeling tasks. The options are as follows: - true: The dataset contains team labeling tasks. - false: The dataset does not contain team labeling tasks.

    feature_supports

    @@ -459,10 +394,7 @@

    Boolean

    Whether to import data. The options are as follows:

    -
    • true: Import data.

      -
    • false: Do not import data.

      -
    +

    Whether to import data. The options are as follows: - true: Import data. - false: Do not import data.

    import_task_id

    @@ -539,10 +471,7 @@

    Boolean

    Whether a dataset is hosted. The options are as follows:

    -
    • true: The dataset is hosted.

      -
    • false: The dataset is not hosted.

      -
    +

    Whether a dataset is hosted. The options are as follows: - true: The dataset is hosted. - false: The dataset is not hosted.

    next_version_num

    @@ -577,17 +506,7 @@

    Integer

    Dataset status. The options are as follows:

    -
    • 0: creating dataset

      -
    • 1: normal dataset

      -
    • 2: deleting dataset

      -
    • 3: deleted dataset

      -
    • 4: abnormal dataset

      -
    • 5: synchronizing dataset

      -
    • 6: releasing dataset

      -
    • 7: dataset in version switching

      -
    • 8: importing dataset

      -
    +

    Dataset status. The options are as follows: - 0: creating dataset - 1: normal dataset - 2: deleting dataset - 3: deleted dataset - 4: abnormal dataset - 5: synchronizing dataset - 6: releasing dataset - 7: dataset in version switching - 8: importing dataset

    third_path

    @@ -643,9 +562,7 @@

    Integer

    Type of the dataset output path. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    +

    Type of the dataset output path. The options are as follows: - 0: OBS bucket (default value)

    workforce_descriptor

    @@ -692,15 +609,7 @@

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    @@ -721,10 +630,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    @@ -896,18 +799,7 @@

    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. 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

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -1138,10 +1022,7 @@

    Boolean

    Whether to clear hard example properties during release. The options are as follows:

    -
    • true: Clear hard example properties. (Default value)

      -
    • false: Do not clear hard example properties.

      -
    +

    Whether to clear hard example properties during release. The options are as follows: - true: Clear hard example properties. (Default value) - false: Do not clear hard example properties.

    code

    @@ -1162,10 +1043,7 @@

    Boolean

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows:

    -
    • true: Crop the image.

      -
    • false: Do not crop the image. (Default value)

      -
    +

    Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: - true: Crop the image. - false: Do not crop the image. (Default value)

    crop_path

    @@ -1200,10 +1078,7 @@

    Boolean

    Whether data is validated by the validation algorithm before release. The options are as follows:

    -
    • true: The data has been validated.

      -
    • false: The data has not been validated.

      -
    +

    Whether data is validated by the validation algorithm before release. The options are as follows: - true: The data has been validated. - false: The data has not been validated.

    deleted_sample_count

    @@ -1231,40 +1106,28 @@

    Boolean

    Whether to export images to the version output directory during release. The options are as follows:

    -
    • true: Export images to the version output directory.

      -
    • false: Do not export images to the version output directory. (Default value)

      -
    +

    Whether to export images to the version output directory during release. The options are as follows: - true: Export images to the version output directory. - false: Do not export images to the version output directory. (Default value)

    extract_serial_number

    Boolean

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows:

    -
    • true: Parse the subsample number.

      -
    • false: Do not parse the subsample number. (Default value)

      -
    +

    Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: - true: Parse the subsample number. - false: Do not parse the subsample number. (Default value)

    include_dataset_data

    Boolean

    Whether to include the source data of a dataset during release. The options are as follows:

    -
    • true: The source data of a dataset is included.

      -
    • false: The source data of a dataset is not included.

      -
    +

    Whether to include the source data of a dataset during release. The options are as follows: - true: The source data of a dataset is included. - false: The source data of a dataset is not included.

    is_current

    Boolean

    Whether the current dataset version is used. The options are as follows:

    -
    • true: The current dataset version is used.

      -
    • false: The current dataset version is not used.

      -
    +

    Whether the current dataset version is used. The options are as follows: - true: The current dataset version is used. - false: The current dataset version is not used.

    label_stats

    @@ -1278,10 +1141,7 @@

    String

    Label type of a released version. The options are as follows:

    -
    • multi: Multi-label samples are included.

      -
    • single: All samples are single-labeled.

      -
    +

    Label type of a released version. The options are as follows: - multi: Multi-label samples are included. - single: All samples are single-labeled.

    manifest_cache_input_path

    @@ -1344,36 +1204,21 @@

    Integer

    Status of a preprocessing task such as rotation and cropping. The options are as follows:

    -
    • 0: initialized

      -
    • 1: running

      -
    • 2: completed

      -
    • 3: failed

      -
    • 4: stopped

      -
    • 5: timeout

      -
    • 6: deletion failed

      -
    • 7: stop failed

      -
    +

    Status of a preprocessing task such as rotation and cropping. The options are as follows: - 0: initialized - 1: running - 2: completed - 3: failed - 4: stopped - 5: timeout - 6: deletion failed - 7: stop failed

    remove_sample_usage

    Boolean

    Whether to clear the existing usage information of a dataset during release. The options are as follows:

    -
    • true: Clear the existing usage information of a dataset. (Default value)

      -
    • false: Do not clear the existing usage information of a dataset.

      -
    +

    Whether to clear the existing usage information of a dataset during release. The options are as follows: - true: Clear the existing usage information of a dataset. (Default value) - false: Do not clear the existing usage information of a dataset.

    rotate

    Boolean

    Whether to rotate the image. The options are as follows:

    -
    • true: Rotate the image.

      -
    • false: Do not rotate the image. (Default value)

      -
    +

    Whether to rotate the image. The options are as follows: - true: Rotate the image. - false: Do not rotate the image. (Default value)

    rotate_path

    @@ -1387,34 +1232,14 @@

    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. 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

    status

    Integer

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

    -
    • 0: creating

      -
    • 1: running

      -
    • 2: deleting

      -
    • 3: deleted

      -
    • 4: error

      -
    +

    Status of a dataset version. The options are as follows: - 0: creating - 1: running - 2: deleting - 3: deleted - 4: error

    tags

    @@ -1463,11 +1288,7 @@

    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. The options are as follows: - Default: default format - CarbonData: CarbonData (supported only by table datasets) - CSV: CSV

    version_id

    @@ -1488,10 +1309,7 @@

    Boolean

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the released CSV file is a column name.

      -
    • false: The first row in the released CSV file is not a column name.

      -
    +

    Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the released CSV file is a column name. - false: The first row in the released CSV file is not a column name.

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -1679,20 +1483,14 @@

    Boolean

    Whether to synchronously update auto labeling data. The options are as follows:

    -
    • true: Update auto labeling data synchronously.

      -
    • false: Do not update auto labeling data synchronously.

      -
    +

    Whether to synchronously update auto labeling data. The options are as follows: - true: Update auto labeling data synchronously. - false: Do not update auto labeling data synchronously.

    is_synchronize_data

    Boolean

    Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows:

    -
    • true: Synchronize updated data to team members.

      -
    • false: Do not synchronize updated data to team members.

      -
    +

    Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: - true: Synchronize updated data to team members. - false: Do not synchronize updated data to team members.

    workers

    @@ -1753,24 +1551,14 @@

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    diff --git a/docs/modelarts/api-ref/ListImportTasks.html b/docs/modelarts/api-ref/ListImportTasks.html index 5c139b30d..89007d23c 100644 --- a/docs/modelarts/api-ref/ListImportTasks.html +++ b/docs/modelarts/api-ref/ListImportTasks.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/import-tasks

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -181,20 +181,14 @@ - - - - - @@ -395,10 +371,7 @@ -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    OBS path or manifest path to be imported.

    -
    • When importing a manifest file, ensure that the path is accurate to the manifest file.

      -
    • When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

      -
    +

    OBS path or manifest path to be imported. - When importing a manifest file, ensure that the path is accurate to the manifest file.- When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification.

    import_type

    Integer

    Import mode. The options are as follows:

    -
    • 0: Import by directory.

      -
    • 1: Import by manifest file.

      -
    +

    Import mode. The options are as follows: - 0: Import by directory. - 1: Import by manifest file.

    imported_sample_count

    @@ -229,14 +223,7 @@

    String

    Status of an import task. The options are as follows:

    -
    • QUEUING: queuing

      -
    • STARTING: execution started

      -
    • RUNNING: running

      -
    • COMPLETED: completed

      -
    • FAILED: failed

      -
    • NOT_EXIST: not found

      -
    +

    Status of an import task. The options are as follows: - QUEUING: queuing - STARTING: execution started - RUNNING: running - COMPLETED: completed - FAILED: failed - NOT_EXIST: not found

    task_id

    @@ -311,15 +298,7 @@

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    @@ -340,10 +319,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    diff --git a/docs/modelarts/api-ref/ListLabels.html b/docs/modelarts/api-ref/ListLabels.html index d9cc17834..a86b60bf0 100644 --- a/docs/modelarts/api-ref/ListLabels.html +++ b/docs/modelarts/api-ref/ListLabels.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -116,18 +116,7 @@ - @@ -167,10 +156,7 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -229,15 +215,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    diff --git a/docs/modelarts/api-ref/ListSamples.html b/docs/modelarts/api-ref/ListSamples.html index cb727b75d..cdb92cf77 100644 --- a/docs/modelarts/api-ref/ListSamples.html +++ b/docs/modelarts/api-ref/ListSamples.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -80,19 +80,7 @@ - - - - - - - - @@ -329,10 +284,7 @@ - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Integer

    Labeling 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

      -
    +

    Labeling 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

    limit

    @@ -110,10 +98,7 @@

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    low_score

    @@ -140,10 +125,7 @@

    String

    Sorting sequence of the query. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting sequence of the query. The options are as follows: - asc: ascending order - desc: descending order (default value)

    preview

    @@ -152,10 +134,7 @@

    Boolean

    Whether to support preview. The options are as follows:

    -
    • true: Preview is supported.

      -
    • false: Preview is not supported.

      -
    +

    Whether to support preview. The options are as follows: - true: Preview is supported. - false: Preview is not supported.

    process_parameter

    @@ -173,21 +152,7 @@

    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. 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_type

    @@ -196,14 +161,7 @@

    Integer

    Sample file type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: audio

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format (default value)

      -
    +

    Sample file type. The options are as follows: - 0: image - 1: text - 2: audio - 4: table - 6: video - 9: custom format (default value)

    search_conditions

    @@ -270,10 +228,7 @@

    Boolean

    Whether the acceptance is passed, which is used for team labeling. The options are as follows:

    -
    • true: The acceptance is passed.

      -
    • false: The acceptance is not passed.

      -
    +

    Whether the acceptance is passed, which is used for team labeling. The options are as follows: - true: The acceptance is passed. - false: The acceptance is not passed.

    check_comment

    @@ -299,7 +254,7 @@

    hard_details

    Map<String,Object>

    +

    Map<String,HardDetail>

    Details about difficulties, including description, causes, and suggestions of difficult problems.

    Boolean

    Whether to accept the review, which is used for team labeling. The options are as follows:

    -
    • true: accepted

      -
    • false: rejected

      -
    +

    Whether to accept the review, which is used for team labeling. The options are as follows: - true: accepted - false: rejected

    review_comment

    @@ -388,21 +340,7 @@

    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. 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_time

    @@ -416,14 +354,7 @@

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    score

    @@ -458,7 +389,7 @@
    -
    Table 5 HardDetail

    Parameter

    +
    @@ -531,24 +462,14 @@ - - - - @@ -663,10 +570,7 @@ - - - - - -
    Table 5 HardDetail

    Parameter

    Type

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    @@ -588,10 +509,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -626,18 +544,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -680,15 +584,18 @@

    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 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]]**.

    @modelarts:from

    @@ -719,54 +626,14 @@

    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. 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.

    @modelarts:shape

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -813,10 +680,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -830,39 +694,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    diff --git a/docs/modelarts/api-ref/ListSearch.html b/docs/modelarts/api-ref/ListSearch.html index bcf595781..dc39711f5 100644 --- a/docs/modelarts/api-ref/ListSearch.html +++ b/docs/modelarts/api-ref/ListSearch.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-condition

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -107,18 +107,7 @@ - @@ -158,10 +147,7 @@ - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -220,15 +206,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    diff --git a/docs/modelarts/api-ref/ListStats.html b/docs/modelarts/api-ref/ListStats.html index c8b16558d..ceab0aa7d 100644 --- a/docs/modelarts/api-ref/ListStats.html +++ b/docs/modelarts/api-ref/ListStats.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - - @@ -118,22 +101,19 @@ - - - @@ -217,18 +197,7 @@ - @@ -254,15 +223,7 @@ -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Language. The options are as follows:

    -
    • zh-cn: Chinese

      -
    • en-us: English (default value)

      -
    +

    Language. The options are as follows: - zh-cn: Chinese - en-us: English (default value)

    sample_state

    @@ -74,21 +71,7 @@

    String

    Query statistics on samples in a specified state. 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

      -
    +

    Query statistics on samples in a specified state. 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

    Boolean

    Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows:

    -
    • true: The dataset can be split into training set and validation set.

      -
    • false: The dataset cannot be split into training set and validation set.

      -
    +

    Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows: - true: The dataset can be split into training set and validation set. - false: The dataset cannot be split into training set and validation set.

    grouped_label_stats

    Map<String,Array<Object>>

    +

    Map<String,Array<LabelStats>>

    Label statistics grouped by labeling type.

    hard_detail_stats

    Map<String,Object>

    +

    Map<String,PairOfintAndHardDetail>

    Statistics on hard example reasons. The type is Map<Integer, Pair<Integer, HardDetail>>. The key of Map indicates the ID of the hard example reason, the key of Pair indicates the number of times that the hard example reason occurs, and the value of Pair indicates the hard example reason.

    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. 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

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -297,7 +258,7 @@
    -
    Table 6 PairOfintAndHardDetail

    Parameter

    +
    @@ -396,10 +357,7 @@ -
    Table 6 PairOfintAndHardDetail

    Parameter

    Type

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    diff --git a/docs/modelarts/api-ref/ListWorkerTasks.html b/docs/modelarts/api-ref/ListWorkerTasks.html index 15383b6c7..a49b0571c 100644 --- a/docs/modelarts/api-ref/ListWorkerTasks.html +++ b/docs/modelarts/api-ref/ListWorkerTasks.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces/worker-tasks

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - - @@ -163,12 +157,7 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Sorting method. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting method. The options are as follows: - asc: ascending order - desc: descending order (default value)

    search_content

    @@ -83,10 +80,7 @@

    String

    Sorting mode of the query. The options are as follows:

    -
    • create_time: Sort by creation time. (Default value)

      -
    • workforce_task_name: Sort by task name.

      -
    +

    Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - workforce_task_name: Sort by task name.

    Integer

    Email notification status of a labeling team member's labeling task. The options are as follows:

    -
    • 0: The email has not been sent.

      -
    • 1: The email format is incorrect.

      -
    • 2: The email address is unreachable.

      -
    • 3: The email has been sent.

      -
    +

    Email notification status of a labeling team member's labeling task. The options are as follows: - 0: The email has not been sent. - 1: The email format is incorrect. - 2: The email address is unreachable. - 3: The email has been sent.

    last_notify_time

    @@ -217,14 +206,7 @@

    Integer

    Task status of a labeling team member. The options are as follows:

    -
    • 6: created

      -
    • 0: starting

      -
    • 1: running

      -
    • 2: under acceptance

      -
    • 3: approved, indicating the team labeling task is complete

      -
    • 4: rejected, indicating that the task needs to be labeled and reviewed again

      -
    +

    Task status of a labeling team member. The options are as follows: - 6: created - 0: starting - 1: running - 2: under acceptance - 3: approved, indicating the team labeling task is complete - 4: rejected, indicating that the task needs to be labeled and reviewed again

    update_time

    diff --git a/docs/modelarts/api-ref/ListWorkers.html b/docs/modelarts/api-ref/ListWorkers.html index ccdb5e2da..41e3a6d66 100644 --- a/docs/modelarts/api-ref/ListWorkers.html +++ b/docs/modelarts/api-ref/ListWorkers.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces/{workforce_id}/workers

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -37,7 +37,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -71,10 +71,7 @@ - - @@ -156,24 +150,14 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Sorting sequence. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting sequence. The options are as follows: - asc: ascending order - desc: descending order (default value)

    sort_by

    @@ -83,10 +80,7 @@

    String

    Sorting mode of the query. The options are as follows:

    -
    • create_time: Sort by creation time. (Default value)

      -
    • email: Sort by email.

      -
    +

    Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - email: Sort by email.

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    diff --git a/docs/modelarts/api-ref/ListWorkforceTaskSamples.html b/docs/modelarts/api-ref/ListWorkforceTaskSamples.html index 55eb98940..8743a2144 100644 --- a/docs/modelarts/api-ref/ListWorkforceTaskSamples.html +++ b/docs/modelarts/api-ref/ListWorkforceTaskSamples.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -71,19 +71,7 @@ - - - - - @@ -262,10 +230,7 @@ - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    Integer

    Labeling 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

      -
    +

    Labeling 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

    limit

    @@ -101,10 +89,7 @@

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    offset

    @@ -131,21 +116,7 @@

    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. 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

    search_conditions

    @@ -203,10 +174,7 @@

    Boolean

    Whether the acceptance is passed, which is used for team labeling. The options are as follows:

    -
    • true: The acceptance is passed.

      -
    • false: The acceptance is not passed.

      -
    +

    Whether the acceptance is passed, which is used for team labeling. The options are as follows: - true: The acceptance is passed. - false: The acceptance is not passed.

    check_comment

    @@ -232,7 +200,7 @@

    hard_details

    Map<String,Object>

    +

    Map<String,HardDetail>

    Details about difficulties, including description, causes, and suggestions of difficult problems.

    Boolean

    Whether to accept the review, which is used for team labeling. The options are as follows:

    -
    • true: accepted

      -
    • false: rejected

      -
    +

    Whether to accept the review, which is used for team labeling. The options are as follows: - true: accepted - false: rejected

    review_comment

    @@ -321,21 +286,7 @@

    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. 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_time

    @@ -349,14 +300,7 @@

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    score

    @@ -391,7 +335,7 @@
    -
    Table 5 HardDetail

    Parameter

    +
    @@ -464,24 +408,14 @@ - - - - @@ -596,10 +516,7 @@ - - - - - -
    Table 5 HardDetail

    Parameter

    Type

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    @@ -521,10 +455,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -559,18 +490,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -613,15 +530,18 @@

    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 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]]**.

    @modelarts:from

    @@ -652,54 +572,14 @@

    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. 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.

    @modelarts:shape

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -746,10 +626,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -763,39 +640,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    diff --git a/docs/modelarts/api-ref/ListWorkforceTaskStats.html b/docs/modelarts/api-ref/ListWorkforceTaskStats.html index 3d12a3778..6724e1f62 100644 --- a/docs/modelarts/api-ref/ListWorkforceTaskStats.html +++ b/docs/modelarts/api-ref/ListWorkforceTaskStats.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/stats

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,21 +62,7 @@ - @@ -106,22 +92,19 @@ - - - @@ -205,18 +188,7 @@ - @@ -242,15 +214,7 @@ -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Statistics on the specified sample state. 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

      -
    +

    Statistics on the specified sample state. 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

    Boolean

    Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows:

    -
    • true: The dataset can be split into training set and validation set.

      -
    • false: The dataset cannot be split into training set and validation set.

      -
    +

    Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows: - true: The dataset can be split into training set and validation set. - false: The dataset cannot be split into training set and validation set.

    grouped_label_stats

    Map<String,Array<Object>>

    +

    Map<String,Array<LabelStats>>

    Label statistics grouped by labeling type.

    hard_detail_stats

    Map<String,Object>

    +

    Map<String,PairOfintAndHardDetail>

    Statistics on hard example reasons. The type is Map<Integer, Pair<Integer, HardDetail>>. The key of Map indicates the ID of the hard example reason, the key of Pair indicates the number of times that the hard example reason occurs, and the value of Pair indicates the hard example reason.

    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. 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

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -285,7 +249,7 @@
    -
    Table 6 PairOfintAndHardDetail

    Parameter

    +
    @@ -384,10 +348,7 @@ -
    Table 6 PairOfintAndHardDetail

    Parameter

    Type

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    diff --git a/docs/modelarts/api-ref/ListWorkforceTasks.html b/docs/modelarts/api-ref/ListWorkforceTasks.html index fe719568b..a40090bb1 100644 --- a/docs/modelarts/api-ref/ListWorkforceTasks.html +++ b/docs/modelarts/api-ref/ListWorkforceTasks.html @@ -1,1097 +1,1015 @@

    Querying the Team Labeling Task List of a Dataset

    -

    Function

    This API is used to query the team labeling task list of a dataset.

    +

    Function

    This API is used to query the team labeling task list of a dataset.

    -

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks

    +

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks

    -
    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 the project ID, see Obtaining a Project 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

    count

    +

    count

    Integer

    +

    Integer

    Total number of team labeling tasks.

    +

    Total number of team labeling tasks.

    tasks

    +

    tasks

    Array of WorkforceTask objects

    +

    Array of WorkforceTask objects

    Team labeling task list queried by page.

    +

    Team labeling task list queried by page.

    -
    Table 3 WorkforceTask

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 WorkforceTask

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    auto_sync_dataset

    +

    auto_sync_dataset

    Boolean

    +

    Boolean

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows:

    -
    • true: Automatically synchronize the result of a team labeling task to the dataset.

      -
    • false: Do not automatically synchronize the result of a team labeling task to the dataset.

      -
    +

    Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: - true: Automatically synchronize the result of a team labeling task to the dataset. - false: Do not automatically synchronize the result of a team labeling task to the dataset.

    check_rate

    +

    check_rate

    Double

    +

    Double

    Acceptance ratio of a team labeling task.

    +

    Acceptance ratio of a team labeling task.

    checking_task_desc

    +

    checking_task_desc

    WorkforceSamplingTaskDesc object

    +

    WorkforceSamplingTaskDesc object

    Details about the current acceptance task of a team labeling task.

    +

    Details about the current acceptance task of a team labeling task.

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a labeling task is created.

    +

    Time when a labeling task is created.

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID.

    +

    Dataset ID.

    description

    +

    description

    String

    +

    String

    Description of a labeling task.

    +

    Description of a labeling task.

    label_stats

    +

    label_stats

    Array of LabelStats objects

    +

    Array of LabelStats objects

    Label statistics of a labeling task.

    +

    Label statistics of a labeling task.

    pass_rate

    +

    pass_rate

    Double

    +

    Double

    Acceptance pass rate of a team labeling task.

    +

    Acceptance pass rate of a team labeling task.

    repetition

    +

    repetition

    Integer

    +

    Integer

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    +

    Number of persons who label each sample in a team labeling task. The minimum value is 1.

    sample_search_conditions

    +

    sample_search_conditions

    Array of SearchCondition objects

    +

    Array of SearchCondition objects

    Sample search criteria when creating a task.

    +

    Sample search criteria when creating a task.

    sample_stats

    +

    sample_stats

    SampleStats object

    +

    SampleStats object

    Sample statistics of a labeling task.

    +

    Sample statistics of a labeling task.

    score

    +

    score

    Double

    +

    Double

    Average acceptance score of a team labeling task.

    +

    Average acceptance score of a team labeling task.

    status

    +

    status

    Integer

    +

    Integer

    Status of a team labeling task. The options are as follows:

    -
    • 6: created. The owner has created a task but does not start it. Only the owner and manager can view the task list.

      -
    • 0: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started.

      -
    • 1: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again.

      -
    • 2: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed.

      -
    • 3: passed. The team labeling task has been completed.

      -
    • 4: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing.

      -
    • 5: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized.

      -
    • 7: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress.

      -
    +

    Status of a team labeling task. The options are as follows: - 6: created. The owner has created a task but does not start it. Only the owner and manager can view the task list. - 0: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started. - 1: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again. - 2: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed. - 3: passed. The team labeling task has been completed. - 4: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing. - 5: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized. - 7: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress.

    synchronize_auto_labeling_data

    +

    synchronize_auto_labeling_data

    Boolean

    +

    Boolean

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows:

    -
    • true: Synchronize the results to be confirmed to team members after auto labeling is complete.

      -
    • false: Do not synchronize the auto labeling results. (Default value)

      -
    +

    Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: - true: Synchronize the results to be confirmed to team members after auto labeling is complete. - false: Do not synchronize the auto labeling results. (Default value)

    synchronize_data

    +

    synchronize_data

    Boolean

    +

    Boolean

    Whether to synchronize the added data of a team labeling task. The options are as follows:

    -
    • true: Synchronize uploaded files, data sources, and imported unlabeled files to team members.

      -
    • false: Do not synchronize the added data. (Default value)

      -
    +

    Whether to synchronize the added data of a team labeling task. The options are as follows: - true: Synchronize uploaded files, data sources, and imported unlabeled files to team members. - false: Do not synchronize the added data. (Default value)

    task_id

    +

    task_id

    String

    +

    String

    ID of a labeling task.

    +

    ID of a labeling task.

    task_name

    +

    task_name

    String

    +

    String

    Name of a labeling task.

    +

    Name of a labeling task.

    update_time

    +

    update_time

    Long

    +

    Long

    Time when a labeling task is updated.

    +

    Time when a labeling task is updated.

    version_id

    +

    version_id

    String

    +

    String

    Version ID of the dataset associated with a labeling task.

    +

    Version ID of the dataset associated with a labeling task.

    workforce_stats

    +

    workforce_stats

    WorkforceStats object

    +

    WorkforceStats object

    Statistics on team labeling task members.

    +

    Statistics on team labeling task members.

    workforces_config

    +

    workforces_config

    WorkforcesConfig object

    +

    WorkforcesConfig object

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    +

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    -
    Table 4 WorkforceSamplingTaskDesc

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 4 WorkforceSamplingTaskDesc

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    action

    +

    action

    Integer

    +

    Integer

    Action after the acceptance. The options are as follows:

    -
    • 0: Pass all samples when the acceptance is completed (including single-rejected samples)

      -
    • 1: Reject all samples when the acceptance is completed (including single-accepted samples)

      -
    • 4: Pass only single-accepted samples and unaccepted samples.

      -
    • 5: Reject only single-rejected samples and unaccepted samples.

      -
    +

    Action after the acceptance. The options are as follows: - 0: Pass all samples when the acceptance is completed (including single-rejected samples) - 1: Reject all samples when the acceptance is completed (including single-accepted samples) - 4: Pass only single-accepted samples and unaccepted samples. - 5: Reject only single-rejected samples and unaccepted samples.

    checking_stats

    +

    checking_stats

    CheckTaskStats object

    +

    CheckTaskStats object

    Real-time report of acceptance tasks.

    +

    Real-time report of acceptance tasks.

    checking_task_id

    +

    checking_task_id

    String

    +

    String

    ID of the current acceptance task.

    +

    ID of the current acceptance task.

    overwrite_last_result

    +

    overwrite_last_result

    Boolean

    +

    Boolean

    Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows:

    -
    • true: Overwrite the labeled result.

      -
    • false: Do not overwrite the labeled result. (Default value)

      -
    +

    Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows: - true: Overwrite the labeled result. - false: Do not overwrite the labeled result. (Default value)

    total_stats

    +

    total_stats

    CheckTaskStats object

    +

    CheckTaskStats object

    Overall report of historical acceptance tasks.

    +

    Overall report of historical acceptance tasks.

    -
    Table 5 CheckTaskStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 CheckTaskStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    accepted_sample_count

    +

    accepted_sample_count

    Integer

    +

    Integer

    Accepted samples.

    +

    Accepted samples.

    checked_sample_count

    +

    checked_sample_count

    Integer

    +

    Integer

    Checked samples.

    +

    Checked samples.

    pass_rate

    +

    pass_rate

    Double

    +

    Double

    Pass rate of samples.

    +

    Pass rate of samples.

    rejected_sample_count

    +

    rejected_sample_count

    Integer

    +

    Integer

    Rejected samples.

    +

    Rejected samples.

    sampled_sample_count

    +

    sampled_sample_count

    Integer

    +

    Integer

    Number of sampled samples.

    +

    Number of sampled samples.

    sampling_num

    +

    sampling_num

    Integer

    +

    Integer

    Samples of an acceptance task.

    +

    Samples of an acceptance task.

    sampling_rate

    +

    sampling_rate

    Double

    +

    Double

    Sampling rate of an acceptance task.

    +

    Sampling rate of an acceptance task.

    score

    +

    score

    String

    +

    String

    Acceptance score.

    +

    Acceptance score.

    task_id

    +

    task_id

    String

    +

    String

    ID of an acceptance task.

    +

    ID of an acceptance task.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total samples.

    +

    Total samples.

    total_score

    +

    total_score

    Long

    +

    Long

    Total acceptance score.

    +

    Total acceptance score.

    unchecked_sample_count

    +

    unchecked_sample_count

    Integer

    +

    Integer

    Unchecked samples.

    +

    Unchecked samples.

    -
    Table 6 LabelStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 6 LabelStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    attributes

    +

    attributes

    Array of LabelAttribute objects

    +

    Array of LabelAttribute objects

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    +

    Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included.

    count

    +

    count

    Integer

    +

    Integer

    Number of labels.

    +

    Number of labels.

    name

    +

    name

    String

    +

    String

    Label name.

    +

    Label name.

    property

    +

    property

    LabelProperty object

    +

    LabelProperty object

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    +

    Basic attribute key-value pair of a label, such as color and shortcut keys.

    sample_count

    +

    sample_count

    Integer

    +

    Integer

    Number of samples containing the label.

    +

    Number of samples containing the label.

    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. 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

    -
    Table 7 LabelAttribute

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 7 LabelAttribute

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    default_value

    +

    default_value

    String

    +

    String

    Default value of a label attribute.

    +

    Default value of a label attribute.

    id

    +

    id

    String

    +

    String

    Label attribute ID.

    +

    Label attribute ID.

    name

    +

    name

    String

    +

    String

    Label attribute name.

    +

    Label attribute name.

    type

    +

    type

    String

    +

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    +

    values

    Array of LabelAttributeValue objects

    +

    Array of LabelAttributeValue objects

    List of label attribute values.

    +

    List of label attribute values.

    -
    Table 8 LabelAttributeValue

    Parameter

    +
    - - - - - - - -
    Table 8 LabelAttributeValue

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Label attribute value ID.

    +

    Label attribute value ID.

    value

    +

    value

    String

    +

    String

    Label attribute value.

    +

    Label attribute value.

    -
    Table 9 LabelProperty

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 9 LabelProperty

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    @modelarts:color

    +

    @modelarts:color

    String

    +

    String

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    +

    Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0.

    @modelarts:default_shape

    +

    @modelarts:default_shape

    String

    +

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    +

    @modelarts:from_type

    String

    +

    String

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    @modelarts:rename_to

    +

    @modelarts:rename_to

    String

    +

    String

    Default attribute: The new name of the label.

    +

    Default attribute: The new name of the label.

    @modelarts:shortcut

    +

    @modelarts:shortcut

    String

    +

    String

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    +

    Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.

    @modelarts:to_type

    +

    @modelarts:to_type

    String

    +

    String

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    +

    Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset.

    -
    Table 10 SearchCondition

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 10 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. The options are as follows: - 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. 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.

    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 11 SearchLabels

    Parameter

    +
    - - - - - - - -
    Table 11 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. The options are as follows: - OR: OR operation - AND: AND operation

    -
    Table 12 SearchLabel

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 12 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. The options are as follows: - 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. 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

    -
    Table 13 SearchProp

    Parameter

    +
    - - - - - - - -
    Table 13 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. The options are as follows: - 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 14 SampleStats

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 14 SampleStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    accepted_sample_count

    +

    accepted_sample_count

    Integer

    +

    Integer

    Number of samples accepted by the owner.

    +

    Number of samples accepted by the owner.

    auto_annotation_sample_count

    +

    auto_annotation_sample_count

    Integer

    +

    Integer

    Number of samples to be confirmed after intelligent labeling.

    +

    Number of samples to be confirmed after intelligent labeling.

    deleted_sample_count

    +

    deleted_sample_count

    Integer

    +

    Integer

    Number of deleted samples.

    +

    Number of deleted samples.

    rejected_sample_count

    +

    rejected_sample_count

    Integer

    +

    Integer

    Number of samples that failed to pass the owner acceptance.

    +

    Number of samples that failed to pass the owner acceptance.

    sampled_sample_count

    +

    sampled_sample_count

    Integer

    +

    Integer

    Number of samples that are to be accepted by the owner and sampled.

    +

    Number of samples that are to be accepted by the owner and sampled.

    total_sample_count

    +

    total_sample_count

    Integer

    +

    Integer

    Total number of samples.

    +

    Total number of samples.

    unannotated_sample_count

    +

    unannotated_sample_count

    Integer

    +

    Integer

    Number of unlabeled samples.

    +

    Number of unlabeled samples.

    uncheck_sample_count

    +

    uncheck_sample_count

    Integer

    +

    Integer

    Number of samples that have been approved by the reviewer and are to be accepted by the owner.

    +

    Number of samples that have been approved by the reviewer and are to be accepted by the owner.

    unreviewed_sample_count

    +

    unreviewed_sample_count

    Integer

    +

    Integer

    Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer.

    +

    Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer.

    -
    Table 15 WorkforceStats

    Parameter

    +
    - - - - - - - - - - -
    Table 15 WorkforceStats

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    labeler_count

    +

    labeler_count

    Integer

    +

    Integer

    Number of labeling persons.

    +

    Number of labeling persons.

    reviewer_count

    +

    reviewer_count

    Integer

    +

    Integer

    Number of reviewers.

    +

    Number of reviewers.

    workforce_count

    +

    workforce_count

    Integer

    +

    Integer

    Number of teams.

    +

    Number of teams.

    -
    Table 16 WorkforcesConfig

    Parameter

    +
    - - - - - - - -
    Table 16 WorkforcesConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    String

    +

    String

    Administrator.

    +

    Team administrator.

    workforces

    +

    workforces

    Array of WorkforceConfig objects

    +

    Array of WorkforceConfig objects

    List of teams that execute labeling tasks.

    +

    List of teams that execute labeling tasks.

    -
    Table 17 WorkforceConfig

    Parameter

    +
    - - - - - - - - - - -
    Table 17 WorkforceConfig

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    workers

    +

    workers

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    String

    +

    String

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    +

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    -
    Table 18 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 18 Worker

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Example Requests

    Querying the Team Labeling Task List of a Dataset

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

    Example Requests

    Querying the Team Labeling Task List of a Dataset

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

    Example Responses

    Status code: 200

    -

    OK

    -
    {
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    {
       "count" : 2,
       "tasks" : [ {
         "dataset_id" : "WxCREuCkBSAlQr9xrde",
    @@ -1199,38 +1117,38 @@
       } ]
     }
    -

    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/ListWorkforces.html b/docs/modelarts/api-ref/ListWorkforces.html index a824c0a73..ce50fc42d 100644 --- a/docs/modelarts/api-ref/ListWorkforces.html +++ b/docs/modelarts/api-ref/ListWorkforces.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/workforces

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Sorting sequence of the query. The options are as follows:

    -
    • asc: ascending order

      -
    • desc: descending order (default value)

      -
    +

    Sorting sequence of the query. The options are as follows: - asc: ascending order - desc: descending order (default value)

    search_content

    @@ -83,10 +80,7 @@

    String

    Sorting mode of the query. The options are as follows:

    -
    • create_time: Sort by creation time. (Default value)

      -
    • workforce_name: Sort by labeling team name.

      -
    +

    Sorting mode of the query. The options are as follows: - create_time: Sort by creation time. (Default value) - workforce_name: Sort by labeling team name.

    workforce_task_id

    diff --git a/docs/modelarts/api-ref/ReviewSamples.html b/docs/modelarts/api-ref/ReviewSamples.html index 8aa308803..c0ffd5537 100644 --- a/docs/modelarts/api-ref/ReviewSamples.html +++ b/docs/modelarts/api-ref/ReviewSamples.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/review

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -86,10 +86,7 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

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

    -
    • true: passed

      -
    • false: not passed

      -
    +

    Whether the submitted sample review comments are passed. The options are as follows: - true: passed - false: not passed

    comment

    diff --git a/docs/modelarts/api-ref/SendEmails.html b/docs/modelarts/api-ref/SendEmails.html index bde049879..b4bbfc4a0 100644 --- a/docs/modelarts/api-ref/SendEmails.html +++ b/docs/modelarts/api-ref/SendEmails.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/notify

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -105,10 +105,7 @@ - @@ -141,10 +138,7 @@ - diff --git a/docs/modelarts/api-ref/StartWorkforceSamplingTask.html b/docs/modelarts/api-ref/StartWorkforceSamplingTask.html index 1096cf5b7..2f8b81ed2 100644 --- a/docs/modelarts/api-ref/StartWorkforceSamplingTask.html +++ b/docs/modelarts/api-ref/StartWorkforceSamplingTask.html @@ -5,7 +5,7 @@

    URI

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

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/StartWorkforceTask.html b/docs/modelarts/api-ref/StartWorkforceTask.html index dd5494926..70d3aa9b8 100644 --- a/docs/modelarts/api-ref/StartWorkforceTask.html +++ b/docs/modelarts/api-ref/StartWorkforceTask.html @@ -1,266 +1,256 @@

    Starting a Team Labeling Task

    -

    Function

    This API is used to start a team labeling task.

    +

    Function

    This API is used to start a team labeling task.

    -

    URI

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

    +

    URI

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

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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 the project ID, see Obtaining a Project ID.

    workforce_task_id

    +

    workforce_task_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dataset_id

    +

    dataset_id

    No

    +

    No

    String

    +

    String

    Dataset ID.

    +

    Dataset ID.

    task_id

    +

    task_id

    No

    +

    No

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    workforces_config

    +

    workforces_config

    No

    +

    No

    WorkforcesConfig object

    +

    WorkforcesConfig object

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    +

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    -
    Table 3 WorkforcesConfig

    Parameter

    +
    - - - - - - - - - - -
    Table 3 WorkforcesConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    No

    +

    No

    String

    +

    String

    Administrator.

    +

    Team administrator.

    workforces

    +

    workforces

    No

    +

    No

    Array of WorkforceConfig objects

    +

    Array of WorkforceConfig objects

    List of teams that execute labeling tasks.

    +

    List of teams that execute labeling tasks.

    -
    Table 4 WorkforceConfig

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 4 WorkforceConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    workers

    +

    workers

    No

    +

    No

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    No

    +

    No

    String

    +

    String

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    +

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    -
    Table 5 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Worker

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    No

    +

    No

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    No

    +

    No

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    No

    +

    No

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    No

    +

    No

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    No

    +

    No

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    Starting a Team Labeling Task

    -
    {
    +

    Example Requests

    Starting a Team Labeling Task

    +
    {
       "workforces_config" : {
         "workforces" : [ {
           "workforce_id" : "l4u9Hpz2JJ67DNN1Hg9",
    @@ -273,42 +263,42 @@
       }
     }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    { }
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    { }
    -

    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/SyncDataSource.html b/docs/modelarts/api-ref/SyncDataSource.html index 0bbb14dfb..7ae87b7e9 100644 --- a/docs/modelarts/api-ref/SyncDataSource.html +++ b/docs/modelarts/api-ref/SyncDataSource.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/sync-data

    -
    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/SyncDataSourceState.html b/docs/modelarts/api-ref/SyncDataSourceState.html index d49a0b676..2aba16dae 100644 --- a/docs/modelarts/api-ref/SyncDataSourceState.html +++ b/docs/modelarts/api-ref/SyncDataSourceState.html @@ -5,7 +5,7 @@

    URI

    GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -102,14 +102,7 @@ -
    Table 1 Path Parameters

    Parameter

    Mandatory

    String

    Status of a task. The options are as follows:

    -
    • QUEUING: queuing

      -
    • STARTING: execution started

      -
    • RUNNING: running

      -
    • COMPLETED: completed

      -
    • FAILED: failed

      -
    • NOT_EXIST: not found

      -
    +

    Status of a task. The options are as follows: - QUEUING: queuing - STARTING: execution started - RUNNING: running - COMPLETED: completed - FAILED: failed - NOT_EXIST: not found

    task_id

    diff --git a/docs/modelarts/api-ref/UpdateDataset.html b/docs/modelarts/api-ref/UpdateDataset.html index 5ce955dcd..f03ab38e1 100644 --- a/docs/modelarts/api-ref/UpdateDataset.html +++ b/docs/modelarts/api-ref/UpdateDataset.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -149,18 +149,7 @@ - @@ -210,10 +199,7 @@ - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -286,15 +272,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    diff --git a/docs/modelarts/api-ref/UpdateLabel.html b/docs/modelarts/api-ref/UpdateLabel.html index 52885bfb0..a1cf9dda0 100644 --- a/docs/modelarts/api-ref/UpdateLabel.html +++ b/docs/modelarts/api-ref/UpdateLabel.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,18 +62,7 @@ - @@ -106,15 +95,7 @@ - - diff --git a/docs/modelarts/api-ref/UpdateLabels.html b/docs/modelarts/api-ref/UpdateLabels.html index 8998bbe7a..b86da404d 100644 --- a/docs/modelarts/api-ref/UpdateLabels.html +++ b/docs/modelarts/api-ref/UpdateLabels.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    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. 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

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -185,10 +166,7 @@

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    Table 1 Path parameters

    Parameter

    +
    @@ -104,18 +104,7 @@ - @@ -165,10 +154,7 @@ - - - @@ -363,10 +338,7 @@ - diff --git a/docs/modelarts/api-ref/UpdateSamples.html b/docs/modelarts/api-ref/UpdateSamples.html index 4fe924ecf..4a549135c 100644 --- a/docs/modelarts/api-ref/UpdateSamples.html +++ b/docs/modelarts/api-ref/UpdateSamples.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    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. 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

    String

    Label attribute type. The options are as follows:

    -
    • text: text

      -
    • select: single-choice drop-down list

      -
    +

    Label attribute type. The options are as follows: - text: text - select: single-choice drop-down list

    values

    @@ -241,15 +227,7 @@

    String

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows:

    -
    • bndbox: rectangle

      -
    • polygon: polygon

      -
    • circle: circle

      -
    • line: straight line

      -
    • dashed: dotted line

      -
    • point: point

      -
    • polyline: polyline

      -
    +

    Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:from_type

    @@ -327,10 +305,7 @@

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -113,14 +113,7 @@ - - - - @@ -266,10 +240,7 @@ - - - - - - - @@ -582,10 +478,7 @@ - diff --git a/docs/modelarts/api-ref/UpdateWorker.html b/docs/modelarts/api-ref/UpdateWorker.html index 93ab80822..57322283b 100644 --- a/docs/modelarts/api-ref/UpdateWorker.html +++ b/docs/modelarts/api-ref/UpdateWorker.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    sample_usage

    @@ -129,12 +122,7 @@

    String

    Sample usage. The options are as follows:

    -
    • TRAIN: training

      -
    • EVAL: evaluation

      -
    • TEST: test

      -
    • INFERENCE: inference

      -
    +

    Sample usage. The options are as follows: - TRAIN: training - EVAL: evaluation - TEST: test - INFERENCE: inference

    source

    @@ -175,10 +163,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -223,18 +208,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -287,15 +258,18 @@

    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 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]]**.

    @modelarts:from

    @@ -334,39 +308,7 @@

    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. 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.

    @modelarts:shape

    @@ -375,15 +317,7 @@

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -442,10 +376,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -463,39 +394,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    @@ -546,10 +445,7 @@

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -72,12 +72,7 @@ - diff --git a/docs/modelarts/api-ref/UpdateWorkforce.html b/docs/modelarts/api-ref/UpdateWorkforce.html index cbe8dea21..3c239fc6e 100644 --- a/docs/modelarts/api-ref/UpdateWorkforce.html +++ b/docs/modelarts/api-ref/UpdateWorkforce.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/workforces/{workforce_id}

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    Table 1 Path parameters

    Parameter

    +
    diff --git a/docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html b/docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html index c28e62b11..6b4ee6d71 100644 --- a/docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html +++ b/docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/status

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Table 1 Path parameters

    Parameter

    +
    @@ -46,7 +46,7 @@
    Table 1 Path Parameters

    Parameter

    Mandatory

    -
    Table 2 Query parameters

    Parameter

    +
    @@ -62,10 +62,7 @@ - @@ -89,14 +86,7 @@ - - - @@ -167,10 +151,7 @@ - - @@ -226,10 +207,7 @@ - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    Integer

    Acceptance action. The options are as follows:

    -
    • 0: Pass all samples.

      -
    • 1: Reject all samples.

      -
    • 2: Cancel acceptance.

      -
    • 3: View the list of conflicted samples.

      -
    • 4: Pass single-accepted samples and unaccepted samples.

      -
    • 5: Pass only single-accepted samples.

      -
    +

    Acceptance action. The options are as follows: - 0: Pass all samples. - 1: Reject all samples. - 2: Cancel acceptance. - 3: View the list of conflicted samples. - 4: Pass single-accepted samples and unaccepted samples. - 5: Pass only single-accepted samples.

    locale

    @@ -105,10 +95,7 @@

    String

    Language. The options are as follows:

    -
    • en-us: English (default value)

      -
    • zh-cn: Chinese

      -
    +

    Language. The options are as follows: - en-us: English (default value) - zh-cn: Chinese

    overwrite_last_result

    @@ -117,10 +104,7 @@

    Boolean

    Whether to overwrite labeled data. The options are as follows:

    -
    • true: Overwrite labeled data.

      -
    • false: Do not overwrite labeled data. (Default value)

      -
    +

    Whether to overwrite labeled data. The options are as follows: - true: Overwrite labeled data. - false: Do not overwrite labeled data. (Default value)

    Boolean

    Whether the acceptance is passed, which is used for team labeling. The options are as follows:

    -
    • true: The acceptance is passed.

      -
    • false: The acceptance is not passed.

      -
    +

    Whether the acceptance is passed, which is used for team labeling. The options are as follows: - true: The acceptance is passed. - false: The acceptance is not passed.

    check_comment

    @@ -196,7 +177,7 @@

    hard_details

    Map<String,Object>

    +

    Map<String,HardDetail>

    Details about difficulties, including description, causes, and suggestions of difficult problems.

    Boolean

    Whether to accept the review, which is used for team labeling. The options are as follows:

    -
    • true: accepted

      -
    • false: rejected

      -
    +

    Whether to accept the review, which is used for team labeling. The options are as follows: - true: accepted - false: rejected

    review_comment

    @@ -285,21 +263,7 @@

    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. 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_time

    @@ -313,14 +277,7 @@

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    score

    @@ -355,7 +312,7 @@
    -
    Table 6 HardDetail

    Parameter

    +
    @@ -428,24 +385,14 @@ - - - - @@ -560,10 +493,7 @@ - - - - - -
    Table 6 HardDetail

    Parameter

    Type

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    @@ -485,10 +432,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -523,18 +467,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -577,15 +507,18 @@

    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 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]]**.

    @modelarts:from

    @@ -616,54 +549,14 @@

    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. 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.

    @modelarts:shape

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -710,10 +603,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -727,39 +617,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    diff --git a/docs/modelarts/api-ref/UpdateWorkforceTask.html b/docs/modelarts/api-ref/UpdateWorkforceTask.html index 93b0f3819..a65b2ce15 100644 --- a/docs/modelarts/api-ref/UpdateWorkforceTask.html +++ b/docs/modelarts/api-ref/UpdateWorkforceTask.html @@ -1,284 +1,274 @@

    Updating a Team Labeling Task

    -

    Function

    This API is used to update a team labeling task.

    +

    Function

    This API is used to update a team labeling task.

    -

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

    +

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}

    -
    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 the project ID, see Obtaining a Project ID.

    workforce_task_id

    +

    workforce_task_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    dataset_id

    +

    dataset_id

    No

    +

    No

    String

    +

    String

    Dataset ID.

    +

    Dataset ID.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Team labeling task description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Team labeling task description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    task_id

    +

    task_id

    No

    +

    No

    String

    +

    String

    ID of a team labeling task.

    +

    ID of a team labeling task.

    task_name

    +

    task_name

    No

    +

    No

    String

    +

    String

    Team labeling task name. The value contains 1 to 64 characters and only letters, digits, underscores (_), and hyphens (-) are allowed.

    +

    Team labeling task name. The value contains 1 to 64 characters and only letters, digits, underscores (_), and hyphens (-) are allowed.

    workforces_config

    +

    workforces_config

    No

    +

    No

    WorkforcesConfig object

    +

    WorkforcesConfig object

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    +

    Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

    -
    Table 3 WorkforcesConfig

    Parameter

    +
    - - - - - - - - - - -
    Table 3 WorkforcesConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    No

    +

    No

    String

    +

    String

    Administrator.

    +

    Team administrator.

    workforces

    +

    workforces

    No

    +

    No

    Array of WorkforceConfig objects

    +

    Array of WorkforceConfig objects

    List of teams that execute labeling tasks.

    +

    List of teams that execute labeling tasks.

    -
    Table 4 WorkforceConfig

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 4 WorkforceConfig

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    workers

    +

    workers

    No

    +

    No

    Array of Worker objects

    +

    Array of Worker objects

    List of labeling team members.

    +

    List of labeling team members.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    workforce_name

    +

    workforce_name

    No

    +

    No

    String

    +

    String

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    +

    Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

    -
    Table 5 Worker

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Worker

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    No

    +

    No

    Long

    +

    Long

    Creation time.

    +

    Creation time.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    +

    Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

    email

    +

    email

    No

    +

    No

    String

    +

    String

    Email address of a labeling team member.

    +

    Email address of a labeling team member.

    role

    +

    role

    No

    +

    No

    Integer

    +

    Integer

    Role. The options are as follows:

    -
    • 0: labeling personnel

      -
    • 1: reviewer

      -
    • 2: team administrator

      -
    • 3: dataset owner

      -
    +

    Role. The options are as follows: - 0: labeling personnel - 1: reviewer - 2: team administrator - 3: dataset owner

    status

    +

    status

    No

    +

    No

    Integer

    +

    Integer

    Current login status of a labeling team member. The options are as follows:

    -
    • 0: The invitation email has not been sent.

      -
    • 1: The invitation email has been sent but the user has not logged in.

      -
    • 2: The user has logged in.

      -
    • 3: The labeling team member has been deleted.

      -
    +

    Current login status of a labeling team member. The options are as follows: - 0: The invitation email has not been sent. - 1: The invitation email has been sent but the user has not logged in. - 2: The user has logged in. - 3: The labeling team member has been deleted.

    update_time

    +

    update_time

    No

    +

    No

    Long

    +

    Long

    Update time.

    +

    Update time.

    worker_id

    +

    worker_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team member.

    +

    ID of a labeling team member.

    workforce_id

    +

    workforce_id

    No

    +

    No

    String

    +

    String

    ID of a labeling team.

    +

    ID of a labeling team.

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    Updating a Team Labeling Task

    -
    {
    +

    Example Requests

    Updating a Team Labeling Task

    +
    {
       "workforces_config" : {
         "workforces" : [ {
           "workforce_id" : "3frbQ90hb8ZKksAhyR8",
    @@ -291,42 +281,42 @@
       }
     }
    -

    Example Responses

    Status code: 200

    -

    OK

    -
    { }
    +

    Example Responses

    Status code: 200

    +

    OK

    +
    { }
    -

    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/UpdateWorkforceTaskSamples.html b/docs/modelarts/api-ref/UpdateWorkforceTaskSamples.html index 495537bcf..12617421b 100644 --- a/docs/modelarts/api-ref/UpdateWorkforceTaskSamples.html +++ b/docs/modelarts/api-ref/UpdateWorkforceTaskSamples.html @@ -5,7 +5,7 @@

    URI

    PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -122,14 +122,7 @@ - - - - @@ -275,10 +249,7 @@ - - - - - - - @@ -591,10 +487,7 @@ - diff --git a/docs/modelarts/api-ref/UploadSamplesJson.html b/docs/modelarts/api-ref/UploadSamplesJson.html index 5d6e41099..f23a1ff03 100644 --- a/docs/modelarts/api-ref/UploadSamplesJson.html +++ b/docs/modelarts/api-ref/UploadSamplesJson.html @@ -5,7 +5,7 @@

    URI

    POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    sample_usage

    @@ -138,12 +131,7 @@

    String

    Sample usage. The options are as follows:

    -
    • TRAIN: training

      -
    • EVAL: evaluation

      -
    • TEST: test

      -
    • INFERENCE: inference

      -
    +

    Sample usage. The options are as follows: - TRAIN: training - EVAL: evaluation - TEST: test - INFERENCE: inference

    source

    @@ -184,10 +172,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -232,18 +217,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -296,15 +267,18 @@

    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 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]]**.

    @modelarts:from

    @@ -343,39 +317,7 @@

    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. 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.

    @modelarts:shape

    @@ -384,15 +326,7 @@

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -451,10 +385,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -472,39 +403,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    @@ -555,10 +454,7 @@

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    Boolean

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

    -
    • true: The operation is successful.

      -
    • false: The operation is failed.

      -
    +

    Check whether the operation is successful. The options are as follows: - true: The operation is successful. - false: The operation is failed.

    Table 1 Path parameters

    Parameter

    +
    @@ -54,10 +54,7 @@ - - - - @@ -196,14 +190,7 @@ - @@ -235,15 +222,7 @@ - - @@ -337,10 +313,7 @@ - - - @@ -553,10 +512,7 @@ - - - - - - - @@ -883,10 +764,7 @@ - diff --git a/docs/modelarts/api-ref/en-us_image_0000001209615814.png b/docs/modelarts/api-ref/en-us_image_0000001209615814.png new file mode 100644 index 000000000..371f8e2ef Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001209615814.png differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001209615816.gif b/docs/modelarts/api-ref/en-us_image_0000001209615816.gif new file mode 100644 index 000000000..d5d6a5eb2 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001209615816.gif differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001209775802.gif b/docs/modelarts/api-ref/en-us_image_0000001209775802.gif new file mode 100644 index 000000000..ad0cefd80 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001209775802.gif differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001254215795.gif b/docs/modelarts/api-ref/en-us_image_0000001254215795.gif new file mode 100644 index 000000000..942e14512 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001254215795.gif differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001254415793.gif b/docs/modelarts/api-ref/en-us_image_0000001254415793.gif new file mode 100644 index 000000000..1f8bc2f59 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001254415793.gif differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001254535751.png b/docs/modelarts/api-ref/en-us_image_0000001254535751.png new file mode 100644 index 000000000..d4a37a976 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001254535751.png differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001254535753.gif b/docs/modelarts/api-ref/en-us_image_0000001254535753.gif new file mode 100644 index 000000000..b3e803442 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001254535753.gif differ diff --git a/docs/modelarts/api-ref/en-us_image_0000001298629861.png b/docs/modelarts/api-ref/en-us_image_0000001298629861.png new file mode 100644 index 000000000..44ec9e361 Binary files /dev/null and b/docs/modelarts/api-ref/en-us_image_0000001298629861.png differ diff --git a/docs/modelarts/api-ref/modelarts_03_0001.html b/docs/modelarts/api-ref/modelarts_03_0001.html index daaf71b03..fbe0e47c8 100644 --- a/docs/modelarts/api-ref/modelarts_03_0001.html +++ b/docs/modelarts/api-ref/modelarts_03_0001.html @@ -1,7 +1,8 @@

    Overview

    -

    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 models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs. For details about all ModelArts APIs, see API Overview.

    +

    +

    Before calling a ModelArts API, ensure that you have fully understood the concepts related to ModelArts. For details, see the Service Overview.

    Table 1 Path Parameters

    Parameter

    Mandatory

    Boolean

    Whether to directly import to the final result. The options are as follows:

    -
    • true: Import labels to the labeled dataset. (Default value).

      -
    • false: Import labels to the to-be-confirmed dataset. Currently, to-be-confirmed datasets only support categories of image classification and object detection.

      -
    +

    Whether to directly import to the final result. The options are as follows: - true: Import labels to the labeled dataset. (Default value). - false: Import labels to the to-be-confirmed dataset. Currently, to-be-confirmed datasets only support categories of image classification and object detection.

    label_format

    @@ -98,10 +95,7 @@

    String

    Label type of text classification. The options are as follows:

    -
    • 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt.

      -
    • 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

      -
    +

    Label type of text classification. The options are as follows: - 0: The label is separated from the text, and they are distinguished by the fixed suffix _result. For example, the text file is abc.txt, and the label file is abc_result.txt. - 1: Default value. Labels and texts are stored in the same file and separated by separators. You can use text_sample_separator to specify the separator between the text and label and text_label_separator to specify the separator between labels.

    text_label_separator

    @@ -110,7 +104,7 @@

    String

    Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

    +

    Separator between labels. By default, a comma (,) is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

    text_sample_separator

    @@ -119,7 +113,7 @@

    String

    Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,).

    +

    Separator between the text and label. By default, the Tab key is used as the separator. The separator needs to be escaped. The separator can contain only one character, such as a letter, a digit, or any of the following special characters: !@#$%^&*_=|?/':.;,

    Integer

    Sample type. The options are as follows:

    -
    • 0: image

      -
    • 1: text

      -
    • 2: speech

      -
    • 4: table

      -
    • 6: video

      -
    • 9: custom format

      -
    +

    Sample type. The options are as follows: - 0: image - 1: text - 2: speech - 4: table - 6: video - 9: custom format

    Integer

    Data type. The options are as follows:

    -
    • 0: OBS bucket (default value)

      -
    • 1: GaussDB(DWS)

      -
    • 2: DLI

      -
    • 3: RDS

      -
    • 4: MRS

      -
    • 5: AI Gallery

      -
    • 6: Inference service

      -
    +

    Data type. The options are as follows: - 0: OBS bucket (default value) - 1: GaussDB(DWS) - 2: DLI - 3: RDS - 4: MRS - 5: AI Gallery - 6: Inference service

    schema_maps

    @@ -270,10 +249,7 @@

    Boolean

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows:

    -
    • true: The first row in the file is the column name.

      -
    • false: The first row in the file is not the column name.

      -
    +

    Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: - true: The first row in the file is the column name. - false: The first row in the file is not the column name.

    String

    Running mode of an MRS cluster. The options are as follows:

    -
    • 0: normal cluster

      -
    • 1: security cluster

      -
    +

    Running mode of an MRS cluster. The options are as follows: - 0: normal cluster - 1: security cluster

    cluster_name

    @@ -462,10 +435,7 @@

    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. The options are as follows: - human: manual labeling - auto: automatic labeling

    id

    @@ -510,18 +480,7 @@

    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. 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

    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. 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.

    @modelarts:end_time

    @@ -574,15 +530,18 @@

    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 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]]**.

    @modelarts:from

    @@ -621,39 +580,7 @@

    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. 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.

    @modelarts:shape

    @@ -662,15 +589,7 @@

    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. The options are as follows: - bndbox: rectangle - polygon: polygon - circle: circle - line: straight line - dashed: dotted line - point: point - polyline: polyline

    @modelarts:source

    @@ -729,10 +648,7 @@

    Double

    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

      -
    +

    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

    @modelarts:hard_coefficient

    @@ -750,39 +666,7 @@

    Array of integers

    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.

      -
    +

    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.

    @modelarts:size

    @@ -833,10 +717,7 @@

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    Boolean

    Whether the operation is successful. The options are as follows:

    -
    • true: successful

      -
    • false: failed

      -
    +

    Whether the operation is successful. The options are as follows: - true: successful - false: failed

    - @@ -47,7 +47,7 @@ - - - -
    Table 1 Development environment APIs

    API

    +

    DevEnviron APIs

    +
    - - - - - - @@ -57,145 +57,145 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -211,22 +211,22 @@ - - - - @@ -242,51 +242,56 @@ - - - - - - - - - + + +
    Table 1 DevEnviron APIs

    API

    Description

    Creating a Development Environment Instance

    +

    Creating a Development Environment Instance

    Create a development environment instance for code development.

    Querying a List of Development Environment Instances

    +

    Querying a List of Development Environment Instances

    Query the development environment instances that meet the search criteria.

    Querying the Details About a Development Environment Instance

    +

    Querying Details About a Development Environment Instance

    Query the details about a development environment instance.

    Modifying the Description of a Development Environment Instance

    +

    Modifying the Description of a Development Environment Instance

    Modify the description of a development environment instance.

    Deleting a Development Environment Instance

    +

    Deleting a Development Environment Instance

    Delete a development environment instance.

    Managing a Development Environment Instance

    +

    Managing a Development Environment Instance

    Start or stop a development environment instance.

    Training Jobs

    Creating a Training Job

    +

    Creating a Training Job

    Create a training job.

    Querying a Training Job List

    +

    Querying a Training Job List

    Query the created training jobs that meet the search criteria.

    Querying the Details About a Training Job Version

    +

    Querying the Details About a Training Job Version

    Query the details about a specified training job based on the job ID.

    Deleting a Version of a Training Job

    +

    Deleting a Version of a Training Job

    Delete a version of a training job.

    Querying a List of Training Job Versions

    +

    Querying a List of Training Job Versions

    Query the version of a specified training job based on the job ID.

    Creating a Version of a Training Job

    +

    Creating a Version of a Training Job

    Create a version of a training job.

    Stopping a Training Job

    +

    Stopping a Training Job

    Stop a training job.

    Modifying the Description of a Training Job

    +

    Modifying the Description of a Training Job

    Modify the description of a training job.

    Deleting a Training Job

    +

    Deleting a Training Job

    Delete a training job.

    Obtaining the Name of a Training Job Log File

    +

    Obtaining the Name of a Training Job Log File

    Obtain the name of a training job log file.

    Querying a Built-in Algorithm

    +

    Querying a Built-in Algorithm

    Query the details about a built-in model.

    Querying Training Job Logs

    +

    Querying Training Job Logs

    Query detailed information about training job logs by row.

    Training Job Parameter Configuration

    Creating a Training Job Configuration

    +

    Creating a Training Job Configuration

    Create a training job configuration.

    Querying a List of Training Job Configurations

    +

    Querying a List of Training Job Configurations

    Query the created training job configurations that meet the search criteria.

    Modifying a Training Job Configuration

    +

    Modifying a Training Job Configuration

    Modify a training job configuration.

    Deleting a Training Job Configuration

    +

    Deleting a Training Job Configuration

    Delete a training job configuration.

    Querying the Details About a Training Job Configuration

    +

    Querying the Details About a Training Job Configuration

    Query the details about a specified training job configuration.

    Visualization Job Management

    Creating a Visualization Job

    +

    Creating a Visualization Job

    Create a visualization job.

    Querying a Visualization Job List

    +

    Querying a Visualization Job List

    Query the visualization jobs that meet the search criteria.

    Querying the Details About a Visualization Job

    +

    Querying the Details About a Visualization Job

    Query the details about a specified visualization job based on the job name.

    Modifying the Description of a Visualization Job

    +

    Modifying the Description of a Visualization Job

    Modify the description of a visualization job.

    Deleting a Visualization Job

    +

    Deleting a Visualization Job

    Delete a visualization job.

    Stopping a Visualization Job

    +

    Stopping a Visualization Job

    Stop a visualization job.

    Restarting a Visualization Job

    +

    Restarting a Visualization Job

    Restart a visualization job.

    Resource and Engine Specifications

    Querying Job Resource Specifications

    +

    Querying Job Resource Specifications

    Query the resource specifications of a specified job.

    Querying Job Engine Specifications

    +

    Querying Job Engine Specifications

    Query the engine type and version of a specified job.

    Job Statuses

    Job Statuses

    +

    Job Statuses

    View job statuses and status description.

    Importing a Model

    +

    Importing a Model

    Import a model.

    Querying a Model List

    +

    Querying a Model List

    Query the models that meet the search criteria.

    Querying the Details About a Model

    +

    Querying the Details About a Model

    Query details about a model based on the model ID.

    Deleting a Model

    +

    Deleting a Model

    Delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode.

    Deploying a Model as a Service

    +

    Deploying a Model as a Service

    Deploy a model service.

    Querying a Service List

    +

    Querying a Service List

    Query model services.

    Querying the Details About a Service

    +

    Querying the Details About a Service

    Query the details about a model service based on the service ID.

    Updating Service Configurations

    +

    Updating Service Configurations

    Update a model service.

    Querying Service Monitoring Information

    +

    Querying Service Monitoring Information

    Query service monitoring information.

    Querying Service Update Logs

    +

    Querying Service Update Logs

    Query the update logs of a real-time service.

    Querying Service Event Logs

    +

    Querying Service Event Logs

    Query service event logs, including service operation records, key actions during deployment, and deployment failure causes.

    Deleting a Service

    +

    Deleting a Service

    Delete a model service.

    Querying Supported Service Deployment Specifications

    +

    Querying Supported Service Deployment Specifications

    Query supported service deployment specifications.

    Querying Dedicated Resource Pools

    +

    Query dedicated resource pools.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0003.html b/docs/modelarts/api-ref/modelarts_03_0003.html index 924cc3486..95cc391fd 100644 --- a/docs/modelarts/api-ref/modelarts_03_0003.html +++ b/docs/modelarts/api-ref/modelarts_03_0003.html @@ -1,8 +1,8 @@

    Response

    -

    After sending a request, you will receive a response, including the status code, response header, and response body.

    -

    Status Code

    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.

    +

    After sending a request, you will receive a response, including the status code, response header, and response body.

    +

    Status Code

    A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Code.

    For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.

    Response Header

    Similar to a request, a response also has a header, for example, Content-type.

    @@ -65,7 +65,7 @@

    Figure 1 shows the response header fields for the API used to obtain a user token.

    x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.

    -
    Figure 1 Header fields of the response to the request for obtaining a user token
    +
    Figure 1 Header fields of the response to the request for obtaining a user token

    Response Body

    The body of a response is often returned in structured format as specified in the Content-Type header field. The response body transfers content except the response header.

    The following is part of the response body for the API used to obtain a user token.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0004.html b/docs/modelarts/api-ref/modelarts_03_0004.html index 13c56b0fc..f20fcf6d4 100644 --- a/docs/modelarts/api-ref/modelarts_03_0004.html +++ b/docs/modelarts/api-ref/modelarts_03_0004.html @@ -1,12 +1,12 @@

    Authentication

    -
    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 body using an AK/SK pair.
    • Token-based authentication: Requests are authenticated using a token.
    • AK/SK authentication: Requests are encrypted using the access key ID (AK) and secret access key (SK).
    +
    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 body using an AK/SK pair.
    • Token-based authentication: Requests are authenticated using a token.
    • AK/SK authentication: Requests are encrypted using the access key ID (AK) and secret access key (SK).

    Token-based Authentication

    The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.

    A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.

    -

    In Making an API Request, the process of calling the API used to obtain a user token is described.

    +

    In Making an API Request, the process of calling the API used to obtain a user token is described.

    {
     	"auth": {
     		"identity": {
    @@ -15,26 +15,25 @@
     			],
     			"password": {
     				"user": {
    -					"name": "user_name",
    -					"password": "user_password",
    +					"name": "user_name",
    +					"password": "user_password",
     					"domain": {
    -						"name": "domain_name"
    +						"name": "domain_name"
     					}
     				}
     			}
     		},
     		"scope": {
     			"project": {
    -				"name": "project_name"
    +				"name": "project_name"
     			}
     		}
     	}
     }

    After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:

    -
    -POST https://{endpoint}/v1/{project_id}/services
    +
    POST https://{endpoint}/v1/{project_id}/services
     Content-Type: application/json
    -X-Auth-Token: ABCDEFJ....
    +X-Auth-Token: ABCDEFJ....

    AK/SK-based Authentication

    An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.

    AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.

    @@ -42,25 +41,25 @@ Content-Type: application/json

    The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.

    Download the demo project at https://github.com/api-gate-way/SdkDemo.

    +

    ModelArts is a regional service. Specify the project ID when calling the API. Therefore, before running the demo project, add the project ID (X-Project-Id) in line 110 of access() in AccessServicelmpl.java. For details about how to obtain a project ID, see Obtaining a Project ID.

    +

    If you do not need the demo project, visit the following URL to download the API Gateway signing SDK:

    Obtain the API Gateway signing SDK from the enterprise administrator.

    Decompress the downloaded package and reference the obtained JAR files as dependencies, as highlighted in the following figure.

    -

    -
    1. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be credentials.csv.)

      1. Log in to ManageOne Operation Portal.
      2. In the upper right corner of the page, click your account avatar and choose My Settings from the drop-down list.
      3. On the My Settings page, the Project List tab page is displayed by default. Click the Manage Access Key tab page.
      4. Click Add Access Key to create an AK/SK pair.
      5. Click OK. The certificate is automatically downloaded.
      6. After the certificate is downloaded, obtain the AK and SK information from the credentials file.
        • Only two access keys can be added for each user.
        • To ensure access key security, access keys are automatically downloaded only when they are generated for the first time and cannot be obtained from the management console later. Keep them properly.
        -
        -
      -

    2. Download and decompress the demo project.
    3. Import the demo project to Eclipse.

      Figure 1 Selecting Existing Projects into Workspace
      -
      Figure 2 Selecting the demo project
      -
      Figure 3 Structure of the demo project
      +

      +
      1. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be credentials.csv.)

        1. Log in to the console, enter the My Credentials page, and choose Access Keys > Create Access Key.
        2. In the Create Access Key dialog box that is displayed, use the login password for verification.
        3. Click OK, open the credentials.csv file, and save the key file as prompted. The access key file is saved in the default downloads folder of the browser. Then, the access key (Access Key Id and Secret Access Key) is obtained.
        +

      2. Download and decompress the demo project.
      3. Import the demo project to Eclipse.

        Figure 1 Selecting Existing Projects into Workspace
        +
        Figure 2 Selecting the demo project
        +
        Figure 3 Structure of the demo project

      4. Sign the request.

        The request signing method is integrated in the JAR files imported in 3. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.

        The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:

        • AccessService: abstract class that merges the GET, POST, PUT, and DELETE methods into the access method
        • Demo: execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests
        • AccessServiceImpl: implementation of the access method, which contains the code required for communication with API Gateway

        The following describes how to call a POST method to sign the request.

        1. (Optional) Add request header fields.

          Uncomment the following code snippet in the AccessServiceImpl.java file, and specify the project ID and account ID.

          -
          //TODO: Add special headers.
          -//request.addHeader("X-Project-Id", "xxxxx");
          -//request.addHeader("X-Domain-Id", "xxxxx");
          -
        2. Edit the main() method in the Demo.java file, and replace the bold text with actual values.

          As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment. Replace the values of region, serviceName, ak, sk, and url. The URL for obtaining the VPC is used in the sample project. Replace it with the actual URL. Contact the administrator to obtain the endpoint.

          +
          //TODO: Add special headers.
          +//request.addHeader("X-Project-Id", "xxxxx");
          +//request.addHeader("X-Domain-Id", "xxxxx");
          +
        3. Edit the main() method in the Demo.java file, and replace the bold text with actual values.

          As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment. Replace the values of region, serviceName, ak, sk, and url. The URL for obtaining the VPC is used in the sample project. Replace it with the actual URL. Contact the system administrator to obtain the endpoint.

          //TODO: Replace the value of region with the actual region where the service to be accessed is located.
           private static final String region = "";
           
          @@ -70,15 +69,15 @@ private static final String serviceName = "";
           public static void main(String[] args) throws UnsupportedEncodingException
           {
           //TODO: Replace the values of ak and sk with the AK/SK obtained on the My Credentials page.
          -String ak = "ZIRRKMTWP******1WKNKB";
          -String sk = "Us0mdMNHk******YrRCnW0ecfzl";
          +String ak = "ZIRRKMTWP******1WKNKB";
          +String sk = "Us0mdMNHk******YrRCnW0ecfzl";
           
           //TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header.
           //TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID.
           //TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file.
           
           //TODO: Test the API.
          -String url = "https://{Endpoint}/v1/{project_id}/vpcs";
          +String url = "https://{Endpoint}/v1/{project_id}/vpcs";
           get(ak, sk, url);
           
           //TODO: When creating a VPC, replace {project_id} in postUrl with the actual value.
          diff --git a/docs/modelarts/api-ref/modelarts_03_0005.html b/docs/modelarts/api-ref/modelarts_03_0005.html
          index 2f201f5f8..d574c9ab0 100644
          --- a/docs/modelarts/api-ref/modelarts_03_0005.html
          +++ b/docs/modelarts/api-ref/modelarts_03_0005.html
          @@ -1,9 +1,9 @@
           
           
           

          Making an API Request

          -

          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 token can then be used to authenticate the calling of other APIs.

          -

          Request URI

          The format of a request URI is as follows:

          -

          {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

          +

          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 token can then be used to authenticate the calling of other APIs.

          +

          Request URI

          The format of a request URI is as follows:

          +

          {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

          @@ -36,7 +36,7 @@

          For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the resource-path (/v3/auth/tokens) in the URI of the API used to obtain a user token. Then, construct the URI as follows:

          -https://{iam-endpoint}/v3/auth/tokens
          +https://{iam-endpoint}/v3/auth/tokens

          To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.

          @@ -82,7 +82,7 @@ https://{iam-
          Table 1 Request URI

          Parameter

          -
          For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
          POST https://{iam-endpoint}/v3/auth/tokens
          +
          For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
          POST https://{iam-endpoint}/v3/auth/tokens

          Request Header

          You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

          @@ -174,17 +174,17 @@ https://{iam-

          In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDK to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added to the request.

          -
          The API for obtaining a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The request with the added Content-Type header is as follows:
          POST https://{iam-endpoint}/v3/auth/tokens
          +
          The API for obtaining a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The request with the added Content-Type header is as follows:
          POST https://{iam-endpoint}/v3/auth/tokens
           Content-Type: application/json

          Request Body

          The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be encoded in UTF-8.

          The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

          -

          If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace user_name, domain_name, and user_password with the actual username, account name, and login password, respectively. project_name is the project name. For details, see Obtaining a Username, Obtaining an Account Name and ID, and Obtaining a Project Name.

          +

          If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace user_name, domain_name, and user_password with the actual username, account name, and login password, respectively. project_name is the project name. For details, see Obtaining a Username and ID, Obtaining an Account Name and ID, and Obtaining a Project ID.

          The scope parameter specifies where a token takes effect. In the example, the token takes effect only for the resources in a specified project. ModelArts uses a region-specific endpoint to call this API. Set scope to project. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see "Obtaining a User Token".

          -POST https://{iam-endpoint}/v3/auth/tokens 
          +POST https://{iam-endpoint}/v3/auth/tokens 
           Content-Type:application/json
           {
             "auth": {
          diff --git a/docs/modelarts/api-ref/modelarts_03_0006.html b/docs/modelarts/api-ref/modelarts_03_0006.html
          index 422b747be..c1051978b 100644
          --- a/docs/modelarts/api-ref/modelarts_03_0006.html
          +++ b/docs/modelarts/api-ref/modelarts_03_0006.html
          @@ -2,8 +2,8 @@
           
           

          Obtaining a Username and ID

          When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:

          -
          1. Log in to the management console after registration.
          2. In the upper right corner, click your account avatar icon and choose My Settings from the drop-down list.

            On the My Settings page, view the username and ID.

            -
            Figure 1 Viewing the username and ID
            +
            1. Log in to the management console after registration.
            2. Hover the cursor on the username and choose My Credentials from the drop-down list.

              On the My Credentials page, view the username and ID.

              +
              Figure 1 Viewing the username and ID
          diff --git a/docs/modelarts/api-ref/modelarts_03_0043.html b/docs/modelarts/api-ref/modelarts_03_0043.html index 2e1d823fd..aa23aa5de 100644 --- a/docs/modelarts/api-ref/modelarts_03_0043.html +++ b/docs/modelarts/api-ref/modelarts_03_0043.html @@ -1,6 +1,6 @@ -

          Training Management

          +

          Training Management

    String

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

    +

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

    String

    Training job name. The value is a string of 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

    +

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

    job_desc

    @@ -56,16 +56,16 @@

    String

    Description of a training job. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a training job. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    config

    Yes

    JSON

    +

    Object

    Parameters for creating a training job

    +

    Parameters for creating a training job For details, see Table 3.

    workspace_id

    @@ -81,7 +81,7 @@
    -
    Table 3 config parameters

    Parameter

    +
    @@ -97,7 +97,7 @@ - - @@ -138,7 +138,7 @@ - @@ -147,7 +147,7 @@ - @@ -156,7 +156,7 @@ - @@ -169,7 +169,7 @@ - - + + + + + - @@ -262,7 +271,7 @@ - @@ -271,7 +280,7 @@ - @@ -280,7 +289,7 @@ - @@ -305,7 +314,7 @@ - @@ -314,7 +323,7 @@ - @@ -500,7 +509,7 @@ -
    Table 3 config parameters

    Parameter

    Mandatory

    Integer

    Number of workers in a training job. Obtain the maximum value from the max_num value returned by the API in Querying Job Resource Specifications.

    +

    Number of workers in a training job. Obtain the maximum value from the max_num value returned by the API in Querying Job Resource Specifications.

    app_url

    @@ -129,7 +129,7 @@

    data_url

    Yes

    +

    No

    String

    dataset_id

    Yes

    +

    No

    String

    dataset_version_id

    Yes

    +

    No

    String

    data_source

    Yes

    +

    No

    Array<Object>

    Long

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    +

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    engine_id

    @@ -178,7 +178,16 @@

    Long

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    +

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    +

    model_id

    +

    Yes

    +

    Long

    +

    ID of the built-in model of a training job. Obtain model_id by calling the API described in Querying a Built-in Algorithm. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    train_url

    @@ -253,7 +262,7 @@

    dataset_id

    Yes

    +

    No

    String

    dataset_version

    Yes

    +

    No

    String

    type

    Yes

    +

    No

    String

    data_url

    Yes

    +

    No

    String

    No

    JSON

    +

    Object

    Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see Table 6.

    No

    JSON

    +

    Object

    Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see Table 7.

    Int

    Status of a training job. For details about the job statuses, see Job Statuses.

    +

    Status of a training job. For details about the job statuses, see Job Statuses.

    create_time

    @@ -649,7 +658,9 @@ "error_code": "ModelArts.0103" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0046.html b/docs/modelarts/api-ref/modelarts_03_0046.html index 4591ef30f..979159e00 100644 --- a/docs/modelarts/api-ref/modelarts_03_0046.html +++ b/docs/modelarts/api-ref/modelarts_03_0046.html @@ -5,7 +5,7 @@

    URI

    GET /v1/{project_id}/training-jobs

    Table 1 describes the required parameters. -
    Table 1 Parameters

    Parameter

    +
    @@ -21,94 +21,94 @@ -
    Table 1 URI parameters

    Parameter

    Mandatory

    String

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

    +

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

    - -

    Request Body

    Table 2 describes the request parameters.

    -
    Table 2 Parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Query parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of status to 3, 5, 6, or 13. For details about the job statuses, see Job Statuses.

    +

    Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of status to 3, 5, 6, or 13. For details about the job statuses, see Job Statuses.

    per_page

    +

    per_page

    No

    +

    No

    Integer

    +

    Integer

    Number of jobs displayed on each page. The value range is [1, 1000]. Default value: 10

    +

    Number of jobs displayed on each page. The value range is [1, 1000]. Default value: 10

    page

    +

    page

    No

    +

    No

    Integer

    +

    Integer

    Index of the page to be queried. Default value: 1 The value range is [1, 65535].

    +

    Index of the page to be queried. Default value: 1 The value range is [1, 65535].

    sortBy

    +

    sortBy

    No

    +

    No

    String

    +

    String

    Sorting mode of the query. The value can be job_name, job_desc, status, duration, version_count, or create_time. Default value: job_name

    +

    Sorting mode of the query. The value can be job_name, job_desc, status, duration, version_count, or create_time. Default value: job_name

    order

    +

    order

    No

    +

    No

    String

    +

    String

    Sorting order. The options are as follows:

    -
    • asc: ascending order. It is the default value.
    • desc: descending order
    +

    Sorting order. The options are as follows:

    +
    • asc: ascending order. It is the default value.
    • desc: descending order

    search_content

    +

    search_content

    No

    +

    No

    String

    +

    String

    Search content, for example, a training job name. The value is a string of 0 to 64 characters. By default, this parameter is left blank.

    +

    Search content, for example, a training job name. The value must contain 0 to 64 characters. By default, this parameter is left blank.

    workspace_id

    +

    workspace_id

    No

    +

    No

    String

    +

    String

    Workspace where a job resides. Default value: 0

    +

    Workspace where a job resides. Default value: 0

    +

    Request Body

    None

    +

    Response Body

    Table 3 describes the response parameters.
    @@ -206,7 +206,7 @@ - - - - @@ -658,25 +658,25 @@ - - - -
    Table 3 Parameters

    Parameter

    Int

    Status of a training job. For details about the job statuses, see Job Statuses.

    +

    Status of a training job. For details about the job statuses, see Job Statuses.

    create_time

    @@ -271,7 +271,9 @@ } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0047.html b/docs/modelarts/api-ref/modelarts_03_0047.html index b5c706ff5..8fb10d54b 100644 --- a/docs/modelarts/api-ref/modelarts_03_0047.html +++ b/docs/modelarts/api-ref/modelarts_03_0047.html @@ -1,7 +1,7 @@

    Querying the Details About a Training Job Version

    -

    Function

    This API is used to query the details about a specified training job based on the job ID.

    +

    Function

    This API is used to query the details about a specified training job based on the job ID.

    URI

    GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}

    Table 1 describes the required parameters. @@ -21,7 +21,7 @@

    String

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

    +

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

    job_id

    @@ -140,7 +140,7 @@

    Integer

    Status of a training job. For details about the job statuses, see Job Statuses.

    +

    Status of a training job. For details about the job statuses, see Job Statuses.

    app_url

    @@ -278,7 +278,7 @@

    system_metric_list

    JSON

    +

    Object

    System monitoring metrics of a training job. For details, see Table 6.

    No

    JSON

    +

    Object

    Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see Table 6.

    +

    Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see Table 12.

    host_path

    No

    JSON

    +

    Object

    Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see Table 7.

    +

    Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see Table 13.

    -
    Table 12 nfs parameters

    Parameter

    +
    @@ -727,7 +727,7 @@
    Table 12 nfs parameters

    Parameter

    Mandatory

    -
    Table 13 host_path parameters

    Parameter

    +
    @@ -894,7 +894,7 @@ }, "dataset_name": "dataset-test", "dataset_version_name": "dataset-version-test", - "spec_code": , + "spec_code": "modelarts.vm.gpu.v100", "start_time": 1563172362000, "volumes": [ { @@ -925,7 +925,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0048.html b/docs/modelarts/api-ref/modelarts_03_0048.html index 8cb1ba345..dc95a91c7 100644 --- a/docs/modelarts/api-ref/modelarts_03_0048.html +++ b/docs/modelarts/api-ref/modelarts_03_0048.html @@ -2,7 +2,7 @@

    Deleting a Version of a Training Job

    Function

    This API is used to delete a version of a training job.

    -

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    +

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    URI

    DELETE /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}

    Table 1 describes the required parameters. @@ -22,7 +22,7 @@
    -
    Table 13 host_path parameters

    Parameter

    Mandatory

    String

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

    +

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

    job_id

    @@ -98,7 +98,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0049.html b/docs/modelarts/api-ref/modelarts_03_0049.html index c75cc5ace..8f3cacbb4 100644 --- a/docs/modelarts/api-ref/modelarts_03_0049.html +++ b/docs/modelarts/api-ref/modelarts_03_0049.html @@ -5,7 +5,7 @@

    URI

    GET /v1/{project_id}/training-jobs/{job_id}/versions

    Table 1 describes the required parameters. -
    Table 1 Parameters

    Parameter

    +
    @@ -21,7 +21,7 @@ -
    Table 1 URI parameters

    Parameter

    Mandatory

    String

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

    +

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

    job_id

    @@ -37,42 +37,42 @@
    - -

    Request Body

    Table 2 describes the request parameters.

    -
    Table 2 Parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 2 Query parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    per_page

    +

    per_page

    No

    +

    No

    Integer

    +

    Integer

    Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: 10

    +

    Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: 10

    page

    +

    page

    No

    +

    No

    Integer

    +

    Integer

    Index of the page to be queried

    -
    • If paging is required, set page to 1.
    • The default value of page is 0, indicating that paging is not supported.
    +

    Index of the page to be queried

    +
    • If paging is required, set page to 1.
    • The default value of page is 0, indicating that paging is not supported.
    +

    Request Body

    None

    +

    Response Body

    Table 3 describes the response parameters.
    @@ -145,292 +145,292 @@ -
    Table 3 Parameters

    Parameter

    Table 4 versions parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -631,31 +631,31 @@
    Table 4 versions parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    version_id

    +

    version_id

    Long

    +

    Long

    Version ID of a training job

    +

    Version ID of a training job

    version_name

    +

    version_name

    String

    +

    String

    Version name of a training job

    +

    Version name of a training job

    pre_version_id

    +

    pre_version_id

    Long

    +

    Long

    ID of the previous version of a training job

    +

    ID of the previous version of a training job

    engine_type

    +

    engine_type

    Long

    +

    Long

    Engine type of a training job

    +

    Engine type of a training job

    engine_name

    +

    engine_name

    String

    +

    String

    Name of the engine selected for a training job

    +

    Name of the engine selected for a training job

    engine_id

    +

    engine_id

    Long

    +

    Long

    ID of the engine selected for a training job

    +

    ID of the engine selected for a training job

    engine_version

    +

    engine_version

    String

    +

    String

    Version of the engine selected for a training job

    +

    Version of the engine selected for a training job

    status

    +

    status

    Int

    +

    Int

    Status of a training job

    +

    Status of a training job

    app_url

    +

    app_url

    String

    +

    String

    Code directory of a training job

    +

    Code directory of a training job

    boot_file_url

    +

    boot_file_url

    String

    +

    String

    Boot file of a training job

    +

    Boot file of a training job

    create_time

    +

    create_time

    Long

    +

    Long

    Time when a training job is created

    +

    Time when a training job is created

    parameter

    +

    parameter

    JSON Array

    +

    JSON Array

    Running parameters of a training job. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 5.

    +

    Running parameters of a training job. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 5.

    duration

    +

    duration

    Long

    +

    Long

    Training job running duration, in milliseconds

    +

    Training job running duration, in milliseconds

    spec_id

    +

    spec_id

    Long

    +

    Long

    ID of the resource specifications selected for a training job

    +

    ID of the resource specifications selected for a training job

    core

    +

    core

    String

    +

    String

    Number of cores of the resource specifications

    +

    Number of cores of the resource specifications

    cpu

    +

    cpu

    String

    +

    String

    CPU memory of the resource specifications

    +

    CPU memory of the resource specifications

    gpu_num

    +

    gpu_num

    Integer

    +

    Integer

    Number of GPUs of the resource specifications

    +

    Number of GPUs of the resource specifications

    gpu_type

    +

    gpu_type

    String

    +

    String

    GPU type of the resource specifications

    +

    GPU type of the resource specifications

    worker_server_num

    +

    worker_server_num

    Integer

    +

    Integer

    Number of workers in a training job

    +

    Number of workers in a training job

    data_url

    +

    data_url

    String

    +

    String

    Dataset of a training job

    +

    Dataset of a training job

    train_url

    +

    train_url

    String

    +

    String

    OBS path of the training job output file

    +

    OBS path of the training job output file

    log_url

    +

    log_url

    String

    +

    String

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

    +

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/log/

    dataset_version_id

    +

    dataset_version_id

    String

    +

    String

    Dataset version ID of a training job

    +

    Dataset version ID of a training job

    dataset_id

    +

    dataset_id

    String

    +

    String

    Dataset ID of a training job

    +

    Dataset ID of a training job

    data_source

    +

    data_source

    JSON Array

    +

    JSON Array

    Datasets of a training job. For details, see Table 6.

    +

    Datasets of a training job. For details, see Table 6.

    model_id

    +

    model_id

    Long

    +

    Long

    Model ID of a training job

    +

    Model ID of a training job

    model_metric_list

    +

    model_metric_list

    String

    +

    String

    Model metrics of a training job. For details, see Table 7.

    +

    Model metrics of a training job. For details, see Table 7.

    system_metric_list

    +

    system_metric_list

    String

    +

    String

    System monitoring metrics of a training job. For details, see Table 8.

    +

    System monitoring metrics of a training job. For details, see Table 8.

    user_image_url

    +

    user_image_url

    String

    +

    String

    SWR URL of a custom image used by a training job

    +

    SWR URL of a custom image used by a training job

    user_command

    +

    user_command

    String

    +

    String

    Boot command used to start the container of a custom image of a training job

    +

    Boot command used to start the container of a custom image of a training job

    resource_id

    +

    resource_id

    String

    +

    String

    Charged resource ID of a training job

    +

    Charged resource ID of a training job

    dataset_name

    +

    dataset_name

    String

    +

    String

    Dataset of a training job

    +

    Dataset of a training job

    start_time

    +

    start_time

    Long

    +

    Long

    Training start time

    +

    Training start time

    volumes

    +

    volumes

    JSON Array

    +

    JSON Array

    Storage volume that can be used by a training job. For details, see Table 13.

    +

    Storage volume that can be used by a training job. For details, see Table 13.

    dataset_version_name

    +

    dataset_version_name

    String

    +

    String

    Dataset of a training job

    +

    Dataset of a training job

    pool_name

    +

    pool_name

    String

    +

    String

    Name of a resource pool

    +

    Name of a resource pool

    pool_id

    +

    pool_id

    String

    +

    String

    ID of a resource pool

    +

    ID of a resource pool

    nas_mount_path

    +

    nas_mount_path

    String

    +

    String

    Local mount path of SFS Turbo (NAS). Example value: /home/work/nas

    +

    Local mount path of SFS Turbo (NAS). Example value: /home/work/nas

    nas_share_addr

    +

    nas_share_addr

    String

    +

    String

    Shared path of SFS Turbo (NAS). Example value: 192.168.8.150:/

    +

    Shared path of SFS Turbo (NAS). Example value: 192.168.8.150:/

    nas_type

    +

    nas_type

    String

    +

    String

    Only NFS is supported. Example value: nfs

    +

    Only NFS is supported. Example value: nfs

    - - - - - - - - @@ -891,7 +891,9 @@ } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0050.html b/docs/modelarts/api-ref/modelarts_03_0050.html index dc99169f8..6816849ea 100644 --- a/docs/modelarts/api-ref/modelarts_03_0050.html +++ b/docs/modelarts/api-ref/modelarts_03_0050.html @@ -2,7 +2,7 @@

    Creating a Version of a Training Job

    Function

    This API is used to create a version of a training job.

    -

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    +

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    URI

    POST /v1/{project_id}/training-jobs/{job_id}/versions

    Table 1 describes the required parameters. @@ -22,7 +22,7 @@
    - - - - @@ -74,158 +74,158 @@ -
    Table 11 total_metric parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_metric_meta

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    total_reserved_data

    JSON Array

    +

    JSON Array

    Reserved parameter

    +

    Reserved parameter

    total_metric_values

    JSON Array

    +

    JSON Array

    Overall validation metrics of a training job. For details, see Table 12.

    +

    Overall validation metrics of a training job. For details, see Table 12.

    String

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

    +

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

    job_id

    @@ -56,16 +56,16 @@

    String

    Description of a training job. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a training job. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    config

    Yes

    JSON

    +

    Object

    Parameters for creating a training job

    +

    Parameters for creating a training job For details, see Table 3.

    Table 3 config parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -244,7 +244,7 @@ - @@ -253,7 +253,7 @@ - @@ -262,7 +262,7 @@ - @@ -271,7 +271,7 @@ - @@ -362,7 +362,7 @@ - - - - @@ -115,7 +115,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0053.html b/docs/modelarts/api-ref/modelarts_03_0053.html index a18304120..8ba485a1d 100644 --- a/docs/modelarts/api-ref/modelarts_03_0053.html +++ b/docs/modelarts/api-ref/modelarts_03_0053.html @@ -2,7 +2,7 @@

    Deleting a Training Job

    Function

    This API is used to delete a training job.

    -

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    +

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    URI

    DELETE /v1/{project_id}/training-jobs/{job_id}

    Table 1 describes the required parameters. @@ -22,7 +22,7 @@
    - - - @@ -324,7 +324,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0058.html b/docs/modelarts/api-ref/modelarts_03_0058.html index 2f5346a9e..ac00b76fa 100644 --- a/docs/modelarts/api-ref/modelarts_03_0058.html +++ b/docs/modelarts/api-ref/modelarts_03_0058.html @@ -21,7 +21,7 @@
    - @@ -30,9 +30,9 @@

    Request Body

    Table 2 describes the request parameters. -
    Table 3 config parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    worker_server_num

    +

    worker_server_num

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    +

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    app_url

    +

    app_url

    Yes

    +

    Yes

    String

    +

    String

    Code directory of a training job, for example, /usr/app/. This parameter must be used together with boot_file_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    +

    Code directory of a training job, for example, /usr/app/. This parameter must be used together with boot_file_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    boot_file_url

    +

    boot_file_url

    Yes

    +

    Yes

    String

    +

    String

    Boot file of a training job, which needs to be stored in the code directory. Example value: /usr/app/boot.py This parameter must be used together with app_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    +

    Boot file of a training job, which needs to be stored in the code directory. Example value: /usr/app/boot.py This parameter must be used together with app_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    parameter

    +

    parameter

    No

    +

    No

    Array<Object>

    +

    Array<Object>

    Running parameters of a training job. It is a collection of label-value pairs. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 5.

    +

    Running parameters of a training job. It is a collection of label-value pairs. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 5.

    data_url

    +

    data_url

    Yes

    +

    No

    String

    +

    String

    OBS URL of the dataset required by a training job. By default, this parameter is left blank. For example, /usr/data/. This parameter cannot be used together with data_source or dataset_id and dataset_version_id. However, one of the parameters must exist.

    +

    OBS URL of the dataset required by a training job. By default, this parameter is left blank. For example, /usr/data/. This parameter cannot be used together with data_source or dataset_id and dataset_version_id. However, one of the parameters must exist.

    dataset_id

    +

    dataset_id

    Yes

    +

    No

    String

    +

    String

    Dataset ID of a training job. This parameter must be used together with dataset_version_id, but cannot be used together with data_url or data_source.

    +

    Dataset ID of a training job. This parameter must be used together with dataset_version_id, but cannot be used together with data_url or data_source.

    dataset_version_id

    +

    dataset_version_id

    Yes

    +

    No

    String

    +

    String

    Dataset version ID of a training job. This parameter must be used together with dataset_id, but cannot be used together with data_url or data_source.

    +

    Dataset version ID of a training job. This parameter must be used together with dataset_id, but cannot be used together with data_url or data_source.

    data_source

    +

    data_source

    No

    +

    No

    JSON Array

    +

    JSON Array

    Dataset of a training job. This parameter cannot be used with data_url, dataset_id, or dataset_version_id. For details, see Table 4.

    +

    Dataset of a training job. This parameter cannot be used with data_url, dataset_id, or dataset_version_id. For details, see Table 4.

    spec_id

    +

    spec_id

    Yes

    +

    Yes

    Long

    +

    Long

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    +

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    engine_id

    +

    engine_id

    Yes

    +

    Yes

    Long

    +

    Long

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    +

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    model_id

    +

    model_id

    Yes

    +

    Yes

    Long

    +

    Long

    ID of the built-in model of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    +

    ID of the built-in model of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    train_url

    +

    train_url

    Yes

    +

    Yes

    String

    +

    String

    OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: /bucket/trainUrl/

    +

    OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: /bucket/trainUrl/

    log_url

    +

    log_url

    No

    +

    No

    String

    +

    String

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/train/

    +

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/train/

    pre_version_id

    +

    pre_version_id

    Yes

    +

    Yes

    Long

    +

    Long

    ID of the previous version of a training job. You can obtain the value of version_id by calling the API described in Querying a List of Training Job Versions.

    +

    ID of the previous version of a training job. You can obtain the value of version_id by calling the API described in Querying a List of Training Job Versions.

    user_image_url

    +

    user_image_url

    No

    +

    No

    String

    +

    String

    SWR URL of a custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

    +

    SWR URL of a custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

    user_command

    +

    user_command

    No

    +

    No

    String

    +

    String

    Boot command used to start the container of a custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.

    +

    Boot command used to start the container of a custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}.

    dataset_id

    Yes

    +

    No

    String

    dataset_version

    Yes

    +

    No

    String

    type

    Yes

    +

    No

    String

    data_url

    Yes

    +

    No

    String

    Int

    Status of a training job. For details about the job statuses, see Job Statuses.

    +

    Status of a training job. For details about the job statuses, see Job Statuses.

    create_time

    @@ -435,7 +435,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0051.html b/docs/modelarts/api-ref/modelarts_03_0051.html index 3d390839b..36ae1ad5b 100644 --- a/docs/modelarts/api-ref/modelarts_03_0051.html +++ b/docs/modelarts/api-ref/modelarts_03_0051.html @@ -2,7 +2,7 @@

    Stopping a Training Job

    Function

    This API is used to stop a training job.

    -

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    +

    Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training Job List and Querying the Details About a Training Job Version.

    URI

    POST /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/stop

    Table 1 describes the required parameters. @@ -22,7 +22,7 @@

    String

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

    +

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

    job_id

    @@ -100,7 +100,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0052.html b/docs/modelarts/api-ref/modelarts_03_0052.html index 2ce6e6559..acf188413 100644 --- a/docs/modelarts/api-ref/modelarts_03_0052.html +++ b/docs/modelarts/api-ref/modelarts_03_0052.html @@ -21,7 +21,7 @@

    String

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

    +

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

    job_id

    @@ -55,7 +55,7 @@

    String

    Description of a training job. The value is a string of 0 to 256 characters.

    +

    Description of a training job. The value must contain 0 to 256 characters.

    String

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

    +

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

    job_id

    @@ -91,7 +91,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0054.html b/docs/modelarts/api-ref/modelarts_03_0054.html index fe655a310..7c8c97f34 100644 --- a/docs/modelarts/api-ref/modelarts_03_0054.html +++ b/docs/modelarts/api-ref/modelarts_03_0054.html @@ -21,7 +21,7 @@

    String

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

    +

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

    job_id

    @@ -108,7 +108,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0056.html b/docs/modelarts/api-ref/modelarts_03_0056.html index e2fb4abf4..bfd46b9b0 100644 --- a/docs/modelarts/api-ref/modelarts_03_0056.html +++ b/docs/modelarts/api-ref/modelarts_03_0056.html @@ -21,7 +21,7 @@

    String

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

    +

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

    String

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

    +

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

    Table 2 Parameters

    Parameter

    +
    - @@ -40,81 +40,81 @@ - - - - - - - - - - - - - - - - - - - - - - - @@ -122,76 +122,76 @@

    This parameter cannot be used together with data_source or dataset_id and dataset_version_id. However, one of the parameters must exist.

    - - - - - - - - - - - - - - - - - - - @@ -199,7 +199,7 @@ -
    Table 2 Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    config_name

    +

    config_name

    Yes

    +

    Yes

    String

    Name of a training job configuration. The value is a string of 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

    +

    Name of a training job configuration. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

    config_desc

    +

    config_desc

    No

    +

    No

    String

    Description of a training job configuration. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a training job configuration. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    worker_server_num

    +

    worker_server_num

    Yes

    +

    Yes

    Integer

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    +

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    app_url

    +

    app_url

    Yes

    +

    Yes

    String

    Code directory of a training job, for example, /usr/app/. This parameter must be used together with boot_file_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    boot_file_url

    +

    boot_file_url

    Yes

    +

    Yes

    String

    Boot file of a training job, which needs to be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used together with app_url. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    model_id

    +

    model_id

    Yes

    +

    Yes

    Long

    Model ID of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    +

    Model ID of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    parameter

    +

    parameter

    No

    +

    No

    Array<Object>

    Running parameters of a training job. It is a collection of label-value pairs. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 4.

    spec_id

    +

    spec_id

    Yes

    +

    Yes

    Long

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    +

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    data_url

    +

    data_url

    Yes

    +

    No

    String

    dataset_id

    +

    dataset_id

    Yes

    +

    No

    String

    Dataset ID of a training job. This parameter must be used together with dataset_version_id, but cannot be used together with data_url or data_source.

    dataset_version_id

    +

    dataset_version_id

    Yes

    +

    No

    String

    Dataset version ID of a training job. This parameter must be used together with dataset_id, but cannot be used together with data_url or data_source.

    data_source

    +

    data_source

    Yes

    +

    No

    JSON Array

    Dataset of a training job. This parameter cannot be used together with data_url or dataset_id and dataset_version_id.

    +

    Dataset of a training job. This parameter cannot be used together with data_url or dataset_id and dataset_version_id. For details, see Table 3.

    engine_id

    +

    engine_id

    Yes

    +

    Yes

    Long

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    +

    ID of the engine selected for a training job. The default value is 1. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    train_url

    +

    train_url

    No

    +

    No

    String

    OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: /usr/train/

    log_url

    +

    log_url

    No

    +

    No

    String

    OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: /usr/train/

    user_image_url

    +

    user_image_url

    No

    +

    No

    String

    SWR URL of a custom image used by a training job. Example value: 100.125.5.235:20202/jobmng/custom-cpu-base:1.0

    user_command

    +

    user_command

    No

    +

    No

    String

    Boot command used to start the container of a custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}. The run_train.sh script needs to be invoked to initialize variables, such as the AK/SK. The run_train.sh script is followed by python to ensure that the Python files can be executed in the initialized variable environment. run_train.sh is used to start Python.

    +

    Boot command used to start the container of a custom image of a training job. The format is bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}. The boot script run_train.sh must be invoked to initialize variables, such as the AK/SK. The run_train.sh script is followed by python to ensure that the Python files can be executed in the initialized variable environment. run_train.sh is used to start Python.

    Table 3 data_source parameters

    Parameter

    +
    @@ -211,7 +211,7 @@ - @@ -220,7 +220,7 @@ - @@ -229,7 +229,7 @@ - @@ -238,7 +238,7 @@ - @@ -354,7 +354,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0059.html b/docs/modelarts/api-ref/modelarts_03_0059.html index 3c282083a..69a8f1212 100644 --- a/docs/modelarts/api-ref/modelarts_03_0059.html +++ b/docs/modelarts/api-ref/modelarts_03_0059.html @@ -21,7 +21,7 @@
    - @@ -140,7 +140,7 @@ - @@ -150,7 +150,7 @@
    -
    Table 3 data_source parameters

    Parameter

    Mandatory

    dataset_id

    Yes

    +

    No

    String

    dataset_version

    Yes

    +

    No

    String

    type

    Yes

    +

    No

    String

    data_url

    Yes

    +

    No

    String

    String

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

    +

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

    configs

    JSON Array

    +

    Array of ConfigResponse objects

    configs parameters

    Table 4 configs parameters

    Parameter

    +
    @@ -252,7 +252,9 @@ "error_code": "ModelArts.0105" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0060.html b/docs/modelarts/api-ref/modelarts_03_0060.html index b0442b9b0..87b19ecd3 100644 --- a/docs/modelarts/api-ref/modelarts_03_0060.html +++ b/docs/modelarts/api-ref/modelarts_03_0060.html @@ -21,7 +21,7 @@
    - - - - - - - @@ -124,7 +124,7 @@ - @@ -133,7 +133,7 @@ - @@ -142,11 +142,11 @@ - - -
    Table 4 configs parameters

    Parameter

    Type

    String

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

    +

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

    config_name

    @@ -55,7 +55,7 @@

    String

    Description of a training job configuration. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a training job configuration. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    worker_server_num

    @@ -64,7 +64,7 @@

    Integer

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    +

    Number of workers in a training job. Obtain the maximum value from Querying Job Resource Specifications.

    app_url

    @@ -91,7 +91,7 @@

    Long

    Model ID of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    +

    Model ID of a training job. After setting model_id, you do not need to set app_url or boot_file_url, and engine_id.

    parameter

    @@ -100,7 +100,7 @@

    Array<Object>

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a training job uses a custom image.

    +

    Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a training job uses a custom image. For details, see Table 4.

    spec_id

    @@ -109,12 +109,12 @@

    Long

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    +

    ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in Querying Job Resource Specifications.

    data_url

    Yes

    +

    No

    String

    dataset_id

    Yes

    +

    No

    String

    dataset_version_id

    Yes

    +

    No

    String

    data_source

    Yes

    +

    No

    JSON Array

    Dataset of a training job. This parameter cannot be used together with data_url or dataset_id and dataset_version_id.

    +

    Dataset of a training job. This parameter cannot be used together with data_url or dataset_id and dataset_version_id. For details, see Table 3.

    engine_id

    @@ -155,7 +155,7 @@

    Long

    ID of the engine selected for a training job. The default value is 1. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    +

    ID of the engine selected for a training job. The default value is 1. Obtain the ID by calling the API described in Querying Job Engine Specifications.

    train_url

    @@ -199,7 +199,7 @@ -
    Table 3 data_source parameters

    Parameter

    +
    @@ -249,7 +249,7 @@
    Table 3 data_source parameters

    Parameter

    Mandatory

    -
    Table 4 parameter parameters

    Parameter

    +
    @@ -356,6 +356,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    -
    Table 4 parameter parameters

    Parameter

    Mandatory

    String

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

    +

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

    config_name

    @@ -91,6 +91,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    URI

    GET /v1/{project_id}/training-job-configs/{config_name}

    Table 1 describes the required parameters. -
    Table 1 Parameters

    Parameter

    +
    @@ -21,7 +21,7 @@ -
    Table 1 URI parameters

    Parameter

    Mandatory

    String

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

    +

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

    config_name

    @@ -37,33 +37,33 @@
    - -

    Request Body

    Table 2 describes the request parameters.

    -
    Table 2 Parameters

    Parameter

    +
    - - - - - - -
    Table 2 Query parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    config_type

    +

    config_type

    No

    +

    No

    String

    +

    String

    Configuration type to be queried. Options:

    -
    • custom: Query the custom configurations.
    • sample: Query the sample configurations. The default value is custom.
    +

    Configuration type to be queried. Options:

    +
    • custom: Query the custom configurations.
    • sample: Query the sample configurations. The default value is custom.
    +

    Request Body

    None

    +

    Response Body

    Table 3 describes the response parameters.
    @@ -176,7 +176,7 @@ -
    Table 3 Parameters

    Parameter

    JSON Array

    Datasets of a training job

    +

    Datasets of a training job For details, see Table 4.

    engine_type

    @@ -338,7 +338,7 @@ -
    Table 4 data_source parameters

    Parameter

    +
    @@ -391,14 +391,14 @@ - - @@ -582,6 +582,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - @@ -48,7 +48,7 @@ - - - - - -
    Table 4 data_source parameters

    Parameter

    Type

    nfs

    JSON

    +

    Object

    Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see Table 6.

    host_path

    JSON

    +

    Object

    Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see Table 7.

    String

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

    +

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

    String

    Name of a visualization job. The value is a string of 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-).

    +

    Name of a visualization job. The value must contain 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-).

    job_desc

    @@ -57,7 +57,7 @@

    String

    Description of a visualization job. The value is a string of 0 to 256 characters. By default, this parameter is left blank.

    +

    Description of a visualization job. The value must contain 0 to 256 characters. By default, this parameter is left blank.

    train_url

    @@ -82,25 +82,25 @@

    No

    JSON

    +

    Object

    Specifications when a visualization job is created. You do not need to set this parameter.

    +

    Specifications when a visualization job is created. You do not need to set this parameter. For details, see Table 3.

    schedule

    No

    JSON

    +

    Object

    Automatic stop setting

    +

    Auto stop setting. For details, see Table 4.

    -
    Table 3 flavor parameters

    Parameter

    +
    @@ -123,7 +123,7 @@
    Table 3 flavor parameters

    Parameter

    Mandatory

    -
    Table 4 schedule parameters

    Parameter

    +
    @@ -208,7 +208,7 @@ - - @@ -46,7 +46,7 @@ - - - - - @@ -158,6 +158,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - - @@ -118,6 +118,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - - - - @@ -45,7 +45,7 @@ - - @@ -258,6 +259,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - @@ -163,6 +163,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - @@ -345,14 +345,14 @@ -
    Table 4 schedule parameters

    Parameter

    Mandatory

    Integer

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    create_time

    @@ -261,6 +261,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    String

    Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of status to 3, 5, 6, or 13. For details about the job statuses, see Job Statuses.

    +

    Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of status to 3, 5, 6, or 13. For details about the job statuses, see Job Statuses.

    per_page

    @@ -92,7 +92,7 @@

    String

    Search content, for example, a visualization job name. The value is a string of 0 to 64 characters. By default, this parameter is left blank.

    +

    Search content, for example, a visualization job name. The value must contain 0 to 64 characters. By default, this parameter is left blank.

    workspace_id

    @@ -194,7 +194,7 @@

    Integer

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    create_time

    @@ -288,6 +288,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    job_id

    @@ -126,7 +126,7 @@

    Int

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    +

    Status of a visualization job. For details about the job statuses, see Job Statuses.

    String

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

    +

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

    job_id

    @@ -55,7 +55,7 @@

    String

    Description of a visualization job. The value is a string of 0 to 256 characters.

    +

    Description of a visualization job. The value must contain 0 to 256 characters.

    String

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

    +

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

    job_id

    @@ -92,6 +92,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    job_id

    @@ -92,6 +92,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    job_id

    @@ -92,6 +92,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    String

    Job type. The value can be train or inference.

    +

    Job type. The value can be train or inference. This parameter is not required for querying the specifications of ExeML resources.

    engine_id

    @@ -54,7 +54,7 @@

    Long

    Engine ID of a job. Default value: 0

    +

    Engine ID of a job. Default value: 0 This parameter is not required for querying the specifications of ExeML resources.

    project_type

    @@ -64,6 +64,7 @@

    Integer

    Project type. Default value: 0

    +
    • 0: non-ExeML project
    • 1: ExeML job for image classification
    • 2: ExeML job for object detection
    • 3: ExeML job for predictive analytics

    String

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

    +

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

    String

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

    +

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

    package array

    Collection of dependency packages

    +

    Collection of dependency packages. For details, see Table 5.

    -
    Table 5 package parameters

    Parameter

    +
    @@ -563,7 +563,7 @@ - @@ -581,7 +581,7 @@ - @@ -773,10 +773,12 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0077.html b/docs/modelarts/api-ref/modelarts_03_0077.html index a91e59ec7..20ac29ec2 100644 --- a/docs/modelarts/api-ref/modelarts_03_0077.html +++ b/docs/modelarts/api-ref/modelarts_03_0077.html @@ -21,7 +21,7 @@ - @@ -285,7 +285,7 @@ - - @@ -412,10 +413,12 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0078.html b/docs/modelarts/api-ref/modelarts_03_0078.html index b750b2321..54836c144 100644 --- a/docs/modelarts/api-ref/modelarts_03_0078.html +++ b/docs/modelarts/api-ref/modelarts_03_0078.html @@ -21,7 +21,7 @@ - - @@ -279,7 +279,7 @@ - @@ -300,7 +300,7 @@ - @@ -642,10 +642,12 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0079.html b/docs/modelarts/api-ref/modelarts_03_0079.html index 0cb95f664..10553711c 100644 --- a/docs/modelarts/api-ref/modelarts_03_0079.html +++ b/docs/modelarts/api-ref/modelarts_03_0079.html @@ -21,7 +21,7 @@ - - @@ -123,6 +123,7 @@
    Table 5 package parameters

    Parameter

    Mandatory

    No

    InputParams structure

    +

    Object

    Input parameters in apis, described in JSON Schema format. For details, see Table 11.

    No

    OutputParams structure

    +

    Object

    Output parameters in apis, described in JSON Schema format. For details, see Table 12.

    String

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

    +

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

    String

    Model source. Options:

    -
    • algos: built-in algorithm
    • custom: custom model
    +
    • auto: ExeML
    • algos: built-in algorithm
    • custom: custom model

    tunable

    @@ -316,7 +316,8 @@

    String array

    Model deployment type, determining which service a model can be deployed as. The example value is real-time (real-time service).

    +

    Model deployment type, determining which service a model can be deployed as. Possible values are real-time (real-time service) and batch (batch service).

    +

    Model deployment type, determining which service a model can be deployed as. The example value is real-time (real-time service).

    subscription_id

    @@ -335,7 +336,7 @@

    specification

    Specification structure

    +

    Object

    Minimum deployment specifications. For details, see Table 5.

    String

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

    +

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

    model_id

    @@ -222,7 +222,7 @@

    String

    Model source. Options:

    -
    • algos: built-in algorithm
    • custom: custom model
    +
    • auto: ExeML
    • algos: built-in algorithm
    • custom: custom model

    tunable

    @@ -258,7 +258,7 @@

    health

    Health structure

    +

    Object

    Model health check interface information. For details, see Table 8.

    labels_map

    Map

    +

    Object

    Model label map. The key is fixed to labels, and the value is the model label array.

    specification

    Specification structure

    +

    Object

    Minimum model deployment specifications. For details, see Table 9.

    String

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

    +

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

    model_id

    @@ -140,10 +140,12 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0081.html b/docs/modelarts/api-ref/modelarts_03_0081.html index c8172a11b..91d6fded1 100644 --- a/docs/modelarts/api-ref/modelarts_03_0081.html +++ b/docs/modelarts/api-ref/modelarts_03_0081.html @@ -22,6 +22,8 @@ + diff --git a/docs/modelarts/api-ref/modelarts_03_0082.html b/docs/modelarts/api-ref/modelarts_03_0082.html index f8047c2d6..be6d0955b 100644 --- a/docs/modelarts/api-ref/modelarts_03_0082.html +++ b/docs/modelarts/api-ref/modelarts_03_0082.html @@ -1,7 +1,7 @@

    Deploying a Model as a Service

    -

    Function

    This API is used to deploy a model as a service.

    +

    Function

    This API is used to deploy a model as a service.

    URI

    POST /v1/{project_id}/services

    Table 1 describes the required parameters. @@ -21,7 +21,7 @@

    String

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

    +

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

    config array corresponding to infer_type

    Model running configuration. If infer_type is batch, you can configure only one model. If infer_type is real-time, you can configure multiple models and assign weights based on service requirements. However, the versions of these models cannot be the same.

    +
    • If infer_type is set to real-time, see Table 3.
    • If infer_type is set to batch, see Table 4.

    schedule

    @@ -138,7 +139,7 @@
    -
    Table 3 config parameters of real-time

    Parameter

    +
    @@ -179,7 +180,7 @@ - @@ -216,7 +217,7 @@
    Table 3 config parameters of real-time

    Parameter

    Mandatory

    No

    custom_spec structure

    +

    Object

    Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see Table 6.

    -
    Table 4 config parameters of batch

    Parameter

    +
    @@ -241,7 +242,7 @@ - - - @@ -473,6 +473,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - - -
    Table 4 config parameters of batch

    Parameter

    Mandatory

    String

    Resource flavor. Available options: modelarts.vm.cpu.2u and modelarts.vm.gpu.p4

    +

    Resource flavor. Options: modelarts.vm.cpu.2u and modelarts.vm.gpu.p4

    instance_count

    @@ -269,7 +270,7 @@

    String

    Data source type. This parameter can be set to ManifestFile. By default, this parameter is left blank, indicating that only files in the src_path directory are read. If this parameter is set to ManifestFile, src_path must be a specific Manifest file path. You can specify multiple data paths in the Manifest file.

    +

    Data source type. This parameter can be set to ManifestFile. By default, this parameter is left blank, indicating that only files in the src_path directory are read. If this parameter is set to ManifestFile, src_path must be a specific manifest file path. You can specify multiple data paths in the manifest file.

    src_path

    @@ -535,6 +536,70 @@ "mapping_type": "file" }] } +
  • Sample request: Creating a batch service and setting mapping_type to csv
    {
    +"service_name": "batchservicetest",
    +"description": "",
    +"infer_type": "batch",
    +"config": [{
    +    "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2",
    +    "specification": "modelarts.vm.cpu.2u",
    +    "instance_count": 1,
    +    "src_path": "https://infers-data.obs.xxxx.com/xgboosterdata/",
    +    "dest_path": "https://infers-data.obs.xxxx.com.com/output/",
    +    "req_uri": "/",
    +    "mapping_type": "csv",
    +    "mapping_rule": {
    +        "type": "object",
    +        "properties": {
    +            "data": {
    +                "type": "object",
    +                "properties": {
    +                    "req_data": {
    +                        "type": "array",
    +                        "items": [{
    +                            "type": "object",
    +                            "properties": {
    +                                "input5": {
    +                                    "type": "number",
    +                                    "index": 0
    +                                },
    +                                "input4": {
    +                                    "type": "number",
    +                                    "index": 1
    +                                },
    +                                "input3": {
    +                                    "type": "number",
    +                                    "index": 2
    +                                },
    +                                "input2": {
    +                                    "type": "number",
    +                                    "index": 3
    +                                },
    +                                "input1": {
    +                                    "type": "number",
    +                                    "index": 4
    +                                }
    +                            }
    +                        }]
    +                    }
    +                }
    +            }
    +        }
    +    }
    +}]
    +}
    +
    The format of the inference request body described in mapping_rule is as follows:
    {
    +"data": {
    +    "req_data": [{
    +        "input1": 1,
    +        "input2": 2,
    +        "input3": 3,
    +        "input4": 4,
    +        "input5": 5
    +    }]
    +}
    +}
    +
    • Sample response
      {
         "service_id": "10eb0091-887f-4839-9929-cbc884f1e20e",
      @@ -543,6 +608,8 @@
       

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +

    String

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

    +

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

    String

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

    +

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

    service_id

    @@ -102,7 +102,7 @@

    String

    Inference type, which can be real-time, edge,

    +

    Inference type, which can be real-time, edge, or batch

    workspace_id

    @@ -165,7 +165,8 @@

    config array corresponding to infer_type

    Service configuration (If a service is shared, only model_id, model_name, and model_version are returned.)

    +

    Service configuration (If a service is shared, only model_id, model_name, and model_version are returned.)

    +
    • If infer_type is set to real-time, see Table 3.
    • If infer_type is set to batch, see Table 4.

    access_address

    @@ -270,7 +271,7 @@
    -
    Table 3 config parameters of real-time

    Parameter

    +
    @@ -303,7 +304,7 @@ - - - -
    Table 3 config parameters of real-time

    Parameter

    Type

    String

    Model source. This parameter is returned when a model is created through ExeML. The value is auto.

    +

    Model source. This parameter is returned when a model is created through ExeML. The value is auto.

    status

    @@ -325,14 +326,14 @@

    String

    Resource flavor. Options: modelarts.vm.cpu.2u, modelarts.vm.gpu.p4, and modelarts.vm.ai1.a310

    +

    Resource flavor. Options: modelarts.vm.cpu.2u, modelarts.vm.gpu.p4, and modelarts.vm.ai1.a310Options: modelarts.vm.gpu.v100 and modelarts.vm.cpu.2u To use other flavors, contact the system administrator.

    custom_spec

    custom_spec structure

    +

    Object

    Custom

    +

    Custom For details, see Table 7.

    envs

    @@ -382,7 +383,7 @@
    -
    Table 4 config parameters of batch

    Parameter

    +
    @@ -415,14 +416,14 @@ - - -
    Table 4 config parameters of batch

    Parameter

    Type

    String

    Resource flavor. Options: modelarts.vm.cpu.2u, modelarts.vm.gpu.p4, and modelarts.vm.ai1.a310

    +

    Resource flavor. Options: modelarts.vm.cpu.2u, modelarts.vm.gpu.p4, and modelarts.vm.ai1.a310Options: modelarts.vm.gpu.v100 and modelarts.vm.cpu.2u To use other flavors, contact the system administrator

    custom_spec

    custom_spec structure

    +

    Object

    Custom

    +

    Custom For details, see Table 7.

    envs

    @@ -688,7 +689,7 @@
    -
    Table 7 custom_spec parameters

    Parameter

    +
    @@ -772,6 +773,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    -
    Table 7 custom_spec parameters

    Parameter

    Type

    String

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

    +

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

    service_id

    @@ -74,6 +74,7 @@

    config array corresponding to infer_type

    Service configuration. If this parameter is not set, the service is not updated. The model service is modified and the update_time parameter is returned only for requests with config updated.

    +
    • If infer_type is set to real-time, see Table 3.
    • If infer_type is set to batch, see Table 4.

    schedule

    @@ -98,186 +99,186 @@
    -
    Table 3 config parameters of real-time

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 config parameters of real-time

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    model_id

    +

    model_id

    Yes

    +

    Yes

    String

    +

    String

    Model ID

    +

    Model ID

    weight

    +

    weight

    Yes

    +

    Yes

    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.

    specification

    +

    specification

    Yes

    +

    Yes

    String

    +

    String

    Resource specifications. Select specifications based on service requirements.

    +

    Resource specifications. Select specifications based on service requirements.

    custom_spec

    +

    custom_spec

    No

    +

    No

    custom_spec structure

    +

    Object

    Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see Table 6.

    +

    Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see Table 6.

    instance_count

    +

    instance_count

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of instances deployed in a model. The value must be greater than 0.

    +

    Number of instances for deploying a model. The value must be greater than 0.

    envs

    +

    envs

    No

    +

    No

    Map<String, String>

    +

    Map<String, String>

    (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.

    +

    (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.

    cluster_id

    +

    cluster_id

    No

    +

    No

    string

    +

    string

    ID of a dedicated resource pool. By default, this parameter is left blank, indicating that no dedicated resource pool is used.

    +

    ID of a dedicated resource pool. By default, this parameter is left blank, indicating that no dedicated resource pool is used.

    -
    Table 4 config parameters of batch

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -289,9 +290,9 @@ - - @@ -299,27 +300,77 @@ - - - - - - + + +
    Table 4 config parameters of batch

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    model_id

    +

    model_id

    Yes

    +

    Yes

    String

    +

    String

    Model ID

    +

    Model ID

    specification

    +

    specification

    Yes

    +

    Yes

    String

    +

    String

    Resource flavor. Available options: modelarts.vm.cpu.2u and modelarts.vm.gpu.p4

    +

    Resource flavor. Options: modelarts.vm.cpu.2u and modelarts.vm.gpu.p4

    instance_count

    +

    instance_count

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of instances deployed in a model.

    +

    Number of instances for deploying a model.

    envs

    +

    envs

    No

    +

    No

    Map<String, String>

    +

    Map<String, String>

    (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank.

    +

    (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.

    src_type

    +

    src_type

    No

    +

    No

    String

    +

    String

    Data source type. This parameter can be set to ManifestFile. By default, this parameter is left blank, indicating that only files in the src_path directory are read. If this parameter is set to ManifestFile, src_path must be a specific Manifest file path. You can specify multiple data paths in the Manifest file.

    +

    Data source type. This parameter can be set to ManifestFile. By default, this parameter is left blank, indicating that only files in the src_path directory are read. If this parameter is set to ManifestFile, src_path must be a specific manifest file path. You can specify multiple data paths in the manifest file.

    src_path

    +

    src_path

    Yes

    +

    Yes

    String

    +

    String

    OBS path of the input data of a batch job

    +

    OBS path of the input data of a batch job

    dest_path

    +

    dest_path

    Yes

    +

    Yes

    String

    +

    String

    OBS path of the output data of a batch job

    +

    OBS path of the output data of a batch job

    req_uri

    +

    req_uri

    Yes

    +

    Yes

    String

    +

    String

    Inference API called in a batch task, which is a REST API in the model image. Select an API URI from the model config.json file for inference. If a ModelArts built-in inference image is used, the value of this parameter is /.

    +

    Inference API called in a batch job, which is a REST API in the model image. Select an API URI from the model config.json file for inference. If a ModelArts built-in inference image is used, the value of this parameter is /.

    mapping_type

    +

    mapping_type

    Yes

    +

    Yes

    String

    +

    String

    Mapping type of the input data. The value can be file or csv.

    -
    • If you select file, each inference request corresponds to a file in the input data path. When this mode is used, req_uri of this model can have only one input parameter and the type of this parameter is file.
    • If you select csv, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and mapping_rule needs to be configured to map the index of each parameter in the inference request body to the CSV file.
    +

    Mapping type of the input data. The value can be file or csv.

    +
    • If you select file, each inference request corresponds to a file in the input data path. When this mode is used, req_uri of this model can have only one input parameter and the type of this parameter is file.
    • If you select csv, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and mapping_rule must be configured to map the index of each parameter in the inference request body to the CSV file.

    mapping_rule

    +

    mapping_rule

    No

    +

    No

    Map

    +

    Map

    Mapping between input parameters and CSV data. This parameter is mandatory only when mapping_type is set to csv.

    -

    Mapping rule: The mapping rule comes from the input parameter (input_params) in the model configuration file config.json. When type is set to string, number, integer, or boolean, you need to configure the index parameter. For details, see .

    -

    The index must be a positive integer starting from 0. If the value of index does not comply with the rule, this parameter is ignored in the request. After the mapping rule is configured, the corresponding CSV data must be separated by commas (,).

    +

    Mapping between input parameters and CSV data. This parameter is mandatory only when mapping_type is set to csv.

    +

    Mapping rule: The mapping rule comes from the input parameter (input_params) in the model configuration file config.json. When type is set to string, number, integer, or boolean, you are required to configure the index parameter. For details, see .

    +

    The index must be a positive integer starting from 0. If the index value does not comply with the rule, this parameter will be ignored in the request. After the mapping rule is configured, the CSV data must be separated by commas (,).

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    String

    +

    String

    Scheduling type. Only the value stop is supported.

    +

    Scheduling type. Only the value stop is supported.

    time_unit

    Yes

    String

    +

    String

    Scheduling time unit. Possible values are DAYS, HOURS, and MINUTES.

    +

    Scheduling time unit. Possible values are DAYS, HOURS, and MINUTES.

    duration

    Yes

    Integer

    +

    Integer

    Value that maps to the time unit. For example, if the task stops after two hours, set time_unit to HOURS and duration to 2.

    +

    Value that maps to the time unit. For example, if the task stops after two hours, set time_unit to HOURS and duration to 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + @@ -346,6 +397,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - - - @@ -51,9 +51,9 @@ - - @@ -64,122 +64,123 @@

    Request Body

    None

    Response Body

    Table 3 describes the response parameters. -
    Table 6 custom_spec parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    cpu

    +

    Yes

    +

    Float

    +

    Number of required CPUs

    +

    memory

    +

    Yes

    +

    Integer

    +

    Required memory capacity, in MB

    +

    gpu_p4

    +

    No

    +

    Float

    +

    Number of GPUs, which can be decimals. This parameter is optional. By default, it is not used.

    +

    ascend_a310

    +

    No

    +

    Integer

    +

    Number of NPUs, which can be decimals. This parameter is optional. By default, it is not used.

    String

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

    +

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

    service_id

    @@ -41,9 +41,9 @@

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    No

    String

    +

    String

    ID of the node to be queried. By default, all nodes are queried.

    +

    ID of the node to be queried. By default, all nodes are queried.

    Table 3 Parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 3 Parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    service_id

    +

    service_id

    String

    +

    String

    Service ID

    +

    Service ID

    service_name

    +

    service_name

    String

    +

    String

    Service name

    +

    Service name

    monitors

    +

    monitors

    monitor array corresponding to infer_type of a service

    +

    monitor array corresponding to infer_type of a service

    Monitoring details

    +

    Monitoring details

    +
    • If infer_type is set to real-time, see Table 4.
    -
    Table 4 monitor parameters of real-time

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - @@ -212,6 +213,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    - - -
    Table 4 monitor parameters of real-time

    Parameter

    Type

    Description

    +

    Description

    model_id

    +

    model_id

    String

    Model ID

    +

    Model ID

    model_name

    +

    model_name

    String

    Model name

    +

    Model name

    model_version

    +

    model_version

    String

    Model version

    +

    Model version

    invocation_times

    +

    invocation_times

    Long

    Total number of model instance calls

    +

    Total number of model instance calls

    failed_times

    +

    failed_times

    Long

    Number of failed model instance calls

    +

    Number of failed model instance calls

    cpu_core_usage

    +

    cpu_core_usage

    Float

    Number of used CPUs

    +

    Number of used CPUs

    cpu_core_total

    +

    cpu_core_total

    Float

    Total number of CPUs

    +

    Total number of CPUs

    cpu_memory_usage

    +

    cpu_memory_usage

    Integer

    Used memory, in MB

    +

    Used memory, in MB

    cpu_memory_total

    +

    cpu_memory_total

    Integer

    Total memory, in MB

    +

    Total memory, in MB

    gpu_usage

    +

    gpu_usage

    Float

    Number used GPUs

    +

    Number used GPUs

    gpu_total

    +

    gpu_total

    Float

    Total number of GPUs

    +

    Total number of GPUs

    String

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

    +

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

    service_id

    @@ -197,9 +197,9 @@

    custom_spec

    Float

    +

    Object

    Custom specifications.

    +

    Custom specifications. For details, see Table 6.

    instance_count

    @@ -268,7 +268,7 @@
    -
    Table 6 custom_spec parameters

    Parameter

    +
    @@ -337,6 +337,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    -
    Table 6 custom_spec parameters

    Parameter

    Type

    String

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

    +

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

    service_id

    @@ -50,6 +50,8 @@

    Status Code

    For details about the status code, see Table 1.

    +

    Error Codes

    See Error Codes.

    +
    diff --git a/docs/modelarts/api-ref/modelarts_03_0095.html b/docs/modelarts/api-ref/modelarts_03_0095.html index df05515b7..0a95a4915 100644 --- a/docs/modelarts/api-ref/modelarts_03_0095.html +++ b/docs/modelarts/api-ref/modelarts_03_0095.html @@ -2,6220 +2,6221 @@

    Error Codes

    -

    Status Code

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modelarts/api-ref/modelarts_03_0097.html b/docs/modelarts/api-ref/modelarts_03_0097.html index 1e284f54c..082758443 100644 --- a/docs/modelarts/api-ref/modelarts_03_0097.html +++ b/docs/modelarts/api-ref/modelarts_03_0097.html @@ -2,15 +2,15 @@

    Change History

    -

    Status Code

    Error Codes

    +

    Error Codes

    Error Message

    +

    Error Message

    Description

    +

    Description

    Solution

    +

    Solution

    400

    +

    400

    ModelArts.0104

    +

    ModelArts.0104

    Parameter error.

    +

    Parameter error.

    Parameter error.

    +

    Parameter error.

    Check the parameter settings.

    +

    Check the parameter settings.

    400

    +

    400

    ModelArts.0113

    +

    ModelArts.0113

    Create Notebook failed. Quota: {} is exhausted.

    +

    Create Notebook failed. Quota: {} is exhausted.

    Failed to create the notebook instance due to the exhausted quota.

    +

    Failed to create the notebook instance due to the exhausted quota.

    Contact the administrator for a higher quota.

    +

    Contact the system administrator for a higher quota.

    400

    +

    400

    ModelArts.6301

    +

    ModelArts.6301

    The instance already exists.

    +

    The instance already exists.

    The instance already exists.

    +

    The instance already exists.

    Enter another instance name.

    +

    Enter another instance name.

    400

    +

    400

    ModelArts.6302

    +

    ModelArts.6302

    The instance count already reaches the maximum value.

    +

    The instance count already reaches the maximum value.

    The maximum number of instances has been reached.

    +

    The maximum number of instances has been reached.

    Delete unnecessary instances.

    +

    Delete unnecessary instances.

    400

    +

    400

    ModelArts.6303

    +

    ModelArts.6303

    The field does not support sorting.

    +

    The field does not support sorting.

    This field does not support sorting.

    +

    This field does not support sorting.

    Delete the field from the sorting parameters.

    +

    Delete the field from the sorting parameters.

    400

    +

    400

    ModelArts.6304

    +

    ModelArts.6304

    Please stop the instance before deleting.

    +

    Please stop the instance before deleting.

    Failed to delete the instance in the running state.

    +

    Failed to delete the instance in the running state.

    Refresh the page. Stop the instance and then delete it.

    +

    Refresh the page. Stop the instance and then delete it.

    400

    +

    400

    ModelArts.6305

    +

    ModelArts.6305

    The instance is already running.

    +

    The instance is already running.

    The instance is in the running state.

    +

    The instance is in the running state.

    Do not start it again.

    +

    Do not start it again.

    400

    +

    400

    ModelArts.6306

    +

    ModelArts.6306

    The instance is starting.

    +

    The instance is starting.

    Other operations cannot be performed because the instance is being started.

    +

    Other operations cannot be performed because the instance is being started.

    Perform other operations later.

    +

    Perform other operations later.

    400

    +

    400

    ModelArts.6307

    +

    ModelArts.6307

    The instance has already been stopped.

    +

    The instance has already been stopped.

    The instance has been stopped.

    +

    The instance has been stopped.

    Refresh the page and view the instance state.

    +

    Refresh the page and view the instance state.

    400

    +

    400

    ModelArts.6308

    +

    ModelArts.6308

    The instance is stopping.

    +

    The instance is stopping.

    The instance is being stopped.

    +

    The instance is being stopped.

    Refresh the page and view the instance state.

    +

    Refresh the page and view the instance state.

    400

    +

    400

    ModelArts.6309

    +

    ModelArts.6309

    The instance does not exist.

    +

    The instance does not exist.

    The instance does not exist.

    +

    The instance does not exist.

    Ensure that the instance has been deleted.

    +

    Ensure that the instance has been deleted.

    400

    +

    400

    ModelArts.6316

    +

    ModelArts.6316

    The param 'storage' is needed for creating notebook instance.

    +

    The param 'storage' is needed for creating notebook instance.

    Incorrect parameters during instance creation.

    +

    Incorrect parameters during instance creation.

    Add the storage parameter.

    +

    Add the storage parameter.

    400

    +

    400

    ModelArts.6317

    +

    ModelArts.6317

    The 'path' parameter is required when the storage type is OBS.

    +

    The 'path' parameter is required when the storage type is OBS.

    Incorrect parameters during instance creation.

    +

    Incorrect parameters during instance creation.

    Add the path parameter.

    +

    Add the path parameter.

    400

    +

    400

    ModelArts.6318

    +

    ModelArts.6318

    The param 'path' needs to end with /.

    +

    The param 'path' needs to end with /.

    Incorrect parameters during instance creation.

    +

    Incorrect parameters during instance creation.

    Ensure that the value of the path parameter ends with a slash (/).

    +

    Ensure that the value of the path parameter ends with a slash (/).

    400

    +

    400

    ModelArts.6319

    +

    ModelArts.6319

    There is no ak/sk in the global settings. Please add it by access ModelArts console.

    +

    There is no ak/sk in the global settings. Please add it by access ModelArts console.

    The AK/SK have not been configured in the global settings of ModelArts.

    +

    The AK/SK have not been configured in the global settings of ModelArts.

    Configure the AK/SK in the global settings of ModelArts.

    +

    Configure the AK/SK in the global settings of ModelArts.

    400

    +

    400

    ModelArts.6320

    +

    ModelArts.6320

    Access obs error. Reason is {}.

    +

    Access obs error. Reason is {}.

    OBS access error.

    +

    OBS access error.

    Ensure that the OBS path is correct.

    +

    Ensure that the OBS path is correct.

    400

    +

    400

    ModelArts.6323

    +

    ModelArts.6323

    The flavor is not supported, please check it.

    +

    The flavor is not supported, please check it.

    The flavor is not supported.

    +

    The flavor is not supported.

    Ensure that the flavor is correctly configured.

    +

    Ensure that the flavor is correctly configured.

    400

    +

    400

    ModelArts.6324

    +

    ModelArts.6324

    This location type is not supported. Please check it.

    +

    This location type is not supported. Please check it.

    The storage type is not supported.

    +

    The storage type is not supported.

    Ensure that the storage type is correctly configured.

    +

    Ensure that the storage type is correctly configured.

    400

    +

    400

    ModelArts.6326

    +

    ModelArts.6326

    The instance is frozen. Check whether your account is in arrears in Billing Center.

    +

    The instance is frozen. Check whether your account is in arrears in Billing Center.

    The instance has been frozen.

    +

    The instance has been frozen.

    Check the account balance and top up the account.

    +

    Check the account balance and top up the account.

    400

    +

    400

    ModelArts.6327

    +

    ModelArts.6327

    The instance is not in running. Please refresh the page and start it.

    +

    The instance is not in running. Please refresh the page and start it.

    The instance is not in the running state.

    +

    The instance is not in the running state.

    Refresh the page and try again.

    +

    Refresh the page and try again.

    400

    +

    400

    ModelArts.6328

    +

    ModelArts.6328

    Sorry, you currently do not have permission for this flavor. Please apply it firstly.

    +

    Sorry, you currently do not have permission for this flavor. Please apply it firstly.

    You do not have permission to use the flavor.

    +

    You do not have permission to use the flavor.

    Contact technical support.

    +

    Contact technical support.

    400

    +

    400

    ModelArts.6329

    +

    ModelArts.6329

    Sorry, this flavor specification is sold out. Please try others.

    +

    Sorry, this flavor specification is sold out. Please try others.

    The flavor is sold out.

    +

    The flavor is sold out.

    Use another flavor or try again later.

    +

    Use another flavor or try again later.

    400

    +

    400

    ModelArts.6330

    +

    ModelArts.6330

    The flavor type of profile does not match the type of flavor. Please check it.

    +

    The flavor type of profile does not match the type of flavor. Please check it.

    The types are not matched.

    +

    The types are not matched.

    Ensure that the flavor type matches the profile type.

    +

    Ensure that the flavor type matches the profile type.

    400

    +

    400

    ModelArts.6331

    +

    ModelArts.6331

    The evs volume size ranges from {} GB to {} GB.

    +

    The evs volume size ranges from {} GB to {} GB.

    The EVS disk size exceeds the upper limit.

    +

    The EVS disk size exceeds the upper limit.

    Check the EVS disk size.

    +

    Check the EVS disk size.

    400

    +

    400

    ModelArts.6332

    +

    ModelArts.6332

    Incorrect parameter type. The '{}' parameter must be of the '{}' type.

    +

    Incorrect parameter type. The '{}' parameter must be of the '{}' type.

    Parameter type error.

    +

    Parameter type error.

    Ensure that the parameter type meets the requirements.

    +

    Ensure that the parameter type meets the requirements.

    400

    +

    400

    ModelArts.6333

    +

    ModelArts.6333

    The notebook is being restored. Refresh the page and wait for several minutes. The fault may be caused by instance overload.

    +

    The notebook is being restored. Refresh the page and wait for several minutes. The fault may be caused by instance overload.

    Notebook instance fault.

    +

    Notebook instance fault.

    The instance is recovering. Try again later.

    +

    The instance is recovering. Try again later.

    400

    +

    400

    ModelArts.6334

    +

    ModelArts.6334

    Invalid value for name or description. The character `{}` is not allowed.

    +

    Invalid value for name or description. The character `{}` is not allowed.

    The description parameter is incorrect.

    +

    The description parameter is incorrect.

    Enter a valid description value.

    +

    Enter a valid description value.

    400

    +

    400

    ModelArts.6335

    +

    ModelArts.6335

    '{}' is a required property.

    +

    '{}' is a required property.

    Parameter missing.

    +

    Parameter missing.

    Ensure that the corresponding parameter is available.

    +

    Ensure that the corresponding parameter is available.

    400

    +

    400

    ModelArts.6336

    +

    ModelArts.6336

    '{}' property value is incorrect.

    +

    '{}' property value is incorrect.

    Incorrect parameter value.

    +

    Incorrect parameter value.

    Ensure that the corresponding parameter is correct.

    +

    Ensure that the corresponding parameter is correct.

    400

    +

    400

    ModelArts.6341

    +

    ModelArts.6341

    The repository does not exist or has been deleted.

    +

    The repository does not exist or has been deleted.

    The Git repository does not exist or has been deleted.

    +

    The Git repository does not exist or has been deleted.

    Check the corresponding parameter.

    +

    Check the corresponding parameter.

    400

    +

    400

    ModelArts.6343

    +

    ModelArts.6343

    The repository name already exists.

    +

    The repository name already exists.

    The Git repository already exists.

    +

    The Git repository already exists.

    Check the corresponding parameter.

    +

    Check the corresponding parameter.

    400

    +

    400

    ModelArts.6344

    +

    ModelArts.6344

    Delete failed. Please delete the associated development environment instance first.

    +

    Delete failed. Please delete the associated development environment instance first.

    Failed to delete the repository.

    +

    Failed to delete the repository.

    Delete the corresponding notebook instance first.

    +

    Delete the corresponding notebook instance first.

    400

    +

    400

    ModelArts.6345

    +

    ModelArts.6345

    Currently the OBS type instance does not support git capability.

    +

    Currently the OBS type instance does not support git capability.

    The Git repository cannot be used for OBS instances.

    +

    The Git repository cannot be used for OBS instances.

    Use notebook instances of the EVS type.

    +

    Use notebook instances of the EVS type.

    400

    +

    400

    ModelArts.6346

    +

    ModelArts.6346

    The timestamp of auto stop must be later than the current timestamp.

    +

    The timestamp of auto stop must be later than the current timestamp.

    This parameter cannot be modified.

    +

    This parameter cannot be modified.

    Check the corresponding parameter and ensure that the automatic end time is later than the current time.

    +

    Check the corresponding parameter and ensure that the automatic end time is later than the current time.

    400

    +

    400

    ModelArts.6347

    +

    ModelArts.6347

    When the instance is in the '{}' status, the '{}' parameter cannot be modified.

    +

    When the instance is in the '{}' status, the '{}' parameter cannot be modified.

    Failed to modify the parameter.

    +

    Failed to modify the parameter.

    Check the corresponding parameter.

    +

    Check the corresponding parameter.

    400

    +

    400

    ModelArts.6348

    +

    ModelArts.6348

    The 'duration' parameter is mandatory for enabling auto stop.

    +

    The 'duration' parameter is mandatory for enabling auto stop.

    The description parameter is missing.

    +

    The description parameter is missing.

    Configure the duration parameter.

    +

    Configure the duration parameter.

    400

    +

    400

    ModelArts.6349

    +

    ModelArts.6349

    The 'duration' parameter is incorrect. The value ranges from {} to {}.

    +

    The 'duration' parameter is incorrect. The value ranges from {} to {}.

    The value of duration parameter exceeds the threshold.

    +

    The value of duration parameter exceeds the threshold.

    Configure the duration parameter.

    +

    Configure the duration parameter.

    400

    +

    400

    ModelArts.6350

    +

    ModelArts.6350

    Failed to access OBS because of incorrect AK/SK or insufficient permissions.

    +

    Failed to access OBS because of incorrect AK/SK or insufficient permissions.

    Access to OBS is rejected.

    +

    Access to OBS is rejected.

    Ensure that the AK/SK is correct and you have the permission to access OBS.

    +

    Ensure that the AK/SK is correct and you have the permission to access OBS.

    400

    +

    400

    ModelArts.6353

    +

    ModelArts.6353

    Failed to verify the AK/SK. Please check and try again.

    +

    Failed to verify the AK/SK. Please check and try again.

    Incorrect AK/SK.

    +

    Incorrect AK/SK.

    Ensure that the AK/SK in the global settings of ModelArts is correct.

    +

    Ensure that the AK/SK in the global settings of ModelArts is correct.

    400

    +

    400

    ModelArts.6354

    +

    ModelArts.6354

    The AK/SK do not belong to the user. Please check and enter the correct ones.

    +

    The AK/SK do not belong to the user. Please check and enter the correct ones.

    Incorrect AK/SK.

    +

    Incorrect AK/SK.

    Ensure that the AK/SK in the global settings of ModelArts is correct.

    +

    Ensure that the AK/SK in the global settings of ModelArts is correct.

    400

    +

    400

    ModelArts.6355

    +

    ModelArts.6355

    The resource is initializing. Please wait one minute and try again.

    +

    The resource is initializing. Please wait one minute and try again.

    Resources in the dedicated resource pool are being initialized.

    +

    Resources in the dedicated resource pool are being initialized.

    Try again later.

    +

    Try again later.

    400

    +

    400

    ModelArts.6357

    +

    ModelArts.6357

    The operation is not allowed because another operation is being performed on the instance or the instance is in the target state.

    +

    The operation is not allowed because another operation is being performed on the instance or the instance is in the target state.

    The operation is not allowed.

    +

    The operation is not allowed.

    Try again later.

    +

    Try again later.

    400

    +

    400

    ModelArts.6358

    +

    ModelArts.6358

    The path parameter is incorrect. It cannot be the root directory of an OBS bucket, but must be a specific directory in the OBS bucket.

    +

    The path parameter is incorrect. It cannot be the root directory of an OBS bucket, but must be a specific directory in the OBS bucket.

    The OBS path parameter is incorrect.

    +

    The OBS path parameter is incorrect.

    Ensure that the path parameter is correct.

    +

    Ensure that the path parameter is correct.

    400

    +

    400

    ModelArts.6361

    +

    ModelArts.6361

    ModelArts internal service or configuration error. Submit a service ticket to get professional technical support.

    +

    ModelArts internal service or configuration error. Submit a service ticket to get professional technical support.

    Internal error.

    +

    Internal error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    400

    +

    400

    ModelArts.6371

    +

    ModelArts.6371

    Currently, notebooks support only OBS buckets whose Storage Class is Standard. Change the OBS bucket and try again.

    +

    Currently, notebooks support only OBS buckets whose Storage Class is Standard. Change the OBS bucket and try again.

    Notebook instances support only standard OBS buckets.

    +

    Notebook instances support only standard OBS buckets.

    Use standard OBS buckets.

    +

    Use standard OBS buckets.

    400

    +

    400

    ModelArts.6374

    +

    ModelArts.6374

    The credential can be added only when type is set to AK/SK or agency.

    +

    The credential can be added only when type is set to AK/SK or agency.

    The authentication type can only be AK/SK or agency.

    +

    The authentication type can only be AK/SK or agency.

    Ensure that the authentication type is AK/SK or agency.

    +

    Ensure that the authentication type is AK/SK or agency.

    400

    +

    400

    ModelArts.6376

    +

    ModelArts.6376

    Please make sure agency exists.

    +

    Please make sure agency exists.

    The IAM agency does not exist.

    +

    The IAM agency does not exist.

    Ensure that the agency exists on IAM.

    +

    Ensure that the agency exists on IAM.

    400

    +

    400

    ModelArts.6377

    +

    ModelArts.6377

    The user id cannot be left blank.

    +

    The user id cannot be left blank.

    The user ID cannot be left blank.

    +

    The user ID cannot be left blank.

    Ensure that the user ID parameter is available.

    +

    Ensure that the user ID parameter is available.

    400

    +

    400

    ModelArts.6378

    +

    ModelArts.6378

    The agency name cannot be left blank.

    +

    The agency name cannot be left blank.

    The agency name cannot be left blank.

    +

    The agency name cannot be left blank.

    Ensure that the agency name parameter is available.

    +

    Ensure that the agency name parameter is available.

    400

    +

    400

    ModelArts.6379

    +

    ModelArts.6379

    No IAM agency created in Settings. Create an IAM agency on the ModelArts management console.

    +

    No IAM agency created in Settings. Create an IAM agency on the ModelArts management console.

    No agency is created in the global settings.

    +

    No agency is created in the global settings.

    Create an agency in the global settings.

    +

    Create an agency in the global settings.

    400

    +

    400

    ModelArts.6528

    +

    ModelArts.6528

    No EVS available. Please try again later.

    +

    No EVS available. Please try again later.

    The EVS disk has been sold out.

    +

    The EVS disk has been sold out.

    Try again later or contact technical support.

    +

    Try again later or contact technical support.

    401

    +

    401

    ModelArts.6201

    +

    ModelArts.6201

    The user's account has been suspended.

    +

    The user's account has been suspended.

    The user account is frozen.

    +

    The user account is frozen.

    Check the account balance and top up the account.

    +

    Check the account balance and top up the account.

    401

    +

    401

    ModelArts.6203

    +

    ModelArts.6203

    The user's account has been restricted.

    +

    The user's account has been restricted.

    The user account is restricted.

    +

    The user account is restricted.

    Check the account balance and top up the account.

    +

    Check the account balance and top up the account.

    403

    +

    403

    ModelArts.0112

    +

    ModelArts.0112

    Policy doesn't allow {} {} to be performed.

    +

    Policy doesn't allow {} {} to be performed.

    The permission on the workspace is restricted.

    +

    The permission on the workspace is restricted.

    Ensure that you have the permission on the workspace.

    +

    Ensure that you have the permission on the workspace.

    408

    +

    408

    ModelArts.6100

    +

    ModelArts.6100

    The request timed out. Please try again.

    +

    The request timed out. Please try again.

    Timeout.

    +

    Timeout.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    429

    +

    429

    ModelArts.6101

    +

    ModelArts.6101

    The system is busy now. Please try again later.

    +

    The system is busy now. Please try again later.

    The system is busy.

    +

    The system is busy.

    The system is busy. Please try again. If the retry still fails, contact technical support.

    +

    The system is busy. Please try again. If the retry still fails, contact technical support.

    500

    +

    500

    ModelArts.6102

    +

    ModelArts.6102

    The server has encountered an error and fails to process the request. Please try again later or submit a service ticket.

    +

    The server has encountered an error and fails to process the request. Please try again later or submit a service ticket.

    Internal error.

    +

    Internal error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.6200

    +

    ModelArts.6200

    No resources available. Please try again later or submit a service ticket.

    +

    No resources available. Please try again later or submit a service ticket.

    Internal error.

    +

    Internal error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    400

    +

    400

    ModelArts.6600

    +

    ModelArts.6600

    Check whether the parameter is valid.

    +

    Check whether the parameter is valid.

    Failed to verify the parameters.

    +

    Failed to verify the parameters.

    Ensure that the parameter is valid.

    +

    Ensure that the parameter is valid.

    400

    +

    400

    ModelArts.6651

    +

    ModelArts.6651

    Unsupport entity.

    +

    Unsupport entity.

    Unsupported project objects.

    +

    Unsupported project objects.

    Ensure that the project object is supported.

    +

    Ensure that the project object is supported.

    400

    +

    400

    ModelArts.6652

    +

    ModelArts.6652

    Please delete resources from the project first.

    +

    Please delete resources from the project first.

    Failed to delete the project resources.

    +

    Failed to delete the project resources.

    Delete the datasets and notebook instances under the project and ensure that all training jobs have been completed.

    +

    Delete the datasets and notebook instances under the project and ensure that all training jobs have been completed.

    400

    +

    400

    ModelArts.6690

    +

    ModelArts.6690

    The image size cannot exceed 8 MB.

    +

    The image size cannot exceed 8 MB.

    The image size exceeds 8 MB.

    +

    The image size exceeds 8 MB.

    Ensure that the image size does not exceed 8 MB.

    +

    Ensure that the image size does not exceed 8 MB.

    401

    +

    401

    ModelArts.6608

    +

    ModelArts.6608

    Please refresh user info.

    +

    Please refresh user info.

    Failed to obtain the user information.

    +

    Failed to obtain the user information.

    Refresh the user information.

    +

    Refresh the user information.

    401

    +

    401

    ModelArts.6620

    +

    ModelArts.6620

    Please refresh the user token.

    +

    Please refresh the user token.

    Invalid user token.

    +

    Invalid user token.

    Refresh the user token.

    +

    Refresh the user token.

    403

    +

    403

    ModelArts.6653

    +

    ModelArts.6653

    Contact the project owner.

    +

    Contact the project owner.

    You are not authorized to operate the project.

    +

    You are not authorized to operate the project.

    Contact the project owner to obtain the authorization.

    +

    Contact the project owner to obtain the authorization.

    404

    +

    404

    ModelArts.6623

    +

    ModelArts.6623

    Ensure that the dataset already exists.

    +

    Ensure that the dataset already exists.

    Failed to find the corresponding dataset.

    +

    Failed to find the corresponding dataset.

    Ensure that the dataset already exists.

    +

    Ensure that the dataset already exists.

    404

    +

    404

    ModelArts.6624

    +

    ModelArts.6624

    Ensure that the storage path already exists.

    +

    Ensure that the storage path already exists.

    Failed to find the corresponding storage path.

    +

    Failed to find the corresponding storage path.

    Ensure that the storage path already exists.

    +

    Ensure that the storage path already exists.

    404

    +

    404

    ModelArts.6650

    +

    ModelArts.6650

    Ensure that the project already exists.

    +

    Ensure that the project already exists.

    Failed to find the corresponding project.

    +

    Failed to find the corresponding project.

    Ensure that the project already exists.

    +

    Ensure that the project already exists.

    404

    +

    404

    ModelArts.6655

    +

    ModelArts.6655

    Can't find ai project template.

    +

    Can't find ai project template.

    Failed to find the corresponding project template.

    +

    Failed to find the corresponding project template.

    Ensure that the corresponding project template already exists.

    +

    Ensure that the corresponding project template already exists.

    417

    +

    417

    ModelArts.6654

    +

    ModelArts.6654

    Project with the same name already exists.

    +

    Project with the same name already exists.

    A project with the same name already exists.

    +

    A project with the same name already exists.

    Use another project name.

    +

    Use another project name.

    500

    +

    500

    ModelArts.6691

    +

    ModelArts.6691

    System error. Check the service status.

    +

    System error. Check the service status.

    The algorithm service is abnormal.

    +

    The algorithm service is abnormal.

    System error. Check the service state.

    +

    System error. Check the service state.

    500

    +

    500

    ModelArts.6692

    +

    ModelArts.6692

    System error. Check the service status.

    +

    System error. Check the service status.

    The dataset service is abnormal.

    +

    The dataset service is abnormal.

    System error. Check the service state.

    +

    System error. Check the service state.

    500

    +

    500

    ModelArts.6699

    +

    ModelArts.6699

    Internal error.

    +

    Internal error.

    Network error.

    +

    Network error.

    Check network connectivity.

    +

    Check network connectivity.

    400

    +

    400

    ModelArts.4205

    +

    ModelArts.4205

    A subdirectory must be specified as the dataset input or output path.

    +

    A subdirectory must be specified as the dataset input or output path.

    A subdirectory must be specified as the dataset input or output path.

    +

    A subdirectory must be specified as the dataset input or output path.

    A subdirectory must be specified as the dataset input or output path.

    +

    A subdirectory must be specified as the dataset input or output path.

    400

    +

    400

    ModelArts.4311

    +

    ModelArts.4311

    OBS bucket does not exist

    +

    OBS bucket does not exist

    The OBS bucket does not exist.

    +

    The OBS bucket does not exist.

    Ensure that the bucket name is correct and that the bucket name exists in OBS.

    +

    Ensure that the bucket name is correct and that the bucket name exists in OBS.

    400

    +

    400

    ModelArts.4312

    +

    ModelArts.4312

    OBS path does not exist

    +

    OBS path does not exist

    Incorrect or invalid bucket name.

    +

    Incorrect or invalid bucket name.

    Ensure that the bucket name is correct and that the bucket name exists in OBS.

    +

    Ensure that the bucket name is correct and that the bucket name exists in OBS.

    400

    +

    400

    ModelArts.4313

    +

    ModelArts.4313

    OBS path is invalid

    +

    OBS path is invalid

    Invalid characters in the OBS path.

    +

    Invalid characters in the OBS path.

    Ensure that the OBS path consists of valid characters, including digits, letters, hyphens (-), underscores (_), slashes (/), and Chinese characters.

    +

    Ensure that the OBS path consists of valid characters, including digits, letters, hyphens (-), underscores (_), slashes (/), and Chinese characters.

    400

    +

    400

    ModelArts.4314

    +

    ModelArts.4314

    Obs error

    +

    Obs error

    OBS access error.

    +

    OBS access error.

    Ensure that you have the permission to access OBS and that the OBS path is valid.

    +

    Ensure that you have the permission to access OBS and that the OBS path is valid.

    400

    +

    400

    ModelArts.4338

    +

    ModelArts.4338

    The resource not exists

    +

    The resource not exists

    The dataset ID or labeling task ID does not exist.

    +

    The dataset ID or labeling task ID does not exist.

    Ensure that the input dataset ID or labeling task ID is correct.

    +

    Ensure that the input dataset ID or labeling task ID is correct.

    400

    +

    400

    ModelArts.4340

    +

    ModelArts.4340

    Import path does not contain valid file

    +

    Import path does not contain valid file

    No valid file exists in the import path.

    +

    No valid file exists in the import path.

    Ensure that the file in the OBS path is valid.

    +

    Ensure that the file in the OBS path is valid.

    400

    +

    400

    ModelArts.4342

    +

    ModelArts.4342

    Dataset publish with splitting annotated samples error

    +

    Dataset publish with splitting annotated samples error

    Incorrect splitting for labeled samples.

    +

    Incorrect splitting for labeled samples.

    Ensure that the labeled samples and labels meet splitting criteria.

    +

    Ensure that the labeled samples and labels meet splitting criteria.

    400

    +

    400

    ModelArts.4343

    +

    ModelArts.4343

    Dataset is publishing, the operation is forbidden

    +

    Dataset is publishing, the operation is forbidden

    Do not switch, import, synchronize, or publish a dataset version because there is an ongoing publish task.

    +

    Do not switch, import, synchronize, or publish a dataset version because there is an ongoing publish task.

    Perform the operations after the ongoing publish task is complete.

    +

    Perform the operations after the ongoing publish task is complete.

    400

    +

    400

    ModelArts.4344

    +

    ModelArts.4344

    Dataset is being deleted, annotation is forbidden

    +

    Dataset is being deleted, annotation is forbidden

    No labeling task is allowed because the dataset is being deleted.

    +

    No labeling task is allowed because the dataset is being deleted.

    Ensure that the dataset ID is correct.

    +

    Ensure that the dataset ID is correct.

    400

    +

    400

    ModelArts.4345

    +

    ModelArts.4345

    File not found

    +

    File not found

    The HDFS file does not exist.

    +

    The HDFS file does not exist.

    Ensure that the OBS path is correct and that the file is available in the OBS path.

    +

    Ensure that the OBS path is correct and that the file is available in the OBS path.

    400

    +

    400

    ModelArts.4347

    +

    ModelArts.4347

    List files failed

    +

    List files failed

    Failed to obtain HDFS files.

    +

    Failed to obtain HDFS files.

    Ensure that the OBS path is correct and that the files are available in the OBS path.

    +

    Ensure that the OBS path is correct and that the files are available in the OBS path.

    400

    +

    400

    ModelArts.4349

    +

    ModelArts.4349

    Dataset is switching version, the operation is forbidden

    +

    Dataset is switching version, the operation is forbidden

    Do not switch, import, synchronize, or publish a dataset version because there is an ongoing version switching task.

    +

    Do not switch, import, synchronize, or publish a dataset version because there is an ongoing version switching task.

    Perform the operations after the ongoing version switching task is complete.

    +

    Perform the operations after the ongoing version switching task is complete.

    400

    +

    400

    ModelArts.4350

    +

    ModelArts.4350

    The work_path is too long, please select shorter folder

    +

    The work_path is too long, please select shorter folder

    The value of work_path exceeded the limit.

    +

    The value of work_path exceeded the limit.

    Change the value of work_path to a valid one.

    +

    Change the value of work_path to a valid one.

    400

    +

    400

    ModelArts.4351

    +

    ModelArts.4351

    Dataset already exists

    +

    Dataset already exists

    A dataset whose name is the value of dataset_name already exists.

    +

    A dataset whose name is the value of dataset_name already exists.

    Change the value of dataset_name.

    +

    Change the value of dataset_name.

    400

    +

    400

    ModelArts.4352

    +

    ModelArts.4352

    Dataset does not exist

    +

    Dataset does not exist

    The dataset ID does not exist.

    +

    The dataset ID does not exist.

    Ensure that the imported dataset ID is correct.

    +

    Ensure that the imported dataset ID is correct.

    400

    +

    400

    ModelArts.4353

    +

    ModelArts.4353

    Dataset version does not exist

    +

    Dataset version does not exist

    The dataset version ID does not exist.

    +

    The dataset version ID does not exist.

    Check dataset version parameters.

    +

    Check dataset version parameters.

    400

    +

    400

    ModelArts.4355

    +

    ModelArts.4355

    Sync data source task exist

    +

    Sync data source task exist

    A data synchronization task is being executed for the dataset.

    +

    A data synchronization task is being executed for the dataset.

    Perform the operations after the ongoing data synchronization task is complete.

    +

    Perform the operations after the ongoing data synchronization task is complete.

    400

    +

    400

    ModelArts.4356

    +

    ModelArts.4356

    Dataset already has running import task

    +

    Dataset already has running import task

    A data import task is being executed for the dataset.

    +

    A data import task is being executed for the dataset.

    Perform the operations after the ongoing data import task is complete.

    +

    Perform the operations after the ongoing data import task is complete.

    400

    +

    400

    ModelArts.4357

    +

    ModelArts.4357

    Parse AI annotation result file name error

    +

    Parse AI annotation result file name error

    Failed to parse the labeling file name.

    +

    Failed to parse the labeling file name.

    Ensure that the file name in the OBS auto labeling result path is correct.

    +

    Ensure that the file name in the OBS auto labeling result path is correct.

    400

    +

    400

    ModelArts.4358

    +

    ModelArts.4358

    Invalid export path

    +

    Invalid export path

    Invalid OBS export path.

    +

    Invalid OBS export path.

    Ensure that the export path is correct.

    +

    Ensure that the export path is correct.

    400

    +

    400

    ModelArts.4359

    +

    ModelArts.4359

    Export task does not exist

    +

    Export task does not exist

    The export task ID does not exist.

    +

    The export task ID does not exist.

    Ensure that the export task ID is correct.

    +

    Ensure that the export task ID is correct.

    400

    +

    400

    ModelArts.4361

    +

    ModelArts.4361

    Import AI annotation error

    +

    Import AI annotation error

    Failed to synchronize the auto labeling task result.

    +

    Failed to synchronize the auto labeling task result.

    Ensure that the auto labeling task result is correct.

    +

    Ensure that the auto labeling task result is correct.

    400

    +

    400

    ModelArts.4362

    +

    ModelArts.4362

    Import data error

    +

    Import data error

    Failed to import data.

    +

    Failed to import data.

    Ensure that the authentication information and the request parameters for creating an import task are correct.

    +

    Ensure that the authentication information and the request parameters for creating an import task are correct.

    400

    +

    400

    ModelArts.4364

    +

    ModelArts.4364

    Dataset workPath subdir already exists

    +

    Dataset workPath subdir already exists

    The work_path subdirectory already exists in the dataset directory.

    +

    The work_path subdirectory already exists in the dataset directory.

    Ensure that the subdirectory in the dataset directory is correct.

    +

    Ensure that the subdirectory in the dataset directory is correct.

    400

    +

    400

    ModelArts.4365

    +

    ModelArts.4365

    Dataset labels not set

    +

    Dataset labels not set

    The label set of the dataset is empty.

    +

    The label set of the dataset is empty.

    Create labels for the dataset.

    +

    Create labels for the dataset.

    400

    +

    400

    ModelArts.4368

    +

    ModelArts.4368

    Parse pc bin file error

    +

    Parse pc bin file error

    Failed to parse the point cloud binary file.

    +

    Failed to parse the point cloud binary file.

    Ensure that the point cloud binary file is not damaged.

    +

    Ensure that the point cloud binary file is not damaged.

    400

    +

    400

    ModelArts.4369

    +

    ModelArts.4369

    Parse pc prelabel json file error

    +

    Parse pc prelabel json file error

    Failed to parse the point cloud pre-labeling file.

    +

    Failed to parse the point cloud pre-labeling file.

    Ensure that the point cloud pre-labeling file is correct.

    +

    Ensure that the point cloud pre-labeling file is correct.

    400

    +

    400

    ModelArts.4370

    +

    ModelArts.4370

    One dataset version can be released in a minute, please try again later

    +

    One dataset version can be released in a minute, please try again later

    Frequent dataset version creation.

    +

    Frequent dataset version creation.

    Do not frequently create dataset versions.

    +

    Do not frequently create dataset versions.

    400

    +

    400

    ModelArts.4371

    +

    ModelArts.4371

    Dataset version already exists

    +

    Dataset version already exists

    The value of version_name is the same as an existing version.

    +

    The value of version_name is the same as an existing version.

    Change the value of version_name.

    +

    Change the value of version_name.

    400

    +

    400

    ModelArts.4372

    +

    ModelArts.4372

    Valid image not found

    +

    Valid image not found

    No point cloud data image found.

    +

    No point cloud data image found.

    Ensure that the point cloud data image is correct.

    +

    Ensure that the point cloud data image is correct.

    400

    +

    400

    ModelArts.4374

    +

    ModelArts.4374

    Invalid path

    +

    Invalid path

    Invalid OBS path.

    +

    Invalid OBS path.

    Ensure that the OBS path is correct and that the file is available in the OBS path.

    +

    Ensure that the OBS path is correct and that the file is available in the OBS path.

    400

    +

    400

    ModelArts.4375

    +

    ModelArts.4375

    Parse pc obs image error

    +

    Parse pc obs image error

    Failed to parse the point cloud data image in OBS.

    +

    Failed to parse the point cloud data image in OBS.

    Ensure that the point cloud data image is correct.

    +

    Ensure that the point cloud data image is correct.

    400

    +

    400

    ModelArts.4376

    +

    ModelArts.4376

    Unsupported pc pcd format error

    +

    Unsupported pc pcd format error

    The PCD attribute is not supported.

    +

    The PCD attribute is not supported.

    Check the point cloud data in PCD format.

    +

    Check the point cloud data in PCD format.

    400

    +

    400

    ModelArts.4377

    +

    ModelArts.4377

    Pc pcd format error

    +

    Pc pcd format error

    Failed to parse the point cloud data in PCD format.

    +

    Failed to parse the point cloud data in PCD format.

    Ensure that the PCD file is valid.

    +

    Ensure that the PCD file is valid.

    400

    +

    400

    ModelArts.4378

    +

    ModelArts.4378

    Parse pc pcd file error

    +

    Parse pc pcd file error

    Failed to parse the point cloud data in PCD format.

    +

    Failed to parse the point cloud data in PCD format.

    Ensure that the PCD file is correct.

    +

    Ensure that the PCD file is correct.

    400

    +

    400

    ModelArts.4379

    +

    ModelArts.4379

    Unsupported pc file format error

    +

    Unsupported pc file format error

    The point cloud data format is not supported.

    +

    The point cloud data format is not supported.

    Ensure that the imported point cloud data is in BIN or PCD format.

    +

    Ensure that the imported point cloud data is in BIN or PCD format.

    400

    +

    400

    ModelArts.4380

    +

    ModelArts.4380

    Parse kitti calibration file error

    +

    Parse kitti calibration file error

    Failed to parse the Kitti data.

    +

    Failed to parse the Kitti data.

    Ensure that the data is correct.

    +

    Ensure that the data is correct.

    400

    +

    400

    ModelArts.4381

    +

    ModelArts.4381

    Dataset is publishing, annotation is forbidden

    +

    Dataset is publishing, annotation is forbidden

    Sample labeling is not allowed because a publish task is being executed in the dataset.

    +

    Sample labeling is not allowed because a publish task is being executed in the dataset.

    Wait until the publish task is complete.

    +

    Wait until the publish task is complete.

    400

    +

    400

    ModelArts.4382

    +

    ModelArts.4382

    Generate 2d image error

    +

    Generate 2d image error

    Failed to generate a 2D image.

    +

    Failed to generate a 2D image.

    Ensure that the point cloud data is correct.

    +

    Ensure that the point cloud data is correct.

    400

    +

    400

    ModelArts.4384

    +

    ModelArts.4384

    Invalid export parameter

    +

    Invalid export parameter

    Invalid parameter.

    +

    Invalid parameter.

    Ensure that all mandatory parameters are included and valid.

    +

    Ensure that all mandatory parameters are included and valid.

    400

    +

    400

    ModelArts.4391

    +

    ModelArts.4391

    Task name is invalid

    +

    Task name is invalid

    An auto deploy task whose name is the task_name value already exists in the dataset.

    +

    An auto deploy task whose name is the task_name value already exists in the dataset.

    Ensure that the task name is correct.

    +

    Ensure that the task name is correct.

    400

    +

    400

    ModelArts.4392

    +

    ModelArts.4392

    Task failed

    +

    Task failed

    Failed to create or run the dataset.

    +

    Failed to create or run the dataset.

    Ensure that the parameters and task resources are correct.

    +

    Ensure that the parameters and task resources are correct.

    400

    +

    400

    ModelArts.4393

    +

    ModelArts.4393

    Task stopped

    +

    Task stopped

    The dataset task has been stopped.

    +

    The dataset task has been stopped.

    Check the status of the dataset task with the specified ID.

    +

    Check the status of the dataset task with the specified ID.

    400

    +

    400

    ModelArts.4396

    +

    ModelArts.4396

    Parameter is invalid

    +

    Parameter is invalid

    Invalid parameter.

    +

    Invalid parameter.

    Ensure that the import task parameters are correct.

    +

    Ensure that the import task parameters are correct.

    400

    +

    400

    ModelArts.4399

    +

    ModelArts.4399

    Type match error

    +

    Type match error

    The dataset type does not match the algorithm model.

    +

    The dataset type does not match the algorithm model.

    Ensure that the algorithm model is correct.

    +

    Ensure that the algorithm model is correct.

    400

    +

    400

    ModelArts.4400

    +

    ModelArts.4400

    Can not get table schema

    +

    Can not get table schema

    Failed to obtain the schema information from the OBS directory.

    +

    Failed to obtain the schema information from the OBS directory.

    Ensure that the CSV file in the OBS directory is correct.

    +

    Ensure that the CSV file in the OBS directory is correct.

    400

    +

    400

    ModelArts.4404

    +

    ModelArts.4404

    Can not get table schema from DLI

    +

    Can not get table schema from DLI

    Failed to obtain the schema information from DLI.

    +

    Failed to obtain the schema information from DLI.

    Ensure that the request parameters are correct.

    +

    Ensure that the request parameters are correct.

    400

    +

    400

    ModelArts.4405

    +

    ModelArts.4405

    Dataset must contains labels to start automation labeling

    +

    Dataset must contains labels to start automation labeling

    Labeled samples must be available for enabling auto labeling.

    +

    Labeled samples must be available for enabling auto labeling.

    Add new labeled samples to the dataset.

    +

    Add new labeled samples to the dataset.

    400

    +

    400

    ModelArts.4406

    +

    ModelArts.4406

    Dataset must contains labels with at least five images to start automation labeling

    +

    Dataset must contains labels with at least five images to start automation labeling

    The number of samples to be labeled for each label cannot be less than 5.

    +

    The number of samples to be labeled for each label cannot be less than 5.

    Ensure that each label has at least five samples.

    +

    Ensure that each label has at least five samples.

    400

    +

    400

    ModelArts.4407

    +

    ModelArts.4407

    Dataset must contains unlabeled files

    +

    Dataset must contains unlabeled files

    The dataset must contain samples that have not been labeled.

    +

    The dataset must contain samples that have not been labeled.

    Ensure that there are unlabeled samples in the dataset.

    +

    Ensure that there are unlabeled samples in the dataset.

    400

    +

    400

    ModelArts.4408

    +

    ModelArts.4408

    Dataset contains labels shape not bndbox

    +

    Dataset contains labels shape not bndbox

    The label shape cannot be bounding box.

    +

    The label shape cannot be bounding box.

    Ensure that the shape attribute is correct.

    +

    Ensure that the shape attribute is correct.

    400

    +

    400

    ModelArts.4409

    +

    ModelArts.4409

    Running tasks has exceed the max threshold

    +

    Running tasks has exceed the max threshold

    The number of tasks that are being executed in the dataset has reached the maximum allowed limit.

    +

    The number of tasks that are being executed in the dataset has reached the maximum allowed limit.

    Try again later.

    +

    Try again later.

    400

    +

    400

    ModelArts.4410

    +

    ModelArts.4410

    Label not found

    +

    Label not found

    The label does not exist.

    +

    The label does not exist.

    Ensure that the label name is correct.

    +

    Ensure that the label name is correct.

    400

    +

    400

    ModelArts.4411

    +

    ModelArts.4411

    Label already exists

    +

    Label already exists

    The new label list contains existing label names.

    +

    The new label list contains existing label names.

    Ensure that the label names are correct.

    +

    Ensure that the label names are correct.

    400

    +

    400

    ModelArts.4412

    +

    ModelArts.4412

    Label shortcut already exists

    +

    Label shortcut already exists

    The label shortcut already exists.

    +

    The label shortcut already exists.

    Change the label shortcut.

    +

    Change the label shortcut.

    400

    +

    400

    ModelArts.4413

    +

    ModelArts.4413

    Label is incompatible with annotation rules

    +

    Label is incompatible with annotation rules

    The label attribute does not comply with specifications.

    +

    The label attribute does not comply with specifications.

    Ensure that the label attribute complies with specifications.

    +

    Ensure that the label attribute complies with specifications.

    400

    +

    400

    ModelArts.4414

    +

    ModelArts.4414

    Triplet label's from_entity or to_entity does not exist

    +

    Triplet label's from_entity or to_entity does not exist

    The entity label does not exist in the triplet label.

    +

    The entity label does not exist in the triplet label.

    Ensure that the entity label in the triplet label is available.

    +

    Ensure that the entity label in the triplet label is available.

    400

    +

    400

    ModelArts.4415

    +

    ModelArts.4415

    Entity label can not be deleted because it is used by triplet label

    +

    Entity label can not be deleted because it is used by triplet label

    Failed to delete the entity label because it is being used in the triplet label.

    +

    Failed to delete the entity label because it is being used in the triplet label.

    Wait until the label is not used in the triplet label and try again.

    +

    Wait until the label is not used in the triplet label and try again.

    400

    +

    400

    ModelArts.4416

    +

    ModelArts.4416

    Sync tags error

    +

    Sync tags error

    Failed to synchronize labels in the team labeling task.

    +

    Failed to synchronize labels in the team labeling task.

    Ensure that the synchronization task parameters are correct.

    +

    Ensure that the synchronization task parameters are correct.

    400

    +

    400

    ModelArts.4417

    +

    ModelArts.4417

    Update sample labels failed when upload sample and labels

    +

    Update sample labels failed when upload sample and labels

    Failed to update the sample labels.

    +

    Failed to update the sample labels.

    Ensure that the labels are correct.

    +

    Ensure that the labels are correct.

    400

    +

    400

    ModelArts.4418

    +

    ModelArts.4418

    Label property mask_gray_value already exists

    +

    Label property mask_gray_value already exists

    Duplicate tag mask_gray_value.

    +

    Duplicate tag mask_gray_value.

    Ensure that the tag mask_gray_value is correct.

    +

    Ensure that the tag mask_gray_value is correct.

    400

    +

    400

    ModelArts.4420

    +

    ModelArts.4420

    Sample not found

    +

    Sample not found

    The sample with the specified ID does not exist.

    +

    The sample with the specified ID does not exist.

    Ensure that the sample ID is correct.

    +

    Ensure that the sample ID is correct.

    400

    +

    400

    ModelArts.4421

    +

    ModelArts.4421

    Upload sample failed

    +

    Upload sample failed

    Failed to upload the sample to the dataset.

    +

    Failed to upload the sample to the dataset.

    Ensure that the uploaded sample type and data are correct.

    +

    Ensure that the uploaded sample type and data are correct.

    400

    +

    400

    ModelArts.4422

    +

    ModelArts.4422

    Sample already exists

    +

    Sample already exists

    The sample that is being imported already exists.

    +

    The sample that is being imported already exists.

    Enter that the imported sample is correct.

    +

    Enter that the imported sample is correct.

    400

    +

    400

    ModelArts.4423

    +

    ModelArts.4423

    Get sample size failed, please input size manually

    +

    Get sample size failed, please input size manually

    Incorrect size of the image obtained from the object detection dataset.

    +

    Incorrect size of the image obtained from the object detection dataset.

    Manually set the image size.

    +

    Manually set the image size.

    400

    +

    400

    ModelArts.4425

    +

    ModelArts.4425

    Label property mask_gray_value is incompatible with defined value

    +

    Label property mask_gray_value is incompatible with defined value

    The mask_gray_value value cannot be changed.

    +

    The mask_gray_value value cannot be changed.

    Ensure that the mask_gray_value value is not changed.

    +

    Ensure that the mask_gray_value value is not changed.

    400

    +

    400

    ModelArts.4426

    +

    ModelArts.4426

    Dataset must contains tags to start auto deploy

    +

    Dataset must contains tags to start auto deploy

    The label set of the dataset cannot be empty.

    +

    The label set of the dataset cannot be empty.

    Create labels for the dataset.

    +

    Create labels for the dataset.

    400

    +

    400

    ModelArts.4427

    +

    ModelArts.4427

    Dataset must contains tags with at least five images to start auto deploy

    +

    Dataset must contains tags with at least five images to start auto deploy

    The number of samples to be labeled for each label cannot be less than 5.

    +

    The number of samples to be labeled for each label cannot be less than 5.

    Ensure that each label has at least five samples.

    +

    Ensure that each label has at least five samples.

    400

    +

    400

    ModelArts.4502

    +

    ModelArts.4502

    The IAM agency name already exists, please delete the agency in IAM first and retry

    +

    The IAM agency name already exists, please delete the agency in IAM first and retry

    The default IAM agency already exists.

    +

    The default IAM agency already exists.

    Delete the IAM agency and create a new one.

    +

    Delete the IAM agency and create a new one.

    400

    +

    400

    ModelArts.4601

    +

    ModelArts.4601

    The workforce does not exist

    +

    The workforce does not exist

    The team ID does not exist.

    +

    The team ID does not exist.

    Ensure that the team ID is correct.

    +

    Ensure that the team ID is correct.

    400

    +

    400

    ModelArts.4602

    +

    ModelArts.4602

    The workforce already exists

    +

    The workforce already exists

    A team whose name is the workforce_name value already exists.

    +

    A team whose name is the workforce_name value already exists.

    Ensure that the workforce_name value is correct.

    +

    Ensure that the workforce_name value is correct.

    400

    +

    400

    ModelArts.4603

    +

    ModelArts.4603

    Update workforce state failed

    +

    Update workforce state failed

    Failed to delete the team.

    +

    Failed to delete the team.

    Check whether the team has been deleted.

    +

    Check whether the team has been deleted.

    400

    +

    400

    ModelArts.4604

    +

    ModelArts.4604

    The worker does not exist

    +

    The worker does not exist

    The team member specified by work_id does not exist.

    +

    The team member specified by work_id does not exist.

    Ensure that the workforce_id and work_id values are correct.

    +

    Ensure that the workforce_id and work_id values are correct.

    400

    +

    400

    ModelArts.4605

    +

    ModelArts.4605

    The worker already exists

    +

    The worker already exists

    The team member whose value is the email value already exists.

    +

    The team member whose value is the email value already exists.

    Ensure that the email value is correct.

    +

    Ensure that the email value is correct.

    400

    +

    400

    ModelArts.4609

    +

    ModelArts.4609

    Change password failed

    +

    Change password failed

    Failed to change the account password.

    +

    Failed to change the account password.

    Ensure that the new password complies with specifications.

    +

    Ensure that the new password complies with specifications.

    400

    +

    400

    ModelArts.4612

    +

    ModelArts.4612

    Task not found

    +

    Task not found

    The task ID does not exist.

    +

    The task ID does not exist.

    Ensure that the task ID is correct.

    +

    Ensure that the task ID is correct.

    400

    +

    400

    ModelArts.4615

    +

    ModelArts.4615

    Workforce task is unfinished

    +

    Workforce task is unfinished

    The version cannot be switched because the team labeling task has not been completed.

    +

    The version cannot be switched because the team labeling task has not been completed.

    Wait until the team labeling task is complete and try again.

    +

    Wait until the team labeling task is complete and try again.

    400

    +

    400

    ModelArts.4617

    +

    ModelArts.4617

    The number of manager should be one

    +

    The number of manager should be one

    The team manager already exists.

    +

    The team manager already exists.

    Ensure that the roles of the team members are correct.

    +

    Ensure that the roles of the team members are correct.

    400

    +

    400

    ModelArts.4618

    +

    ModelArts.4618

    Can not delete yourself

    +

    Can not delete yourself

    You cannot delete yourself from the team.

    +

    You cannot delete yourself from the team.

    Ensure that the request parameters are correct.

    +

    Ensure that the request parameters are correct.

    400

    +

    400

    ModelArts.4619

    +

    ModelArts.4619

    Workforce task does not exist

    +

    Workforce task does not exist

    No team labeling task whose ID is the workforce_task_id value is allowed.

    +

    No team labeling task whose ID is the workforce_task_id value is allowed.

    Ensure that the workforce_task_id value is correct.

    +

    Ensure that the workforce_task_id value is correct.

    400

    +

    400

    ModelArts.4620

    +

    ModelArts.4620

    The workforce task already exists

    +

    The workforce task already exists

    A team labeling task whose name is the task_name value already exists.

    +

    A team labeling task whose name is the task_name value already exists.

    Ensure that the task_name value is correct.

    +

    Ensure that the task_name value is correct.

    400

    +

    400

    ModelArts.4622

    +

    ModelArts.4622

    Invalid n_clusters, should less than the total number of samples

    +

    Invalid n_clusters, should less than the total number of samples

    The number of groups has reached the maximum allowed limit.

    +

    The number of groups has reached the maximum allowed limit.

    Check whether the number of groups is less than the total number of samples.

    +

    Check whether the number of groups is less than the total number of samples.

    400

    +

    400

    ModelArts.4623

    +

    ModelArts.4623

    Workforce task is checking

    +

    Workforce task is checking

    Only one review task is allowed at a time.

    +

    Only one review task is allowed at a time.

    Wait until all existing review tasks are complete and try again.

    +

    Wait until all existing review tasks are complete and try again.

    400

    +

    400

    ModelArts.4627

    +

    ModelArts.4627

    Request notify too frequently

    +

    Request notify too frequently

    Frequent notification request submission.

    +

    Frequent notification request submission.

    Try again later.

    +

    Try again later.

    400

    +

    400

    ModelArts.4628

    +

    ModelArts.4628

    Can not delete worker who has task

    +

    Can not delete worker who has task

    The team member cannot be deleted because the labeling task has not been completed.

    +

    The team member cannot be deleted because the labeling task has not been completed.

    Notify the member to complete the task.

    +

    Notify the member to complete the task.

    400

    +

    400

    ModelArts.4650

    +

    ModelArts.4650

    Interactive operations not found

    +

    Interactive operations not found

    Incorrect interactive_operations value.

    +

    Incorrect interactive_operations value.

    Ensure that the interactive_operations value is correct.

    +

    Ensure that the interactive_operations value is correct.

    400

    +

    400

    ModelArts.4651

    +

    ModelArts.4651

    Get obs sample error

    +

    Get obs sample error

    Failed to read the sample from OBS.

    +

    Failed to read the sample from OBS.

    Ensure that the sample in OBS is correct.

    +

    Ensure that the sample in OBS is correct.

    400

    +

    400

    ModelArts.4700

    +

    ModelArts.4700

    Task does not exist

    +

    Task does not exist

    The task ID does not exist.

    +

    The task ID does not exist.

    Ensure that the task ID is correct.

    +

    Ensure that the task ID is correct.

    400

    +

    400

    ModelArts.4701

    +

    ModelArts.4701

    Can not start data analysis task, dataset version annotation type must be 'Image Classification' or 'Object Detection'

    +

    Can not start data analysis task, dataset version annotation type must be 'Image Classification' or 'Object Detection'

    The dataset type does not support feature analysis.

    +

    The dataset type does not support feature analysis.

    Ensure that the dataset type is correct.

    +

    Ensure that the dataset type is correct.

    400

    +

    400

    ModelArts.4702

    +

    ModelArts.4702

    Can not start data analysis task, dataset version must be 'Default' format

    +

    Can not start data analysis task, dataset version must be 'Default' format

    The dataset format does not support feature analysis.

    +

    The dataset format does not support feature analysis.

    Use the default dataset format.

    +

    Use the default dataset format.

    400

    +

    400

    ModelArts.4703

    +

    ModelArts.4703

    Can not start data analysis task, dataset version must contains annotated samples

    +

    Can not start data analysis task, dataset version must contains annotated samples

    Feature analysis cannot be performed because there is no labeled sample in the dataset.

    +

    Feature analysis cannot be performed because there is no labeled sample in the dataset.

    Ensure that there are labeled samples in the dataset.

    +

    Ensure that there are labeled samples in the dataset.

    400

    +

    400

    ModelArts.4704

    +

    ModelArts.4704

    Currently unable to start data analysis task, Please try again later

    +

    Currently unable to start data analysis task, Please try again later

    Feature analysis cannot be performed because a dataset version is being published.

    +

    Feature analysis cannot be performed because a dataset version is being published.

    Try again later.

    +

    Try again later.

    400

    +

    400

    ModelArts.4706

    +

    ModelArts.4706

    Can not start data analysis task, dataset version status must be normal

    +

    Can not start data analysis task, dataset version status must be normal

    Feature analysis cannot be performed because the dataset version is not in normal state.

    +

    Feature analysis cannot be performed because the dataset version is not in normal state.

    Ensure that the current dataset version is in normal state.

    +

    Ensure that the current dataset version is in normal state.

    400

    +

    400

    ModelArts.4709

    +

    ModelArts.4709

    Data preprocessing task already exists

    +

    Data preprocessing task already exists

    A training task whose name is the name value already exists.

    +

    A training task whose name is the name value already exists.

    Ensure that the name value is correct in the request for creating in the task.

    +

    Ensure that the name value is correct in the request for creating in the task.

    400

    +

    400

    ModelArts.4710

    +

    ModelArts.4710

    Dataset export file error

    +

    Dataset export file error

    Failed to publish or export the dataset.

    +

    Failed to publish or export the dataset.

    Ensure that the task export or publish parameters are correct.

    +

    Ensure that the task export or publish parameters are correct.

    400

    +

    400

    ModelArts.4711

    +

    ModelArts.4711

    Publishing requires splitting but annotated samples do not satisfied for splitting rules

    +

    Publishing requires splitting but annotated samples do not satisfied for splitting rules

    Failed to publish because the dataset label samples do not meet splitting requirements.

    +

    Failed to publish because the dataset label samples do not meet splitting requirements.

    Ensure that the number of dataset labels and the number of labeled samples meet the splitting requirements.

    +

    Ensure that the number of dataset labels and the number of labeled samples meet the splitting requirements.

    400

    +

    400

    ModelArts.4712

    +

    ModelArts.4712

    Dataset publish version failed

    +

    Dataset publish version failed

    Failed to publish the dataset version.

    +

    Failed to publish the dataset version.

    Ensure that the task export or publish parameters are correct.

    +

    Ensure that the task export or publish parameters are correct.

    400

    +

    400

    ModelArts.4800

    +

    ModelArts.4800

    The label task already exists

    +

    The label task already exists

    A labeling task whose name is the task_name value already exists.

    +

    A labeling task whose name is the task_name value already exists.

    Ensure that the task_name value is correct.

    +

    Ensure that the task_name value is correct.

    400

    +

    400

    ModelArts.4801

    +

    ModelArts.4801

    The label task not exists

    +

    The label task not exists

    The labeling task specified by the ID does not exist.

    +

    The labeling task specified by the ID does not exist.

    Ensure that the imported task ID is correct.

    +

    Ensure that the imported task ID is correct.

    400

    +

    400

    ModelArts.4820

    +

    ModelArts.4820

    Unsupported operation, label task type is %s

    +

    Unsupported operation, label task type is %s

    The labeling task type does not support the operation.

    +

    The labeling task type does not support the operation.

    Ensure that the labeling task type is correct.

    +

    Ensure that the labeling task type is correct.

    400

    +

    400

    ModelArts.4822

    +

    ModelArts.4822

    The number of labelers must exceed 1

    +

    The number of labelers must exceed 1

    At least two annotators are available in the team.

    +

    At least two annotators are available in the team.

    Check the number of annotators in the team.

    +

    Check the number of annotators in the team.

    400

    +

    400

    ModelArts.4823

    +

    ModelArts.4823

    Import to dataset version error

    +

    Import to dataset version error

    No data can be imported to a table dataset version.

    +

    No data can be imported to a table dataset version.

    Ensure that the dataset type is correct.

    +

    Ensure that the dataset type is correct.

    400

    +

    400

    ModelArts.4824

    +

    ModelArts.4824

    Dataset version status must be normal

    +

    Dataset version status must be normal

    Abnormal dataset version state.

    +

    Abnormal dataset version state.

    Check the version publish state of the dataset.

    +

    Check the version publish state of the dataset.

    400

    +

    400

    ModelArts.4825

    +

    ModelArts.4825

    Dataset version is empty

    +

    Dataset version is empty

    No sample is available in the dataset version.

    +

    No sample is available in the dataset version.

    Check the version publish result of the dataset.

    +

    Check the version publish result of the dataset.

    400

    +

    400

    ModelArts.4827

    +

    ModelArts.4827

    Dataset version delete failed

    +

    Dataset version delete failed

    Failed to delete the dataset version because there is a labeling task based on the dataset version.

    +

    Failed to delete the dataset version because there is a labeling task based on the dataset version.

    Check whether there is any labeling task that is created using the dataset version.

    +

    Check whether there is any labeling task that is created using the dataset version.

    400

    +

    400

    ModelArts.4851

    +

    ModelArts.4851

    Task version not found

    +

    Task version not found

    The version specified by version_id does not exist.

    +

    The version specified by version_id does not exist.

    Ensure that the version_id value is correct.

    +

    Ensure that the version_id value is correct.

    401

    +

    401

    ModelArts.4504

    +

    ModelArts.4504

    Iam error

    +

    Iam error

    IAM error.

    +

    IAM error.

    Ensure that the AK/SK or token is correct.

    +

    Ensure that the AK/SK or token is correct.

    403

    +

    403

    ModelArts.4310

    +

    ModelArts.4310

    OBS action is forbidden, please check iam agency or OBS and so on

    +

    OBS action is forbidden, please check iam agency or OBS and so on

    You do not have permission to access OBS.

    +

    You do not have permission to access OBS.

    Grant the permission to access OBS.

    +

    Grant the permission to access OBS.

    403

    +

    403

    ModelArts.4335

    +

    ModelArts.4335

    Iam agency is invalid

    +

    Iam agency is invalid

    Invalid IAM agency.

    +

    Invalid IAM agency.

    Check the IAM permission.

    +

    Check the IAM permission.

    403

    +

    403

    ModelArts.4336

    +

    ModelArts.4336

    The user hasn't permission

    +

    The user hasn't permission

    Restricted user permission.

    +

    Restricted user permission.

    Check the user permission.

    +

    Check the user permission.

    403

    +

    403

    ModelArts.4348

    +

    ModelArts.4348

    Check dli agency failed

    +

    Check dli agency failed

    Failed to create the agency for checking DLI.

    +

    Failed to create the agency for checking DLI.

    Check the agency permission for checking DLI.

    +

    Check the agency permission for checking DLI.

    403

    +

    403

    ModelArts.4419

    +

    ModelArts.4419

    File is too large

    +

    File is too large

    The size of the file imported from OBS or to be parsed has reached the maximum allowed limit.

    +

    The size of the file imported from OBS or to be parsed has reached the maximum allowed limit.

    Ensure that the file is correct.

    +

    Ensure that the file is correct.

    403

    +

    403

    ModelArts.4500

    +

    ModelArts.4500

    The number of iam agencies has reached the maximum

    +

    The number of iam agencies has reached the maximum

    The number of IAM agencies exceeded the upper limit.

    +

    The number of IAM agencies exceeded the upper limit.

    Delete unused IAM agencies.

    +

    Delete unused IAM agencies.

    403

    +

    403

    ModelArts.4501

    +

    ModelArts.4501

    The iam agency create action is forbidden

    +

    The iam agency create action is forbidden

    Failed to create the IAM agency.

    +

    Failed to create the IAM agency.

    Ensure that you have permission to create an IAM agency.

    +

    Ensure that you have permission to create an IAM agency.

    403

    +

    403

    ModelArts.4600

    +

    ModelArts.4600

    The worker action is forbidden

    +

    The worker action is forbidden

    The team member cannot perform the operation.

    +

    The team member cannot perform the operation.

    Check whether the team member has permission to perform the operation.

    +

    Check whether the team member has permission to perform the operation.

    403

    +

    403

    ModelArts.4613

    +

    ModelArts.4613

    Task not finish

    +

    Task not finish

    Failed to obtain the task result because the task execution has not been completed.

    +

    Failed to obtain the task result because the task execution has not been completed.

    Try again later.

    +

    Try again later.

    403

    +

    403

    ModelArts.4803

    +

    ModelArts.4803

    Dataset has unfinished label tasks, the operation is forbidden

    +

    Dataset has unfinished label tasks, the operation is forbidden

    Failed to delete data because the labeling task in the dataset has not been completed.

    +

    Failed to delete data because the labeling task in the dataset has not been completed.

    Ensure that all labeling tasks in the dataset are complete.

    +

    Ensure that all labeling tasks in the dataset are complete.

    403

    +

    403

    ModelArts.4821

    +

    ModelArts.4821

    Task is publishing, the operation is forbidden

    +

    Task is publishing, the operation is forbidden

    The auto labeling task cannot be started because a labeling task is being published.

    +

    The auto labeling task cannot be started because a labeling task is being published.

    Try again after the labeling task is published.

    +

    Try again after the labeling task is published.

    403

    +

    403

    ModelArts.4850

    +

    ModelArts.4850

    Process task is initializing, the operation is forbidden

    +

    Process task is initializing, the operation is forbidden

    Failed to delete the task because the processor task is being initialized.

    +

    Failed to delete the task because the processor task is being initialized.

    Check the task status.

    +

    Check the task status.

    429

    +

    429

    ModelArts.4395

    +

    ModelArts.4395

    Too many dataset requests

    +

    Too many dataset requests

    Frequent dataset or labeling task creation in a unit time.

    +

    Frequent dataset or labeling task creation in a unit time.

    Try again later.

    +

    Try again later.

    500

    +

    500

    ModelArts.4354

    +

    ModelArts.4354

    Insufficient quota

    +

    Insufficient quota

    The number of created datasets has reached the maximum allowed limit.

    +

    The number of created datasets has reached the maximum allowed limit.

    Delete unused datasets or apply for a higher quota.

    +

    Delete unused datasets or apply for a higher quota.

    500

    +

    500

    ModelArts.4360

    +

    ModelArts.4360

    Sync data source error

    +

    Sync data source error

    Failed to synchronize the data source.

    +

    Failed to synchronize the data source.

    Check the synchronization task status and result.

    +

    Check the synchronization task status and result.

    500

    +

    500

    ModelArts.4367

    +

    ModelArts.4367

    Update dataset state failed

    +

    Update dataset state failed

    Failed to delete the dataset.

    +

    Failed to delete the dataset.

    Check the dataset status.

    +

    Check the dataset status.

    500

    +

    500

    ModelArts.4373

    +

    ModelArts.4373

    No migratory job

    +

    No migratory job

    Failed to create the dataset migration task.

    +

    Failed to create the dataset migration task.

    Check whether the source dataset of the migration task is valid.

    +

    Check whether the source dataset of the migration task is valid.

    500

    +

    500

    ModelArts.4424

    +

    ModelArts.4424

    Delete sample failed

    +

    Delete sample failed

    Failed to delete the dataset sample.

    +

    Failed to delete the dataset sample.

    Ensure that the sample to be deleted is correct and that there is unfinished import or synchronization task.

    +

    Ensure that the sample to be deleted is correct and that there is unfinished import or synchronization task.

    500

    +

    500

    ModelArts.4614

    +

    ModelArts.4614

    Task failed

    +

    Task failed

    Failed to run the task.

    +

    Failed to run the task.

    Check the execution result of the processor task.

    +

    Check the execution result of the processor task.

    501

    +

    501

    ModelArts.4383

    +

    ModelArts.4383

    Unsupported operation, dataset %s type is %s

    +

    Unsupported operation, dataset %s type is %s

    The operation cannot be performed in the dataset.

    +

    The operation cannot be performed in the dataset.

    Check whether the dataset supports the current operation.

    +

    Check whether the dataset supports the current operation.

    501

    +

    501

    ModelArts.4385

    +

    ModelArts.4385

    Auto deploy task exist

    +

    Auto deploy task exist

    Failed to start the deploy task because an auto deploy task is being executed in the dataset.

    +

    Failed to start the deploy task because an auto deploy task is being executed in the dataset.

    Start a new deploy task after the current task is complete.

    +

    Start a new deploy task after the current task is complete.

    501

    +

    501

    ModelArts.4386

    +

    ModelArts.4386

    Auto labeling task exist

    +

    Auto labeling task exist

    Failed to start the auto labeling task because an auto labeling task is being executed in the dataset.

    +

    Failed to start the auto labeling task because an auto labeling task is being executed in the dataset.

    Start a new auto labeling task after the current task is complete.

    +

    Start a new auto labeling task after the current task is complete.

    501

    +

    501

    ModelArts.4387

    +

    ModelArts.4387

    Pre-label task exist

    +

    Pre-label task exist

    Failed to start the pre-labeling task because a pre-labeling task is being executed in the dataset.

    +

    Failed to start the pre-labeling task because a pre-labeling task is being executed in the dataset.

    Start a new pre-labeling task after the current task is complete.

    +

    Start a new pre-labeling task after the current task is complete.

    501

    +

    501

    ModelArts.4394

    +

    ModelArts.4394

    Task is running

    +

    Task is running

    Failed to obtain the migration result because a migration task is being executed in the dataset.

    +

    Failed to obtain the migration result because a migration task is being executed in the dataset.

    Wait until the migration task is complete.

    +

    Wait until the migration task is complete.

    400

    +

    400

    ModelArts.0116

    +

    ModelArts.0116

    Free train job reached the limit

    +

    Free train job reached the limit

    The number of free jobs exceeds the upper limit.

    +

    The number of free jobs exceeds the upper limit.

    Create the job again after the running job or the queuing job is complete.

    +

    Create the job again after the running job or the queuing job is complete.

    400

    +

    400

    ModelArts.0806

    +

    ModelArts.0806

    download log failed

    +

    download log failed

    No log is found.

    +

    No log is found.

    Ensure that the configured log storage duration exceeds the log storage duration. View the job running parameters and ensure that the job is started successfully. If the fault persists, contact technical support.

    +

    Ensure that the configured log storage duration exceeds the log storage duration. View the job running parameters and ensure that the job is started successfully. If the fault persists, contact technical support.

    400

    +

    400

    ModelArts.0901

    +

    ModelArts.0901

    Get dataset url failed

    +

    Get dataset url failed

    An error occurred when obtaining the dataset URL.

    +

    An error occurred when obtaining the dataset URL.

    Ensure that the dataset URL is correct.

    +

    Ensure that the dataset URL is correct.

    400

    +

    400

    ModelArts.2605

    +

    ModelArts.2605

    The number of available nodes in the resource pool is illegal: ${nodeCount}

    +

    The number of available nodes in the resource pool is illegal: ${nodeCount}

    No compute node is available in the selected resource pool.

    +

    No compute node is available in the selected resource pool.

    Select another resource pool.

    +

    Select another resource pool.

    400

    +

    400

    ModelArts.2606

    +

    ModelArts.2606

    ${obsUrl} should not be bucket

    +

    ${obsUrl} should not be bucket

    The selected dataset path is invalid.

    +

    The selected dataset path is invalid.

    Select a valid path or select another dataset.

    +

    Select a valid path or select another dataset.

    400

    +

    400

    ModelArts.2607

    +

    ModelArts.2607

    parameter length reaches the max limit ${BATCH_CMD_LENGTH_LIMIT}

    +

    parameter length reaches the max limit ${BATCH_CMD_LENGTH_LIMIT}

    The number of characters in the running parameter exceeds the upper limit.

    +

    The number of characters in the running parameter exceeds the upper limit.

    Check the running parameters and try again.

    +

    Check the running parameters and try again.

    400

    +

    400

    ModelArts.2608

    +

    ModelArts.2608

    ${url} should not contains

    +

    ${url} should not contains

    Invalid OBS path.

    +

    Invalid OBS path.

    Ensure that the OBS path does not contain the following characters: '{} [] and spaces try again.

    +

    Ensure that the OBS path does not contain the following characters: '{} [] and spaces try again.

    403

    +

    403

    ModelArts.2701

    +

    ModelArts.2701

    There is already a peer connection

    +

    There is already a peer connection

    The VPC peering connection already exists in the resource pool.

    +

    The VPC peering connection already exists in the resource pool.

    Use the existing connection or create another one.

    +

    Use the existing connection or create another one.

    403

    +

    403

    ModelArts.2702

    +

    ModelArts.2702

    Invalid vpc or subnet

    +

    Invalid vpc or subnet

    The specified VPC CIDR block overlaps with the dedicated resource pool CIDR block, and no VPC peering connection can be created.

    +

    The specified VPC CIDR block overlaps with the dedicated resource pool CIDR block, and no VPC peering connection can be created.

    Change the VPC CIDR block.

    +

    Change the VPC CIDR block.

    403

    +

    403

    ModelArts.2703

    +

    ModelArts.2703

    network of pool is not ready

    +

    network of pool is not ready

    There are multiple peering connections in the dedicated resource pool. These peering connections may have been manually operated.

    +

    There are multiple peering connections in the dedicated resource pool. These peering connections may have been manually operated.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    403

    +

    403

    ModelArts.3000

    +

    ModelArts.3000

    volumes of config are used in dedicated pools

    +

    volumes of config are used in dedicated pools

    You do not have the permission to access the volume in the dedicated resource pool.

    +

    You do not have the permission to access the volume in the dedicated resource pool.

    Access a common volume.

    +

    Access a common volume.

    404

    +

    404

    ModelArts.0015

    +

    ModelArts.0015

    The resource you requested is not exist

    +

    The resource you requested is not exist

    The queried resource does not exist.

    +

    The queried resource does not exist.

    Ensure that the URL is correct.

    +

    Ensure that the URL is correct.

    500

    +

    500

    ModelArts.2700

    +

    ModelArts.2700

    ${operator} failed. Response status is ${status}.Detail error msg: $agentErrorMsg

    +

    ${operator} failed. Response status is ${status}.Detail error msg: $agentErrorMsg

    Failed to call the VPC interface.

    +

    Failed to call the VPC interface.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.2704

    +

    ModelArts.2704

    Update sfs turbo info of pool failed. Error msg: {ex.getMessage}

    +

    Update sfs turbo info of pool failed. Error msg: {ex.getMessage}

    Failed to create the VPC peering connection and call the VPC interface.

    +

    Failed to create the VPC peering connection and call the VPC interface.

    Try again later.

    +

    Try again later.

    500

    +

    500

    ModelArts.2800

    +

    ModelArts.2800

    ${operator} failed. Response status is $status. Detail error msg: ${agentErrorMsg}

    +

    ${operator} failed. Response status is $status. Detail error msg: ${agentErrorMsg}

    Failed to access the SFS Turbo interface.

    +

    Failed to access the SFS Turbo interface.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    400

    +

    400

    ModelArts.5011

    +

    ModelArts.5011

    Invalid parameter

    +

    Invalid parameter

    Invalid parameter.

    +

    Invalid parameter.

    Modify the parameter.

    +

    Modify the parameter.

    400

    +

    400

    ModelArts.5012

    +

    ModelArts.5012

    Invalid product attribute

    +

    Invalid product attribute

    Invalid product attribute.

    +

    Invalid product attribute.

    Modify the product attribute.

    +

    Modify the product attribute.

    400

    +

    400

    ModelArts.5016

    +

    ModelArts.5016

    The original model ({0}) does not exist during model release

    +

    The original model ({0}) does not exist during model release

    The product source model does not exist.

    +

    The product source model does not exist.

    Select another source model.

    +

    Select another source model.

    400

    +

    400

    ModelArts.5022

    +

    ModelArts.5022

    Unsupported model type

    +

    Unsupported model type

    The model type is not supported.

    +

    The model type is not supported.

    Select another source model.

    +

    Select another source model.

    400

    +

    400

    ModelArts.5025

    +

    ModelArts.5025

    Incorrect verification code

    +

    Incorrect verification code

    Incorrect verification code.

    +

    Incorrect verification code.

    Enter the correct verification code.

    +

    Enter the correct verification code.

    400

    +

    400

    ModelArts.5026

    +

    ModelArts.5026

    Verification code expired

    +

    Verification code expired

    Verification code expired.

    +

    Verification code expired.

    Obtain a new verification code.

    +

    Obtain a new verification code.

    400

    +

    400

    ModelArts.5027

    +

    ModelArts.5027

    The verification code does not match the email address.

    +

    The verification code does not match the email address.

    The email address and verification code do not match.

    +

    The email address and verification code do not match.

    Obtain a new verification code.

    +

    Obtain a new verification code.

    400

    +

    400

    ModelArts.5038

    +

    ModelArts.5038

    You must first get a verification code

    +

    You must first get a verification code

    You have not obtained the verification code.

    +

    You have not obtained the verification code.

    Specify your email address and obtain the verification code by email.

    +

    Specify your email address and obtain the verification code by email.

    400

    +

    400

    ModelArts.5041

    +

    ModelArts.5041

    Duplicate version. Refresh the page and try again

    +

    Duplicate version. Refresh the page and try again

    Duplicate version.

    +

    Duplicate version.

    Refresh the page and try again.

    +

    Refresh the page and try again.

    400

    +

    400

    ModelArts.5047

    +

    ModelArts.5047

    Hilens product name duplicated.

    +

    Hilens product name duplicated.

    Duplicate HiLens name.

    +

    Duplicate HiLens name.

    Enter another product name.

    +

    Enter another product name.

    400

    +

    400

    ModelArts.5048

    +

    ModelArts.5048

    Hilens skill version duplicated.

    +

    Hilens skill version duplicated.

    Duplicate HiLens version.

    +

    Duplicate HiLens version.

    Select another version.

    +

    Select another version.

    400

    +

    400

    ModelArts.5049

    +

    ModelArts.5049

    Incorrect Hilens skill. Select the skill corresponding to the offering.

    +

    Incorrect Hilens skill. Select the skill corresponding to the offering.

    Incorrect HiLens skill.

    +

    Incorrect HiLens skill.

    Select the correct HiLens skill.

    +

    Select the correct HiLens skill.

    400

    +

    400

    ModelArts.5051

    +

    ModelArts.5051

    The HiLens skill type is not supported. Release the skill type in HiLens Studio.

    +

    The HiLens skill type is not supported. Release the skill type in HiLens Studio.

    The HiLens skill is currently unavailable. Publish the skill in HiLens Studio.

    +

    The HiLens skill is currently unavailable. Publish the skill in HiLens Studio.

    Select the correct HiLens skill.

    +

    Select the correct HiLens skill.

    400

    +

    400

    ModelArts.5052

    +

    ModelArts.5052

    The user does not have the agency permission

    +

    The user does not have the agency permission

    You do not have the agency permission.

    +

    You do not have the agency permission.

    Set an agency and try again.

    +

    Set an agency and try again.

    400

    +

    400

    ModelArts.5303

    +

    ModelArts.5303

    The obs source data is empty

    +

    The obs source data is empty

    Empty source data.

    +

    Empty source data.

    Select other source data.

    +

    Select other source data.

    400

    +

    400

    ModelArts.5304

    +

    ModelArts.5304

    The maximum number of files has been exceeded

    +

    The maximum number of files has been exceeded

    The number of files has reached the maximum allowed limit.

    +

    The number of files has reached the maximum allowed limit.

    Select other source data or reduce the data volume.

    +

    Select other source data or reduce the data volume.

    400

    +

    400

    ModelArts.5305

    +

    ModelArts.5305

    The maximum size of files has been exceeded

    +

    The maximum size of files has been exceeded

    The file size has reached the maximum allowed limit.

    +

    The file size has reached the maximum allowed limit.

    Select other source data or reduce the data volume.

    +

    Select other source data or reduce the data volume.

    400

    +

    400

    ModelArts.5306

    +

    ModelArts.5306

    The maximum depth of files has been exceeded

    +

    The maximum depth of files has been exceeded

    The file depth has reached the maximum allowed limit.

    +

    The file depth has reached the maximum allowed limit.

    Select other source data or reduce the data depth.

    +

    Select other source data or reduce the data depth.

    400

    +

    400

    ModelArts.5309

    +

    ModelArts.5309

    Only allow edge service published to AIHub.

    +

    Only allow edge service published to AIHub.

    Only edge VAS can be published.

    +

    Only edge VAS can be published.

    Select the edge VAS.

    +

    Select the edge VAS.

    400

    +

    400

    ModelArts.5312

    +

    ModelArts.5312

    Only allow market category service published to AIHub.

    +

    Only allow market category service published to AIHub.

    Only market VAS can be published.

    +

    Only market VAS can be published.

    Select the market VAS.

    +

    Select the market VAS.

    400

    +

    400

    ModelArts.5313

    +

    ModelArts.5313

    Only allow released service published to AIHub.

    +

    Only allow released service published to AIHub.

    Only published VAS is allowed.

    +

    Only published VAS is allowed.

    Select the published VAS.

    +

    Select the published VAS.

    400

    +

    400

    ModelArts.5314

    +

    ModelArts.5314

    Only allow 'closed Beta Test' stage service published to AIHub.

    +

    Only allow 'closed Beta Test' stage service published to AIHub.

    Only Closed Beta Test VAS can be published.

    +

    Only Closed Beta Test VAS can be published.

    Select the Closed Beta Test VAS.

    +

    Select the Closed Beta Test VAS.

    401

    +

    401

    ModelArts.5001

    +

    ModelArts.5001

    Token is blank

    +

    Token is blank

    The token does not exist.

    +

    The token does not exist.

    Add the token and try again.

    +

    Add the token and try again.

    401

    +

    401

    ModelArts.5002

    +

    ModelArts.5002

    Token is invalid

    +

    Token is invalid

    Invalid token.

    +

    Invalid token.

    Obtain a token and try again.

    +

    Obtain a token and try again.

    401

    +

    401

    ModelArts.5056

    +

    ModelArts.5056

    You do not have the permission to access the requested resource.

    +

    You do not have the permission to access the requested resource.

    You have not subscribed to HiLens.

    +

    You have not subscribed to HiLens.

    Log in to the HiLens management console and subscribe to the service.

    +

    Log in to the HiLens management console and subscribe to the service.

    403

    +

    403

    ModelArts.5013

    +

    ModelArts.5013

    The user is not registered. Please release a product first to complete the registration

    +

    The user is not registered. Please release a product first to complete the registration

    You have not registered with AI Gallery.

    +

    You have not registered with AI Gallery.

    Publish a product in AI Gallery for registration.

    +

    Publish a product in AI Gallery for registration.

    403

    +

    403

    ModelArts.5014

    +

    ModelArts.5014

    Permission deny

    +

    Permission deny

    You do not have permission to access the resource.

    +

    You do not have permission to access the resource.

    Access other resources.

    +

    Access other resources.

    403

    +

    403

    ModelArts.5017

    +

    ModelArts.5017

    Account suspended.

    +

    Account suspended.

    Suspended account.

    +

    Suspended account.

    Ensure that the account is not restricted and try again.

    +

    Ensure that the account is not restricted and try again.

    403

    +

    403

    ModelArts.5040

    +

    ModelArts.5040

    Your usage has exceeded the maximum quota

    +

    Your usage has exceeded the maximum quota

    The resource usage has reached the maximum allowed limit.

    +

    The resource usage has reached the maximum allowed limit.

    Wait until the system is idle and try again.

    +

    Wait until the system is idle and try again.

    403

    +

    403

    ModelArts.5043

    +

    ModelArts.5043

    Challenge applications submit failed

    +

    Challenge applications submit failed

    Failed to submit the contest.

    +

    Failed to submit the contest.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    403

    +

    403

    ModelArts.5053

    +

    ModelArts.5053

    Product has been recycled.

    +

    Product has been recycled.

    The product has been reclaimed.

    +

    The product has been reclaimed.

    Select another product.

    +

    Select another product.

    403

    +

    403

    ModelArts.5054

    +

    ModelArts.5054

    At least one available version must exist.

    +

    At least one available version must exist.

    At least one available version is required for the product.

    +

    At least one available version is required for the product.

    Perform other operations.

    +

    Perform other operations.

    403

    +

    403

    ModelArts.5055

    +

    ModelArts.5055

    The subscription has expired.

    +

    The subscription has expired.

    The subscription has expired.

    +

    The subscription has expired.

    Initiate a new subscription.

    +

    Initiate a new subscription.

    403

    +

    403

    ModelArts.5057

    +

    ModelArts.5057

    The free package is sold out.

    +

    The free package is sold out.

    The free package has been sold out.

    +

    The free package has been sold out.

    Select another package.

    +

    Select another package.

    404

    +

    404

    ModelArts.5058

    +

    ModelArts.5058

    Object ({0}) does not exit.

    +

    Object ({0}) does not exit.

    The object does not exist.

    +

    The object does not exist.

    Select another object.

    +

    Select another object.

    409

    +

    409

    ModelArts.5015

    +

    ModelArts.5015

    The product is being reviewed

    +

    The product is being reviewed

    The product is being reviewed.

    +

    The product is being reviewed.

    Perform operations after the review is complete.

    +

    Perform operations after the review is complete.

    409

    +

    409

    ModelArts.5044

    +

    ModelArts.5044

    Operations conflict, please try again later

    +

    Operations conflict, please try again later

    Failed to perform the operation.

    +

    Failed to perform the operation.

    Try again later.

    +

    Try again later.

    500

    +

    500

    ModelArts.5000

    +

    ModelArts.5000

    Please try again later or contact customer service to solve the problem

    +

    Please try again later or contact

    +

    technical support to solve the problem

    Internal error.

    +

    Internal error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5003

    +

    ModelArts.5003

    Internal Error: access IAM service failed

    +

    Internal Error: access IAM service failed

    Failed to access IAM.

    +

    Failed to access IAM.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5004

    +

    ModelArts.5004

    Internal Error: access moderation service failed.

    +

    Internal Error: access moderation service failed.

    Failed to access Text Moderation.

    +

    Failed to access Text Moderation.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5005

    +

    ModelArts.5005

    Internal Error: access ModelArts service failed

    +

    Internal Error: access ModelArts service failed

    Failed to access ModelArts.

    +

    Failed to access ModelArts.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5006

    +

    ModelArts.5006

    Internal Error: access AI service failed

    +

    Internal Error: access AI service failed

    Failed to access the managed services in AI Gallery.

    +

    Failed to access the managed services in AI Gallery.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5007

    +

    ModelArts.5007

    Internal Error: access AI manager failed

    +

    Internal Error: access AI manager failed

    Failed to access the manager services in AI Gallery.

    +

    Failed to access the manager services in AI Gallery.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5008

    +

    ModelArts.5008

    Internal Error: access SMN service failed

    +

    Internal Error: access SMN service failed

    Failed to access SMN.

    +

    Failed to access SMN.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5009

    +

    ModelArts.5009

    Database operation failed

    +

    Database operation failed

    Database operation error.

    +

    Database operation error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5010

    +

    ModelArts.5010

    OBS operation failed

    +

    OBS operation failed

    Failed to access OBS.

    +

    Failed to access OBS.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5019

    +

    ModelArts.5019

    Internal Error: access CBC service failed

    +

    Internal Error: access CBC service failed

    Failed to access CBC.

    +

    Failed to access CBC.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5021

    +

    ModelArts.5021

    Internal Error: access LCS service failed

    +

    Internal Error: access LCS service failed

    Failed to access LCS.

    +

    Failed to access LCS.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5039

    +

    ModelArts.5039

    Dear User,the traffic is a little busy. Please try again later

    +

    Dear User,the traffic is a little busy. Please try again later

    Excessive requests.

    +

    Excessive requests.

    Try again later.

    +

    Try again later.

    500

    +

    500

    ModelArts.5050

    +

    ModelArts.5050

    Internal Error: access Hilens service failed

    +

    Internal Error: access Hilens service failed

    Failed to access HiLens.

    +

    Failed to access HiLens.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5300

    +

    ModelArts.5300

    Failed to explore the user source address.

    +

    Failed to explore the user source address.

    Failed to traverse user source addresses.

    +

    Failed to traverse user source addresses.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5301

    +

    ModelArts.5301

    Failed to download the source file from OBS.

    +

    Failed to download the source file from OBS.

    Failed to download the source file from OBS.

    +

    Failed to download the source file from OBS.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5302

    +

    ModelArts.5302

    Failed to upload the source file to the destination address.

    +

    Failed to upload the source file to the destination address.

    Failed to upload the source file to the destination address.

    +

    Failed to upload the source file to the destination address.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5308

    +

    ModelArts.5308

    Internal Error: access VAS service failed

    +

    Internal Error: access VAS service failed

    Failed to access VAS.

    +

    Failed to access VAS.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.5311

    +

    ModelArts.5311

    Failed to get market category id.

    +

    Failed to get market category id.

    No market category ID found.

    +

    No market category ID found.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    400

    +

    400

    ModelArts.0101

    +

    ModelArts.0101

    Invalid Argument.

    +

    Invalid Argument.

    Invalid parameter.

    +

    Invalid parameter.

    Enter the correct parameter as prompted.

    +

    Enter the correct parameter as prompted.

    400

    +

    400

    ModelArts.0107

    +

    ModelArts.0107

    The values of the request parameters ({0},{1}) are invalid.

    +

    The values of the request parameters ({0},{1}) are invalid.

    Invalid parameter values ({0}, {1}).

    +

    Invalid parameter values ({0}, {1}).

    Check whether the parameter values are valid.

    +

    Check whether the parameter values are valid.

    400

    +

    400

    ModelArts.0204

    +

    ModelArts.0204

    Token must contain projectId info.

    +

    Token must contain projectId info.

    No project ID included in the token.

    +

    No project ID included in the token.

    Ensure that the project token is used.

    +

    Ensure that the project token is used.

    400

    +

    400

    ModelArts.3015

    +

    ModelArts.3015

    Config json file does not conform to the specification.

    +

    Config json file does not conform to the specification.

    The model configuration file does not comply with file specifications.

    +

    The model configuration file does not comply with file specifications.

    Check whether config.json or initial_config complies with the specifications.

    +

    Check whether config.json or initial_config complies with the specifications.

    400

    +

    400

    ModelArts.3016

    +

    ModelArts.3016

    Failed to parse config json file because of unsupported fields, types, or formats({0}, {1}).

    +

    Failed to parse config json file because of unsupported fields, types, or formats({0}, {1}).

    Failed to parse the configuration file because the field, type, or format is not supported.

    +

    Failed to parse the configuration file because the field, type, or format is not supported.

    Check whether the field is correct as prompted.

    +

    Check whether the field is correct as prompted.

    400

    +

    400

    ModelArts.3017

    +

    ModelArts.3017

    Failed to publish model because source location noncompliance.

    +

    Failed to publish model because source location noncompliance.

    Failed to publish the model because the model source path does not meet specifications.

    +

    Failed to publish the model because the model source path does not meet specifications.

    Check whether the source_location value complies with the specifications.

    +

    Check whether the source_location value complies with the specifications.

    400

    +

    400

    ModelArts.3023

    +

    ModelArts.3023

    Invalid labels({0}) of model.

    +

    Invalid labels({0}) of model.

    Invalid model label {0}.

    +

    Invalid model label {0}.

    Ensure that a model label starts with a letter or a Chinese character and contains a maximum of 64 characters, including letters, digits, underscores (_), and Chinese characters.

    +

    Ensure that a model label starts with a letter or a Chinese character and contains a maximum of 64 characters, including letters, digits, underscores (_), and Chinese characters.

    400

    +

    400

    ModelArts.3024

    +

    ModelArts.3024

    The templateInputs field is incorrectly configured, check if the input is consistent with the template requirements.

    +

    The templateInputs field is incorrectly configured, check if the input is consistent with the template requirements.

    Incorrect configuration. Check whether the configuration complies with the template requirements.

    +

    Incorrect configuration. Check whether the configuration complies with the template requirements.

    The parameter configuration does not comply with the template requirements. Modify the configuration.

    +

    The parameter configuration does not comply with the template requirements. Modify the configuration.

    400

    +

    400

    ModelArts.3025

    +

    ModelArts.3025

    User ({0}) has only a single share permission and cannot be shared with all users.

    +

    User ({0}) has only a single share permission and cannot be shared with all users.

    User {0} does not have permission to share data with all users.

    +

    User {0} does not have permission to share data with all users.

    Only the administrator or accounts in the whitelist have permission to share data with all users.

    +

    Only the system administrator or accounts in the whitelist have permission to share data with all users.

    400

    +

    400

    ModelArts.3026

    +

    ModelArts.3026

    Failed to delete infer format, infer format ({0}) already be used by template.

    +

    Failed to delete infer format, infer format ({0}) already be used by template.

    Failed to delete input/output mode {0} because it is being used by a template.

    +

    Failed to delete input/output mode {0} because it is being used by a template.

    Find the template that is using the input/output mode, disassociate the mode from the template, and delete the mode again.

    +

    Find the template that is using the input/output mode, disassociate the mode from the template, and delete the mode again.

    400

    +

    400

    ModelArts.3027

    +

    ModelArts.3027

    The model used by the template ({0}) is private and belongs to other users and cannot be shared.

    +

    The model used by the template ({0}) is private and belongs to other users and cannot be shared.

    Input/Output mode {0} used by the template cannot be shared.

    +

    Input/Output mode {0} used by the template cannot be shared.

    Select another mode.

    +

    Select another mode.

    400

    +

    400

    ModelArts.3028

    +

    ModelArts.3028

    Failed to publish model, please select input and output mode.

    +

    Failed to publish model, please select input and output mode.

    Failed to publish the model. Select an input/output mode.

    +

    Failed to publish the model. Select an input/output mode.

    Select another input/output mode and publish the model again.

    +

    Select another input/output mode and publish the model again.

    400

    +

    400

    ModelArts.3029

    +

    ModelArts.3029

    Model publishing failed because the Template model must provide the template ID used.

    +

    Model publishing failed because the Template model must provide the template ID used.

    Failed to publish the model because the template ID is unavailable.

    +

    Failed to publish the model because the template ID is unavailable.

    Enter the template ID.

    +

    Enter the template ID.

    400

    +

    400

    ModelArts.3030

    +

    ModelArts.3030

    Model publishing failed, template ({0}) does not support modifying its built-in input and output mode.

    +

    Model publishing failed, template ({0}) does not support modifying its built-in input and output mode.

    Failed to publish the model because the built-in input/output mode of template {0} cannot be changed.

    +

    Failed to publish the model because the built-in input/output mode of template {0} cannot be changed.

    Do not change the input/output mode of a template when publishing the template model.

    +

    Do not change the input/output mode of a template when publishing the template model.

    400

    +

    400

    ModelArts.3031

    +

    ModelArts.3031

    Cancel sharing failed, ({0}) has not been shared with other tenants.

    +

    Cancel sharing failed, ({0}) has not been shared with other tenants.

    Failed to cancel the sharing because image {0} is not shared with other users.

    +

    Failed to cancel the sharing because image {0} is not shared with other users.

    Ensure that image {0} is not shared with other users.

    +

    Ensure that image {0} is not shared with other users.

    400

    +

    400

    ModelArts.3032

    +

    ModelArts.3032

    Image ({0}) cannot be shared to admin ({1}), please check the image permissions.

    +

    Image ({0}) cannot be shared to admin ({1}), please check the image permissions.

    Failed to share image {0} with the administrator {0}. Check the image permission.

    +

    Failed to share image {0} with the administrator {0}. Check the image permission.

    Perform operations according to the error message.

    +

    Perform operations according to the error message.

    400

    +

    400

    ModelArts.3033

    +

    ModelArts.3033

    Template publishing failed, please provide template label.

    +

    Template publishing failed, please provide template label.

    Failed to publish the template model because its label is left blank.

    +

    Failed to publish the template model because its label is left blank.

    Set the model label.

    +

    Set the model label.

    400

    +

    400

    ModelArts.3034

    +

    ModelArts.3034

    Template model failed to be published, template field is required.

    +

    Template model failed to be published, template field is required.

    Failed to publish the template model because the template field is left blank.

    +

    Failed to publish the template model because the template field is left blank.

    Set template.

    +

    Set template.

    400

    +

    400

    ModelArts.3035

    +

    ModelArts.3035

    Profile preview failed, sourceLocation and previewConfig fields need to provide at least one.

    +

    Profile preview failed, sourceLocation and previewConfig fields need to provide at least one.

    Failed to preview the configuration file.

    +

    Failed to preview the configuration file.

    Either source_location or preview_config must be specified.

    +

    Either source_location or preview_config must be specified.

    400

    +

    400

    ModelArts.3036

    +

    ModelArts.3036

    Parameter verification failed, parameter ({0}) is required.

    +

    Parameter verification failed, parameter ({0}) is required.

    Failed to check parameter {0} because it is left blank.

    +

    Failed to check parameter {0} because it is left blank.

    Set parameters according to the error message.

    +

    Set parameters according to the error message.

    400

    +

    400

    ModelArts.3037

    +

    ModelArts.3037

    Parameter ({0}:{1}) is invalid.

    +

    Parameter ({0}:{1}) is invalid.

    Invalid parameter {0}:{1}.

    +

    Invalid parameter {0}:{1}.

    Modify passwords as prompted.

    +

    Modify passwords as prompted.

    400

    +

    400

    ModelArts.3038

    +

    ModelArts.3038

    When isSpecific is true, domainId is required.

    +

    When isSpecific is true, domainId is required.

    Failed to perform the operation because domain_id is left blank.

    +

    Failed to perform the operation because domain_id is left blank.

    Set domain_id as prompted.

    +

    Set domain_id as prompted.

    400

    +

    400

    ModelArts.3039

    +

    ModelArts.3039

    Template input input_id cannot be repeated.

    +

    Template input input_id cannot be repeated.

    Failed to perform the operation because input_id is repetitive.

    +

    Failed to perform the operation because input_id is repetitive.

    Ensure that the input_id value is unique.

    +

    Ensure that the input_id value is unique.

    400

    +

    400

    ModelArts.3040

    +

    ModelArts.3040

    When the installer installer is yum or apt-get, and the version packageVersion exists, the version constraint restraint can only be EXACT.

    +

    When the installer installer is yum or apt-get, and the version packageVersion exists, the version constraint restraint can only be EXACT.

    Failed to perform the operation because restraint can only be EXACT.

    +

    Failed to perform the operation because restraint can only be EXACT.

    Change the restraint value to EXACT.

    +

    Change the restraint value to EXACT.

    400

    +

    400

    ModelArts.3041

    +

    ModelArts.3041

    When the installer installer is conda or pip, and the version packageVersion exists, the version constraint restraint can only be EXACT, ATLEAST, ATMOST.

    +

    When the installer installer is conda or pip, and the version packageVersion exists, the version constraint restraint can only be EXACT, ATLEAST, ATMOST.

    Failed to perform the operation because restraint can only be EXACT, ATLEAST, or ATMOST.

    +

    Failed to perform the operation because restraint can only be EXACT, ATLEAST, or ATMOST.

    Change the restraint value to EXACT, ATLEAST, or ATMOST.

    +

    Change the restraint value to EXACT, ATLEAST, or ATMOST.

    400

    +

    400

    ModelArts.3063

    +

    ModelArts.3063

    Mode unshared failed, the template using this mode has been shared, you need to cancel the sharing of the template first.

    +

    Mode unshared failed, the template using this mode has been shared, you need to cancel the sharing of the template first.

    Failed to cancel mode sharing because the template using the mode is being shared.

    +

    Failed to cancel mode sharing because the template using the mode is being shared.

    Perform operations according to the error message.

    +

    Perform operations according to the error message.

    400

    +

    400

    ModelArts.3070

    +

    ModelArts.3070

    There is a model name that does not belong to this tenant: ({0}).

    +

    There is a model name that does not belong to this tenant: ({0}).

    The model does not belong to user {0}.

    +

    The model does not belong to user {0}.

    The domain ID of the subscribed model is different from the entered domain ID. Contact the model subscription service and check whether the entered domain ID is correct.

    +

    The domain ID of the subscribed model is different from the entered domain ID. Contact the model subscription service and check whether the entered domain ID is correct.

    400

    +

    400

    ModelArts.3072

    +

    ModelArts.3072

    The domain id is the same and does not support subscribing to your own model.

    +

    The domain id is the same and does not support subscribing to your own model.

    You cannot subscribe to your own model.

    +

    You cannot subscribe to your own model.

    Use another account to subscribe to the model.

    +

    Use another account to subscribe to the model.

    400

    +

    400

    ModelArts.3074

    +

    ModelArts.3074

    Unable to delete subscribed model.

    +

    Unable to delete subscribed model.

    Failed to delete the subscribed model.

    +

    Failed to delete the subscribed model.

    Unsubscribe from the model and try again.

    +

    Unsubscribe from the model and try again.

    400

    +

    400

    ModelArts.3076

    +

    ModelArts.3076

    Model does not support deploying edge services and cannot broadcast.

    +

    Model does not support deploying edge services and cannot broadcast.

    Failed to perform the operation because the model cannot be deployed as an edge service.

    +

    Failed to perform the operation because the model cannot be deployed as an edge service.

    The install_type of the model does not support edge service.

    +

    The install_type of the model does not support edge service.

    400

    +

    400

    ModelArts.3077

    +

    ModelArts.3077

    Model is a subscription model that cannot be broadcast.

    +

    Model is a subscription model that cannot be broadcast.

    Failed to perform the operation because the model has been subscribed.

    +

    Failed to perform the operation because the model has been subscribed.

    The model_source of the model has been set to subscribe.

    +

    The model_source of the model has been set to subscribe.

    400

    +

    400

    ModelArts.3078

    +

    ModelArts.3078

    The model status is not normal and cannot be broadcast.

    +

    The model status is not normal and cannot be broadcast.

    Failed to perform the operation because the model status is abnormal.

    +

    Failed to perform the operation because the model status is abnormal.

    Check the model status.

    +

    Check the model status.

    400

    +

    400

    ModelArts.3079

    +

    ModelArts.3079

    Purchased license, can't cancel subscription.

    +

    Purchased license, can't cancel subscription.

    Failed to unsubscribe from the model because a license has been configured for the model.

    +

    Failed to unsubscribe from the model because a license has been configured for the model.

    Delete the license and unsubscribe from the model.

    +

    Delete the license and unsubscribe from the model.

    403

    +

    403

    ModelArts.0108

    +

    ModelArts.0108

    You are not authorized to perform the ({0}) operation.

    +

    You are not authorized to perform the ({0}) operation.

    You do not have permission to perform {0}.

    +

    You do not have permission to perform {0}.

    Check whether you are authorized to perform operations on OBS or APIs.

    +

    Check whether you are authorized to perform operations on OBS or APIs.

    403

    +

    403

    ModelArts.0203

    +

    ModelArts.0203

    Invalid token.

    +

    Invalid token.

    Invalid token.

    +

    Invalid token.

    Obtain a new token and try again.

    +

    Obtain a new token and try again.

    403

    +

    403

    ModelArts.0206

    +

    ModelArts.0206

    Invalid AK/SK.

    +

    Invalid AK/SK.

    Invalid AK/SK.

    +

    Invalid AK/SK.

    Check whether the token is valid.

    +

    Check whether the token is valid.

    403

    +

    403

    ModelArts.3010

    +

    ModelArts.3010

    Failed to copy model, you don't have permission to copy the model ({0}).

    +

    Failed to copy model, you don't have permission to copy the model ({0}).

    You do not have the permission to copy model {0}.

    +

    You do not have the permission to copy model {0}.

    Check whether the entered token or model ID is correct.

    +

    Check whether the entered token or model ID is correct.

    403

    +

    403

    ModelArts.3075

    +

    ModelArts.3075

    Model ({0}) is a subscription model and cannot create a new version.

    +

    Model ({0}) is a subscription model and cannot create a new version.

    Failed to create a new version because model {0} has been subscribed.

    +

    Failed to create a new version because model {0} has been subscribed.

    No new version can be created for a subscribed model.

    +

    No new version can be created for a subscribed model.

    404

    +

    404

    ModelArts.3001

    +

    ModelArts.3001

    Model ({0}) does not exist.

    +

    Model ({0}) does not exist.

    Model {0} does not exist.

    +

    Model {0} does not exist.

    Check whether the entered model ID is correct.

    +

    Check whether the entered model ID is correct.

    404

    +

    404

    ModelArts.3003

    +

    ModelArts.3003

    Failed to get model names list.

    +

    Failed to get model names list.

    Failed to obtain the model name list.

    +

    Failed to obtain the model name list.

    Check whether the account is correct.

    +

    Check whether the account is correct.

    404

    +

    404

    ModelArts.3019

    +

    ModelArts.3019

    Infer format ({0}) does not exist.

    +

    Infer format ({0}) does not exist.

    Input/Output mode {0} does not exist.

    +

    Input/Output mode {0} does not exist.

    Change the input/output mode.

    +

    Change the input/output mode.

    404

    +

    404

    ModelArts.3021

    +

    ModelArts.3021

    Template ({0}) does not exists.

    +

    Template ({0}) does not exists.

    Template {0} does not exist.

    +

    Template {0} does not exist.

    Select another template.

    +

    Select another template.

    404

    +

    404

    ModelArts.3071

    +

    ModelArts.3071

    The subscription ({0}) does not exist.

    +

    The subscription ({0}) does not exist.

    Subscription {0} does not exist.

    +

    Subscription {0} does not exist.

    Subscribe to the model and try again.

    +

    Subscribe to the model and try again.

    404

    +

    404

    ModelArts.3080

    +

    ModelArts.3080

    Model optimization job ({0}) does not exist.

    +

    Model optimization job ({0}) does not exist.

    Model optimization task {0} does not exist.

    +

    Model optimization task {0} does not exist.

    The task is unavailable.

    +

    The task is unavailable.

    409

    +

    409

    ModelArts.3002

    +

    ModelArts.3002

    Model ({0}, {1}) already exists.

    +

    Model ({0}, {1}) already exists.

    Model ({0}, {1}) already exists.

    +

    Model ({0}, {1}) already exists.

    Change the model name or version and try again.

    +

    Change the model name or version and try again.

    409

    +

    409

    ModelArts.3020

    +

    ModelArts.3020

    Infer format ({0}) already exists.

    +

    Infer format ({0}) already exists.

    Input/Output mode {0} already exists.

    +

    Input/Output mode {0} already exists.

    Change the input/output mode.

    +

    Change the input/output mode.

    409

    +

    409

    ModelArts.3022

    +

    ModelArts.3022

    Template ({0}) already exists.

    +

    Template ({0}) already exists.

    Template {0} already exists.

    +

    Template {0} already exists.

    Select another template.

    +

    Select another template.

    409

    +

    409

    ModelArts.3073

    +

    ModelArts.3073

    model ({0}) already exists, no subscription required.

    +

    model ({0}) already exists, no subscription required.

    Model {0} already exists.

    +

    Model {0} already exists.

    Do not subscribe to another model with the same name.

    +

    Do not subscribe to another model with the same name.

    500

    +

    500

    ModelArts.0010

    +

    ModelArts.0010

    Internal error.

    +

    Internal error.

    Internal error.

    +

    Internal error.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.0109

    +

    ModelArts.0109

    Unauthorized account.

    +

    Unauthorized account.

    Unauthorized account.

    +

    Unauthorized account.

    Only the administrator can call alarm APIs.

    +

    Only the system administrator can call alarm APIs.

    500

    +

    500

    ModelArts.3006

    +

    ModelArts.3006

    Failed to publish model.

    +

    Failed to publish model.

    Failed to publish the model.

    +

    Failed to publish the model.

    The model metadata failed to be stored to the database. Contact R&D and O&M personnel.

    +

    The model metadata failed to be stored to the database. Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.3009

    +

    ModelArts.3009

    Failed to delete model, model ({0}) already deploy service.

    +

    Failed to delete model, model ({0}) already deploy service.

    Failed to delete model {0} because it has been deployed as a service.

    +

    Failed to delete model {0} because it has been deployed as a service.

    Delete the deployed service and try again.

    +

    Delete the deployed service and try again.

    500

    +

    500

    ModelArts.3043

    +

    ModelArts.3043

    User ({0}) does not have obs: object: PutObjectAcl permission.

    +

    User ({0}) does not have obs: object: PutObjectAcl permission.

    User {0} does not have the obs:object:PutObjectAcl permission.

    +

    User {0} does not have the obs:object:PutObjectAcl permission.

    Add the permission and try again.

    +

    Add the permission and try again.

    500

    +

    500

    ModelArts.3044

    +

    ModelArts.3044

    Model file ({0}) is larger than 5G and cannot be imported.

    +

    Model file ({0}) is larger than 5G and cannot be imported.

    Failed to import model file {0}.

    +

    Failed to import model file {0}.

    Ensure that the file is at most 5 GB in size.

    +

    Ensure that the file is at most 5 GB in size.

    500

    +

    500

    ModelArts.3045

    +

    ModelArts.3045

    Parameter ({0}) is null.

    +

    Parameter ({0}) is null.

    Parameter {0} is left blank.

    +

    Parameter {0} is left blank.

    Check the parameter setting as prompted.

    +

    Check the parameter setting as prompted.

    500

    +

    500

    ModelArts.3047

    +

    ModelArts.3047

    ExeML model({0}) cannot be converted.

    +

    ExeML model({0}) cannot be converted.

    Failed to convert model {0}.

    +

    Failed to convert model {0}.

    ExeML models cannot be converted.

    +

    ExeML models cannot be converted.

    500

    +

    500

    ModelArts.3048

    +

    ModelArts.3048

    Model({0}) is being imported and cannot be converted.

    +

    Model({0}) is being imported and cannot be converted.

    Failed to convert model {0} because the model status is abnormal.

    +

    Failed to convert model {0} because the model status is abnormal.

    Convert the model after the model status changes to normal.

    +

    Convert the model after the model status changes to normal.

    500

    +

    500

    ModelArts.3049

    +

    ModelArts.3049

    Cannot convert models belonging to other users.

    +

    Cannot convert models belonging to other users.

    Models of other users cannot be converted.

    +

    Models of other users cannot be converted.

    You can only convert your models.

    +

    You can only convert your models.

    500

    +

    500

    ModelArts.3050

    +

    ModelArts.3050

    Get user temporary credential failed.

    +

    Get user temporary credential failed.

    Failed to obtain the temporary user certificate.

    +

    Failed to obtain the temporary user certificate.

    Check whether the token is valid.

    +

    Check whether the token is valid.

    500

    +

    500

    ModelArts.3052

    +

    ModelArts.3052

    Chip Type ({0}) not support.

    +

    Chip Type ({0}) not support.

    Chip type {0} is not supported.

    +

    Chip type {0} is not supported.

    Check whether the chip is of Ascend, GPU, Arm, or general type.

    +

    Check whether the chip is of Ascend, GPU, Arm, or general type.

    500

    +

    500

    ModelArts.3053

    +

    ModelArts.3053

    Model Type ({0}) not support.

    +

    Model Type ({0}) not support.

    Model type {0} is not supported.

    +

    Model type {0} is not supported.

    This type of model is not supported.

    +

    This type of model is not supported.

    500

    +

    500

    ModelArts.3054

    +

    ModelArts.3054

    Task ({0}) does not exists.

    +

    Task ({0}) does not exists.

    Task {0} does not exist.

    +

    Task {0} does not exist.

    The task is unavailable.

    +

    The task is unavailable.

    500

    +

    500

    ModelArts.3055

    +

    ModelArts.3055

    Task ({0}) is running cannot be deleted.

    +

    Task ({0}) is running cannot be deleted.

    Failed to delete task {0} because it is running.

    +

    Failed to delete task {0} because it is running.

    Delete the task after it is complete.

    +

    Delete the task after it is complete.

    500

    +

    500

    ModelArts.3056

    +

    ModelArts.3056

    Task name ({0}) not meeting the specification.

    +

    Task name ({0}) not meeting the specification.

    Task name {0} does not comply with specifications.

    +

    Task name {0} does not comply with specifications.

    Ensure that a task name starts with a lowercase letter, ends with a lowercase letter or digit, and contains 2 to 24 characters, including lowercase letters, digits, and hyphens (-).

    +

    Ensure that a task name starts with a lowercase letter, ends with a lowercase letter or digit, and contains 2 to 24 characters, including lowercase letters, digits, and hyphens (-).

    500

    +

    500

    ModelArts.3057

    +

    ModelArts.3057

    Task description ({0}) not meeting the specification.

    +

    Task description ({0}) not meeting the specification.

    Task description {0} does not comply with specifications.

    +

    Task description {0} does not comply with specifications.

    Ensure that task description contains 1 to 100 characters and cannot contain the following characters: &,!\"<>=.

    +

    Ensure that task description contains 1 to 100 characters and cannot contain the following characters: &,!\"<>=.

    500

    +

    500

    ModelArts.3058

    +

    ModelArts.3058

    Task input ({0}) not meeting the specification.

    +

    Task input ({0}) not meeting the specification.

    Task input {0} does not comply with specifications.

    +

    Task input {0} does not comply with specifications.

    Perform operations according to the error message.

    +

    Perform operations according to the error message.

    500

    +

    500

    ModelArts.3059

    +

    ModelArts.3059

    Task output ({0}) not meeting the specification.

    +

    Task output ({0}) not meeting the specification.

    Task output {0} does not comply with specifications.

    +

    Task output {0} does not comply with specifications.

    Ensure that the task output is a valid HTTP or HTTPS address.

    +

    Ensure that the task output is a valid HTTP or HTTPS address.

    500

    +

    500

    ModelArts.3060

    +

    ModelArts.3060

    Task spec ({0}) not meeting the specification.

    +

    Task spec ({0}) not meeting the specification.

    Advanced task option {0} does not comply with specifications.

    +

    Advanced task option {0} does not comply with specifications.

    Ensure that the advanced option does not contain Chinese characters or the following characters: (|)&$?<>. Ensure that the value is less than 4000.

    +

    Ensure that the advanced option does not contain Chinese characters or the following characters: (|)&$?<>. Ensure that the value is less than 4000.

    500

    +

    500

    ModelArts.3061

    +

    ModelArts.3061

    get Task ({0}) log parameter not meeting the specification.

    +

    get Task ({0}) log parameter not meeting the specification.

    Log parameters of task {0} do not comply with specifications.

    +

    Log parameters of task {0} do not comply with specifications.

    Ensure that the offset or lines value is greater than or equal to 0.

    +

    Ensure that the offset or lines value is greater than or equal to 0.

    500

    +

    500

    ModelArts.3062

    +

    ModelArts.3062

    Task ({0}) exists.

    +

    Task ({0}) exists.

    Task {0} already exists.

    +

    Task {0} already exists.

    Change the name and try again.

    +

    Change the name and try again.

    500

    +

    500

    ModelArts.3064

    +

    ModelArts.3064

    DL Framework Type ({0}) not support.

    +

    DL Framework Type ({0}) not support.

    Deep learning framework {0} is not supported.

    +

    Deep learning framework {0} is not supported.

    This type of framework is not supported.

    +

    This type of framework is not supported.

    500

    +

    500

    ModelArts.3065

    +

    ModelArts.3065

    The image of the model is being built so the runtime cannot be updated.

    +

    The image of the model is being built so the runtime cannot be updated.

    Failed to update runtime because the model image is being created.

    +

    Failed to update runtime because the model image is being created.

    Wait until the image is created.

    +

    Wait until the image is created.

    500

    +

    500

    ModelArts.3301

    +

    ModelArts.3301

    Failed to build image.

    +

    Failed to build image.

    Failed to create the image.

    +

    Failed to create the image.

    Check the image, or contact R&D and O&M personnel to rectify the fault.

    +

    Check the image, or contact R&D and O&M personnel to rectify the fault.

    500

    +

    500

    ModelArts.3801

    +

    ModelArts.3801

    invalid token, can not get template ak/sk.

    +

    invalid token, can not get template ak/sk.

    Failed to obtain the template AK/SK due to an invalid token.

    +

    Failed to obtain the template AK/SK due to an invalid token.

    Obtain a new token and try again.

    +

    Obtain a new token and try again.

    500

    +

    500

    ModelArts.3802

    +

    ModelArts.3802

    create encrypt path or file failed.

    +

    create encrypt path or file failed.

    Failed to create the encryption path or file.

    +

    Failed to create the encryption path or file.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.3803

    +

    ModelArts.3803

    download file from obs failed.

    +

    download file from obs failed.

    Failed to download the file from OBS.

    +

    Failed to download the file from OBS.

    Check whether the OBS path is available.

    +

    Check whether the OBS path is available.

    500

    +

    500

    ModelArts.3804

    +

    ModelArts.3804

    upload file to obs failed.

    +

    upload file to obs failed.

    Failed to upload the file to OBS.

    +

    Failed to upload the file to OBS.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.3805

    +

    ModelArts.3805

    file can not be empty.

    +

    file can not be empty.

    The file cannot be left blank.

    +

    The file cannot be left blank.

    Set file.

    +

    Set file.

    500

    +

    500

    ModelArts.3901

    +

    ModelArts.3901

    license id ({0}) is not exist.

    +

    license id ({0}) is not exist.

    License ID {0} does not exist.

    +

    License ID {0} does not exist.

    Check whether the license ID is valid.

    +

    Check whether the license ID is valid.

    500

    +

    500

    ModelArts.3902

    +

    ModelArts.3902

    Failed to get license info because ({0}).

    +

    Failed to get license info because ({0}).

    Failed to obtain the license because {Reason}.

    +

    Failed to obtain the license because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3903

    +

    ModelArts.3903

    Renew license failed because ({0}).

    +

    Renew license failed because ({0}).

    Failed to renew the license because {Reason}.

    +

    Failed to renew the license because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3904

    +

    ModelArts.3904

    Upload data failed because ({0}).

    +

    Upload data failed because ({0}).

    Failed to report the used quota because {Reason}.

    +

    Failed to report the used quota because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3905

    +

    ModelArts.3905

    Failed to get app key.

    +

    Failed to get app key.

    Failed to obtain the app key.

    +

    Failed to obtain the app key.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.3906

    +

    ModelArts.3906

    Failed to create license because ({0}).

    +

    Failed to create license because ({0}).

    Failed to create the license because {Reason}.

    +

    Failed to create the license because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3907

    +

    ModelArts.3907

    Failed to delete license because ({0}).

    +

    Failed to delete license because ({0}).

    Failed to delete the license because {Reason}.

    +

    Failed to delete the license because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3908

    +

    ModelArts.3908

    Failed to get CBC resources.

    +

    Failed to get CBC resources.

    Failed to obtain CBC resources.

    +

    Failed to obtain CBC resources.

    Check the license ID or the associated license configuration.

    +

    Check the license ID or the associated license configuration.

    500

    +

    500

    ModelArts.3909

    +

    ModelArts.3909

    access CBC failed.

    +

    access CBC failed.

    Failed to access CBC.

    +

    Failed to access CBC.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    500

    +

    500

    ModelArts.3910

    +

    ModelArts.3910

    Check CBC auth failed because ({0}).

    +

    Check CBC auth failed because ({0}).

    Failed to authorize CBC operations because {Reason}.

    +

    Failed to authorize CBC operations because {Reason}.

    Locate the fault based on the failure cause. Renewal authentication fails because cloudservicetype is not provided. Unsubscription authentication fails because an instance is being deployed.

    +

    Locate the fault based on the failure cause. Renewal authentication fails because cloudservicetype is not provided. Unsubscription authentication fails because an instance is being deployed.

    500

    +

    500

    ModelArts.7001

    +

    ModelArts.7001

    Internal error occurred in workspace manager.

    +

    Internal error occurred in workspace manager.

    An internal error occurred in the workspace manager.

    +

    An internal error occurred in the workspace manager.

    Contact R&D and O&M personnel.

    +

    Contact R&D and O&M personnel.

    400

    +

    400

    ModelArts.3514

    +

    ModelArts.3514

    Field [input_params] must be set for the model that is used to deploy the batch service.

    +

    Field [input_params] must be set for the model that is used to deploy the batch service.

    The input_params parameter for the batch service model is left blank.

    +

    The input_params parameter for the batch service model is left blank.

    Set input_params.

    +

    Set input_params.

    400

    +

    400

    ModelArts.3515

    +

    ModelArts.3515

    The model {id} cannot be used for deploying services because it is still being published.

    +

    The model {id} cannot be used for deploying services because it is still being published.

    Failed to deploy the service because model {ID} is not ready.

    +

    Failed to deploy the service because model {ID} is not ready.

    Try again after the model is ready.

    +

    Try again after the model is ready.

    400

    +

    400

    ModelArts.3516

    +

    ModelArts.3516

    Failed to deploy services because the version of the model that is used for deploying services is the same.

    +

    Failed to deploy services because the version of the model that is used for deploying services is the same.

    Failed to deploy the service due to duplicate model versions.

    +

    Failed to deploy the service due to duplicate model versions.

    Correct the model version list to ensure that no duplicate model versions exist.

    +

    Correct the model version list to ensure that no duplicate model versions exist.

    400

    +

    400

    ModelArts.3518

    +

    ModelArts.3518

    The {service_type} service has not been enabled or authorized.

    +

    The {service_type} service has not been enabled or authorized.

    Service {type} has not been enabled or authorized.

    +

    Service {type} has not been enabled or authorized.

    Enable or authorize the service.

    +

    Enable or authorize the service.

    400

    +

    400

    ModelArts.3519

    +

    ModelArts.3519

    Services only in one of states in [deploying, running, stopping, deleting] can be updated.

    +

    Services only in one of states in [deploying, running, stopping, deleting] can be updated.

    Services in the deploying, running, stopping, or deleting state cannot be updated.

    +

    Services in the deploying, running, stopping, or deleting state cannot be updated.

    Do not update services in the deploying, running, stopping, or deleting state.

    +

    Do not update services in the deploying, running, stopping, or deleting state.

    400

    +

    400

    ModelArts.3520

    +

    ModelArts.3520

    A maximum of {number} {service_type} services are allowed.

    +

    A maximum of {number} {service_type} services are allowed.

    The total number of {type} services has reached the maximum allowed limit {quantity}.

    +

    The total number of {type} services has reached the maximum allowed limit {quantity}.

    Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota.

    +

    Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota.

    400

    +

    400

    ModelArts.3521

    +

    ModelArts.3521

    A maximum of {number} {service_type} services in running status are allowed.

    +

    A maximum of {number} {service_type} services in running status are allowed.

    The total number of {type} services in the running state has reached the maximum allowed limit {quantity}.

    +

    The total number of {type} services in the running state has reached the maximum allowed limit {quantity}.

    Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota.

    +

    Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota.

    400

    +

    400

    ModelArts.3522

    +

    ModelArts.3522

    A maximum of {number} {service_type} service instances are allowed.

    +

    A maximum of {number} {service_type} service instances are allowed.

    The total number of {type} service instances has reached the maximum allowed limit {quantity}.

    +

    The total number of {type} service instances has reached the maximum allowed limit {quantity}.

    Delete the service instances that are no longer used or contact service O&M personnel to increase the quantity quota.

    +

    Delete the service instances that are no longer used or contact service O&M personnel to increase the quantity quota.

    400

    +

    400

    ModelArts.3523

    +

    ModelArts.3523

    Service {name} has been subscribed.

    +

    Service {name} has been subscribed.

    Service {name} has been subscribed.

    +

    Service {name} has been subscribed.

    Directly use the subscribed service.

    +

    Directly use the subscribed service.

    400

    +

    400

    ModelArts.3524

    +

    ModelArts.3524

    Failed to subscribe to the service because {reason}.

    +

    Failed to subscribe to the service because {reason}.

    Failed to subscribe to the service because {Reason}.

    +

    Failed to subscribe to the service because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3525

    +

    ModelArts.3525

    Forbidden to update service {name} because it is a shared service.

    +

    Forbidden to update service {name} because it is a shared service.

    Failed to update service {name} because it is a shared service.

    +

    Failed to update service {name} because it is a shared service.

    Do not update a shared service.

    +

    Do not update a shared service.

    400

    +

    400

    ModelArts.3527

    +

    ModelArts.3527

    Forbidden to subscribe to service {id} because it is a {service_type} service.

    +

    Forbidden to subscribe to service {id} because it is a {service_type} service.

    Failed to subscribe to service {ID} because it is a {type} service.

    +

    Failed to subscribe to service {ID} because it is a {type} service.

    The service of this type cannot be subscribed to.

    +

    The service of this type cannot be subscribed to.

    400

    +

    400

    ModelArts.3528

    +

    ModelArts.3528

    Forbidden to subscribe to service {id} because it is released by yourself.

    +

    Forbidden to subscribe to service {id} because it is released by yourself.

    Failed to subscribe to service {ID} because it is your service.

    +

    Failed to subscribe to service {ID} because it is your service.

    You cannot subscribe to services published by yourself.

    +

    You cannot subscribe to services published by yourself.

    400

    +

    400

    ModelArts.3529

    +

    ModelArts.3529

    Model {id} under service {id} does not exist.

    +

    Model {id} under service {id} does not exist.

    Model {ID} of service {ID} does not exist.

    +

    Model {ID} of service {ID} does not exist.

    Ensure that the model ID is correctly set and that the model belongs to the target service.

    +

    Ensure that the model ID is correctly set and that the model belongs to the target service.

    400

    +

    400

    ModelArts.3531

    +

    ModelArts.3531

    Service {id} has created the QR code.

    +

    Service {id} has created the QR code.

    A QR code has been created for service {ID}.

    +

    A QR code has been created for service {ID}.

    The QR code has been created for the service and does not need to be created again.

    +

    The QR code has been created for the service and does not need to be created again.

    400

    +

    400

    ModelArts.3532

    +

    ModelArts.3532

    No QR code found for service {id}.

    +

    No QR code found for service {id}.

    A QR code has not been created for service {ID}.

    +

    A QR code has not been created for service {ID}.

    Create a QR code for the service and try again.

    +

    Create a QR code for the service and try again.

    400

    +

    400

    ModelArts.3533

    +

    ModelArts.3533

    The selected edge node does not support {GPU/NPU}.

    +

    The selected edge node does not support {GPU/NPU}.

    The selected edge node flavor does not support {GPU/NPU}.

    +

    The selected edge node flavor does not support {GPU/NPU}.

    Add the target hardware support to the selected edge node, or use another edge node that supports the target hardware.

    +

    Add the target hardware support to the selected edge node, or use another edge node that supports the target hardware.

    400

    +

    400

    ModelArts.3534

    +

    ModelArts.3534

    The security group must contain at least one inbound rule to allow the TCP request from source address 0.0.0.0/0 and port 8080.

    +

    The security group must contain at least one inbound rule to allow the TCP request from source address 0.0.0.0/0 and port 8080.

    The security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is 0.0.0.0/0, and port number is 8080.

    +

    The security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is 0.0.0.0/0, and port number is 8080.

    Add the inbound rule to the security group.

    +

    Add the inbound rule to the security group.

    400

    +

    400

    ModelArts.3535

    +

    ModelArts.3535

    Subservice {name} of service {name} does not exist.

    +

    Subservice {name} of service {name} does not exist.

    Subservice {name} of service {name} does not exist.

    +

    Subservice {name} of service {name} does not exist.

    Ensure that the subservice name is correctly set and that the subservice belongs to the target service.

    +

    Ensure that the subservice name is correctly set and that the subservice belongs to the target service.

    400

    +

    400

    ModelArts.3536

    +

    ModelArts.3536

    Subservice {name} of service {name} has been subscribed.

    +

    Subservice {name} of service {name} has been subscribed.

    You have subscribed to subservice {name} of service {name}.

    +

    You have subscribed to subservice {name} of service {name}.

    Directly use the subscribed subservice.

    +

    Directly use the subscribed subservice.

    400

    +

    400

    ModelArts.3538

    +

    ModelArts.3538

    The requirement notification of service {name} should not exceed one.

    +

    The requirement notification of service {name} should not exceed one.

    At most one requirement notification is allowed for service {name}.

    +

    At most one requirement notification is allowed for service {name}.

    Check the configuration and ensure that no more than one requirement notification is configured for service {name}.

    +

    Check the configuration and ensure that no more than one requirement notification is configured for service {name}.

    400

    +

    400

    ModelArts.3540

    +

    ModelArts.3540

    Operation failed because you are not the owner of service {name}.

    +

    Operation failed because you are not the owner of service {name}.

    You are not the owner of service {name}.

    +

    You are not the owner of service {name}.

    This operation can be performed only by the service owner.

    +

    This operation can be performed only by the service owner.

    400

    +

    400

    ModelArts.3541

    +

    ModelArts.3541

    Error code {error_code} of service {name} does not exist.

    +

    Error code {error_code} of service {name} does not exist.

    Error code {error code} of service {name} does not exist.

    +

    Error code {error code} of service {name} does not exist.

    Ensure that the error code is correctly set and that the error code belongs to the target service.

    +

    Ensure that the error code is correctly set and that the error code belongs to the target service.

    400

    +

    400

    ModelArts.3542

    +

    ModelArts.3542

    Error code {error_code} of service {name} already exists.

    +

    Error code {error_code} of service {name} already exists.

    Error code {error code} of service {name} already exists.

    +

    Error code {error code} of service {name} already exists.

    Change the error code and try again.

    +

    Change the error code and try again.

    400

    +

    400

    ModelArts.3544

    +

    ModelArts.3544

    URL domain CNAME resolution failed.

    +

    URL domain CNAME resolution failed.

    Failed to parse the CNAME domain.

    +

    Failed to parse the CNAME domain.

    Check whether the URL is correct.

    +

    Check whether the URL is correct.

    400

    +

    400

    ModelArts.3545

    +

    ModelArts.3545

    Invalid certificate or private key.

    +

    Invalid certificate or private key.

    Invalid certificate or private key.

    +

    Invalid certificate or private key.

    Check whether the certificate or private key is correctly configured.

    +

    Check whether the certificate or private key is correctly configured.

    400

    +

    400

    ModelArts.3547

    +

    ModelArts.3547

    Cluster {id} does not exist.

    +

    Cluster {id} does not exist.

    Cluster {ID} does not exist.

    +

    Cluster {ID} does not exist.

    Check whether the cluster ID is correct.

    +

    Check whether the cluster ID is correct.

    400

    +

    400

    ModelArts.3548

    +

    ModelArts.3548

    Path {path} is not a valid regex.

    +

    Path {path} is not a valid regex.

    Path {path} is not a valid regular expression.

    +

    Path {path} is not a valid regular expression.

    Check whether the path is correct.

    +

    Check whether the path is correct.

    400

    +

    400

    ModelArts.3549

    +

    ModelArts.3549

    Error code {code} is duplicated.

    +

    Error code {code} is duplicated.

    Duplicate error code {error code} in the request body.

    +

    Duplicate error code {error code} in the request body.

    Modify the error code to ensure that the error code is unique.

    +

    Modify the error code to ensure that the error code is unique.

    400

    +

    400

    ModelArts.3550

    +

    ModelArts.3550

    Domain {name} has been used.

    +

    Domain {name} has been used.

    Domain {noun} has been used.

    +

    Domain {noun} has been used.

    Change the domain name and try again.

    +

    Change the domain name and try again.

    400

    +

    400

    ModelArts.3551

    +

    ModelArts.3551

    OBS path {path} does not exist.

    +

    OBS path {path} does not exist.

    OBS path {path} does not exist.

    +

    OBS path {path} does not exist.

    Check whether the OBS path is correct.

    +

    Check whether the OBS path is correct.

    400

    +

    400

    ModelArts.3552

    +

    ModelArts.3552

    The length of [resource_id] must be in the range of [0, 64].

    +

    The length of [resource_id] must be in the range of [0, 64].

    The resource_id value is not in the range from 0 to 64.

    +

    The resource_id value is not in the range from 0 to 64.

    Check whether RESOURCE_SPEC_CODE is too long.

    +

    Check whether RESOURCE_SPEC_CODE is too long.

    400

    +

    400

    ModelArts.3553

    +

    ModelArts.3553

    Service {name} not subscribed yet.

    +

    Service {name} not subscribed yet.

    Service {name} has not been subscribed to.

    +

    Service {name} has not been subscribed to.

    Subscribe to the service and try again.

    +

    Subscribe to the service and try again.

    400

    +

    400

    ModelArts.3554

    +

    ModelArts.3554

    Cluster name {name} has been used.

    +

    Cluster name {name} has been used.

    Cluster name {name} has been used.

    +

    Cluster name {name} has been used.

    Change the cluster name and try again.

    +

    Change the cluster name and try again.

    400

    +

    400

    ModelArts.3556

    +

    ModelArts.3556

    Forbidden to share ai-service {id} because ai-service is unsharable.

    +

    Forbidden to share ai-service {id} because ai-service is unsharable.

    AI service {ID} cannot be shared.

    +

    AI service {ID} cannot be shared.

    AI services cannot be shared.

    +

    AI services cannot be shared.

    400

    +

    400

    ModelArts.3559

    +

    ModelArts.3559

    Source error code {error_code} of service {name} already exists.

    +

    Source error code {error_code} of service {name} already exists.

    Source error code {error code} of service {name} already exists.

    +

    Source error code {error code} of service {name} already exists.

    Change the source error code and try again.

    +

    Change the source error code and try again.

    400

    +

    400

    ModelArts.3560

    +

    ModelArts.3560

    Project {project_id} has not subscribed to subservice {id}.

    +

    Project {project_id} has not subscribed to subservice {id}.

    Subservice {ID} has not been subscribed for project {ID}.

    +

    Subservice {ID} has not been subscribed for project {ID}.

    Subscribe to the subservice and try again.

    +

    Subscribe to the subservice and try again.

    400

    +

    400

    ModelArts.3561

    +

    ModelArts.3561

    Insufficient node quota.

    +

    Insufficient node quota.

    Insufficient node quota.

    +

    Insufficient node quota.

    Contact service O&M personnel to increase the quota or delete unnecessary nodes to release resources.

    +

    Contact service O&M personnel to increase the quota or delete unnecessary nodes to release resources.

    400

    +

    400

    ModelArts.3562

    +

    ModelArts.3562

    The value of field {due_time} must be a future time.

    +

    The value of field {due_time} must be a future time.

    The due_time value must be later than the current time.

    +

    The due_time value must be later than the current time.

    Set the due_time parameter to a time later than the current time.

    +

    Set the due_time parameter to a time later than the current time.

    400

    +

    400

    ModelArts.3564

    +

    ModelArts.3564

    The sample collection task has been created for service {id}.

    +

    The sample collection task has been created for service {id}.

    Sample collection for service {ID} has been created.

    +

    Sample collection for service {ID} has been created.

    Do not create the task again.

    +

    Do not create the task again.

    400

    +

    400

    ModelArts.3565

    +

    ModelArts.3565

    No sample collection task is created for service {id}.

    +

    No sample collection task is created for service {id}.

    Sample collection for service {ID} has not been created.

    +

    Sample collection for service {ID} has not been created.

    Create a service sample collection task and try again.

    +

    Create a service sample collection task and try again.

    400

    +

    400

    ModelArts.3566

    +

    ModelArts.3566

    Forbidden to modify the default workspace.

    +

    Forbidden to modify the default workspace.

    The default workspace cannot be modified.

    +

    The default workspace cannot be modified.

    Do not modify the default workspace.

    +

    Do not modify the default workspace.

    400

    +

    400

    ModelArts.3567

    +

    ModelArts.3567

    OBS error occurs because {reason}.

    +

    OBS error occurs because {reason}.

    OBS error because {cause}.

    +

    OBS error because {cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3568

    +

    ModelArts.3568

    OBS client error occurs.

    +

    OBS client error occurs.

    The OBS client is abnormal.

    +

    The OBS client is abnormal.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3572

    +

    ModelArts.3572

    Invalid OBS URL {url}.

    +

    Invalid OBS URL {url}.

    Invalid OBS path {path}.

    +

    Invalid OBS path {path}.

    Check whether the OBS path is correct.

    +

    Check whether the OBS path is correct.

    400

    +

    400

    ModelArts.3573

    +

    ModelArts.3573

    Failed to obtain the bucket name from OBS URL {url}.

    +

    Failed to obtain the bucket name from OBS URL {url}.

    Failed to obtain the bucket name from OBS path {path}.

    +

    Failed to obtain the bucket name from OBS path {path}.

    Check whether the OBS path is correct.

    +

    Check whether the OBS path is correct.

    400

    +

    400

    ModelArts.3574

    +

    ModelArts.3574

    Failed to validate the correctness of OBS URL {url}.

    +

    Failed to validate the correctness of OBS URL {url}.

    Failed to check OBS path {path}.

    +

    Failed to check OBS path {path}.

    Check whether the OBS path is correct.

    +

    Check whether the OBS path is correct.

    400

    +

    400

    ModelArts.3576

    +

    ModelArts.3576

    Failed to query the model quota.

    +

    Failed to query the model quota.

    Failed to obtain the model quota.

    +

    Failed to obtain the model quota.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3577

    +

    ModelArts.3577

    Failed to update the model quota.

    +

    Failed to update the model quota.

    Failed to update the model quota.

    +

    Failed to update the model quota.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3578

    +

    ModelArts.3578

    Insufficient model quota. Increase the quota or delete any unnecessary services.

    +

    Insufficient model quota. Increase the quota or delete any unnecessary services.

    Insufficient model quota.

    +

    Insufficient model quota.

    Increase the quota or delete the models that are no longer used, and try again.

    +

    Increase the quota or delete the models that are no longer used, and try again.

    400

    +

    400

    ModelArts.3580

    +

    ModelArts.3580

    Model not purchased.

    +

    Model not purchased.

    The model has not been purchased.

    +

    The model has not been purchased.

    Purchase the model and try again.

    +

    Purchase the model and try again.

    400

    +

    400

    ModelArts.3582

    +

    ModelArts.3582

    Failed to create edge configurations.

    +

    Failed to create edge configurations.

    Failed to create edge configurations.

    +

    Failed to create edge configurations.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3583

    +

    ModelArts.3583

    Failed to create the edge application due to IEF error.

    +

    Failed to create the edge application due to IEF error.

    Failed to create the edge application due to an IEF platform error.

    +

    Failed to create the edge application due to an IEF platform error.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3584

    +

    ModelArts.3584

    Failed to update the edge application.

    +

    Failed to update the edge application.

    Failed to update the edge application.

    +

    Failed to update the edge application.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3585

    +

    ModelArts.3585

    The host port has been used by another edge application.

    +

    The host port has been used by another edge application.

    The host port has been used by another edge application.

    +

    The host port has been used by another edge application.

    Use another port or contact service O&M personnel.

    +

    Use another port or contact service O&M personnel.

    400

    +

    400

    ModelArts.3586

    +

    ModelArts.3586

    Failed to create the edge application.

    +

    Failed to create the edge application.

    Failed to create the edge application.

    +

    Failed to create the edge application.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3587

    +

    ModelArts.3587

    Failed to delete the edge application.

    +

    Failed to delete the edge application.

    Failed to delete the edge application.

    +

    Failed to delete the edge application.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3588

    +

    ModelArts.3588

    Failed to create edge volumes and environments.

    +

    Failed to create edge volumes and environments.

    Failed to create edge parameters.

    +

    Failed to create edge parameters.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3589

    +

    ModelArts.3589

    Model {id} cannot be used to deploy {service_type} service.

    +

    Model {id} cannot be used to deploy {service_type} service.

    Model {ID} cannot be used to deploy the {type} service.

    +

    Model {ID} cannot be used to deploy the {type} service.

    Select another deployment type.

    +

    Select another deployment type.

    400

    +

    400

    ModelArts.3590

    +

    ModelArts.3590

    Invalid expression rule. Create a rule using Spring Expression Language and the desired result type is Boolean.

    +

    Invalid expression rule. Create a rule using Spring Expression Language and the desired result type is Boolean.

    Invalid expression rule.

    +

    Invalid expression rule.

    Ensure that the rule complies with the Spring expression language syntax, and the expected result is of Boolean type.

    +

    Ensure that the rule complies with the Spring expression language syntax, and the expected result is of Boolean type.

    400

    +

    400

    ModelArts.3591

    +

    ModelArts.3591

    There are duplicate rules in the extend-configs.

    +

    There are duplicate rules in the extend-configs.

    Duplicate rules in extend-configs.

    +

    Duplicate rules in extend-configs.

    Modify the expression specifications to prevent duplicate expressions.

    +

    Modify the expression specifications to prevent duplicate expressions.

    400

    +

    400

    ModelArts.3592

    +

    ModelArts.3592

    Incorrect model health configuration.

    +

    Incorrect model health configuration.

    Incorrect model health check parameters.

    +

    Incorrect model health check parameters.

    Check whether the health check parameters of the model are correct.

    +

    Check whether the health check parameters of the model are correct.

    400

    +

    400

    ModelArts.3593

    +

    ModelArts.3593

    The model has been expired.

    +

    The model has been expired.

    The model has expired.

    +

    The model has expired.

    Purchase or subscribe to the model again.

    +

    Purchase or subscribe to the model again.

    400

    +

    400

    ModelArts.3594

    +

    ModelArts.3594

    Failed to query IEF instances.

    +

    Failed to query IEF instances.

    Failed to obtain the edge instance.

    +

    Failed to obtain the edge instance.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3595

    +

    ModelArts.3595

    Failed to create the IEF application mesh.

    +

    Failed to create the IEF application mesh.

    Failed to create the application mesh.

    +

    Failed to create the application mesh.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3596

    +

    ModelArts.3596

    Failed to update the IEF application mesh.

    +

    Failed to update the IEF application mesh.

    Failed to update the application mesh.

    +

    Failed to update the application mesh.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3597

    +

    ModelArts.3597

    Please authorize the development environment to use and store your AK and SK.

    +

    Please authorize the development environment to use and store your AK and SK.

    Failed to use the service because the development environment has not been authorized to store and use your AK and SK.

    +

    Failed to use the service because the development environment has not been authorized to store and use your AK and SK.

    Authorize the development environment to store and use your AK and SK.

    +

    Authorize the development environment to store and use your AK and SK.

    400

    +

    400

    ModelArts.3598

    +

    ModelArts.3598

    Only nodes in the [Running] state can be selected.

    +

    Only nodes in the [Running] state can be selected.

    Only running nodes can be selected.

    +

    Only running nodes can be selected.

    Select a running node and try again.

    +

    Select a running node and try again.

    400

    +

    400

    ModelArts.3610

    +

    ModelArts.3610

    Parameter {name} cannot be empty.

    +

    Parameter {name} cannot be empty.

    Parameter {name} cannot be left blank.

    +

    Parameter {name} cannot be left blank.

    Set the parameter and try again.

    +

    Set the parameter and try again.

    400

    +

    400

    ModelArts.3611

    +

    ModelArts.3611

    Failed to query the batch task run log.

    +

    Failed to query the batch task run log.

    Failed to obtain batch processing task logs.

    +

    Failed to obtain batch processing task logs.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3612

    +

    ModelArts.3612

    Failed to {create/update} the service payload due to error code {code}. Please try later or submit a service ticket for professional technical support.

    +

    Failed to {create/update} the service payload due to error code {code}. Please try later or submit a service ticket for professional technical support.

    Failed to {create/update} service workload. The error code is {error code}. Try again later or submit a service ticket.

    +

    Failed to {create/update} service workload. The error code is {error code}. Try again later or submit a service ticket.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3613

    +

    ModelArts.3613

    Failed to register the API. Please try later or submit a service ticket for professional technical support.

    +

    Failed to register the API. Please try later or submit a service ticket for professional technical support.

    Failed to register the service API. Try again later or submit a service ticket.

    +

    Failed to register the service API. Try again later or submit a service ticket.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3620

    +

    ModelArts.3620

    Failed to get the number of associated services.

    +

    Failed to get the number of associated services.

    Failed to obtain the number of associated services.

    +

    Failed to obtain the number of associated services.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3811

    +

    ModelArts.3811

    Failed to query the agency because {reason}.

    +

    Failed to query the agency because {reason}.

    Failed to obtain the agency because {Reason}.

    +

    Failed to obtain the agency because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3812

    +

    ModelArts.3812

    Failed to create AI resource specification code {code} because {reason}.

    +

    Failed to create AI resource specification code {code} because {reason}.

    Failed to create resource flavor code {code} because {Reason}.

    +

    Failed to create resource flavor code {code} because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3813

    +

    ModelArts.3813

    Failed to update AI resource specification code {code} because {reason}.

    +

    Failed to update AI resource specification code {code} because {reason}.

    Failed to update resource flavor code {code} because {Reason}.

    +

    Failed to update resource flavor code {code} because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3814

    +

    ModelArts.3814

    Failed to delete AI resource specification code {code} because {reason}.

    +

    Failed to delete AI resource specification code {code} because {reason}.

    Failed to delete resource flavor code {code} because {Reason}.

    +

    Failed to delete resource flavor code {code} because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3815

    +

    ModelArts.3815

    Failed to delete AI subservice {id} because {reason}.

    +

    Failed to delete AI subservice {id} because {reason}.

    Failed to delete subservice {ID} because {Reason}.

    +

    Failed to delete subservice {ID} because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3816

    +

    ModelArts.3816

    Failed to create the AI proxy mapping because {reason}.

    +

    Failed to create the AI proxy mapping because {reason}.

    Failed to create the proxy mapping because {reason}.

    +

    Failed to create the proxy mapping because {reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3817

    +

    ModelArts.3817

    Failed to update the AI proxy mapping because {reason}.

    +

    Failed to update the AI proxy mapping because {reason}.

    Failed to update the proxy mapping path because {reason}.

    +

    Failed to update the proxy mapping path because {reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3818

    +

    ModelArts.3818

    The agency of service {name} has been defined.

    +

    The agency of service {name} has been defined.

    The agency of service {name} has been configured.

    +

    The agency of service {name} has been configured.

    Do not repeat the operation.

    +

    Do not repeat the operation.

    400

    +

    400

    ModelArts.3822

    +

    ModelArts.3822

    The batch service task does not exist.

    +

    The batch service task does not exist.

    The batch service does not exist.

    +

    The batch service does not exist.

    Enter the correct batch service ID.

    +

    Enter the correct batch service ID.

    400

    +

    400

    ModelArts.3825

    +

    ModelArts.3825

    Failed to generate the SDR data because {reason}.

    +

    Failed to generate the SDR data because {reason}.

    Failed to generate CDR data because {Reason}.

    +

    Failed to generate CDR data because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3826

    +

    ModelArts.3826

    Failed to create the API because {reason}.

    +

    Failed to create the API because {reason}.

    Failed to create the API because {Reason}.

    +

    Failed to create the API because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3827

    +

    ModelArts.3827

    Failed to subscribe to the API because {reason}.

    +

    Failed to subscribe to the API because {reason}.

    Failed to subscribe to the API because {Reason}.

    +

    Failed to subscribe to the API because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3828

    +

    ModelArts.3828

    Failed to unsubscribe from the API because {reason}.

    +

    Failed to unsubscribe from the API because {reason}.

    Failed to unsubscribe from the API because {Reason}.

    +

    Failed to unsubscribe from the API because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3829

    +

    ModelArts.3829

    Failed to modify the API subscription status because {reason}.

    +

    Failed to modify the API subscription status because {reason}.

    Failed to update the API subscription because {Reason}.

    +

    Failed to update the API subscription because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3830

    +

    ModelArts.3830

    Operation not allowed. Change the charging mode from postpaid to prepaid in CBC.

    +

    Operation not allowed. Change the charging mode from postpaid to prepaid in CBC.

    You are not allowed to change the billing mode from postpaid to prepaid.

    +

    You are not allowed to change the billing mode from postpaid to prepaid.

    Change the billing mode in CBC.

    +

    Change the billing mode in CBC.

    400

    +

    400

    ModelArts.3831

    +

    ModelArts.3831

    Operation not allowed. Change the charging mode from prepaid to postpaid in CBC.

    +

    Operation not allowed. Change the charging mode from prepaid to postpaid in CBC.

    You are not allowed to change the billing mode from prepaid to postpaid.

    +

    You are not allowed to change the billing mode from prepaid to postpaid.

    Change the billing mode in CBC.

    +

    Change the billing mode in CBC.

    400

    +

    400

    ModelArts.3832

    +

    ModelArts.3832

    The subscription configuration is not modified and does not need to be updated. Please check.

    +

    The subscription configuration is not modified and does not need to be updated. Please check.

    Failed to perform the operation because the subscription configuration has not modified.

    +

    Failed to perform the operation because the subscription configuration has not modified.

    Change the subscription configuration and try again.

    +

    Change the subscription configuration and try again.

    400

    +

    400

    ModelArts.3833

    +

    ModelArts.3833

    Failed to delete the API because {reason}.

    +

    Failed to delete the API because {reason}.

    Failed to delete the API because {Reason}.

    +

    Failed to delete the API because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3834

    +

    ModelArts.3834

    Failed to update metedata in CBC because {reason}.

    +

    Failed to update metedata in CBC because {reason}.

    Failed to update the CBC metadata because {Reason}.

    +

    Failed to update the CBC metadata because {Reason}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3835

    +

    ModelArts.3835

    Resource specification code {code} of service {name} does not exist.

    +

    Resource specification code {code} of service {name} does not exist.

    Resource flavor code {code} of service {name} does not exist.

    +

    Resource flavor code {code} of service {name} does not exist.

    Ensure that the resource flavor code is correctly set and that the code belongs to the target service.

    +

    Ensure that the resource flavor code is correctly set and that the code belongs to the target service.

    400

    +

    400

    ModelArts.3836

    +

    ModelArts.3836

    Resource specification code {code} of project {id} does not exist.

    +

    Resource specification code {code} of project {id} does not exist.

    Resource flavor code {code} of project {1} does not exist.

    +

    Resource flavor code {code} of project {1} does not exist.

    Ensure that the resource flavor code is correctly set and that the code belongs to the target project.

    +

    Ensure that the resource flavor code is correctly set and that the code belongs to the target project.

    400

    +

    400

    ModelArts.3837

    +

    ModelArts.3837

    Resource ID {id} of project {id} does not exist.

    +

    Resource ID {id} of project {id} does not exist.

    Resource {ID} of project {1} does not exist.

    +

    Resource {ID} of project {1} does not exist.

    Ensure that the resource ID is correctly set and that the resource belongs to the target project.

    +

    Ensure that the resource ID is correctly set and that the resource belongs to the target project.

    400

    +

    400

    ModelArts.3838

    +

    ModelArts.3838

    The hard-select has not been enabled for service {id}.

    +

    The hard-select has not been enabled for service {id}.

    Hard example filtering of service {0} has not been enabled.

    +

    Hard example filtering of service {0} has not been enabled.

    Enable hard example filtering for the service and try again.

    +

    Enable hard example filtering for the service and try again.

    400

    +

    400

    ModelArts.3839

    +

    ModelArts.3839

    The hard-select has been enabled for service {id}.

    +

    The hard-select has been enabled for service {id}.

    Hard example filtering of service {0} has been enabled.

    +

    Hard example filtering of service {0} has been enabled.

    You do not need to enable it again.

    +

    You do not need to enable it again.

    400

    +

    400

    ModelArts.3840

    +

    ModelArts.3840

    Only one algorithm can be set for the service model.

    +

    Only one algorithm can be set for the service model.

    Service {0} has more than one labeling type.

    +

    Service {0} has more than one labeling type.

    Modify the configuration to ensure that there is only one labeling type.

    +

    Modify the configuration to ensure that there is only one labeling type.

    400

    +

    400

    ModelArts.3841

    +

    ModelArts.3841

    The value of [dataset_type] must be one of values in [image_classification, object_detection].

    +

    The value of [dataset_type] must be one of values in [image_classification, object_detection].

    The labeling type is not object detection or image classification.

    +

    The labeling type is not object detection or image classification.

    Change the labeling type to object detection or image classification.

    +

    Change the labeling type to object detection or image classification.

    400

    +

    400

    ModelArts.3842

    +

    ModelArts.3842

    The labeling type of service algorithm {name} does not match that of dataset {type}.

    +

    The labeling type of service algorithm {name} does not match that of dataset {type}.

    The labeling type of service algorithm {0} does not match that of dataset {1}.

    +

    The labeling type of service algorithm {0} does not match that of dataset {1}.

    Modify the labeling type or contact service O&M personnel.

    +

    Modify the labeling type or contact service O&M personnel.

    400

    +

    400

    ModelArts.3843

    +

    ModelArts.3843

    Failed to query the information about dataset {id}.

    +

    Failed to query the information about dataset {id}.

    Failed to obtain database {0}.

    +

    Failed to obtain database {0}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3844

    +

    ModelArts.3844

    Failed to import samples to dataset {id}.

    +

    Failed to import samples to dataset {id}.

    Failed to import the sample to dataset {0}.

    +

    Failed to import the sample to dataset {0}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3845

    +

    ModelArts.3845

    No sample is available for import under the OBS path {path} of service {id}.

    +

    No sample is available for import under the OBS path {path} of service {id}.

    No sample is available to be imported to OBS path {path} of service {ID}.

    +

    No sample is available to be imported to OBS path {path} of service {ID}.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3846

    +

    ModelArts.3846

    Failed to add the OBS bucket lifecycle rule for service {id}.

    +

    Failed to add the OBS bucket lifecycle rule for service {id}.

    Failed to add the lifecycle rule for the OBS bucket of service {ID}.

    +

    Failed to add the lifecycle rule for the OBS bucket of service {ID}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3847

    +

    ModelArts.3847

    Failed to delete the OBS bucket lifecycle rule for service {id}.

    +

    Failed to delete the OBS bucket lifecycle rule for service {id}.

    Failed to delete the lifecycle rule for the OBS bucket of service {ID}.

    +

    Failed to delete the lifecycle rule for the OBS bucket of service {ID}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3848

    +

    ModelArts.3848

    Service {id} in the information of dataset {import_type} already exists.

    +

    Service {id} in the information of dataset {import_type} already exists.

    The service {ID} of the {import type} dataset already exists.

    +

    The service {ID} of the {import type} dataset already exists.

    Check the request and select the correct service ID.

    +

    Check the request and select the correct service ID.

    400

    +

    400

    ModelArts.3849

    +

    ModelArts.3849

    Service {id} in the information of dataset {import_type} does not exist.

    +

    Service {id} in the information of dataset {import_type} does not exist.

    The service {ID} of the {import type} dataset does not exist.

    +

    The service {ID} of the {import type} dataset does not exist.

    Check whether the service ID is correct.

    +

    Check whether the service ID is correct.

    400

    +

    400

    ModelArts.3850

    +

    ModelArts.3850

    The hard-sample-select task {id} of service {id} does not exist.

    +

    The hard-sample-select task {id} of service {id} does not exist.

    Hard example task {ID} of service {ID} does not exist.

    +

    Hard example task {ID} of service {ID} does not exist.

    Ensure that the hard example task ID is correctly set and that the task belongs to the target service.

    +

    Ensure that the hard example task ID is correctly set and that the task belongs to the target service.

    400

    +

    400

    ModelArts.3851

    +

    ModelArts.3851

    The status of hard-sample-select task {name} cannot be changed from {status} to {status}.

    +

    The status of hard-sample-select task {name} cannot be changed from {status} to {status}.

    The status {status value} of the hard example task {name} cannot be updated to {status value}.

    +

    The status {status value} of the hard example task {name} cannot be updated to {status value}.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3852

    +

    ModelArts.3852

    Failed to start hard-sample-select task {id} because related OBS files have been deleted.

    +

    Failed to start hard-sample-select task {id} because related OBS files have been deleted.

    Failed to start hard example task {ID} because key OBS files have been deleted.

    +

    Failed to start hard example task {ID} because key OBS files have been deleted.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3853

    +

    ModelArts.3853

    The hard-sample-select quota of project {id} does not exist.

    +

    The hard-sample-select quota of project {id} does not exist.

    The quota for selecting hard samples for project {ID} does not exist.

    +

    The quota for selecting hard samples for project {ID} does not exist.

    Create the quota and try again.

    +

    Create the quota and try again.

    400

    +

    400

    ModelArts.3854

    +

    ModelArts.3854

    The hard-sample-select quota of project {id} already exists.

    +

    The hard-sample-select quota of project {id} already exists.

    The quota for selecting hard samples for project {ID} already exists.

    +

    The quota for selecting hard samples for project {ID} already exists.

    You do not need to create it again.

    +

    You do not need to create it again.

    400

    +

    400

    ModelArts.3856

    +

    ModelArts.3856

    A maximum of {number} free services are allowed.

    +

    A maximum of {number} free services are allowed.

    The number of free services has reached the maximum allowed limit {Number}.

    +

    The number of free services has reached the maximum allowed limit {Number}.

    Delete unnecessary free services to release resources.

    +

    Delete unnecessary free services to release resources.

    400

    +

    400

    ModelArts.3857

    +

    ModelArts.3857

    A maximum of {number} free service instances are allowed.

    +

    A maximum of {number} free service instances are allowed.

    The number of free services has reached the maximum allowed limit {Number}.

    +

    The number of free services has reached the maximum allowed limit {Number}.

    Delete unnecessary free services to release resources.

    +

    Delete unnecessary free services to release resources.

    400

    +

    400

    ModelArts.3862

    +

    ModelArts.3862

    Subservice {id} has been added to whitelist URL {url}.

    +

    Subservice {id} has been added to whitelist URL {url}.

    The URL {URL} has been added to the whitelist of the sub-service {ID}.

    +

    The URL {URL} has been added to the whitelist of the sub-service {ID}.

    Do not repeat the operation.

    +

    Do not repeat the operation.

    400

    +

    400

    ModelArts.3863

    +

    ModelArts.3863

    Whitelist URL {id} of service {name} does not exist.

    +

    Whitelist URL {id} of service {name} does not exist.

    The whitelist URL {ID} of the service {name} does not exist.

    +

    The whitelist URL {ID} of the service {name} does not exist.

    Ensure that the URL ID in the whitelist is correct and that the URL belongs to the corresponding service.

    +

    Ensure that the URL ID in the whitelist is correct and that the URL belongs to the corresponding service.

    400

    +

    400

    ModelArts.3864

    +

    ModelArts.3864

    Subservice {id} of service {name} does not exist.

    +

    Subservice {id} of service {name} does not exist.

    The sub-service {ID} of service {name} does not exist.

    +

    The sub-service {ID} of service {name} does not exist.

    Ensure that the sub-service ID is correct and that the sub-service belongs to the corresponding service.

    +

    Ensure that the sub-service ID is correct and that the sub-service belongs to the corresponding service.

    400

    +

    400

    ModelArts.3865

    +

    ModelArts.3865

    The size of the download whitelist of service {name} exceeds the maximum number {number} allowed.

    +

    The size of the download whitelist of service {name} exceeds the maximum number {number} allowed.

    The number of the whitelist records downloaded by service {name} exceeds the upper limit {value}.

    +

    The number of the whitelist records downloaded by service {name} exceeds the upper limit {value}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3866

    +

    ModelArts.3866

    Domain ID {id} and user ID {id} already exist.

    +

    Domain ID {id} and user ID {id} already exist.

    The domain ID {ID} and user ID {ID} already exist.

    +

    The domain ID {ID} and user ID {ID} already exist.

    Do not repeat the operation.

    +

    Do not repeat the operation.

    400

    +

    400

    ModelArts.3867

    +

    ModelArts.3867

    Domain ID {id} does not exist.

    +

    Domain ID {id} does not exist.

    The domain ID {ID} does not exist.

    +

    The domain ID {ID} does not exist.

    Check the request and enter the correct domain ID.

    +

    Check the request and enter the correct domain ID.

    400

    +

    400

    ModelArts.3868

    +

    ModelArts.3868

    Domain ID {id} and user ID {id} do not exist.

    +

    Domain ID {id} and user ID {id} do not exist.

    The domain ID {ID} and user ID {ID} do not exist.

    +

    The domain ID {ID} and user ID {ID} do not exist.

    Check the request and enter the correct domain ID and user ID.

    +

    Check the request and enter the correct domain ID and user ID.

    400

    +

    400

    ModelArts.3869

    +

    ModelArts.3869

    Failed to delete the task type because {reason}.

    +

    Failed to delete the task type because {reason}.

    Failed to delete the task type. Fault cause: {fault cause}.

    +

    Failed to delete the task type. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3870

    +

    ModelArts.3870

    Failed to subscribe to the API because {reason}.

    +

    Failed to subscribe to the API because {reason}.

    Failed to subscribe to the API. Fault cause: {fault cause}.

    +

    Failed to subscribe to the API. Fault cause: {fault cause}.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3871

    +

    ModelArts.3871

    Forbidden to subscribe to postpaid QPS for the task type.

    +

    Forbidden to subscribe to postpaid QPS for the task type.

    You are not allowed to subscribe to postpaid QPS for the task type.

    +

    You are not allowed to subscribe to postpaid QPS for the task type.

    Check the request parameter or contact service O&M personnel.

    +

    Check the request parameter or contact service O&M personnel.

    400

    +

    400

    ModelArts.3872

    +

    ModelArts.3872

    Forbidden to change the charging mode for the task type from prepaid to postpaid QPS.

    +

    Forbidden to change the charging mode for the task type from prepaid to postpaid QPS.

    You are not allowed to change the billing mode of the task type from prepaid mode to postpaid QPS mode.

    +

    You are not allowed to change the billing mode of the task type from prepaid mode to postpaid QPS mode.

    Check the request parameter or contact service O&M personnel.

    +

    Check the request parameter or contact service O&M personnel.

    400

    +

    400

    ModelArts.3873

    +

    ModelArts.3873

    No corresponding subservice is found in cluster {name}.

    +

    No corresponding subservice is found in cluster {name}.

    The cluster {0} does not have the corresponding sub-service.

    +

    The cluster {0} does not have the corresponding sub-service.

    Check the request parameter or contact service O&M personnel.

    +

    Check the request parameter or contact service O&M personnel.

    400

    +

    400

    ModelArts.3880

    +

    ModelArts.3880

    Failed to create the AS policy because {reason}.

    +

    Failed to create the AS policy because {reason}.

    Failed to create the AS policy. Fault cause: {fault cause}.

    +

    Failed to create the AS policy. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    400

    +

    400

    ModelArts.3890

    +

    ModelArts.3890

    The total number of AS policies exceeds the maximum number {number} allowed.

    +

    The total number of AS policies exceeds the maximum number {number} allowed.

    The number of AS policies exceeds the upper limit {0}.

    +

    The number of AS policies exceeds the upper limit {0}.

    Delete unnecessary AS policies.

    +

    Delete unnecessary AS policies.

    400

    +

    400

    ModelArts.3892

    +

    ModelArts.3892

    Calling failed due to invalid CBS request.

    +

    Calling failed due to invalid CBS request.

    Failed to call the API due to the invalid CBC request.

    +

    Failed to call the API due to the invalid CBC request.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3894

    +

    ModelArts.3894

    The specification configuration information of runtime environment {name} does not exist.

    +

    The specification configuration information of runtime environment {name} does not exist.

    The specification configurations of the running environment {0} does not exist.

    +

    The specification configurations of the running environment {0} does not exist.

    Set the flavor configurations for the running environment and try again.

    +

    Set the flavor configurations for the running environment and try again.

    400

    +

    400

    ModelArts.3895

    +

    ModelArts.3895

    The specification configuration information of runtime environment {name} already exists.

    +

    The specification configuration information of runtime environment {name} already exists.

    The specification configurations of the running environment {0} already exist.

    +

    The specification configurations of the running environment {0} already exist.

    Do not repeat the operation.

    +

    Do not repeat the operation.

    400

    +

    400

    ModelArts.3896

    +

    ModelArts.3896

    Resource specification code {0} for user {1} already exists.

    +

    Resource specification code {0} for user {1} already exists.

    The records of the resource specification code {0} in project {1} already exist.

    +

    The records of the resource specification code {0} in project {1} already exist.

    Do not repeat the operation.

    +

    Do not repeat the operation.

    400

    +

    400

    ModelArts.3897

    +

    ModelArts.3897

    Failed to {create/obtain/remove} the AS policy due to error code {code}.

    +

    Failed to {create/obtain/remove} the AS policy due to error code {code}.

    Failed to request {create/obtain/delete} the AS. Error code: {0}.

    +

    Failed to request {create/obtain/delete} the AS. Error code: {0}.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    400

    +

    400

    ModelArts.3950

    +

    ModelArts.3950

    Failed to obtain the AI service list.

    +

    Failed to obtain the AI service list.

    Failed to obtain the AI service list.

    +

    Failed to obtain the AI service list.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.3951

    +

    ModelArts.3951

    Failed to parse file {name}.

    +

    Failed to parse file {name}.

    Failed to parse the file {name}.

    +

    Failed to parse the file {name}.

    Ensure that the file name is correct.

    +

    Ensure that the file name is correct.

    400

    +

    400

    ModelArts.3952

    +

    ModelArts.3952

    Insufficient resources. Please try later.

    +

    Insufficient resources. Please try later.

    Insufficient resources.

    +

    Insufficient resources.

    Try again later or contact service O&M personnel.

    +

    Try again later or contact service O&M personnel.

    400

    +

    400

    ModelArts.3953

    +

    ModelArts.3953

    Failed to delete online service {id} because it has been associated with AI service {name}. Please disassociate it and try again.

    +

    Failed to delete online service {id} because it has been associated with AI service {name}. Please disassociate it and try again.

    Failed to delete real-time service {ID} because it has been associated with AI service {name}.

    +

    Failed to delete real-time service {ID} because it has been associated with AI service {name}.

    Cancel the association between the real-time service and all AI services and try again.

    +

    Cancel the association between the real-time service and all AI services and try again.

    400

    +

    400

    ModelArts.3954

    +

    ModelArts.3954

    AI resource specification {id} does not exist.

    +

    AI resource specification {id} does not exist.

    The cloud resource specification {ID} does not exist.

    +

    The cloud resource specification {ID} does not exist.

    Ensure that the cloud resource specification ID is correct.

    +

    Ensure that the cloud resource specification ID is correct.

    400

    +

    400

    ModelArts.3955

    +

    ModelArts.3955

    Field [resource_id_components] of AI resource specification {id} cannot be empty.

    +

    Field [resource_id_components] of AI resource specification {id} cannot be empty.

    The ID components in the cloud resource specification {ID} cannot be left blank.

    +

    The ID components in the cloud resource specification {ID} cannot be left blank.

    Set the resource_id_components parameter and try again.

    +

    Set the resource_id_components parameter and try again.

    400

    +

    400

    ModelArts.7002

    +

    ModelArts.7002

    You are not authorized to operate dataset {id}.

    +

    You are not authorized to operate dataset {id}.

    You do not have the permission to operate the dataset {ID}.

    +

    You do not have the permission to operate the dataset {ID}.

    Check the permission or contact service O&M personnel.

    +

    Check the permission or contact service O&M personnel.

    401

    +

    401

    ModelArts.3801

    +

    ModelArts.3801

    User credential (AK and SK) does not exist.

    +

    User credential (AK and SK) does not exist.

    The user certificate does not exist.

    +

    The user certificate does not exist.

    Add the AK/SK again.

    +

    Add the AK/SK again.

    403

    +

    403

    ModelArts.0210

    +

    ModelArts.0210

    The project id in the request URL does not match the token.

    +

    The project id in the request URL does not match the token.

    The project ID in the request URL and the token do not match.

    +

    The project ID in the request URL and the token do not match.

    Use the correct project ID to generate a token.

    +

    Use the correct project ID to generate a token.

    403

    +

    403

    ModelArts.3555

    +

    ModelArts.3555

    Forbidden to access ECS.

    +

    Forbidden to access ECS.

    You do not have the permission to access the ECS.

    +

    You do not have the permission to access the ECS.

    Authorize access to the ECS and try again.

    +

    Authorize access to the ECS and try again.

    403

    +

    403

    ModelArts.3936

    +

    ModelArts.3936

    The app-auth API {id} does not belong to service {id}.

    +

    The app-auth API {id} does not belong to service {id}.

    The API {ID} that supports application authentication does not belong to the service {ID}.

    +

    The API {ID} that supports application authentication does not belong to the service {ID}.

    Check the request parameter or contact service O&M personnel.

    +

    Check the request parameter or contact service O&M personnel.

    404

    +

    404

    ModelArts.3502

    +

    ModelArts.3502

    Service {name} does not exist.

    +

    Service {name} does not exist.

    The service {name} does not exist.

    +

    The service {name} does not exist.

    Ensure that the service name is correct.

    +

    Ensure that the service name is correct.

    404

    +

    404

    ModelArts.3507

    +

    ModelArts.3507

    Model {name} does not exist.

    +

    Model {name} does not exist.

    The model {ID} does not exist.

    +

    The model {ID} does not exist.

    Ensure that the model ID is correct.

    +

    Ensure that the model ID is correct.

    404

    +

    404

    ModelArts.3923

    +

    ModelArts.3923

    Application {id} does not exist.

    +

    Application {id} does not exist.

    The application {ID} does not exist.

    +

    The application {ID} does not exist.

    Ensure that the application ID is correct.

    +

    Ensure that the application ID is correct.

    404

    +

    404

    ModelArts.3935

    +

    ModelArts.3935

    The app-auth API {id} does not exist.

    +

    The app-auth API {id} does not exist.

    The API {ID} that supports application authentication does not exist.

    +

    The API {ID} that supports application authentication does not exist.

    Ensure that the interface ID is correct.

    +

    Ensure that the interface ID is correct.

    409

    +

    409

    ModelArts.3503

    +

    ModelArts.3503

    Service {name} already exists.

    +

    Service {name} already exists.

    The service {name} already exists.

    +

    The service {name} already exists.

    Change the service name and try again.

    +

    Change the service name and try again.

    409

    +

    409

    ModelArts.3929

    +

    ModelArts.3929

    Failed to create the application because {reason}.

    +

    Failed to create the application because {reason}.

    Failed to create the application. Fault cause: {fault cause}.

    +

    Failed to create the application. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3501

    +

    ModelArts.3501

    Failed to deploy the service.

    +

    Failed to deploy the service.

    Failed to deploy the service.

    +

    Failed to deploy the service.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3504

    +

    ModelArts.3504

    Failed to delete the service.

    +

    Failed to delete the service.

    Failed to delete the service.

    +

    Failed to delete the service.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3505

    +

    ModelArts.3505

    Failed to update the service.

    +

    Failed to update the service.

    Failed to query the service.

    +

    Failed to query the service.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3506

    +

    ModelArts.3506

    Model {id} does not exist.

    +

    Model {id} does not exist.

    Failed to update the service.

    +

    Failed to update the service.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3508

    +

    ModelArts.3508

    Failed to query the service monitoring information.

    +

    Failed to query the service monitoring information.

    Failed to obtain the service monitoring information.

    +

    Failed to obtain the service monitoring information.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3509

    +

    ModelArts.3509

    Failed to query edge nodes.

    +

    Failed to query edge nodes.

    Failed to query the node.

    +

    Failed to query the node.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3511

    +

    ModelArts.3511

    Failed to query edge tags.

    +

    Failed to query edge tags.

    Failed to query the edge label.

    +

    Failed to query the edge label.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3537

    +

    ModelArts.3537

    Failed to handle the CBC request.

    +

    Failed to handle the CBC request.

    Failed to process the CBC request.

    +

    Failed to process the CBC request.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3539

    +

    ModelArts.3539

    Failed to initialize service URL {url}.

    +

    Failed to initialize service URL {url}.

    Failed to initialize the service URL {URL}.

    +

    Failed to initialize the service URL {URL}.

    Ensure that the service URL is correct.

    +

    Ensure that the service URL is correct.

    500

    +

    500

    ModelArts.3543

    +

    ModelArts.3543

    Invalid CBC request.

    +

    Invalid CBC request.

    The CBC request is invalid.

    +

    The CBC request is invalid.

    Try again or contact service O&M personnel.

    +

    Try again or contact service O&M personnel.

    500

    +

    500

    ModelArts.3546

    +

    ModelArts.3546

    Failed to create the cluster.

    +

    Failed to create the cluster.

    Failed to create the dedicated resource pool.

    +

    Failed to create the dedicated resource pool.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3579

    +

    ModelArts.3579

    Failed to query the model information.

    +

    Failed to query the model information.

    Failed to query the model information.

    +

    Failed to query the model information.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3581

    +

    ModelArts.3581

    Failed to create edge certificates.

    +

    Failed to create edge certificates.

    Failed to create the edge certificate.

    +

    Failed to create the edge certificate.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3802

    +

    ModelArts.3802

    Failed to create API group {name} because {reason}.

    +

    Failed to create API group {name} because {reason}.

    Failed to create the API group {name}. Fault cause: {fault cause}.

    +

    Failed to create the API group {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3803

    +

    ModelArts.3803

    Failed to register API {name} because {reason}.

    +

    Failed to register API {name} because {reason}.

    Failed to register the API {name}. Fault cause: {fault cause}.

    +

    Failed to register the API {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3805

    +

    ModelArts.3805

    Failed to create AI service {name} because {reason}.

    +

    Failed to create AI service {name} because {reason}.

    Failed to create the AI service {name}. Fault cause: {fault cause}.

    +

    Failed to create the AI service {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3806

    +

    ModelArts.3806

    Failed to update AI service {name} because {reason}.

    +

    Failed to update AI service {name} because {reason}.

    Failed to update the AI service {name}. Fault cause: {fault cause}.

    +

    Failed to update the AI service {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3807

    +

    ModelArts.3807

    Failed to delete AI service {name} because {reason}.

    +

    Failed to delete AI service {name} because {reason}.

    Failed to delete the AI service {name}. Fault cause: {fault cause}.

    +

    Failed to delete the AI service {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3808

    +

    ModelArts.3808

    Failed to create AI subservice {name} because {reason}.

    +

    Failed to create AI subservice {name} because {reason}.

    Failed to create the sub-service {name}. Fault cause: {fault cause}.

    +

    Failed to create the sub-service {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3809

    +

    ModelArts.3809

    Failed to update AI subservice {name} because {reason}.

    +

    Failed to update AI subservice {name} because {reason}.

    Failed to update the sub-service {name}. Fault cause: {fault cause}.

    +

    Failed to update the sub-service {name}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3810

    +

    ModelArts.3810

    Failed to create the agency because {reason}.

    +

    Failed to create the agency because {reason}.

    Failed to create the agency. Fault cause: {fault cause}.

    +

    Failed to create the agency. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3819

    +

    ModelArts.3819

    Failed to delete the agency definition.

    +

    Failed to delete the agency definition.

    Failed to delete the service agency definition.

    +

    Failed to delete the service agency definition.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3858

    +

    ModelArts.3858

    Failed to bind task type to API {id} because {reason}.

    +

    Failed to bind task type to API {id} because {reason}.

    Failed to bind task type to API {ID}. Fault cause: {fault cause}.

    +

    Failed to bind task type to API {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3859

    +

    ModelArts.3859

    Failed to unbind task type from API {id} because {reason}.

    +

    Failed to unbind task type from API {id} because {reason}.

    Failed to unbind the task type from API {ID}. Fault cause: {fault cause}.

    +

    Failed to unbind the task type from API {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3860

    +

    ModelArts.3860

    Failed to create the task type because {reason}.

    +

    Failed to create the task type because {reason}.

    Failed to create the task type. Fault cause: {fault cause}.

    +

    Failed to create the task type. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3861

    +

    ModelArts.3861

    Failed to update the task type because {reason}.

    +

    Failed to update the task type because {reason}.

    Failed to update the task. Fault cause: {fault cause}.

    +

    Failed to update the task. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3891

    +

    ModelArts.3891

    Failed to operate the serverless cluster because {reason}.

    +

    Failed to operate the serverless cluster because {reason}.

    Failed to operate the serverless cluster. Fault cause: {fault cause}.

    +

    Failed to operate the serverless cluster. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3893

    +

    ModelArts.3893

    Failed to forward the CBC request to the cloud service.

    +

    Failed to forward the CBC request to the cloud service.

    Failed to forward the CBC request to the cloud service.

    +

    Failed to forward the CBC request to the cloud service.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    500

    +

    500

    ModelArts.3921

    +

    ModelArts.3921

    Failed to create the app-auth API because {reason}.

    +

    Failed to create the app-auth API because {reason}.

    Failed to register the API that supports application authentication. Fault cause: {fault cause}.

    +

    Failed to register the API that supports application authentication. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3924

    +

    ModelArts.3924

    Failed to create the application code for application {id} because {reason}.

    +

    Failed to create the application code for application {id} because {reason}.

    Failed to create the AppCode of the application {ID}. Fault cause: {fault cause}.

    +

    Failed to create the AppCode of the application {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3925

    +

    ModelArts.3925

    Failed to delete app-auth api {id} because {reason}.

    +

    Failed to delete app-auth api {id} because {reason}.

    Failed to delete API {ID} that supports application authentication. Fault cause: {fault cause}.

    +

    Failed to delete API {ID} that supports application authentication. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3926

    +

    ModelArts.3926

    Failed to reset the secret of application {id} because {reason}.

    +

    Failed to reset the secret of application {id} because {reason}.

    Failed to reset the private key of the application {ID}. Fault cause: {fault cause}.

    +

    Failed to reset the private key of the application {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3927

    +

    ModelArts.3927

    Failed to reset the application code of application {id} because {reason}.

    +

    Failed to reset the application code of application {id} because {reason}.

    Failed to reset the AppCode of the application {ID}. Fault cause: {fault cause}.

    +

    Failed to reset the AppCode of the application {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3928

    +

    ModelArts.3928

    Failed to obtain the app-auth API information because {reason}.

    +

    Failed to obtain the app-auth API information because {reason}.

    Failed to obtain information about the API that supports application authentication. Fault cause: {fault cause}.

    +

    Failed to obtain information about the API that supports application authentication. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3932

    +

    ModelArts.3932

    Failed to obtain the application information because {reason}.

    +

    Failed to obtain the application information because {reason}.

    Failed to obtain the application information. Fault cause: {fault cause}.

    +

    Failed to obtain the application information. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3933

    +

    ModelArts.3933

    Failed to delete application {id} because {reason}.

    +

    Failed to delete application {id} because {reason}.

    Failed to delete the application {ID}. Fault cause: {fault cause}.

    +

    Failed to delete the application {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3934

    +

    ModelArts.3934

    Failed to delete the application code of application {id} because {reason}.

    +

    Failed to delete the application code of application {id} because {reason}.

    Failed to delete the AppCode of the application {ID}. Fault cause: {fault cause}.

    +

    Failed to delete the AppCode of the application {ID}. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3937

    +

    ModelArts.3937

    Failed to authorize the app-auth API to the application because {reason}.

    +

    Failed to authorize the app-auth API to the application because {reason}.

    Failed to authorize the API to the application. Fault cause: {fault cause}.

    +

    Failed to authorize the API to the application. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.3938

    +

    ModelArts.3938

    Failed to unbind the app-auth API from the application because {reason}.

    +

    Failed to unbind the app-auth API from the application because {reason}.

    Failed to cancel the authorization from the API to the application. Fault cause: {fault cause}.

    +

    Failed to cancel the authorization from the API to the application. Fault cause: {fault cause}.

    Locate the fault based on the failure cause.

    +

    Locate the fault based on the failure cause.

    500

    +

    500

    ModelArts.7001

    +

    ModelArts.7001

    Unknown workspace system error. Try again later or submit a service ticket for professional technical support.

    +

    Unknown workspace system error. Try again later or submit a service ticket for professional technical support.

    An internal workspace error occurred.

    +

    An internal workspace error occurred.

    Contact service O&M personnel.

    +

    Contact service O&M personnel.

    400

    +

    400

    ModelArts.7002

    +

    ModelArts.7002

    Not gray user, please contact the administrator

    +

    Not gray user, please contact the administrator

    Workspace authentication error.

    +

    Workspace authentication error.

    Contact the administrator to check whether the user has permissions on the workspace.

    +

    Contact the system administrator to check whether the user has permissions on the workspace.

    400

    +

    400

    ModelArts.7003

    +

    ModelArts.7003

    no permission to get iam user list, please check permission

    +

    no permission to get iam user list, please check permission

    IAM permissions are incorrect.

    +

    IAM permissions are incorrect.

    Add the IAM permissions based on the error message.

    +

    Add the IAM permissions based on the error message.

    400

    +

    400

    ModelArts.7004

    +

    ModelArts.7004

    the status of workspace: {workspaceID} is abnormal, can not execute [action: {action}]

    +

    the status of workspace: {workspaceID} is abnormal, can not execute [action: {action}]

    You are not allowed to create resources when a workspace is in the normal state, for example, a deleted or failed workspace.

    +

    You are not allowed to create resources when a workspace is in the normal state, for example, a deleted or failed workspace.

    Create resources in a normal workspace.

    +

    Create resources in a normal workspace.

    400

    +

    400

    ModelArts.7005

    +

    ModelArts.7005

    workspace:{workspace} not existed

    +

    workspace:{workspace} not existed

    The workspace does not exist.

    +

    The workspace does not exist.

    Ensure that the transferred workspace ID exists.

    +

    Ensure that the transferred workspace ID exists.

    400

    +

    400

    ModelArts.7006

    +

    ModelArts.7006

    workspace number over limit, limit: {limit}

    +

    workspace number over limit, limit: {limit}

    The number of workspaces exceeds the upper limit.

    +

    The number of workspaces exceeds the upper limit.

    Delete unnecessary workspaces.

    +

    Delete unnecessary workspaces.

    500

    +

    500

    ModelArts.7001

    +

    ModelArts.7001

    Workspace internal error

    +

    Workspace internal error

    An unknown error occurs in the workspace.

    +

    An unknown error occurs in the workspace.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.7008

    +

    ModelArts.7008

    workspace in read-only status, please wait a few minutes

    +

    workspace in read-only status, please wait a few minutes

    The workspace is abnormal. Only the read-only operation is supported.

    +

    The workspace is abnormal. Only the read-only operation is supported.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.7009

    +

    ModelArts.7009

    call {apiType} api failed

    +

    call {apiType} api failed

    The workspace is abnormal.

    +

    The workspace is abnormal.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.7100

    +

    ModelArts.7100

    get enterprise project id failed

    +

    get enterprise project id failed

    EPS request error.

    +

    EPS request error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    500

    +

    500

    ModelArts.7101

    +

    ModelArts.7101

    Call pdp auth api failed.

    +

    Call pdp auth api failed.

    PDP request error.

    +

    PDP request error.

    System error. Contact technical support.

    +

    System error. Contact technical support.

    Released On

    +
    - - - diff --git a/docs/modelarts/api-ref/modelarts_03_0108.html b/docs/modelarts/api-ref/modelarts_03_0108.html index 3f052f288..660306142 100644 --- a/docs/modelarts/api-ref/modelarts_03_0108.html +++ b/docs/modelarts/api-ref/modelarts_03_0108.html @@ -1,16 +1,14 @@ -

    DevEnviron

    +

    DevEnviron

    diff --git a/docs/modelarts/api-ref/modelarts_03_0110.html b/docs/modelarts/api-ref/modelarts_03_0110.html index d5e46fc8e..babb3fbcc 100644 --- a/docs/modelarts/api-ref/modelarts_03_0110.html +++ b/docs/modelarts/api-ref/modelarts_03_0110.html @@ -1,8 +1,8 @@

    Creating a Development Environment Instance

    -

    Function

    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 calling the API described in Querying the Details About a Development Environment Instance.

    +

    Function

    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 calling the API described in Querying Details About a Development Environment Instance.

    URI

    POST /v1/{project_id}/demanager/instances

    @@ -23,7 +23,7 @@
    - @@ -78,7 +78,7 @@ -

    Released On

    Description

    +

    Description

    2021-04-30

    +

    2021-04-30

    This is the first official release.

    +

    This is the first official release.

    String

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

    +

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

    Instance flavor. The options are as follows:

    • modelarts.kat1.xlarge
    • modelarts.vm.cpu.2u
    • modelarts.vm.cpu.8u
    • modelarts.vm.gpu.v100
    -

    The preceding flavors are for reference only. The actual flavors depend on the region. If you need to use other flavors, contact the administrator to change the flavors.

    +

    The preceding flavors are for reference only. The actual flavors depend on the region. If you need to use other flavors, contact the system administrator to change the flavors.

    spec

    @@ -973,7 +973,7 @@

    String

    Storage path

    -
    • If type is set to obs, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket.
    +
    • If type is set to obs, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket.

    volume_size

    @@ -1426,8 +1426,7 @@ "workspace": { "id": "0" } -} - +}
    • Failed sample response
      {
      @@ -1435,7 +1434,9 @@
           "error_code": "ModelArts.6318"
       }
    -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0111.html b/docs/modelarts/api-ref/modelarts_03_0111.html index baf29209e..eeaa331e8 100644 --- a/docs/modelarts/api-ref/modelarts_03_0111.html +++ b/docs/modelarts/api-ref/modelarts_03_0111.html @@ -22,441 +22,441 @@

    String

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

    +

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

    -

    Request Body

    Table 2 describes the request parameters.

    -
    Table 2 Parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 query parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    de_type

    +

    de_type

    Yes

    +

    Yes

    String

    +

    String

    Development environment type. Only Notebook is supported. The first letter must be capitalized.

    +

    Development environment type. Only Notebook is supported. The first letter must be capitalized.

    provision_type

    +

    provision_type

    No

    +

    No

    String

    +

    String

    Deployment type. Only Docker is supported.

    +

    Deployment type. Only Docker is supported.

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Instance status. By default, all statuses are returned. The options are as follows:

    -
    • CREATING: The instance is being created.
    • CREATE_FAILED: The instance fails to be created.
    • STARTING: The instance is being started.
    • RESTARTING: The instance is being restarted.
    • START_FAILED: The instance fails to be started.
    • RUNNING: The instance is running.
    • STOPPING: The instance is being stopped.
    • STOPPED: The instance has been stopped.
    • UNAVAILABLE: The instance is unavailable.
    • DELETED: The instance has been deleted.
    • RESIZING: The instance specifications are being changed.
    • RESIZE_FAILED: The instance specifications fail to be changed.
    +

    Instance status. By default, all statuses are returned. The options are as follows:

    +
    • CREATING: The instance is being created.
    • CREATE_FAILED: The instance fails to be created.
    • STARTING: The instance is being started.
    • RESTARTING: The instance is being restarted.
    • START_FAILED: The instance fails to be started.
    • RUNNING: The instance is running.
    • STOPPING: The instance is being stopped.
    • STOPPED: The instance has been stopped.
    • UNAVAILABLE: The instance is unavailable.
    • DELETED: The instance has been deleted.
    • RESIZING: The instance specifications are being changed.
    • RESIZE_FAILED: The instance specifications fail to be changed.

    sortby

    +

    sortby

    No

    +

    No

    String

    +

    String

    Classification standard. The value can be name or creation_timestamp. The default value is name.

    +

    Classification standard. The value can be name or creation_timestamp. The default value is name.

    order

    +

    order

    No

    +

    No

    String

    +

    String

    Sorting mode. The value can be asc or desc. The default value is asc.

    +

    Sorting mode. The value can be asc or desc. The default value is asc.

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Start index. The default value is 0.

    +

    Start index. The default value is 0.

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Number of returned result records. The value range is (0, ∞). The default value is 0, which indicates that all results are returned.

    +

    Number of returned result records. The value range is (0, ∞). The default value is 0, which indicates that all results are returned.

    workspace_id

    +

    workspace_id

    No

    +

    No

    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.

    show_self

    +

    show_self

    No

    +

    No

    String

    +

    String

    Only the user is displayed. The default value is true.

    +

    Only the user is displayed. The default value is true.

    ai_project

    +

    ai_project

    No

    +

    No

    String

    +

    String

    AI project ID

    +

    AI project ID

    pool_id

    +

    pool_id

    No

    +

    No

    String

    +

    String

    ID of a dedicated resource pool. This parameter can be used to query information about all instances in a dedicated resource pool.

    +

    ID of a dedicated resource pool. This parameter can be used to obtain all instances in a dedicated resource pool.

    +

    Request Body

    None

    Response Body

    Table 3 describes the response parameters. -
    Table 3 Parameters

    Parameter

    +
    - - - - - - - -
    Table 3 Parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_count

    +

    total_count

    Integer

    +

    Integer

    Total number of development environments.

    +

    Total number of development environments.

    instances

    +

    instances

    Array

    +

    Array

    Configuration list. For details, see Table 4.

    +

    Configuration list. For details, see Table 4.

    -
    Table 4 instances parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 instances parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Instance ID

    +

    Instance ID

    name

    +

    name

    String

    +

    String

    Instance name

    +

    Instance name

    description

    +

    description

    String

    +

    String

    Instance description

    +

    Instance description

    status

    +

    status

    String

    +

    String

    Instance status

    +

    Instance status

    creation_timestamp

    +

    creation_timestamp

    String

    +

    String

    Time when an instance is created

    +

    Time when an instance is created

    profile

    +

    profile

    Object

    +

    Object

    Configuration information. For details, see Table 5.

    +

    Configuration information. For details, see Table 5.

    flavor

    +

    flavor

    String

    +

    String

    Instance flavor

    +

    Instance flavor

    spec

    +

    spec

    Object

    +

    Object

    Instance definition. For details about parameters of a notebook instance, see Table 13.

    +

    Instance definition. For details about parameters of a notebook instance, see Table 13.

    workspace

    +

    workspace

    Object

    +

    Object

    Workspace. For details, see Table 17.

    +

    Workspace. For details, see Table 17.

    latest_update_timestamp

    +

    latest_update_timestamp

    String

    +

    String

    Time when an instance is modified

    +

    Time when an instance is modified

    flavor_details

    +

    flavor_details

    Object

    +

    Object

    Flavor details. For details, see Table 9.

    +

    Flavor details. For details, see Table 9.

    pool

    +

    pool

    Object

    +

    Object

    Dedicated resource pool. For details, see Table 10.

    +

    Dedicated resource pool. For details, see Table 10.

    ai_project

    +

    ai_project

    Object

    +

    Object

    AI project. For details, see Table 11.

    +

    AI project. For details, see Table 11.

    error_code

    +

    error_code

    String

    +

    String

    Error code. For details, see Error Codes.

    +

    Error code. For details, see Error Codes.

    queuing_info

    +

    queuing_info

    Object

    +

    Object

    Queuing information. For details, see Table 18.

    +

    Queuing information. For details, see Table 18.

    user

    +

    user

    Object

    +

    Object

    User information. For details, see Table 19.

    +

    User information. For details, see Table 19.

    repository

    +

    repository

    Object

    +

    Object

    Git repository information. For details, see Table 20. This parameter cannot be used. It is automatically returned when the API is called.

    +

    Git repository information. For details, see Table 20. This parameter cannot be used. It is automatically returned when the API is called.

    -
    Table 5 profile parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 profile parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Configuration ID

    +

    Configuration ID

    name

    +

    name

    String

    +

    String

    Configuration name

    +

    Configuration name

    description

    +

    description

    String

    +

    String

    Configuration description

    +

    Configuration description

    de_type

    +

    de_type

    String

    +

    String

    Development environment type. Only Notebook is supported.

    +

    Development environment type. Only Notebook is supported.

    provision

    +

    provision

    Object

    +

    Object

    Deployment information. For details, see Table 6.

    +

    Deployment information. For details, see Table 6.

    labels

    +

    labels

    Map<String,String>

    +

    Map<String,String>

    Label information, which can be extended

    +

    Label information, which can be extended

    flavor_type

    +

    flavor_type

    String

    +

    String

    Hardware, which can be CPU, GPU, or Ascend.

    +

    Hardware, which can be CPU, GPU, or Ascend.

    -
    Table 6 provision parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 6 provision parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    String

    +

    String

    Deployment type. Only Docker is supported.

    +

    Deployment type. Only Docker is supported.

    spec

    +

    spec

    Object

    +

    Object

    Deployment details. For details, see Table 7.

    +

    Deployment details. For details, see Table 7.

    annotations

    +

    annotations

    Map<String,String>

    +

    Map<String,String>

    Label information, which can be extended. By default, this parameter is left blank.

    +

    Label information, which can be extended. By default, this parameter is left blank.

    -
    Table 7 spec parameters

    Parameter

    +
    - - - - - - - -
    Table 7 spec parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    engine

    +

    engine

    String

    +

    String

    Deployment engine. Only CCE is supported.

    +

    Deployment engine. Only CCE is supported.

    params

    +

    params

    Object

    +

    Object

    Deployment parameters. Only Docker is supported. For details, see Table 8.

    +

    Deployment parameters. Only Docker is supported. For details, see Table 8.

    -
    Table 8 Docker deployment parameters

    Parameter

    +
    - - - - - - - - - - - - - - @@ -464,589 +464,589 @@ -
    Table 8 Docker deployment parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    namespace

    +

    namespace

    String

    +

    String

    SWR organization name, which is globally unique

    +

    SWR organization name, which is globally unique

    image_name

    +

    image_name

    String

    +

    String

    Image name

    +

    Image name

    image_tag

    +

    image_tag

    String

    +

    String

    Image tag

    +

    Image tag

    annotations

    +

    annotations

    Map<String,String>

    +

    Map<String,String>

    Label information, which can be extended. By default, this parameter is left blank.

    +

    Label information, which can be extended. By default, this parameter is left blank.

    Table 9 flavor_details parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 9 flavor_details parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    String

    +

    String

    Flavor name

    +

    Flavor name

    status

    +

    status

    String

    +

    String

    Flavor sale status The options are as follows:

    +

    Flavor sale status The options are as follows:

    • onSale
    • soldOut

    queuing_num

    +

    queuing_num

    Integer

    +

    Integer

    This parameter is mandatory when promo_type is set to Free and status is set to soldOut.

    +

    This parameter is mandatory when promo_type is set to Free and status is set to soldOut.

    queue_left_time

    +

    queue_left_time

    Integer

    +

    Integer

    Left queuing time, in seconds

    +

    Left queuing time, in seconds

    This parameter is mandatory when promo_type is set to Free and status is set to soldOut.

    storage_list

    +

    storage_list

    Array<Storage type>

    +

    Array<Storage type>

    Supported storage type. The options are obs, evs, and efs.

    +

    Supported storage type. The options are obs, evs, and efs.

    is_permitted

    +

    is_permitted

    Boolean

    +

    Boolean

    Whether the current user has the permission to use this flavor

    +

    Whether the current user has the permission to use this flavor

    type

    +

    type

    String

    +

    String

    Flavor status. The options are as follows:

    +

    Flavor status. The options are as follows:

    • GPU
    • CPU
    • ASCEND

    params

    +

    params

    Dict

    +

    Dict

    Parameters that describing flavor

    +

    Parameters that describing flavor

    promo_type

    +

    promo_type

    String

    +

    String

    Promotion type. The options are as follows:

    +

    Promotion type. The options are as follows:

    • Free
    • NoDiscount

    instance_num

    +

    instance_num

    Integer

    +

    Integer

    Number of instances of this flavor the current created

    +

    Number of instances of this flavor the current created

    duration

    +

    duration

    Integer

    +

    Integer

    Auto stop time after startup, in seconds

    +

    Auto stop time after startup, in seconds

    store_time

    +

    store_time

    Integer

    +

    Integer

    Maximum retention period of an inactive instance of this flavor in the database, in hours

    +

    Maximum retention period of an inactive instance of this flavor in the database, in hours

    The default value is -1, indicating that the instance can be permanently saved.

    billing_flavor

    +

    billing_flavor

    String

    +

    String

    Billing specifications. If this field is left blank, the specifications name is used for billing.

    +

    Billing specifications. If this field is left blank, the specifications name is used for billing.

    billing_params

    +

    billing_params

    Integer

    +

    Integer

    Billing ratio This parameter is mandatory when billing_flavor is specified.

    +

    Billing ratio This parameter is mandatory when billing_flavor is specified.

    -
    Table 10 pool parameters

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 10 pool parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    ID of a resource pool

    +

    ID of a resource pool

    name

    +

    name

    String

    +

    String

    Name of a resource pool

    +

    Name of a resource pool

    type

    +

    type

    String

    +

    String

    Type of a resource pool. USER_DEFINED indicates a dedicated resource pool.

    +

    Type of a resource pool. USER_DEFINED indicates a dedicated resource pool.

    owner

    +

    owner

    Object

    +

    Object

    This parameter is mandatory when type is set to USER_DEFINED. For details, see Table 12.

    +

    This parameter is mandatory when type is set to USER_DEFINED. For details, see Table 12.

    -
    Table 11 AIProject parameters

    Parameter

    +
    - - - - -
    Table 11 AIProject parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    AI project ID

    +

    AI project ID

    -
    Table 12 owner parameters

    Parameter

    +
    - - - - -
    Table 12 owner parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    String

    +

    String

    Project ID

    +

    Project ID

    -
    Table 13 notebook parameters

    Parameter

    +
    - - - - - - - - - - - - - -
    Table 13 notebook parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    auto_stop

    +

    auto_stop

    Object

    +

    Object

    Auto stop parameter. For details, see Table 16.

    +

    Auto stop parameter. For details, see Table 16.

    annotations

    +

    annotations

    Map<String,String>

    +

    Map<String,String>

    Annotations

    +

    Annotations

    The generated URL cannot be directly accessed.

    failed_reasons

    +

    failed_reasons

    Object

    +

    Object

    Cause for a creation or startup failure. See Table 15.

    +

    Cause for a creation or startup failure. See Table 15.

    extend_params

    +

    extend_params

    Map<String,String>

    +

    Map<String,String>

    Extended parameter

    +

    Extended parameter

    -
    Table 14 location parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 14 location parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    path

    +

    path

    No

    +

    No

    String

    +

    String

    Storage path.

    +

    Storage path.

    • If type is set to obs, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket.

    volume_size

    +

    volume_size

    No

    +

    No

    Integer

    +

    Integer

    If type is set to obs, this parameter does not need to be set.

    +

    If type is set to obs, this parameter does not need to be set.

    -
    Table 15 failed_reasons parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 15 failed_reasons parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    code

    +

    code

    String

    +

    String

    Error code

    +

    Error code

    message

    +

    message

    String

    +

    String

    Error message

    +

    Error message

    detail

    +

    detail

    Map<String,String>

    +

    Map<String,String>

    Error details

    +

    Error details

    -
    Table 16 auto_stop parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - -
    Table 16 auto_stop parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    enable

    +

    enable

    Boolean

    +

    Boolean

    Whether to enable the auto stop function

    +

    Whether to enable the auto stop function

    duration

    +

    duration

    Integer

    +

    Integer

    Running duration, in seconds

    +

    Running duration, in seconds

    prompt

    +

    prompt

    Boolean

    +

    Boolean

    Whether to display a prompt again. This parameter is provided for the console to use.

    +

    Whether to display a prompt again. This parameter is provided for the console to use.

    stop_timestamp

    +

    stop_timestamp

    Integer

    +

    Integer

    Time when the instance stops. The value is a 13-digit timestamp.

    +

    Time when the instance stops. The value is a 13-digit timestamp.

    remain_time

    +

    remain_time

    Integer

    +

    Integer

    Remaining time before actual stop, in seconds

    +

    Remaining time before actual stop, in seconds

    -
    Table 17 workspace parameters

    Parameter

    +
    - - - - -
    Table 17 workspace parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Workspace ID

    +

    Workspace ID

    -
    Table 18 queuing_info parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 18 queuing_info parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Instance ID

    +

    Instance ID

    name

    +

    name

    String

    +

    String

    Instance name

    +

    Instance name

    de_type

    +

    de_type

    String

    +

    String

    Development environment type. By default, all types are returned.

    +

    Development environment type. By default, all types are returned.

    Only Notebook is supported.

    flavor

    +

    flavor

    String

    +

    String

    Instance flavor. By default, all types are returned.

    +

    Instance flavor. By default, all types are returned.

    flavor_details

    +

    flavor_details

    Object

    +

    Object

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 9.

    +

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 9.

    status

    +

    status

    String

    +

    String

    Instance status. By default, all statuses are returned, including:

    +

    Instance status. By default, all statuses are returned, including:

    • CREATE_QUEUING
    • START_QUEUING

    begin_timestamp

    +

    begin_timestamp

    Integer

    +

    Integer

    Time when an instance starts queuing. The value is a 13-digit timestamp.

    +

    Time when an instance starts queuing. The value is a 13-digit timestamp.

    remain_time

    +

    remain_time

    Integer

    +

    Integer

    Left queuing time, in seconds

    +

    Left queuing time, in seconds

    end_timestamp

    +

    end_timestamp

    Integer

    +

    Integer

    Time when an instance completes queuing. The value is a 13-digit timestamp.

    +

    Time when an instance completes queuing. The value is a 13-digit timestamp.

    rank

    +

    rank

    Integer

    +

    Integer

    Ranking of an instance in a queue

    +

    Ranking of an instance in a queue

    -
    Table 19 user parameters

    Parameter

    +
    - - - - - - - -
    Table 19 user parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    User ID

    +

    User ID

    name

    +

    name

    String

    +

    String

    Username

    +

    Username

    -
    Table 20 repository parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - -
    Table 20 repository parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Repository ID

    +

    Repository ID

    branch

    +

    branch

    String

    +

    String

    Repository branch

    +

    Repository branch

    user_name

    +

    user_name

    String

    +

    String

    Repository username

    +

    Repository username

    user_email

    +

    user_email

    String

    +

    String

    Repository user mailbox

    +

    Repository user mailbox

    type

    +

    type

    String

    +

    String

    Repository type. The options are CodeClub and GitHub.

    +

    Repository type. The options are CodeClub and GitHub.

    connection_info

    +

    connection_info

    Object

    +

    Object

    Repository link information. For details, see Table 21.

    +

    Repository link information. For details, see Table 21.

    -
    Table 21 connection_info parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 21 connection_info parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    protocol

    +

    protocol

    String

    +

    String

    Repository link protocol. The options are ssh and https.

    +

    Repository link protocol. The options are ssh and https.

    url

    +

    url

    String

    +

    String

    Repository link address

    +

    Repository link address

    credential

    +

    credential

    Object

    +

    Object

    Certificate information. For details, see Table 22.

    +

    Certificate information. For details, see Table 22.

    -
    Table 22 credential parameters

    Parameter

    +
    - - - - - - - - @@ -1213,7 +1213,9 @@ } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0112.html b/docs/modelarts/api-ref/modelarts_03_0112.html index bd8a6fa01..a6eb492bc 100644 --- a/docs/modelarts/api-ref/modelarts_03_0112.html +++ b/docs/modelarts/api-ref/modelarts_03_0112.html @@ -1,6 +1,6 @@ -

    Querying the Details About a Development Environment Instance

    +

    Querying Details About a Development Environment Instance

    Function

    This API is used to query the details about a development environment instance.

    URI

    GET /v1/{project_id}/demanager/instances/{instance_id}

    @@ -22,7 +22,7 @@
    - - - - - -
    Table 22 credential parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    ssh_private_key

    +

    ssh_private_key

    String

    +

    String

    SSH private certificate

    +

    SSH private certificate

    access_token

    +

    access_token

    String

    +

    String

    OAuth token of GitHub

    +

    OAuth token of GitHub

    String

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

    +

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

    instance_id

    @@ -538,21 +538,21 @@

    Object

    Storage path. For details, see Table 20.

    +

    Storage path. For details, see Table 12.

    credential

    Object

    AK and SK for accessing OBS. For details, see Table 30.

    +

    AK and SK for accessing OBS. For details, see Table 21.

    repository

    Object

    Git repository information. For details, see Table 28. This parameter cannot be used. It is automatically returned when the API is called.

    +

    Git repository information. For details, see Table 19. This parameter cannot be used. It is automatically returned when the API is called.

    resource_reserved_timestamp

    @@ -566,14 +566,14 @@

    Object

    Auto stop parameter. For details, see Table 23.

    +

    Auto stop parameter. For details, see Table 14.

    failed_reasons

    Object

    Cause for a creation or startup failure. For details, see Table 22.

    +

    Cause for a creation or startup failure. For details, see Table 15.

    annotations

    @@ -595,7 +595,7 @@
    -
    Table 12 storage parameters

    Parameter

    +
    @@ -615,14 +615,14 @@ -
    Table 12 storage parameters

    Parameter

    Type

    Object

    Storage location. If type is set to obs, this parameter is mandatory. See Table 21. By default, this parameter is left blank.

    +

    Storage location. If type is set to obs, this parameter is mandatory. See Table 13. By default, this parameter is left blank.

    -
    Table 13 location parameters

    Parameter

    +
    @@ -649,7 +649,7 @@
    Table 13 location parameters

    Parameter

    Type

    -
    Table 14 auto_stop parameters

    Parameter

    +
    @@ -696,7 +696,7 @@
    Table 14 auto_stop parameters

    Parameter

    Type

    -
    Table 15 failed_reasons parameters

    Parameter

    +
    @@ -789,7 +789,7 @@ -
    Table 15 failed_reasons parameters

    Parameter

    Type

    Object

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 16.

    +

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 7.

    status

    @@ -858,7 +858,7 @@
    -
    Table 19 repository parameters

    Parameter

    +
    @@ -905,14 +905,14 @@ -
    Table 19 repository parameters

    Parameter

    Type

    Object

    Repository link information. For details, see Table 29.

    +

    Repository link information. For details, see Table 20.

    -
    Table 20 connection_info parameters

    Parameter

    +
    @@ -938,14 +938,14 @@ -
    Table 20 connection_info parameters

    Parameter

    Type

    Object

    Certificate information. For details, see Table 30.

    +

    Certificate information. For details, see Table 21.

    -
    Table 21 credential parameters

    Parameter

    +
    @@ -1059,7 +1059,9 @@ "error_code": "ModelArts.6309" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0113.html b/docs/modelarts/api-ref/modelarts_03_0113.html index 4ba2f8db6..4cde10a68 100644 --- a/docs/modelarts/api-ref/modelarts_03_0113.html +++ b/docs/modelarts/api-ref/modelarts_03_0113.html @@ -22,7 +22,7 @@
    - - - - - - - - - - @@ -308,7 +308,7 @@ -
    Table 21 credential parameters

    Parameter

    Type

    String

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

    +

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

    instance_id

    @@ -191,7 +191,7 @@

    Object

    Configuration information. For details, see Table 12.

    +

    Configuration information. For details, see Table 16.

    flavor

    @@ -205,35 +205,35 @@

    Object

    For details about the flavor, see Table 16.

    +

    For details about the flavor, see Table 10.

    pool

    Object

    For details about the dedicated resource pool, see Table 17.

    +

    For details about the dedicated resource pool, see Table 11.

    spec

    Object

    Instance definition For details about parameters of a notebook instance, see Table 19.

    +

    Instance definition For details about parameters of a notebook instance, see Table 14.

    workspace

    Object

    Workspace. For details, see Table 24.

    +

    Workspace. For details, see Table 7.

    ai_project

    Object

    AI project. For details, see Table 25.

    +

    AI project. For details, see Table 10.

    error_code

    @@ -247,21 +247,21 @@

    Object

    Queuing information. For details, see Table 26.

    +

    Queuing information. For details, see Table 20.

    user

    Object

    User information. For details, see Table 27.

    +

    User information. For details, see Table 21.

    repository

    Object

    Git repository information. For details, see Table 28. This parameter cannot be used. It is automatically returned when the API is called.

    +

    Git repository information. For details, see Table 22. This parameter cannot be used. It is automatically returned when the API is called.

    Object

    Deployment information. For details, see Table 4.

    +

    Deployment information. For details, see Table 7.

    labels

    @@ -329,7 +329,7 @@
    -
    Table 7 provision parameters

    Parameter

    +
    @@ -422,7 +422,7 @@ -
    Table 7 provision parameters

    Parameter

    Type

    Table 10 flavor_details parameters

    Parameter

    +
    @@ -538,7 +538,7 @@
    Table 10 flavor_details parameters

    Parameter

    Type

    -
    Table 11 pool parameters

    Parameter

    +
    @@ -620,7 +620,7 @@
    Table 11 pool parameters

    Parameter

    Type

    -
    Table 14 notebook parameters

    Parameter

    +
    @@ -646,21 +646,21 @@ - - - - -
    Table 14 notebook parameters

    Parameter

    Type

    Object

    Storage path. For details, see Table 20.

    +

    Storage path. For details, see Table 15.

    credential

    Object

    AK and SK for accessing OBS. For details, see Table 30.

    +

    AK and SK for accessing OBS. For details, see Table 24.

    repository

    Object

    Git repository information. For details, see Table 28. This parameter cannot be used. It is automatically returned when the API is called.

    +

    Git repository information. For details, see Table 22. This parameter cannot be used. It is automatically returned when the API is called.

    resource_reserved_timestamp

    @@ -674,14 +674,14 @@

    Object

    Auto stop parameter. For details, see Table 23.

    +

    Auto stop parameter. For details, see Table 17.

    failed_reasons

    Object

    Cause for a creation or startup failure. For details, see Table 22.

    +

    Cause for a creation or startup failure. For details, see Table 18.

    annotations

    @@ -703,7 +703,7 @@
    -
    Table 15 storage parameters

    Parameter

    +
    @@ -753,7 +753,7 @@
    Table 15 storage parameters

    Parameter

    Type

    -
    Table 17 auto_stop parameters

    Parameter

    +
    @@ -800,7 +800,7 @@
    Table 17 auto_stop parameters

    Parameter

    Type

    -
    Table 18 failed_reasons parameters

    Parameter

    +
    @@ -852,7 +852,7 @@
    Table 18 failed_reasons parameters

    Parameter

    Type

    -
    Table 20 queuing_info parameters

    Parameter

    +
    @@ -893,7 +893,7 @@ -
    Table 20 queuing_info parameters

    Parameter

    Type

    Object

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 16.

    +

    Flavor details, which display the flavor information and whether the flavor is sold out For details, see Table 10.

    status

    @@ -936,7 +936,7 @@
    -
    Table 21 user parameters

    Parameter

    +
    @@ -962,7 +962,7 @@
    Table 21 user parameters

    Parameter

    Type

    -
    Table 22 repository parameters

    Parameter

    +
    @@ -1009,14 +1009,14 @@ -
    Table 22 repository parameters

    Parameter

    Type

    Object

    Repository link information. For details, see Table 29.

    +

    Repository link information. For details, see Table 23.

    -
    Table 23 connection_info parameters

    Parameter

    +
    @@ -1042,14 +1042,14 @@ -
    Table 23 connection_info parameters

    Parameter

    Type

    Object

    Certificate information. For details, see Table 30.

    +

    Certificate information. For details, see Table 21.

    -
    Table 24 credential parameters

    Parameter

    +
    @@ -1162,7 +1162,9 @@ "error_code": "ModelArts.6309" } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0114.html b/docs/modelarts/api-ref/modelarts_03_0114.html index 8cfda18f7..1fd951904 100644 --- a/docs/modelarts/api-ref/modelarts_03_0114.html +++ b/docs/modelarts/api-ref/modelarts_03_0114.html @@ -22,7 +22,7 @@
    - -
    Table 24 credential parameters

    Parameter

    Type

    String

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

    +

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

    instance_id

    @@ -73,7 +73,9 @@ } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0115.html b/docs/modelarts/api-ref/modelarts_03_0115.html index 8ab2f021f..1f61915f3 100644 --- a/docs/modelarts/api-ref/modelarts_03_0115.html +++ b/docs/modelarts/api-ref/modelarts_03_0115.html @@ -22,7 +22,7 @@

    String

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

    +

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

    instance_id

    @@ -107,7 +107,9 @@ } -

    Status Code

    For details about the status code, see Status Code.

    +

    Status Code

    For details about the status code, see Status Code.

    +
    +

    Error Codes

    See Error Codes.

    diff --git a/docs/modelarts/api-ref/modelarts_03_0138.html b/docs/modelarts/api-ref/modelarts_03_0138.html new file mode 100644 index 000000000..143fe9485 --- /dev/null +++ b/docs/modelarts/api-ref/modelarts_03_0138.html @@ -0,0 +1,23 @@ + + +

    Permissions Policies and Supported Actions

    +
    + + diff --git a/docs/modelarts/api-ref/modelarts_03_0140.html b/docs/modelarts/api-ref/modelarts_03_0140.html index f15c7c5e0..3859ae1f1 100644 --- a/docs/modelarts/api-ref/modelarts_03_0140.html +++ b/docs/modelarts/api-ref/modelarts_03_0140.html @@ -1,7 +1,8 @@

    API Calling

    -

    ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

    +

    ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

    +

    In addition, ModelArts provides SDKs of multiple programming languages for you to use. For details about how to use the SDKs, see ModelArts SDK Reference.