forked from docs/modelarts
Update content (#31)
Changes to ma_api from doc-exports#1 This is an automatically created Pull Request for changes to ma_api in opentelekomcloud-docs/doc-exports#1. Please do not edit it manually, since update to the original PR will overwrite local changes. Original patch file, as well as complete rst archive, can be found in the artifacts of the opentelekomcloud-docs/doc-exports#1 Reviewed-by: Vineet Pruthi <None>
This commit is contained in:
parent
10a5d8856a
commit
4317c860a8
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0002.html
|
||||
|
||||
.. _modelarts_03_0002:
|
||||
|
||||
API Overview
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0401.html
|
||||
|
||||
.. _modelarts_03_0401:
|
||||
|
||||
Creating a Training Job Using the TensorFlow Framework
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateAuthorization.html
|
||||
|
||||
.. _CreateAuthorization:
|
||||
|
||||
Configuring Authorization
|
||||
@ -64,7 +66,7 @@ Example Requests
|
||||
|
||||
Upload authorization.
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{endpoint}/v2/{project_id}/authorizations
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateModelArtsAgency.html
|
||||
|
||||
.. _CreateModelArtsAgency:
|
||||
|
||||
Creating a ModelArts Agency
|
||||
@ -50,7 +52,7 @@ Example Requests
|
||||
|
||||
Create a ModelArts agency.
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{endpoint}/v2/{project_id}/agency
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DeleteAuthorizations.html
|
||||
|
||||
.. _DeleteAuthorizations:
|
||||
|
||||
Deleting Authorization
|
||||
@ -44,7 +46,7 @@ Example Requests
|
||||
|
||||
Delete the authorization of a specified user.
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{endpoint}/v2/{project_id}/authorizations?user_id=****d80fb058844ae8b82aa66d9fe****
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: GetAuthorizations.html
|
||||
|
||||
.. _GetAuthorizations:
|
||||
|
||||
Viewing an Authorization List
|
||||
@ -112,7 +114,7 @@ Example Requests
|
||||
|
||||
View an authorization list.
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/authorizations
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0140.html
|
||||
|
||||
.. _modelarts_03_0140:
|
||||
|
||||
API Calling
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0143.html
|
||||
|
||||
.. _modelarts_03_0143:
|
||||
|
||||
Basic Concepts
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0141.html
|
||||
|
||||
.. _modelarts_03_0141:
|
||||
|
||||
Endpoints
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0001.html
|
||||
|
||||
.. _modelarts_03_0001:
|
||||
|
||||
Overview
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0004.html
|
||||
|
||||
.. _modelarts_03_0004:
|
||||
|
||||
Authentication
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0005.html
|
||||
|
||||
.. _modelarts_03_0005:
|
||||
|
||||
Making an API Request
|
||||
@ -65,7 +67,7 @@ The HTTP protocol defines the following request methods that can be used to send
|
||||
|
||||
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{iam-endpoint}/v3/auth/tokens
|
||||
|
||||
@ -116,7 +118,7 @@ You can also add additional header fields to a request, such as the fields requi
|
||||
|
||||
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:
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{iam-endpoint}/v3/auth/tokens
|
||||
Content-Type: application/json
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0003.html
|
||||
|
||||
.. _modelarts_03_0003:
|
||||
|
||||
Response
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0097.html
|
||||
|
||||
.. _modelarts_03_0097:
|
||||
|
||||
Change History
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0095.html
|
||||
|
||||
.. _modelarts_03_0095:
|
||||
|
||||
Error Codes
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0147.html
|
||||
|
||||
.. _modelarts_03_0147:
|
||||
|
||||
Obtaining a Project ID and Name
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0006.html
|
||||
|
||||
.. _modelarts_03_0006:
|
||||
|
||||
Obtaining a Username and ID
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0148.html
|
||||
|
||||
.. _modelarts_03_0148:
|
||||
|
||||
Obtaining an Account Name and ID
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0094.html
|
||||
|
||||
.. _modelarts_03_0094:
|
||||
|
||||
Status Code
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ExportTask.html
|
||||
|
||||
.. _ExportTask:
|
||||
|
||||
Creating a Dataset Export Task
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: GetExportTasksStatusOfDataset.html
|
||||
|
||||
.. _GetExportTasksStatusOfDataset:
|
||||
|
||||
Querying the Dataset Export Task List
|
||||
@ -362,7 +364,7 @@ Example Requests
|
||||
|
||||
Querying the Export Task List by Page
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: GetExportTaskStatusOfDataset.html
|
||||
|
||||
.. _GetExportTaskStatusOfDataset:
|
||||
|
||||
Querying the Status of a Dataset Export Task
|
||||
@ -284,7 +286,7 @@ Example Requests
|
||||
|
||||
Querying the Status of an Export Task (Exporting Data to OBS)
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks/{task_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ImportTask.html
|
||||
|
||||
.. _ImportTask:
|
||||
|
||||
Creating an Import Task
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DescImportTask.html
|
||||
|
||||
.. _DescImportTask:
|
||||
|
||||
Querying Details About a Dataset Import Task
|
||||
@ -215,7 +217,7 @@ Example Requests
|
||||
|
||||
Querying Details About an Import Task
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListImportTasks.html
|
||||
|
||||
.. _ListImportTasks:
|
||||
|
||||
Querying the Dataset Import Task List
|
||||
@ -235,7 +237,7 @@ Example Requests
|
||||
|
||||
Obtaining the Dataset Import Task List
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: modelarts_03_0299.html
|
||||
|
||||
.. _modelarts_03_0299:
|
||||
|
||||
Data Management APIs
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: SyncDataSourceState.html
|
||||
|
||||
.. _SyncDataSourceState:
|
||||
|
||||
Querying the Status of a Dataset Synchronization Task
|
||||
@ -76,7 +78,7 @@ Example Requests
|
||||
|
||||
Obtaining the Status of a Dataset Synchronization
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: SyncDataSource.html
|
||||
|
||||
.. _SyncDataSource:
|
||||
|
||||
Synchronizing a Dataset
|
||||
@ -38,7 +40,7 @@ Example Requests
|
||||
|
||||
Synchronizing a Dataset
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateDataset.html
|
||||
|
||||
.. _CreateDataset:
|
||||
|
||||
Creating a Dataset
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DeleteDataset.html
|
||||
|
||||
.. _DeleteDataset:
|
||||
|
||||
Deleting a Dataset
|
||||
@ -38,7 +40,7 @@ Example Requests
|
||||
|
||||
Deleting a Dataset
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: UpdateDataset.html
|
||||
|
||||
.. _UpdateDataset:
|
||||
|
||||
Modifying a Dataset
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListStats.html
|
||||
|
||||
.. _ListStats:
|
||||
|
||||
Querying Dataset Statistics
|
||||
@ -236,7 +238,7 @@ Example Requests
|
||||
|
||||
Querying Dataset Statistics
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DescDataset.html
|
||||
|
||||
.. _DescDataset:
|
||||
|
||||
Querying Details About a Dataset
|
||||
@ -753,7 +755,7 @@ Example Requests
|
||||
|
||||
Querying Details About a Dataset
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListWorkforceTaskStats.html
|
||||
|
||||
.. _ListWorkforceTaskStats:
|
||||
|
||||
Querying Details About Team Labeling Task Statistics
|
||||
@ -230,7 +232,7 @@ Example Requests
|
||||
|
||||
Querying Statistics on Unapproved Samples of a Team Labeling Task
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/workforce-tasks/tY330MHxV9dqIPVaTRM/data-annotations/stats?sample_state=__unreviewed__
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: GetWorkforceTaskMetrics.html
|
||||
|
||||
.. _GetWorkforceTaskMetrics:
|
||||
|
||||
Querying Details About the Progress of a Team Labeling Task Member
|
||||
@ -48,7 +50,7 @@ Example Requests
|
||||
|
||||
Querying Details About the Progress of a Team Labeling Task Member
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: GetDatasetMetrics.html
|
||||
|
||||
.. _GetDatasetMetrics:
|
||||
|
||||
Querying the Monitoring Data of a Dataset
|
||||
@ -58,7 +60,7 @@ Example Requests
|
||||
|
||||
Querying the Monitoring Data of a Dataset
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/metrics
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListDatasets.html
|
||||
|
||||
.. _ListDatasets:
|
||||
|
||||
Response body for querying the dataset list.
|
||||
@ -863,7 +865,7 @@ Example Requests
|
||||
|
||||
Querying the Dataset List
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets?offset=0&limit=10&sort_by=create_time&order=desc&dataset_type=0&file_preview=true
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateDatasetVersion.html
|
||||
|
||||
.. _CreateDatasetVersion:
|
||||
|
||||
Creating a Dataset Labeling Version
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DeleteDatasetVersion.html
|
||||
|
||||
.. _DeleteDatasetVersion:
|
||||
|
||||
Deleting a Dataset Labeling Version
|
||||
@ -40,7 +42,7 @@ Example Requests
|
||||
|
||||
Deleting a Dataset Labeling Version
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DescribeDatasetVersion.html
|
||||
|
||||
.. _DescribeDatasetVersion:
|
||||
|
||||
Querying Details About a Dataset Version
|
||||
@ -345,7 +347,7 @@ Example Requests
|
||||
|
||||
Querying Details About a Dataset Version
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListDatasetVersions.html
|
||||
|
||||
.. _ListDatasetVersions:
|
||||
|
||||
Querying the Dataset Version List
|
||||
@ -383,7 +385,7 @@ Example Requests
|
||||
|
||||
Querying the Version List of a Specific Dataset
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: AutoAnnotationProgress.html
|
||||
|
||||
.. _AutoAnnotationProgress:
|
||||
|
||||
Obtaining Information About Intelligent Tasks
|
||||
@ -863,7 +865,7 @@ Example Requests
|
||||
|
||||
Obtaining Information About an Auto Labeling (Active Learning) Task
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListAutoAnnotationSamples.html
|
||||
|
||||
.. _ListAutoAnnotationSamples:
|
||||
|
||||
Querying Auto Labeling Sample List
|
||||
@ -507,7 +509,7 @@ Example Requests
|
||||
|
||||
Querying Auto Labeling Sample List
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DescribeAutoAnnotationSample.html
|
||||
|
||||
.. _DescribeAutoAnnotationSample:
|
||||
|
||||
Querying Details About an Auto Labeling Sample
|
||||
@ -447,7 +449,7 @@ Example Requests
|
||||
|
||||
Querying Details About an Auto Labeling Sample
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id}
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: ListTasks.html
|
||||
|
||||
.. _ListTasks:
|
||||
|
||||
Querying the Intelligent Task List by Page
|
||||
@ -905,7 +907,7 @@ Example Requests
|
||||
|
||||
Querying the List of Auto Labeling, One-Click Model Deployment, or Auto Grouping Tasks by Page
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks?offset=0&limit=10
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateTask.html
|
||||
|
||||
.. _CreateTask:
|
||||
|
||||
Starting Intelligent Tasks
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: StopAutoAnnotation.html
|
||||
|
||||
.. _StopAutoAnnotation:
|
||||
|
||||
Stopping an Intelligent Task
|
||||
@ -40,7 +42,7 @@ Example Requests
|
||||
|
||||
Stopping Auto Labeling, One-Click Model Deployment, or Auto Grouping Tasks
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}/stop
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: CreateLabels.html
|
||||
|
||||
.. _CreateLabels:
|
||||
|
||||
Creating a Dataset Label
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DeleteLabelAndSamples.html
|
||||
|
||||
.. _DeleteLabelAndSamples:
|
||||
|
||||
Deleting a Label and the Files that Only Contain the Label
|
||||
@ -90,7 +92,7 @@ Example Requests
|
||||
|
||||
Deleting a Label and the Files that Only Contain the Label
|
||||
|
||||
.. code-block::
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels/%E8%8D%89%E8%8E%93
|
||||
|
||||
|
@ -1,3 +1,5 @@
|
||||
:original_name: DeleteLabels.html
|
||||
|
||||
.. _DeleteLabels:
|
||||
|
||||
Deleting Labels in Batches
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user