matreche/modelarts-umn
1
0
Fork 0
forked from docs/modelarts
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changes to ma_api-ref from docs/doc-exports#332 (Reduce length of special chars

Browse Source 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
This commit is contained in:
proposalbot 2022-10-18 07:11:40 +00:00 committed by zuul
parent b112803263
commit d0127cf2e3
8 changed files with 179 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-ref/source/common_parameters/error_codes.rst
View File

@ -688,13 +688,13 @@ Error Codes
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3056 | Task name ({0}) not meeting the specification. | 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 (-). | | 500 | ModelArts.3056 | Task name ({0}) not meeting the specification. | 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 (-). |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3057 | Task description ({0}) not meeting the specification. | Task description {0} does not comply with specifications. | Ensure that task description contains 1 to 100 characters and cannot contain the following characters: &,!\"<>=. | | 500 | ModelArts.3057 | Task description ({0}) not meeting the specification. | Task description {0} does not comply with specifications. | Ensure that task description contains 1 to 100 characters and cannot contain the following characters: ``&,!\"<>=.`` |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3058 | Task input ({0}) not meeting the specification. | Task input {0} does not comply with specifications. | Perform operations according to the error message. | | 500 | ModelArts.3058 | Task input ({0}) not meeting the specification. | Task input {0} does not comply with specifications. | Perform operations according to the error message. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3059 | Task output ({0}) not meeting the specification. | Task output {0} does not comply with specifications. | Ensure that the task output is a valid HTTP or HTTPS address. | | 500 | ModelArts.3059 | Task output ({0}) not meeting the specification. | Task output {0} does not comply with specifications. | Ensure that the task output is a valid HTTP or HTTPS address. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3060 | Task spec ({0}) not meeting the specification. | 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. | | 500 | ModelArts.3060 | Task spec ({0}) not meeting the specification. | 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. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 500 | ModelArts.3061 | get Task ({0}) log parameter not meeting the specification. | Log parameters of task {0} do not comply with specifications. | Ensure that the offset or lines value is greater than or equal to 0. | | 500 | ModelArts.3061 | get Task ({0}) log parameter not meeting the specification. | Log parameters of task {0} do not comply with specifications. | Ensure that the offset or lines value is greater than or equal to 0. |
+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

60
api-ref/source/data_management/dataset_management/creating_a_dataset.rst
View File

@ -54,7 +54,7 @@ Request Parameters
| | | | - **600**: video labeling | | | | | - **600**: video labeling |
| | | | - **900**: custom format | | | | | - **900**: custom format |
+-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Dataset description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | No | String | 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 | No | Boolean | Whether to automatically import the labeling information in the input directory, supporting detection, image classification, and text classification. The options are as follows: | | import_annotations | No | Boolean | Whether to automatically import the labeling information in the input directory, supporting detection, image classification, and text classification. The options are as follows: |
| | | | | | | | | |
@ -350,35 +350,35 @@ Request Parameters
.. table:: **Table 15** Worker .. table:: **Table 15** Worker
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================================================================+ +=================+=================+=================+==============================================================================================================================================+
| create_time | No | Long | Creation time. | | create_time | No | Long | Creation time. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| email | No | String | Email address of a labeling team member. | | email | No | String | Email address of a labeling team member. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| role | No | Integer | Role. The options are as follows: | | role | No | Integer | Role. The options are as follows: |
| | | | | | | | | |
| | | | - **0**: labeling personnel | | | | | - **0**: labeling personnel |
| | | | - **1**: reviewer | | | | | - **1**: reviewer |
| | | | - **2**: team administrator | | | | | - **2**: team administrator |
| | | | - **3**: dataset owner | | | | | - **3**: dataset owner |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| status | No | Integer | Current login status of a labeling team member. The options are as follows: | | status | No | Integer | Current login status of a labeling team member. The options are as follows: |
| | | | | | | | | |
| | | | - **0**: The invitation email has not been sent. | | | | | - **0**: The invitation email has not been sent. |
| | | | - **1**: The invitation email has been sent but the user has not logged in. | | | | | - **1**: The invitation email has been sent but the user has not logged in. |
| | | | - **2**: The user has logged in. | | | | | - **2**: The user has logged in. |
| | | | - **3**: The labeling team member has been deleted. | | | | | - **3**: The labeling team member has been deleted. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| update_time | No | Long | Update time. | | update_time | No | Long | Update time. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| worker_id | No | String | ID of a labeling team member. | | worker_id | No | String | ID of a labeling team member. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_id | No | String | ID of a labeling team. | | workforce_id | No | String | ID of a labeling team. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters Response Parameters
------------------- -------------------

30
api-ref/source/data_management/dataset_management/modifying_a_dataset.rst
View File

