Example Requests
Upload authorization.
-
POST https://{endpoint}/v2/{project_id}/authorizations
+Example Requests
Upload authorization.
+
POST https://{endpoint}/v2/{project_id}/authorizations
{
"user_id" : "****d80fb058844ae8b82aa66d9fe****",
@@ -100,49 +96,49 @@
"content" : "modelarts_agency"
}
Example Responses
Status code: 200
-
OK
-
{
+Example Responses
Status code: 200
+
OK
+
{
"result" : "true"
}
Status Codes
-
Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-OK
+ | OK
|
-400
+ | 400
|
-Bad Request
+ | Bad Request
|
-401
+ | 401
|
-Unauthorized
+ | Unauthorized
|
-403
+ | 403
|
-Forbidden
+ | Forbidden
|
-404
+ | 404
|
-Not Found
+ | Not Found
|
diff --git a/docs/modelarts/api-ref/CreateDataset.html b/docs/modelarts/api-ref/CreateDataset.html
index 18653c115..fa67dbd09 100644
--- a/docs/modelarts/api-ref/CreateDataset.html
+++ b/docs/modelarts/api-ref/CreateDataset.html
@@ -1,984 +1,1003 @@
Creating a Dataset
- FunctionThis API is used to create a dataset.
+ FunctionThis API is used to create a dataset.
- URIPOST /v2/{project_id}/datasets
+ URIPOST /v2/{project_id}/datasets
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-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 parametersParameter
+Request Parameters
+ Table 2 Request body parametersParameter
|
-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 DataSourceParameter
+Table 3 DataSourceParameter
|
-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 SchemaMapParameter
+Table 4 SchemaMapParameter
|
-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 SourceInfoParameter
+Table 5 SourceInfoParameter
|
-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.
|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|