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:
otcbot[bot] 2022-05-02 14:51:57 +00:00 committed by GitHub
parent 10a5d8856a
commit 4317c860a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
157 changed files with 425 additions and 111 deletions

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0002.html
.. _modelarts_03_0002: .. _modelarts_03_0002:
API Overview API Overview

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0401.html
.. _modelarts_03_0401: .. _modelarts_03_0401:
Creating a Training Job Using the TensorFlow Framework Creating a Training Job Using the TensorFlow Framework

View File

@ -1,3 +1,5 @@
:original_name: CreateAuthorization.html
.. _CreateAuthorization: .. _CreateAuthorization:
Configuring Authorization Configuring Authorization
@ -64,7 +66,7 @@ Example Requests
Upload authorization. Upload authorization.
.. code-block:: .. code-block:: text
POST https://{endpoint}/v2/{project_id}/authorizations POST https://{endpoint}/v2/{project_id}/authorizations

View File

@ -1,3 +1,5 @@
:original_name: CreateModelArtsAgency.html
.. _CreateModelArtsAgency: .. _CreateModelArtsAgency:
Creating a ModelArts Agency Creating a ModelArts Agency
@ -50,7 +52,7 @@ Example Requests
Create a ModelArts agency. Create a ModelArts agency.
.. code-block:: .. code-block:: text
POST https://{endpoint}/v2/{project_id}/agency POST https://{endpoint}/v2/{project_id}/agency

View File

@ -1,3 +1,5 @@
:original_name: DeleteAuthorizations.html
.. _DeleteAuthorizations: .. _DeleteAuthorizations:
Deleting Authorization Deleting Authorization
@ -44,7 +46,7 @@ Example Requests
Delete the authorization of a specified user. Delete the authorization of a specified user.
.. code-block:: .. code-block:: text
DELETE https://{endpoint}/v2/{project_id}/authorizations?user_id=****d80fb058844ae8b82aa66d9fe**** DELETE https://{endpoint}/v2/{project_id}/authorizations?user_id=****d80fb058844ae8b82aa66d9fe****

View File

@ -1,3 +1,5 @@
:original_name: GetAuthorizations.html
.. _GetAuthorizations: .. _GetAuthorizations:
Viewing an Authorization List Viewing an Authorization List
@ -112,7 +114,7 @@ Example Requests
View an authorization list. View an authorization list.
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/authorizations GET https://{endpoint}/v2/{project_id}/authorizations

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0140.html
.. _modelarts_03_0140: .. _modelarts_03_0140:
API Calling API Calling

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0143.html
.. _modelarts_03_0143: .. _modelarts_03_0143:
Basic Concepts Basic Concepts

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0141.html
.. _modelarts_03_0141: .. _modelarts_03_0141:
Endpoints Endpoints

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0001.html
.. _modelarts_03_0001: .. _modelarts_03_0001:
Overview Overview

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0004.html
.. _modelarts_03_0004: .. _modelarts_03_0004:
Authentication Authentication

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0005.html
.. _modelarts_03_0005: .. _modelarts_03_0005:
Making an API Request 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: 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 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: 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 POST https://{iam-endpoint}/v3/auth/tokens
Content-Type: application/json Content-Type: application/json

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0003.html
.. _modelarts_03_0003: .. _modelarts_03_0003:
Response Response

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0097.html
.. _modelarts_03_0097: .. _modelarts_03_0097:
Change History Change History

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0095.html
.. _modelarts_03_0095: .. _modelarts_03_0095:
Error Codes Error Codes

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0147.html
.. _modelarts_03_0147: .. _modelarts_03_0147:
Obtaining a Project ID and Name Obtaining a Project ID and Name

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0006.html
.. _modelarts_03_0006: .. _modelarts_03_0006:
Obtaining a Username and ID Obtaining a Username and ID

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0148.html
.. _modelarts_03_0148: .. _modelarts_03_0148:
Obtaining an Account Name and ID Obtaining an Account Name and ID

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0094.html
.. _modelarts_03_0094: .. _modelarts_03_0094:
Status Code Status Code

View File

@ -1,3 +1,5 @@
:original_name: ExportTask.html
.. _ExportTask: .. _ExportTask:
Creating a Dataset Export Task Creating a Dataset Export Task

View File

@ -1,3 +1,5 @@
:original_name: GetExportTasksStatusOfDataset.html
.. _GetExportTasksStatusOfDataset: .. _GetExportTasksStatusOfDataset:
Querying the Dataset Export Task List Querying the Dataset Export Task List
@ -362,7 +364,7 @@ Example Requests
Querying the Export Task List by Page Querying the Export Task List by Page
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks

View File

@ -1,3 +1,5 @@
:original_name: GetExportTaskStatusOfDataset.html
.. _GetExportTaskStatusOfDataset: .. _GetExportTaskStatusOfDataset:
Querying the Status of a Dataset Export Task 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) 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} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks/{task_id}

View File

@ -1,3 +1,5 @@
:original_name: ImportTask.html
.. _ImportTask: .. _ImportTask:
Creating an Import Task Creating an Import Task

View File

@ -1,3 +1,5 @@
:original_name: DescImportTask.html
.. _DescImportTask: .. _DescImportTask:
Querying Details About a Dataset Import Task Querying Details About a Dataset Import Task
@ -215,7 +217,7 @@ Example Requests
Querying Details About an Import Task Querying Details About an Import Task
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id}

View File

@ -1,3 +1,5 @@
:original_name: ListImportTasks.html
.. _ListImportTasks: .. _ListImportTasks:
Querying the Dataset Import Task List Querying the Dataset Import Task List
@ -235,7 +237,7 @@ Example Requests
Obtaining the Dataset Import Task List Obtaining the Dataset Import Task List
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks

View File

@ -1,3 +1,5 @@
:original_name: modelarts_03_0299.html
.. _modelarts_03_0299: .. _modelarts_03_0299:
Data Management APIs Data Management APIs

View File

@ -1,3 +1,5 @@
:original_name: SyncDataSourceState.html
.. _SyncDataSourceState: .. _SyncDataSourceState:
Querying the Status of a Dataset Synchronization Task Querying the Status of a Dataset Synchronization Task
@ -76,7 +78,7 @@ Example Requests
Obtaining the Status of a Dataset Synchronization Obtaining the Status of a Dataset Synchronization
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status

View File

@ -1,3 +1,5 @@
:original_name: SyncDataSource.html
.. _SyncDataSource: .. _SyncDataSource:
Synchronizing a Dataset Synchronizing a Dataset
@ -38,7 +40,7 @@ Example Requests
Synchronizing a Dataset Synchronizing a Dataset
.. code-block:: .. code-block:: text
POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data

View File

@ -1,3 +1,5 @@
:original_name: CreateDataset.html
.. _CreateDataset: .. _CreateDataset:
Creating a Dataset Creating a Dataset

View File

@ -1,3 +1,5 @@
:original_name: DeleteDataset.html
.. _DeleteDataset: .. _DeleteDataset:
Deleting a Dataset Deleting a Dataset
@ -38,7 +40,7 @@ Example Requests
Deleting a Dataset Deleting a Dataset
.. code-block:: .. code-block:: text
DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id} DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}

View File

@ -1,3 +1,5 @@
:original_name: UpdateDataset.html
.. _UpdateDataset: .. _UpdateDataset:
Modifying a Dataset Modifying a Dataset

View File

@ -1,3 +1,5 @@
:original_name: ListStats.html
.. _ListStats: .. _ListStats:
Querying Dataset Statistics Querying Dataset Statistics
@ -236,7 +238,7 @@ Example Requests
Querying Dataset Statistics Querying Dataset Statistics
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats

View File

@ -1,3 +1,5 @@
:original_name: DescDataset.html
.. _DescDataset: .. _DescDataset:
Querying Details About a Dataset Querying Details About a Dataset
@ -753,7 +755,7 @@ Example Requests
Querying Details About a Dataset Querying Details About a Dataset
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}

View File

@ -1,3 +1,5 @@
:original_name: ListWorkforceTaskStats.html
.. _ListWorkforceTaskStats: .. _ListWorkforceTaskStats:
Querying Details About Team Labeling Task Statistics Querying Details About Team Labeling Task Statistics
@ -230,7 +232,7 @@ Example Requests
Querying Statistics on Unapproved Samples of a Team Labeling Task 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__ GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/workforce-tasks/tY330MHxV9dqIPVaTRM/data-annotations/stats?sample_state=__unreviewed__

View File

@ -1,3 +1,5 @@
:original_name: GetWorkforceTaskMetrics.html
.. _GetWorkforceTaskMetrics: .. _GetWorkforceTaskMetrics:
Querying Details About the Progress of a Team Labeling Task Member 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 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 GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics

View File

@ -1,3 +1,5 @@
:original_name: GetDatasetMetrics.html
.. _GetDatasetMetrics: .. _GetDatasetMetrics:
Querying the Monitoring Data of a Dataset Querying the Monitoring Data of a Dataset
@ -58,7 +60,7 @@ Example Requests
Querying the Monitoring Data of a Dataset Querying the Monitoring Data of a Dataset
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/metrics GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/metrics