@ -30,21 +30,21 @@ Request Parameters
.. table:: **Table 2** Request body parameters .. table:: **Table 2** Request body parameters
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+====================+===========+==============================================================+=============================================================================================================================+ +====================+===========+==============================================================+=================================================================================================================================+
| add_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of added labels. | | add_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of added labels. |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| current_version_id | No | String | ID of current dataset version. | | current_version_id | No | String | ID of current dataset version. |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| dataset_name | No | String | Dataset name. | | dataset_name | No | String | Dataset name. |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| delete_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of deleted labels. | | delete_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of deleted labels. |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Dataset description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | No | String | Dataset description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| update_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of updated labels. | | update_labels | No | Array of :ref:`Label <updatedataset__request_label>` objects | List of updated labels. |
+--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
.. _updatedataset__request_label: .. _updatedataset__request_label:

70
api-ref/source/data_management/dataset_management/querying_details_about_a_dataset.rst
View File

@ -714,41 +714,41 @@ Response Parameters
.. table:: **Table 15** Worker .. table:: **Table 15** Worker
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+==========================================================================================================================================+ +=======================+=======================+==============================================================================================================================================+
| create_time | Long | Creation time. | | create_time | Long | Creation time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| email | String | Email address of a labeling team member. | | email | String | Email address of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| role | Integer | Role. The options are as follows: | | role | Integer | Role. The options are as follows: |
| | | | | | | |
| | | - **0**: labeling personnel | | | | - **0**: labeling personnel |
| | | | | | | |
| | | - **1**: reviewer | | | | - **1**: reviewer |
| | | | | | | |
| | | - **2**: team administrator | | | | - **2**: team administrator |
| | | | | | | |
| | | - **3**: dataset owner | | | | - **3**: dataset owner |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Current login status of a labeling team member. The options are as follows: | | status | Integer | Current login status of a labeling team member. The options are as follows: |
| | | | | | | |
| | | - **0**: The invitation email has not been sent. | | | | - **0**: The invitation email has not been sent. |
| | | | | | | |
| | | - **1**: The invitation email has been sent but the user has not logged in. | | | | - **1**: The invitation email has been sent but the user has not logged in. |
| | | | | | | |
| | | - **2**: The user has logged in. | | | | - **2**: The user has logged in. |
| | | | | | | |
| | | - **3**: The labeling team member has been deleted. | | | | - **3**: The labeling team member has been deleted. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| update_time | Long | Update time. | | update_time | Long | Update time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| worker_id | String | ID of a labeling team member. | | worker_id | String | ID of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_id | String | ID of a labeling team. | | workforce_id | String | ID of a labeling team. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Example Requests Example Requests
---------------- ----------------

58
api-ref/source/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst
View File

@ -704,35 +704,35 @@ Response Parameters
.. table:: **Table 17** Worker .. table:: **Table 17** Worker
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+==========================================================================================================================================+ +=======================+=======================+==============================================================================================================================================+
| create_time | Long | Creation time. | | create_time | Long | Creation time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| email | String | Email address of a labeling team member. | | email | String | Email address of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| role | Integer | Role. The options are as follows: | | role | Integer | Role. The options are as follows: |
| | | | | | | |
| | | - **0**: labeling personnel | | | | - **0**: labeling personnel |
| | | - **1**: reviewer | | | | - **1**: reviewer |
| | | - **2**: team administrator | | | | - **2**: team administrator |
| | | - **3**: dataset owner | | | | - **3**: dataset owner |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Current login status of a labeling team member. The options are as follows: | | status | Integer | Current login status of a labeling team member. The options are as follows: |
| | | | | | | |
| | | - **0**: The invitation email has not been sent. | | | | - **0**: The invitation email has not been sent. |
| | | - **1**: The invitation email has been sent but the user has not logged in. | | | | - **1**: The invitation email has been sent but the user has not logged in. |
| | | - **2**: The user has logged in. | | | | - **2**: The user has logged in. |
| | | - **3**: The labeling team member has been deleted. | | | | - **3**: The labeling team member has been deleted. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| update_time | Long | Update time. | | update_time | Long | Update time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| worker_id | String | ID of a labeling team member. | | worker_id | String | ID of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_id | String | ID of a labeling team. | | workforce_id | String | ID of a labeling team. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
Example Requests Example Requests
---------------- ----------------

58
api-ref/source/data_management/sample_management/querying_details_about_a_sample.rst
View File

@ -162,35 +162,35 @@ Response Parameters
.. table:: **Table 5** Worker .. table:: **Table 5** Worker
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+==========================================================================================================================================+ +=======================+=======================+==============================================================================================================================================+
| create_time | Long | Creation time. | | create_time | Long | Creation time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| email | String | Email address of a labeling team member. | | email | String | Email address of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| role | Integer | Role. The options are as follows: | | role | Integer | Role. The options are as follows: |
| | | | | | | |
| | | - **0**: labeling personnel | | | | - **0**: labeling personnel |
| | | - **1**: reviewer | | | | - **1**: reviewer |
| | | - **2**: team administrator | | | | - **2**: team administrator |
| | | - **3**: dataset owner | | | | - **3**: dataset owner |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Current login status of a labeling team member. The options are as follows: | | status | Integer | Current login status of a labeling team member. The options are as follows: |
| | | | | | | |
| | | - **0**: The invitation email has not been sent. | | | | - **0**: The invitation email has not been sent. |
| | | - **1**: The invitation email has been sent but the user has not logged in. | | | | - **1**: The invitation email has been sent but the user has not logged in. |
| | | - **2**: The user has logged in. | | | | - **2**: The user has logged in. |
| | | - **3**: The labeling team member has been deleted. | | | | - **3**: The labeling team member has been deleted. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| update_time | Long | Update time. | | update_time | Long | Update time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| worker_id | String | ID of a labeling team member. | | worker_id | String | ID of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_id | String | ID of a labeling team. | | workforce_id | String | ID of a labeling team. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
.. _describesample__response_samplelabel: .. _describesample__response_samplelabel:

58
api-ref/source/data_management/sample_management/querying_the_sample_list.rst
View File

@ -221,35 +221,35 @@ Response Parameters
.. table:: **Table 6** Worker .. table:: **Table 6** Worker
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+==========================================================================================================================================+ +=======================+=======================+==============================================================================================================================================+
| create_time | Long | Creation time. | | create_time | Long | Creation time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ``^!<>=&"'`` |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| email | String | Email address of a labeling team member. | | email | String | Email address of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| role | Integer | Role. The options are as follows: | | role | Integer | Role. The options are as follows: |
| | | | | | | |
| | | - **0**: labeling personnel | | | | - **0**: labeling personnel |
| | | - **1**: reviewer | | | | - **1**: reviewer |
| | | - **2**: team administrator | | | | - **2**: team administrator |
| | | - **3**: dataset owner | | | | - **3**: dataset owner |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Current login status of a labeling team member. The options are as follows: | | status | Integer | Current login status of a labeling team member. The options are as follows: |
| | | | | | | |
| | | - **0**: The invitation email has not been sent. | | | | - **0**: The invitation email has not been sent. |
| | | - **1**: The invitation email has been sent but the user has not logged in. | | | | - **1**: The invitation email has been sent but the user has not logged in. |
| | | - **2**: The user has logged in. | | | | - **2**: The user has logged in. |
| | | - **3**: The labeling team member has been deleted. | | | | - **3**: The labeling team member has been deleted. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| update_time | Long | Update time. | | update_time | Long | Update time. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| worker_id | String | ID of a labeling team member. | | worker_id | String | ID of a labeling team member. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| workforce_id | String | ID of a labeling team. | | workforce_id | String | ID of a labeling team. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
.. _listsamples__response_samplelabel: .. _listsamples__response_samplelabel:

20
api-ref/source/model_management/importing_a_model.rst
View File

@ -57,7 +57,7 @@ Request Body
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| runtime | No | String | For details about **runtime** options, see **Model Management** > **Importing a Model** > **Importing a Meta Model from OBS** in *ModelArts User Guide*. | | runtime | No | String | For details about **runtime** options, see **Model Management** > **Importing a Model** > **Importing a Meta Model from OBS** in *ModelArts User Guide*. |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Model remarks. The value contains a maximum of 100 characters and cannot contain the following special characters and more: &!'\"<>= | | description | No | String | Model remarks. The value contains a maximum of 100 characters and cannot contain the following special characters and more: ``&!'\"<>=`` |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| model_algorithm | No | String | Model algorithm. If the algorithm is read from the configuration file, this parameter can be left blank. For example, the value can be **predict_analysis**, **object_detection**, or **image_classification**. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters ``(&!'\"<>=)`` are not allowed. | | model_algorithm | No | String | Model algorithm. If the algorithm is read from the configuration file, this parameter can be left blank. For example, the value can be **predict_analysis**, **object_detection**, or **image_classification**. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters ``(&!'\"<>=)`` are not allowed. |
+--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -124,15 +124,15 @@ Request Body
.. table:: **Table 5** **package** parameters .. table:: **Table 5** **package** parameters
+-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+===========+========+====================================================================================================================================================================================+ +=================+===========+========+========================================================================================================================================================================================+
| package_name | Yes | String | Name of a dependency package. Ensure that the package name is correct and exists. Chinese characters and special characters (&!'"<>=) are not allowed. | | package_name | Yes | String | Name of a dependency package. Ensure that the package name is correct and exists. Chinese characters and special characters ``(&!'"<>=)`` are not allowed. |
+-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| package_version | No | String | Version of a dependency package. If this parameter is left blank, the latest version is installed by default. Chinese characters and special characters (&!'"<>=) are not allowed. | | package_version | No | String | Version of a dependency package. If this parameter is left blank, the latest version is installed by default. Chinese characters and special characters ``(&!'"<>=)`` are not allowed. |
+-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| restraint | No | String | Version restriction. The value can be **EXACT**, **ATLEAST**, or **ATMOST**. This parameter is mandatory only when **package_version** exists. | | restraint | No | String | Version restriction. The value can be **EXACT**, **ATLEAST**, or **ATMOST**. This parameter is mandatory only when **package_version** exists. |
+-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 6** **metric** parameters .. table:: **Table 6** **metric** parameters