View File

@ -1,3 +1,5 @@
:original_name: ListDatasets.html
.. _ListDatasets: .. _ListDatasets:
Response body for querying the dataset list. Response body for querying the dataset list.
@ -863,7 +865,7 @@ Example Requests
Querying the Dataset List 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 GET https://{endpoint}/v2/{project_id}/datasets?offset=0&limit=10&sort_by=create_time&order=desc&dataset_type=0&file_preview=true

View File

@ -1,3 +1,5 @@
:original_name: CreateDatasetVersion.html
.. _CreateDatasetVersion: .. _CreateDatasetVersion:
Creating a Dataset Labeling Version Creating a Dataset Labeling Version

View File

@ -1,3 +1,5 @@
:original_name: DeleteDatasetVersion.html
.. _DeleteDatasetVersion: .. _DeleteDatasetVersion:
Deleting a Dataset Labeling Version Deleting a Dataset Labeling Version
@ -40,7 +42,7 @@ Example Requests
Deleting a Dataset Labeling Version Deleting a Dataset Labeling Version
.. code-block:: .. code-block:: text
DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id} DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id}

View File

@ -1,3 +1,5 @@
:original_name: DescribeDatasetVersion.html
.. _DescribeDatasetVersion: .. _DescribeDatasetVersion:
Querying Details About a Dataset Version Querying Details About a Dataset Version
@ -345,7 +347,7 @@ Example Requests
Querying Details About a Dataset Version Querying Details About a Dataset Version
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id}

View File

@ -1,3 +1,5 @@
:original_name: ListDatasetVersions.html
.. _ListDatasetVersions: .. _ListDatasetVersions:
Querying the Dataset Version List Querying the Dataset Version List
@ -383,7 +385,7 @@ Example Requests
Querying the Version List of a Specific Dataset Querying the Version List of a Specific Dataset
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions

View File

@ -1,3 +1,5 @@
:original_name: AutoAnnotationProgress.html
.. _AutoAnnotationProgress: .. _AutoAnnotationProgress:
Obtaining Information About Intelligent Tasks Obtaining Information About Intelligent Tasks
@ -863,7 +865,7 @@ Example Requests
Obtaining Information About an Auto Labeling (Active Learning) Task 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} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}

View File

@ -1,3 +1,5 @@
:original_name: ListAutoAnnotationSamples.html
.. _ListAutoAnnotationSamples: .. _ListAutoAnnotationSamples:
Querying Auto Labeling Sample List Querying Auto Labeling Sample List
@ -507,7 +509,7 @@ Example Requests
Querying Auto Labeling Sample List Querying Auto Labeling Sample List
.. code-block:: .. code-block:: text
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples

View File

@ -1,3 +1,5 @@
:original_name: DescribeAutoAnnotationSample.html
.. _DescribeAutoAnnotationSample: .. _DescribeAutoAnnotationSample:
Querying Details About an Auto Labeling Sample Querying Details About an Auto Labeling Sample
@ -447,7 +449,7 @@ Example Requests
Querying Details About an Auto Labeling Sample 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} GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id}

View File

@ -1,3 +1,5 @@
:original_name: ListTasks.html
.. _ListTasks: .. _ListTasks:
Querying the Intelligent Task List by Page 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 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 GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks?offset=0&limit=10

View File

@ -1,3 +1,5 @@
:original_name: CreateTask.html
.. _CreateTask: .. _CreateTask:
Starting Intelligent Tasks Starting Intelligent Tasks

View File

@ -1,3 +1,5 @@
:original_name: StopAutoAnnotation.html
.. _StopAutoAnnotation: .. _StopAutoAnnotation:
Stopping an Intelligent Task Stopping an Intelligent Task
@ -40,7 +42,7 @@ Example Requests
Stopping Auto Labeling, One-Click Model Deployment, or Auto Grouping Tasks 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 POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}/stop

View File

@ -1,3 +1,5 @@
:original_name: CreateLabels.html
.. _CreateLabels: .. _CreateLabels:
Creating a Dataset Label Creating a Dataset Label

View File

@ -1,3 +1,5 @@
:original_name: DeleteLabelAndSamples.html
.. _DeleteLabelAndSamples: .. _DeleteLabelAndSamples:
Deleting a Label and the Files that Only Contain the Label 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 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 DELETE https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels/%E8%8D%89%E8%8E%93

View File

@ -1,3 +1,5 @@
:original_name: DeleteLabels.html
.. _DeleteLabels: .. _DeleteLabels:
Deleting Labels in Batches Deleting Labels in Batches

Some files were not shown because too many files have changed in this diff Show More