'1.0', 'info' => ['style' => 'ROA', 'product' => 'AIWorkSpace', 'version' => '2021-02-04'], 'directories' => [ [ 'children' => ['ListExperiment', 'SetExperimentLabels', 'DeleteExperimentLabel', 'CreateRun', 'UpdateRun', 'DeleteRun', 'DeleteRunLabel', 'LogRunMetrics', 'ListRunMetrics'], 'type' => 'directory', 'title' => 'Experiments', ], [ 'children' => ['AddImageLabels', 'ListImageLabels', 'RemoveImageLabels', 'CreateImageBuild'], 'type' => 'directory', 'title' => 'Images', ], [ 'children' => [ [ 'children' => ['ListPermissions', 'GetPermission'], 'type' => 'directory', 'title' => 'Permissions', ], [ 'children' => ['DeleteWorkspaceResource', 'UpdateWorkspaceResource', 'CreateWorkspaceResource'], 'type' => 'directory', 'title' => 'Resources', ], [ 'children' => ['AddMemberRole', 'RemoveMemberRole', 'DeleteMembers', 'GetMember', 'CreateMember'], 'type' => 'directory', 'title' => 'Members', ], [ 'children' => ['UpdateConfigs', 'ListConfigs'], 'type' => 'directory', 'title' => 'Configurations', ], 'GetDefaultWorkspace', 'UpdateDefaultWorkspace', 'ListWorkspaceUsers', ], 'type' => 'directory', 'title' => 'Workspaces', ], [ 'children' => [ [ 'children' => ['GetDatasetFileMetasStatistics', 'StopDatasetJob', 'GetDatasetJob', 'CreateDatasetFileMetas', 'UpdateDatasetJob', 'ListDatasetJobs', 'DeleteDatasetJobConfig', 'DeleteDatasetJob', 'UpdateDatasetJobConfig', 'UpdateDatasetFileMetas', 'ListDatasetJobConfigs', 'ListDatasetFileMetas', 'GetDatasetJobConfig', 'GetDatasetFileMeta', 'DeleteDatasetFileMetas', 'CreateDatasetJobConfig', 'CreateDatasetJob'], 'type' => 'directory', 'title' => 'Multimodal search', ], 'PublishDataset', 'CreateDatasetLabels', 'DeleteDatasetLabels', 'DeleteDatasetVersionLabels', 'CreateDatasetVersionLabels', ], 'type' => 'directory', 'title' => 'Datasets', ], [ 'children' => ['ValidateConnection'], 'type' => 'directory', 'title' => 'Connections', ], [ 'children' => ['CreateCodeSource', 'DeleteCodeSource', 'PublishCodeSource', 'UpdateCodeSource', 'GetCodeSource', 'ListCodeSources'], 'type' => 'directory', 'title' => 'Code configurations', ], [ 'children' => ['UpdateModel', 'GetModel', 'ListModels', 'CreateModelVersion', 'UpdateModelVersion', 'GetModelVersion', 'ListModelVersions', 'DeleteModelVersion', 'CreateModelLabels', 'DeleteModelLabels', 'CreateModelVersionLabels', 'DeleteModelVersionLabels'], 'type' => 'directory', 'title' => 'Models', ], [ 'children' => ['SetUserConfigs', 'DeleteUserConfig', 'ListUserConfigs'], 'type' => 'directory', 'title' => 'User configurations', ], [ 'children' => [ 'CreateProductOrders', 'AcceptDataworksEvent', 'CreateWorkspaceRole', 'DeleteWorkspaceRoles', 'GetInstanceJob', 'GetWorkspaceRole', 'UpdateWorkspaceRole', 'AddImage', 'ChangeResourceGroup', 'CreateConnection', 'CreateDataset', 'CreateDatasetVersion', 'CreateExperiment', 'CreateModel', 'CreateWorkspace', 'DeleteConfig', 'DeleteConnection', 'DeleteDataset', 'DeleteDatasetVersion', 'DeleteExperiment', 'DeleteModel', 'DeleteWorkspace', 'GetConfig', 'GetConnection', 'GetDataset', 'GetDatasetVersion', 'GetExperiment', 'GetImage', 'GetRun', 'GetWorkspace', 'ListConnections', 'ListDatasetVersions', 'ListDatasets', 'ListFeatures', 'ListImages', 'ListMembers', 'ListProducts', 'ListQuotas', 'ListResources', 'ListRuns', 'ListWorkspaceRoles', 'ListWorkspaces', 'PublishImage', 'RemoveImage', 'UpdateConfig', 'UpdateConnection', 'UpdateDataset', 'UpdateDatasetVersion', 'UpdateExperiment', 'UpdateWorkspace', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'CodeSourceItem' => [ 'title' => '', 'description' => 'The code source configuration struct.', 'type' => 'object', 'properties' => [ 'CodeSourceId' => ['title' => '', 'description' => 'The code source configuration ID.', 'type' => 'string', 'example' => 'code-202**********'], 'DisplayName' => ['title' => '', 'description' => 'The display name of the code source configuration.', 'type' => 'string', 'example' => 'MyCodeSourceName1'], 'Description' => ['title' => '', 'description' => 'The detailed description.', 'type' => 'string', 'example' => 'code source of dlc examples'], 'CodeRepo' => ['title' => '', 'description' => 'The code repository URL.', 'type' => 'string', 'example' => 'https://code.aliyun.com/****'], 'CodeBranch' => ['title' => '', 'description' => 'The code branch.', 'type' => 'string', 'example' => 'master'], 'CodeCommit' => ['title' => '', 'description' => 'The code commit ID.', 'type' => 'string', 'example' => '44da10**********'], 'CodeRepoUserName' => ['title' => '', 'description' => 'The username used as the access code for the code repository.', 'type' => 'string', 'example' => 'user'], 'CodeRepoAccessToken' => ['title' => '', 'description' => 'The token used as the access code for the code repository.', 'type' => 'string', 'example' => ''], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the code source configuration.', 'enumValueTitles' => ['PUBLIC' => 'Visible to everyone in this workspace.', 'PRIVATE' => 'Visible only to you and administrators in this workspace.'], 'type' => 'string', 'example' => 'PUBLIC', ], 'UserId' => ['title' => '', 'description' => 'The creator ID.', 'type' => 'string', 'example' => '1157290171663117'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '1234'], 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-01-18T12:52:15Z'], 'GmtModifyTime' => ['title' => '', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2021-01-18T12:52:15Z'], 'MountPath' => ['title' => '', 'description' => 'The local mount path of the code.', 'type' => 'string', 'example' => '/root/code/'], 'CloneType' => ['description' => 'The clone mode. Valid values:'."\n" .'- 0: Create a new subdirectory.'."\n" .'- 1: Tile to the current directory.', 'type' => 'integer', 'title' => '', 'example' => '0', 'format' => 'int32'], ], 'example' => '', ], 'Collection' => [ 'title' => '', 'description' => 'A short description of struct'."\n", 'type' => 'object', 'properties' => [ 'CollectionName' => ['title' => '', 'description' => 'The name of the collection. The name must be globally unique.'."\n", 'type' => 'string', 'example' => 'AI4D', 'visibility' => 'Public', 'backendName' => 'CollectionName'], 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The last update time.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime'], 'UserId' => ['title' => '', 'description' => 'The ID of the user that created the collection.'."\n", 'type' => 'string', 'example' => '155770209******', 'visibility' => 'Public', 'backendName' => 'UserId'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '155770209******', 'visibility' => 'Public', 'backendName' => 'OwnerId'], ], 'visibility' => 'Public', 'example' => '', ], 'Connection' => [ 'title' => '', 'description' => 'Connection information.', 'type' => 'object', 'properties' => [ 'ConnectionType' => ['title' => '', 'description' => 'The connection type. Valid values:'."\n" ."\n" .'- DashScopeConnection: A service connection to Alibaba Cloud Model Studio.'."\n" ."\n" .'- OpenLLMConnection: An open source model connection.'."\n" ."\n" .'- MilvusConnection: A Milvus connection.'."\n" ."\n" .'- OpenSearchConnection: An OpenSearch connection.'."\n" ."\n" .'- LindormConnection: A Lindorm connection.'."\n" ."\n" .'- ElasticsearchConnection: An Elasticsearch connection.'."\n" ."\n" .'- HologresConnection: A Hologres connection.'."\n" ."\n" .'- RDSConnection: An RDS connection.'."\n" ."\n" .'- CustomConnection: A custom connection.', 'type' => 'string', 'example' => 'ElasticsearchConnection', 'visibility' => 'Public', 'backendName' => 'connectionType'], 'Description' => ['title' => '', 'description' => 'The connection description.', 'type' => 'string', 'example' => 'This is a description of a database connection.', 'visibility' => 'Public', 'backendName' => 'description'], 'Accessibility' => ['title' => '', 'description' => 'The workspace visibility. Valid values:'."\n" ."\n" .'- PRIVATE (default): The connection is visible only to you and administrators in the workspace.'."\n" ."\n" .'- PUBLIC: The connection is visible to all users in the workspace.', 'type' => 'string', 'example' => 'PRIVATE', 'visibility' => 'Public', 'backendName' => 'accessibility'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '228**', 'visibility' => 'Public', 'backendName' => 'workspaceId'], 'Creator' => ['title' => '', 'description' => 'The creator of the connection.', 'type' => 'string', 'example' => '20925961****557803', 'visibility' => 'Public', 'backendName' => 'creator'], 'ResourceMeta' => [ 'title' => '', 'description' => 'The resource information for the connection. This usually applies to database connection configurations.', 'type' => 'object', 'properties' => [ 'InstanceName' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'lindorm-xxxxxxx', 'visibility' => 'Public', 'backendName' => 'instanceName'], 'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'ld-2vc1***v1zaqgzol', 'visibility' => 'Public', 'backendName' => 'instanceId'], 'Extra' => ['title' => '', 'description' => 'Extra configuration information.', 'type' => 'string', 'example' => '{"vpcId":"vpc-xxxx"}', 'visibility' => 'Public', 'backendName' => 'extra'], ], 'example' => '', 'visibility' => 'Public', 'backendName' => 'resourceMeta', ], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the connection was last modified. The time is in UTC and follows the ISO 8601 format.', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'."\n", 'visibility' => 'Public', 'backendName' => 'gmtModifiedTime'], 'ConnectionName' => ['title' => '', 'description' => 'The name of the connection.', 'type' => 'string', 'example' => 'lindorm-connection', 'visibility' => 'Public', 'backendName' => 'connectionName'], 'ConnectionId' => ['title' => '', 'description' => 'The connection ID.', 'type' => 'string', 'example' => 'conn-pai9m***mi47', 'visibility' => 'Public', 'backendName' => 'connectionId'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the connection was created. The time is in UTC and follows the ISO 8601 format.', 'type' => 'string', 'example' => '2025-03-07T07:54:56Z'."\n", 'visibility' => 'Public', 'backendName' => 'gmtCreateTime'], 'Secrets' => [ 'title' => '', 'description' => 'The key-value configurations to encrypt, such as database logon passwords and model connection keys.', 'type' => 'object', 'additionalProperties' => ['description' => 'The value of the encrypted connection configuration.', 'type' => 'string', 'title' => '', 'example' => 'Dsjk***hsl01'."\n", 'visibility' => 'Public'], 'example' => '', 'visibility' => 'Public', ], 'Configs' => [ 'title' => '', 'description' => 'The connection configurations.', 'type' => 'object', 'additionalProperties' => ['description' => 'The value of the connection configuration.', 'type' => 'string', 'title' => '', 'example' => '12345', 'visibility' => 'Public'], 'example' => '', 'visibility' => 'Public', ], 'Models' => [ 'title' => '', 'description' => 'The model list.', 'type' => 'array', 'items' => [ 'description' => 'The model.', 'type' => 'object', 'properties' => [ 'Model' => ['title' => '', 'description' => 'The model identifier.', 'type' => 'string', 'example' => 'model_001', 'visibility' => 'Public', 'backendName' => 'model'], 'DisplayName' => ['title' => '', 'description' => 'The model\'s display name.', 'type' => 'string', 'example' => 'BGE model deploy.', 'visibility' => 'Public', 'backendName' => 'displayName'], 'ModelType' => ['title' => '', 'description' => 'The model type. Valid values:'."\n" ."\n" .'- LLM (large language model)'."\n" ."\n" .'- Embedding (Embedding model)'."\n" ."\n" .'- ReRank (ReRank model)', 'type' => 'string', 'example' => 'LLM', 'visibility' => 'Public', 'backendName' => 'modelType'], 'ToolCall' => ['title' => '', 'description' => 'Indicates whether tool calling is supported. Valid values:'."\n" ."\n" .'- true: Supported'."\n" ."\n" .'- false: Not supported', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'toolCall'], ], 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true', ], 'example' => '', 'visibility' => 'Public', 'backendName' => 'models', 'itemName' => 'model', ], ], 'example' => '', 'visibility' => 'Public', ], 'Dataset' => [ 'title' => '', 'description' => 'Dataset properties.', 'type' => 'object', 'properties' => [ 'DatasetId' => ['title' => '', 'description' => 'The ID of the dataset.', 'type' => 'string', 'example' => 'd-c0h44g3****j8o4348'], 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '2485765****023475'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1631044****3440'], 'Name' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'myName'], 'DataSourceType' => [ 'title' => '', 'description' => 'The type of the data source.', 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'type' => 'string', 'example' => 'NAS', ], 'Uri' => ['title' => '', 'description' => 'URI examples:'."\n" ."\n" .'- OSS data source:'."\n" .' `oss://bucket.endpoint/object`'."\n" ."\n" .'- General-purpose NAS data source:'."\n" .' `nas://.region/subpath/to/dir/`'."\n" ."\n" .'- CPFS 1.0 data source:'."\n" .' `nas://.region/subpath/to/dir/`'."\n" ."\n" .'- CPFS 2.0 data source:'."\n" .' `nas://.region//`'."\n" ."\n" .'> The format of the `fsid` distinguishes CPFS 1.0 from CPFS 2.0. A CPFS 1.0 `fsid` has the format `cpfs-<8-character ASCII string>`, and a CPFS 2.0 `fsid` has the format `cpfs-<16-character ASCII string>`.', 'type' => 'string', 'example' => 'nas://09f****f2.cn-hangzhou/'], 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'DataType' => [ 'title' => '', 'description' => 'The data type of the dataset. Valid values:'."\n" ."\n" .'- `COMMON`: (Default) Common data.'."\n" ."\n" .'- `PIC`: Images.'."\n" ."\n" .'- `TEXT`: Text.'."\n" ."\n" .'- `VIDEO`: Videos.'."\n" ."\n" .'- `AUDIO`: Audio.', 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], 'type' => 'string', 'example' => 'COMMON', ], 'Property' => [ 'title' => '', 'description' => 'Indicates whether the dataset corresponds to a single file or a directory. Valid values:'."\n" ."\n" .'- `FILE`: The dataset is a file.'."\n" ."\n" .'- `DIRECTORY`: The dataset is a directory.', 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'type' => 'string', 'example' => 'DIRECTORY', ], 'SourceType' => [ 'title' => '', 'description' => 'The source type.', 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI公开数据集', 'ITAG' => '来自标注平台ITAG', 'USER' => '来自用户'], 'type' => 'string', 'example' => 'USER', ], 'SourceId' => ['title' => '', 'description' => 'The source ID.', 'type' => 'string', 'example' => 'jdnhf***fnrimv'], 'Description' => ['title' => '', 'description' => 'The description of the dataset.', 'type' => 'string', 'example' => 'This is a description of a dataset.'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace where the dataset is located.', 'type' => 'string', 'example' => '478**'], 'Options' => ['title' => '', 'description' => 'A JSON string of extended options. When you use the dataset in a Data Lake Compute job, you can configure the `mountPath` field to specify the default mount path for the dataset.', 'type' => 'string', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}'], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the dataset in the workspace. Valid values:'."\n" ."\n" .'- `PRIVATE`: Visible only to the dataset\'s owner and administrators.'."\n" ."\n" .'- `PUBLIC`: The dataset is visible to all users in the workspace.'."\n" ."\n" .'- `ROLE_PUBLIC`: Visible to specified workspace roles (see `AccessibleRoleIdList`). The owner and administrators also have visibility.', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'type' => 'string', 'example' => 'PRIVATE', ], 'ProviderType' => ['title' => '', 'description' => 'The type of the data source provider. Valid values:'."\n" ."\n" .'- `ECS` (Default)'."\n" ."\n" .'- `Lingjun`', 'type' => 'string', 'example' => 'Ecs'], 'SourceDatasetId' => ['title' => '', 'description' => 'The ID of the source dataset for the annotated dataset.', 'type' => 'string', 'example' => 'd-bvfasdfxxxxj8o411'], 'SourceDatasetVersion' => ['title' => '', 'description' => 'The version of the source dataset for the annotated dataset.', 'type' => 'string', 'example' => 'v2'], 'TagTemplateType' => ['title' => '', 'description' => 'The annotation template for the iTAG annotated dataset.', 'type' => 'string', 'example' => 'text-classification'], 'LatestVersion' => ['title' => '', 'description' => 'Details of the latest dataset version.', '$ref' => '#/components/schemas/DatasetVersion', 'example' => ''], 'MountAccess' => ['title' => '', 'description' => 'The mount access permissions.', 'type' => 'string', 'example' => 'RO RW'], 'ImportInfo' => ['title' => '', 'description' => 'The configuration for importing data from a storage source. Supported sources include OSS, NAS, and CPFS.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'{'."\n" .'"region": "${region}",// The region ID.'."\n" .'"bucket": "${bucket}",// The bucket name.'."\n" .'"path": "${path}" // The file path.'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS'."\n" ."\n" .''."\n" ."\n" .'Content'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'Intelligent Computing CPFS'."\n" ."\n" .''."\n" ."\n" .'Content'."\n" ."\n" .'
', 'type' => 'string', 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}'], 'Edition' => ['title' => '', 'description' => 'The edition of the dataset. Valid values:'."\n" ."\n" .'`BASIC`: The basic edition. This edition does not support file metadata management.'."\n" .'`ADVANCED`: The advanced edition. This edition is supported only for OSS datasets and allows metadata management for up to 1 million files per version.', 'type' => 'string', 'example' => 'BASIC'], 'IsShared' => [ 'description' => 'Indicates whether the dataset is shared.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'title' => '', 'example' => 'false', ], 'SharedFrom' => ['description' => 'The source of the shared dataset. This parameter is valid only when `IsShared` is `true`.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasetShareRelationship'], 'SharingConfig' => [ 'type' => 'object', 'properties' => [ 'SharedTo' => [ 'type' => 'array', 'items' => ['description' => 'A sharing relationship that defines how the dataset is shared.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DatasetShareRelationship'], 'description' => 'A list of sharing relationships.', 'title' => '', 'example' => '', ], ], 'description' => 'The sharing configuration for the dataset.', 'title' => '', 'example' => '', ], 'Labels' => [ 'title' => '', 'description' => 'A list of labels.', 'type' => 'array', 'items' => ['description' => 'A label.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => '{"Key": "env", "Value": "test"}'], 'example' => '', ], 'MountAccessReadWriteRoleIdList' => [ 'title' => '', 'description' => 'A list of IDs for workspace roles with read and write permissions on the dataset. Role IDs that start with `PAI` are built-in roles, and role IDs that start with `role-` are custom roles. An asterisk (`*`) indicates that all roles have read and write permissions.', 'type' => 'array', 'items' => ['description' => 'A workspace role ID.', 'type' => 'string', 'title' => '', 'example' => 'PAI.AlgoOperator'], 'example' => '', ], 'AccessibleRoleIdList' => [ 'type' => 'array', 'items' => ['description' => 'The ID of a workspace role.', 'type' => 'string', 'title' => '', 'example' => 'PAI.AlgoOperator'], 'description' => 'If `Accessibility` is `ROLE_PUBLIC`, this parameter lists the IDs of workspace roles that can view the dataset. Role IDs that start with `PAI` are built-in roles, and those that start with `role-` are custom roles.', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'DatasetFileMeta' => [ 'title' => '', 'description' => 'The details of the dataset file metadata.', 'type' => 'object', 'properties' => [ 'DatasetFileMetaId' => ['title' => '', 'description' => 'The ID of the dataset file metadata.', 'type' => 'string', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6', 'visibility' => 'Public', 'backendName' => 'DatasetFileMetaId'], 'Uri' => ['title' => '', 'description' => 'The unique URI of the file. It records the unique path of the file. Paths for files in OSS and NAS are supported.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'oss\\://${bucket}/${path}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'nas\\://${fileSystemId}/${path}'."\n" ."\n" .'
', 'type' => 'string', 'example' => 'oss://test-bucket/dataset/cat.png', 'visibility' => 'Public', 'backendName' => 'Uri'], 'FileName' => ['title' => '', 'description' => 'The name of the file.', 'type' => 'string', 'example' => 'cat.png', 'visibility' => 'Public', 'backendName' => 'FileName'], 'DownloadUrl' => ['title' => '', 'description' => 'The download URL of the file.', 'type' => 'string', 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D', 'visibility' => 'Public', 'backendName' => 'DownloadUrl'], 'Score' => ['title' => '', 'description' => 'The similarity score.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'visibility' => 'Public', 'backendName' => 'Score'], 'DataSize' => ['title' => '', 'description' => 'The size of the file in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '120000', 'visibility' => 'Public', 'backendName' => 'DataSize'], 'FileFingerPrint' => ['title' => '', 'description' => 'The file fingerprint. This value ensures the uniqueness of the file content and changes if the content is modified. The ETag is used for OSS files, and the MD5 value is used for NAS files.', 'type' => 'string', 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", 'visibility' => 'Public', 'backendName' => 'FileFingerPrint'], 'FileUpdateTime' => ['title' => '', 'description' => 'The time when the file was last modified. The time is in Coordinated Universal Time (UTC) and in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z', 'visibility' => 'Public', 'backendName' => 'FileUpdateTime'], 'Tags' => ['title' => '', 'description' => 'A collection of tags for the metadata, in JSON string format. The collection includes the following groups:'."\n" ."\n" .'- Algorithm tag group:'."\n" ."\n" .' - ai: A list of tag names aggregated from all algorithm-based tagging tasks for a single metadata record.'."\n" ."\n" .'- User-defined tag group:'."\n" ."\n" .' - user: A list of tag names that a user adds to a single metadata record.'."\n" ."\n" .' - user-delete-ai-tags: A list of tag names from the algorithm tag group that the user deletes from a single metadata record.', 'type' => 'string', 'example' => '{'."\n" .' "ai":'."\n" .' ['."\n" .' "Lane line",'."\n" .' "Water horse",'."\n" .' "Sunny day"'."\n" .' ],'."\n" .' "user":'."\n" .' ['."\n" .' "Everett",'."\n" .' "Intelligent driving Dataset 1",'."\n" .' "Cloudy day"'."\n" .' ],'."\n" .' "user-delete-ai-tags":'."\n" .' ['."\n" .' "Sunny day"'."\n" .' ]'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'Tags'], 'ThumbnailUrl' => ['title' => '', 'description' => 'The URL of the thumbnail.', 'type' => 'string', 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D', 'visibility' => 'Public', 'backendName' => 'ThumbnailUrl'], 'MetaAttributes' => ['title' => '', 'description' => 'Specific metadata for the file, such as the width and height of an image or the bitrate and resolution of a video. Currently, this metadata cannot be used for retrieval. The format is a JSON string.', 'type' => 'string', 'example' => '{ "ImageHeight": 400, "ImageWidth": 800 }', 'visibility' => 'Public', 'backendName' => 'MetaAttributes'], 'SemanticIndexJobId' => ['title' => '', 'description' => 'The ID of the job that last built the semantic index.', 'type' => 'string', 'example' => 'dsjob-klfwtjto****scvt3', 'visibility' => 'Public', 'backendName' => 'SemanticIndexJobId'], 'SemanticIndexUpdateTime' => ['title' => '', 'description' => 'The time when the semantic index was last updated. The time is in UTC and in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z', 'visibility' => 'Public', 'backendName' => 'SemanticIndexUpdateTime'], 'FileCreateTime' => ['title' => '', 'description' => 'The time when the file was created. The time is in UTC and in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z', 'visibility' => 'Public', 'backendName' => 'FileCreateTime'], 'FileType' => [ 'title' => '', 'description' => 'The type of the file. This corresponds to the main type of a Multipurpose Internet Mail Extensions (MIME) type.', 'type' => 'string', 'enumValueTitles' => ['image' => 'image', 'application' => 'application', 'video' => 'video', 'audio' => 'audio', 'text' => 'text'], 'example' => 'image', 'visibility' => 'Public', 'backendName' => 'FileType', ], 'ContentType' => [ 'title' => '', 'description' => 'The MIME type of the file. It includes a type and a subtype.', 'type' => 'string', 'enumValueTitles' => ['image/png' => 'image/png', 'image/jpeg' => 'image/jpeg', 'image/tiff' => 'image/tiff', 'image/bmp' => 'image/bmp', 'image/gif' => 'image/gif', 'image/x-icon' => 'image/x-icon', 'image/svg+xml' => 'image/svg+xml', 'image/webp' => 'image/webp', 'image/heic ' => 'image/heic '], 'example' => 'image/jpeg', 'visibility' => 'Public', 'backendName' => 'ContentType', ], 'Status' => [ 'type' => 'string', 'enum' => ['ACTIVE', 'DELETED'], 'description' => 'The current status of the metadata:'."\n" .'\\- ACTIVE: Active.'."\n" .'\\- DELETED: Deleted.', 'title' => '', 'example' => 'ACTIVE', 'visibility' => 'Public', 'backendName' => 'Status', ], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetFileMetaConentUpdate' => [ 'title' => '', 'description' => 'The details of the file metadata to update.', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg'."\n", 'visibility' => 'Public', 'backendName' => 'FileName'], 'Comment' => ['title' => '', 'description' => 'The file comment.', 'type' => 'string', 'example' => 'The first image file in the dataset.', 'visibility' => 'Public', 'backendName' => 'Comment'], 'FileCreateTime' => ['title' => '', 'description' => 'The time when the file was created, in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01.001Z'."\n", 'visibility' => 'Public', 'backendName' => 'FileCreateTime'], 'FileUpdateTime' => ['title' => '', 'description' => 'The time when the file was last modified, in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01.001Z'."\n", 'visibility' => 'Public', 'backendName' => 'FileUpdateTime'], 'DataSize' => ['title' => '', 'description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'visibility' => 'Public', 'backendName' => 'DataSize'], 'FileType' => [ 'title' => '', 'description' => 'The file type. This is the primary type from the Multipurpose Internet Mail Extensions (MIME) type.', 'enumValueTitles' => ['image' => '图片类型', 'application' => '应用类型', 'audio' => '音频类型', 'video' => '视频类型', 'text' => '文本类型'], 'type' => 'string', 'required' => false, 'example' => 'image', 'visibility' => 'Public', 'backendName' => 'FileType', ], 'ContentType' => [ 'title' => '', 'description' => 'The MIME type of the file. It includes a type and a subtype.', 'enumValueTitles' => ['image/png' => 'PNG', ' image/svg+xml' => 'SVG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', ' image/gif' => 'GIF', 'image/bmp' => 'BMP', 'image/x-icon' => 'ICON', 'image/heic' => 'HEIC', 'image/webp' => 'WEBP'], 'type' => 'string', 'required' => false, 'example' => 'image/jpeg'."\n", 'visibility' => 'Public', 'backendName' => 'ContentType', ], 'MetaAttributes' => ['title' => '', 'description' => 'Specific file metadata, such as the width and height of an image, and the bitrate and resolution of a video. Retrieval based on this metadata is not yet supported. The value is a JSON string.', 'type' => 'string', 'example' => '{'."\n" .' "Image":'."\n" .' {'."\n" .' "Width": 1920,'."\n" .' "Height": 1080,'."\n" .' "Channel": 3'."\n" .' }'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'MetaAttributes'], 'Tags' => ['title' => '', 'description' => 'The tag groups to update.'."\n" ."\n" .'- Update tags using an algorithm. Set a valid TagJobId.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "ai":["lane line", "water barrier", "sunny day"]'."\n" .'}'."\n" .'```'."\n" ."\n" .'- Manual tagging: Use add or remove to add or delete tags within a tag group. The modifiable tag groups are:'."\n" ."\n" .' - user: A list of tag names to add to or delete from a single metadata entry.'."\n" ."\n" .' - user-delete-ai-tags: A list of tag names to delete from the algorithm-generated tag group for a single metadata entry.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "user":{'."\n" .' "add":["lane line","sunny day"],'."\n" .' "remove":["water barrier"]'."\n" .' },'."\n" .' "user-delete-ai-tags":{'."\n" .' "add": ["ground shade"],'."\n" .' "remove": []'."\n" .' }'."\n" .'}'."\n" .'```', 'type' => 'string', 'example' => '{'."\n" .' "user":{'."\n" .' "add":["Lane line","Sunny day"],'."\n" .' "remove":["Water horse"]'."\n" .' },'."\n" .' "user-delete-ai-tags":{'."\n" .' "add": ["Ground shadow"],'."\n" .' "remove": []'."\n" .' }'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'Tags'], 'DatasetFileMetaId' => ['title' => '', 'description' => 'The ID of the dataset file metadata.', 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", 'visibility' => 'Public', 'backendName' => 'DatasetFileMetaId'], 'SemanticIndexJobId' => ['title' => '', 'description' => 'The ID of the job that builds the semantic index.', 'type' => 'string', 'example' => 'dsjob-klfwt*****l0escvt3', 'visibility' => 'Public', 'backendName' => 'SemanticIndexJobId'], 'SemanticIndexUpdateTime' => ['title' => '', 'description' => 'The time when the semantic index was built.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z', 'visibility' => 'Public', 'backendName' => 'SemanticIndexUpdateTime'], 'FileFingerPrint' => ['title' => '', 'description' => 'The file fingerprint information.', 'type' => 'string', 'example' => '124FB71******7BE45608CDEA4DE54B3', 'visibility' => 'Public', 'backendName' => 'FileFingerPrint'], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetFileMetaContentCreate' => [ 'title' => '', 'description' => 'The details of the file metadata.', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The name of the file.', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg', 'visibility' => 'Public', 'backendName' => 'FileName'], 'Uri' => ['title' => '', 'description' => 'The unique URI of the file. This URI records the unique path of the file. The path can be an OSS or NAS path.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'oss\\://${bucket}/${path}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'nas\\://${fileSystemId}/${path}'."\n" ."\n" .'
', 'type' => 'string', 'required' => true, 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" .'nas://0e25d***dff/dataset/1653421.jpg', 'visibility' => 'Public', 'backendName' => 'Uri'], 'Comment' => ['title' => '', 'description' => 'The comment on the file.', 'type' => 'string', 'example' => 'The first image file in the dataset.', 'visibility' => 'Public', 'backendName' => 'Comment'], 'FileCreateTime' => ['title' => '', 'description' => 'The time when the file was created. The time is in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z', 'visibility' => 'Public', 'backendName' => 'FileCreateTime'], 'FileUpdateTime' => ['title' => '', 'description' => 'The time when the file was last modified. The time is in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'required' => true, 'example' => '2025-01-12T14:36:01Z', 'visibility' => 'Public', 'backendName' => 'FileUpdateTime'], 'FileFingerPrint' => ['title' => '', 'description' => 'The fingerprint of the file. This value ensures the uniqueness of the file content and changes if the content is modified. For OSS files, this is the ETag. For NAS files, this is the MD5 value.', 'type' => 'string', 'required' => true, 'example' => 'D41D8CD98F*****E9800998ECF8', 'visibility' => 'Public', 'backendName' => 'FileFingerPrint'], 'DataSize' => ['title' => '', 'description' => 'The size of the file in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'visibility' => 'Public', 'backendName' => 'DataSize'], 'FileType' => [ 'title' => '', 'description' => 'The type of the file. This is the same as the Multipurpose Internet Mail Extensions (MIME) type.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['image' => '图片类型', 'application' => '应用类型', 'audio' => '音频类型', 'video' => '视频类型', 'text' => '文本类型'], 'example' => 'image', 'visibility' => 'Public', 'backendName' => 'FileType', ], 'ContentType' => [ 'title' => '', 'description' => 'The MIME type of the file. It includes a type and a subtype.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['image/png' => 'PNG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', 'image/bmp' => 'BMP', 'image/gif' => 'GIF', 'image/x-icon' => 'ICON', 'image/svg+xml' => 'SVG', 'image/webp' => 'WEBP', 'image/heic ' => 'HEIC'], 'example' => 'image/jpeg', 'visibility' => 'Public', 'backendName' => 'ContentType', ], 'MetaAttributes' => ['title' => '', 'description' => 'The specific metadata of the file. This metadata cannot be used for retrieval. The value must be a JSON string.', 'type' => 'string', 'example' => '{'."\n" .' "ImageHeight": 1080,'."\n" .' "ImageWidth": 1920'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'MetaAttributes'], 'Tags' => ['title' => '', 'description' => 'The tags that are manually added by users. The \\`add\\` operation is used to add tags to a tag group. The value must be a JSON string.'."\n" .'The following tag group is available:'."\n" ."\n" .'- user: A list of tag names added to a single piece of metadata.'."\n" ."\n" .'```'."\n" .'{'."\n" .' "user":{'."\n" .' "add":["Lane line","Sunny day"]'."\n" .' }'."\n" .'}'."\n" .'```', 'type' => 'string', 'deprecated' => false, 'example' => '{'."\n" .' "user":{'."\n" .' "add":["Lane line","Sunny day"]'."\n" .' }'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'Tags'], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetFileMetaContentGet' => [ 'title' => '', 'description' => 'The details of the retrieved dataset file metadata.', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => false, 'example' => '00001.jpeg', 'visibility' => 'Public', 'backendName' => 'FileName'], 'Uri' => ['title' => '', 'description' => 'The unique URI of the file. This URI records the unique path of the file. Paths for files in OSS and NAS are supported.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'oss\\://${bucket}/${path}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'nas\\://${fileSystemId}/${path}'."\n" ."\n" .'
', 'type' => 'string', 'required' => false, 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" .'nas://0e25d***dff/dataset/1653421.jpg'."\n", 'visibility' => 'Public', 'backendName' => 'Uri'], 'Comment' => ['title' => '', 'description' => 'The comment on the file.', 'type' => 'string', 'example' => 'The first image file in the dataset.', 'visibility' => 'Public', 'backendName' => 'Comment'], 'FileCreateTime' => ['title' => '', 'description' => 'The time when the file was created. The time is in the ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2025-01-12T14:36:01Z', 'visibility' => 'Public', 'backendName' => 'FileCreateTime'], 'FileUpdateTime' => ['title' => '', 'description' => 'The time when the file was last modified. The time is in the ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'required' => false, 'example' => '2025-01-12T14:36:01Z', 'visibility' => 'Public', 'backendName' => 'FileUpdateTime'], 'FileFingerPrint' => ['title' => '', 'description' => 'The fingerprint of the file. This value ensures the uniqueness of the file content. The value changes if the file content is modified. For OSS files, the ETag is used. For NAS files, the MD5 hash is used.', 'type' => 'string', 'required' => false, 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", 'visibility' => 'Public', 'backendName' => 'FileFingerPrint'], 'DataSize' => ['title' => '', 'description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'visibility' => 'Public', 'backendName' => 'DataSize'], 'FileType' => [ 'title' => '', 'description' => 'The file type. This is the same as the Multipurpose Internet Mail Extensions (MIME) type.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['image' => '图片类型', 'application' => '应用类型', 'audio' => '音频类型', 'video' => '视频类型', 'text' => '文本类型'], 'example' => 'image', 'visibility' => 'Public', 'backendName' => 'FileType', ], 'ContentType' => [ 'title' => '', 'description' => 'The MIME type of the file. It includes a type and a subtype.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['image/png' => 'PNG', 'image/jpeg' => 'JPEG', 'image/tiff' => 'TIFF', 'image/bmp' => 'BMP', 'image/gif' => 'GIF', 'image/x-icon' => 'ICON', 'image/svg+xml' => 'SVG', 'image/heic' => 'HEIC', 'image/webp' => 'WEBP'], 'example' => 'image/png', 'visibility' => 'Public', 'backendName' => 'ContentType', ], 'MetaAttributes' => ['title' => '', 'description' => 'The specific metadata of the file. This metadata cannot be used for retrieval. The format is a JSON string.', 'type' => 'string', 'example' => '{'."\n" .' "ImageHeight": 1080,'."\n" .' "ImageWidth": 1920'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'MetaAttributes'], 'Tags' => ['title' => '', 'description' => 'A collection of tags for the metadata. It includes the following groups:'."\n" ."\n" .'- Algorithm tag group:'."\n" ."\n" .' - ai: A list of tag names aggregated from all algorithmic tagging tasks for a single metadata record.'."\n" ."\n" .'- User-defined tag group:'."\n" ."\n" .' - user: A list of tag names that a user adds to a single metadata record.'."\n" ."\n" .' - user-delete-ai-tags: A list of tag names from the algorithm tag group that the user wants to delete from a single metadata record.', 'type' => 'string', 'example' => '{'."\n" .' "ai":'."\n" .' ['."\n" .' "Lane line",'."\n" .' "Water horse",'."\n" .' "Sunny day"'."\n" .' ],'."\n" .' "user":'."\n" .' ['."\n" .' "Everett",'."\n" .' "Intelligent driving Dataset 1",'."\n" .' "Cloudy day"'."\n" .' ],'."\n" .' "user-delete-ai-tags":'."\n" .' ['."\n" .' "Sunny day"'."\n" .' ]'."\n" .'}', 'visibility' => 'Public', 'backendName' => 'Tags'], 'DatasetFileMetaId' => ['title' => '', 'description' => 'The ID of the dataset file metadata.', 'type' => 'string', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", 'visibility' => 'Public', 'backendName' => 'DatasetFileMetaId'], 'FileDir' => ['title' => '', 'description' => 'The path of the folder where the OSS, NAS, or CPFS file is located.', 'type' => 'string', 'example' => 'icp_certificate_card/icp/1577179298694813/1716429710367', 'visibility' => 'Public', 'backendName' => 'FileDir'], 'TagUpdateTime' => ['title' => '', 'description' => 'The time when the tag was last modified. The time is in the ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z', 'visibility' => 'Public', 'backendName' => 'TagUpdateTime'], 'SemanticIndexJobId' => ['title' => '', 'description' => 'The ID of the job that builds the semantic index.', 'type' => 'string', 'example' => 'dsjob-klfwtjtov*****scvt3', 'visibility' => 'Public', 'backendName' => 'SemanticIndexJobId'], 'SemanticIndexUpdateTime' => ['title' => '', 'description' => 'The time when the semantic index was built.', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-12T14:36:01.000Z', 'visibility' => 'Public', 'backendName' => 'SemanticIndexUpdateTime'], 'Status' => [ 'type' => 'string', 'enum' => ['ACTIVE', 'DELETED'], 'description' => '', 'title' => '', 'example' => '', 'backendName' => 'Status', ], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetFileMetaResponse' => [ 'title' => '', 'description' => 'The returned result of the metadata operation for a single file.'."\n", 'type' => 'object', 'properties' => [ 'DatasetFileMetaId' => ['title' => '', 'description' => 'The metadata ID of the dataset file.'."\n", 'type' => 'string', 'required' => true, 'example' => '07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6', 'visibility' => 'Public', 'backendName' => 'DatasetFileMetaId'], 'Result' => ['title' => '', 'description' => 'The description of the reason why the metadata operation failed.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Not Found', 'visibility' => 'Public', 'backendName' => 'Result'], 'Uri' => ['title' => '', 'description' => 'The file URI.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://l*****-test/dataset/1653421.jpg', 'visibility' => 'Public', 'backendName' => 'Uri'], ], 'visibility' => 'Public', 'example' => '', ], 'DatasetFileMetasStat' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '元数据属性内容。', 'type' => 'string', 'example' => 'cat'], 'Count' => ['title' => '聚合后的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], 'DatasetJob' => [ 'title' => '', 'description' => 'The dataset job.'."\n", 'type' => 'object', 'properties' => [ 'DatasetJobId' => ['title' => '', 'description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'dsjob-9jx1*****uj9e', 'visibility' => 'Public', 'backendName' => 'DatasetJobId'], 'JobAction' => ['title' => '', 'description' => 'The job action.'."\n", 'type' => 'string', 'example' => 'SemanticIndex', 'visibility' => 'Public', 'backendName' => 'JobAction'], 'CreateTime' => ['title' => '', 'description' => 'The job creation time (UTC).'."\n", 'type' => 'string', 'example' => '2023-06-20T04:05:59Z', 'visibility' => 'Public', 'backendName' => 'CreateTime'], 'FinishTime' => ['title' => '', 'description' => 'The job finish time (UTC).'."\n", 'type' => 'string', 'example' => '2023-06-20T06:03:48Z', 'visibility' => 'Public', 'backendName' => 'FinishTime'], 'Status' => ['title' => '', 'description' => 'The job status.'."\n", 'type' => 'string', 'example' => 'Running', 'visibility' => 'Public', 'backendName' => 'Status'], 'Description' => ['title' => '', 'description' => 'The job description.'."\n", 'type' => 'string', 'example' => 'This is a job description of a dataset.', 'visibility' => 'Public', 'backendName' => 'Description'], 'JobMode' => [ 'title' => '', 'description' => 'The job mode.'."\n" ."\n" .'Valid value:'."\n" ."\n" .'* Full'."\n", 'type' => 'string', 'enumValueTitles' => ['Full' => ''], 'example' => 'Full', 'visibility' => 'Public', 'backendName' => 'JobMode', ], 'JobSpec' => ['title' => '', 'description' => 'The job details.'."\n", 'type' => 'string', 'example' => '{\\"modelId\\":\\"xxx\\"}', 'visibility' => 'Public', 'backendName' => 'JobSpec'], 'Logs' => [ 'title' => '', 'description' => 'The job logs.'."\n", 'type' => 'array', 'items' => ['description' => 'The content of the log entry.'."\n", 'type' => 'string', 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], 'visibility' => 'Public', 'backendName' => 'Logs', 'itemName' => 'Log', 'example' => '', ], 'TotalFileCount' => ['title' => '', 'description' => 'The number of job files.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'visibility' => 'Public', 'backendName' => 'TotalFileCount'], 'CompletedFileCount' => ['title' => '', 'description' => 'The number of completed files.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '990', 'visibility' => 'Public', 'backendName' => 'CompletedFileCount'], 'FailedFileCount' => ['title' => '', 'description' => 'The number of failed files.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'FailedFileCount'], 'DatasetVersion' => ['title' => '', 'description' => 'The dataset version.'."\n", 'type' => 'string', 'example' => 'v1', 'visibility' => 'Public', 'backendName' => 'DatasetVersion'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => '145883', 'visibility' => 'Public', 'backendName' => 'WorkspaceId'], ], 'visibility' => 'Public', 'example' => '', ], 'DatasetJobConfig' => [ 'title' => '', 'description' => 'The configuration for a dataset job.', 'type' => 'object', 'properties' => [ 'DatasetJobConfigId' => ['title' => '', 'description' => 'The unique ID for the dataset job configuration.', 'type' => 'string', 'example' => 'dscfg-xxxxxxxxxxxx', 'visibility' => 'Public', 'backendName' => 'DatasetJobConfigId'], 'CreateTime' => ['title' => '', 'description' => 'The creation time of the dataset job configuration.', 'type' => 'string', 'example' => '2025-01-14T01:37:37Z', 'visibility' => 'Public', 'backendName' => 'CreateTime'], 'ModifyTime' => ['title' => '', 'description' => 'The last modification time of the dataset job configuration.', 'type' => 'string', 'example' => '2024-10-11T02:18:54Z', 'visibility' => 'Public', 'backendName' => 'ModifyTime'], 'ConfigType' => ['title' => '', 'description' => 'The type of the dataset job configuration.', 'type' => 'string', 'example' => 'MultimodalIntelligentTag', 'visibility' => 'Public', 'backendName' => 'ConfigType'], 'Config' => ['title' => '', 'description' => 'The content of the dataset job configuration, in JSON format.', 'type' => 'string', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', 'visibility' => 'Public', 'backendName' => 'Config'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'example' => '234*34', 'visibility' => 'Public', 'backendName' => 'WorkspaceId'], 'DatasetVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'datasetVersion'], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetLabel' => [ 'title' => 'A short description of struct', 'description' => 'A key-value pair attached to a dataset for identification and management.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => 'Key', 'description' => 'The label key, which must be 1 to 128 characters long.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Key'], 'Value' => ['title' => 'Value', 'description' => 'The label value, which can be 0 to 128 characters long.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Value'], ], 'example' => '', 'visibility' => 'Public', ], 'DatasetShareRelationship' => [ 'description' => 'The configuration for sharing a dataset.', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '', 'description' => 'The status of the sharing relationship.'."\n" ."\n" .'- ACTIVE: The sharing relationship is active. Complete dataset information is displayed only in this state.'."\n" ."\n" .'- EXPIRED: The sharing relationship has expired.'."\n" ."\n" .'- REVOKED: The sharing relationship was revoked by the sharer.'."\n" ."\n" .'- INVALID: The sharing relationship is invalid. This can happen if the source dataset is deleted.', 'enumValueTitles' => ['REVOKED' => 'REVOKED', 'ACTIVE' => 'ACTIVE', 'EXPIRED' => 'EXPIRED', 'INVALID' => 'INVALID'], 'type' => 'string', 'example' => 'ACTIVE', ], 'SourceTenantId' => ['title' => '', 'description' => 'The ID of the tenant that owns the source dataset. The user who shares the dataset must be a workspace administrator or the root account.', 'type' => 'string', 'example' => '148***************115'], 'SourceWorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace that contains the source dataset.', 'type' => 'string', 'example' => '33**19'], 'TenantId' => ['title' => '', 'description' => 'The ID of the target tenant. This must be a root account ID.'."\n" ."\n" .'> This parameter is required when you set a sharing relationship.', 'type' => 'string', 'required' => false, 'example' => '153***************249'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the target workspace. This ID must be different from the source workspace ID.'."\n" ."\n" .'> This parameter is required when you set a sharing relationship.', 'type' => 'string', 'required' => false, 'example' => '42**2'], 'IsSecureMode' => [ 'title' => '', 'description' => 'Specifies whether to enable security protection for the shared dataset.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'SharedAt' => ['title' => '', 'description' => 'The time when the dataset was shared. The time is in ISO 8601 format.', 'type' => 'string', 'example' => '2025-08-27T12:23:58Z'], 'ExpiresAt' => ['title' => '', 'description' => 'The expiration time. The time is in ISO 8601 format.'."\n" ."\n" .'> If you do not specify this parameter, the sharing relationship never expires.', 'type' => 'string', 'example' => '2026-08-27T12:23:58Z'], 'AllowedMountAccessLevels' => [ 'title' => '', 'description' => 'The allowed permissions for the shared dataset. When a user accesses the shared dataset, their permissions are limited to this list. The default value is \\`\\["RO"]\\`.'."\n" ."\n" .'- RO: Read-only permission. The recipient can only read the dataset.'."\n" ."\n" .'- RW: Read and write permission. The recipient can read and modify the dataset.', 'type' => 'array', 'items' => [ 'description' => 'The dataset permission.', 'enumValueTitles' => ['RW' => 'RW', 'RO' => 'RO'], 'type' => 'string', 'title' => '', 'example' => 'RO', ], 'required' => false, 'example' => '', ], 'Extra' => ['description' => 'Additional configurations for the sharing relationship. This parameter is a JSON string.'."\n" ."\n" .'- AllowExportModel: Specifies whether to allow the export of trained models.'."\n" ."\n" .'- AllowAccessDLCWebTerminal: Specifies whether to allow users to log on to the container in a DLC task.'."\n" ."\n" .'- AllowAccessDLCFullLog: Specifies whether to allow access to the full task logs.', 'type' => 'string', 'title' => '', 'example' => '{"AllowExportModel":false,"AllowAccessDLCWebTerminal":false,"AllowAccessDLCFullLog":false}'], ], 'title' => '', 'example' => '', ], 'DatasetVersion' => [ 'title' => '', 'description' => 'Contains the configuration and metadata of a dataset version.', 'type' => 'object', 'properties' => [ 'VersionName' => ['title' => '', 'description' => 'The name of the dataset version.', 'type' => 'string', 'example' => 'v1'], 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time of the dataset version, in UTC.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time the dataset version was last modified, in UTC.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'Property' => ['title' => '', 'description' => 'The data format of the dataset.', 'type' => 'string', 'example' => 'FILE'], 'DataSourceType' => ['title' => '', 'description' => 'The data source type. For example, the value `OSS` indicates Object Storage Service.', 'type' => 'string', 'example' => 'OSS'], 'Uri' => ['title' => '', 'description' => 'The URI of the data source.', 'type' => 'string', 'example' => 'OSS://xxx'], 'Labels' => [ 'title' => '', 'description' => 'A list of labels applied to the dataset version.', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/Label', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', ], 'Options' => ['title' => '', 'description' => 'Additional configurations for the dataset version, in JSON format.', 'type' => 'string', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}'], 'SourceType' => ['title' => '', 'description' => 'The method used to create the dataset version.', 'type' => 'string', 'example' => 'USER'], 'Description' => ['title' => '', 'description' => 'A custom description for the dataset version.', 'type' => 'string', 'example' => 'base model v1'], 'SourceId' => ['title' => '', 'description' => 'The ID of the source from which the version was created.', 'type' => 'string', 'example' => 'd-65mrsr5fub4u74lej3'], 'DataCount' => ['title' => '', 'description' => 'The total number of data items in the version.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], 'DataSize' => ['title' => '', 'description' => 'The total size of the data in the version, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], 'MountAccess' => ['title' => '', 'description' => 'The access permission for the mounted dataset. For example, `RO` means read-only.', 'type' => 'string', 'example' => 'RO'], 'ImportInfo' => ['title' => '', 'description' => 'Information about the import source, in JSON format.', 'type' => 'string', 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}'], ], 'example' => '', ], 'Experiment' => [ 'title' => '', 'description' => 'The experiment.'."\n", 'type' => 'object', 'properties' => [ 'ExperimentId' => ['title' => '', 'description' => 'ExperimentId'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'ExperimentId', 'example' => ''], 'Name' => ['title' => '', 'description' => 'Name'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'Name', 'example' => ''], 'WorkspaceId' => ['title' => '', 'description' => 'WorkspaceId'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'WorkspaceId', 'example' => ''], 'ArtifactUri' => ['title' => '', 'description' => 'ArtifactUri'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'ArtifactUri', 'example' => ''], 'TensorboardLogUri' => ['title' => '', 'description' => 'TensorboardLogUri'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'TensorboardLogUri', 'example' => ''], 'Labels' => [ 'title' => '', 'description' => 'Labels'."\n", 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/ExperimentLabel', 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], 'visibility' => 'Public', 'backendName' => 'Labels', 'example' => '', ], 'UserId' => ['title' => '', 'description' => 'UserId'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'UserId', 'example' => ''], 'OwnerId' => ['title' => '', 'description' => 'OwnerId'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'OwnerId', 'example' => ''], 'GmtCreateTime' => ['title' => '', 'description' => 'GmtCreatedTime'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'GmtCreatedTime', 'example' => ''], 'GmtModifiedTime' => ['title' => '', 'description' => 'GmtModifiedTime'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'RequestId'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'RequestId', 'example' => ''], 'Accessibility' => ['title' => '', 'description' => 'Accessibility'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'Accessibility', 'example' => ''], 'LatestRun' => ['title' => '', 'description' => 'LatestRun'."\n", '$ref' => '#/components/schemas/Run', 'visibility' => 'Public', 'backendName' => 'LatestRun', 'example' => ''], ], 'visibility' => 'Public', 'example' => '', ], 'ExperimentLabel' => [ 'title' => '', 'description' => 'The experiment label.'."\n", 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'Key of Experiment Label'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'backendName' => 'Key'], 'Value' => ['title' => '', 'description' => 'Value of Experiment Label'."\n", 'type' => 'string', 'example' => 'value', 'visibility' => 'Public', 'backendName' => 'Value'], 'GmtCreateTime' => ['title' => '', 'description' => 'Create time'."\n", 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'visibility' => 'Public', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => '', 'description' => 'Modified time'."\n", 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime'], 'ExperimentId' => ['title' => '', 'description' => 'ExperimentId'."\n", 'type' => 'string', 'example' => 'exp-890waerw09a0f', 'visibility' => 'Public', 'backendName' => 'ExperimentId'], ], 'visibility' => 'Public', 'example' => '', ], 'Label' => [ 'title' => '', 'description' => 'The label structure.'."\n", 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The label key. The value can be up to 128 bytes in length and cannot contain equal signs (=) and commas (,).'."\n", 'type' => 'string', 'example' => 'env', 'visibility' => 'Public', 'backendName' => 'Key'], 'Value' => ['title' => '', 'description' => 'The label value. The value can be up to 128 bytes in length and cannot contain equal signs (=) and commas (,).'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'Value'], ], 'visibility' => 'Public', 'example' => '', ], 'LabelInfo' => [ 'title' => '', 'description' => 'TrialLabelInfo'."\n", 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'Key of Label'."\n", 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'backendName' => 'Key'], 'Value' => ['title' => '', 'description' => 'Value of Label'."\n", 'type' => 'string', 'example' => 'value', 'visibility' => 'Public', 'backendName' => 'Value'], ], 'visibility' => 'Public', 'example' => '', ], 'LineageEntity' => [ 'title' => '', 'description' => 'The data lineage entity.', 'type' => 'object', 'properties' => [ 'Attributes' => ['title' => '', 'description' => 'The entity\'s attributes.', 'type' => 'object', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Attributes'], 'EntityType' => ['title' => '', 'description' => 'The entity type.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'EntityType'], 'Name' => ['title' => '', 'description' => 'The entity\'s name.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Name'], 'QualifiedName' => ['title' => '', 'description' => 'The entity\'s qualified name.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'QualifiedName'], ], 'example' => '', 'visibility' => 'Public', ], 'LineageRelation' => [ 'title' => '', 'description' => 'A directed link from a source to a target entity in a data lineage graph.', 'type' => 'object', 'properties' => [ 'DestEntityQualifiedName' => ['title' => '', 'description' => 'The fully qualified name of the target entity in the relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'DestEntityQualifiedName'], 'RelationshipGuid' => ['title' => '', 'description' => 'The system-assigned unique identifier (GUID) for the relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'RelationshipGuid'], 'SrcEntityQualifiedName' => ['title' => '', 'description' => 'The fully qualified name of the source entity in the relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'SrcEntityQualifiedName'], ], 'example' => '', 'visibility' => 'Public', ], 'Model' => [ 'title' => '', 'description' => 'The model.'."\n", 'type' => 'object', 'properties' => [ 'ModelId' => ['title' => '', 'description' => 'The model ID.'."\n", 'type' => 'string', 'example' => 'model-1123*****', 'visibility' => 'Public', 'backendName' => 'ModelId'], 'ModelName' => ['title' => '', 'description' => 'The model name.'."\n", 'type' => 'string', 'example' => '情感分析', 'visibility' => 'Public', 'backendName' => 'ModelName'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the model was created, in UTC. The time follows the ISO 8601 standard.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the model was last modified, in UTC. The time follows the ISO 8601 standard.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => '234**', 'visibility' => 'Public', 'backendName' => 'WorkspaceId'], 'UserId' => ['title' => '', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '1557702098******', 'visibility' => 'Public', 'backendName' => 'UserId'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '1557702098******', 'visibility' => 'Public', 'backendName' => 'OwnerId'], 'ModelDescription' => ['title' => '', 'description' => 'The model description.'."\n", 'type' => 'string', 'example' => '情感分析。', 'visibility' => 'Public', 'backendName' => 'ModelDescription'], 'Accessibility' => [ 'title' => '', 'description' => 'The workspace accessibility. Valid values:'."\n" ."\n" .'* PRIVATE (default): The model is accessible only to you and the administrator of the workspace.'."\n" .'* PUBLIC: The model is accessible to all members of the workspace.'."\n", 'type' => 'string', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'example' => 'PUBLIC', 'visibility' => 'Public', 'backendName' => 'Accessibility', ], 'LatestVersion' => ['title' => '', 'description' => 'The latest version of the model.'."\n", '$ref' => '#/components/schemas/ModelVersion', 'visibility' => 'Public', 'backendName' => 'LatestVersion', 'example' => ''], 'OrderNumber' => ['title' => '', 'description' => 'The sequence number of the model.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'visibility' => 'Public', 'backendName' => 'OrderNumber'], 'Origin' => ['title' => '', 'description' => 'The community or organization to which the source model belongs, such as ModelScope or Hugging Face.'."\n", 'type' => 'string', 'example' => 'ModelScope', 'visibility' => 'Public', 'backendName' => 'Origin'], 'Domain' => ['title' => '', 'description' => 'The domain where the model is applied, such as nlp (Natural Language Processing) and cv (Computer Vision).'."\n", 'type' => 'string', 'example' => 'nlp', 'visibility' => 'Public', 'backendName' => 'Domain'], 'Task' => ['title' => '', 'description' => 'The task. The specific issue that the model resolves, such as text-classification.'."\n", 'type' => 'string', 'example' => 'text-classifiaction', 'visibility' => 'Public', 'backendName' => 'Task'], 'ModelDoc' => ['title' => '', 'description' => 'The model document.'."\n", 'type' => 'string', 'example' => 'https://***.md', 'visibility' => 'Public', 'backendName' => 'ModelDoc'], 'Provider' => ['title' => '', 'description' => 'The model provider.'."\n", 'type' => 'string', 'example' => 'pai', 'visibility' => 'Public', 'backendName' => 'Provider'], 'ModelType' => ['title' => '', 'description' => 'The model type, such as checkpoint and LoRA.'."\n", 'type' => 'string', 'example' => 'Checkpoint', 'visibility' => 'Public', 'backendName' => 'ModelType'], 'Labels' => [ 'title' => '', 'description' => 'The labels.'."\n", 'type' => 'array', 'items' => ['description' => 'The label.'."\n", '$ref' => '#/components/schemas/Label', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], 'visibility' => 'Public', 'backendName' => 'Labels', 'itemName' => 'Labels', 'example' => '', ], 'Tags' => [ 'title' => '', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/Label', 'description' => '', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], 'description' => '', 'visibility' => 'Public', 'backendName' => 'Tags', 'itemName' => 'Tags', 'example' => '', ], 'ExtraInfo' => ['title' => '', 'description' => 'The additional information.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "RatingCount": 2866,'."\n" .' "Rating": 4.94,'."\n" .' "FavoriteCount": 34992,'."\n" .' "CommentCount": 754,'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" .' "TippedAmountCount": 32,'."\n" .' "DownloadCount": 606056'."\n" .'}', 'visibility' => 'Public'], 'ParameterSize' => ['type' => 'integer', 'format' => 'int64', 'example' => '1024', 'description' => '', 'visibility' => 'Public', 'backendName' => 'ParameterSize', 'title' => ''], 'GmtLatestVersionModifiedTime' => ['type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'description' => '', 'visibility' => 'Public', 'backendName' => 'GmtLatestVersionModifiedTime', 'title' => ''], ], 'visibility' => 'Public', 'example' => '', ], 'ModelVersion' => [ 'title' => '', 'description' => 'The model version.'."\n", 'type' => 'object', 'properties' => [ 'VersionName' => ['title' => '', 'description' => 'The model version, which is unique for the model. If you leave this parameter empty, `0.1.0` is the first version by default. Then, the minor version number incremented by 1 is used as the second version `0.2.0`.'."\n" ."\n" .'The version consists of a major version number, a minor version number, and a patch version number. The version numbers are separated with periods (`.`). The major and minor version numbers are digits, and the patch version number starts with a digit followed by an underscore (`_`) and a letter. such as 1.1.0 or 2.3.4\\_beta.'."\n" ."\n" .'Regular expression: `"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(_\\\\w+)?$"`'."\n", 'type' => 'string', 'example' => '0.1.0', 'visibility' => 'Public', 'backendName' => 'VersionName'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the model was created, in UTC. The time follows the ISO 8601 standard.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the model was last modified, in UTC. The time follows the ISO 8601 standard.'."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime'], 'UserId' => ['title' => '', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '155770209******', 'visibility' => 'Public', 'backendName' => 'UserId'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => '155770209******', 'visibility' => 'Public', 'backendName' => 'OwnerId'], 'Uri' => ['title' => '', 'description' => 'The URI of the model version, which is the location where the model is stored. The value can be the HTTP(S) address of the model, such as `https://myweb.com/mymodel.tar.gz`. If the model is stored in an Object Storage Service (OSS) bucket, the value is in the `oss://./object` format. The endpoint can be queried in the OSS console, such as `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.'."\n", 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', 'visibility' => 'Public', 'backendName' => 'Uri'], 'VersionDescription' => ['title' => '', 'description' => 'The model version description.'."\n", 'type' => 'string', 'example' => '情感分析。', 'visibility' => 'Public', 'backendName' => 'VersionDescription'], 'FormatType' => [ 'title' => '', 'description' => 'The model format.'."\n" ."\n" .'* OfflineModel'."\n" .'* SavedModel'."\n" .'* Keras H5'."\n" .'* Frozen Pb'."\n" .'* Caffe Prototxt'."\n" .'* TorchScript'."\n" .'* XGBoost'."\n" .'* PMML'."\n" .'* AlinkModel'."\n" .'* ONNX'."\n", 'type' => 'string', 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], 'example' => 'SavedModel', 'visibility' => 'Public', 'backendName' => 'FormatType', ], 'FrameworkType' => [ 'title' => '', 'description' => 'The model framework.'."\n" ."\n" .'* Pytorch'."\n" .'* XGBoost'."\n" .'* Keras'."\n" .'* Caffe'."\n" .'* Alink'."\n" .'* Xflow'."\n" .'* TensorFlow'."\n", 'type' => 'string', 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], 'example' => 'TensorFlow', 'visibility' => 'Public', 'backendName' => 'FrameworkType', ], 'Options' => ['title' => '', 'description' => 'The extended field. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{}', 'visibility' => 'Public', 'backendName' => 'Options'], 'SourceType' => [ 'title' => '', 'description' => 'The source type of the model. Default value: Custom.'."\n" ."\n" .'* Custom'."\n" .'* PAIFlow'."\n" .'* TrainingService'."\n", 'type' => 'string', 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', 'visibility' => 'Public', 'backendName' => 'SourceType', ], 'SourceId' => ['title' => '', 'description' => 'The source ID.'."\n" ."\n" .'* If the source type is Custom, this field is not limited.'."\n" .'* If the source type is PAIFlow or TrainingService, the format is:'."\n" ."\n" .''."\n" ."\n" .' region=,workspaceId=,kind=,id='."\n" ."\n" .'region is the ID of the Alibaba Cloud region. workspacceId is the ID of the workspace. kind is the type. Valid values: PipelineRun (PAIFlow pipeline) and ServiceJob (training service). id is the unique identifier.'."\n", 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', 'visibility' => 'Public', 'backendName' => 'SourceId'], 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" ."\n" .'* Pending'."\n" .'* Approved'."\n" .'* Rejected'."\n", 'type' => 'string', 'example' => 'Approved', 'visibility' => 'Public', 'backendName' => 'ApprovalStatus'], 'Labels' => [ 'title' => '', 'description' => 'The labels.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The label.'."\n", '$ref' => '#/components/schemas/Label', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'type' => 'string', 'description' => '', 'visibility' => 'Public', 'example' => 'k1', 'backendName' => 'Key'], 'Value' => ['title' => '', 'type' => 'string', 'description' => '', 'visibility' => 'Public', 'example' => 'v1', 'backendName' => 'Value'], ], 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => '', ], 'visibility' => 'Public', 'backendName' => 'Labels', 'itemName' => 'Labels', 'example' => '', ], 'Metrics' => ['title' => '', 'description' => 'The model metrics.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "Results": [{'."\n" .' "Dataset": {'."\n" .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.175'."\n" .' }'."\n" .' }, {'."\n" .' "Dataset": {'."\n" .' "Uri": "oss://xxxx/"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.172'."\n" .' }'."\n" .' }]'."\n" .'}', 'visibility' => 'Public'], 'TrainingSpec' => ['title' => '', 'description' => 'The training configuration, used for fine-tuning and incremental training.'."\n", 'type' => 'object', 'example' => '{}', 'visibility' => 'Public'], 'InferenceSpec' => ['title' => '', 'description' => 'The inference configurations applied to the downstream, such as the configuration of the processor or container of Elastic Algorithm Service (EAS). Example: `{ "processor": "tensorflow_gpu_1.12" }`'."\n", 'type' => 'object', 'example' => '{'."\n" .' "processor": "tensorflow_gpu_1.12"'."\n" .'}', 'visibility' => 'Public'], 'EvaluationSpec' => ['title' => '', 'description' => 'The evaluation configuration.'."\n", 'type' => 'object', 'example' => '{}', 'visibility' => 'Public'], 'CompressionSpec' => ['title' => '', 'description' => 'The compression configuration.'."\n", 'type' => 'object', 'example' => '{}', 'visibility' => 'Public'], 'ExtraInfo' => ['title' => '', 'description' => 'The additional information.'."\n", 'type' => 'object', 'example' => '{'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" .' "TrainedWords": ["albedo_overlord"]'."\n" .'}', 'visibility' => 'Public'], 'DistillationSpec' => ['type' => 'object', 'description' => '', 'visibility' => 'Public', 'example' => '{}', 'title' => ''], ], 'visibility' => 'Public', 'example' => '', ], 'ModulePermissions' => [ 'title' => '', 'description' => 'A list of module permission configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ModuleName' => ['title' => '', 'description' => 'The module name. Valid values are:'."\n" ."\n" .'- PaiDesigner: PAI-Designer'."\n" ."\n" .'- Paiflow: workflow'."\n" ."\n" .'- DSW: PAI-DSW'."\n" ."\n" .'- DLC: PAI-DLC'."\n" ."\n" .'- Dataset: dataset'."\n" ."\n" .'- Model: model'."\n" ."\n" .'- Image: image'."\n" ."\n" .'- CodeSource: code source'."\n" ."\n" .'- PaiWorkspace@@Workspace: Basic workspace information'."\n" ."\n" .'- PaiWorkspace@@MemberRole: workspace member management'."\n" ."\n" .'- PaiWorkspace@@Resource: workspace computing resource management'."\n" ."\n" .'- PaiWorkspace@@Config: workspace configuration center'."\n" ."\n" .'- ArtLab: ArtLab', 'type' => 'string', 'example' => 'PaiDesigner'], 'PermissionType' => ['title' => '', 'description' => 'The permission type. Valid values are:'."\n" ."\n" .'- ReadOnly: read-only access.'."\n" ."\n" .'- ReadWrite: Allows users to edit and run.'."\n" ."\n" .'- FullAccess: full control.'."\n" ."\n" .'- NoPrivilege: no permissions.'."\n" ."\n" .'- CustomPermissions: custom permissions.', 'type' => 'string', 'example' => 'ReadOnly'], 'Permissions' => [ 'title' => '', 'description' => 'The permissions. This parameter is required and applies only when `PermissionType` is set to `CustomPermissions`.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PermissionCodes' => [ 'title' => '', 'description' => 'A list of permissions.', 'type' => 'array', 'items' => ['description' => 'The permission code. Each permission must be unique within the region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~).', 'type' => 'string', 'title' => '', 'example' => 'PaiDLC:GetTensorboard'], 'example' => '', ], 'PermissionRules' => [ 'title' => '', 'description' => 'A list of permission rules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Accessibility' => ['title' => '', 'description' => 'The access type. Valid values are:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can perform this action.'."\n" ."\n" .'- PRIVATE: Only the creator can perform this action.'."\n" ."\n" .'- ANY: Both the creator and non-creators can perform this action.', 'type' => 'string', 'example' => 'PRIVATE'], 'EntityAccessType' => ['title' => '', 'description' => 'The entity access type. This parameter is ignored if `Accessibility` is set to `PUBLIC`. If `Accessibility` is set to `PRIVATE`, the value of this parameter determines the permissions. Valid values are:'."\n" ."\n" .'- CREATOR: Only the creator can perform this action.'."\n" ."\n" .'- ANY: Both the creator and non-creators can perform this action.', 'type' => 'string', 'example' => 'CREATOR'], ], 'description' => 'A permission rule.', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => 'A permission object.', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => 'The permission object.', 'title' => '', 'example' => '', ], 'example' => '', ], 'Prompt' => [ 'title' => '', 'description' => '提示词数据结构', 'type' => 'object', 'properties' => [ 'CreateTime' => ['title' => '', 'type' => 'string', 'backendName' => 'CreateTime', 'description' => '', 'example' => ''], 'ModifyTime' => ['title' => '', 'type' => 'string', 'backendName' => 'ModifyTime', 'description' => '', 'example' => ''], 'PromptName' => ['title' => '', 'type' => 'string', 'backendName' => 'PromptName', 'description' => '', 'example' => ''], 'FrameworkType' => ['title' => '', 'type' => 'string', 'backendName' => 'FrameworkType', 'description' => '', 'example' => ''], 'FrameworkContent' => ['title' => '', 'type' => 'string', 'backendName' => 'FrameworkContent', 'description' => '', 'example' => ''], 'PromptId' => ['title' => '', 'type' => 'string', 'backendName' => 'PromptId', 'description' => '', 'example' => ''], 'Description' => ['title' => '', 'type' => 'string', 'backendName' => 'Description', 'description' => '', 'example' => ''], 'Accessibility' => ['title' => '', 'type' => 'string', 'backendName' => 'Accessibility', 'description' => '', 'example' => ''], ], 'example' => '', ], 'Relation' => [ 'title' => '', 'description' => 'Relation'."\n", 'type' => 'object', 'properties' => [ 'ErrMsg' => ['title' => '', 'description' => 'ErrMsg'."\n", 'type' => 'string', 'visibility' => 'Public', 'backendName' => 'ErrMsg', 'example' => ''], 'LineageRelation' => ['title' => '', 'description' => 'LineageRelation'."\n", '$ref' => '#/components/schemas/LineageRelation', 'visibility' => 'Public', 'backendName' => 'LineageRelation', 'example' => ''], 'Result' => ['title' => '', 'description' => 'Result'."\n", 'type' => 'boolean', 'visibility' => 'Public', 'backendName' => 'Result', 'example' => ''], ], 'visibility' => 'Public', 'example' => '', ], 'Relationship' => [ 'title' => '', 'description' => 'Defines a connection between two entities.', 'type' => 'object', 'properties' => [ 'Attributes' => ['title' => '', 'description' => 'A collection of key-value pairs providing additional details about the relationship.', 'type' => 'object', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Attributes'], 'DataChannel' => ['title' => '', 'description' => 'The channel or system through which the relationship is established.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'DataChannel'], 'RelationshipGuid' => ['title' => '', 'description' => 'The globally unique identifier (GUID) for the relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'RelationshipGuid'], 'RelationshipType' => ['title' => '', 'description' => 'Specifies the type of relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'RelationshipType'], ], 'example' => '', 'visibility' => 'Public', ], 'Run' => [ 'title' => '', 'description' => 'The run.', 'type' => 'object', 'properties' => [ 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the run.', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'type' => 'string', 'example' => 'PRIVATE', ], 'SourceId' => ['title' => '', 'description' => 'The ID of the source PAI workload.', 'type' => 'string', 'example' => 'train9s0afvjkf'], 'SourceType' => ['title' => '', 'description' => 'The type of the source PAI workload.', 'type' => 'string', 'example' => 'TrainingService'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace to which the run belongs.', 'type' => 'string', 'example' => '145883'], 'Params' => [ 'title' => '', 'description' => 'The list of hyperparameters for the run.', 'type' => 'array', 'items' => ['description' => 'A hyperparameter.', '$ref' => '#/components/schemas/RunParam', 'title' => '', 'example' => ''], 'example' => '', ], 'Labels' => [ 'title' => '', 'description' => 'The list of labels for the run.', 'type' => 'array', 'items' => ['description' => 'A label.', '$ref' => '#/components/schemas/RunLabel', 'title' => '', 'example' => ''], 'example' => '', ], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the run was last modified.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'Name' => ['title' => '', 'description' => 'Name', 'type' => 'string', 'example' => 'testrun'], 'Metrics' => [ 'title' => '', 'description' => 'The list of metrics for the run.', 'type' => 'array', 'items' => ['description' => 'Metrics', '$ref' => '#/components/schemas/RunMetric', 'title' => '', 'example' => ''], 'example' => '', ], 'OwnerId' => ['title' => '', 'description' => 'The ID of the owner\'s root account.', 'type' => 'string', 'example' => '163104*****3440'], 'ExperimentId' => ['title' => '', 'description' => 'The ID of the experiment associated with the run.', 'type' => 'string', 'example' => 'exp-1zpfthdx******'], 'UserId' => ['title' => '', 'description' => 'The ID of the owner.', 'type' => 'string', 'example' => ''], 'RunId' => ['title' => '', 'description' => 'The unique ID of the run.', 'type' => 'string', 'example' => 'run-1qJhzJ2YXgX****'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the run was created.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], 'RunLabel' => [ 'title' => '', 'description' => 'Details of a Run label', 'type' => 'object', 'properties' => [ 'Value' => ['title' => '', 'description' => 'Value of the label', 'type' => 'string', 'required' => true, 'example' => ''], 'RunId' => ['title' => '', 'description' => 'ID of the Run that owns this label', 'type' => 'string', 'example' => ''], 'GmtCreateTime' => ['title' => '', 'description' => 'Time when the label was created', 'type' => 'string', 'example' => ''], 'GmtModifiedTime' => ['title' => '', 'description' => 'Time when the label was last modified', 'type' => 'string', 'example' => ''], 'Key' => ['title' => '', 'description' => 'Key of the label', 'type' => 'string', 'required' => true, 'example' => ''], ], 'example' => '', ], 'RunMetric' => [ 'title' => '', 'description' => 'A single run metric recorded during a task.', 'type' => 'object', 'properties' => [ 'Value' => ['title' => '', 'description' => 'The metric value.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '', 'visibility' => 'Public', 'backendName' => 'Value'], 'Step' => ['title' => '', 'description' => 'The step when the metric was recorded.', 'type' => 'integer', 'format' => 'int64', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Step'], 'Timestamp' => ['title' => '', 'description' => 'The timestamp when the metric was recorded.', 'type' => 'integer', 'format' => 'int64', 'example' => '', 'visibility' => 'Public', 'backendName' => 'Timestamp'], 'Key' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'required' => true, 'example' => '', 'visibility' => 'Public', 'backendName' => 'Key'], ], 'example' => '', 'visibility' => 'Public', ], 'RunParam' => [ 'title' => '', 'description' => 'A key-value pair representing a run parameter.', 'type' => 'object', 'properties' => [ 'Value' => ['title' => '', 'description' => 'The run parameter\'s value.', 'type' => 'string', 'required' => true, 'example' => '', 'visibility' => 'Public', 'backendName' => 'Value'], 'Key' => ['title' => '', 'description' => 'The run parameter\'s key.', 'type' => 'string', 'required' => true, 'example' => '', 'visibility' => 'Public', 'backendName' => 'Key'], ], 'example' => '', 'visibility' => 'Public', ], 'ServiceTemplate' => [ 'title' => 'A short description of struct', 'description' => '服务模版。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'ServiceTemplateId' => ['title' => '服务模版ID', 'description' => '服务模版ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'st-asdkjf**skdhh', 'backendName' => 'ServiceTemplateId'], 'ServiceTemplateName' => ['title' => '服务模版名称', 'description' => '服务模版名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'foo', 'backendName' => 'ServiceTemplateName'], 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => '更新时间', 'description' => '更新时间。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-01-21T17:12:35Z', 'backendName' => 'GmtModifiedTime'], 'UserId' => ['title' => '创建者ID', 'description' => '创建者ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '155770209****904', 'backendName' => 'UserId'], 'OwnerId' => ['title' => '主账号ID', 'description' => '主账号ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => '155770209****904', 'backendName' => 'OwnerId'], 'OrderNumber' => ['title' => '序号', 'description' => '序号。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'OrderNumber'], 'Provider' => ['title' => '提供者', 'description' => '提供者。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'pai', 'backendName' => 'Provider'], 'ServiceTemplateDoc' => ['title' => '服务模版文档', 'description' => '服务模版文档。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://***.md', 'backendName' => 'ServiceTemplateDoc'], 'ServiceTemplateDescription' => ['title' => '描述', 'description' => '描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '这里是一个描述。', 'backendName' => 'ServiceTemplateDescription'], 'InferenceSpec' => ['title' => '模版配置', 'description' => '模版配置。', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "processor": "tensorflow_gpu_1.12" }', 'backendName' => 'InferenceSpec'], 'Labels' => [ 'title' => '标签列表', 'description' => '标签列表。', 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => '标签。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Label'], 'backendName' => 'Labels', ], ], ], 'Trial' => [ 'title' => 'A short description of struct', 'description' => 'Trial'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Name' => ['title' => 'Name', 'description' => 'Name'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Name'], 'TrialId' => ['title' => 'TrialId', 'description' => 'TrialId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'TrialId'], 'SourceType' => ['title' => 'SourceType', 'description' => 'SourceType'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'SourceType'], 'SourceId' => ['title' => 'SourceId', 'description' => 'SourceId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'SourceId'], 'WorkspaceId' => ['title' => 'WorkspaceId', 'description' => 'WorkspaceId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'WorkspaceId'], 'ExperimentId' => ['title' => 'ExperimentId', 'description' => 'ExperimentId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'ExperimentId'], 'Labels' => [ 'title' => 'Labels', 'description' => 'Labels'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => ['visibility' => 'Public', 'type' => 'object', 'extendType' => 'true', 'description' => ''], 'backendName' => 'Labels', ], 'UserId' => ['title' => 'UserId', 'description' => 'UserId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'UserId'], 'OwnerId' => ['title' => 'OwnerId', 'description' => 'OwnerId'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'OwnerId'], 'GmtCreateTime' => ['title' => 'GmtCreateTime', 'description' => 'GmtCreateTime'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => 'GmtModifiedTime', 'description' => 'GmtModifiedTime'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'GmtModifiedTime'], 'Accessibility' => ['title' => 'Accessibility', 'description' => 'Accessibility'."\n", 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'Accessibility'], ], ], 'TrialLabel' => [ 'title' => 'A short description of struct', 'description' => 'A key-value pair associated with a trial.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => 'Key of Trial Label', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'key', 'visibility' => 'Public', 'backendName' => 'Key'], 'Value' => ['title' => 'Value of Trial Label', 'description' => 'The value of the label.', 'type' => 'string', 'example' => 'value', 'visibility' => 'Public', 'backendName' => 'Value'], 'GmtCreateTime' => ['title' => 'Create time', 'description' => 'The time the label was created, in UTC and following the ISO 8601 standard.', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'visibility' => 'Public', 'backendName' => 'GmtCreateTime'], 'GmtModifiedTime' => ['title' => 'Modified time', 'description' => 'The time the label was last modified, in UTC and following the ISO 8601 standard.', 'type' => 'string', 'example' => '2023-12-27T03:30:04Z', 'visibility' => 'Public', 'backendName' => 'GmtModifiedTime'], 'TrialId' => ['title' => 'trl-v0fw9a0sd8f9af', 'description' => 'The ID of the associated trial.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'TrialId'], ], 'example' => '', 'visibility' => 'Public', ], ], ], 'apis' => [ 'AcceptDataworksEvent' => [ 'summary' => 'PAI accepts and processes system event messages from DataWorks.', 'path' => '/api/v1/workspaces/action/acceptdataworksevent', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '259201', 'abilityTreeNodes' => ['FEATURElearn8QX455'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'MessageId' => ['description' => 'The ID of the DataWorks open message. After an extension point event is triggered, the message ID is available in the received event message. For more information about the message format, see [Message format](~~436911~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '539306ba-*****-41a0-****-6dc81060985c'], 'Data' => ['description' => 'The event content of the message.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{"eventCode":"d****ct","projectId":"8***6","tenantId":4*******8,"operator":"115*****901"}'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], 'example' => '', ], ], ], 'title' => 'AcceptDataworksEvent', 'description' => 'This API is for internal system calls only.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptDataworksEvent'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'AddImage' => [ 'summary' => 'Adds a custom image to a workspace.', 'path' => '/api/v1/images', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61619', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The image name. The naming convention is as follows:'."\n" ."\n" .'- The name must be 1 to 50 characters long.'."\n" ."\n" .'- The name can contain lowercase letters, digits, and hyphens (-). It must start with a letter.'."\n" ."\n" .'- The name must be unique within the workspace.', 'type' => 'string', 'required' => true, 'example' => 'nlp-compression'], 'Description' => ['title' => '', 'description' => 'The description of the image.', 'type' => 'string', 'required' => false, 'example' => 'NLP model compression training image'], 'ImageUri' => ['title' => '', 'description' => 'The URI of the image. The URI can be reused. For more information, see [ListImage](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'registry.cn-hangzhou.aliyuncs.com/pai-compression/nlp:gpu'], 'Labels' => [ 'title' => '', 'description' => 'The labels of the image. This is an array where each item contains a key and a value.'."\n" .'Official images have the following label: system.official=true'."\n" .'The following keys are supported:'."\n" ."\n" .'- system.chipType'."\n" ."\n" .'- system.dsw\\.cudaVersion'."\n" ."\n" .'- system.dsw\\.fromImageId'."\n" ."\n" .'- system.dsw\\.fromInstanceId'."\n" ."\n" .'- system.dsw\\.id'."\n" ."\n" .'- system.dsw\\.os'."\n" ."\n" .'- system.dsw\\.osVersion'."\n" ."\n" .'- system.dsw\\.resourceType'."\n" ."\n" .'- system.dsw\\.rootImageId'."\n" ."\n" .'- system.dsw\\.stage'."\n" ."\n" .'- system.dsw\\.tag'."\n" ."\n" .'- system.dsw\\.type'."\n" ."\n" .'- system.framework'."\n" ."\n" .'- system.origin'."\n" ."\n" .'- system.pythonVersion'."\n" ."\n" .'- system.source'."\n" ."\n" .'- system.supported.dlc'."\n" ."\n" .'- system.supported.dsw', 'type' => 'array', 'items' => [ 'description' => 'A label.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the label.', 'type' => 'string', 'required' => false, 'example' => 'system.chipType'], 'Value' => ['title' => '', 'description' => 'The value of the label.', 'type' => 'string', 'required' => false, 'example' => 'GPU'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace to which the image belongs. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '15******45'], 'Accessibility' => ['title' => '', 'description' => 'The visibility of the image. Valid values:'."\n" ."\n" .'- PUBLIC: All members of the workspace can perform operations on the image.'."\n" ."\n" .'- PRIVATE: Only the creator can perform operations on the image.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], 'Size' => ['description' => 'The size of the image, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '2'], 'ImageId' => ['description' => 'The ID of the image. If you leave this parameter empty, the system automatically generates an ID.'."\n" .'The format is \\`image-\\` followed by 18 uppercase letters, lowercase letters, or digits.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'image-k83*****cv'], 'SourceType' => ['title' => '', 'type' => 'string', 'required' => false, 'description' => 'The source type of the image. Valid values:'."\n" .'Import'."\n" .'Build', 'example' => ''], 'SourceId' => ['title' => '', 'type' => 'string', 'required' => false, 'description' => 'The source ID of the image. If the source type is Build, this ID corresponds to the image build ID.', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'ImageId' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => 'image-4c62******53uor'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ImageId\\": \\"image-4c62******53uor\\"\\n}","type":"json"}]', 'title' => 'AddImage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:AddImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AddImageLabels' => [ 'summary' => 'Adds labels to a specified image.', 'path' => '/api/v1/images/{ImageId}/labels', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61617', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the image. For more information, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'image-4c62******53uor'."\n"], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The image labels.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'title' => '', 'description' => 'A list of image labels.', 'type' => 'array', 'items' => [ 'description' => 'An image label.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the label. The following keys are supported:'."\n" ."\n" .'- system.chipType'."\n" ."\n" .'- system.dsw\\.cudaVersion'."\n" ."\n" .'- system.dsw\\.fromImageId'."\n" ."\n" .'- system.dsw\\.fromInstanceId'."\n" ."\n" .'- system.dsw\\.id'."\n" ."\n" .'- system.dsw\\.os'."\n" ."\n" .'- system.dsw\\.osVersion'."\n" ."\n" .'- system.dsw\\.resourceType'."\n" ."\n" .'- system.dsw\\.rootImageId'."\n" ."\n" .'- system.dsw\\.stage'."\n" ."\n" .'- system.dsw\\.tag'."\n" ."\n" .'- system.dsw\\.type'."\n" ."\n" .'- system.framework'."\n" ."\n" .'- system.origin'."\n" ."\n" .'- system.pythonVersion'."\n" ."\n" .'- system.source'."\n" ."\n" .'- system.supported.dlc'."\n" ."\n" .'- system.supported.dsw', 'type' => 'string', 'required' => false, 'example' => 'system.chipType'], 'Value' => ['title' => '', 'description' => 'The value of the label.', 'type' => 'string', 'required' => false, 'example' => 'GPU'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddImageLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:AddImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'AddMemberRole' => [ 'summary' => 'Assigns a role to a member in a workspace, granting that member the role\'s permissions.', 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the workspace. To obtain this ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '145883', 'title' => ''], ], [ 'name' => 'MemberId', 'in' => 'path', 'schema' => ['description' => 'The ID of the member. To obtain this ID, see [ListMembers](~~449135~~).', 'type' => 'string', 'required' => true, 'example' => '145883-215139******688039', 'title' => ''], ], [ 'name' => 'RoleName', 'in' => 'path', 'schema' => ['description' => 'The role to assign. You can specify a built-in role or a custom role.'."\n" ."\n" .'- Built-in role: You can specify one of the following built-in roles. For the permissions of each role, see [Appendix: Roles and permissions](~~2840449~~).'."\n" ."\n" .' - `PAI.AlgoDeveloper`: Algorithm developer.'."\n" ."\n" .' - `PAI.AlgoOperator`: Algorithm operator.'."\n" ."\n" .' - `PAI.LabelManager`: Labeling administrator.'."\n" ."\n" .' - `PAI.MaxComputeDeveloper`: MaxCompute developer.'."\n" ."\n" .' - `PAI.WorkspaceAdmin`: Administrator.'."\n" ."\n" .' - `PAI.WorkspaceGuest`: Guest.'."\n" ."\n" .' - `PAI.WorkspaceOwner`: Owner.'."\n" ."\n" .'- Custom role: Specify the ID of the custom role. The ID must be prefixed with `role-`. Example: `role-sw******2tij`.', 'type' => 'string', 'required' => true, 'example' => 'PAI.AlgoDeveloper', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'title' => 'AddMemberRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberRole'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:AddMemberRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ChangeResourceGroup' => [ 'summary' => 'Changes the resource group of a specified resource.', 'path' => '/resourcegroups/action/changeresourcegroup', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '249844', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ResourceId' => ['description' => 'The resource ID. This ID is the same as the workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '12**56'], 'NewResourceGroupId' => ['description' => 'The ID of the new resource group. For more information about how to obtain a resource group ID, see [View the basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-df********534dy'], 'ResourceType' => ['description' => 'The type of the resource. You must set this parameter to workspace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'workspace'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6****27E-****-5144-A002-89C****8660F'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ChangeResourceGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6****27E-****-5144-A002-89C****8660F\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateCodeSource' => [ 'summary' => 'Creates a code configuration in PAI. You can configure a Git code branch and CommitId. After the configuration is created, it can be referenced in DLC jobs.', 'path' => '/api/v1/codesources', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55315', 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '1234'], 'DisplayName' => ['title' => '', 'description' => 'The name of the code configuration.', 'type' => 'string', 'required' => true, 'example' => 'MyCodeSource1'], 'Description' => ['title' => '', 'description' => 'The description of the code configuration, which helps distinguish different code configurations.', 'type' => 'string', 'example' => 'code source of dlc examples', 'required' => false], 'CodeRepo' => ['title' => '', 'description' => 'The URL of the code repository. This parameter is required.', 'type' => 'string', 'example' => 'https://code.aliyun.com/******', 'required' => false], 'CodeRepoUserName' => ['title' => '', 'description' => 'The username of the code repository.', 'type' => 'string', 'example' => 'use***', 'required' => false], 'CodeRepoAccessToken' => ['title' => '', 'description' => 'The access token of the code repository.', 'type' => 'string', 'example' => '***', 'required' => false], 'CodeBranch' => ['title' => '', 'description' => 'The code branch.', 'type' => 'string', 'example' => 'master', 'required' => false], 'MountPath' => ['title' => '', 'description' => 'The local mount directory for the code. This parameter is required.', 'type' => 'string', 'example' => '/root/code/code-source-1', 'required' => false], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the code configuration.', 'enumValueTitles' => ['PUBLIC' => 'Visible to all members in the workspace.', 'PRIVATE' => 'Visible only to you and administrators in the workspace.'], 'type' => 'string', 'example' => 'PRIVATE', 'required' => false, ], 'CodeCommit' => ['title' => '', 'description' => 'The CommitID of the code. CodeCommit takes priority over CodeBranch. If you specify CodeCommit, CodeBranch does not take effect.', 'type' => 'string', 'required' => false, 'example' => '171de********a9d900d'], 'CloneType' => ['description' => 'The clone mode. Valid values:'."\n" .'- 0 (default): creates a new subdirectory.'."\n" .'- 1: tiles to the current directory.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'CodeSourceId' => ['title' => '', 'description' => 'The ID of the created code configuration.', 'type' => 'string', 'example' => 'code-20********'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3**********'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20********\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3**********\\"\\n}","type":"json"}]', 'title' => 'Create code configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCodeSource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paicodesource:CreateCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateConnection' => [ 'summary' => 'Creates a connection to link PAI cloud services with your models, databases, and other services. This is useful for scenarios such as LangStudio and multimodal dataset retrieval.', 'path' => '/api/v1/connections', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267606', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body, which contains the parameters required to create the connection.', 'type' => 'object', 'properties' => [ 'Accessibility' => [ 'description' => 'The visibility of the workspace. The default value is `PRIVATE`.', 'enumValueTitles' => ['PUBLIC' => 'Visible to all users in this workspace.', 'PRIVATE' => 'Visible only to you and administrators in this workspace.'], 'type' => 'string', 'default' => 'PRIVATE', 'required' => false, 'example' => 'PRIVATE', 'title' => '', ], 'Configs' => [ 'description' => 'Configuration properties for the connection, provided as key-value pairs. The required keys depend on the connection type. For details, see the supplementary parameter information.', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'The value of a configuration property for the connection.', 'type' => 'string', 'example' => '6379', 'title' => ''], 'title' => '', 'example' => '', ], 'ConnectionName' => ['description' => 'The name of the connection.', 'type' => 'string', 'required' => true, 'example' => 'llm-connection', 'title' => ''], 'ConnectionType' => [ 'description' => 'The type of the connection.', 'enumValueTitles' => ['ElasticsearchConnection' => 'Elasticsearch connection', 'MilvusConnection' => 'Milvus connection', 'OpenSearchConnection' => 'OpenSearch connection', 'HologresConnection' => 'Hologres connection', 'DashScopeConnection' => 'Alibaba Cloud Model Studio service', 'LindormConnection' => 'Lindorm connection', 'RDSConnection' => 'RDS connection', 'OpenLLMConnection' => 'Generic LLM model connection', 'CustomConnection' => 'Custom connection'], 'type' => 'string', 'required' => false, 'example' => 'DashScopeConnection', 'title' => '', ], 'Description' => ['description' => 'The description of the connection.', 'type' => 'string', 'example' => 'Open-source LLM service connection.', 'required' => false, 'title' => ''], 'Secrets' => [ 'description' => 'Sensitive connection properties that require encryption, such as database credentials or an API key for a model service.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The value of an encrypted connection property.', 'type' => 'string', 'example' => 'Dsjk***hsl01', 'title' => ''], 'title' => '', 'example' => '', ], 'WorkspaceId' => ['description' => 'The ID of the workspace. To get this ID, call the [`ListWorkspaces`](~~449124~~) operation.', 'type' => 'string', 'required' => false, 'example' => '123**45', 'title' => ''], 'ResourceMeta' => [ 'description' => 'Resource metadata for the connection. This parameter is typically used for database connection types.', 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'Test instance.', 'required' => false, 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ld-uf69****9nqjjes', 'title' => ''], 'Extra' => ['description' => 'Additional configuration information.', 'type' => 'string', 'required' => false, 'example' => '{"vpcId":"vpc-xxxx"}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'Models' => [ 'description' => 'A list of models. This parameter applies to model service connections.', 'type' => 'array', 'items' => [ 'description' => 'A model.', 'type' => 'object', 'properties' => [ 'Model' => ['description' => 'The model identifier. This value corresponds to the `model` parameter in an OpenAI API request.', 'type' => 'string', 'required' => false, 'example' => 'model_001', 'title' => ''], 'DisplayName' => ['description' => 'The display name of the model.', 'type' => 'string', 'example' => 'Language model', 'required' => false, 'title' => ''], 'ModelType' => [ 'description' => 'The model type.', 'enumValueTitles' => ['Embedding' => 'Embedding model', 'LLM' => 'LLM', 'ReRank' => 'ReRank model'], 'type' => 'string', 'required' => false, 'example' => 'LLM', 'title' => '', ], 'ToolCall' => [ 'description' => 'Specifies whether the model supports tool calling.', 'enumValueTitles' => ['true' => 'The model supports tool calling.', 'false' => 'The model does not support tool calling.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], 'SupportReasoning' => [ 'description' => 'Specifies whether the model supports deep reasoning and can output the reasoning process as `reasoning_content`.', 'enumValueTitles' => ['true' => 'The model supports deep reasoning.', 'false' => 'The model does not support deep reasoning.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], 'SupportResponseSchema' => [ 'description' => 'Specifies whether the model supports structured output in the OpenAI API\'s JSON Schema format.', 'enumValueTitles' => ['true' => 'The model supports structured output.', 'false' => 'The model does not support structured output.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], 'SupportVision' => [ 'description' => 'Specifies whether the model supports visual understanding.', 'enumValueTitles' => ['true' => 'The model supports visual understanding.', 'false' => 'The model does not support visual understanding.'], 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => '', ], 'MaxModelLength' => ['description' => 'The context length.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4096', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'ConnectionId' => ['description' => 'The connection ID.', 'type' => 'string', 'example' => 'conn-pai9m***mi47', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\"\\n}","type":"json"}]', 'title' => 'CreateConnection', 'requestParamsDescription' => 'The Configs and Secrets formats vary for each connection type:'."\n" ."\n" .'- **DashScopeConnection/OpenLLMConnection**'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Secrets": {'."\n" .' "api_key": "xxx"'."\n" .' },'."\n" .' "Configs": {'."\n" .' "base_url": "cn-hangzhou.aigc.aliyuncs.com/api/v1/services/xxx"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'- **OpenSearchConnection/LindormConnection/ElasticsearchConnection**'."\n" ."\n" .'```'."\n" ."\n" .'{'."\n" .' "Secrets": {'."\n" .' "password": "xxx"'."\n" .' },'."\n" .' "Configs": {'."\n" .' "uri": "xxx",'."\n" .' "username": "xxx"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'- **MilvusConnection**'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Secrets": {'."\n" .' "password": "xxx"'."\n" .' },'."\n" .' "Configs": {'."\n" .' "uri": "xxx",'."\n" .' "username": "xxx"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'- **HologresConnection**'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Secrets": {'."\n" .' "password": "xxx"'."\n" .' },'."\n" .' "Configs": {'."\n" .' "database": "xx",'."\n" .' "port": "xx",'."\n" .' "host": "xx",'."\n" .' "user": "xx"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'- **RDSConnection**'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Secrets": {'."\n" .' "password": "xxx"'."\n" .' },'."\n" .' "Configs": {'."\n" .' "database": "xxx",'."\n" .' "port": "xxx",'."\n" .' "host": "xxx",'."\n" .' "type": "db_type",'."\n" .' "username": "xxx"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'- **CustomConnection**'."\n" ."\n" .'Uses a custom format.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnection'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateDataset' => [ 'summary' => 'Creates a dataset.', 'path' => '/api/v1/datasets', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48562', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '', 'description' => 'The name of the dataset. The name must meet the following requirements:'."\n" ."\n" .'- Starts with a lowercase letter, an uppercase letter, a number, or a Chinese character.'."\n" ."\n" .'- Can contain underscores (\\_) and hyphens (-).'."\n" ."\n" .'- Must be 1 to 127 characters long.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'myName', ], 'Property' => [ 'title' => '', 'description' => 'The property of the dataset. Valid values:'."\n" ."\n" .'- FILE: A file.'."\n" ."\n" .'- DIRECTORY: A directory.', 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'type' => 'string', 'required' => true, 'example' => 'DIRECTORY', ], 'DataSourceType' => [ 'title' => '', 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'- OSS: Object Storage Service (OSS).'."\n" ."\n" .'- NAS: general-purpose Apsara File Storage NAS.'."\n" ."\n" .'- EXTREMENAS: Extreme NAS.'."\n" ."\n" .'- CPFS: general-purpose Cloud Parallel File Storage (CPFS).'."\n" ."\n" .'- BMCPFS: AI Computing Edition of CPFS.'."\n" ."\n" .'- MAXCOMPUTE: MaxCompute.'."\n" ."\n" .'- URL: a public HTTP or HTTPS URL.', 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'type' => 'string', 'required' => true, 'example' => 'NAS', ], 'Uri' => ['title' => '', 'description' => 'The URI of the data. The URI format varies based on the `DataSourceType` value.'."\n" ."\n" .'- For an `OSS` data source: `oss://bucket.endpoint/object`'."\n" ."\n" .'- For a `NAS` data source:'."\n" .' For general-purpose `NAS`: `nas://.region/subpath/to/dir/`.'."\n" .' For `CPFS` 1.0: `nas://.region/subpath/to/dir/`.'."\n" .' For `CPFS` 2.0: `nas://.region//`.'."\n" .' `CPFS` 1.0 and `CPFS` 2.0 are distinguished by the format of the file system ID (fsid). The fsid for `CPFS` 1.0 is in the `cpfs-<8-character ASCII string>` format. The fsid for `CPFS` 2.0 is in the `cpfs-<16-character ASCII string>` format.', 'type' => 'string', 'required' => true, 'example' => 'nas://09f****f2.cn-hangzhou/'], 'DataType' => [ 'title' => '', 'description' => 'The data type of the dataset. The default value is `COMMON`. Valid values:'."\n" ."\n" .'- COMMON: common'."\n" ."\n" .'- PIC: image'."\n" ."\n" .'- TEXT: text'."\n" ."\n" .'- VIDEO: video'."\n" ."\n" .'- AUDIO: audio', 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], 'type' => 'string', 'required' => false, 'example' => 'COMMON', ], 'Labels' => [ 'title' => '', 'description' => 'A list of labels.', 'type' => 'array', 'items' => ['description' => 'The label to add to the dataset.', '$ref' => '#/components/schemas/Label', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'SourceType' => [ 'title' => '', 'description' => 'The source of the data. The default value is USER.', 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'type' => 'string', 'example' => 'USER', 'required' => false, ], 'SourceId' => ['title' => '', 'description' => 'The ID of the data source.'."\n" ."\n" .'- If `SourceType` is `USER`, you can specify a custom value for `SourceId`.'."\n" ."\n" .'- If `SourceType` is `ITAG`, this parameter specifies the iTAG task ID from which the dataset was generated.'."\n" ."\n" .'- If `SourceType` is `PAI_PUBLIC_DATASET`, the dataset is from a public PAI dataset, and this parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'jdnhf***fnrimv'], 'Description' => ['title' => '', 'description' => 'A custom description to distinguish the dataset from other datasets.', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the dataset.'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace to which the dataset belongs. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).'."\n" .'If this parameter is not specified, the default workspace is used. If the default workspace does not exist, an error is returned.', 'type' => 'string', 'required' => false, 'example' => '478**'], 'Options' => ['title' => '', 'description' => 'The extended fields, which are a JSON string.'."\n" .'When a Data Lake Compute (DLC) job uses the dataset, you can configure the `mountPath` field to specify the default mount path of the dataset.', 'type' => 'string', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}', 'required' => false], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the dataset in the workspace. Valid values:'."\n" ."\n" .'- PRIVATE (default): The dataset is visible only to its owner and administrators in the workspace.'."\n" ."\n" .'- PUBLIC: The dataset is visible to all users in the workspace.'."\n" ."\n" .'- ROLE\\_PUBLIC: The dataset is visible to users with specific workspace roles. The list of roles is specified in the `AccessibleRoleIdList` parameter. The dataset owner and administrators always retain visibility.', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'type' => 'string', 'example' => 'PRIVATE', 'required' => false, ], 'ProviderType' => ['title' => '', 'description' => 'The type of the data source provider. Valid values:'."\n" ."\n" .'- Ecs (default)'."\n" ."\n" .'- Lingjun', 'type' => 'string', 'example' => 'Ecs', 'required' => false], 'Provider' => ['description' => 'The provider of the dataset. You cannot set this parameter to `pai`.', 'type' => 'string', 'required' => false, 'example' => 'Github', 'title' => ''], 'UserId' => ['description' => 'The Alibaba Cloud account ID of the dataset owner. Workspace owners and administrators can create datasets for specified members of a workspace.', 'type' => 'string', 'required' => false, 'example' => '2485765****023475', 'title' => ''], 'SourceDatasetId' => ['description' => 'The ID of the source dataset for a labeled dataset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'd-bvfasdfxxxxj8o411'], 'SourceDatasetVersion' => ['description' => 'The version of the source dataset for a labeled dataset.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'v2'], 'VersionDescription' => ['description' => 'The description of the initial version of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the first dataset version.', 'title' => ''], 'VersionLabels' => [ 'description' => 'A list of labels for the initial version.', 'type' => 'array', 'items' => ['description' => 'The label to add to the initial version of the dataset.', '$ref' => '#/components/schemas/Label', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DataSize' => ['description' => 'The size of the dataset files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '999999999999', 'minimum' => '1', 'required' => false, 'example' => '10000', 'title' => ''], 'DataCount' => ['description' => 'The number of files in the dataset.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '999999999999', 'minimum' => '1', 'required' => false, 'example' => '500', 'title' => ''], 'MountAccessReadWriteRoleIdList' => [ 'description' => 'A list of workspace role IDs that are granted read and write permissions when the dataset is mounted. Role IDs that start with `PAI.` are built-in roles, and role IDs that start with `role-` are custom roles. If the list contains an asterisk (\\*), all roles are granted read and write permissions.'."\n" ."\n" .'- Accounts with specified roles: `["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]`'."\n" ."\n" .'- All accounts: `["*"]`'."\n" ."\n" .'- Dataset creator only: `[]`', 'type' => 'array', 'items' => ['description' => 'The workspace role ID.', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'ImportInfo' => ['description' => 'The storage import configuration of the dataset. `OSS`, `NAS`, and `CPFS` are supported.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"bucket": "${bucket}",// The bucket name.\\'."\n" .'"path": "${path}" // The file path.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"path": "${path}", // The file system path.\\'."\n" .'"mountTarget": "${mount\\_target}" // The mount target of the file system.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"protocolServiceId":"${protocol\\_service\\_id}", // The protocol service of the file system.\\'."\n" .'"exportId": "${export\\_id}", // The exported directory of the file system.\\'."\n" .'"path": "${path}", // The file system path.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS (AI Computing Edition)'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"path": "${path}", // The file system path.\\'."\n" .'"mountTarget": "${mount\\_target}", // The mount target of the file system. This parameter is specific to the AI Computing Edition.\\'."\n" .'"isVpcMount": boolean, // Specifies whether the mount target is in a VPC. This parameter is specific to the AI Computing Edition.\\'."\n" .'}'."\n" ."\n" .'
', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}', 'title' => ''], 'Edition' => [ 'description' => 'The edition of the dataset. The default value is BASIC. Valid values:'."\n" ."\n" .'- BASIC: Basic. Does not support dataset file metadata management.'."\n" ."\n" .'- ADVANCED: Advanced. Supported only for OSS datasets. Each version supports metadata management for up to 1 million files.'."\n" ."\n" .'- LOGICAL: Logical. Supported only for OSS datasets. Each version supports metadata management for up to 3 million files.', 'enumValueTitles' => ['LOGICAL' => 'LOGICAL', 'BASIC' => 'BASIC', 'ADVANCED' => 'ADVANCED'], 'type' => 'string', 'required' => false, 'example' => 'ADVANCED', 'title' => '', ], 'AccessibleRoleIdList' => [ 'type' => 'array', 'items' => ['description' => 'The workspace role ID.', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator', 'title' => ''], 'description' => 'This parameter takes effect only when `Accessibility` is set to `ROLE_PUBLIC`. This parameter specifies a list of workspace role IDs that can view this dataset. Role IDs that start with `PAI.` are built-in roles, and role IDs that start with `role-` are custom roles.', 'title' => '', 'example' => '', 'required' => false, ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F'], 'DatasetId' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'example' => 'd-rbvg5*****jhc9ks92', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\",\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\"\\n}","type":"json"}]', 'title' => 'CreateDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateDatasetFileMetas' => [ 'summary' => 'Creates file metadata records for a dataset in a batch.', 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260491', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['description' => 'The ID of the workspace where the dataset is located. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '478**'], 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], 'DatasetFileMetas' => [ 'description' => 'A list of file metadata content.', 'type' => 'array', 'items' => ['description' => 'The details of the file metadata content.', 'required' => false, '$ref' => '#/components/schemas/DatasetFileMetaContentCreate', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Status' => [ 'description' => 'The status of the batch metadata creation. A value of \\`true\\` indicates that all records were created successfully. If the value is \\`false\\`, check \\`FailedDetails\\`.', 'type' => 'boolean', 'enumValueTitles' => ['true' => 'Success', 'false' => 'Failed'], 'title' => '', 'example' => 'true', ], 'FailedDetails' => [ 'description' => 'A list of file metadata records that failed to be created.', 'type' => 'array', 'items' => ['description' => 'The details of a file metadata record that failed to be created.', '$ref' => '#/components/schemas/DatasetFileMetaResponse', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'SucceedDetails' => [ 'description' => 'A list of file metadata records that were successfully created.', 'type' => 'array', 'items' => ['description' => 'The details of a file metadata record that was successfully created.', '$ref' => '#/components/schemas/DatasetFileMetaResponse', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatasetFileMetas', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetFileMetas'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ],\\n \\"SucceedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateDatasetJob' => [ 'summary' => 'Creates a dataset job.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260335', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain the dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID. For more information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''], 'JobAction' => [ 'description' => 'The task operation.'."\n" ."\n" .'- SemanticIndex: semantic index'."\n" ."\n" .'- IntelligentTag: intelligent tagging'."\n" ."\n" .'- FileMetaExport: metadata export'."\n" ."\n" .'- FileMetaBuild: build and update metadata'."\n" ."\n" .'- IntelligentTagRevert: revoke intelligent tagging'."\n" ."\n" .'- FileMetaImport: metadata import', 'enumValueTitles' => ['SemanticIndex' => 'SemanticIndex', 'IntelligentTag' => 'IntelligentTag', 'FileMetaExport' => 'FileMetaExport'], 'type' => 'string', 'required' => true, 'example' => 'SemanticIndex', 'title' => '', ], 'JobMode' => [ 'description' => 'The task type.'."\n" ."\n" .'- Full (default): forces the processing of all metadata. This task takes a long time to execute.'."\n" ."\n" .'- Increment: processes only changed or unsuccessfully processed metadata. The SemanticIndex and IntelligentTag tasks support Increment and Full. Other tasks support only Full.', 'enumValueTitles' => ['Full' => 'Full'], 'type' => 'string', 'required' => false, 'example' => 'Full', 'title' => '', ], 'Description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'This is a job description.', 'title' => ''], 'JobSpec' => ['description' => 'The task details.', 'type' => 'string', 'required' => true, 'example' => '{\\"modelId\\":\\"xxx\\"}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '99341606-****-0757724D97EE'], 'DatasetJobId' => ['description' => 'The dataset task ID.', 'type' => 'string', 'example' => 'dsjob-9jx1******uj9e', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99341606-****-0757724D97EE\\",\\n \\"DatasetJobId\\": \\"dsjob-9jx1******uj9e\\"\\n}","type":"json"}]', 'title' => 'CreateDatasetJob', 'requestParamsDescription' => 'Description of the JobSpec parameter in CreateDatasetJob:'."\n" ."\n" .'### Semantic index task'."\n" ."\n" .'Example:'."\n" ."\n" .'```{'."\n" .' "modelId": "xxx",'."\n" .' "modelVersion": "1.0.0",'."\n" .' "contentList": ["file"],'."\n" .' "embeddingConnectionId": "conn-xxx",'."\n" .' "embeddingModel": "default",'."\n" .' "databaseConnectionId": "conn-xxx",'."\n" .' "databaseTableName": "table_xxx",'."\n" .' "vectorIndexConfig":"{\\"shards\\":1,\\"similarity\\":\\"cosine\\",\\"indexType\\":\\"hnsw\\",\\"indexOptions\\":{\\"m\\":16,\\"efConstruction\\":200}}",'."\n" .' "concurrency": 2'."\n" .'}'."\n" .'```'."\n" ."\n" .'Field description:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| --------------------- | ------- | --------- | -------- | ----------------------------------------------------------------------- |'."\n" .'| modelId | String | model-xxx | No | The ID of the official model. |'."\n" .'| modelVersion | String | 1.0.0 | No | The version of the official model. |'."\n" .'| embeddingConnectionId | String | conn-xxx | No | The ID of the Elastic Algorithm Service (EAS) model service connection. |'."\n" .'| embeddingModel | String | default | No | The name of the model that corresponds to the EAS model service. |'."\n" .'| databaseConnectionId | String | conn-xxx | No | The ID of the vector database service connection. |'."\n" .'| databaseTableName | String | table_xxx | No | The name of the vector database table. |'."\n" .'| concurrency | Integer | 2 | No | The number of concurrent tasks. |'."\n" .'| contentList | Array | | Yes | The list of content to index. |'."\n" .'| +- | String | file | | The content to index. Currently, only file is supported. |'."\n" ."\n" .'### Intelligent tagging task'."\n" ."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "intelligentTagConnectionId": "conn-keltvufiud3quopq11",'."\n" .' "promptId": "pmt-gh6qaj1kvkf6yk7qx2",'."\n" .' "modelId":"qwen-vl-max"'."\n" .'}'."\n" .'```'."\n" ."\n" .'Field description:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| -------------------------- | ------ | ----------------------- | -------- | -------------------------------------- |'."\n" .'| modelId | String | qwen-vl-max | Yes | The model name. |'."\n" .'| intelligentTagConnectionId | String | conn-keltvufiud3quopq11 | Yes | The connection for tagging management. |'."\n" .'| promptId | String | pmt-gh6qaj1kvkf6yk7qx2 | Yes | The prompt ID. |'."\n" ."\n" .'### Metadata export task'."\n" ."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "query":{'."\n" .' "QueryType": "TAG",'."\n" .' "QueryText": "",'."\n" .' "TopK": 100,'."\n" .' "ScoreThreshold":0.6'."\n" .' },'."\n" .' "filteredAttributes":"FileName,Uri",'."\n" .' "exportDirUri": "oss://bucket/path/" '."\n" .'}'."\n" .'```'."\n" ."\n" .'Field description:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| ------------------ | ------ | --------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| query | JSON | | No | The query conditions for the export. The fields are the same as those in the `ListDatasetMetas` operation. See: `QueryParams` |'."\n" .'| filteredAttributes | String | Comma-separated | No | If specified, the exported results contain only the specified attribute fields. The fields are:
\\* Uri (required)
\\* DatasetFileMetaId
\\* FileName
\\* DataSize
\\* FileType
\\* ContentType
\\* Comment
\\* MetaAttributes
\\* FileFingerPrint
\\* FileCreateTime
\\* FileUpdateTime
\\* Tags.user: custom tags
\\* Tags.user-delete-ai-tags: algorithm tags deleted by the user
\\* Tags.ai: aggregated algorithm tags from all tagging tasks
\\* Tags.all: algorithm tags and custom tags, excluding algorithm tags deleted by the user |'."\n" .'| exportDirUri | String | oss://bucket/path/
or
pvfs://cata_log/DB/lanceTable | Yes | The OSS storage path for the exported content. This must be a folder path.
A folder named `{datasetId}-{datasetversion}-{time:yyyy-MM-dd-HH-mm-ss}` is created in this path to store the YAML and JSONL files. |'."\n" ."\n" .'**QueryParams**:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| -------------------------- | ------- | ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| QueryType | String | MIX | No | MIX, VECTOR, TAG |'."\n" .'| QueryText | String | "fallen water-filled barrier" | No | The text to search for. |'."\n" .'| QueryImage | String | oss://bucket.cn-hangzhou.aliyuncs.com/image.jpg | No | When you search by image, this parameter specifies the image information.
You can use an OSS URL of an image that is accessible over the public network. |'."\n" .'| QueryTagsIncludeAll | String | blue cone,lane line | No | Indicates "includes all of the following tags".
You can select multiple tags. The query results must contain all of these tags.
If this parameter is empty, this condition is not applied.
This parameter is valid when QueryType is set to TAG or MIX. |'."\n" .'| QueryTagsIncludeAny | String | blue sky | No | Indicates "includes any of the following tags".
You can select multiple tags. The query results must contain at least one of these tags.
If this parameter is empty, this condition is not applied.
This parameter is valid when QueryType is set to TAG or MIX. |'."\n" .'| QueryTagsExclude | String | overcast | No | Indicates "excludes the following tags".
You can select multiple tags. The query results cannot contain these tags.
If this parameter is empty, this condition is not applied.
This parameter is valid when QueryType is set to TAG or MIX. |'."\n" .'| QueryFileName | String | water_barrier | No | Performs a fuzzy search for the file name based on a 2-gram fuzzy match. |'."\n" .'| QueryFileDir | String | oss://cars/20250221/ | No | Performs a fuzzy search for the file folder based on a 2-gram fuzzy match. |'."\n" .'| QueryFileTypeIncludeAny | String | image,video | No | Indicates "includes any of the following file types".
You can select multiple file types. The query results must match at least one of these file types.
If this parameter is empty, this condition is not applied. |'."\n" .'| QueryContentTypeIncludeAny | String | image/jpeg,application/pdf | No | Indicates "includes any of the following MIME types".
You can select multiple MIME types. The query results must match at least one of these MIME types.
If this parameter is empty, this condition is not applied. |'."\n" .'| StartFileUpdateTime | String | 2021-01-12T14:36:01.000Z | No | Queries the file metadata within a time range. The start of the file update time.
The time is a UTC timestamp in the ISO 8601 format: 2021-01-12T14:36:01.000Z. |'."\n" .'| EndFileUpdateTime | String | 2021-01-12T14:36:01.000Z | No | Queries the file metadata within a time range. The end of the file update time.
The time is a UTC timestamp in the ISO 8601 format: 2021-01-12T14:36:01.000Z. |'."\n" .'| StartTagUpdateTime | String | 2021-01-12T14:36:01.000Z | No | Queries the file metadata within a time range. The start of the last tag update time.
The time is a UTC timestamp in the ISO 8601 format: 2021-01-12T14:36:01.000Z.
This parameter is valid when QueryType is set to TAG or MIX. |'."\n" .'| EndTagUpdateTime | String | 2021-01-12T14:36:01.000Z | No | Queries the file metadata within a time range. The end of the last tag update time.
The time is a UTC timestamp in the ISO 8601 format: 2021-01-12T14:36:01.000Z.
This parameter is valid when QueryType is set to TAG or MIX. |'."\n" .'| TopK | Integer | 100 | No | The maximum number of exported items. By default, there is no limit. |'."\n" .'| ScoreThreshold | Float | 0.6 | | The similarity score threshold. Only results with a score greater than the ScoreThreshold value are returned.
This parameter is valid when QueryType is set to VECTOR or MIX. |'."\n" .'| DatasetFileMetaIds | String | | No | A list of file metadata IDs. The maximum number of IDs is 20. |'."\n" ."\n" .'### Build and update metadata task'."\n" ."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{}'."\n" .'```'."\n" ."\n" .'### Revoke intelligent tagging task'."\n" ."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "intelligentTagJobId": "dsjob-gh6qaj1kvkf6yk7qx2"'."\n" .'}'."\n" .'```'."\n" ."\n" .'Field description:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| ------------------- | ------ | ------------------------ | -------- | ------------------------------------------------- |'."\n" .'| intelligentTagJobId | String | dsjob-gh6qaj1kvkf6yk7qx2 | Yes | The ID of the intelligent tagging task to revoke. |'."\n" ."\n" .'### Metadata import task'."\n" ."\n" .'Example using query conditions:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "srcDatasetId": "d-1234",'."\n" .' "srcDatasetVersion": "v1",'."\n" .' "srcWorkspaceId": "12729",'."\n" .' "query":'."\n" .' {'."\n" .' "QueryType": "TAG",'."\n" .' "QueryText": "",'."\n" .' "TopK": 100,'."\n" .' "ScoreThreshold": 0.6'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'Example using a pai\\_dataset\\_filemeta\\_manifest file:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "manifestUri":"oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml"'."\n" .'}'."\n" .'```'."\n" ."\n" .'Field description:'."\n" ."\n" .'| Field Name | Type | Example | Required | Description |'."\n" .'| ------------------ | ------ | ------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| srcDatasetId | String | dsjob-gh6qaj1kvkf6yk7qx2 | Yes (query-based) | The ID of the source dataset for the import. |'."\n" .'| srcDatasetVersion | String | v1 | Yes (query-based) | The version of the source dataset for the import. |'."\n" .'| srcWorkspaceId | String | 12729 | Yes (query-based) | The workspace of the source dataset for the import. |'."\n" .'| query | JSON | | No (query-based) | The query conditions applied to the source dataset version.
See: `QueryParams` |'."\n" .'| manifestUri | String | oss://bucket/export_path/d-mpdxv0lm9sndij7gpb-v1-2025-06-18-12-23-30/pai_dataset_filemeta_manifest.yaml | Yes (file-based) | The path of the source manifest file for the import.
Only OSS URIs without an endpoint are supported. |'."\n" .'| filteredAttributes | String | FileName,Uri,FileFingerPrint,DataSize,DataSize,FileUpdateTime,Tags.ai | No | By default, all attribute fields are imported.
If specified, the imported content contains only the specified attribute fields.
The fields are:
\\* FileName (required)
\\* Uri (required)
\\* FileFingerPrint (required)
\\* DataSize (required)
\\* FileType (required)
\\* ContentType (required)
\\* Comment
\\* MetaAttributes
\\* FileCreateTime
\\* FileUpdateTime
\\* Tags.user: custom tags
\\* Tags.user-delete-ai-tags: algorithm tags deleted by the user
\\* Tags.ai: aggregated algorithm tags from all tagging tasks |'."\n" .'| importMode | String | append | No | The import mode:
append (default): In append mode, files with the same URI are overwritten with the imported content.
replace: In replace mode, the original file metadata in the dataset version is deleted. |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJob'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateDatasetJobConfig' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260458', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wzlj****9ks92'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '454716'], 'ConfigType' => [ 'description' => 'The configuration type.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['MultimodalIntelligentTag' => 'Multimodal Intelligent Tag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], 'title' => '', 'example' => 'MultimodalIntelligentTag', ], 'Config' => ['description' => 'The configuration content.'."\n" .'The format is as follows:'."\n" ."\n" .'- MultimodalIntelligentTag'."\n" ."\n" .'{'."\n" .'"apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" .'}'."\n" ."\n" .'- MultimodalSemanticIndex'."\n" ."\n" .'{'."\n" .'"defaultModelId": "xxx",'."\n" .'"defaultModelVersion":"1.0.0"'."\n" .'}', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], 'DatasetVersion' => ['type' => 'string', 'required' => false, 'description' => 'The name of the dataset version.', 'title' => '', 'example' => 'v1'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'DatasetJobConfigId' => ['description' => 'The configuration ID.', 'type' => 'string', 'title' => '', 'example' => 'dscfg-xxxxxxxxxxxxxx'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatasetJobConfig', 'summary' => 'Creates a dataset Job configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJobConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxxxx\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateDatasetLabels' => [ 'path' => '/api/v1/datasets/{DatasetId}/labels', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48572', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => false, 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'description' => 'The list of labels.', 'type' => 'array', 'items' => ['description' => 'The labels to add to the dataset.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A083731B-4973-54D1-B324-E53****4DD44'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatasetLabels', 'summary' => 'Adds labels to a dataset.', 'description' => 'When you call this operation, note the following:'."\n" ."\n" .'- The key and value of a label must be a non-empty string with a maximum length of 128 characters.'."\n" ."\n" .'- A label key cannot start with aliyun, acs, http\\://, or https\\://.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A083731B-4973-54D1-B324-E53****4DD44\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateDatasetVersion' => [ 'summary' => 'Creates a dataset version.', 'path' => '/api/v1/datasets/{DatasetId}/versions', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232558', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain the dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Property' => [ 'description' => 'The property of the dataset. Valid values:'."\n" ."\n" .'- FILE: A file.'."\n" ."\n" .'- DIRECTORY: A folder.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'title' => '', 'example' => 'DIRECTORY', ], 'DataSourceType' => [ 'description' => 'The type of the data source. If you specify multiple types, separate them with commas (,). Valid values:'."\n" ."\n" .'- NAS: The data is stored in Alibaba Cloud File Storage (NAS).'."\n" ."\n" .'- OSS: The data is stored in Alibaba Cloud Object Storage Service (OSS).'."\n" ."\n" .'- CPFS'."\n" ."\n" .'Note: The DataSourceType of the version must be the same as the DataSourceType of the dataset. The system verifies this consistency when you create the version.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'title' => '', 'example' => 'OSS', ], 'Uri' => ['description' => 'The following examples show how to configure the URI:'."\n" ."\n" .'- If the data source type is OSS: `oss://bucket.endpoint/object`'."\n" ."\n" .'- If the data source type is NAS:'."\n" .' The format for a general-purpose NAS file system is `nas://.region/subpath/to/dir/`.'."\n" .' CPFS 1.0: `nas://.region/subpath/to/dir/`.'."\n" .' CPFS 2.0: `nas://.region//`.'."\n" .' CPFS 1.0 and CPFS 2.0 are distinguished by the format of the fsid. The format for CPFS 1.0 is cpfs-<8 ASCII characters>. The format for CPFS 2.0 is cpfs-<16 ASCII characters>.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/'], 'Labels' => [ 'description' => 'A list of tags for the dataset version.', 'type' => 'array', 'items' => ['description' => 'The tag.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'SourceType' => [ 'description' => 'The type of the data source. The default value is USER. Valid values:'."\n" ."\n" .'- PAI-PUBLIC-DATASET: a public dataset from PAI.'."\n" ."\n" .'- ITAG: a dataset generated from the annotation results of the iTAG module.'."\n" ."\n" .'- USER: a dataset registered by a user.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'title' => '', 'example' => 'USER', ], 'SourceId' => ['description' => 'The ID of the data source.'."\n" ."\n" .'- If SourceType is set to USER, you can customize the SourceId.'."\n" ."\n" .'- If SourceType is set to ITAG, which indicates a dataset generated from the annotation results of the iTAG module, SourceId is the task ID from iTAG.'."\n" ."\n" .'- If SourceType is set to PAI\\_PUBLIC\\_DATASET, which indicates a dataset created from a public PAI dataset, SourceId is empty by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'd-a0xbe5n03bhqof46ce'], 'Options' => ['description' => 'The extended field, which is a JSON string.'."\n" .'When DLC uses the dataset, you can configure the mountPath field to specify the default mount path for the dataset.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}'], 'Description' => ['description' => 'A custom description for the dataset version. This helps distinguish different dataset versions.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'This is a description of the dataset version.'], 'DataSize' => ['description' => 'The size of the space occupied by the dataset files. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '19000'], 'DataCount' => ['description' => 'The number of files in the dataset.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '300'], 'ImportInfo' => ['description' => 'The storage import configuration of the dataset. Supported storage types include OSS, NAS, and CPFS.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'{
'."\n" .'"region": "${region}",// The region ID.
'."\n" .'"bucket": "${bucket}",// The bucket name.
'."\n" .'"path": "${path}" // The file path.
'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'{
'."\n" .'"region": "${region}",// The region ID.
'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.
'."\n" .'"path": "${path}", // The file system path.
'."\n" .'"mountTarget": "${mount\\_target}" // The mount target of the file system.
'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS'."\n" ."\n" .''."\n" ."\n" .'{
'."\n" .'"region": "${region}",// The region ID.
'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.
'."\n" .'"protocolServiceId":"${protocol\\_service\\_id}", // The protocol service of the file system.
'."\n" .'"exportId": "${export\\_id}", // The exported directory of the file system.
'."\n" .'"path": "${path}", // The file system path.
'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'Intelligent Computing CPFS'."\n" ."\n" .''."\n" ."\n" .'{
'."\n" .'"region": "${region}",// The region ID.
'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.
'."\n" .'"path": "${path}", // The file system path.
'."\n" .'"mountTarget": "${mount\\_target}", // The mount target of the file system. This parameter is specific to the Intelligent Computing edition.
'."\n" .'"isVpcMount": boolean, // Specifies whether the mount target is in a VPC. This parameter is specific to the Intelligent Computing edition.
'."\n" .'}'."\n" ."\n" .'
', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD'], 'VersionName' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'title' => '', 'example' => 'v1'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatasetVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD\\",\\n \\"VersionName\\": \\"v1\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateDatasetVersionLabels' => [ 'summary' => 'Creates labels for a dataset version.', 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232578', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wzlj****9ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'description' => 'The list of labels.', 'type' => 'array', 'items' => ['description' => 'The label to add to the dataset version.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDatasetVersionLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersionLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateExperiment' => [ 'summary' => 'Creates an experiment.', 'path' => '/api/v1/experiments', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '206973', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '478**'], 'Labels' => [ 'title' => '', 'description' => 'The labels.', 'type' => 'array', 'items' => ['description' => 'A label.', 'required' => false, '$ref' => '#/components/schemas/LabelInfo', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'Name' => ['title' => '', 'description' => 'The name of the experiment. The name must meet the following requirements:'."\n" ."\n" .'- Start with an uppercase or lowercase letter.'."\n" ."\n" .'- Contain uppercase letters, lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- Be 1 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'exp-test'], 'ArtifactUri' => ['title' => '', 'description' => 'The default output path of artifacts for all tasks that are associated with the experiment. Only Object Storage Service (OSS) paths are supported.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/test'], 'Accessibility' => [ 'description' => 'The visibility of the experiment. It can be PRIVATE (visible only to the creator and the creator\'s Alibaba Cloud account) or PUBLIC (visible to all users). This parameter is optional. The default value is PRIVATE.', 'type' => 'string', 'required' => false, 'default' => 'PRIVATE', 'enum' => ['PRIVATE', 'PUBLIC'], 'title' => '', 'example' => 'PRIVATE', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'Request ID'], 'ExperimentId' => ['title' => '', 'description' => 'If the call is asynchronous, the API returns a JobId.', 'type' => 'string', 'example' => 'ExperimentId-example-id-****'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"Request ID\\",\\n \\"ExperimentId\\": \\"ExperimentId-example-id-****\\"\\n}","type":"json"}]', 'title' => 'CreateExperiment', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateExperiment'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:CreateExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateImageBuild' => [ 'summary' => 'Builds a custom image based on the specified configuration. After the image is successfully built, it is added to the list of custom images in the current workspace.', 'path' => '/api/v1/imagebuilds', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '259250', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['type' => 'string', 'title' => '', 'description' => 'An idempotence token.', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Accessibility' => [ 'description' => 'The visibility of the image.'."\n" ."\n" .'- **PUBLIC**: The image is public.'."\n" ."\n" .'- **PRIVATE**: The image is private.', 'type' => 'string', 'title' => '', 'required' => false, 'enumValueTitles' => ['PUBLIC' => '', 'PRIVATE' => ''], 'example' => 'PUBLIC', ], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12345'], 'Resource' => [ 'description' => 'The resources used to run the task.', 'type' => 'object', 'properties' => [ 'EcsSpec' => ['description' => 'The instance type of the pay-as-you-go resource. This parameter is required when you use the public resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ecs.c6.large'], 'ResourceConfig' => [ 'type' => 'object', 'properties' => [ 'CPU' => ['type' => 'string', 'description' => 'The number of CPU cores.', 'required' => false, 'title' => '', 'example' => '4'], 'Memory' => ['type' => 'string', 'description' => 'The memory size.', 'required' => false, 'title' => '', 'example' => '8Gi'], ], 'description' => 'The resource configuration. Specify this parameter when you use subscription resources. Leave it empty when you use the public resource group.', 'required' => false, 'title' => '', 'example' => '', ], 'ResourceId' => ['type' => 'string', 'description' => 'The resource quota ID. This parameter applies only to subscription resources. Do not set this parameter for pay-as-you-go resources.', 'required' => false, 'title' => '', 'example' => 'quotaadzoqup693z'], 'ResourceType' => [ 'type' => 'string', 'title' => '', 'description' => 'The type of the subscription resource. Currently, only Lingjun resources are supported. Specify this parameter when you use subscription resources.', 'required' => false, 'enumValueTitles' => ['Lingjun' => ''], 'example' => 'Lingjun', ], ], 'required' => true, 'title' => '', 'example' => '', ], 'UserVpc' => [ 'description' => 'The information about the user\'s virtual private cloud (VPC). This parameter is required when you use the public resource group.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID. If the build task needs to access your ACR Enterprise Edition instance, specify a VPC that is in the access control list of the instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vpc-abcdef**'], 'SwitchId' => ['description' => 'The vSwitch ID. This parameter is optional.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vs-abcdef**'], 'SecurityGroupId' => ['description' => 'The security group ID. This parameter is required when you configure a VPC.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sg-abcdef**'], 'ExtendedCidrs' => [ 'description' => 'The extended CIDR blocks.'."\n" ."\n" .'- If you do not specify a vSwitch ID, you can leave this parameter empty. The system automatically obtains all CIDR blocks of the VPC.'."\n" ."\n" .'- If you specify a vSwitch ID, you must specify this parameter. For best results, include all CIDR blocks of the VPC.', 'type' => 'array', 'items' => ['description' => 'An extended CIDR block.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '10.0.0.0/24'], 'title' => '', 'required' => false, 'example' => '', ], 'DefaultRoute' => ['description' => 'The default route.'."\n" ."\n" .'- eth1: Indicates that the user\'s elastic network interface (ENI) is used to access the external network through a private gateway. For more information, see [Configure a Distribution Switch (DSW) instance to access the Internet through a private NAT gateway](https://help.aliyun.com/zh/pai/user-guide/configure-a-dsw-instance-to-access-the-internet-through-a-private-nat-gateway?spm=a2c4g.11186623.0.0.3b3965f6SZWm85).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'eth1'], ], 'title' => '', 'required' => false, 'example' => '', ], 'TargetRegistry' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['type' => 'string', 'description' => 'The ID of the image repository instance. This parameter is required when you use ACR as the image repository.', 'required' => false, 'title' => '', 'example' => 'cri-**abcd'], 'Type' => ['type' => 'string', 'required' => true, 'description' => 'The type of the target image repository. Only ACR Enterprise Edition is supported.', 'title' => '', 'example' => 'AcrEnterprise'], ], 'required' => true, 'title' => '', 'description' => '**The configuration of the target image repository.**', 'example' => '', ], 'OverwriteImageTag' => ['description' => 'Specifies whether to overwrite an existing image version in the image repository.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], 'BuildConfig' => [ 'description' => '**The build configuration. Specify the content of the Dockerfile to be built.**', 'type' => 'object', 'properties' => [ 'Dockerfile' => ['description' => 'The content of the Dockerfile to be built.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'FROM ubuntu:18:04'."\n" .'RUN pip3 install numpy==1.19.5'], 'BuildType' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The build type. The following types are supported:'."\n" ."\n" .'- **PackageInstallation**: Installs software packages based on a specified image.'."\n" ."\n" .'- **CustomDockerfile**: Builds an image based on a custom Dockerfile.', 'example' => 'PackageInstallation'], 'RegistryAuths' => ['type' => 'object', 'title' => '', 'description' => 'The authentication information for the private image repository. You can specify the authentication information for an ACR image repository that does not belong to you. The format is \\`{"user\\_registry\\_domain":{"Auth":"base64 encoded auth"}}\\`.', 'required' => false, 'example' => '{'."\n" .' "user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com": {'."\n" .' "Auth": "dXNlcjp0ZXN0"'."\n" .' }'."\n" .'}'], ], 'required' => true, 'title' => '', 'example' => '', ], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-wulanchabu'], 'ImageBuildJobName' => ['type' => 'string', 'title' => '', 'description' => 'The name of the image build task.', 'required' => false, 'example' => 'build-my-image'], 'Image' => [ 'type' => 'object', 'properties' => [ 'Name' => ['type' => 'string', 'required' => true, 'description' => 'The name of the image. The name must meet the following requirements:'."\n" ."\n" .'- The name must be 1 to 50 characters in length.'."\n" ."\n" .'- The name can contain lowercase letters, digits, and hyphens (-). It must start with a letter.'."\n" ."\n" .'- The name must be unique within the same workspace.', 'title' => '', 'example' => 'test-v1'], 'Description' => ['type' => 'string', 'description' => 'The description of the image.', 'required' => false, 'title' => '', 'example' => 'Build test image'], 'Uri' => ['type' => 'string', 'required' => true, 'description' => 'The image URL.', 'title' => '', 'example' => 'user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com/pai-test/pai-test:test-v1'], 'Labels' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['type' => 'string', 'description' => 'The key of the image label.', 'required' => false, 'title' => '', 'example' => 'key1'], 'Value' => ['type' => 'string', 'description' => 'The value of the image label.', 'required' => false, 'title' => '', 'example' => 'value1'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The image labels.', 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'description' => 'The metadata of the image.', 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'description' => 'The request body.', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ImageBuildId' => ['description' => 'The image build ID.', 'type' => 'string', 'title' => '', 'example' => 'build-****ks92'], 'ImageBuildJobId' => ['type' => 'string', 'title' => '', 'description' => 'The build task ID.', 'example' => 'dlc-****ks92'], ], 'title' => '', 'description' => 'The response that is returned.', 'example' => '', ], ], ], 'title' => 'CreateImageBuild', 'description' => '## Description', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:CreateImageBuild', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageBuildId\\": \\"build-****ks92\\",\\n \\"ImageBuildJobId\\": \\"dlc-****ks92\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateMember' => [ 'summary' => 'Adds one or more users to a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/members', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the workspace. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'Members' => [ 'title' => '', 'description' => 'The list of members.', 'type' => 'array', 'items' => [ 'description' => 'The member details.', 'type' => 'object', 'properties' => [ 'UserId' => ['title' => '', 'description' => 'The member IDs. Use commas (,) to separate multiple IDs. For more information, see [ListMembers](~~449135~~).', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039,145883-2769726******87513'], 'Roles' => [ 'title' => '', 'description' => 'The list of roles.', 'type' => 'array', 'items' => ['description' => 'The name of the role. For more information about the mapping between roles and permissions, see [List of roles and permissions](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission).'."\n" .'The following roles are supported:'."\n" ."\n" .'- PAI.AlgoDeveloper: Algorithm Developer.'."\n" ."\n" .'- PAI.AlgoOperator: Algorithm O\\&M.'."\n" ."\n" .'- PAI.LabelManager: Labeling Manager.'."\n" ."\n" .'- PAI.MaxComputeDeveloper: MaxCompute Developer.'."\n" ."\n" .'- PAI.WorkspaceAdmin: Administrator.'."\n" ."\n" .'- PAI.WorkspaceGuest: Guest.'."\n" ."\n" .'- PAI.WorkspaceOwner: Owner.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PAI.AlgoDeveloper'], 'required' => true, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'], 'Members' => [ 'title' => '', 'description' => 'The list of members.', 'type' => 'array', 'items' => [ 'description' => 'The member details.', 'type' => 'object', 'properties' => [ 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '21513926******88039'."\n"], 'Roles' => [ 'title' => '', 'description' => 'The list of roles.', 'type' => 'array', 'items' => ['description' => 'The role name. For more information about the mapping between roles and permissions, see [List of roles and permissions](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission).'."\n" .'Possible values:'."\n" ."\n" .'- PAI.AlgoDeveloper: Algorithm Developer'."\n" ."\n" .'- PAI.AlgoOperator: Algorithm O\\&M'."\n" ."\n" .'- PAI.LabelManager: Labeling Manager'."\n" ."\n" .'- PAI.MaxComputeDeveloper: MaxCompute Developer'."\n" ."\n" .'- PAI.WorkspaceAdmin: Administrator'."\n" ."\n" .'- PAI.WorkspaceGuest: Guest'."\n" ."\n" .'- PAI.WorkspaceOwner: Owner', 'type' => 'string', 'title' => '', 'example' => 'PAI.AlgoDeveloper'], 'example' => '', ], 'DisplayName' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'example' => 'myDisplayName'], 'MemberId' => ['title' => '', 'description' => 'The member ID.', 'type' => 'string', 'example' => '145883-21513926******88039'."\n"], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'CreateMember', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:CreateMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"21513926******88039\\\\n\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateModel' => [ 'summary' => 'Creates a model, which is a collection of model versions. You must specify information such as the model name and description.', 'path' => '/api/v1/models', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133752', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ModelName' => ['title' => '', 'description' => 'The name of the model. The name must be 1 to 127 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'News classification'], 'Labels' => [ 'title' => '', 'description' => 'A list of labels. This parameter is deprecated and is replaced by the Tag parameter.', 'type' => 'array', 'items' => ['description' => 'A label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'Tag' => [ 'title' => '', 'description' => 'A list of tags.', 'type' => 'array', 'items' => ['description' => 'A tag. This is the same as a label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'ModelDescription' => ['title' => '', 'description' => 'The description of the model. Use this to distinguish different models.', 'type' => 'string', 'required' => false, 'example' => 'News classification.'], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '796**'], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the model in the workspace. Valid values:'."\n" ."\n" .'- PRIVATE (default): The model is visible only to you and administrators in the workspace.'."\n" ."\n" .'- PUBLIC: The model is visible to everyone in the workspace.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'example' => 'PRIVATE', ], 'Origin' => ['title' => '', 'description' => 'The source of the model. This specifies the community or organization that the source model belongs to, such as ModelScope and HuggingFace.', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], 'Domain' => ['title' => '', 'description' => 'The domain. This describes the field that the model is designed for, such as nlp (Natural Language Processing) or cv (computer vision).', 'type' => 'string', 'required' => false, 'example' => 'nlp'], 'Task' => ['title' => '', 'description' => 'The task. This describes the specific problem that the model solves, such as text-classification (text classification).', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], 'ModelDoc' => ['title' => '', 'description' => 'The model documentation.', 'type' => 'string', 'required' => false, 'example' => 'https://*.md'], 'OrderNumber' => ['title' => '', 'description' => 'The ordinal number of the model. You can use this for custom sorting.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], 'ModelType' => ['title' => '', 'description' => 'The model type, such as Checkpoint or LoRA.', 'type' => 'string', 'required' => false, 'example' => 'Checkpoint'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information about the model.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "RatingCount": 2866,'."\n" .' "Rating": 4.94,'."\n" .' "FavoriteCount": 34992,'."\n" .' "CommentCount": 754,'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" .' "TippedAmountCount": 32,'."\n" .' "DownloadCount": 606056'."\n" .'}'], 'ParameterSize' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of parameters, in millions.', 'required' => false, 'title' => '', 'example' => '3000'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DAD3112-AE22-5563-9A02-5C7E8****E35'], 'ModelId' => ['description' => 'The model ID.', 'type' => 'string', 'title' => '', 'example' => 'model-rbvg5wzljz****ks92'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DAD3112-AE22-5563-9A02-5C7E8****E35\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\"\\n}","type":"json"}]', 'title' => 'CreateModel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateModelLabels' => [ 'summary' => 'Creates labels for a model.', 'path' => '/api/v1/models/{ModelId}/labels', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133787', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-1dkasjfhds23dft'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'description' => 'The list of labels.', 'type' => 'array', 'items' => ['description' => 'The label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F81D9EC0-1872-50F5-A96C-A0647D****1D'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateModelLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F81D9EC0-1872-50F5-A96C-A0647D****1D\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateModelVersion' => [ 'summary' => 'Adds a new version to a specified model.', 'path' => '/api/v1/models/{ModelId}/versions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133771', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'VersionName' => ['title' => '', 'description' => 'The model version. The version must be unique within the model. If you do not specify this parameter, the first version defaults to **0.1.0**. The minor version number is then incremented by 1 for each subsequent version. For example, the second version defaults to **0.2.0**.'."\n" .'A version number consists of a major version, a minor version, and a patch version, separated by periods (.). The major and minor versions are numbers. The patch version can start with a number and contain underscores (\\_) and letters. Examples: 1.1.0 and 2.3.4\\_beta.', 'type' => 'string', 'required' => false, 'example' => '0.1.0'], 'Uri' => ['title' => '', 'description' => 'The URI of the model version, which is the storage location of the model. The following types of model URIs are supported:'."\n" ."\n" .'- An HTTP or HTTPS URL of the model. Example: `https://myweb.com/mymodel.tar.gz`.'."\n" ."\n" .'- If the model is stored in Object Storage Service (OSS), the URI must be in the `oss://./object` format. For more information about endpoints, see [Endpoints](~~31837~~). Example: `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.', 'type' => 'string', 'required' => true, 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/'], 'Labels' => [ 'title' => '', 'description' => 'The list of labels.', 'type' => 'array', 'items' => ['description' => 'A label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'VersionDescription' => ['title' => '', 'description' => 'The description of the model version.', 'type' => 'string', 'required' => false, 'example' => 'Sentiment analysis.'], 'FormatType' => [ 'title' => '', 'description' => 'The format of the model. Valid values:'."\n" ."\n" .'- OfflineModel'."\n" ."\n" .'- SavedModel'."\n" ."\n" .'- Keras H5'."\n" ."\n" .'- Frozen Pb'."\n" ."\n" .'- Caffe Prototxt'."\n" ."\n" .'- TorchScript'."\n" ."\n" .'- XGBoost'."\n" ."\n" .'- PMML'."\n" ."\n" .'- AlinkModel'."\n" ."\n" .'- ONNX', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], 'example' => 'SavedModel', ], 'FrameworkType' => [ 'title' => '', 'description' => 'The framework of the model. Valid values:'."\n" ."\n" .'- Pytorch'."\n" ."\n" .'- XGBoost'."\n" ."\n" .'- Keras'."\n" ."\n" .'- Caffe'."\n" ."\n" .'- Alink'."\n" ."\n" .'- Xflow'."\n" ."\n" .'- TensorFlow', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], 'example' => 'TensorFlow', ], 'Options' => ['title' => '', 'description' => 'The extended fields. This parameter is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}'], 'Metrics' => ['title' => '', 'description' => 'The model metrics.'."\n" .'The serialized data cannot exceed 8,192 bytes in length.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "Results": [{'."\n" .' "Dataset": {'."\n" .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.175'."\n" .' }'."\n" .' }, {'."\n" .' "Dataset": {'."\n" .' "Uri": "oss://xxxx/"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.172'."\n" .' }'."\n" .' }]'."\n" .'}'], 'TrainingSpec' => ['title' => '', 'description' => 'The training configurations. These configurations are used for fine-tuning and incremental training.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'InferenceSpec' => ['title' => '', 'description' => 'The configurations for downstream inference services, such as the processor and container for Elastic Algorithm Service (EAS). Example:'."\n" .'`{ "processor": "tensorflow_gpu_1.12" }`', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "processor": "tensorflow_gpu_1.12"'."\n" .'}'], 'SourceType' => [ 'title' => '', 'description' => 'The source type of the model. Valid values:'."\n" ."\n" .'- Custom (default): The model is custom.'."\n" ."\n" .'- PAIFlow: The model is from a PAI pipeline.'."\n" ."\n" .'- TrainingService: The model is from a PAI training service.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], 'SourceId' => ['title' => '', 'description' => 'The source ID.'."\n" ."\n" .'- If SourceType is set to Custom, this parameter has no format restrictions.'."\n" ."\n" .'- If SourceType is PAIFlow or TrainingService, the value must be in the following format:'."\n" ."\n" .'```'."\n" .'region=,workspaceId=,kind=,id='."\n" .'```'."\n" ."\n" .'The fields are described as follows:'."\n" ."\n" .'- region: The ID of the Alibaba Cloud region.'."\n" ."\n" .'- workspaceId: The ID of the workspace.'."\n" ."\n" .'- kind: The type. Valid values: PipelineRun (PAI pipeline) and ServiceJob (training service).'."\n" ."\n" .'- id: The unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" ."\n" .'- Pending: The version is pending approval.'."\n" ."\n" .'- Approved: The version is approved for deployment.'."\n" ."\n" .'- Rejected: The version is rejected for deployment.', 'type' => 'string', 'required' => false, 'example' => 'Approved'], 'EvaluationSpec' => ['title' => '', 'description' => 'The evaluation configurations.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'CompressionSpec' => ['title' => '', 'description' => 'The compression configurations.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" .' "TrainedWords": ["albedo_overlord"]'."\n" .'}'], 'DistillationSpec' => ['type' => 'object', 'description' => 'The distillation configurations.', 'required' => false, 'title' => '', 'example' => '{}'], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information about how to obtain the model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-dfs1****5c'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '21645FCD-BAB9-5742-89AE-AEB27****B2E'], 'VersionName' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'example' => '0.1.0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21645FCD-BAB9-5742-89AE-AEB27****B2E\\",\\n \\"VersionName\\": \\"0.1.0\\"\\n}","type":"json"}]', 'title' => 'CreateModelVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateModelVersionLabels' => [ 'summary' => 'Creates labels for a model version.', 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133790', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'title' => '', 'description' => 'A list of labels.', 'type' => 'array', 'items' => ['description' => 'A label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateModelVersionLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersionLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'CreateProductOrders' => [ 'summary' => 'Purchases products. This operation supports pay-as-you-go purchases of DataWorks, OSS, PAI, and MaxCompute.', 'path' => '/api/v1/productorders', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '75124', 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The purchase request.', 'type' => 'object', 'properties' => [ 'AutoPay' => ['title' => '', 'description' => 'Specifies whether to automatically pay for all products listed in the Products parameter.'."\n" ."\n" .'- true: Enables automatic payment.'."\n" ."\n" .'- false: Disables automatic payment.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'Products' => [ 'description' => 'The list of products to purchase.', 'type' => 'array', 'items' => [ 'description' => 'The product to purchase.', 'type' => 'object', 'properties' => [ 'AutoRenew' => [ 'description' => 'Specifies whether to enable auto-renewal.'."\n" ."\n" .'- true: Enables auto-renewal.'."\n" ."\n" .'- false: Disables auto-renewal.', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'title' => '', 'example' => 'true', ], 'ProductCode' => [ 'description' => 'The product code. The following codes are supported:'."\n" ."\n" .'- DataWorks\\_share: The pay-as-you-go DataWorks product.'."\n" ."\n" .'- MaxCompute\\_share: The pay-as-you-go MaxCompute product.'."\n" ."\n" .'- PAI\\_share: The pay-as-you-go PAI product.'."\n" ."\n" .'- OSS\\_share: The pay-as-you-go OSS product.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['MaxCompute_share' => 'MaxCompute\\_share', 'OSS_share' => 'OSS\\_share', 'DataWorks_share' => 'DataWorks\\_share', 'PAI_share' => 'PAI\\_share'], 'title' => '', 'example' => 'DataWorks_share', ], 'ChargeType' => [ 'description' => 'The billing method. Currently, only POSTPAY is supported.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['POSTPAY' => 'POSTPAY'], 'title' => '', 'example' => 'POSTPAY', ], 'OrderType' => [ 'description' => 'The order type. Currently, only BUY is supported.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['BUY' => 'BUY'], 'title' => '', 'example' => 'BUY', ], 'PricingCycle' => [ 'description' => 'The billing cycle. The following values are supported:'."\n" ."\n" .'- Month: Monthly billing. Only DataWorks\\_share supports this value.'."\n" ."\n" .'- Hour: Hourly billing. Only OSS\\_share and MaxCompute\\_share support this value.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['Month' => 'Month', 'Hour' => 'Hour'], 'title' => '', 'example' => 'Month', ], 'Duration' => ['description' => 'The subscription duration. This parameter is used with PricingCycle. Currently, only a value of 1 is supported.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1'], 'InstanceProperties' => [ 'description' => 'The list of instance properties.'."\n" ."\n" .'- DataWorks\\_share:'."\n" .' \\[ {'."\n" .' "Code": "region",'."\n" .' "Value": "cn-shanghai"'."\n" .' }'."\n" .' ]'."\n" ."\n" .'- OSS\\_share:'."\n" .' \\[ {'."\n" .' "Code": "commodity\\_type",'."\n" .' "Value": "oss",'."\n" .' "Name": "Object Storage Service"'."\n" .' },'."\n" .' {'."\n" .' "Code": "ord\\_time",'."\n" .' "Value": "1:Hour",'."\n" .' "Name": "1 Hour"'."\n" .' }'."\n" .' ]'."\n" ."\n" .'- PAI\\_share: None'."\n" ."\n" .'- MaxCompute\\_share for accounts in mainland China:'."\n" .' \\['."\n" .' {'."\n" .' "Code": "region",'."\n" .' "Value": "cn-hangzhou"'."\n" .' },'."\n" .' {'."\n" .' "Code": "odps\\_specification\\_type",'."\n" .' "Value": "OdpsStandard"'."\n" .' },'."\n" .' {'."\n" .' "Code": "ord\\_time",'."\n" .' "Value": "1:Hour"'."\n" .' }'."\n" .' ]'."\n" ."\n" .'- MaxCompute\\_share for accounts outside mainland China:'."\n" .' \\['."\n" .' {'."\n" .' "Code": "region",'."\n" .' "Value": "cn-hangzhou"'."\n" .' },'."\n" .' {'."\n" .' "Code": "ord\\_time",'."\n" .' "Value": "1:Hour"'."\n" .' }'."\n" .' ]', 'type' => 'array', 'items' => [ 'description' => 'The instance property information.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The code of the instance property.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'commodity_type'], 'Name' => ['description' => 'The name of the instance property.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Object Storage Service'], 'Value' => ['description' => 'The value of the instance property.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oss'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ksdjf-jksd-*****slkdjf'], 'OrderId' => ['title' => '', 'description' => 'The ID of the purchase order.', 'type' => 'string', 'example' => '210292536260646'], 'Message' => ['title' => '', 'description' => 'The message returned for the purchase.', 'type' => 'string', 'example' => 'Normal'], 'BuyProductRequestId' => ['title' => '', 'description' => 'The ID of the product purchase request.', 'type' => 'string', 'example' => '3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb'], 'ProductIds' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ksdjf-jksd-*****slkdjf\\",\\n \\"OrderId\\": \\"210292536260646\\",\\n \\"Message\\": \\"Normal\\",\\n \\"BuyProductRequestId\\": \\"3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\",\\n \\"ProductIds\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', 'title' => 'CreateProductOrders', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProductOrders'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'pai:CreateOrder', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateRun' => [ 'summary' => 'Creates a run for an experiment. The run can be associated with a specific workload or be a standalone code execution.', 'path' => '/api/v1/runs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '233339', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the run. The naming convention is as follows:'."\n" ."\n" .'- Starts with a lowercase or uppercase letter.'."\n" ."\n" .'- Can contain lowercase letters, uppercase letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- The length must be 1 to 63 characters.'."\n" ."\n" .'If this parameter is left empty, the server-generated random ID (RunID) is used as the name.', 'type' => 'string', 'required' => false, 'example' => 'myName'], 'SourceType' => ['title' => '', 'description' => 'The source type of the PAI workload associated with the run. Options include TrainingService, DLC, or empty. This parameter is optional. The default value is empty.', 'type' => 'string', 'required' => false, 'example' => 'DLC'], 'SourceId' => ['title' => '', 'description' => 'The ID of the PAI workload associated with the run.', 'type' => 'string', 'required' => false, 'example' => 'job-jdnhf***fnrimv'], 'ExperimentId' => ['title' => '', 'description' => 'The ID of the experiment associated with the run.', 'type' => 'string', 'required' => true, 'example' => 'exp-6thbb5xrbmp*****'], 'Labels' => [ 'title' => '', 'description' => 'The list of labels for the run.', 'type' => 'array', 'items' => ['description' => 'The details of the label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'Params' => [ 'description' => 'The list of parameters for the run.', 'type' => 'array', 'items' => ['description' => 'The details of the parameter.', 'required' => false, '$ref' => '#/components/schemas/RunParam', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], 'RunId' => ['description' => 'The ID of the run.', 'type' => 'string', 'title' => '', 'example' => 'run-1meoz7VJd2C6f****'], ], 'example' => '', ], ], ], 'title' => 'CreateRun', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateRun'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:CreateRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"RunId\\": \\"run-1meoz7VJd2C6f****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateWorkspace' => [ 'summary' => 'Creates a workspace.', 'path' => '/api/v1/workspaces', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '14204', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request structure.', 'type' => 'object', 'properties' => [ 'WorkspaceName' => ['title' => '', 'description' => 'The name of the workspace. The format is as follows:'."\n" .'- The length is 3 to 23 characters and can contain letters, underscores (_), or digits.'."\n" .'- It must start with a letter (uppercase or lowercase).'."\n" .'- It must be unique within the current region.', 'type' => 'string', 'required' => true, 'example' => 'workspace_example'], 'Description' => ['title' => '', 'description' => 'The description of the workspace. The description cannot exceed 80 characters in length.', 'type' => 'string', 'required' => true, 'example' => '这是一个工作空间描述示例。'], 'DisplayName' => ['title' => '', 'description' => 'We recommend that you name the workspace based on its business attribute to facilitate identification of its purpose. If you do not configure this parameter, the workspace name is used by default.', 'type' => 'string', 'example' => 'demo工作空间', 'required' => false], 'EnvTypes' => [ 'title' => '', 'description' => 'The environments included in the workspace:'."\n" .'- The simple mode contains only the production environment (prod).'."\n" .'- The standard mode contains both the development environment (dev) and the production environment (prod).', 'type' => 'array', 'items' => ['description' => 'The environment type. Valid values:'."\n" ."\n" .'- dev: development environment.'."\n" .'- prod: production environment.', 'type' => 'string', 'required' => true, 'example' => 'dev', 'title' => ''], 'required' => true, 'example' => '', ], 'ResourceGroupId' => ['description' => 'The resource group ID. For information about how to obtain the resource group ID, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwp7rkyq****', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '12**'], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"WorkspaceId\\": \\"12**\\"\\n}","type":"json"}]', 'title' => 'Create a workspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateWorkspaceResource' => [ 'summary' => 'Add a resource reference to a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATURElearnC5P7SW'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the workspace. To obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Resources' => [ 'title' => '', 'description' => 'The list of resources.', 'type' => 'array', 'items' => [ 'description' => 'The resource details.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The resource name. The name must meet the following requirements:'."\n" ."\n" .'- Must be 3 to 28 characters long, start with a letter, and can contain only letters, digits, and underscores (\\_).'."\n" ."\n" .'- Must be unique within the same region.'."\n" ."\n" .'- If `Option` is set to `Attach` and `ResourceType` is set to `MaxCompute`, this parameter specifies the project name.', 'type' => 'string', 'required' => true, 'example' => 'ResourceName', 'title' => ''], 'ProductType' => ['description' => '**\\[Deprecated]** This parameter is deprecated and will be removed in a future version. Use the `ResourceType` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], 'EnvType' => ['description' => 'The environment type. Valid values:'."\n" ."\n" .'- `dev`: development environment'."\n" ."\n" .'- `prod`: production environment', 'type' => 'string', 'required' => true, 'example' => 'prod', 'title' => ''], 'WorkspaceId' => ['description' => 'The ID of the workspace to which the resource belongs. To obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether this is the default resource for its type. Each resource type can have only one default resource.'."\n" ."\n" .'- `false` (default): The resource is not the default resource.'."\n" ."\n" .'- `true`: The resource is the default resource.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], 'Quotas' => [ 'description' => 'The resource quotas. Currently, only MaxCompute resources have resource quotas.', 'type' => 'array', 'items' => [ 'description' => 'A resource quota.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ID of the resource quota. To obtain the resource quota ID, see [ListQuotas](~~449144~~). This parameter is required only for subscription MaxCompute resources.'."\n" .'For ECS, Lingjun, and ACS resources, you do not need to specify this parameter. Their quota information is configured in the `Spec` parameter.', 'type' => 'string', 'required' => false, 'example' => '232892******92912', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'Spec' => ['description' => 'The resource specification in JSON format. For ECS and Lingjun resources, the format is as follows:'."\n" .'{
'."\n" .'"clusterType": "The type of the cluster",'."\n" .'"resourceId": "The ID of the quota",'."\n" .'"resourceName": "The name of the quota"'."\n" .'}'."\n" .'The `clusterType` parameter can have the following values:
'."\n" ."\n" .'- `share`: shared resource group'."\n" ."\n" .'- `private`: dedicated resource group'."\n" ."\n" .'- `FullyManaged`: fully managed ACS resource', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "clusterType": "private",'."\n" .' "resourceId": "quota1c******b4",'."\n" .' "resourceName": "unif******90"'."\n" .' }'."\n", 'title' => ''], 'GroupName' => ['description' => 'The name of the resource group. The name must be unique within an Alibaba Cloud account. This parameter is required for MaxCompute, ECS, Lingjun, ACS, and Flink resources.', 'type' => 'string', 'required' => false, 'example' => 'groupName', 'title' => ''], 'ResourceType' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- `MaxCompute`: MaxCompute resources'."\n" ."\n" .'- `ECS`: general-purpose computing resources'."\n" ."\n" .'- `Lingjun`: Lingjun intelligent computing resources'."\n" ."\n" .'- `ACS`: ACS computing resources'."\n" ."\n" .'- `Flink`: Flink resources'."\n" ."\n" .'- `SelfManagedAckPro`: unified managed cluster resource (AckPro)'."\n" ."\n" .'- `SelfManagedAckLingjun`: unified managed cluster resource (AckLingjun)'."\n" ."\n" .'- `SelfManagedASI`: unified managed cluster resource for third-party clouds (ASI)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], 'Labels' => [ 'description' => 'An array of resource tags.', 'type' => 'array', 'items' => [ 'description' => 'A resource tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'system.support.eas', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'Option' => ['description' => 'The creation behavior. Valid values:'."\n" ."\n" .'- `CreateAndAttach`: Creates a resource and attaches it to the workspace.'."\n" ."\n" .'- `Attach`: Attaches an existing resource to the workspace. This option requires you to specify the `Name`, `ResourceType`, `GroupName`, and `EnvType` parameters.'."\n" ."\n" .'> MaxCompute resources only support the `Attach` option.', 'type' => 'string', 'required' => false, 'example' => 'CreateAndAttach', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde', 'title' => ''], 'Resources' => [ 'title' => '', 'description' => 'A list of resources.', 'type' => 'array', 'items' => [ 'description' => 'The details of a resource.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => '1234', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"1234\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', 'title' => 'CreateWorkspaceResource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspaceResource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateWorkspaceRole' => [ 'summary' => 'Creates a workspace role.', 'path' => '/api/v1/workspaces/{WorkspaceId}/roles', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221935', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. You can call the [ListWorkspaces](~~449124~~) operation to obtain the workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'RoleName' => ['description' => 'The unique name for the custom role within the workspace. It can contain letters, digits, underscores (\\_), and hyphens (-), and be up to 64 characters long.', 'type' => 'string', 'required' => false, 'example' => 'dev-test', 'title' => ''], 'RoleType' => ['description' => 'The role type. This operation only creates custom roles. Valid value: custom.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], 'ModulePermissions' => ['description' => 'The permission settings for the role.', '$ref' => '#/components/schemas/ModulePermissions', 'required' => false, 'title' => '', 'example' => ''], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A519F77D-28A0-52F5-AB82-5********8', 'title' => ''], 'InstanceJobId' => ['description' => 'The job ID for the request.', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole-role-***abc*******', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'AIWorkSpace::2021-02-04::GetInstanceJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 20], 'title' => 'CreateWorkspaceRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:AddWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\",\\n \\"InstanceJobId\\": \\"CreateWorkspaceCustomRole-role-***abc*******\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteCodeSource' => [ 'summary' => 'Deletes a code source configuration by its ID.', 'path' => '/api/v1/codesources/{CodeSourceId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55455', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'CodeSourceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the code source configuration to delete. For more information, see [ListCodeSources](~~459922~~).', 'type' => 'string', 'required' => true, 'example' => 'code-20210111103721-85qz78ia96lu'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'CodeSourceId' => ['title' => '', 'description' => 'The ID of the deleted code source configuration.', 'type' => 'string', 'example' => 'code-20210111103721-85qz78ia96lu'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteCodeSource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCodeSource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paicodesource:DeleteCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteConfig' => [ 'summary' => 'Deletes a workspace configuration.', 'path' => '/api/v1/workspaces/{WorkspaceId}/configs/{ConfigKey}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '117762', 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '98***'], ], [ 'name' => 'ConfigKey', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: The temporary storage path. This key is valid only when CategoryName is CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: The automatic release configuration. This key is valid only when CategoryName is DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: The priority configuration. This key is valid only when CategoryName is DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: The maximum runtime configuration of a DLC task for a quota. This key is valid only when CategoryName is QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: The predefined tags for the workspace. Resources that you create must have these tags.', 'type' => 'string', 'required' => true, 'example' => 'tempStoragePath'], ], [ 'name' => 'CategoryName', 'in' => 'query', 'schema' => ['description' => 'The classification of the configuration item. The following classifications are supported:'."\n" ."\n" .'- DLCAutoRecycle: The DLC automatic release configuration.'."\n" ."\n" .'- DLCPriorityConfig: The DLC priority settings.'."\n" ."\n" .'- DSWPriorityConfig: The DSW priority settings.'."\n" ."\n" .'- QuotaMaximumDuration: The maximum runtime configuration of a DLC task for a quota.'."\n" ."\n" .'- CommonTagConfig: The tag settings.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CommonResourceConfig'], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['description' => 'The filter conditions. Separate multiple conditions with commas. The conditions are combined with a logical AND.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1=value;key2=value2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], ], 'example' => '', ], ], ], 'title' => 'DeleteConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteConnection' => [ 'path' => '/api/v1/connections/{ConnectionId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267624', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'ConnectionId', 'in' => 'path', 'schema' => ['description' => 'The connection ID. For more information, see [ListConnections](url).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'conn-pai9m***mi47'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'title' => 'DeleteConnection', 'summary' => 'Deletes a connection.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDataset' => [ 'summary' => 'Deletes a dataset.', 'path' => '/api/v1/datasets/{DatasetId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48570', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wzlj****9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetFileMetas' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260630', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace where the dataset is located. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '132602'], ], [ 'name' => 'DatasetFileMetaIds', 'in' => 'query', 'schema' => ['description' => 'The ID of the dataset file metadata.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Status' => ['description' => 'The status of the batch deletion. A value of \\`true\\` indicates that all metadata records were deleted. If the value is \\`false\\`, check the \\`FailedDetails\\` parameter for more information.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'FailedDetails' => [ 'description' => 'A list of file metadata records that failed to be deleted.', 'type' => 'array', 'items' => ['description' => 'The details of a file metadata record that failed to be deleted.', '$ref' => '#/components/schemas/DatasetFileMetaResponse', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatasetFileMetas', 'summary' => 'Deletes file metadata records from a dataset in batches.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetFileMetas'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetJob' => [ 'summary' => 'Deletes a dataset Job.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260524', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information about how to obtain the dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobId', 'in' => 'path', 'schema' => ['description' => 'Dataset task ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsjob-9jx1******uj9e'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatasetJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJob'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetJobConfig' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260472', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'DatasetJobConfigId', 'in' => 'path', 'schema' => ['description' => 'The configuration ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dscfg-xxxxxxxxxxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '513663'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'], ], 'example' => '', ], ], ], 'title' => 'DeleteDatasetJobConfig', 'summary' => 'Deletes a dataset job configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJobConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetLabels' => [ 'summary' => 'Deletes labels from a dataset.', 'path' => '/api/v1/datasets/{DatasetId}/labels', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48573', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the dataset. For more information about how to obtain the ID of a dataset, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => false, 'example' => 'd-rbvg5****jhc9ks92'], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'schema' => ['description' => 'The keys of the labels. For more information about how to query the keys of labels, see [GetDataset](~~457218~~). Separate multiple keys with commas (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatasetLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetVersion' => [ 'summary' => 'Deletes a specified version of a dataset. This operation cannot be used to delete version v1. Version v1 is deleted with the dataset when you call the DeleteDataset operation.', 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232579', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['description' => 'The dataset version. The version must be later than v1. Version v1 is deleted when the dataset is deleted.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatasetVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteDatasetVersionLabels' => [ 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}/labels', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232577', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'Keys', 'in' => 'query', 'schema' => ['description' => 'The keys of the version labels. Separate multiple keys with commas.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B2E89D7E-74F8-5656-A5D6-81D83403F9A8'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDatasetVersionLabels', 'summary' => 'Deletes labels from a dataset version.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersionLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2E89D7E-74F8-5656-A5D6-81D83403F9A8\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteExperiment' => [ 'summary' => 'Deletes an experiment.', 'path' => '/api/v1/experiments/{ExperimentId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '206974', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', 'schema' => ['description' => 'The experiment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'exp-1zpfthdx******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], 'example' => '', ], ], ], 'title' => 'DeleteExperiment', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperiment'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteExperimentLabel' => [ 'summary' => 'Deletes a label from an experiment.', 'path' => '/api/v1/experiments/{ExperimentId}/labels/{Key}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '207073', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', 'schema' => ['description' => 'The experiment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'exp-1zpfthdx******'], ], [ 'name' => 'Key', 'in' => 'path', 'schema' => ['description' => 'The key of the experiment label to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'is_evaluate'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'title' => 'DeleteExperimentLabel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperimentLabel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteExperimentLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteMembers' => [ 'summary' => 'Deletes members from a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/members', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ 'name' => 'MemberIds', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'A list of member IDs. Separate multiple member IDs with commas (,). For more information about how to obtain member IDs, see [ListMembers](~~449135~~).', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039,145883-2769726******87513'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], 'Code' => ['description' => 'The error code returned if the request failed.', 'type' => 'string', 'title' => '', 'example' => '100600017'], 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'title' => '', 'example' => 'Owner not allowed to delete'], ], 'example' => '', ], ], ], 'title' => 'DeleteMembers', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMembers'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:DeleteMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"Code\\": \\"100600017\\",\\n \\"Message\\": \\"Owner not allowed to delete\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteModel' => [ 'summary' => 'Deletes a model.', 'path' => '/api/v1/models/{ModelId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133765', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the model. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzl****ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteModelLabels' => [ 'summary' => 'Deletes model labels.', 'path' => '/api/v1/models/{ModelId}/labels', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133789', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the model. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-d8dfd****sjfd'], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The tag keys to delete. Separate multiple tag keys with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModelLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteModelVersion' => [ 'summary' => 'Deletes a model version.', 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133784', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The version of the model.', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModelVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteModelVersionLabels' => [ 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}/labels', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133792', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the model. For more information about how to obtain the model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-d8dfd****sjfd'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'required' => true, 'example' => '0.1.1'], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The keys of the labels that you want to delete. Separate multiple keys with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'key1,key2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteModelVersionLabels', 'summary' => 'Deletes labels from a model version.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersionLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteRun' => [ 'summary' => 'Deletes a run.', 'path' => '/api/v1/runs/{RunId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '233507', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The run ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], 'example' => '', ], ], ], 'title' => 'DeleteRun', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRun'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteRunLabel' => [ 'summary' => 'Deletes a label from a run.', 'path' => '/api/v1/runs/{RunId}/labels/{Key}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '233523', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The ID of the run.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'Key', 'in' => 'path', 'schema' => ['description' => 'The key of the run label to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'is_evaluate'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], 'example' => '', ], ], ], 'title' => 'DeleteRunLabel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRunLabel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteRunLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteUserConfig' => [ 'path' => '/api/v1/userconfigs/{CategoryName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '194787', 'abilityTreeNodes' => ['FEATURElearn1N0SUT'], ], 'parameters' => [ [ 'name' => 'ConfigKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The configuration key. Only customizePAIAssumedRole is supported.', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], ], [ 'name' => 'CategoryName', 'in' => 'path', 'schema' => ['description' => 'The classification. Only DataPrivacyConfig is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DataPrivacyConfig'], ], [ 'name' => 'Scope', 'in' => 'query', 'schema' => ['description' => 'The scope. Valid values: subUser and owner.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'subUser'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'dsjk****dfjksdf'], ], 'example' => '', ], ], ], 'title' => 'DeleteUserConfig', 'summary' => 'Deletes a user configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'pai:DeleteUserConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeleteWorkspace' => [ 'summary' => 'Deletes a workspace. This operation does not release associated resources. You must release them manually.', 'path' => '/api/v1/workspaces/{WorkspaceId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '61546', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'title' => 'DeleteWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'DeleteWorkspaceResource' => [ 'summary' => 'Detaches a resource from a workspace. This operation does not delete the underlying resource.', 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ProductType', 'in' => 'query', 'schema' => ['description' => '**This parameter is deprecated and will be removed. Use the `ResourceType` parameter instead.**', 'type' => 'string', 'required' => false, 'example' => 'DLC', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The resource group name. To get the resource group name, see [ListResources](~~449143~~).', 'type' => 'string', 'required' => false, 'example' => 'group', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. To get the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'Option', 'in' => 'query', 'schema' => ['description' => 'The deletion behavior. Valid values:'."\n" ."\n" .'- `DetachAndDelete` (default): Detaches the resource from the workspace and deletes the resource.'."\n" ."\n" .'- `Detach`: Detaches the resource from the workspace.', 'type' => 'string', 'required' => false, 'example' => 'DetachAndDelete', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Valid values:'."\n" ."\n" .'- `ECS`: general-purpose computing resources'."\n" ."\n" .'- `Lingjun`: Lingjun intelligent computing resources'."\n" ."\n" .'- `ACS`: ACS computing resources'."\n" ."\n" .'- `Flink`: Flink resources.'."\n" ."\n" .'- `MaxCompute`: MaxCompute resources. For this resource type, the `Option` parameter can only be set to `Detach`.'."\n" ."\n" .'- `SelfManagedAckPro`: AckPro unified management cluster resources'."\n" ."\n" .'- `SelfManagedAckLingjun`: AckLinjun unified management cluster resources'."\n" ."\n" .'- `SelfManagedASI`: ASI unified management cluster resources (third-party cloud)', 'type' => 'string', 'required' => false, 'example' => 'DLC', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of labels.', 'type' => 'string', 'required' => false, 'example' => 'system.supported.eas=true', 'title' => ''], ], [ 'name' => 'ResourceIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of resource IDs. All specified resources must belong to the same `GroupName`. You must specify a value for at least one of the `GroupName` or `ResourceIds` parameters.', 'type' => 'string', 'required' => false, 'example' => 'Resource-dks******jkf,Resource-adf******dss', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'ResourceIds' => [ 'description' => 'The affected resource IDs.', 'type' => 'array', 'items' => ['description' => 'An affected resource ID.', 'type' => 'string', 'example' => 'Resource-dks******jkf', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\"\\n ]\\n}","type":"json"}]', 'title' => 'DeleteWorkspaceResource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspaceResource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:DeleteWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteWorkspaceRoles' => [ 'summary' => 'Deletes one or more roles from a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/action/delete', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '221941', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the workspace. You can call the [ListWorkspaces](~~449124~~) operation to obtain the workspace ID.', 'type' => 'string', 'required' => true, 'example' => '98***', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'RoleIds' => [ 'type' => 'array', 'items' => ['description' => 'The ID of a role.', 'type' => 'string', 'required' => false, 'example' => 'role-dhg*******', 'title' => ''], 'description' => 'The IDs of the roles to delete.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'title' => 'DeleteWorkspaceRoles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:RemoveWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetCodeSource' => [ 'summary' => 'Retrieves the details of a code source configuration.', 'path' => '/api/v1/codesources/{CodeSourceId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ 'name' => 'CodeSourceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The code source configuration ID. To obtain the code source configuration ID, call [ListCodeSources](~~459922~~).', 'type' => 'string', 'required' => true, 'example' => 'code-202**********'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'CodeSourceId' => ['title' => '', 'description' => 'The code source configuration ID.', 'type' => 'string', 'example' => 'code-202**********'], 'DisplayName' => ['title' => '', 'description' => 'The code source configuration name.', 'type' => 'string', 'example' => 'MyCodeSource1'], 'Description' => ['title' => '', 'description' => 'The detailed description of the code source configuration.', 'type' => 'string', 'example' => 'This is my data source 1.'], 'CodeRepo' => ['title' => '', 'description' => 'The code repository URL.', 'type' => 'string', 'example' => 'https://code.aliyun.com/pai-dlc/examples.git'], 'CodeBranch' => ['title' => '', 'description' => 'The code repository branch.', 'type' => 'string', 'example' => 'master'], 'CodeCommit' => ['title' => '', 'description' => 'The code commit ID.', 'type' => 'string', 'example' => '44da10***********'], 'CodeRepoUserName' => ['title' => '', 'description' => 'The username of the code repository.', 'type' => 'string', 'example' => 'user1'], 'CodeRepoAccessToken' => ['title' => '', 'description' => 'The access code repository token.', 'type' => 'string', 'example' => 'xxxx'], 'MountPath' => ['title' => '', 'description' => 'The local mount directory of the code.', 'type' => 'string', 'example' => '/root/code'], 'Accessibility' => [ 'title' => '', 'description' => 'The visibility of the code source configuration.', 'enumValueTitles' => ['PUBLIC' => 'Visible to everyone in this workspace.', 'PRIVATE' => 'Visible only to you and administrators in this workspace.'], 'type' => 'string', 'example' => 'PRIVATE', ], 'UserId' => ['title' => '', 'description' => 'The creator ID of the code source configuration.', 'type' => 'string', 'example' => '1722********'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '1234'], 'GmtCreateTime' => ['title' => '', 'description' => 'The creation time of the code source configuration. The time is in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-12T23:36:01.123Z'], 'GmtModifyTime' => ['title' => '', 'description' => 'The modification time of the code source configuration. The time is in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-12T23:36:01.123Z'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'CloneType' => ['description' => 'The clone mode. Valid values:'."\n" .'- 0: Create a new subdirectory.'."\n" .'- 1: Tile to the current directory.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-202**********\\",\\n \\"DisplayName\\": \\"MyCodeSource1\\",\\n \\"Description\\": \\"This is my data source 1.\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/pai-dlc/examples.git\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da10***********\\",\\n \\"CodeRepoUserName\\": \\"user1\\",\\n \\"CodeRepoAccessToken\\": \\"xxxx\\",\\n \\"MountPath\\": \\"/root/code\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"UserId\\": \\"1722********\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-12T23:36:01.123Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"CloneType\\": 0\\n}","type":"json"}]', 'title' => 'Get code source configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeSource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paicodesource:GetCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetConfig' => [ 'path' => '/api/v1/workspaces/{WorkspaceId}/config', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '240491', 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1234******2'], ], [ 'name' => 'CategoryName', 'in' => 'query', 'schema' => ['description' => 'The classification of the configuration item. The following classifications are supported:'."\n" ."\n" .'- CommonResourceConfig: common resource configurations'."\n" ."\n" .'- DLCAutoRecycle: automatic DLC resource recycling'."\n" ."\n" .'- DLCPriorityConfig: DLC priority settings'."\n" ."\n" .'- DSWPriorityConfig: DSW priority settings'."\n" ."\n" .'- QuotaMaximumDuration: the maximum runtime of a DLC task for a quota'."\n" ."\n" .'- CommonTagConfig: tag settings', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CommonResourceConfig'], ], [ 'name' => 'ConfigKey', 'in' => 'query', 'schema' => ['description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: the temporary storage path. This key applies only when CategoryName is set to CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: the automatic recycling configuration. This key applies only when CategoryName is set to DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: the priority configuration. This key applies only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: the maximum runtime of a DLC task for a quota. This key applies only when CategoryName is set to QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: the predefined tags for the workspace. Resources that you create must have tags.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tempStoragePath'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oss://***'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '1234******2'."\n"], 'ConfigKey' => ['description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: the temporary storage path. This key applies only when CategoryName is CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: the automatic recycling configuration. This key applies only when CategoryName is DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: the priority configuration. This key applies only when CategoryName is DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: the maximum runtime of a DLC task for a quota. This key applies only when CategoryName is QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: the predefined tags for the workspace. Resources that you create must have tags.', 'type' => 'string', 'title' => '', 'example' => 'tempStoragePath'], 'ConfigValue' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'title' => '', 'example' => 'oss://***'], 'CategoryName' => ['description' => 'The classification of the configuration item. The following classifications are supported:'."\n" ."\n" .'- CommonResourceConfig: common resource configurations'."\n" ."\n" .'- DLCAutoRecycle: automatic DLC resource recycling'."\n" ."\n" .'- DLCPriorityConfig: DLC priority settings'."\n" ."\n" .'- DSWPriorityConfig: DSW priority settings'."\n" ."\n" .'- QuotaMaximumDuration: the maximum runtime of a DLC task for a quota'."\n" ."\n" .'- CommonTagConfig: tag settings', 'type' => 'string', 'title' => '', 'example' => 'CommonResourceConfig'], 'Labels' => [ 'description' => 'The list of tags for the configuration item.', 'type' => 'array', 'items' => [ 'description' => 'The tag of the configuration item.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'title' => '', 'example' => 'key1'], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'title' => '', 'example' => 'value1'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetConfig', 'summary' => 'Retrieves the configurations of a workspace.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\",\\n \\"WorkspaceId\\": \\"1234******2\\\\n\\",\\n \\"ConfigKey\\": \\"tempStoragePath\\",\\n \\"ConfigValue\\": \\"oss://***\\",\\n \\"CategoryName\\": \\"CommonResourceConfig\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetConnection' => [ 'summary' => 'Retrieves the details of a connection.', 'path' => '/api/v1/connections/{ConnectionId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267615', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'ConnectionId', 'in' => 'path', 'schema' => ['description' => 'The connection ID. For more information about how to obtain a connection ID, see [ListConnections](url).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'conn-pai9m***mi47'."\n"], ], [ 'name' => 'EncryptOption', 'in' => 'query', 'schema' => ['description' => 'The encryption setting. Valid values:'."\n" ."\n" .'- PlainText: The value is in plaintext.'."\n" ."\n" .'- Secret: The value is in ciphertext.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PlainText'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '11**43'], 'Accessibility' => ['description' => 'The visibility of the resource. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can access the resource.'."\n" ."\n" .'- PRIVATE: Only the creator can access the resource.', 'type' => 'string', 'title' => '', 'example' => 'PRIVATE'], 'ConnectionId' => ['description' => 'The connection ID.', 'type' => 'string', 'title' => '', 'example' => 'conn-pai9m***mi47'], 'ConnectionType' => ['description' => 'The type of the connection. Valid values:'."\n" ."\n" .'- DashScopeConnection: A connection to a Model Studio service.'."\n" ."\n" .'- OpenLLMConnection: A connection to an open-source model.'."\n" ."\n" .'- MilvusConnection: A connection to Milvus.'."\n" ."\n" .'- OpenSearchConnection: A connection to OpenSearch.'."\n" ."\n" .'- LindormConnection: A connection to Lindorm.'."\n" ."\n" .'- ElasticsearchConnection: A connection to Elasticsearch.'."\n" ."\n" .'- HologresConnection: A connection to Hologres.'."\n" ."\n" .'- RDSConnection: A connection to RDS.'."\n" ."\n" .'- CustomConnection: A custom connection.', 'type' => 'string', 'title' => '', 'example' => 'OpenSearchConnection'], 'ConnectionName' => ['description' => 'The name of the connection.', 'type' => 'string', 'title' => '', 'example' => 'Database connection'], 'Description' => ['description' => 'The description of the connection.', 'type' => 'string', 'title' => '', 'example' => '用于数据集检索。'], 'Configs' => [ 'description' => 'The configuration information of the connection.', 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'description' => 'The value of a connection configuration.', 'title' => '', 'example' => '12345'], 'title' => '', 'example' => '', ], 'Secrets' => [ 'description' => 'The key-value pairs that need to be encrypted. Examples include the logon password for a database and the key for a model connection.', 'type' => 'object', 'additionalProperties' => ['type' => 'string', 'description' => 'The value of an encrypted connection configuration.', 'title' => '', 'example' => 'Dsjk***hsl01'], 'title' => '', 'example' => '', ], 'GmtCreateTime' => ['description' => 'The UTC time when the connection was created. The time is in the ISO 8601 format.', 'type' => 'string', 'title' => '', 'example' => '2025-03-07T07:54:56Z'], 'GmtModifiedTime' => ['description' => 'The UTC time when the connection was last modified. The time is in the ISO 8601 format.', 'type' => 'string', 'title' => '', 'example' => '2025-03-07T07:54:56Z'], 'Creator' => ['description' => 'The creator of the connection.', 'type' => 'string', 'title' => '', 'example' => '28632***898231'], 'ResourceMeta' => [ 'description' => 'The instance resource information of the connection. This parameter is typically used for database connections.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ld-2vc1***v1zaqgzol'], 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'title' => '', 'example' => 'Test instance.'], 'Extra' => ['type' => 'string', 'description' => 'Additional configuration information.', 'title' => '', 'example' => '{"vpcId":"vpc-xxxx"}'], ], 'title' => '', 'example' => '', ], 'Models' => [ 'description' => 'The list of models. This parameter is applicable to connections of the model service type.', 'type' => 'array', 'items' => [ 'description' => 'The model information.', 'type' => 'object', 'properties' => [ 'Model' => ['description' => 'The model identifier.', 'type' => 'string', 'title' => '', 'example' => 'model_001'], 'DisplayName' => ['description' => 'The display name of the model.', 'type' => 'string', 'title' => '', 'example' => '测试语言模型。'], 'ModelType' => ['description' => 'The model type. Valid values:'."\n" ."\n" .'- LLM: A large language model (LLM).'."\n" ."\n" .'- Embedding: An embedding model.'."\n" ."\n" .'- ReRank: A reranking model.', 'type' => 'string', 'title' => '', 'example' => 'LLM'], 'ToolCall' => ['description' => 'Indicates whether tool calling is supported. Valid values:'."\n" ."\n" .'- true: Tool calling is supported.'."\n" ."\n" .'- false: Tool calling is not supported.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"11**43\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\",\\n \\"ConnectionType\\": \\"OpenSearchConnection\\",\\n \\"ConnectionName\\": \\"Database connection\\",\\n \\"Description\\": \\"用于数据集检索。\\",\\n \\"Configs\\": {\\n \\"key\\": \\"12345\\"\\n },\\n \\"Secrets\\": {\\n \\"key\\": \\"Dsjk***hsl01\\"\\n },\\n \\"GmtCreateTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"GmtModifiedTime\\": \\"2025-03-07T07:54:56Z\\",\\n \\"Creator\\": \\"28632***898231\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceId\\": \\"ld-2vc1***v1zaqgzol\\",\\n \\"InstanceName\\": \\"Test instance.\\",\\n \\"Extra\\": \\"{\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxx\\\\\\"}\\"\\n },\\n \\"Models\\": [\\n {\\n \\"Model\\": \\"model_001\\",\\n \\"DisplayName\\": \\"测试语言模型。\\",\\n \\"ModelType\\": \\"LLM\\",\\n \\"ToolCall\\": true\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetConnection', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnection'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetDataset' => [ 'summary' => 'Retrieves a dataset.', 'path' => '/api/v1/datasets/{DatasetId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48564', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The dataset ID. For information on how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'd-rbvg5wz****c9ks92', 'title' => ''], 'Name' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'myName', 'title' => ''], 'Description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'example' => '用于标注的数据。', 'title' => ''], 'GmtCreateTime' => ['description' => 'The time when the dataset was created.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''], 'GmtModifiedTime' => ['description' => 'The time when the dataset was last updated.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z', 'title' => ''], 'UserId' => ['description' => 'The user ID of the dataset owner.', 'type' => 'string', 'example' => '2485765****023475', 'title' => ''], 'OwnerId' => ['description' => 'The owner ID.', 'type' => 'string', 'example' => '1631044****3440', 'title' => ''], 'Property' => [ 'description' => 'The property of the initial dataset version (v1). Valid values:'."\n" ."\n" .'- `FILE`: The dataset is a file.'."\n" ."\n" .'- `DIRECTORY`: The dataset is a folder.', 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'type' => 'string', 'example' => 'DIRECTORY', 'title' => '', ], 'DataSourceType' => [ 'description' => 'The data source type. Valid values:'."\n" ."\n" .'- `OSS`: Object Storage Service (OSS).'."\n" ."\n" .'- `NAS`: Apsara File Storage NAS.', 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'type' => 'string', 'example' => 'NAS', 'title' => '', ], 'Uri' => ['description' => 'The URI of the initial dataset version (v1). The supported formats are as follows:'."\n" ."\n" .'- For an OSS data source: `oss://bucket.endpoint/object`.'."\n" ."\n" .'- For a NAS data source, the format varies by NAS type:'."\n" ."\n" .' CPFS 1.0 and CPFS 2.0 are distinguished by the format of the file system ID ():', 'type' => 'string', 'example' => 'nas://09f****f2.cn-hangzhou/', 'title' => ''], 'Labels' => [ 'description' => 'The labels attached to the dataset.', 'type' => 'array', 'items' => ['description' => 'A key-value label.', '$ref' => '#/components/schemas/Label', 'example' => '{"Key": "env", "Value": "test"}', 'title' => ''], 'title' => '', 'example' => '', ], 'DataType' => [ 'description' => 'The data type of the dataset. Valid values:'."\n" ."\n" .'- `COMMON`: General data'."\n" ."\n" .'- `PIC`: images'."\n" ."\n" .'- `TEXT`: text'."\n" ."\n" .'- `VIDEO`: videos'."\n" ."\n" .'- `AUDIO`: audio', 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], 'type' => 'string', 'example' => 'COMMON', 'title' => '', ], 'SourceType' => [ 'description' => 'The source type of the initial dataset version (v1).', 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'type' => 'string', 'example' => 'USER', 'title' => '', ], 'SourceId' => ['description' => 'The ID of the data source for the initial version (v1). The meaning of this parameter varies based on the `SourceType` value.'."\n" ."\n" .'- If `SourceType` is `USER`, you can specify a custom value for `SourceId`.'."\n" ."\n" .'- If `SourceType` is `ITAG`, the dataset is generated from an iTAG annotation task, and `SourceId` is the task ID.'."\n" ."\n" .'- If `SourceType` is `PAI_PUBLIC_DATASET`, the dataset is created from a PAI public dataset. In this case, `SourceId` is empty.', 'type' => 'string', 'example' => 'jdnhf***fnrimv', 'title' => ''], 'WorkspaceId' => ['description' => 'The ID of the workspace where the dataset is located.', 'type' => 'string', 'example' => '478**', 'title' => ''], 'Options' => ['description' => 'Extended properties for the initial dataset version (v1), in JSON string format. For example, when using the dataset in a DLC job, you can set the `mountPath` field to specify the default mount path.', 'type' => 'string', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}', 'title' => ''], 'Accessibility' => [ 'description' => 'The visibility of the dataset in the workspace. Valid values:'."\n" ."\n" .'- `PRIVATE`: The dataset is visible only to its owner and workspace administrators.'."\n" ."\n" .'- `PUBLIC`: The dataset is visible to all members in the workspace.'."\n" ."\n" .'- `ROLE_PUBLIC`: The dataset is visible to specific workspace roles. For the list of roles, see the `AccessibleRoleIdList` parameter. The dataset owner and workspace administrators can always view the dataset.', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'type' => 'string', 'example' => 'PRIVATE', 'title' => '', ], 'ProviderType' => ['description' => 'The type of the data source provider. Valid values:'."\n" ."\n" .'- `ECS` (default)'."\n" ."\n" .'- `Lingjun`', 'type' => 'string', 'example' => 'Ecs', 'title' => ''], 'Provider' => ['description' => 'The provider of the dataset. If the value is `pai`, the dataset is a PAI public dataset.', 'type' => 'string', 'example' => 'pai', 'title' => ''], 'SourceDatasetId' => ['description' => 'The ID of the source dataset for the iTAG annotation set.', 'type' => 'string', 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n", 'title' => ''], 'SourceDatasetVersion' => ['description' => 'The version of the source dataset for the annotation set.', 'type' => 'string', 'example' => 'v2', 'title' => ''], 'TagTemplateType' => ['description' => 'The annotation template of the iTAG annotation set.', 'type' => 'string', 'example' => 'TextClassification', 'title' => ''], 'LatestVersion' => ['description' => 'The latest version of the dataset.', '$ref' => '#/components/schemas/DatasetVersion', 'title' => '', 'example' => ''], 'MountAccess' => ['description' => 'The mount permissions for the dataset. Valid values:'."\n" ."\n" .'- `RO`: read-only mount'."\n" ."\n" .'- `RW`: read and write mount', 'type' => 'string', 'example' => 'RW', 'title' => ''], 'MountAccessReadWriteRoleIdList' => [ 'description' => 'A list of workspace role IDs granted read/write permissions for the dataset. A role ID that starts with `PAI` is a basic role ID. A role ID that starts with `role-` is a custom role ID. If the list contains `*`, all roles have read and write permissions.', 'type' => 'array', 'items' => ['description' => 'A workspace role ID.', 'type' => 'string', 'example' => 'PAI.AlgoOperator', 'title' => ''], 'title' => '', 'example' => '', ], 'ImportInfo' => ['description' => 'The storage import configuration of the dataset. Storage services such as OSS, NAS, and CPFS are supported.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"bucket": "${bucket}",// The bucket name.\\'."\n" .'"path": "${path}" // The path to the file or folder.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"path": "${path}", // The path in the file system.\\'."\n" .'"mountTarget": "${mount\\_target}" // The file system mount target.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"protocolServiceId":"${protocol\\_service\\_id}", // The protocol service ID.\\'."\n" .'"exportId": "${export\\_id}", // The export directory ID.\\'."\n" .'"path": "${path}", // The path in the file system.\\'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS for Intelligent Computing'."\n" ."\n" .''."\n" ."\n" .'{\\'."\n" .'"region": "${region}",// The region ID.\\'."\n" .'"fileSystemId": "${file\\_system\\_id}", // The file system ID.\\'."\n" .'"path": "${path}", // The path in the file system.\\'."\n" .'"mountTarget": "${mount\\_target}" // The file system mount target. This parameter is specific to CPFS for Intelligent Computing.\\'."\n" .'"isVpcMount": boolean, // Specifies whether the mount target is a VPC mount target. Specific to CPFS for Intelligent Computing.\\'."\n" .'}'."\n" ."\n" .'
', 'type' => 'string', 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}', 'title' => ''], 'Edition' => ['description' => 'The edition of the dataset. Valid values:'."\n" ."\n" .'- `BASIC`: The basic edition, which does not support file metadata management.'."\n" ."\n" .'- `ADVANCED`: The advanced edition, which is supported only for OSS datasets and allows you to manage metadata for up to 1 million files per version.', 'type' => 'string', 'example' => 'BASIC', 'title' => ''], 'IsShared' => [ 'description' => 'Indicates whether the dataset is a shared dataset.', 'enumValueTitles' => ['false' => 'false', 'true' => 'true'], 'type' => 'boolean', 'example' => 'false', 'title' => '', ], 'SharedFrom' => ['description' => 'The source from which the dataset was shared. This parameter is returned only if `IsShared` is `true`.', '$ref' => '#/components/schemas/DatasetShareRelationship', 'title' => '', 'example' => ''], 'SharingConfig' => [ 'type' => 'object', 'properties' => [ 'SharedTo' => [ 'type' => 'array', 'items' => ['description' => 'A sharing relationship for the dataset.', '$ref' => '#/components/schemas/DatasetShareRelationship', 'title' => '', 'example' => ''], 'description' => 'A list of relationships indicating to whom the dataset is shared.', 'title' => '', 'example' => '', ], ], 'description' => 'The sharing configuration for the dataset.', 'title' => '', 'example' => '', ], 'AccessibleRoleIdList' => [ 'type' => 'array', 'items' => ['description' => 'A workspace role ID.', 'type' => 'string', 'example' => 'PAI.AlgoOperator', 'title' => ''], 'description' => 'A list of workspace role IDs that can view the dataset. This parameter takes effect only when `Accessibility` is set to `ROLE_PUBLIC`. A role ID that starts with `PAI` is a basic role ID. A role ID that starts with `role-` is a custom role ID.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"Name\\": \\"myName\\",\\n \\"Description\\": \\"用于标注的数据。\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"2485765****023475\\",\\n \\"OwnerId\\": \\"1631044****3440\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"DataSourceType\\": \\"NAS\\",\\n \\"Uri\\": \\"nas://09f****f2.cn-hangzhou/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"DataType\\": \\"COMMON\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"SourceId\\": \\"jdnhf***fnrimv\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"Provider\\": \\"pai\\",\\n \\"SourceDatasetId\\": \\"d-rcdg3wxxxxxhc5jk87\\\\n\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"TextClassification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n },\\n \\"MountAccess\\": \\"RW\\",\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"IsShared\\": false,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n }\\n ]\\n },\\n \\"AccessibleRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetDatasetFileMeta' => [ 'summary' => 'Retrieves the metadata record of a specified file in a dataset.', 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas/{DatasetFileMetaId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260628', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'DatasetFileMetaId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset file metadata.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'DatasetFileMeta' => ['description' => 'The details of the dataset file metadata.', '$ref' => '#/components/schemas/DatasetFileMetaContentGet', 'title' => '', 'example' => ''], 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'title' => '', 'example' => 'v1'], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '1234'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetDatasetFileMeta', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMeta'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetFileMeta', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetFileMeta\\": {\\n \\"FileName\\": \\"00001.jpeg\\",\\n \\"Uri\\": \\"oss://*****-test/dataset/1653421.jpg\\\\nnas://0e25d***dff/dataset/1653421.jpg\\\\n\\",\\n \\"Comment\\": \\"The first image file in the dataset.\\",\\n \\"FileCreateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"FileUpdateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"FileFingerPrint\\": \\"D41D8CD98F*****E9800998ECF8\\\\n\\",\\n \\"DataSize\\": 10000,\\n \\"FileType\\": \\"image\\",\\n \\"ContentType\\": \\"image/png\\",\\n \\"MetaAttributes\\": \\"{\\\\n \\\\\\"ImageHeight\\\\\\": 1080,\\\\n \\\\\\"ImageWidth\\\\\\": 1920\\\\n}\\",\\n \\"Tags\\": \\"{\\\\n \\\\\\"ai\\\\\\":\\\\n [\\\\n \\\\\\"Lane line\\\\\\",\\\\n \\\\\\"Water horse\\\\\\",\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ],\\\\n \\\\\\"user\\\\\\":\\\\n [\\\\n \\\\\\"Everett\\\\\\",\\\\n \\\\\\"Intelligent driving Dataset 1\\\\\\",\\\\n \\\\\\"Cloudy day\\\\\\"\\\\n ],\\\\n \\\\\\"user-delete-ai-tags\\\\\\":\\\\n [\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ]\\\\n}\\",\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6\\\\n\\",\\n \\"FileDir\\": \\"icp_certificate_card/icp/1577179298694813/1716429710367\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"dsjob-klfwtjtov*****scvt3\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"Status\\": \\"\\"\\n },\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"DatasetId\\": \\"d-rbvg5wz****c9ks92\\",\\n \\"WorkspaceId\\": \\"1234\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetDatasetFileMetasStatistics' => [ 'summary' => 'Retrieves statistics for metadata in a dataset.', 'path' => '/api/v1/statistics/datasets/{DatasetId}/datasetfilemetas', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267067', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '145883'], ], [ 'name' => 'AggregateBy', 'in' => 'query', 'schema' => [ 'description' => 'The metadata field used for statistical aggregation. The value is not case-sensitive. If you do not specify this parameter, the total number of file metadata entries in the dataset is returned, and the aggregation list is not returned.'."\n" .'Valid values:'."\n" ."\n" .'- filedir: The directory path of the file.'."\n" ."\n" .'- filetype: The file type.'."\n" ."\n" .'- tags.user: Custom user tags.'."\n" ."\n" .'- tags.user-delete-ai-tags: Algorithm tags deleted by the user.'."\n" ."\n" .'- tags.ai: Algorithm tags that are aggregated from all labeling tasks.'."\n" ."\n" .'- tags.all: A combination of algorithm tags and custom user tags, excluding any algorithm tags deleted by the user.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['filetype' => 'filetype', 'tags.user' => 'tags.user', 'tags.ai' => 'tags.ai', 'filedir' => 'filedir', 'tags.user-delete-ai-tags' => 'tags.user-delete-ai-tags', 'tags.all' => 'tags.all'], 'title' => '', 'example' => 'filedir', ], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return for each query that uses the NextToken parameter. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], 'TotalCount' => ['description' => 'The number of statistical results returned. For example, the number of metadata entries or the number of user tags.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '73'], 'DatasetFileMetasStats' => [ 'description' => 'The details of the returned aggregation list. You can get the count for each aggregated item. The list is sorted by Count in descending order by default.', 'type' => 'array', 'items' => ['description' => 'The aggregated item and its count.', '$ref' => '#/components/schemas/DatasetFileMetasStat', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetDatasetFileMetasStatistics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMetasStatistics'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetFileMetasStatistics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"TotalCount\\": 73,\\n \\"DatasetFileMetasStats\\": [\\n {\\n \\"Key\\": \\"cat\\",\\n \\"Count\\": 10\\n }\\n ]\\n}","type":"json"}]', ], 'GetDatasetJob' => [ 'summary' => 'Retrieves a dataset job.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260532', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobId', 'in' => 'path', 'schema' => ['description' => 'The dataset job ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsjob-9jx1xxxxxxuj9e'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '478**'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D'], 'JobAction' => [ 'description' => 'The task operation.', 'type' => 'string', 'enumValueTitles' => ['SemanticIndex' => 'The semantic index task.', 'IntelligentTag' => 'The intelligent tagging task.', 'FileMetaExport' => 'The metadata exporting task.'], 'title' => '', 'example' => 'SemanticIndex', ], 'JobMode' => [ 'description' => 'The task pattern.', 'type' => 'string', 'enumValueTitles' => ['Full' => 'The full pattern.'], 'title' => '', 'example' => 'Full', ], 'CreateTime' => ['description' => 'The time when the task was started.', 'type' => 'string', 'title' => '', 'example' => '2024-11-15T07:06:42Z'], 'FinishTime' => ['description' => 'The time when the task was finished.', 'type' => 'string', 'title' => '', 'example' => '2024-07-16T02:03:23Z'], 'JobSpec' => ['description' => 'The task details.', 'type' => 'string', 'title' => '', 'example' => '{\\"modelId\\":\\"xxx\\"}'], 'Status' => [ 'description' => 'The task status.', 'type' => 'string', 'enumValueTitles' => ['Succeeded' => 'The task was successful.', 'Failed' => 'The task failed.', 'Running' => 'The task is running.', 'Pending' => 'The task is pending.', 'PartialFailed' => 'The task partially failed.', 'Deleting' => 'The task is being deleted.', 'ManuallyStop' => 'The task was manually stopped.'], 'title' => '', 'example' => 'Running', ], 'Description' => ['description' => 'The task description.', 'type' => 'string', 'title' => '', 'example' => 'This is a task description.'], 'Logs' => [ 'description' => 'The list of task logs.', 'type' => 'array', 'items' => ['description' => 'A line in the task logs.', 'type' => 'string', 'title' => '', 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.'], 'title' => '', 'example' => '', ], 'TotalFileCount' => ['description' => 'The total number of files for the task.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1000'], 'CompletedFileCount' => ['description' => 'The total number of completed files.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '990'], 'FailedFileCount' => ['description' => 'The total number of failed files.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\",\\n \\"JobAction\\": \\"SemanticIndex\\",\\n \\"JobMode\\": \\"Full\\",\\n \\"CreateTime\\": \\"2024-11-15T07:06:42Z\\",\\n \\"FinishTime\\": \\"2024-07-16T02:03:23Z\\",\\n \\"JobSpec\\": \\"{\\\\\\\\\\\\\\"modelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"This is a task description.\\",\\n \\"Logs\\": [\\n \\"2025-02-17 09:58:10.143 INFO: Job completed successfully.\\"\\n ],\\n \\"TotalFileCount\\": 1000,\\n \\"CompletedFileCount\\": 990,\\n \\"FailedFileCount\\": 10\\n}","type":"json"}]', 'title' => 'GetDatasetJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJob'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDatasetJobConfig' => [ 'summary' => 'Retrieves the configuration of a dataset job.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260462', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'DatasetJobConfigId', 'in' => 'path', 'schema' => ['description' => 'The configuration ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dscfg-xxxxxxxxxxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '114243'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], 'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '2024-10-16T01:44:10Z'], 'ModifyTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-12-26T02:17:18Z'], 'ConfigType' => ['description' => 'The configuration type.'."\n" ."\n" .'- MultimodalIntelligentTag'."\n" ."\n" .'- MultimodalSemanticIndex', 'type' => 'string', 'title' => '', 'example' => 'MultimodalIntelligentTag'], 'Config' => ['description' => 'The configuration content. The format depends on the ConfigType value.'."\n" .'If ConfigType is MultimodalIntelligentTag, the format is as follows:'."\n" ."\n" .'{'."\n" .'"apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" .'}'."\n" ."\n" .'If ConfigType is MultimodalSemanticIndex, the format is as follows:'."\n" ."\n" .'{'."\n" .'"defaultModelId": "xxx",'."\n" .'"defaultModelVersion":"1.0.0"'."\n" .'}', 'type' => 'string', 'title' => '', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => '114243'], ], 'example' => '', ], ], ], 'title' => 'GetDatasetJobConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJobConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"CreateTime\\": \\"2024-10-16T01:44:10Z\\",\\n \\"ModifyTime\\": \\"2024-12-26T02:17:18Z\\",\\n \\"ConfigType\\": \\"MultimodalIntelligentTag\\",\\n \\"Config\\": \\"{ \\\\\\"apiKey\\\\\\":\\\\\\"sk-xxxxxxxxxxxxxxxxxxxxx\\\\\\" }\\",\\n \\"DatasetId\\": \\"d-lfd60v0p****ujtsdx\\",\\n \\"WorkspaceId\\": \\"114243\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetDatasetVersion' => [ 'summary' => 'Retrieves information about a specific dataset version.', 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232570', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['description' => 'The name of the version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C55DF3DA-F120-5E37-A374-F49365531701'], 'DatasetId' => ['title' => '', 'description' => 'The ID of the dataset.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'd-dkdbnnap0g7b6su4yg'], 'VersionName' => ['title' => '', 'description' => 'The name of the dataset version.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => 'v1'], 'Property' => [ 'title' => '', 'description' => 'The property of the dataset.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'enum' => ['FILE', 'DIRECTORY'], 'example' => 'DIRECTORY', ], 'GmtCreateTime' => ['description' => 'The time when the dataset version was created.', 'type' => 'string', 'title' => '', 'example' => '2023-12-13T10:22:05.694Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the dataset version was last modified.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'example' => '2023-12-13T10:22:05.694Z'], 'DataSourceType' => [ 'title' => '', 'description' => 'The type of the data source.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'enum' => ['OSS', 'NAS', 'CPFS'], 'example' => 'OSS', ], 'Uri' => ['title' => '', 'description' => 'The URI of the dataset version.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'example' => 'oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/'], 'Labels' => [ 'title' => '', 'description' => 'The tags of the resource.', 'type' => 'array', 'items' => ['deprecated' => false, '$ref' => '#/components/schemas/Label', 'description' => 'A tag.', 'title' => '', 'example' => ''], 'deprecated' => false, 'maxItems' => 20, 'example' => '', ], 'Options' => ['title' => '', 'description' => 'Additional options.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}'], 'SourceType' => [ 'title' => '', 'description' => 'The source type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'enum' => ['USER', 'ITAG', 'PAI_PUBLIC_DATASET', 'CLEANING', 'ENHANCE', 'ADDVERSION'], 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'example' => 'USER', ], 'Description' => ['title' => '', 'description' => 'The description of the version.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'example' => 'This is a description of the dataset version.'], 'SourceId' => ['title' => '', 'description' => 'The ID of the dataset source.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'default' => '', 'example' => 'd-rbvg5wzljzjhc9ks92'], 'DataCount' => ['title' => '', 'description' => 'The number of data entries.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'example' => '10000'], 'DataSize' => ['title' => '', 'description' => 'The size of the dataset.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'example' => '10000'], 'MountAccess' => ['description' => 'The access permissions when the dataset is mounted.'."\n" ."\n" .'- RO: Read-only mount'."\n" ."\n" .'- RW: Read-write mount', 'type' => 'string', 'title' => '', 'example' => 'RO'], 'ImportInfo' => ['description' => 'The storage import configuration of the dataset. Supported storage services include OSS, NAS, and CPFS.'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'OSS'."\n" ."\n" .''."\n" ."\n" .'{'."\n" .'"region": "${region}",// Region ID'."\n" .'"bucket": "${bucket}",// Bucket name'."\n" .'"path": "${path}" // File path'."\n" .'}'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'NAS'."\n" ."\n" .''."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'CPFS'."\n" ."\n" .''."\n" ."\n" .'Block content'."\n" ."\n" .'
'."\n" ."\n" .'
'."\n" ."\n" .''."\n" ."\n" .'AI Computing CPFS'."\n" ."\n" .''."\n" ."\n" .'Block content'."\n" ."\n" .'
', 'type' => 'string', 'title' => '', 'example' => '{'."\n" .' "region": "cn-wulanchabu",'."\n" .' "fileSystemId": "bmcpfs-xxxxxxxxxxx",'."\n" .' "path": "/mnt",'."\n" .' "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com",'."\n" .' "isVpcMount": true'."\n" .'}'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetDatasetVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C55DF3DA-F120-5E37-A374-F49365531701\\",\\n \\"DatasetId\\": \\"d-dkdbnnap0g7b6su4yg\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"GmtCreateTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-13T10:22:05.694Z\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"This is a description of the dataset version.\\",\\n \\"SourceId\\": \\"d-rbvg5wzljzjhc9ks92\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n}","type":"json"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'manual', ], 'GetDefaultWorkspace' => [ 'summary' => 'Retrieves the details of the default workspace.', 'path' => '/api/v1/defaultWorkspaces', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return detailed information about the default workspace. The detailed information includes the Conditions list. Valid values:'."\n" ."\n" .'- false (default): Detailed information is not returned.'."\n" ."\n" .'- true: Detailed information is returned.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '1234'], 'WorkspaceName' => ['title' => '', 'description' => 'The name of the workspace. The name must be unique within the same region.', 'type' => 'string', 'example' => 'workspace-example'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the workspace was created. The time is in Coordinated Universal Time (UTC) and is formatted in ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the workspace was last modified. The time is in UTC and is formatted in ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'DisplayName' => ['title' => '', 'description' => 'The display name of the workspace.', 'type' => 'string', 'example' => 'workspace-example'], 'Description' => ['title' => '', 'description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'workspace description example'], 'EnvTypes' => [ 'title' => '', 'description' => 'The environments in the workspace.'."\n" ."\n" .'- A workspace in basic mode contains only the production (prod) environment.'."\n" ."\n" .'- A workspace in standard mode contains the development (dev) and production (prod) environments.', 'type' => 'array', 'items' => ['description' => 'The environment. Valid values:'."\n" ."\n" .'- dev: The development environment.'."\n" ."\n" .'- prod: The production environment.', 'type' => 'string', 'title' => '', 'example' => 'prod'], 'example' => '', ], 'Creator' => ['title' => '', 'description' => 'The Alibaba Cloud account that created the workspace.', 'type' => 'string', 'example' => '17915******4216'."\n"], 'Owner' => [ 'title' => '', 'description' => 'The Alibaba Cloud account that created the workspace.', 'type' => 'object', 'properties' => [ 'UserId' => ['title' => '', 'description' => 'The UID of the user.', 'type' => 'string', 'example' => '17915******4216'], 'UserName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'username'], 'UserKp' => ['title' => '', 'description' => 'The UID of the user.', 'type' => 'string', 'example' => '17915******4216'], ], 'example' => '', ], 'Status' => ['title' => '', 'description' => 'The status of the workspace. Valid values:'."\n" ."\n" .'- ENABLED: Normal.'."\n" ."\n" .'- INITIALIZING: Initializing.'."\n" ."\n" .'- FAILURE: Failed.'."\n" ."\n" .'- DISABLED: Disabled.'."\n" ."\n" .'- FROZEN: Frozen due to an overdue payment.'."\n" ."\n" .'- UPDATING: The workspace is being updated.', 'type' => 'string', 'example' => 'ENABLED'], 'Conditions' => [ 'title' => '', 'description' => 'The details about the creation stages of the default workspace.', 'type' => 'array', 'items' => [ 'description' => 'The details about a creation stage of the default workspace.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The task type. Valid values:'."\n" ."\n" .'- CREATING: Creating.'."\n" ."\n" .'- WORKSPACE\\_CREATED: The workspace is created.'."\n" ."\n" .'- MEMBERS\\_ADDED: Members are added.'."\n" ."\n" .'- ENABLED: The process is complete.', 'type' => 'string', 'example' => 'CREATING '], 'Code' => ['title' => '', 'description' => 'The status code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message. This parameter is empty if the status code is 200.', 'type' => 'string', 'example' => 'Create Failed'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'GetDefaultWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetDefaultWorkspace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"17915******4216\\\\n\\",\\n \\"Owner\\": {\\n \\"UserId\\": \\"17915******4216\\",\\n \\"UserName\\": \\"username\\",\\n \\"UserKp\\": \\"17915******4216\\"\\n },\\n \\"Status\\": \\"ENABLED\\",\\n \\"Conditions\\": [\\n {\\n \\"Type\\": \\"CREATING \\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Create Failed\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetExperiment' => [ 'summary' => 'Retrieves an experiment.', 'path' => '/api/v1/experiments/{ExperimentId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '206972', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'ExperimentId', 'in' => 'path', 'schema' => ['description' => 'The experiment ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'exp-1zpfthdx******'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'Specifies whether to retrieve the latest run information for the experiment.', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'default' => 'false', 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The experiment instance.', '$ref' => '#/components/schemas/Experiment', 'title' => '', 'example' => ''], ], ], 'title' => 'GetExperiment', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetExperiment'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:GetExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetImage' => [ 'summary' => 'Retrieves the details of an image.', 'path' => '/api/v1/images/{ImageId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61616', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the image. For more information, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'image-4c62******53uor'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to display non-essential information. Non-essential information currently includes labels.'."\n" .'Valid values:'."\n" ."\n" .'- false (default): Does not display non-essential information.'."\n" ."\n" .'- true: Displays non-essential information.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the image was created. The time is in UTC and the format is ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the image was last modified. The time is in UTC and the format is ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'Name' => ['title' => '', 'description' => 'The name of the image.', 'type' => 'string', 'example' => 'nlp-compression'."\n"], 'Description' => ['title' => '', 'description' => 'The description of the image.', 'type' => 'string', 'example' => 'NLP model compression training image'], 'ImageUri' => ['title' => '', 'description' => 'The URL of the image, including the version number.', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu'."\n"], 'UserId' => ['title' => '', 'description' => 'The UID of the user who created the image.', 'type' => 'string', 'example' => '15577******8921'], 'ParentUserId' => ['title' => '', 'description' => 'The Alibaba Cloud account of the creator.', 'type' => 'string', 'example' => '15577******8921'], 'Labels' => [ 'title' => '', 'description' => 'A list of image labels. This is an array. Each item in the array contains a Key and a Value field.'."\n" .'Official images have the following label: the key is system.official and the value is true.', 'type' => 'array', 'items' => [ 'description' => 'The image label.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'system.chipType'."\n"], 'Value' => ['title' => '', 'description' => 'The value of the label.', 'type' => 'string', 'example' => 'GPU'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace to which the image belongs.', 'type' => 'string', 'example' => '15945'], 'Accessibility' => ['title' => '', 'description' => 'The visibility of the image. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can perform operations on the image.'."\n" ."\n" .'- PRIVATE: Only the creator can perform operations on the image.', 'type' => 'string', 'example' => 'PUBLIC'], 'Size' => ['description' => 'The size of the image in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], 'SourceType' => ['title' => '', 'description' => 'The type of the image source.', 'type' => 'string', 'example' => ''], 'SourceId' => ['title' => '', 'description' => 'The ID of the image source.', 'type' => 'string', 'example' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Name\\": \\"nlp-compression\\\\n\\",\\n \\"Description\\": \\"NLP model compression training image\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu\\\\n\\",\\n \\"UserId\\": \\"15577******8921\\",\\n \\"ParentUserId\\": \\"15577******8921\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\\\n\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Size\\": 10,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n}","type":"json"}]', 'title' => 'GetImage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetImage'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiimage:GetImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetInstanceJob' => [ 'summary' => 'Gets the details of a job.', 'path' => '/api/v1/instancejobs/{InstanceJobId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '219742', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'InstanceJobId', 'in' => 'path', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde', 'title' => ''], 'Status' => ['description' => 'The status of the job. Valid values:'."\n" ."\n" .'- Creating: The job is being created.'."\n" ."\n" .'- Updating: The job is being updated.'."\n" ."\n" .'- Deleting: The job is being deleted.'."\n" ."\n" .'- Successful: The job completed successfully (a final state).'."\n" ."\n" .'- Failed: The job failed (a final state).', 'type' => 'string', 'example' => 'Successful', 'title' => ''], 'ReasonMessage' => ['description' => 'A message providing details about the job.', 'type' => 'string', 'example' => 'workspace-example', 'title' => ''], 'GmtCreateTime' => ['description' => 'The creation time in UTC, in ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''], 'Type' => ['description' => 'The job type. Valid values:'."\n" ."\n" .'- CreateWorkspaceCustomRole'."\n" ."\n" .'- UpdateWorkspaceCustomRole'."\n" ."\n" .'- DeleteWorkspaceCustomRole', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole', 'title' => ''], 'InstanceJobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'CreateWorkspaceCustomRole-role-***abc*******'."\n", 'title' => ''], 'InstanceId' => ['description' => 'The instance ID. For example, if a job creates a custom role, this parameter returns the corresponding role ID.', 'type' => 'string', 'example' => '*****12qb3*****', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'title' => 'GetInstanceJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetInstanceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Status\\": \\"Successful\\",\\n \\"ReasonMessage\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Type\\": \\"CreateWorkspaceCustomRole\\",\\n \\"InstanceJobId\\": \\"CreateWorkspaceCustomRole-role-***abc*******\\\\n\\",\\n \\"InstanceId\\": \\"*****12qb3*****\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetMember' => [ 'path' => '/api/v1/workspaces/{WorkspaceId}/member', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '36846', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '145883'], ], [ 'name' => 'UserId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['title' => '', 'description' => 'The user UID. For more information about how to view the user UID, see [ListWorkspaceUsers](~~449133~~). You must specify either UserId or MemberId. You cannot specify both.', 'type' => 'string', 'required' => false, 'example' => '21513926******88039'], ], [ 'name' => 'MemberId', 'in' => 'query', 'schema' => ['description' => 'The member UID. You must specify either UserId or MemberId. You cannot specify both.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '145883-21513926******88039'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '21513926******88039'], 'MemberName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'user1'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the member was created. The time is in Coordinated Universal Time (UTC) and the format is ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'Roles' => [ 'title' => '', 'description' => 'The list of roles.', 'type' => 'array', 'items' => ['description' => 'The role name. For more information about the mapping between role names and permissions, see [List of roles and permissions](https://pai.console.aliyun.com/?spm=api-workbench.API%20Explorer.0.0.7a862392uO09Se\\®ionId=cn-shanghai#/workspace/permission).'."\n" .'Possible values:'."\n" ."\n" .'- PAI.AlgoDeveloper: Algorithm developer.'."\n" ."\n" .'- PAI.AlgoOperator: Algorithm O\\&M.'."\n" ."\n" .'- PAI.LabelManager: Labeling administrator.'."\n" ."\n" .'- PAI.MaxComputeDeveloper: MaxCompute developer.'."\n" ."\n" .'- PAI.WorkspaceAdmin: Administrator.'."\n" ."\n" .'- PAI.WorkspaceGuest: Guest.'."\n" ."\n" .'- PAI.WorkspaceOwner: Owner.', 'type' => 'string', 'title' => '', 'example' => 'myRole1'], 'example' => '', ], 'DisplayName' => ['title' => '', 'description' => 'The display name of the member.', 'type' => 'string', 'example' => 'myDisplayName'], 'MemberId' => ['title' => '', 'description' => 'The member ID.', 'type' => 'string', 'example' => '145883-21513926******88039'."\n"], 'AccountType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], ], ], 'title' => 'GetMember', 'summary' => 'Retrieves a member of a workspace.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"UserId\\": \\"21513926******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"myRole1\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"145883-21513926******88039\\\\n\\",\\n \\"AccountType\\": \\"\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetModel' => [ 'summary' => 'Gets the details of a specified model.', 'path' => '/api/v1/models/{ModelId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133753', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information about how to obtain a model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5****c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'ModelId' => ['title' => '', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'model-rbvg5wzljz****ks92'], 'ModelName' => ['title' => '', 'description' => 'The model name.', 'type' => 'string', 'example' => 'Sentiment analysis'], 'ModelDescription' => ['title' => '', 'description' => 'The model description.', 'type' => 'string', 'example' => 'General sentiment analysis.'], 'GmtCreateTime' => ['title' => '', 'description' => 'The UTC time when the model was created. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The UTC time when the model was last updated. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1234567890******'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1234567890******'], 'Origin' => ['title' => '', 'description' => 'The source of the model. This indicates the community or organization to which the source model belongs, such as ModelScope and HuggingFace.', 'type' => 'string', 'example' => 'ModelScope'], 'Provider' => ['title' => '', 'description' => 'The provider.', 'type' => 'string', 'example' => 'pai'], 'Domain' => ['title' => '', 'description' => 'The domain. This indicates the domain of the problem that the model is designed to solve, such as natural language processing (NLP) and computer vision (CV).', 'type' => 'string', 'example' => 'cv'], 'Task' => ['title' => '', 'description' => 'The task. This indicates the specific problem that the model is designed to solve, such as text classification.', 'type' => 'string', 'example' => 'text-classification'], 'ModelDoc' => ['title' => '', 'description' => 'The model document.', 'type' => 'string', 'example' => 'https://***.md'], 'Labels' => [ 'title' => '', 'description' => 'The list of labels for the model.', 'type' => 'array', 'items' => ['description' => 'The label.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'example' => '', ], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '234**'], 'Accessibility' => ['title' => '', 'description' => 'The visibility of the workspace. Valid values:'."\n" ."\n" .'- PRIVATE: The model is visible only to you and administrators in the workspace.'."\n" ."\n" .'- PUBLIC: The model is visible to everyone in the workspace.', 'type' => 'string', 'example' => 'PUBLIC'], 'LatestVersion' => ['title' => '', 'description' => 'The latest version of the model.', '$ref' => '#/components/schemas/ModelVersion', 'example' => ''], 'ModelType' => ['title' => '', 'description' => 'The model type.', 'type' => 'string', 'example' => 'Checkpoint'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information about the model.', 'type' => 'object', 'example' => '{'."\n" .' "RatingCount": 2866,'."\n" .' "Rating": 4.94,'."\n" .' "FavoriteCount": 34992,'."\n" .' "CommentCount": 754,'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" .' "TippedAmountCount": 32,'."\n" .' "DownloadCount": 606056'."\n" .'}'], 'OrderNumber' => ['title' => '', 'description' => 'The ordinal number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ParameterSize' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of parameters, in millions.', 'title' => '', 'example' => '3000'], 'GmtLatestVersionModifiedTime' => ['type' => 'string', 'description' => 'The time when the latest version was updated.', 'title' => '', 'example' => '2021-01-30T12:51:33.028Z'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\",\\n \\"ModelName\\": \\"Sentiment analysis\\",\\n \\"ModelDescription\\": \\"General sentiment analysis.\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Provider\\": \\"pai\\",\\n \\"Domain\\": \\"cv\\",\\n \\"Task\\": \\"text-classification\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n },\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"ExtraInfo\\": {\\n \\"RatingCount\\": 2866,\\n \\"Rating\\": 4.94,\\n \\"FavoriteCount\\": 34992,\\n \\"CommentCount\\": 754,\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png\\"\\n ],\\n \\"TippedAmountCount\\": 32,\\n \\"DownloadCount\\": 606056\\n },\\n \\"OrderNumber\\": 1,\\n \\"ParameterSize\\": 3000,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\"\\n}","type":"json"}]', 'title' => 'GetModel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paimodel:GetModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetModelVersion' => [ 'summary' => 'Retrieves a model version.', 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133779', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information about how to obtain the model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wzljz****ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'required' => true, 'example' => '1.0.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'GmtCreateTime' => ['title' => '', 'description' => 'The UTC time when the model was created. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The UTC time when the model was last updated. The time is in the ISO 8601 format.', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'], 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1234567890******'], 'OwnerId' => ['title' => '', 'description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1234567890******'], 'Uri' => ['title' => '', 'description' => 'The URI of the model version. This is the storage location of the model. Valid values:'."\n" ."\n" .'- The HTTP or HTTPS URL of the model. Example: `https://myweb.com/mymodel.tar.gz`.'."\n" ."\n" .'- If the model is stored in Object Storage Service (OSS), the format is `oss://./object`. For more information about how to configure the endpoint, see [Endpoints](~~31837~~). Example: `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.', 'type' => 'string', 'example' => 'oss://t***.cn-beijing.oss.aliyuncs.com/mod**/'], 'Labels' => [ 'title' => '', 'description' => 'The list of labels for the model version.', 'type' => 'array', 'items' => ['description' => 'The label.', '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'example' => '', ], 'Options' => ['title' => '', 'description' => 'The extended field. This field is a JSON string.', 'type' => 'string', 'example' => '{}'], 'VersionName' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'example' => '0.1.0'], 'VersionDescription' => ['title' => '', 'description' => 'The description of the model version.', 'type' => 'string', 'example' => 'General sentiment analysis.'], 'TrainingSpec' => ['title' => '', 'description' => 'The training configuration. This is the configuration for fine-tuning and incremental training.', 'type' => 'object', 'example' => '{}'], 'InferenceSpec' => ['title' => '', 'description' => 'Describes how to apply the model to a downstream inference service. For example, this can describe the processor and container for Elastic Algorithm Service (EAS).', 'type' => 'object', 'example' => '{'."\n" .' "Processor": "tensorflow_gpu_1.12"'."\n" .'}'], 'FormatType' => [ 'title' => '', 'description' => 'The model format. Valid values:'."\n" ."\n" .'- OfflineModel'."\n" ."\n" .'- SavedModel'."\n" ."\n" .'- Keras H5'."\n" ."\n" .'- Frozen Pb'."\n" ."\n" .'- Caffe Prototxt'."\n" ."\n" .'- TorchScript'."\n" ."\n" .'- XGBoost'."\n" ."\n" .'- PMML'."\n" ."\n" .'- AlinkModel'."\n" ."\n" .'- ONNX', 'type' => 'string', 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], 'example' => 'SavedModel', ], 'FrameworkType' => [ 'title' => '', 'description' => 'The model framework. Valid values:'."\n" ."\n" .'- Pytorch'."\n" .' -XGBoost'."\n" ."\n" .'- Keras'."\n" ."\n" .'- Caffe'."\n" ."\n" .'- Alink'."\n" ."\n" .'- Xflow'."\n" ."\n" .'- TensorFlow', 'type' => 'string', 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], 'example' => 'TensorFlow', ], 'SourceType' => [ 'title' => '', 'description' => 'The source type of the model. Valid values:'."\n" ."\n" .'- Custom: The model is a custom model.'."\n" ."\n" .'- PAIFlow: The model is from a PAI pipeline.'."\n" ."\n" .'- TrainingService: The model is from a PAI training service.', 'type' => 'string', 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], 'SourceId' => ['title' => '', 'description' => 'The source ID.'."\n" ."\n" .'- If the source type is Custom, this field has no limits.'."\n" ."\n" .'- If the source is PAIFlow or TrainingService, the format is:'."\n" ."\n" .'```'."\n" .'region=,workspaceId=,kind=,id='."\n" .'```'."\n" ."\n" .'The parameters are:'."\n" ."\n" .'- region: The ID of the Alibaba Cloud region.'."\n" ."\n" .'- workspaceId: The workspace ID.'."\n" ."\n" .'- kind: The type. Valid values: PipelineRun (PAI pipeline) and ServiceJob (training service).'."\n" ."\n" .'- id: The unique identifier.', 'type' => 'string', 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" ."\n" .'- Pending: The model is pending approval.'."\n" ."\n" .'- Approved: The model is approved for publishing.'."\n" ."\n" .'- Rejected: The model is rejected for publishing.', 'type' => 'string', 'example' => 'Approved'], 'EvaluationSpec' => ['title' => '', 'description' => 'The evaluation configuration.', 'type' => 'object', 'example' => '{}'], 'CompressionSpec' => ['title' => '', 'description' => 'The compression configuration.', 'type' => 'object', 'example' => '{}'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information.', 'type' => 'object', 'example' => '{'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" .' "TrainedWords": ["albedo_overlord"]'."\n" .'}'], 'Metrics' => ['title' => '', 'description' => 'The metrics.', 'type' => 'object', 'example' => '{}'], 'DistillationSpec' => ['type' => 'object', 'description' => 'The distillation configuration.', 'title' => '', 'example' => '{}'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"UserId\\": \\"1234567890******\\",\\n \\"OwnerId\\": \\"1234567890******\\",\\n \\"Uri\\": \\"oss://t***.cn-beijing.oss.aliyuncs.com/mod**/\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{}\\",\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"VersionDescription\\": \\"General sentiment analysis.\\",\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"Processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"Metrics\\": {},\\n \\"DistillationSpec\\": {}\\n}","type":"json"}]', 'title' => 'GetModelVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModelVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paimodel:GetModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'GetPermission' => [ 'summary' => 'Retrieves the permissions of a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions/{PermissionCode}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '14248', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'PermissionCode', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The name of the permission, which is unique within a region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~). For information about how to obtain the permission name, see [ListPermissions](~~449132~~).', 'type' => 'string', 'required' => true, 'example' => 'PaiDLC:GetTensorboard'."\n"], ], [ 'name' => 'Accessibility', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can access the instance.'."\n" .'- PRIVATE: Only the creator can access the instance.', 'type' => 'string', 'example' => 'PUBLIC', 'required' => false], ], [ 'name' => 'Creator', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Alibaba Cloud account UID of the workspace permission creator.', 'type' => 'string', 'example' => '17915******4216', 'required' => false], ], [ 'name' => 'Resource', 'in' => 'query', 'schema' => ['description' => 'The resource.', 'type' => 'string', 'required' => false, 'example' => 'job/dlc-ksd******s12', 'title' => ''], ], [ 'name' => 'Option', 'in' => 'query', 'schema' => ['description' => 'The optional configurations. Separate multiple configurations with commas (,). Valid values:'."\n" .'- ResourceEmpty: The resource is empty. The resource is empty if Resource is not specified.'."\n" .'- DisableRam: RAM authentication is not performed.', 'type' => 'string', 'required' => false, 'example' => 'ResourceEmpty,DisableRam', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', 'style' => 'json', 'schema' => ['type' => 'object', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'CallerUid', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CallerType', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CallerAccessKeyId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CallerSecurityToken', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'PermissionCode' => ['title' => '', 'description' => 'The name of the permission, which is unique within the same region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~).', 'type' => 'string', 'example' => 'PaiDLC:ListJobs'], 'PermissionRules' => [ 'description' => 'The list of permission rules.', 'type' => 'array', 'items' => [ 'description' => 'The permission rule.', 'type' => 'object', 'properties' => [ 'Accessibility' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can perform operations.'."\n" .'- PRIVATE: Only the creator can perform operations.'."\n" .'- ANY: Both the creator and non-creators can perform operations.', 'type' => 'string', 'example' => 'PRIVATE'], 'EntityAccessType' => ['title' => '', 'description' => 'The access type.'."\n" .'When Accessibility is set to PUBLIC, all users can perform operations and this value does not take effect.'."\n" .'When Accessibility is set to PRIVATE, EntityAccessType supports the following values:'."\n" .'- CREATOR: Only the creator can perform operations.'."\n" .'- ANY: Both the creator and non-creators can perform operations.', 'type' => 'string', 'example' => 'CREATOR'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Retrieve workspace permissions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermission'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'pai:AdministratePAI', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"PermissionCode\\": \\"PaiDLC:ListJobs\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n}","type":"json"}]', ], 'GetRun' => [ 'summary' => 'Retrieves run details.', 'path' => '/api/v1/runs/{RunId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '233505', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The run ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to get information about metrics, parameters, and labels. This parameter is optional. The default value is false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The information about the run instance.', '$ref' => '#/components/schemas/Run', 'title' => '', 'example' => ''], ], ], 'title' => 'GetRun', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetRun'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:GetRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetWorkspace' => [ 'summary' => 'Retrieves the details of a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '14101', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '12345'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return additional information, such as the workspace owner. Valid values:'."\n" ."\n" .'- false (default): Does not return additional information.'."\n" ."\n" .'- true: Returns additional information.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '1234'], 'WorkspaceName' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'example' => 'workspace-example'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the workspace was created. The time is in UTC and follows the ISO 8601 standard.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the workspace was last modified. The time is in UTC and follows the ISO 8601 standard.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'DisplayName' => ['title' => '', 'description' => 'The display name of the workspace.', 'type' => 'string', 'example' => 'workspace-example'], 'Description' => ['title' => '', 'description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'workspace description example'], 'EnvTypes' => [ 'title' => '', 'description' => 'The environments that the workspace contains. Valid values:'."\n" ."\n" .'- A workspace in basic mode has only the production environment (prod).'."\n" ."\n" .'- A workspace in standard mode has both the development environment (dev) and the production environment (prod).', 'type' => 'array', 'items' => ['description' => 'The environment type. Valid values:'."\n" ."\n" .'- dev: the development environment.'."\n" ."\n" .'- prod: the production environment.', 'type' => 'string', 'title' => '', 'example' => 'prod'], 'example' => '', ], 'Creator' => ['title' => '', 'description' => 'The ID of the user who created the workspace.', 'type' => 'string', 'example' => '1157******94123'], 'Status' => ['title' => '', 'description' => 'The status of the workspace. Valid values:'."\n" ."\n" .'- ENABLED: The workspace is running as normal.'."\n" ."\n" .'- INITIALIZING: The workspace is being initialized.'."\n" ."\n" .'- FAILURE: The workspace failed to be created.'."\n" ."\n" .'- DISABLED: The workspace is manually disabled.'."\n" ."\n" .'- FROZEN: The workspace is frozen due to an overdue payment.'."\n" ."\n" .'- UPDATING: The workspace is being updated.', 'type' => 'string', 'example' => 'ENABLED'], 'AdminNames' => [ 'title' => '', 'description' => 'The list of administrator account names.', 'type' => 'array', 'items' => ['description' => 'The administrator account name. This parameter is returned only when Verbose is set to true.', 'type' => 'string', 'title' => '', 'example' => 'demo_test@***.aliyunid.com'], 'example' => '', ], 'IsDefault' => ['title' => '', 'description' => 'Indicates whether the workspace is the default workspace. Valid values:'."\n" ."\n" .'- false: The workspace is not the default workspace.'."\n" ."\n" .'- true: The workspace is the default workspace.', 'type' => 'boolean', 'example' => 'true'], 'ExtraInfos' => ['title' => '', 'description' => 'Additional information. This parameter currently contains the tenant ID (TenantId).', 'type' => 'object', 'example' => '{"TenantId": "4286******98"}'], 'Owner' => [ 'description' => 'The information about the workspace owner. This parameter is returned only when Verbose is set to true.', 'type' => 'object', 'properties' => [ 'UserKp' => ['description' => 'The user UID.', 'type' => 'string', 'title' => '', 'example' => '1157******94123'], 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '1157******94123'], 'UserName' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'example' => 'mings****t'], 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'title' => '', 'example' => 'mings****t'], ], 'title' => '', 'example' => '', ], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'rg-acfmwp7rkyq****'], ], 'example' => '', ], ], ], 'title' => 'GetWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DisplayName\\": \\"workspace-example\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Creator\\": \\"1157******94123\\",\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": true,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"Owner\\": {\\n \\"UserKp\\": \\"1157******94123\\",\\n \\"UserId\\": \\"1157******94123\\",\\n \\"UserName\\": \\"mings****t\\",\\n \\"DisplayName\\": \\"mings****t\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmwp7rkyq****\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'GetWorkspaceRole' => [ 'summary' => 'Gets information about a specific role within a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/{RoleId}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '221948', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. You can obtain this ID by calling the [ListWorkspaces](~~449124~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'image-tzi7f9czc0cxs9s45t', 'title' => ''], ], [ 'name' => 'RoleId', 'in' => 'path', 'schema' => ['description' => 'The custom role ID.', 'type' => 'string', 'required' => false, 'example' => 'role-sw******2tij', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'], 'RoleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'dev-test', 'title' => ''], 'RoleId' => ['description' => 'The role ID.', 'type' => 'string', 'example' => 'role-dhg*******'."\n", 'title' => ''], 'GmtCreateTime' => ['description' => 'The time when the role was created. It is specified in UTC and formatted in ISO 8601.', 'type' => 'string', 'title' => '', 'example' => '2025-06-11T08:58:35.438Z'], 'GmtModifiedTime' => ['description' => 'The time when the role was last modified. It is specified in UTC and formatted in ISO 8601.', 'type' => 'string', 'title' => '', 'example' => '2026-03-27T02:26:33.872Z'], 'Creator' => ['description' => 'The Alibaba Cloud account UID of the creator.', 'type' => 'string', 'title' => '', 'example' => '2680******4103'], 'ModulePermissions' => ['description' => 'The permission configuration of the role.', '$ref' => '#/components/schemas/ModulePermissions', 'title' => '', 'example' => ''], 'Status' => ['description' => 'The task status. Valid values:'."\n" ."\n" .'- `Creating`: The role is being created.'."\n" ."\n" .'- `Updating`: The role is being updated.'."\n" ."\n" .'- `Deleting`: The role is being deleted.'."\n" ."\n" .'- `Succeeded`: The task succeeded.'."\n" ."\n" .'- `Failed`: The task failed.', 'type' => 'string', 'example' => 'Successful', 'title' => ''], ], 'title' => '', 'description' => 'The response parameters.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetWorkspaceRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\",\\n \\"RoleName\\": \\"dev-test\\",\\n \\"RoleId\\": \\"role-dhg*******\\\\n\\",\\n \\"GmtCreateTime\\": \\"2025-06-11T08:58:35.438Z\\",\\n \\"GmtModifiedTime\\": \\"2026-03-27T02:26:33.872Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleName\\": \\"PaiDesigner\\",\\n \\"PermissionType\\": \\"ReadOnly\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCodes\\": [\\n \\"PaiDLC:GetTensorboard\\"\\n ],\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Status\\": \\"Successful\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListCodeSources' => [ 'summary' => 'Queries a list of code configurations. This operation supports pagination, sorting, and conditional filtering.', 'path' => '/api/v1/codesources', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55462', 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The display name of the code configuration. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'MyDataSource'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the code configuration list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The field used for sorting. Valid values:'."\n" .'- GmtModifyTime: the time when the code source was last modified.'."\n" .'- DisplayName: the display name.'."\n" .'- CodeSourceId: the code source ID.'."\n" .'- GmtCreateTime (default): the time when the code source was created.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'GmtModifyTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The sort order for the specified field in a paged query. Valid values:'."\n" .'- ASC (default): ascending order.'."\n" .'- DESC: descending order.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'desc', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace ID. This parameter is required. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'CodeSources' => [ 'title' => '', 'description' => 'The list of code source configurations.', 'type' => 'array', 'items' => ['description' => 'The code configuration details.', '$ref' => '#/components/schemas/CodeSourceItem', 'title' => '', 'example' => ''], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of code source configurations that match the filter conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSources\\": [\\n {\\n \\"CodeSourceId\\": \\"code-202**********\\",\\n \\"DisplayName\\": \\"MyCodeSourceName1\\",\\n \\"Description\\": \\"code source of dlc examples\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/****\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da10**********\\",\\n \\"CodeRepoUserName\\": \\"user\\",\\n \\"CodeRepoAccessToken\\": \\"\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"UserId\\": \\"1157290171663117\\",\\n \\"WorkspaceId\\": \\"1234\\",\\n \\"GmtCreateTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"GmtModifyTime\\": \\"2021-01-18T12:52:15Z\\",\\n \\"MountPath\\": \\"/root/code/\\",\\n \\"CloneType\\": 0\\n }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'title' => 'List code configurations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCodeSources'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paicodesource:ListCodeSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListConfigs' => [ 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '117761', 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '87***'], ], [ 'name' => 'CategoryName', 'in' => 'query', 'schema' => ['description' => 'The category of the configuration item. The following categories are supported:'."\n" ."\n" .'- CommonResourceConfig: The common resource configuration.'."\n" ."\n" .'- DLCAutoRecycle: The automatic recycling configuration for DLC.'."\n" ."\n" .'- DLCPriorityConfig: The priority configuration for DLC.'."\n" ."\n" .'- DSWPriorityConfig: The priority configuration for DSW.'."\n" ."\n" .'- QuotaMaximumDuration: The configuration for the maximum runtime of a DLC task in a quota.'."\n" ."\n" .'- CommonTagConfig: The label configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CommonResourceConfig'], ], [ 'name' => 'ConfigKeys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: The path for temporary storage. This key is valid only when CategoryName is set to CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: The automatic recycling configuration. This key is valid only when CategoryName is set to DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: The priority configuration. This key is valid only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: The configuration for the maximum runtime of a DLC task in a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: The predefined labels for the workspace. Resources that you create must have these labels.', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['description' => 'The labels to use as filter conditions. Separate multiple labels with commas. A logical AND operation is performed on these labels.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1=value1,key2=value2'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return label information.'."\n" ."\n" .'- true: Returns label information.'."\n" ."\n" .'- false: Does not return label information.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], 'Configs' => [ 'title' => '', 'description' => 'The list of configuration items.', 'type' => 'array', 'items' => [ 'description' => 'The configuration item.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: The path for temporary storage. This key is valid only when CategoryName is set to CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: The automatic recycling configuration. This key is valid only when CategoryName is set to DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: The priority configuration. This key is valid only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: The configuration for the maximum runtime of a DLC task in a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: The predefined labels for the workspace. Resources that you create must have these labels.', 'type' => 'string', 'example' => 'tempTableLifecycle'], 'ConfigValue' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'oss://***'."\n"], 'Labels' => [ 'description' => 'The list of labels for the configuration item.', 'type' => 'array', 'items' => [ 'description' => 'The label of the configuration item.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the label.', 'type' => 'string', 'title' => '', 'example' => 'key1'], 'Value' => ['description' => 'The value of the label.', 'type' => 'string', 'title' => '', 'example' => 'value1'."\n"], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListConfigs', 'summary' => 'Lists the configurations for a workspace.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"tempTableLifecycle\\",\\n \\"ConfigValue\\": \\"oss://***\\\\n\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\\\n\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListConnections' => [ 'summary' => 'Queries a list of connections.', 'path' => '/api/v1/connections', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267625', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'Workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that marks the starting position for the next page of results.', 'type' => 'string', 'required' => false, 'example' => '15', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'Maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'Field by which to sort results. Default value: GmtCreateTime. Valid values:'."\n" ."\n" .'- GmtCreateTime (default): sorts by creation time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'Sort order. Use with the SortBy parameter. Valid values:'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC (default): descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'ConnectionIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'List of connection IDs to filter by.', 'type' => 'array', 'items' => ['description' => 'Connection ID.', 'type' => 'string', 'required' => false, 'example' => 'conn-ljasd***jsx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ConnectionName', 'in' => 'query', 'schema' => ['description' => 'Connection name. Supports fuzzy matching.', 'type' => 'string', 'example' => 'Database connection', 'required' => false, 'title' => ''], ], [ 'name' => 'ConnectionTypes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'List of connection types to filter by.', 'type' => 'array', 'items' => ['description' => 'Connection type. Valid values:'."\n" ."\n" .'- DashScopeConnection: Model Studio connection.'."\n" ."\n" .'- OpenLLMConnection: open source model connection.'."\n" ."\n" .'- MilvusConnection: Milvus connection.'."\n" ."\n" .'- OpenSearchConnection: OpenSearch connection.'."\n" ."\n" .'- LindormConnection: Lindorm connection.'."\n" ."\n" .'- ElasticsearchConnection: Elasticsearch connection.'."\n" ."\n" .'- HologresConnection: Hologres connection.'."\n" ."\n" .'- RDSConnection: RDS connection.'."\n" ."\n" .'- CustomConnection: custom connection.', 'type' => 'string', 'required' => false, 'example' => 'OpenLLMConnection', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'EncryptOption', 'in' => 'query', 'schema' => ['description' => 'Encryption option for sensitive fields in the response. Valid values:'."\n" ."\n" .'- PlainText: returns values in plaintext.'."\n" ."\n" .'- Secret: returns values in ciphertext.', 'type' => 'string', 'required' => false, 'example' => 'PlainText', 'title' => ''], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['description' => 'Model identifier. Filters connections associated with this model.', 'type' => 'string', 'required' => false, 'example' => 'model_001', 'title' => ''], ], [ 'name' => 'ModelTypes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'List of model types to filter by.', 'type' => 'array', 'items' => ['description' => 'Model type. Valid values:'."\n" ."\n" .'- LLM'."\n" ."\n" .'- Embedding'."\n" ."\n" .'- ReRank', 'type' => 'string', 'required' => false, 'example' => 'LLM', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ToolCall', 'in' => 'query', 'schema' => ['description' => 'Whether tool calling is supported. Valid values:'."\n" ."\n" .'- true: supported.'."\n" ."\n" .'- false: not supported.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Creator', 'in' => 'query', 'schema' => ['description' => 'Alibaba Cloud account ID of the creator.', 'type' => 'string', 'required' => false, 'example' => '12908*******3242', 'title' => ''], ], [ 'name' => 'Accessibility', 'in' => 'query', 'schema' => ['description' => 'Visibility of the connection. Valid values:'."\n" ."\n" .'- PUBLIC: visible to all workspace members.'."\n" ."\n" .'- PRIVATE: visible only to the creator.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Connections' => [ 'description' => 'List of connections.', 'type' => 'array', 'items' => ['description' => 'Connection object.', '$ref' => '#/components/schemas/Connection', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'MaxResults' => ['description' => 'Maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'Token for retrieving the next page of results.', 'type' => 'string', 'example' => '15', 'title' => ''], 'TotalCount' => ['description' => 'Total number of connections that match the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '27', 'title' => ''], 'RequestId' => ['description' => 'Request ID. Used for troubleshooting.', 'type' => 'string', 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Connections\\": [\\n {\\n \\"ConnectionType\\": \\"ElasticsearchConnection\\",\\n \\"Description\\": \\"This is a description of a database connection.\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"WorkspaceId\\": \\"228**\\",\\n \\"Creator\\": \\"20925961****557803\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceName\\": \\"lindorm-xxxxxxx\\",\\n \\"InstanceId\\": \\"ld-2vc1***v1zaqgzol\\",\\n \\"Extra\\": \\"{\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxx\\\\\\"}\\"\\n },\\n \\"GmtModifiedTime\\": \\"2025-03-07T07:54:56Z\\\\n\\",\\n \\"ConnectionName\\": \\"lindorm-connection\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\",\\n \\"GmtCreateTime\\": \\"2025-03-07T07:54:56Z\\\\n\\",\\n \\"Secrets\\": {\\n \\"key\\": \\"Dsjk***hsl01\\\\n\\"\\n },\\n \\"Configs\\": {\\n \\"key\\": \\"12345\\"\\n },\\n \\"Models\\": [\\n {\\n \\"Model\\": \\"model_001\\",\\n \\"DisplayName\\": \\"BGE model deploy.\\",\\n \\"ModelType\\": \\"LLM\\",\\n \\"ToolCall\\": true\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"15\\",\\n \\"TotalCount\\": 27,\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\"\\n}","type":"json"}]', 'title' => 'ListConnections', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnections'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListConnections', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListDatasetFileMetas' => [ 'summary' => 'Queries the files in a dataset.', 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '259940', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The dataset ID. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The version name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'v1', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace where the dataset is located. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '105173', 'title' => ''], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => 'The search type. Valid values:'."\n" ."\n" .'- MIX: Mixed search. This is the default value.'."\n" ."\n" .'- TAG: Searches by tag only.'."\n" ."\n" .'- VECTOR: Searches by vector only.', 'enumValueTitles' => ['TAG' => 'TAG', 'MIX' => 'MIX', 'VECTOR' => 'VECTOR'], 'type' => 'string', 'required' => false, 'example' => 'MIX', 'title' => '', ], ], [ 'name' => 'QueryText', 'in' => 'query', 'schema' => ['description' => 'The text to search for.', 'type' => 'string', 'required' => false, 'example' => 'A fallen water', 'title' => ''], ], [ 'name' => 'TopK', 'in' => 'query', 'schema' => ['description' => 'The maximum number of search results to return.'."\n" ."\n" .'> This parameter is valid only when \\`QueryType\\` is set to \\`VECTOR\\` or \\`MIX\\`.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '5000', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'ScoreThreshold', 'in' => 'query', 'schema' => ['description' => 'The similarity score threshold. Only results with a score greater than this threshold are returned.'."\n" ."\n" .'> This parameter is valid only when \\`QueryType\\` is set to \\`VECTOR\\` or \\`MIX\\`.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.6', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. If you also specify \\`MaxResults\\`, the value of \\`MaxResults\\` takes precedence.'."\n" ."\n" .'> This parameter is deprecated. Use \\`NextToken\\` and \\`MaxResults\\` for paginated queries.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token.'."\n" ."\n" .'> If you do not specify this parameter, the first page of results is returned. If a value is returned for this parameter, more results are available. To get the next page, use the returned token in your next request. Repeat this process until no token is returned, which indicates that all results have been retrieved.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => '90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000', 'title' => '', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The field to sort by for paginated queries. If you do not specify this parameter, results are sorted by relevance from high to low. Other valid values are as follows:'."\n" ."\n" .'- FileCreateTime: Sort by file creation time.'."\n" ."\n" .'- FileUpdateTime: Sort by file last modified time.', 'enumValueTitles' => ['FileCreateTime' => 'FileCreateTime', 'FileUpdateTime' => 'FileUpdateTime'], 'type' => 'string', 'required' => false, 'example' => 'FileCreateTime', 'title' => '', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => 'The sort order for the specified field in a paginated query. Use this parameter with \\`SortBy\\`. The default value is \\`DESC\\`. Valid values:'."\n" ."\n" .'- ASC: Ascending.'."\n" ."\n" .'- DESC: Descending.', 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => '', ], ], [ 'name' => 'EndFileUpdateTime', 'in' => 'query', 'schema' => ['description' => 'The start time for the query that filters files by update time. The time must be a UTC timestamp in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n", 'title' => ''], ], [ 'name' => 'StartFileUpdateTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range for a query based on file update time. The value is a UTC timestamp in ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n", 'title' => ''], ], [ 'name' => 'QueryImage', 'in' => 'query', 'schema' => ['description' => 'The image information to use for an image-based search.'."\n" ."\n" .'- Specify the public URL of an image in an OSS bucket. The format is \\`oss\\://{bucket\\_name}/{object\\_path}\\`. \\`bucket\\_name\\` is the name of the bucket, and \\`object\\_path\\` is the path of the file in the bucket.'."\n" ."\n" .'> This parameter is valid only when \\`QueryType\\` is set to \\`VECTOR\\` or \\`MIX\\`.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-xxx-oss/car/0001.png', 'title' => ''], ], [ 'name' => 'ThumbnailMode', 'in' => 'query', 'schema' => ['description' => 'The mode for generating image thumbnails. Thumbnails are supported only for files in OSS.'."\n" ."\n" .'- Proportional scaling: \\`p\\_{percentage}\\`. The \\`percentage\\` parameter specifies the scaling ratio. Valid values: 1 to 100. For example, \\`p\\_50\\` scales the image to 50% of its original size.'."\n" ."\n" .'- Fixed width, adaptive height: \\`w\\_{width}\\`. The \\`width\\` parameter specifies the image width. Valid values: 1 to 16,384. For example, \\`w\\_200\\` sets the image width to 200 pixels and scales the height adaptively.'."\n" ."\n" .'- Fixed height, adaptive width: \\`h\\_{height}\\`. The \\`height\\` parameter specifies the image height. Valid values: 1 to 16,384. For example, \\`h\\_100\\` sets the image height to 100 pixels and scales the width adaptively.'."\n" ."\n" .'- Fixed width and height with padding: \\`m\\_pad,w\\_{width},h\\_{height},color\\_{RGB}\\`. The \\`m\\_pad\\` parameter scales the image to the maximum size that fits within a rectangle of the specified width and height. The \\`RGB\\` parameter specifies the color for the centered padding in the empty areas. If you do not specify this parameter, the empty areas are filled with white by default. The \\`width\\` and \\`height\\` parameters specify the image width and height. The values for both \\`width\\` and \\`height\\` must be between 1 and 16,384.'."\n" ."\n" .'- Fixed width and height with center crop: \\`m\\_fill,w\\_{width},h\\_{height}\\`. The \\`m\\_fill\\` parameter proportionally scales the image to the minimum size that covers the specified width and height, and then crops the excess from the center. The \\`width\\` and \\`height\\` parameters specify the image width and height. The values for both \\`width\\` and \\`height\\` must be between 1 and 16,384. For example, \\`m\\_fill,w\\_100,h\\_100\\` scales and crops the image to 100 × 100 pixels from the center.'."\n" ."\n" .'- Forced width and height scaling: \\`m\\_fixed,w\\_{width},h\\_{height}\\`. The \\`width\\` and \\`height\\` parameters specify the image width and height. The values for both \\`width\\` and \\`height\\` must be between 1 and 16,384. For example, \\`m\\_fixed,w\\_100,h\\_100\\` forces the image to be scaled to 100 × 100 pixels.', 'type' => 'string', 'required' => false, 'example' => 'w_100', 'title' => ''], ], [ 'name' => 'DatasetFileMetaIds', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'simple', 'schema' => [ 'maxItems' => 20, 'description' => 'A list of metadata IDs to query.', 'type' => 'array', 'items' => ['description' => 'Metadata ID.', 'type' => 'string', 'required' => false, 'example' => '5dc037c8ec0a6fc4e15741328e531bbee036exxxxxxxxx722eff66c38a90e08c', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueryTagsIncludeAll', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'simple', 'schema' => [ 'description' => 'The metadata IDs to query.', 'type' => 'array', 'items' => ['description' => 'The metadata ID.', 'type' => 'string', 'required' => false, 'example' => 'Lane line', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueryTagsIncludeAny', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'simple', 'schema' => [ 'description' => 'A condition that retrieves items that have all of the specified tags. The tags are specified as a comma-separated array. This condition is not applied if the parameter is empty.'."\n" ."\n" .'> This parameter takes effect only when QueryType is set to TAG or MIX. If QueryType is set to TAG, the value of QueryText is also added to this condition.', 'type' => 'array', 'items' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => 'Lane line', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueryTagsExclude', 'in' => 'query', 'allowEmptyValue' => true, 'style' => 'simple', 'schema' => [ 'description' => 'A comma-separated list of tags. The query returns files that match at least one of the specified tags. If you do not specify this parameter, this filter is ignored.'."\n" ."\n" .'> This parameter is valid only when QueryType is set to TAG or MIX.', 'type' => 'array', 'items' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => 'Lane line', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueryFileName', 'in' => 'query', 'schema' => ['description' => 'The tags to exclude from the query results. If you do not specify any tags, this filter is not applied.'."\n" ."\n" .'> This parameter is valid only when QueryType is set to TAG or MIX.', 'type' => 'string', 'required' => false, 'example' => 'car', 'title' => ''], ], [ 'name' => 'QueryFileDir', 'in' => 'query', 'schema' => ['description' => 'The name of the file to retrieve. This parameter supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'cars/20250221/', 'title' => ''], ], [ 'name' => 'QueryFileTypeIncludeAny', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'The search keyword for the file directory. Fuzzy search is supported.', 'type' => 'array', 'items' => ['description' => 'The file type.', 'type' => 'string', 'required' => false, 'example' => 'image', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueryContentTypeIncludeAny', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The content type of the file.', 'type' => 'string', 'required' => false, 'example' => 'image/jpeg', 'title' => ''], 'description' => 'A search condition to include any of the specified content types. The search results must match at least one of these types. You can specify multiple content types. If this parameter is empty, this condition is not applied. Use commas to separate multiple types in the array.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'StartTagUpdateTime', 'in' => 'query', 'schema' => ['description' => 'The file content types. The query returns files that match any of the specified types. You can specify multiple types and separate them with commas. If this parameter is empty, this filter is ignored.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n", 'title' => ''], ], [ 'name' => 'EndTagUpdateTime', 'in' => 'query', 'schema' => ['description' => 'The start time for querying tags by their last update time. The time must be in UTC and in the ISO 8601 format.', 'type' => 'string', 'format' => 'iso8601_normal', 'required' => false, 'example' => '2025-01-12T14:36:01.000Z'."\n", 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The end of the time range for a query that filters tags by their last update time. The time is a UTC timestamp in ISO 8601 format.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'QueryExpression', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'string', 'required' => false, 'example' => '(FileUpdateTime > \'2025-02-28T00:00:00Z\' AND FileUpdateTime < \'2025-05-30T09:27:29Z\') AND FileDir:\'blue_car\' AND NOT FileName="toyota.jpg" AND (( Tags.all=\'lane line\' AND Tags.all=\'barrier gate\') OR NOT Tags.user=\'rainy days\' ) AND HAS SemanticIndexJobId AND Content:\'a fallen water horse\' AND TopK=100 AND SignMode=\'PUBLIC\'', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'A query statement, also known as a Domain-Specific Language (DSL) query, lets you express complex retrieval conditions. It supports grouping, Boolean logic (AND/OR/NOT), range comparisons (>, >=, <, <=), property existence (HAS/NOT HAS), tokenized matches (:), and exact matches (=). Use DSL for advanced retrieval scenarios.'."\n" .'>To avoid conflicts, do not use this query statement with other query parameters.>', 'type' => 'string', 'enum' => ['ACTIVE', 'ALL', 'DELETED'], 'required' => false, 'example' => 'ACTIVE', 'title' => '', ], ], [ 'name' => 'QueryVideo', 'in' => 'query', 'schema' => ['description' => 'The status of the metadata to query.'."\n" ."\n" .'- ACTIVE: Returns metadata for active files. This is the default value.'."\n" ."\n" .'- ALL: Returns metadata for all files.'."\n" ."\n" .'- DELETED: Returns metadata for logically deleted files.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-xxx-oss/car/0001.mp4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request result.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => '30', 'title' => ''], 'NextToken' => ['description' => 'The pagination token. If the number of results that match the query exceeds the page size, this token is returned. To retrieve the next page of data, use the returned token in your next request. Repeat this process until no token is returned, which indicates that all data has been retrieved.', 'type' => 'string', 'example' => '90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000', 'title' => ''], 'DatasetFileMetas' => [ 'description' => 'The detailed metadata of the dataset files.', 'type' => 'array', 'items' => ['description' => 'The detailed metadata of the dataset file.', '$ref' => '#/components/schemas/DatasetFileMeta', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'DatasetId' => ['description' => 'The dataset ID.', 'type' => 'string', 'example' => 'd-rbvg5*****jhc9ks92'."\n", 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '105173', 'title' => ''], 'DatasetVersion' => ['description' => 'The version name of the dataset.', 'type' => 'string', 'example' => 'v1', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results returned per page when you use the \\`NextToken\\` parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 30,\\n \\"NextToken\\": \\"90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000\\",\\n \\"DatasetFileMetas\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6\\",\\n \\"Uri\\": \\"oss://test-bucket/dataset/cat.png\\",\\n \\"FileName\\": \\"cat.png\\",\\n \\"DownloadUrl\\": \\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D\\",\\n \\"Score\\": 0.6,\\n \\"DataSize\\": 120000,\\n \\"FileFingerPrint\\": \\"D41D8CD98F*****E9800998ECF8\\\\n\\",\\n \\"FileUpdateTime\\": \\"2025-01-12T14:36:01Z\\",\\n \\"Tags\\": \\"{\\\\n \\\\\\"ai\\\\\\":\\\\n [\\\\n \\\\\\"Lane line\\\\\\",\\\\n \\\\\\"Water horse\\\\\\",\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ],\\\\n \\\\\\"user\\\\\\":\\\\n [\\\\n \\\\\\"Everett\\\\\\",\\\\n \\\\\\"Intelligent driving Dataset 1\\\\\\",\\\\n \\\\\\"Cloudy day\\\\\\"\\\\n ],\\\\n \\\\\\"user-delete-ai-tags\\\\\\":\\\\n [\\\\n \\\\\\"Sunny day\\\\\\"\\\\n ]\\\\n}\\",\\n \\"ThumbnailUrl\\": \\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D\\",\\n \\"MetaAttributes\\": \\"{ \\\\\\"ImageHeight\\\\\\": 400, \\\\\\"ImageWidth\\\\\\": 800 }\\",\\n \\"SemanticIndexJobId\\": \\"dsjob-klfwtjto****scvt3\\",\\n \\"SemanticIndexUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileCreateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileType\\": \\"image\\",\\n \\"ContentType\\": \\"image/jpeg\\",\\n \\"Status\\": \\"ACTIVE\\"\\n }\\n ],\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\\\n\\",\\n \\"WorkspaceId\\": \\"105173\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', 'title' => 'ListDatasetFileMetas', 'requestParamsDescription' => '## DSL query syntax'."\n" ."\n" .'| Keyword | Description | Example |'."\n" .'| ------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| : | Token match | `FileName:\'lane line\'`
Finds data where the tokenized file name contains "lane line". |'."\n" .'| NOT : | Token non-match | `NOT FileName : \'lane line\'`
Finds data where the tokenized file name does not contain "lane line". |'."\n" .'| \\= | Exact value match | `FileType=\'image\'`
Finds data where the file type is exactly "image". |'."\n" .'| NOT = | Exact value exclusion | `NOT FileType = \'video\'`
Finds all data where FileType is not equal to "video". |'."\n" .'| HAS | Exists | `HAS SemanticIndexJobId`
Finds all data that has the SemanticIndexJobId property. |'."\n" .'| NOT HAS | Does not exist | `NOT HAS SemanticIndexJobId`
Finds all data that does not have the SemanticIndexJobId property. |'."\n" .'| "" | Encloses a string value. | Single and double quotation marks have the same effect. |'."\n" .'| () | Grouping operation | `(FileName:\'black\' AND ContentType=\'image/jpeg\') OR (FileName:\'white\' AND ContentType=\'image/png\')`
Finds data where the file name contains the token "black" and the content type is "image/jpeg", or where the file name contains the token "white" and the content type is "image/png". |'."\n" .'| \\> | Range query:
Greater than | `FileUpdateTime> \'2025-01-16T11:52:56.000Z\' AND DataSize >= 12345`
The file was last modified after 2025-01-16T11:52:56.000Z and the file size is greater than or equal to 12,345 bytes. |'."\n" .'| \\>= | Range query:
Greater than or equal to | Same as above. |'."\n" .'| < | Range query:
Less than | `FileUpdateTime < \'2025-01-16T11:52:56.000Z\' AND DataSize <= 12345`
The file was last modified before 2025-01-16T11:52:56.000Z and the file size is less than or equal to 12,345 bytes. |'."\n" .'| <= | Range query:
Less than or equal to | Same as above. |'."\n" .'| AND | AND
The keyword is case-insensitive. | `FileType=\'image\' AND ContentType:\'image/png\'`
Finds images where the file type is "image" and the content type is "image/png". |'."\n" .'| OR | OR
The keyword is case-insensitive. | `FileType=\'image\' OR FileType=\'video\'`
Finds data where the file type is "image" or "video". |'."\n" ."\n" .'### Supported properties for DSL queries'."\n" ."\n" .'DSL queries support properties for basic file metadata, tags, vector search, and general search. All properties in the query conditions are optional.'."\n" ."\n" .'Type descriptions:'."\n" ."\n" .'- KEYWORD: Supports one or more of the following operations: equals, not equals, exists, and does not exist.'."\n" ."\n" .'- TEXT: Supports one or more of the following operations: token contains, token does not contain, equals, not equals, exists, and does not exist.'."\n" ."\n" .'- NUMBER: Supports one or more of the following operations: range query, equals, exists, and does not exist.'."\n" ."\n" .'- DATE: Supports one or more of the following operations: range query, exists, and does not exist.'."\n" ."\n" .'#### Basic metadata properties'."\n" ."\n" .'| Property name | Internal type | Token contains | Token does not contain | Equals | Not equals | Exists/Does not exist | Range query | AND logic | OR logic |'."\n" .'| ----------------------- | ------------- | -------------- | ---------------------- | ------ | ---------- | --------------------- | ----------- | --------- | -------- |'."\n" .'| DatasetFileMetaId | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| FileName | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| FileDir | TEXT | ✅ | ✅ | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| FileType | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| ContentType | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| DataSize | NUMBER | \\- | \\- | ✅ | \\- | ✅ | ✅ | ✅ | ✅ |'."\n" .'| FileUpdateTime | DATE | \\- | \\- | \\- | \\- | ✅ | ✅ | ✅ | ✅ |'."\n" .'| SyncTime | DATE | \\- | \\- | \\- | \\- | ✅ | ✅ | ✅ | ✅ |'."\n" .'| TagUpdateTime | DATE | \\- | \\- | \\- | \\- | ✅ | ✅ | ✅ | ✅ |'."\n" .'| SemanticIndexUpdateTime | DATE | \\- | \\- | \\- | \\- | ✅ | ✅ | ✅ | ✅ |'."\n" .'| Status | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" ."\n" .'#### Tag properties'."\n" ."\n" .'| Property name | Internal type | Token contains | Token does not contain | Equals | Not equals | Exists/Does not exist | Range query | AND logic | OR logic |'."\n" .'| ------------- | ------------- | -------------- | ---------------------- | ------ | ---------- | --------------------- | ----------- | --------- | -------- |'."\n" .'| Tags.ai | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| Tags.user | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" .'| Tags.all | KEYWORD | \\- | \\- | ✅ | ✅ | ✅ | \\- | ✅ | ✅ |'."\n" ."\n" .'#### Vector query properties'."\n" ."\n" .'| Property name | Internal type | Token contains | Token does not contain | Equals | Not equals | Exists/Does not exist | Range query | AND logic | OR logic |'."\n" .'| -------------- | ------------- | -------------- | ---------------------- | ------ | ---------- | --------------------- | ----------- | --------- | -------- |'."\n" .'| Content | TEXT | ✅ | \\- | ❌ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| TopK | NUMBER | \\- | \\- | ✅ | \\- | ❌ | ❌ | ✅ | ❌ |'."\n" .'| ScoreThreshold | NUMBER | \\- | \\- | ✅ | \\- | ❌ | ❌ | ✅ | ❌ |'."\n" ."\n" .'#### General query properties'."\n" ."\n" .'| Property name | Internal type | Token contains | Token does not contain | Equals | Not equals | Exists/Does not exist | Range query | AND logic | OR logic |'."\n" .'| ------------- | ------------- | -------------- | ---------------------- | ------ | ---------- | --------------------- | ----------- | --------- | -------- |'."\n" .'| QueryType | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| SignMode | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| ThumbnailMode | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| SortBy | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| Order | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| NextToken | KEYWORD | \\- | \\- | ✅ | ❌ | ❌ | \\- | ✅ | ❌ |'."\n" .'| MaxResults | NUMBER | \\- | \\- | ✅ | \\- | ❌ | ❌ | ✅ | ❌ |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetFileMetas'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListDatasetJobConfigs' => [ 'summary' => 'Lists dataset job configurations in batches.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261468', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '431514'], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'description' => 'The configuration type.'."\n" ."\n" .'- MultimodalIntelligentTag'."\n" ."\n" .'- MultimodalSemanticIndex', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['MultimodalIntelligentTag' => 'MultimodalIntelligentTag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], 'title' => '', 'example' => 'MultimodalIntelligentTag', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value starts from 1. The default value is 1.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The name of the dataset version.', 'required' => false, 'title' => '', 'example' => 'v1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '15'], 'DatasetJobConfigs' => [ 'description' => 'A list of dataset job configurations.', 'type' => 'array', 'items' => ['description' => 'A dataset job configuration.', '$ref' => '#/components/schemas/DatasetJobConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'ListDatasetJobConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobConfigs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:ListDatasetJobConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 15,\\n \\"DatasetJobConfigs\\": [\\n {\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxx\\",\\n \\"CreateTime\\": \\"2025-01-14T01:37:37Z\\",\\n \\"ModifyTime\\": \\"2024-10-11T02:18:54Z\\",\\n \\"ConfigType\\": \\"MultimodalIntelligentTag\\",\\n \\"Config\\": \\"{ \\\\\\"apiKey\\\\\\":\\\\\\"sk-xxxxxxxxxxxxxxxxxxxxx\\\\\\" }\\",\\n \\"WorkspaceId\\": \\"234*34\\",\\n \\"DatasetVersion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListDatasetJobs' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260535', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. To obtain this ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'example' => 'd-lfd60v0p****ujtsdx', 'title' => ''], ], [ 'name' => 'DatasetVersion', 'in' => 'query', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace. To obtain this ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '1234', 'title' => ''], ], [ 'name' => 'JobAction', 'in' => 'query', 'schema' => ['description' => 'The job action.', 'type' => 'string', 'required' => false, 'example' => 'SemanticIndex', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages are 1-indexed. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The job status.', 'enumValueTitles' => ['Succeeded' => 'Succeeded', 'Failed' => 'Failed', 'Starting' => 'Starting', 'Running' => 'Running', 'Deleted' => 'Deleted', 'Pending' => 'Pending', 'PartialFailed' => 'PartialFailed', 'Deleting' => 'Deleting', 'ManuallyStop' => 'ManuallyStop'], 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => '', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'The order in which to sort the results. This parameter is used with `SortBy`. Default: DESC.'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The field by which to sort the results. By default, the results are sorted by `CreateTime` in descending order.', 'enumValueTitles' => ['Status' => 'Status', 'JobAction' => 'JobAction', 'FinishTime' => 'FinishTime', 'CreateTime' => 'CreateTime'], 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'title' => '', ], ], [ 'name' => 'WithLogs', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], 'TotalCount' => ['description' => 'The total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DatasetJobs' => [ 'description' => 'A list of dataset jobs.', 'type' => 'array', 'items' => ['description' => 'The details of a dataset job.', '$ref' => '#/components/schemas/DatasetJob', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListDatasetJobs', 'summary' => 'Lists dataset jobs.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:ListDatasetJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"TotalCount\\": 1,\\n \\"DatasetJobs\\": [\\n {\\n \\"DatasetJobId\\": \\"dsjob-9jx1*****uj9e\\",\\n \\"JobAction\\": \\"SemanticIndex\\",\\n \\"CreateTime\\": \\"2023-06-20T04:05:59Z\\",\\n \\"FinishTime\\": \\"2023-06-20T06:03:48Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"Description\\": \\"This is a job description of a dataset.\\",\\n \\"JobMode\\": \\"Full\\",\\n \\"JobSpec\\": \\"{\\\\\\\\\\\\\\"modelId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Logs\\": [\\n \\"2025-02-17 09:58:10.143 INFO: Job completed successfully.\\"\\n ],\\n \\"TotalFileCount\\": 1000,\\n \\"CompletedFileCount\\": 990,\\n \\"FailedFileCount\\": 10,\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"WorkspaceId\\": \\"145883\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListDatasetVersions' => [ 'summary' => 'Retrieves a list of dataset versions.', 'path' => '/api/v1/datasets/{DatasetId}/versions', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232574', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5wz****c9ks92'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value starts from 1. The default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '10'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => 'The sort order for the paged query. The default value is ASC. Valid values:'."\n" ."\n" .'- ASC: Ascending order.'."\n" ."\n" .'- DESC: Descending order.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], 'title' => '', 'example' => 'ASC', ], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'schema' => ['description' => 'The label keys used to filter the dataset list. Datasets are returned if their label keys contain the specified strings.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1,key2'], ], [ 'name' => 'LabelValues', 'in' => 'query', 'schema' => ['description' => 'The label values used to filter the dataset list. Datasets are returned if their label values contain the specified strings.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1,value2'], ], [ 'name' => 'Properties', 'in' => 'query', 'schema' => [ 'description' => 'The dataset properties. Valid values:'."\n" ."\n" .'- DIRECTORY: Folder.'."\n" ."\n" .'- FILE: File.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'title' => '', 'example' => 'DIRECTORY', ], ], [ 'name' => 'SourceTypes', 'in' => 'query', 'schema' => [ 'description' => 'The source type. Valid values:'."\n" ."\n" .'- PAI-PUBLIC-DATASET: A public dataset from PAI.'."\n" ."\n" .'- ITAG: A dataset generated from the annotation results of the iTAG module.'."\n" ."\n" .'- USER: A dataset registered by a user.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'title' => '', 'example' => 'USER', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the data source.'."\n" ."\n" .'- If SourceTypes is USER, you can specify a custom ID.'."\n" ."\n" .'- If SourceTypes is ITAG, this is the ID of the iTAG annotation task.'."\n" ."\n" .'- If SourceTypes is PAI\\_PUBLIC\\_DATASET, this parameter is empty by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'd-a0xbe5n03bhqof46ce'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The field to use for sorting in a paged query. The default value is GmtCreateTime. Valid values:'."\n" ."\n" .'- GmtCreateTime (default): Creation time.'."\n" ."\n" .'- GmtModifiedTime: Modification time.'."\n" ."\n" .'- SourceType'."\n" ."\n" .'- DataSourceType'."\n" ."\n" .'- Property'."\n" ."\n" .'- DataSize'."\n" ."\n" .'- DataCount', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['SourceType' => 'SourceType', 'DataSourceType' => 'DataSourceType', 'DataSize' => 'DataSize', 'DataCount' => 'DataCount', 'Property' => 'Property', 'GmtCreateTime' => 'GmtCreateTime', 'GmtModifiedTime' => 'GmtModifiedTime', 'DatasetId' => 'DatasetId'], 'title' => '', 'example' => 'GmtCreateTime', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0648C5BB-68D0-54D2-92A5-607135B8806B'], 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'TotalCount' => ['description' => 'The number of resources that match the filter conditions.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '5'], 'DatasetVersions' => [ 'description' => 'The list of dataset versions.', 'type' => 'array', 'items' => ['description' => 'The dataset version.', '$ref' => '#/components/schemas/DatasetVersion', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListDatasetVersions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetVersions'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasetVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0648C5BB-68D0-54D2-92A5-607135B8806B\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 5,\\n \\"DatasetVersions\\": [\\n {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListDatasets' => [ 'summary' => 'Lists the datasets in a workspace.', 'path' => '/api/v1/datasets', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48568', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for the paged query. Starts at 1. The default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of datasets to return per page. The default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => 'The sort order for the results, based on the `SortBy` parameter. The default is `ASC`.'."\n" ."\n" .'- `ASC`: ascending order.'."\n" ."\n" .'- `DESC`: descending order.', 'enumValueTitles' => ['ASC' => 'ASC', 'DESC' => 'DESC'], 'type' => 'string', 'example' => 'ASC', 'required' => false, 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The dataset name. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'myName', 'title' => ''], ], [ 'name' => 'Properties', 'in' => 'query', 'schema' => [ 'description' => 'The dataset properties. To specify multiple properties, separate them with commas (,). Valid values:'."\n" ."\n" .'- `DIRECTORY`: A folder.'."\n" ."\n" .'- `FILE`: A file.', 'enumValueTitles' => ['DIRECTORY' => 'DIRECTORY', 'FILE' => 'FILE'], 'type' => 'string', 'example' => 'FILE', 'required' => false, 'title' => '', ], ], [ 'name' => 'DataSourceTypes', 'in' => 'query', 'schema' => [ 'description' => 'The data source type. To specify multiple types, separate them with commas (,). Valid values:'."\n" ."\n" .'- `NAS`: The data source is NAS.'."\n" ."\n" .'- `OSS`: The data source is OSS.', 'enumValueTitles' => ['NAS' => 'NAS', 'OSS' => 'OSS'], 'type' => 'string', 'example' => 'OSS', 'required' => false, 'title' => '', ], ], [ 'name' => 'DataTypes', 'in' => 'query', 'schema' => [ 'description' => 'The data type of the dataset. To specify multiple data types, separate them with commas (,). Valid values:'."\n" ."\n" .'- `VIDEO`: video.'."\n" ."\n" .'- `COMMON`: general.'."\n" ."\n" .'- `TEXT`: text.'."\n" ."\n" .'- `PIC`: image.'."\n" ."\n" .'- `AUDIO`: audio.', 'enumValueTitles' => ['VIDEO' => 'VIDEO', 'COMMON' => 'COMMON', 'TEXT' => 'TEXT', 'PIC' => 'PIC', 'AUDIO' => 'AUDIO'], 'type' => 'string', 'example' => 'COMMON,TEXT', 'required' => false, 'title' => '', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => ['description' => 'The source ID. The value of this parameter varies based on the `SourceTypes` value:'."\n" ."\n" .'- If `SourceTypes` is `USER`, you can specify a custom value for `SourceId`.'."\n" ."\n" .'- If `SourceTypes` is `ITAG`, `SourceId` is the ID of the iTAG task.'."\n" ."\n" .'- If `SourceTypes` is `PAI_PUBLIC_DATASET`, this parameter is empty by default.', 'type' => 'string', 'example' => 'd-rbvg5wzljzjhc9ks92', 'required' => false, 'title' => ''], ], [ 'name' => 'SourceTypes', 'in' => 'query', 'schema' => [ 'description' => 'The source type. To specify multiple types, separate them with commas (,).', 'enumValueTitles' => ['PAI_PUBLIC_DATASET' => 'PAI\\_PUBLIC\\_DATASET', 'ITAG' => 'ITAG', 'USER' => 'USER'], 'type' => 'string', 'example' => 'USER,ITAG', 'required' => false, 'title' => '', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the workspace that contains the dataset. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).'."\n" .'If this parameter is not specified, the default workspace is used. An error is returned if the default workspace does not exist.', 'type' => 'string', 'example' => '324**', 'required' => false], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => ['description' => 'A label used to filter datasets. The operation returns datasets whose label key or value contains the specified string.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Provider', 'in' => 'query', 'schema' => ['description' => 'The dataset provider. Set this parameter to `pai` to query public datasets on the PAI platform.', 'type' => 'string', 'required' => false, 'example' => 'pai', 'title' => ''], ], [ 'name' => 'SourceDatasetId', 'in' => 'query', 'schema' => ['description' => 'The source dataset ID for an iTAG annotation set.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n"], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => 'The sort field.', 'enumValueTitles' => ['DataSourceType' => 'DataSourceType', 'DataType' => 'DataType', 'GmtCreateTime' => 'GmtCreateTime', 'GmtModifiedTime' => 'GmtModifiedTime'], 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'GmtCreateTime', ], ], [ 'name' => 'ShareScope', 'in' => 'query', 'schema' => [ 'description' => 'A filter for shared datasets.'."\n" ."\n" .'- `TO_ME`: Returns only datasets shared with you.'."\n" ."\n" .'- `BY_ME`: Returns only datasets that you have shared with others and displays details of the sharing configuration.'."\n" ."\n" .'- If this parameter is omitted or empty, the operation returns all datasets in the current workspace, including those shared with you.', 'enumValueTitles' => ['TO_ME' => 'TO\\_ME', 'BY_ME' => 'BY\\_ME'], 'type' => 'string', 'required' => false, 'example' => 'BY_ME', 'title' => '', ], ], [ 'name' => 'Edition', 'in' => 'query', 'schema' => [ 'description' => 'The dataset edition. Valid values:'."\n" ."\n" .'- `BASIC`: Basic edition. Does not support file metadata management.'."\n" ."\n" .'- `ADVANCED`: Advanced edition. This edition is supported only for OSS datasets. Each version can manage metadata for up to 1 million files.'."\n" ."\n" .'- `LOGICAL`: Logical edition. This edition is supported only for OSS datasets and is suitable for most use cases. Each version can manage metadata for up to 1 million files. You must use an SDK with this edition.', 'enumValueTitles' => ['LOGICAL' => 'LOGICAL', 'BASIC' => 'BASIC', 'ADVANCED' => 'ADVANCED'], 'type' => 'string', 'required' => false, 'example' => 'BASIC', 'title' => '', ], ], [ 'name' => 'Accessibility', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the dataset\'s visibility.'."\n" ."\n" .'- `PUBLIC`: The dataset is publicly accessible.'."\n" ."\n" .'- `PRIVATE`: The dataset is privately accessible.', 'enumValueTitles' => ['PUBLIC' => 'PUBLIC', 'PRIVATE' => 'PRIVATE'], 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => '', ], ], [ 'name' => 'DatasetIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of dataset IDs.', 'type' => 'string', 'required' => false, 'example' => 'd-rcdg3wxxxxxhc5jk87', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Datasets' => [ 'description' => 'The list of datasets.', 'type' => 'array', 'items' => ['description' => 'A dataset.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total count of datasets.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-c0h44g3****j8o4348\\",\\n \\"UserId\\": \\"2485765****023475\\",\\n \\"OwnerId\\": \\"1631044****3440\\",\\n \\"Name\\": \\"myName\\",\\n \\"DataSourceType\\": \\"NAS\\",\\n \\"Uri\\": \\"nas://09f****f2.cn-hangzhou/\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"Property\\": \\"DIRECTORY\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"SourceId\\": \\"jdnhf***fnrimv\\",\\n \\"Description\\": \\"This is a description of a dataset.\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"SourceDatasetId\\": \\"d-bvfasdfxxxxj8o411\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"text-classification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Options\\": \\"{\\\\n \\\\\\"mountPath\\\\\\": \\\\\\"/mnt/data/\\\\\\"\\\\n}\\",\\n \\"SourceType\\": \\"USER\\",\\n \\"Description\\": \\"base model v1\\",\\n \\"SourceId\\": \\"d-65mrsr5fub4u74lej3\\",\\n \\"DataCount\\": 10000,\\n \\"DataSize\\": 10000,\\n \\"MountAccess\\": \\"RO\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\"\\n },\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"{\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-wulanchabu\\\\\\",\\\\n \\\\\\"fileSystemId\\\\\\": \\\\\\"bmcpfs-xxxxxxxxxxx\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"/mnt\\\\\\",\\\\n \\\\\\"mountTarget\\\\\\": \\\\\\"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\\\\\\",\\\\n \\\\\\"isVpcMount\\\\\\": true\\\\n}\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"IsShared\\": false,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"ACTIVE\\",\\n \\"SourceTenantId\\": \\"148***************115\\",\\n \\"SourceWorkspaceId\\": \\"33**19\\",\\n \\"TenantId\\": \\"153***************249\\",\\n \\"WorkspaceId\\": \\"42**2\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"2025-08-27T12:23:58Z\\",\\n \\"ExpiresAt\\": \\"2026-08-27T12:23:58Z\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"RO\\"\\n ],\\n \\"Extra\\": \\"{\\\\\\"AllowExportModel\\\\\\":false,\\\\\\"AllowAccessDLCWebTerminal\\\\\\":false,\\\\\\"AllowAccessDLCFullLog\\\\\\":false}\\"\\n }\\n ]\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"AccessibleRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ]\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'title' => 'ListDatasets', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListExperiment' => [ 'summary' => 'Retrieves a list of experiments.', 'path' => '/api/v1/experiments', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '206995', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the experiment.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'exp-test'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace where the experiment resides. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).'."\n" ."\n" .'> If you do not specify a workspace ID, the system returns the list of experiments in the default workspace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1517**'], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['description' => 'The filter conditions for labels. Separate multiple conditions with commas (,). A single filter condition must be in the `Key=Value` format.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'is_evaluation:true'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is supported for sorting.', 'type' => 'string', 'required' => false, 'default' => 'GmtCreateTime', 'example' => 'GmtCreateTime'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The order in which to sort the results of a paged query. Valid values:'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC (default): descending order.', 'type' => 'string', 'required' => false, 'default' => 'DESC', 'example' => 'DESC'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'OrderBy', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'A list of sorting methods as strings. You can sort by the following fields: GmtCreateTime, Name, GmtModifiedTime, or ExperimentId. The sorting methods are DESC and ASC. The default is ASC.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'GmtCreateTime DESC,Name ASC'], ], [ 'name' => 'PageToken', 'in' => 'query', 'schema' => ['description' => 'The paging token. It starts from 0. The default is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '0', 'title' => '', 'example' => '0'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to retrieve the LatestRun information related to the experiment.', 'type' => 'boolean', 'required' => false, 'default' => 'False', 'example' => 'false'], ], [ 'name' => 'Options', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Optional parameters.', 'type' => 'object', 'properties' => [ 'match_name_exactly' => ['title' => '', 'description' => 'Specifies whether to perform an exact match for the name. Valid values are "true" and "false".', 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'true'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C'], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '5'], 'Experiments' => [ 'description' => 'The list of experiments.', 'type' => 'array', 'items' => ['description' => 'The details of an experiment.', '$ref' => '#/components/schemas/Experiment', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The token for the next page. Save this token and include it in the next request to retrieve the next page of results.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListExperiment', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListExperiment'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiexperiment:ListExperiments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C\\",\\n \\"TotalCount\\": 5,\\n \\"Experiments\\": [\\n {\\n \\"ExperimentId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ArtifactUri\\": \\"\\",\\n \\"TensorboardLogUri\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"GmtCreateTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"GmtModifiedTime\\": \\"2023-12-27T03:30:04Z\\",\\n \\"ExperimentId\\": \\"exp-890waerw09a0f\\"\\n }\\n ],\\n \\"UserId\\": \\"\\",\\n \\"OwnerId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"LatestRun\\": {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListFeatures' => [ 'path' => '/api/v1/features', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '101118', 'abilityTreeNodes' => ['FEATURElearnZO51AS'], ], 'parameters' => [ [ 'name' => 'Names', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Feature names, separated by commas.', 'type' => 'string', 'required' => false, 'example' => 'PaiConsole:IntegrateWithWorkspace'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'TotalCount' => ['title' => '', 'description' => 'The total number of features.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'Features' => [ 'title' => '', 'description' => 'The list of features.', 'type' => 'array', 'items' => ['description' => 'A feature.', 'type' => 'string', 'title' => '', 'example' => 'PaiConsole:IntegrateWithWorkspace'."\n"], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListFeatures', 'summary' => 'Retrieves a list of features.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFeatures'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListFeatures', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Features\\": [\\n \\"PaiConsole:IntegrateWithWorkspace\\\\n\\"\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListImageLabels' => [ 'summary' => 'Queries a list of image labels.', 'path' => '/api/v1/image/labels', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '61618', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'LabelKeys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The list of tag keys. Separate multiple keys with commas (,).'."\n" .'System tags start with "system". This parameter works independently of the LabelFilter parameter.', 'type' => 'string', 'required' => false, 'example' => 'system.framework,system.official'], ], [ 'name' => 'LabelFilter', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The filter conditions for labels. Separate multiple conditions with commas.'."\n" .'The format for a single condition is `key=value`.'."\n" .'This parameter works independently of the LabelKeys parameter.', 'type' => 'string', 'required' => false, 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'], ], [ 'name' => 'ImageId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The image ID. For more information about how to obtain an image ID, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => false, 'example' => 'image-4c62******53uor'."\n"], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '12345'], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The region where the image resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Labels' => [ 'title' => '', 'description' => 'The list of image labels.', 'type' => 'array', 'items' => [ 'description' => 'An image label.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'system.chipType'], 'Value' => ['title' => '', 'description' => 'The value of the label.', 'type' => 'string', 'example' => 'GPU'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of image labels that meet the filter conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListImageLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiimage:ListImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListImages' => [ 'path' => '/api/v1/images', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61620', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The name of the image. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'tensorflow_2.9'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the image list. The value starts from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page for a paged query. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is used for sorting.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The order in which to sort the results of a paged query. This parameter is used with SortBy. The default value is ASC.'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The filter conditions for labels. Separate multiple conditions with commas (,).'."\n" .'The format for a single filter condition is `Key=Value`.'."\n" .'The supported values for Key are:'."\n" ."\n" .'- system.chipType'."\n" ."\n" .'- system.dsw\\.cudaVersion'."\n" ."\n" .'- system.dsw\\.fromImageId'."\n" ."\n" .'- system.dsw\\.fromInstanceId'."\n" ."\n" .'- system.dsw\\.id'."\n" ."\n" .'- system.dsw\\.os'."\n" ."\n" .'- system.dsw\\.osVersion'."\n" ."\n" .'- system.dsw\\.resourceType'."\n" ."\n" .'- system.dsw\\.rootImageId'."\n" ."\n" .'- system.dsw\\.stage'."\n" ."\n" .'- system.dsw\\.tag'."\n" ."\n" .'- system.dsw\\.type'."\n" ."\n" .'- system.framework'."\n" ."\n" .'- system.origin'."\n" ."\n" .'- system.pythonVersion'."\n" ."\n" .'- system.source'."\n" ."\n" .'- system.supported.dlc'."\n" ."\n" .'- system.supported.dsw', 'type' => 'string', 'required' => false, 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'."\n"], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to display non-essential information. Non-essential information currently includes Labels. Valid values:'."\n" ."\n" .'- true: Includes non-essential information.'."\n" ."\n" .'- false: Does not include non-essential information.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '20******55'], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => ['description' => 'Performs a fuzzy search by image name and description.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'name'], ], [ 'name' => 'Accessibility', 'in' => 'query', 'schema' => ['description' => 'The visibility of the image. This parameter is valid only for custom images.'."\n" ."\n" .'- PUBLIC: The image is public.'."\n" ."\n" .'- PRIVATE: The image is private.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'PUBLIC'], ], [ 'name' => 'ImageUri', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'TotalCount' => ['title' => '', 'description' => 'The total number of returned images.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'Images' => [ 'title' => '', 'description' => 'The list of images.', 'type' => 'array', 'items' => [ 'description' => 'The image details.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The image name.', 'type' => 'string', 'example' => 'tensorflow_2.9'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the image was created. The time is in UTC and the format is ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'Description' => ['title' => '', 'description' => 'The image description.', 'type' => 'string', 'example' => 'desc'], 'ImageUri' => ['title' => '', 'description' => 'The image URL, which includes the version number.', 'type' => 'string', 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0'], 'Labels' => [ 'title' => '', 'description' => 'The list of image labels.', 'type' => 'array', 'items' => [ 'description' => 'The image label.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the label.', 'type' => 'string', 'example' => 'system.chipType'], 'Value' => ['title' => '', 'description' => 'The value of the label.', 'type' => 'string', 'example' => 'GPU'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ImageId' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => 'image-tzi7f9******s45t'], 'Accessibility' => ['title' => '', 'description' => 'The visibility of the image. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can perform operations on the image.'."\n" ."\n" .'- PRIVATE: Only the creator can perform operations on the image.', 'type' => 'string', 'example' => 'PUBLIC'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the image was last modified. The time is in UTC and the format is ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'."\n"], 'UserId' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account that created the image.', 'type' => 'string', 'example' => '155**********904'], 'ParentUserId' => ['title' => '', 'description' => 'The UID of the Alibaba Cloud account that created the image.', 'type' => 'string', 'example' => '155**********904'], 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '20******55'], 'Size' => ['description' => 'The image size in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], 'SourceType' => ['title' => '', 'description' => 'The type of the image source.', 'type' => 'string', 'example' => ''], 'SourceId' => ['title' => '', 'description' => 'The ID of the image source.', 'type' => 'string', 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListImages', 'summary' => 'Queries a list of images.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiimage:ListImages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Images\\": [\\n {\\n \\"Name\\": \\"tensorflow_2.9\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"desc\\",\\n \\"ImageUri\\": \\"registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.chipType\\",\\n \\"Value\\": \\"GPU\\"\\n }\\n ],\\n \\"ImageId\\": \\"image-tzi7f9******s45t\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\\\n\\",\\n \\"UserId\\": \\"155**********904\\",\\n \\"ParentUserId\\": \\"155**********904\\",\\n \\"WorkspaceId\\": \\"20******55\\",\\n \\"Size\\": 2,\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListMembers' => [ 'summary' => 'Lists members in a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/members', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '14243', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'Workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Pages start at 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ 'name' => 'Roles', 'in' => 'query', 'schema' => ['description' => 'Roles used to filter members. Separate multiple roles with commas (,). Valid values:'."\n" ."\n" .'- PAI.AlgoDeveloper: Algorithm developer'."\n" ."\n" .'- PAI.AlgoOperator: Algorithm O\\&M engineer'."\n" ."\n" .'- PAI.LabelManager: Annotation administrator'."\n" ."\n" .'- PAI.MaxComputeDeveloper: MaxCompute developer'."\n" ."\n" .'- PAI.WorkspaceAdmin: Workspace administrator'."\n" ."\n" .'- PAI.WorkspaceGuest: Guest'."\n" ."\n" .'- PAI.WorkspaceOwner: Workspace owner', 'type' => 'string', 'example' => 'PAI.AlgoDeveloper', 'title' => '', 'required' => false], ], [ 'name' => 'MemberName', 'in' => 'query', 'schema' => ['description' => 'Username. Fuzzy match is supported.', 'type' => 'string', 'example' => 'zhangsan', 'title' => '', 'required' => false], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '2788******129', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response object.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], 'Members' => [ 'title' => '', 'description' => 'The list of workspace members.', 'type' => 'array', 'items' => [ 'description' => 'A workspace member.', 'type' => 'object', 'properties' => [ 'UserId' => ['description' => 'Alibaba Cloud account ID of the member.', 'type' => 'string', 'example' => '215139******88039', 'title' => ''], 'MemberName' => ['description' => 'Username of the member.', 'type' => 'string', 'example' => 'user1', 'title' => ''], 'GmtCreateTime' => ['description' => 'Time when the member was added, in UTC. Format: ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''], 'Roles' => [ 'title' => '', 'description' => 'Roles assigned to the member.', 'type' => 'array', 'items' => ['description' => 'Role name. For the mapping between roles and permissions, see [Appendix: Roles and permissions](~~2840449~~).'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- PAI.AlgoDeveloper: Algorithm developer'."\n" ."\n" .'- PAI.AlgoOperator: Algorithm O\\&M engineer'."\n" ."\n" .'- PAI.LabelManager: Annotation administrator'."\n" ."\n" .'- PAI.MaxComputeDeveloper: MaxCompute developer'."\n" ."\n" .'- PAI.WorkspaceAdmin: Workspace administrator'."\n" ."\n" .'- PAI.WorkspaceGuest: Guest'."\n" ."\n" .'- PAI.WorkspaceOwner: Workspace owner', 'type' => 'string', 'example' => 'PAI.AlgoDeveloper', 'title' => ''], 'example' => '', ], 'DisplayName' => ['description' => 'Display name of the member.', 'type' => 'string', 'example' => 'myDisplayName', 'title' => ''], 'MemberId' => ['description' => 'Member ID.', 'type' => 'string', 'example' => '14588*****51688039', 'title' => ''], 'AccountName' => ['description' => 'Account name of the member.', 'type' => 'string', 'example' => 'testAccount', 'title' => ''], 'AccountType' => ['description' => 'Account type. Valid values:'."\n" ."\n" .'- 1: Alibaba Cloud account'."\n" ."\n" .'- 5: RAM user'."\n" ."\n" .'- 6: RAM role', 'type' => 'string', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'Total number of members that match the filter criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListMembers', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Members\\": [\\n {\\n \\"UserId\\": \\"215139******88039\\",\\n \\"MemberName\\": \\"user1\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Roles\\": [\\n \\"PAI.AlgoDeveloper\\"\\n ],\\n \\"DisplayName\\": \\"myDisplayName\\",\\n \\"MemberId\\": \\"14588*****51688039\\",\\n \\"AccountName\\": \\"testAccount\\",\\n \\"AccountType\\": \\"5\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListModelVersions' => [ 'summary' => 'Retrieves a list of model versions.', 'path' => '/api/v1/models/{ModelId}/versions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133782', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the model version list. The value starts from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page for a paged query. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The order in which to sort the entries in the paged query. The default value is ASC.'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field to use for sorting in the paged query. Currently, the GmtCreateTime field is used for sorting.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], ], [ 'name' => 'VersionName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The model version name. This parameter is used to filter the model version list.', 'type' => 'string', 'required' => false, 'example' => '1.0.1'], ], [ 'name' => 'FormatType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The model format. This parameter is used to filter the model version list. Valid values:'."\n" ."\n" .'- OfflineModel'."\n" ."\n" .'- SavedModel'."\n" ."\n" .'- Keras H5'."\n" ."\n" .'- Frozen Pb'."\n" ."\n" .'- Caffe Prototxt'."\n" ."\n" .'- TorchScript'."\n" ."\n" .'- XGBoost'."\n" ."\n" .'- PMML'."\n" ."\n" .'- AlinkModel'."\n" ."\n" .'- ONNX', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['OfflineModel' => 'OfflineModel', 'SavedModel' => 'SavedModel', 'Keras H5' => 'Keras H5', 'Frozen Pb' => 'Frozen Pb', 'Caffe Prototxt' => 'Caffe Prototxt', 'TorchScript' => 'TorchScript', 'XGBoost' => 'XGBoost', 'PMML' => 'PMML', 'AlinkModel' => 'AlinkModel', 'ONNX' => 'ONNX'], 'example' => 'SavedModel', ], ], [ 'name' => 'FrameworkType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The model framework. This parameter is used to filter the model version list. Valid values:'."\n" ."\n" .'- Pytorch'."\n" .' -XGBoost'."\n" ."\n" .'- Keras'."\n" ."\n" .'- Caffe'."\n" ."\n" .'- Alink'."\n" ."\n" .'- Xflow'."\n" ."\n" .'- TensorFlow', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['Pytorch' => 'Pytorch', 'XGBoost' => 'XGBoost', 'Keras' => 'Keras', 'Caffe' => 'Caffe', 'Alink' => 'Alink', 'Xflow' => 'Xflow', 'TensorFlow' => 'TensorFlow'], 'example' => 'TensorFlow', ], ], [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-dajbueh******'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => 'The source type of the model. This parameter is used to filter the model version list. Valid values:'."\n" ."\n" .'- Custom (default): a custom model.'."\n" ."\n" .'- PAIFlow: a model from a PAI pipeline.'."\n" ."\n" .'- TrainingService: a model from a PAI training service.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The source ID.'."\n" ."\n" .'- If the source type is Custom, this parameter is not restricted.'."\n" ."\n" .'- If the source is PAIFlow or TrainingService, the format is as follows:'."\n" ."\n" .'```'."\n" .'region=,workspaceId=,kind=,id='."\n" .'```'."\n" ."\n" .'where:'."\n" ."\n" .'- region is the Alibaba Cloud region ID.'."\n" ."\n" .'- workspaceId is the workspace ID.'."\n" ."\n" .'- kind: the type. Valid values: PipelineRun (PAIFlow pipeline) and ServiceJob (training service).'."\n" ."\n" .'- id: the unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The label string. This parameter is used to filter the list. Model versions that have the specified string in the key or value of their labels are returned.', 'type' => 'string', 'required' => false, 'example' => 'key1'], ], [ 'name' => 'ApprovalStatus', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The approval status. This parameter is used to filter the model version list. Valid values:'."\n" ."\n" .'- Pending: The model version is pending approval.'."\n" ."\n" .'- Approved: The model version is approved for publishing.'."\n" ."\n" .'- Rejected: The model version is rejected for publishing.', 'type' => 'string', 'required' => false, 'example' => 'Approved'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC***3C83E'], 'Versions' => [ 'title' => '', 'description' => 'The list of model versions.', 'type' => 'array', 'items' => ['description' => 'The model version.', '$ref' => '#/components/schemas/ModelVersion', 'title' => '', 'example' => ''], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of model versions.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListModelVersions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModelVersions'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paimodel:ListModelVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC***3C83E\\",\\n \\"Versions\\": [\\n {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListModels' => [ 'summary' => 'Retrieves a list of models.', 'path' => '/api/v1/models', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133768', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the model list. The value starts from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of models to display on each page in a paged query. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The order in which to sort the results of a paged query. The default value is ASC.'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field to use for sorting in a paged query. Currently, only the GmtCreateTime field is supported.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace ID. The returned list contains only the models in the specified workspace. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '324**'], ], [ 'name' => 'ModelName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The model name. This parameter is used to filter the model list.', 'type' => 'string', 'required' => false, 'example' => 'Sentiment analysis'], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The label string. This parameter is used to filter the list. Models are returned if their label keys or values contain the specified string.', 'type' => 'string', 'required' => false, 'example' => 'key1'], ], [ 'name' => 'Provider', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The provider. If you specify a provider, only the public models from that provider are returned. If you leave this parameter empty, your own models are returned.', 'type' => 'string', 'required' => false, 'example' => 'pai'], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The domain. This parameter is used to filter the model list by domain. Examples: nlp (natural language processing) and cv (computer vision).', 'type' => 'string', 'required' => false, 'example' => 'nlp'], ], [ 'name' => 'Task', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The task. This parameter is used to filter the model list by task type. Example: text-classification.', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], ], [ 'name' => 'Origin', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The model source. This parameter is used to filter the model list by community or organization. Examples: ModelScope and HuggingFace.', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The query condition. This parameter performs a fuzzy match on ModelName, Domain, Task, LabelKey, and LabelValue. For example, if you enter nlp, models that match in any of these fields are returned.', 'type' => 'string', 'required' => false, 'example' => 'nlp'], ], [ 'name' => 'ModelType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The model type.', 'type' => 'string', 'required' => false, 'example' => 'Endpoint'], ], [ 'name' => 'Collections', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['title' => '', 'description' => 'The collections to which the model belongs. You can specify multiple collections. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'AI4D,QuickStart'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'description' => 'The tag information.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1'], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => 'Endpoint', 'title' => '', ], ], [ 'name' => 'Conditions', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Column' => ['type' => 'string', 'description' => 'The parameter name. Example: ParameterSize.', 'required' => false, 'title' => '', 'example' => 'ParameterSize'], 'Operator' => ['type' => 'string', 'description' => 'The operator. Example: LessThan.', 'required' => false, 'title' => '', 'example' => 'LessThan'], 'Value' => ['type' => 'string', 'description' => 'The value. Example: 3000.', 'required' => false, 'title' => '', 'example' => '3000'], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The conditions.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Models' => [ 'title' => '', 'description' => 'The list of models.', 'type' => 'array', 'items' => ['description' => 'The model.', '$ref' => '#/components/schemas/Model', 'title' => '', 'example' => ''], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of models.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Models\\": [\\n {\\n \\"ModelId\\": \\"model-1123*****\\",\\n \\"ModelName\\": \\"情感分析\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"UserId\\": \\"1557702098******\\",\\n \\"OwnerId\\": \\"1557702098******\\",\\n \\"ModelDescription\\": \\"情感分析。\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/\\",\\n \\"VersionDescription\\": \\"情感分析。\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"{}\\",\\n \\"SourceType\\": \\"PAIFlow\\",\\n \\"SourceId\\": \\"region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf\\",\\n \\"ApprovalStatus\\": \\"Approved\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"k1\\",\\n \\"Value\\": \\"v1\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"Results\\": [\\n {\\n \\"Dataset\\": {\\n \\"DatasetId\\": \\"d-sdkjanksaklerhfd\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.175\\n }\\n },\\n {\\n \\"Dataset\\": {\\n \\"Uri\\": \\"oss://xxxx/\\"\\n },\\n \\"Metrics\\": {\\n \\"cer\\": 0.172\\n }\\n }\\n ]\\n },\\n \\"TrainingSpec\\": {},\\n \\"InferenceSpec\\": {\\n \\"processor\\": \\"tensorflow_gpu_1.12\\"\\n },\\n \\"EvaluationSpec\\": {},\\n \\"CompressionSpec\\": {},\\n \\"ExtraInfo\\": {\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png\\"\\n ],\\n \\"TrainedWords\\": [\\n \\"albedo_overlord\\"\\n ]\\n },\\n \\"DistillationSpec\\": {}\\n },\\n \\"OrderNumber\\": 101,\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Domain\\": \\"nlp\\",\\n \\"Task\\": \\"text-classifiaction\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Provider\\": \\"pai\\",\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"RatingCount\\": 2866,\\n \\"Rating\\": 4.94,\\n \\"FavoriteCount\\": 34992,\\n \\"CommentCount\\": 754,\\n \\"CoverUris\\": [\\n \\"https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png\\"\\n ],\\n \\"TippedAmountCount\\": 32,\\n \\"DownloadCount\\": 606056\\n },\\n \\"ParameterSize\\": 1024,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-21T17:12:35Z\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'title' => 'ListModels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paimodel:ListModels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'ListPermissions' => [ 'summary' => 'Retrieves a list of user permissions in a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/permissions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '14249', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2AE63638-5420-56DC-B******8174039A0'], 'Permissions' => [ 'title' => '', 'description' => 'The list of permissions.', 'type' => 'array', 'items' => [ 'description' => 'A permission.', 'type' => 'object', 'properties' => [ 'PermissionCode' => ['title' => '', 'description' => 'The name of the permission point. The name is unique within the same region. For more information about permission points, see [Appendix: Roles and permissions](~~2840449~~).'."\n" .'For example, the value PaiDLC:GetTensorboard grants the permission to view Tensorboard details for the DLC feature.', 'type' => 'string', 'example' => 'PaiDLC:GetTensorboard'], 'PermissionRules' => [ 'description' => 'The list of permission rules.', 'type' => 'array', 'items' => [ 'description' => 'A permission rule.', 'type' => 'object', 'properties' => [ 'Accessibility' => ['title' => '', 'description' => 'The access type. Valid values:'."\n" ."\n" .'- PUBLIC: All members in the current workspace can perform the operation.'."\n" ."\n" .'- PRIVATE: Only the creator can perform the operation.'."\n" ."\n" .'- ANY: Both the creator and non-creators can perform the operation.', 'type' => 'string', 'example' => 'PRIVATE'], 'EntityAccessType' => ['title' => '', 'description' => 'The entity access type.'."\n" .'This parameter is invalid if Accessibility is set to PUBLIC. In this case, all users can perform the operation.'."\n" .'If Accessibility is set to PRIVATE, the permission is determined by the value of EntityAccessType. Valid values:'."\n" ."\n" .'- CREATOR: Only the creator can perform the operation.'."\n" ."\n" .'- ANY: Both the creator and non-creators can perform the operation.', 'type' => 'string', 'example' => 'CREATOR'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The number of entries that meet the filter conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], 'example' => '', ], ], ], 'title' => 'ListPermissions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AE63638-5420-56DC-B******8174039A0\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCode\\": \\"PaiDLC:GetTensorboard\\",\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListProducts' => [ 'summary' => 'Lists products.', 'path' => '/api/v1/products', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '14207', 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'ProductCodes', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The product codes, separated by commas.', 'example' => 'PAI_isolate'], ], [ 'name' => 'ServiceCodes', 'in' => 'query', 'schema' => ['type' => 'string', 'title' => '', 'description' => 'The service codes, separated by commas.', 'example' => 'oss'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '1e195c5116124202371861018d5bde'], 'Products' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PurchaseUrl' => ['type' => 'string', 'title' => '', 'description' => 'The purchase URL.', 'example' => 'https://common-buy.aliy'], 'ProductCode' => ['type' => 'string', 'title' => '', 'description' => 'The product code.', 'example' => 'DataWorks_isolate'], 'IsPurchased' => ['type' => 'boolean', 'title' => '', 'description' => 'Indicates whether the product is purchased.', 'example' => 'true'], 'HasPermissionToPurchase' => ['type' => 'boolean', 'title' => '', 'description' => 'Indicates whether the user has permission to purchase the product.', 'example' => ''], 'ProductId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The list of products.', 'example' => '', ], 'Services' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'IsOpen' => ['type' => 'boolean', 'title' => '', 'description' => 'Indicates whether the service is activated.', 'example' => 'true'], 'OpenUrl' => ['type' => 'string', 'title' => '', 'description' => 'The activation URL.', 'example' => ''], 'ServiceCode' => ['type' => 'string', 'title' => '', 'description' => 'The service code.', 'example' => 'oss'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The list of services.', 'example' => '', ], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListProducts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Products\\": [\\n {\\n \\"PurchaseUrl\\": \\"https://common-buy.aliy\\",\\n \\"ProductCode\\": \\"DataWorks_isolate\\",\\n \\"IsPurchased\\": true,\\n \\"HasPermissionToPurchase\\": false,\\n \\"ProductId\\": \\"\\"\\n }\\n ],\\n \\"Services\\": [\\n {\\n \\"IsOpen\\": true,\\n \\"OpenUrl\\": \\"\\",\\n \\"ServiceCode\\": \\"oss\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListProducts', 'translator' => 'manual', ], 'ListQuotas' => [ 'summary' => 'Retrieves a list of resource quotas.', 'path' => '/api/v1/quotas', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '14241', 'abilityTreeNodes' => ['FEATURElearnZO51AS'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The name of the resource quota. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'quota-name'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], 'Quotas' => [ 'title' => '', 'description' => 'The list of resource quotas.', 'type' => 'array', 'items' => [ 'description' => 'The details of the resource quota.', 'type' => 'object', 'properties' => [ 'QuotaType' => ['title' => '', 'description' => 'The type of the resource quota. Valid value:'."\n" ."\n" .'PAI: a GPU resource group cluster of MaxCompute.', 'type' => 'string', 'example' => 'PAI'], 'Mode' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- isolate: subscription.'."\n" ."\n" .'- share: pay-as-you-go.', 'type' => 'string', 'example' => 'isolate'], 'ProductCode' => ['title' => '', 'description' => 'The product name. Valid values:'."\n" ."\n" .'- PAI\\_isolate: a subscription PAI resource group (PAI CPU).'."\n" ."\n" .'- PAI\\_share: a pay-as-you-go PAI resource group (PAI GPU).', 'type' => 'string', 'example' => 'PAI_share'], 'Name' => ['title' => '', 'description' => 'The quota name.', 'type' => 'string', 'example' => 'quota-name'], 'Specs' => [ 'title' => '', 'description' => 'The list of specification descriptions.', 'type' => 'array', 'items' => [ 'description' => 'The specification description.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The specification name.', 'type' => 'string', 'example' => 'cu'], 'Value' => ['title' => '', 'description' => 'The specification value.', 'type' => 'string', 'example' => '11500'], 'Type' => ['title' => '', 'description' => 'The type. This parameter can be empty.', 'type' => 'string', 'example' => 'string'], ], 'title' => '', 'example' => '', ], 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', ], 'Id' => ['title' => '', 'description' => 'The quota ID.', 'type' => 'string', 'example' => '1828233'], 'DisplayName' => ['description' => 'The alias of the resource quota.', 'type' => 'string', 'title' => '', 'example' => '默认Quota。'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The number of resource quotas that meet the filter condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], 'example' => '', ], ], ], 'title' => 'ListQuotas', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotas'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListQuotas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Quotas\\": [\\n {\\n \\"QuotaType\\": \\"PAI\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"ProductCode\\": \\"PAI_share\\",\\n \\"Name\\": \\"quota-name\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\",\\n \\"Type\\": \\"string\\"\\n }\\n ],\\n \\"Id\\": \\"1828233\\",\\n \\"DisplayName\\": \\"默认Quota。\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListResources' => [ 'summary' => 'Lists resources associated with a workspace.', 'path' => '/api/v1/resources', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace. To get the workspace ID, see [ListWorkspaces](~~449124~~).'."\n" ."\n" .'- This parameter is required if `Option` is set to `ListResourceByWorkspace`.'."\n" ."\n" .'- This parameter is not required if `Option` is set to `ListResource`.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than or equal to 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ 'name' => 'ProductTypes', 'in' => 'query', 'schema' => ['description' => '**Deprecated.** This parameter is deprecated. Use the `ResourceType` parameter instead.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the resource group. To get the resource group name, see [ListResources](~~449143~~).', 'type' => 'string', 'example' => 'group', 'title' => '', 'required' => false], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => ['description' => 'The resource name. The name must meet the following requirements:'."\n" ."\n" .'- The name must be 3 to 28 characters in length.'."\n" ."\n" .'- The name must be unique within a region.', 'type' => 'string', 'example' => 'resource', 'title' => '', 'required' => false], ], [ 'name' => 'Option', 'in' => 'query', 'schema' => ['description' => 'The option to query resources. Valid values:'."\n" ."\n" .'- `ListResourceByWorkspace` (Default): lists the resources in a workspace.'."\n" ."\n" .'- `ListResource`: lists the resources of the current user.', 'type' => 'string', 'example' => 'ListResourceByWorkspace', 'title' => '', 'required' => false], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return detailed information. The detailed information includes the `Quotas` field. Valid values:'."\n" ."\n" .'- `true` (Default): returns detailed information.'."\n" ."\n" .'- `false`: does not return detailed information.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ResourceTypes', 'in' => 'query', 'schema' => ['description' => 'The resource types. Valid values:'."\n" ."\n" .'- `MaxCompute`: MaxCompute resources.'."\n" ."\n" .'- `ECS`: ECS resources.'."\n" ."\n" .'- `Lingjun`: Lingjun computing resources.'."\n" ."\n" .'- `ACS`: ACS computing resources.'."\n" ."\n" .'- `Flink`: Flink resources.'."\n" ."\n" .'- `SelfManagedAckPro`: self-managed AckPro cluster resources.'."\n" ."\n" .'- `SelfManagedAckLingjun`: self-managed AckLingjun cluster resources.'."\n" ."\n" .'- `SelfManagedASI`: self-managed ASI cluster resources from a third-party cloud.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], ], [ 'name' => 'QuotaIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of quota IDs. This operation returns only the resources that are associated with all the specified quota IDs.'."\n" ."\n" .'> This parameter is available only for resources whose `ResourceTypes` is set to `ACS`.', 'type' => 'string', 'required' => false, 'example' => 'quota-k******da,quota-cd******w', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of labels. This operation returns only the resources that have all the specified labels.'."\n" ."\n" .'This parameter is available only for resources whose `ResourceTypes` is set to `ACS`.', 'type' => 'string', 'required' => false, 'example' => 'system.supported.dsw=true,system.supported.dlc=true', 'title' => ''], ], [ 'name' => 'VerboseFields', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of fields that you want to return. Valid values:'."\n" ."\n" .'- `Quota`'."\n" ."\n" .'- `Label`'."\n" ."\n" .'- `IsDefault`', 'type' => 'string', 'required' => false, 'example' => 'Quota,IsDefault', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde', 'title' => ''], 'Resources' => [ 'title' => '', 'description' => 'The list of resources.', 'type' => 'array', 'items' => [ 'description' => 'Details of a resource.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => '123', 'title' => ''], 'Name' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'ResourceName', 'title' => ''], 'ProductType' => ['description' => '**Deprecated.** This parameter is deprecated and will be removed in a future release. Use the `ResourceType` parameter instead.', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], 'EnvType' => ['description' => 'The environment type. Valid values:'."\n" ."\n" .'- `dev`: development environment'."\n" ."\n" .'- `prod`: production environment', 'type' => 'string', 'example' => 'prod', 'title' => ''], 'WorkspaceId' => ['description' => 'The ID of the workspace to which the resource belongs.', 'type' => 'string', 'example' => '123', 'title' => ''], 'IsDefault' => ['description' => 'Indicates whether the resource is the default resource of its type. Each resource type has only one default resource. Valid values:'."\n" ."\n" .'- `true`: The resource is the default resource.'."\n" ."\n" .'- `false`: The resource is not the default resource.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Quotas' => [ 'description' => 'The list of quotas.', 'type' => 'array', 'items' => [ 'description' => 'Details of a quota.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The quota name.', 'type' => 'string', 'example' => 'QuotaName', 'title' => ''], 'ProductCode' => ['description' => 'The product code. Valid values:'."\n" ."\n" .'- `PAI_isolate`: PAI subscription resource group (PAI CPU)'."\n" ."\n" .'- `PAI_share`: PAI pay-as-you-go resource group (PAI GPU)'."\n" ."\n" .'- `MaxCompute_share`: MaxCompute pay-as-you-go resource group'."\n" ."\n" .'- `MaxCompute_isolate`: MaxCompute subscription resource group'."\n" ."\n" .'- `DataWorks_isolate`: DataWorks subscription resource group'."\n" ."\n" .'- `DataWorks_share`: DataWorks pay-as-you-go resource group'."\n" ."\n" .'- `DLC_share`: DLC pay-as-you-go resource group', 'type' => 'string', 'example' => 'MaxCompute_isolate', 'title' => ''], 'QuotaType' => ['description' => 'The quota type. Valid values:'."\n" ."\n" .'- `PAI`'."\n" ."\n" .'- `MaxCompute`'."\n" ."\n" .'- `DLC`', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], 'Mode' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- `isolate`: subscription'."\n" ."\n" .'- `share`: pay-as-you-go', 'type' => 'string', 'example' => 'isolate', 'title' => ''], 'Specs' => [ 'title' => '', 'description' => 'The list of specifications.', 'type' => 'array', 'items' => [ 'description' => 'The details of a specification.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'cu', 'title' => ''], 'Value' => ['description' => 'The specification value.', 'type' => 'string', 'example' => '11500', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', ], 'CardType' => ['description' => 'The card type. Valid values:'."\n" ."\n" .'- `CPU`'."\n" ."\n" .'- `GPU`', 'type' => 'string', 'example' => 'CPU', 'title' => ''], 'Id' => ['description' => 'The quota ID.', 'type' => 'string', 'example' => '123', 'title' => ''], 'DisplayName' => ['description' => 'The display name of the quota.', 'type' => 'string', 'example' => '默认后付费Quota', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Spec' => ['description' => 'The resource specifications.', 'type' => 'object', 'example' => '对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}', 'title' => ''], 'GroupName' => ['description' => 'The name of the resource group. The name must be unique within an Alibaba Cloud account.', 'type' => 'string', 'example' => 'groupName', 'title' => ''], 'GmtCreateTime' => ['description' => 'The time when the resource was created. The time is displayed in UTC and is formatted in ISO 8601.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z', 'title' => ''], 'Executor' => [ 'description' => '**Deprecated.** This parameter is no longer used.', 'type' => 'object', 'properties' => [ 'OwnerId' => ['description' => '**Deprecated.** This parameter is no longer used.', 'type' => 'string', 'example' => '110973******7793', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Encryption' => [ 'description' => 'The encryption details. This parameter is valid only for MaxCompute resources.', 'type' => 'object', 'properties' => [ 'Enabled' => ['description' => 'Indicates whether encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Algorithm' => ['description' => 'The encryption algorithm.', 'type' => 'string', 'example' => 'AESCTR', 'title' => ''], 'Key' => ['description' => 'The encryption key.', 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ResourceType' => ['description' => 'The type of the resource. Valid values:'."\n" ."\n" .'- `MaxCompute`: MaxCompute resources'."\n" ."\n" .'- `ECS`: ECS resources'."\n" ."\n" .'- `Lingjun`: Lingjun intelligent computing resources'."\n" ."\n" .'- `ACS`: ACS computing resources'."\n" ."\n" .'- `Flink`: Flink resources'."\n" ."\n" .'- `SelfManagedAckPro`: self-managed cluster resources for AckPro'."\n" ."\n" .'- `SelfManagedAckLingjun`: self-managed cluster resources for AckLingjun'."\n" ."\n" .'- `SelfManagedASI`: self-managed cluster resources for ASI (third-party cloud)', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], 'Labels' => [ 'description' => 'The list of labels.', 'type' => 'array', 'items' => [ 'description' => 'Details of a label.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the label.', 'type' => 'string', 'example' => 'system.supported.dsw', 'title' => ''], 'Value' => ['description' => 'The value of the label.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries that match the filter criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Name\\": \\"ResourceName\\",\\n \\"ProductType\\": \\"MaxCompute\\",\\n \\"EnvType\\": \\"prod\\",\\n \\"WorkspaceId\\": \\"123\\",\\n \\"IsDefault\\": true,\\n \\"Quotas\\": [\\n {\\n \\"Name\\": \\"QuotaName\\",\\n \\"ProductCode\\": \\"MaxCompute_isolate\\",\\n \\"QuotaType\\": \\"MaxCompute\\",\\n \\"Mode\\": \\"isolate\\",\\n \\"Specs\\": [\\n {\\n \\"Name\\": \\"cu\\",\\n \\"Value\\": \\"11500\\"\\n }\\n ],\\n \\"CardType\\": \\"CPU\\",\\n \\"Id\\": \\"123\\",\\n \\"DisplayName\\": \\"默认后付费Quota\\"\\n }\\n ],\\n \\"Spec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GroupName\\": \\"groupName\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Executor\\": {\\n \\"OwnerId\\": \\"110973******7793\\"\\n },\\n \\"Encryption\\": {\\n \\"Enabled\\": false,\\n \\"Algorithm\\": \\"AESCTR\\",\\n \\"Key\\": \\"DEFAULT\\"\\n },\\n \\"ResourceType\\": \\"MaxCompute\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"system.supported.dsw\\",\\n \\"Value\\": \\"true\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', 'title' => 'ListResources', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResources'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListRunMetrics' => [ 'summary' => 'Retrieves a list of metric records for a run.', 'path' => '/api/v1/runs/{RunId}/metrics', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '237434', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The run ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The key of the metric for the run.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'loss'], ], [ 'name' => 'PageToken', 'in' => 'query', 'schema' => ['description' => 'The paging token. The token starts from 0. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '0', 'title' => '', 'example' => '0'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '10', 'title' => '', 'example' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], 'Metrics' => [ 'description' => 'The list of metrics.', 'type' => 'array', 'items' => ['description' => 'The details of the metric.', '$ref' => '#/components/schemas/RunMetric', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'The token to retrieve the next page of results. A value of 0 indicates that all results have been returned. Use the value of this parameter for the \\`PageToken\\` parameter in your next request to retrieve the next page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'example' => '', ], ], ], 'title' => 'ListRunMetrics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRunMetrics'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:ListRunMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListRuns' => [ 'path' => '/api/v1/runs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '237299', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the run.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'myName'], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the workspace where the experiment resides. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).'."\n" ."\n" .'> If you do not specify a workspace ID, the system returns the list of runs in the default workspace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '228**'], ], [ 'name' => 'ExperimentId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the experiment to which the run belongs.', 'type' => 'string', 'required' => false, 'example' => 'exp-1zpfthdx******'], ], [ 'name' => 'SourceType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The type of the PAI workload associated with the run.', 'type' => 'string', 'required' => false, 'example' => 'TrainingService'], ], [ 'name' => 'SourceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the PAI workload associated with the run.', 'type' => 'string', 'required' => false, 'example' => 'job-rbvg5wzlj****'], ], [ 'name' => 'Labels', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The labels of the run for an exact match. The following formats are supported:'."\n" ."\n" .'- Single-label query: "is\\_evaluation:true"'."\n" ."\n" .'- Multi-label query: "is\\_evaluation:true,LLM\\_evaluation:true". This method is not recommended for common scenarios because it may degrade performance. Use commas (,) to separate multiple labels. The system matches all specified key-value pairs.', 'type' => 'string', 'required' => false, 'example' => 'is_evaluation:true'], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to display details, including Metrics, Params, and Labels. Valid values:'."\n" ."\n" .'- true: displays details.'."\n" ."\n" .'- false (default): does not display details.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'true'], ], [ 'name' => 'GmtCreateTime', 'in' => 'query', 'schema' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2021-01-30T12:51:33.028Z'], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => ['description' => 'The fields to sort by and the sort order. You can sort by GmtCreateTime and Name. Valid sort orders are DESC and ASC. The default is ASC. To sort by multiple fields, separate them with a comma (,).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'GmtCreateTime DESC,Name ASC'], ], [ 'name' => 'PageToken', 'in' => 'query', 'schema' => ['description' => 'The paging token. The value starts from 0. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '0', 'title' => '', 'example' => '0'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '10', 'title' => '', 'example' => '10'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to display on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field to use for sorting. Valid values:'."\n" ."\n" .'- Name: the name of the run.'."\n" ."\n" .'- GmtCreateTime (default): the time when the run was created.', 'type' => 'string', 'required' => false, 'default' => 'GmtCreateTime', 'example' => 'GmtCreateTime'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The sort order for the paged query. Use this parameter with SortBy.'."\n" ."\n" .'- ASC: ascending order.'."\n" ."\n" .'- DESC (default): descending order.', 'type' => 'string', 'required' => false, 'default' => 'DESC', 'example' => 'DESC'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], 'Runs' => [ 'description' => 'The list of runs.', 'type' => 'array', 'items' => ['description' => 'The details of the run instance.', '$ref' => '#/components/schemas/Run', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries that meet the filter criteria. This parameter is optional and may not be returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'NextPageToken' => ['description' => 'The paging token. For the first query, leave this parameter empty. The token for the next page is returned in the response. If the returned token is 0, all results have been returned. You can obtain the token for the next page from the **NextPageToken** field in the response.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'example' => '', ], ], ], 'title' => 'ListRuns', 'summary' => 'Retrieves a list of runs.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRuns'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'paiexperiment:ListRuns', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Runs\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"SourceId\\": \\"train9s0afvjkf\\",\\n \\"SourceType\\": \\"TrainingService\\",\\n \\"WorkspaceId\\": \\"145883\\",\\n \\"Params\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Name\\": \\"testrun\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"163104*****3440\\",\\n \\"ExperimentId\\": \\"exp-1zpfthdx******\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"run-1qJhzJ2YXgX****\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListUserConfigs' => [ 'summary' => 'Retrieves user configurations.', 'path' => '/api/v1/userconfigs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194785', 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ 'name' => 'ConfigKeys', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'A collection of configuration keys. Only customizePAIAssumedRole is supported.', 'type' => 'string', 'required' => false, 'example' => 'customizePAIAssumedRole'], ], [ 'name' => 'CategoryNames', 'in' => 'query', 'schema' => ['description' => 'The category. Only DataPrivacyConfig is supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'DataPrivacyConfig'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'sdjksdk-******-dsfds'], 'Configs' => [ 'title' => '', 'description' => 'The list of configurations.', 'type' => 'array', 'items' => [ 'description' => 'The configuration.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The configuration key.', 'type' => 'string', 'example' => 'customizePAIAssumedRole'], 'ConfigValue' => ['title' => '', 'description' => 'The configuration value.', 'type' => 'string', 'example' => 'role'], 'CategoryName' => ['description' => 'The category. Only DataPrivacyConfig is supported.', 'type' => 'string', 'title' => '', 'example' => 'DataPrivacyConfig'], 'Scope' => ['description' => 'The scope. Supported values are subUser and owner.', 'type' => 'string', 'title' => '', 'example' => 'subUser'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], 'example' => '', ], ], ], 'title' => 'ListUserConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserConfigs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListUserConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"sdjksdk-******-dsfds\\",\\n \\"Configs\\": [\\n {\\n \\"ConfigKey\\": \\"customizePAIAssumedRole\\",\\n \\"ConfigValue\\": \\"role\\",\\n \\"CategoryName\\": \\"DataPrivacyConfig\\",\\n \\"Scope\\": \\"subUser\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListWorkspaceRoles' => [ 'summary' => 'Lists the roles in a specified workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/roles', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221945', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. Call the [ListWorkspaces](~~449124~~) operation to get it.', 'type' => 'string', 'required' => true, 'example' => '87***', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Pages start from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'RoleIds', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of role IDs.', 'type' => 'string', 'required' => false, 'example' => 'role-dhg*******', 'title' => ''], ], [ 'name' => 'RoleName', 'in' => 'query', 'schema' => ['description' => 'The role name.', 'type' => 'string', 'required' => false, 'example' => 'dev-test'."\n", 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', 'schema' => ['description' => 'The role type.'."\n" ."\n" .'- `custom`: A custom role.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], ], [ 'name' => 'VerboseFields', 'in' => 'query', 'schema' => ['description' => 'A comma-separated list of fields to return. Currently, only `ModulePermissions` is supported, which returns the permission configuration of the role.', 'type' => 'string', 'required' => false, 'example' => 'ModulePermissions', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['description' => 'The sort field for paginated queries. Valid values:'."\n" ."\n" .'- `GmtCreateTime` (default): Sorts by creation time.'."\n" ."\n" .'- `GmtModifiedTime`: Sorts by modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'The sort order for the specified sort field. Valid values:'."\n" ."\n" .'- `ASC` (default): Ascending order.'."\n" ."\n" .'- `DESC`: Descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status. Valid values:'."\n" ."\n" .'- `Creating`'."\n" ."\n" .'- `Updating`'."\n" ."\n" .'- `Deleting`'."\n" ."\n" .'- `Succeeded`: A terminal state.'."\n" ."\n" .'- `Failed`: A terminal state.', 'type' => 'string', 'required' => false, 'example' => 'Succeeded', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ' '."\n" .'A519F77D-28A0-52F5-AB82-5********8'], 'Roles' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RoleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'dev-test', 'title' => ''], 'RoleId' => ['description' => 'The ID of the custom role.', 'type' => 'string', 'example' => 'role-dhg*******', 'title' => ''], 'GmtCreateTime' => ['description' => 'The creation time, in UTC and ISO 8601 format.', 'type' => 'string', 'example' => '2025-09-14T07:40:01.000Z', 'title' => ''], 'GmtModifiedTime' => ['description' => 'The modification time, in UTC and ISO 8601 format.', 'type' => 'string', 'example' => '2026-04-15T02:29:52Z', 'title' => ''], 'Creator' => ['description' => 'The Alibaba Cloud account UID of the creator.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], 'ModulePermissions' => ['description' => 'The permission configuration of the role.', '$ref' => '#/components/schemas/ModulePermissions', 'title' => '', 'example' => ''], ], 'description' => 'A role object.', 'title' => '', 'example' => '', ], 'description' => 'The list of custom roles.', 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total count of matching entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], 'title' => 'ListWorkspaceRoles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaceRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\\\t\\\\nA519F77D-28A0-52F5-AB82-5********8\\",\\n \\"Roles\\": [\\n {\\n \\"RoleName\\": \\"dev-test\\",\\n \\"RoleId\\": \\"role-dhg*******\\",\\n \\"GmtCreateTime\\": \\"2025-09-14T07:40:01.000Z\\",\\n \\"GmtModifiedTime\\": \\"2026-04-15T02:29:52Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleName\\": \\"PaiDesigner\\",\\n \\"PermissionType\\": \\"ReadOnly\\",\\n \\"Permissions\\": [\\n {\\n \\"PermissionCodes\\": [\\n \\"PaiDLC:GetTensorboard\\"\\n ],\\n \\"PermissionRules\\": [\\n {\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EntityAccessType\\": \\"CREATOR\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListWorkspaceUsers' => [ 'path' => '/api/v1/workspaces/{WorkspaceId}/users', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '14222', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '12345'], ], [ 'name' => 'UserName', 'in' => 'query', 'schema' => ['description' => 'The display name of the user that can be added as a workspace member.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'doctest****'], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1e195c5116124202371861018d5bde'], 'TotalCount' => ['title' => '', 'description' => 'The number of users that meet the filter condition.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'Users' => [ 'title' => '', 'description' => 'The list of users.', 'type' => 'array', 'items' => [ 'description' => 'The user.', 'type' => 'object', 'properties' => [ 'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => '1611******3000'], 'UserName' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'she******mo'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'ListWorkspaceUsers', 'summary' => 'Lists users that can be added as members to a workspace.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaceUsers'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaceUsers', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"TotalCount\\": 2,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"1611******3000\\",\\n \\"UserName\\": \\"she******mo\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'ListWorkspaces' => [ 'path' => '/api/v1/workspaces', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '14203', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the workspace list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field used for sorting in a paged query. Default value: GmtCreateTime. Valid values:'."\n" .'* GmtCreateTime (default): sorts by creation time.'."\n" .'* GmtModifiedTime: sorts by modification time.', 'type' => 'string', 'example' => 'GmtCreateTime', 'required' => false], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The sort order for the specified sort field in a paged query. Valid values:'."\n" .'* ASC (default): ascending order.'."\n" .'* DESC: descending order.', 'type' => 'string', 'example' => 'ASC', 'required' => false], ], [ 'name' => 'WorkspaceName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'example' => 'abc', 'required' => false], ], [ 'name' => 'ModuleList', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The comma-separated list of modules. Default value: PAI.', 'type' => 'string', 'example' => 'PAI', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The workspace status. Valid values:'."\n" ."\n" .'- ENABLED: Normal.'."\n" .'- INITIALIZING: Being initialized.'."\n" .'- FAILURE: Failed.'."\n" .'- DISABLED: Manually disabled.'."\n" .'- FROZEN: Frozen due to overdue payment.'."\n" .'- UPDATING: Being updated.', 'type' => 'string', 'example' => 'ENABLED', 'required' => false], ], [ 'name' => 'Option', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The query option. Valid values:'."\n" .'* GetWorkspaces (default): retrieves the workspace list. The Workspaces parameter is returned.'."\n" .'* GetResourceLimits: retrieves resource limits. The ResourceLimits parameter is returned.', 'type' => 'string', 'example' => 'GetWorkspaces', 'required' => false], ], [ 'name' => 'Verbose', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to display detailed workspace information. Valid values:'."\n" .'- false (default): does not display detailed information.'."\n" .'- true: displays detailed information.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'Fields', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The list of return fields for workspace details. This parameter limits the workspace properties returned in the result.'."\n" .'Separate multiple properties with commas (,). Currently, only Id is supported, which represents the workspace ID.', 'type' => 'string', 'example' => 'Id', 'required' => false], ], [ 'name' => 'WorkspaceIds', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The list of workspace IDs. Separate multiple workspace IDs with commas (,).', 'type' => 'string', 'example' => '123,234', 'required' => false], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID. For information about how to view the resource group ID, see [View basic information of a resource group](~~151181~~).', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwp7rky****', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], 'Workspaces' => [ 'title' => '', 'description' => 'The list of workspace details. This list is returned when Option is set to GetWorkspaces.', 'type' => 'array', 'items' => [ 'description' => 'The workspace details.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '123'], 'WorkspaceName' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'example' => 'workspace-example'], 'GmtCreateTime' => ['title' => '', 'description' => 'The time when the workspace was created. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mm:ss.SSSZ.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'GmtModifiedTime' => ['title' => '', 'description' => 'The time when the workspace was last modified. The time follows the ISO 8601 standard in UTC+0. Format: yyyy-MM-ddTHH:mmZ.', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'], 'Description' => ['title' => '', 'description' => 'The workspace description.', 'type' => 'string', 'example' => 'workspace description example'], 'Creator' => ['title' => '', 'description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '122424353535'], 'EnvTypes' => [ 'title' => '', 'description' => 'The list of environments in the workspace.', 'type' => 'array', 'items' => ['description' => 'The environment in the workspace. Valid values:'."\n" ."\n" .'- Simple mode contains only the production environment (prod).'."\n" .'- Standard mode contains the development environment (dev) and the production environment (prod).', 'type' => 'string', 'example' => 'prod', 'title' => ''], 'example' => '', ], 'Status' => ['title' => '', 'description' => 'The workspace status.', 'type' => 'string', 'example' => 'ENABLED'], 'AdminNames' => [ 'title' => '', 'description' => 'The list of administrator account names.', 'type' => 'array', 'items' => ['description' => 'The administrator account name.', 'type' => 'string', 'example' => 'demo_test@***.aliyunid.com', 'title' => ''], 'example' => '', ], 'IsDefault' => ['title' => '', 'description' => 'Indicates whether the workspace is the default workspace.', 'type' => 'boolean', 'example' => 'false'], 'ExtraInfos' => ['title' => '', 'description' => 'The extended information. Currently, this includes TenantId, which represents the tenant ID.', 'type' => 'object', 'example' => '{"TenantId": "4286******98"}'], 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmwp7rky****', 'title' => ''], 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'The total number of workspaces that match the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ResourceLimits' => ['title' => '', 'description' => 'The resource types and quantity limits that a user can activate within a workspace. This list is returned when Option is set to GetResourceLimits.'."\n" .'Currently supported resource types include:'."\n" .'* MaxCompute_share: MaxCompute pay-as-you-go.'."\n" .'* MaxCompute_isolate: MaxCompute subscription.'."\n" .'* DLC_share: DLC pay-as-you-go.'."\n" .'* PAI_isolate: PAI subscription.'."\n" .'* PAI_share: PAI pay-as-you-go.'."\n" .'* DataWorks_isolate: DataWorks subscription.'."\n" .'* DataWorks_share: DataWorks pay-as-you-go.', 'type' => 'object', 'example' => '{'."\n" .' "MaxCompute_share": 1,'."\n" .' "MaxCompute_isolate": 1,'."\n" .' "DLC_share": 1'."\n" .'}'], ], 'example' => '', ], ], ], 'title' => 'List workspaces', 'summary' => 'Retrieves the list of workspaces in a specified region.', 'description' => 'You can specify different query options by using the option parameter to retrieve different workspace-related information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaces', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"Workspaces\\": [\\n {\\n \\"WorkspaceId\\": \\"123\\",\\n \\"WorkspaceName\\": \\"workspace-example\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Description\\": \\"workspace description example\\",\\n \\"Creator\\": \\"122424353535\\",\\n \\"EnvTypes\\": [\\n \\"prod\\"\\n ],\\n \\"Status\\": \\"ENABLED\\",\\n \\"AdminNames\\": [\\n \\"demo_test@***.aliyunid.com\\"\\n ],\\n \\"IsDefault\\": false,\\n \\"ExtraInfos\\": {\\n \\"TenantId\\": \\"4286******98\\"\\n },\\n \\"resourceGroupId\\": \\"rg-acfmwp7rky****\\",\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"ResourceLimits\\": {\\n \\"MaxCompute_share\\": 1,\\n \\"MaxCompute_isolate\\": 1,\\n \\"DLC_share\\": 1\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'LogRunMetrics' => [ 'summary' => 'Records the metrics of a run in a batch.', 'path' => '/api/v1/runs/{RunId}/metrics/action/log', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '237449', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The ID of the run.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Metrics' => [ 'description' => 'The list of metrics.', 'type' => 'array', 'items' => ['description' => 'The details of a metric.', 'required' => false, '$ref' => '#/components/schemas/RunMetric', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], 'example' => '', ], ], ], 'title' => 'LogRunMetrics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'LogRunMetrics'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'PublishCodeSource' => [ 'summary' => 'Publishes a private code source, making it public in a workspace.', 'path' => '/api/v1/codesources/{CodeSourceId}/publish', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '55459', 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], ], 'parameters' => [ [ 'name' => 'CodeSourceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the code source to publish. For more information, see [ListCodeSources](~~459922~~).', 'type' => 'string', 'required' => true, 'example' => 'code-a797*******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'CodeSourceId' => ['title' => '', 'description' => 'The ID of the code source that was published.', 'type' => 'string', 'example' => 'code-a797*******'], 'RequestId' => ['description' => 'The ID of the request. This is used to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PublishCodeSource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishCodeSource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paicodesource:PublishCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-a797*******\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'PublishDataset' => [ 'summary' => 'Publishes a private dataset in a workspace.', 'path' => '/api/v1/datasets/{DatasetId}/publish', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48571', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5w****c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PublishDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataset'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:PublishDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'PublishImage' => [ 'summary' => 'Publishes an image and changes its visibility from PRIVATE to PUBLIC.', 'path' => '/api/v1/images/{ImageId}/publish', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '72192', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The image ID. For more information, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'image-dk******fa'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], 'ImageId' => ['title' => '', 'description' => 'The image ID.', 'type' => 'string', 'example' => 'image-dk******fa'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PublishImage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishImage'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiimage:PublishImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\",\\n \\"ImageId\\": \\"image-dk******fa\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'RemoveImage' => [ 'summary' => 'Deletes an image.', 'path' => '/api/v1/images/{ImageId}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61615', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the image. To obtain the image ID, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'image-rbv******c9ks92'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RemoveImage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImage'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiimage:RemoveImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'RemoveImageLabels' => [ 'summary' => 'Removes a label from an image.', 'path' => '/api/v1/images/{ImageId}/labels/{LabelKey}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '61614', 'abilityTreeNodes' => ['FEATURElearnAFIS9K'], ], 'parameters' => [ [ 'name' => 'ImageId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the image. For more information, see [ListImages](~~449118~~).', 'type' => 'string', 'required' => true, 'example' => 'image-d8df******dsjfd'], ], [ 'name' => 'LabelKey', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The key of the label.', 'type' => 'string', 'required' => true, 'example' => 'key1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'RemoveImageLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImageLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiimage:RemoveImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'RemoveMemberRole' => [ 'summary' => 'Removes a role from a member.', 'path' => '/api/v1/workspaces/{WorkspaceId}/members/{MemberId}/roles/{RoleName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the workspace. To get this ID, call the [ListWorkspaces](~~449124~~) operation.', 'type' => 'string', 'required' => true, 'example' => '145883', 'title' => ''], ], [ 'name' => 'MemberId', 'in' => 'path', 'schema' => ['description' => 'The ID of the member. To get this ID, see [ListMembers](~~449135~~).', 'type' => 'string', 'required' => true, 'example' => '145883-21513926******88039', 'title' => ''], ], [ 'name' => 'RoleName', 'in' => 'path', 'schema' => ['description' => 'The role to remove. Both official roles and custom roles are supported:'."\n" ."\n" .'- Official roles: Valid values include the following. See [Appendix: Roles and permissions](~~2840449~~) for more information about the permissions of each role.'."\n" ."\n" .' - PAI.AlgoDeveloper: Algorithm developer.'."\n" ."\n" .' - PAI.AlgoOperator: Algorithm operator.'."\n" ."\n" .' - PAI.LabelManager: Label manager.'."\n" ."\n" .' - PAI.MaxComputeDeveloper: MaxCompute developer.'."\n" ."\n" .' - PAI.WorkspaceAdmin: Administrator.'."\n" ."\n" .' - PAI.WorkspaceGuest: Guest.'."\n" ."\n" .' - PAI.WorkspaceOwner: Owner.'."\n" ."\n" .'- Custom roles: Specify the role ID. The ID must start with `role-`, for example, `role-sw******2tij`.', 'type' => 'string', 'required' => true, 'example' => 'PAI.AlgoDeveloper', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'title' => 'RemoveMemberRole', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMemberRole'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:RemoveMemberRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SetExperimentLabels' => [ 'summary' => 'Updates the labels of an experiment.', 'path' => '/api/v1/experiments/{ExperimentId}/labels', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '207071', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Labels' => [ 'description' => 'A list of labels.', 'type' => 'array', 'items' => ['description' => 'The details of a label, including its key and value.', 'required' => false, '$ref' => '#/components/schemas/LabelInfo', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ExperimentId', 'in' => 'path', 'schema' => ['description' => 'The ID of the experiment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'exp-1zpfthdx******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'title' => 'SetExperimentLabels', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'SetExperimentLabels'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:SetExperimentLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'SetUserConfigs' => [ 'summary' => 'Updates user configurations.', 'path' => '/api/v1/userconfigs', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194786', 'abilityTreeNodes' => ['FEATURElearnDVAH75'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration.', 'type' => 'object', 'properties' => [ 'Configs' => [ 'title' => '', 'description' => 'The list of configurations.', 'type' => 'array', 'items' => [ 'description' => 'A configuration.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The configuration key.', 'type' => 'string', 'required' => true, 'example' => 'customizePAIAssumedRole'], 'ConfigValue' => ['title' => '', 'description' => 'The configuration value.', 'type' => 'string', 'required' => true, 'example' => 'role'], 'CategoryName' => ['description' => 'The classification. Only DataPrivacyConfig is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DataPrivacyConfig'], 'Scope' => ['description' => 'The scope. Valid values: subUser and owner.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'owner'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'dsjk****dfjksdf'], ], 'example' => '', ], ], ], 'title' => 'SetUserConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserConfigs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'pai:SetUserConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'StopDatasetJob' => [ 'summary' => 'Stops a dataset Job.', 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}/action/stop', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260528', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobId', 'in' => 'path', 'schema' => ['description' => 'The dataset job ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsjob-9jx1*****uj9e'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], 'WorkspaceId' => ['description' => 'The workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '478**'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F620FFD3-FFDC-5873-A70C-6971CC45F467'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StopDatasetJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDatasetJob'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'paidataset:StopDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F620FFD3-FFDC-5873-A70C-6971CC45F467\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateCodeSource' => [ 'summary' => 'Updates a code source configuration.', 'path' => '/api/v1/codesources/{CodeSourceId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '246302', 'abilityTreeNodes' => ['FEATURElearnFOSXQT'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CodeSourceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the code source configuration. You can obtain the ID by calling the CreateCodeSource, GetCodeSource, or ListCodeSources operation.', 'type' => 'string', 'required' => true, 'example' => 'code-202**********'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['title' => '', 'description' => 'The name of the code source configuration.', 'type' => 'string', 'required' => false, 'example' => 'MyCodeSource1'], 'Description' => ['title' => '', 'description' => 'The description of the code source configuration.', 'type' => 'string', 'required' => false, 'example' => '用于XX的训练代码'], 'CodeRepo' => ['title' => '', 'description' => 'The URL of the code repository.', 'type' => 'string', 'required' => false, 'example' => 'https://code.aliyun.com/******'], 'CodeBranch' => ['title' => '', 'description' => 'The branch name of the code.', 'type' => 'string', 'required' => false, 'example' => 'dev'], 'CodeCommit' => ['title' => '', 'description' => 'The commit ID of the code.', 'type' => 'string', 'required' => false, 'example' => '3a6*****'], 'CodeRepoUserName' => ['title' => '', 'description' => 'The username used to access the access code repository.', 'type' => 'string', 'required' => false, 'example' => 'demo-user'], 'CodeRepoAccessToken' => ['title' => '', 'description' => 'The access token associated with the username.', 'type' => 'string', 'required' => false, 'example' => '***'], 'MountPath' => ['title' => '', 'description' => 'The default mount path.', 'type' => 'string', 'required' => false, 'example' => '/root/code/code-source-1'], 'CloneType' => ['description' => 'The clone mode. Valid values:'."\n" .'- 0 (default): creates a new subdirectory.'."\n" .'- 1: tiles to the current directory.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => '40325405-579C-4D82****'], 'CodeSourceId' => ['title' => '', 'description' => 'The ID of the code source configuration.', 'type' => 'string', 'example' => 'code-20********'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"CodeSourceId\\": \\"code-20********\\"\\n}","type":"json"}]', 'title' => 'Update code source configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCodeSource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paicodesource:UpdateCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateConfig' => [ 'summary' => 'Updates or creates workspace configurations.', 'path' => '/api/v1/workspaces/{WorkspaceId}/config', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '234915', 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1234******2'."\n"], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: The path for temporary storage. This key is valid only when CategoryName is set to CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: The auto-recycle configuration. This key is valid only when CategoryName is set to DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: The priority configuration. This key is valid only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: The maximum runtime of a DLC task for a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: The predefined tags for the workspace. Created resources must have these tags.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tempStoragePath'], 'ConfigValue' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oss://***'."\n"], 'CategoryName' => ['description' => 'The classification of the configuration item. The following classifications are supported:'."\n" ."\n" .'- CommonResourceConfig: The common resource configuration.'."\n" ."\n" .'- DLCAutoRecycle: The DLC auto-recycle configuration.'."\n" ."\n" .'- DLCPriorityConfig: The DLC priority settings.'."\n" ."\n" .'- DSWPriorityConfig: The DSW priority settings.'."\n" ."\n" .'- QuotaMaximumDuration: The maximum runtime of a DLC task for a quota.'."\n" ."\n" .'- CommonTagConfig: The tag settings.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CommonResourceConfig'], 'Labels' => [ 'description' => 'The list of labels for the configuration item.', 'type' => 'array', 'items' => [ 'description' => 'A label for the configuration item.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the label.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1'], 'Value' => ['description' => 'The value of the label.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'UpdateConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateConfigs' => [ 'summary' => 'Updates or creates workspace configurations in batches.', 'path' => '/api/v1/workspaces/{WorkspaceId}/configs', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '117760', 'abilityTreeNodes' => ['FEATURElearnOTS2AE'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '83***'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Configs' => [ 'title' => '', 'description' => 'A list of workspace configurations to update or add.', 'type' => 'array', 'items' => [ 'description' => 'A workspace configuration to update or add.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The key of the configuration item. The following keys are supported:'."\n" ."\n" .'- tempStoragePath: The path for temporary storage. This key is valid only when CategoryName is set to CommonResourceConfig.'."\n" ."\n" .'- isAutoRecycle: The configuration for automatic resource recycling. This key is valid only when CategoryName is set to DLCAutoRecycle.'."\n" ."\n" .'- priorityConfig: The priority configuration. This key is valid only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" ."\n" .'- quotaMaximumDuration: The maximum runtime configuration for a DLC job within a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration.'."\n" ."\n" .'- predefinedTags: The predefined tags for the workspace. Created resources must have these tags.', 'type' => 'string', 'required' => false, 'example' => 'tempStoragePath'], 'ConfigValue' => ['title' => '', 'description' => 'The value of the configuration item.'."\n" ."\n" .'- If ConfigKey is set to predefinedTags, the format of ConfigValue is \\[{"Type":"Tag","Key":"Key1","Value":"{\\\\"Products\\\\":\\\\"DLC,DSW,EAS\\\\",\\\\"Values\\\\":\\\\"value1,value2,value3\\\\"}"}]. The Products field specifies which products use the predefined tags.', 'type' => 'string', 'required' => false, 'example' => 'oss://test/s/'], 'CategoryName' => ['description' => 'The category of the configuration item. The following categories are supported:'."\n" ."\n" .'- CommonResourceConfig: General resource configuration.'."\n" ."\n" .'- DLCAutoRecycle: DLC automatic recycling.'."\n" ."\n" .'- DLCPriorityConfig: DLC priority settings.'."\n" ."\n" .'- DSWPriorityConfig: DSW priority settings.'."\n" ."\n" .'- QuotaMaximumDuration: Configuration for the maximum runtime of a DLC job within a quota.'."\n" ."\n" .'- CommonTagConfig: Tag settings.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CommonResourceConfig'], 'Labels' => [ 'description' => 'A list of tags for the configuration item.', 'type' => 'array', 'items' => [ 'description' => 'A tag for the configuration item.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'key1'], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'value1'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n"], ], 'example' => '', ], ], ], 'title' => 'UpdateConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigs'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdateConnection' => [ 'summary' => 'Updates a connection configuration.', 'path' => '/api/v1/connections/{ConnectionId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267622', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'ConnectionId', 'in' => 'path', 'schema' => ['description' => 'The connection ID. For information about how to obtain a connection ID, see [ListConnections](url).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'conn-pai9m***mi47'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Configs' => [ 'description' => 'The configuration of the connection, specified as key-value pairs. The keys in the Configs parameter vary based on the connection type. For more information, see the request parameters in the CreateConnection topic.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['type' => 'string', 'description' => 'The value of a connection configuration parameter.', 'title' => '', 'example' => '6379'], 'title' => '', 'example' => '', ], 'Description' => ['description' => 'The description of the connection.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Connection for data labeling.'], 'Secrets' => [ 'description' => 'Key-value pairs that require encryption, such as database logon passwords and keys for model connections.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['type' => 'string', 'description' => 'The value of an encrypted connection configuration parameter.', 'title' => '', 'example' => 'Dakbjas**aljksdn'], 'title' => '', 'example' => '', ], 'Models' => [ 'description' => 'A list of model information.', 'type' => 'array', 'items' => [ 'description' => 'The model information.', 'type' => 'object', 'properties' => [ 'Model' => ['description' => 'The model identifier.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'model_001'], 'DisplayName' => ['description' => 'The display name of the model.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'car_tag'], 'ModelType' => ['description' => 'The model type. Valid values:'."\n" ."\n" .'- LLM'."\n" ."\n" .'- Embedding'."\n" ."\n" .'- ReRank', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'LLM'], 'ToolCall' => ['description' => 'Indicates whether tool calling is supported. Valid values:'."\n" ."\n" .'- true: Tool calling is supported.'."\n" ."\n" .'- false: Tool calling is not supported.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', 'title' => 'UpdateConnection', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UpdateDataset' => [ 'summary' => 'Updates the properties of a dataset, such as its name and description.', 'path' => '/api/v1/datasets/{DatasetId}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '48566', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For information about how to obtain the dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'example' => 'd-rbvg5wz****c9ks92', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The dataset name. For information about how to obtain the dataset name, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => false, 'example' => 'myName', 'title' => ''], 'Description' => ['description' => 'The description of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the dataset.', 'title' => ''], 'Options' => ['description' => 'An extended field in a JSON string format. When you use the dataset with Data Lake Compute (DLC), you can configure the `mountPath` field to specify the default mount path.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}', 'title' => ''], 'Edition' => [ 'description' => 'The dataset edition. You can upgrade a dataset from `BASIC` to `ADVANCED`.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'ADVANCED', 'title' => '', ], 'MountAccessReadWriteRoleIdList' => [ 'description' => 'A list of workspace roles that have read and write permissions on the mounted dataset. Role IDs that start with `PAI` are basic role IDs, and role IDs that start with `role-` are custom role IDs. If the list contains an asterisk (`*`), all roles are granted read and write permissions.'."\n" ."\n" .'- To specify roles: \\["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]'."\n" ."\n" .'- To specify all roles: \\["\\*"]'."\n" ."\n" .'- To specify only the dataset creator: \\[]', 'type' => 'array', 'items' => ['description' => 'A workspace role ID.', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator'."\n", 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'SharingConfig' => [ 'type' => 'object', 'properties' => [ 'SharedTo' => [ 'type' => 'array', 'items' => ['description' => 'A sharing relationship.', '$ref' => '#/components/schemas/DatasetShareRelationship', 'required' => false, 'title' => '', 'example' => ''], 'description' => 'The sharing relationships of the dataset.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'The sharing configuration of the dataset.', 'required' => false, 'title' => '', 'example' => '', ], 'Accessibility' => ['description' => 'The visibility of the dataset in the workspace. Valid values:'."\n" ."\n" .'- `PRIVATE` (default): The dataset is visible only to its owner and administrators.'."\n" ."\n" .'- `PUBLIC`: The dataset is visible to all users in the workspace.'."\n" ."\n" .'- `ROLE_PUBLIC`: The dataset is visible to users in specific workspace roles. You must specify the roles in the `AccessibleRoleIdList` parameter. The dataset owner and administrators can always view the dataset.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE', 'title' => ''], 'AccessibleRoleIdList' => [ 'type' => 'array', 'items' => ['description' => 'A workspace role ID.', 'type' => 'string', 'required' => false, 'example' => 'PAI.AlgoOperator', 'title' => ''], 'description' => 'This parameter takes effect only when `Accessibility` is set to `ROLE_PUBLIC`. It specifies the list of workspace roles that can view the dataset. Role IDs that start with `PAI` are basic role IDs, and role IDs that start with `role-` are custom role IDs.', 'title' => '', 'example' => '', 'required' => false, ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'title' => 'UpdateDataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'UpdateDatasetFileMetas' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetfilemetas', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260629', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-lfd60v0p****ujtsdx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], 'WorkspaceId' => ['description' => 'The ID of the workspace that contains the dataset. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '796**'], 'DatasetFileMetas' => [ 'description' => 'A list of dataset file metadata to update.', 'type' => 'array', 'items' => ['description' => 'The details of the file metadata to update.', 'required' => false, '$ref' => '#/components/schemas/DatasetFileMetaConentUpdate', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', ], 'TagJobId' => ['description' => 'The ID of the tagging job for updating metadata tags.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'dsjob-hv0b1****u8taig3y'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], 'Status' => ['description' => 'The status of the batch metadata update. A value of \\`true\\` indicates that all updates succeeded. If the value is \\`false\\`, check the \\`FailedDetails\\` parameter.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'FailedDetails' => [ 'description' => 'A list of file metadata that failed to be updated.', 'type' => 'array', 'items' => ['description' => 'The details of the file metadata that failed to be updated.', '$ref' => '#/components/schemas/DatasetFileMetaResponse', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateDatasetFileMetas', 'summary' => 'Updates multiple file metadata records in a dataset.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetFileMetas'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6\\",\\n \\"Result\\": \\"Not Found\\",\\n \\"Uri\\": \\"oss://l*****-test/dataset/1653421.jpg\\"\\n }\\n ]\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateDatasetJob' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260531', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The dataset ID. For more information about how to obtain a dataset ID, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dsjob-9jx1*****uj9e'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'DatasetVersion' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'v1'], 'WorkspaceId' => ['description' => 'The ID of the workspace. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '478**'], 'Description' => ['description' => 'The description of the dataset job.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'This is a job description of a dataset.'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateDatasetJob', 'summary' => 'Updates a dataset job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJob'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateDatasetJobConfig' => [ 'path' => '/api/v1/datasets/{DatasetId}/datasetjobconfigs/{DatasetJobConfigId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260467', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5*****jhc9ks92'], ], [ 'name' => 'DatasetJobConfigId', 'in' => 'path', 'schema' => ['description' => 'The ID of the configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dscfg-xxxxxxxxxxxx'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '167497'], 'ConfigType' => [ 'description' => 'The configuration type.'."\n" ."\n" .'- MultimodalIntelligentTag'."\n" ."\n" .'- MultimodalSemanticIndex', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['MultimodalIntelligentTag' => 'MultimodalIntelligentTag', 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex'], 'title' => '', 'example' => 'MultimodalSemanticIndex', ], 'Config' => ['description' => 'The configuration content.'."\n" .'The format is as follows:'."\n" ."\n" .'- MultimodalIntelligentTag'."\n" ."\n" .'{'."\n" .'"apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx"'."\n" .'}'."\n" ."\n" .'- MultimodalSemanticIndex'."\n" ."\n" .'{'."\n" .'"defaultModelId": "xxx",'."\n" .'"defaultModelVersion":"1.0.0"'."\n" .'}', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9'], ], 'example' => '', ], ], ], 'title' => 'UpdateDatasetJobConfig', 'summary' => 'Updates a dataset job configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJobConfig'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdateDatasetVersion' => [ 'path' => '/api/v1/datasets/{DatasetId}/versions/{VersionName}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '232571', 'abilityTreeNodes' => ['FEATURElearnTXMM8C'], ], 'parameters' => [ [ 'name' => 'DatasetId', 'in' => 'path', 'schema' => ['description' => 'The ID of the dataset. For more information, see [ListDatasets](~~457222~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'd-rbvg5****jhc9ks92'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset version.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Options' => ['description' => 'An extension field in the JSON String format.'."\n" .'When DLC uses the dataset, you can configure the mountPath field to specify the default mount path.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" .' "mountPath": "/mnt/data/"'."\n" .'}'], 'Description' => ['description' => 'A custom description of the dataset to distinguish it from other datasets.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'This is a description of a dataset version.'], 'DataSize' => ['description' => 'The size of the dataset files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '100000'], 'DataCount' => ['description' => 'The number of files in the dataset.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '100'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateDatasetVersion', 'summary' => 'Updates the information for a specific version of a dataset.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateDefaultWorkspace' => [ 'summary' => 'Sets a workspace as the default.', 'path' => '/api/v1/defaultWorkspaces', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'WorkspaceId' => ['title' => '', 'description' => 'The ID of the workspace. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '12345'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '17915******4216'], ], 'example' => '', ], ], ], 'title' => 'UpdateDefaultWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDefaultWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:UpdateDefaultWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17915******4216\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateExperiment' => [ 'summary' => 'Updates an experiment.', 'path' => '/api/v1/experiments/{ExperimentId}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '206975', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the experiment. The naming convention is as follows:'."\n" ."\n" .'- Must start with a lowercase or uppercase letter.'."\n" ."\n" .'- Can contain lowercase letters, uppercase letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- The length must be 1 to 63 characters.', 'type' => 'string', 'required' => false, 'example' => 'myName'], 'Accessibility' => [ 'description' => 'The visibility of the experiment in the workspace. Valid values:'."\n" ."\n" .'- PRIVATE: The experiment is visible only to you and the administrator in the workspace.'."\n" ."\n" .'- PUBLIC: The experiment is visible to everyone in the workspace.', 'type' => 'string', 'required' => false, 'enum' => ['PRIVATE', 'PUBLIC'], 'title' => '', 'example' => 'PRIVATE', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ExperimentId', 'in' => 'path', 'schema' => ['description' => 'The experiment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'exp-1zpfthdx******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'title' => 'UpdateExperiment', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateExperiment'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiexperiment:UpdateExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdateModel' => [ 'summary' => 'Updates the basic configuration of a model.', 'path' => '/api/v1/models/{ModelId}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133763', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information about how to obtain the model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-rbvg5wz******ks92'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ModelName' => ['title' => '', 'description' => 'The name of the model. The name must be 1 to 127 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'News classification'], 'ModelDescription' => ['title' => '', 'description' => 'The model description.', 'type' => 'string', 'required' => false, 'example' => 'News classification.'], 'Accessibility' => ['title' => '', 'description' => 'The visibility of the model in the workspace. Valid values:'."\n" ."\n" .'- PRIVATE: The model is visible only to you and administrators in the workspace.'."\n" ."\n" .'- PUBLIC: The model is visible to everyone in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], 'Origin' => ['title' => '', 'description' => 'The source of the model. This parameter describes the community or organization to which the source model belongs, such as ModelScope and HuggingFace.', 'type' => 'string', 'required' => false, 'example' => 'ModelScope'], 'Domain' => ['title' => '', 'description' => 'The domain of the model. This parameter specifies the field where the model is applied. Examples: nlp (natural language processing) and cv (computer vision).', 'type' => 'string', 'required' => false, 'example' => 'nlp'], 'Task' => ['title' => '', 'description' => 'The task of the model. This parameter describes the specific problem that the model solves. For example, text-classification.', 'type' => 'string', 'required' => false, 'example' => 'text-classification'], 'ModelDoc' => ['title' => '', 'description' => 'The model document.', 'type' => 'string', 'required' => false, 'example' => 'https://*.md'], 'OrderNumber' => ['title' => '', 'description' => 'The ordinal number of the model. You can use this parameter for custom sorting.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], 'ModelType' => ['title' => '', 'description' => 'The model type, such as Checkpoint or LoRA.', 'type' => 'string', 'required' => false, 'example' => 'Checkpoint'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information about the model.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "RatingCount": 2866,'."\n" .' "Rating": 4.94,'."\n" .' "FavoriteCount": 34992,'."\n" .' "CommentCount": 754,'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/drea***w.png"],'."\n" .' "TippedAmountCount": 32,'."\n" .' "DownloadCount": 606056'."\n" .'}'], 'ParameterSize' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of parameters, in millions.', 'required' => false, 'title' => '', 'example' => '3000'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', 'title' => 'UpdateModel', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModel'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paimodel:UpdateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'UpdateModelVersion' => [ 'summary' => 'Updates a model version.', 'path' => '/api/v1/models/{ModelId}/versions/{VersionName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133781', 'abilityTreeNodes' => ['FEATURElearnN5P2NR'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'VersionDescription' => ['title' => '', 'description' => 'The description of the model version.', 'type' => 'string', 'required' => false, 'example' => 'General sentiment analysis.'], 'Metrics' => ['title' => '', 'description' => 'The model metrics.'."\n" .'The length cannot exceed 8,192 characters after serialization.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "Results": [{'."\n" .' "Dataset": {'."\n" .' "DatasetId": "d-sdkjanksaklerhfd"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.175'."\n" .' }'."\n" .' }, {'."\n" .' "Dataset": {'."\n" .' "Uri": "oss://xxxx/"'."\n" .' },'."\n" .' "Metrics": {'."\n" .' "cer": 0.172'."\n" .' }'."\n" .' }]'."\n" .'}'], 'TrainingSpec' => ['title' => '', 'description' => 'The training configuration. This is used for fine-tuning and incremental training.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'InferenceSpec' => ['title' => '', 'description' => 'Describes how to apply the model to downstream inference applications. For example, describe the processor and container for Elastic Algorithm Service (EAS). Example:'."\n" .'`{ "processor": "tensorflow_gpu_1.12" }`.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "processor": "tensorflow_gpu_1.12"'."\n" .'}'], 'Options' => ['title' => '', 'description' => 'The extended field. This field is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}'], 'SourceType' => [ 'title' => '', 'description' => 'The source type of the model. Valid values:'."\n" ."\n" .'- Custom (default): The model is a custom model.'."\n" ."\n" .'- PAIFlow: The model is from a PAI pipeline.'."\n" ."\n" .'- TrainingService: The model is from a PAI training service.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['PAIFlow' => 'PAIFlow', 'Custom' => 'Custom', 'TrainingService' => 'TrainingService'], 'example' => 'PAIFlow', ], 'SourceId' => ['title' => '', 'description' => 'The source ID.'."\n" ."\n" .'- If the source type is Custom, this field has no restrictions.'."\n" ."\n" .'- If the source is PAIFlow or TrainingService, the format is as follows:'."\n" ."\n" .'```'."\n" .'region=,workspaceId=,kind=,id='."\n" .'```'."\n" ."\n" .'The parameters are described as follows:'."\n" ."\n" .'- region: the Alibaba Cloud region ID.'."\n" ."\n" .'- workspaceId: the workspace ID.'."\n" ."\n" .'- kind: the type. Valid values: PipelineRun (PAI pipeline) or ServiceJob (training service).'."\n" ."\n" .'- id: the unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf'], 'ApprovalStatus' => ['title' => '', 'description' => 'The approval status. Valid values:'."\n" ."\n" .'- Pending: The model is pending approval.'."\n" ."\n" .'- Approved: The model is approved to be published.'."\n" ."\n" .'- Rejected: The model is not approved to be published.', 'type' => 'string', 'required' => false, 'example' => 'Approved'], 'EvaluationSpec' => ['title' => '', 'description' => 'The evaluation configuration.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'CompressionSpec' => ['title' => '', 'description' => 'The compression configuration.', 'type' => 'object', 'required' => false, 'example' => '{}'], 'ExtraInfo' => ['title' => '', 'description' => 'Other information.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" .' "TrainedWords": ["albedo_overlord"]'."\n" .'}'], 'DistillationSpec' => ['type' => 'object', 'description' => 'The distillation configuration.', 'required' => false, 'title' => '', 'example' => '{}'], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ModelId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model ID. For more information about how to obtain the model ID, see [ListModels](~~461944~~).', 'type' => 'string', 'required' => true, 'example' => 'model-dfs1****5c'], ], [ 'name' => 'VersionName', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The model version.', 'type' => 'string', 'required' => true, 'example' => '0.1.0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D5BFFEE3-6025-443F-8A03-02D61***C4B9'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D61***C4B9\\"\\n}","type":"json"}]', 'title' => 'UpdateModelVersion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModelVersion'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paimodel:UpdateModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'UpdateRun' => [ 'path' => '/api/v1/runs/{RunId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '233506', 'abilityTreeNodes' => ['FEATURElearnP1X97H'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'RunId', 'in' => 'path', 'schema' => ['description' => 'The ID of the run.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'run-1qJhzJ2YXgX****'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name of the run. The naming conventions are as follows:'."\n" ."\n" .'- Must start with a lowercase or uppercase letter.'."\n" ."\n" .'- Can contain lowercase letters, uppercase letters, digits, underscores (\\_), and hyphens (-).'."\n" ."\n" .'- The length must be 1 to 63 characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'myName'], 'Labels' => [ 'description' => 'A list of labels.', 'type' => 'array', 'items' => ['description' => 'The details of the label.', 'required' => false, '$ref' => '#/components/schemas/Label', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'A list of parameters.', 'type' => 'array', 'items' => ['description' => 'The details of the parameter.', 'required' => false, '$ref' => '#/components/schemas/RunParam', 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ADF6D849-*****-7E7030F0CE53'], ], 'example' => '', ], ], ], 'title' => 'UpdateRun', 'summary' => 'Updates the details of a run.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateRun'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiexperiment:UpdateRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', 'translator' => 'manual', ], 'UpdateWorkspace' => [ 'summary' => 'Updates the name and description of a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '14202', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The ID of the workspace. For more information, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request structure.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['title' => '', 'description' => 'The display name of the workspace. The name must meet the following requirements:'."\n" ."\n" .'- The name must be 3 to 23 characters in length and can contain letters, underscores (\\_), and digits.'."\n" ."\n" .'- The name must start with a letter.'."\n" ."\n" .'- The name must be unique within the current region.', 'type' => 'string', 'required' => false, 'example' => 'workspace-example'], 'Description' => ['title' => '', 'description' => 'The description of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'This is an example workspace.'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', 'title' => 'UpdateWorkspace', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], ], 'translator' => 'manual', ], 'UpdateWorkspaceResource' => [ 'summary' => 'Updates resources in a workspace.', 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ 'IsDefault' => ['description' => 'Specifies whether to set the resource as the default resource for the workspace. Currently, only `true` is a valid value.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], 'ProductType' => ['description' => '**This parameter is deprecated. Use `ResourceType` instead.**', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], 'GroupName' => ['description' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => 'group-kjds******sd', 'title' => ''], 'ResourceType' => ['description' => 'The resource type. Valid values are:'."\n" ."\n" .'- MaxCompute: MaxCompute resources.'."\n" ."\n" .'- ECS: General-purpose computing resources.'."\n" ."\n" .'- Lingjun: Lingjun intelligent computing resources.'."\n" ."\n" .'- ACS: ACS computing resources.'."\n" ."\n" .'- Flink: Flink resources.'."\n" ."\n" .'- SelfManagedAckPro: Resources for self-managed ACK Pro clusters.'."\n" ."\n" .'- SelfManagedAckLingjun: Resources for self-managed ACK Lingjun clusters.'."\n" ."\n" .'- SelfManagedASI: Resources for self-managed clusters on third-party clouds.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], 'Labels' => [ 'description' => 'An array of tags. The update affects only resources that have all of the specified tags.', 'type' => 'array', 'items' => [ 'description' => 'A tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'system.******', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'True', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'ResourceIds' => [ 'description' => 'An array of resource IDs.'."\n" ."\n" .'You cannot leave both `GroupName` and `ResourceIds` empty. If you specify both parameters, the group name must be the same for all specified resource IDs.', 'type' => 'array', 'items' => ['description' => 'A resource ID.', 'type' => 'string', 'required' => false, 'example' => 'Resource-dks******jkf', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Spec' => ['description' => 'The specifications of the resource.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "clusterType": "share"'."\n" .'}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941', 'title' => ''], 'ResourceIds' => [ 'description' => 'An array of IDs for the resources that were updated.', 'type' => 'array', 'items' => ['description' => 'The ID of an updated resource.', 'type' => 'string', 'example' => 'Resource-dks******jkf'."\n", 'title' => ''], 'example' => 'Resource-dks******jkf', 'title' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\\\n\\"\\n ]\\n}","type":"json"}]', 'title' => 'UpdateWorkspaceResource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspaceResource'], ], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UpdateWorkspaceRole' => [ 'path' => '/api/v1/workspaces/{WorkspaceId}/roles/{RoleId}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221937', 'abilityTreeNodes' => ['FEATURElearnZBMZHZ'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'path', 'schema' => ['description' => 'The workspace ID. Call the [ListWorkspaces](~~449124~~) operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => '83***', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'RoleName' => ['description' => 'The name of the custom role. The name must be unique within the workspace. It can be up to 64 characters long and can contain letters, digits, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'dev-test', 'title' => ''], 'ModulePermissions' => ['description' => 'The permission settings for the role.', '$ref' => '#/components/schemas/ModulePermissions', 'required' => false, 'title' => '', 'example' => ''], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RoleId', 'in' => 'path', 'schema' => ['description' => 'The role ID.', 'type' => 'string', 'required' => true, 'example' => 'role-dhg*******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A519F77D-28A0-52F5-AB82-5********8'."\n"], 'InstanceJobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'UpdateWorkspaceCustomRole-role-***abc*******', 'title' => ''], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'AIWorkSpace::2021-02-04::GetInstanceJob', 'callbackInterval' => 2000, 'maxCallbackTimes' => 10], 'title' => 'UpdateWorkspaceRole', 'summary' => 'Updates a role in a workspace.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A519F77D-28A0-52F5-AB82-5********8\\\\n\\",\\n \\"InstanceJobId\\": \\"UpdateWorkspaceCustomRole-role-***abc*******\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'ValidateConnection' => [ 'summary' => 'Validates a connection.', 'path' => '/api/v1/connections/validate', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATURElearnIUXWCQ'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Configs' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The configuration of the connection, specified as key-value pairs. The configuration keys vary by connection type. For more information, see the supplementary information about the request parameters.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', 'title' => ''], 'description' => 'The configuration of the connection, specified as key-value pairs. The configuration keys vary by connection type. For more information, see the supplementary information about the request parameters of the CreateConnection operation.', 'required' => false, 'title' => '', 'example' => '', ], 'ConnectionId' => ['description' => 'The connection ID. For more information about how to obtain the connection ID, see [ListConnections](url).', 'type' => 'string', 'required' => false, 'example' => 'conn-x2wz5zvvbyf2420fi9', 'title' => ''], 'ConnectionType' => ['description' => 'The connection type. Only connection types that support public network access are available. Valid values:'."\n" ."\n" .'- DashScopeConnection: a service connection for Alibaba Cloud Model Studio.'."\n" ."\n" .'- DeepSeekConnection: a service connection for DeepSeek.'."\n" ."\n" .'- FunctionAIMCPConnection: a connection for Function AI MCP.'."\n" ."\n" .'- CustomMCPConnection: a custom MCP connection.', 'type' => 'string', 'required' => false, 'example' => 'DashScopeConnection', 'title' => ''], 'Secrets' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The connection configuration to encrypt, such as database credentials or a model service key.', 'type' => 'string', 'example' => 'ZGJiZWQ2ZDY3MTMyYjJk****************NjE2NDg1NzM0YzlkZg==', 'title' => ''], 'description' => 'The key-value pairs to encrypt, such as a database logon password or a model connection key.', 'required' => false, 'title' => '', 'example' => '', ], 'ValidateType' => ['description' => 'The validation type. Set the value to:'."\n" ."\n" .'- Connectivity: a connectivity test', 'type' => 'string', 'required' => false, 'example' => 'Connectivity', 'title' => ''], 'WorkspaceId' => ['description' => 'The workspace ID. For more information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The validation status.'."\n" ."\n" .'- success: The validation is successful.'."\n" ."\n" .'- failed: The validation failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A14FA81-DD4E-******-6343FE44B941', 'title' => ''], 'Message' => ['description' => 'A description of the validation result.', 'type' => 'string', 'example' => 'The connection is reachable.', 'title' => ''], 'Code' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '403', 'title' => ''], 'Details' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'Details of the validation result. For example, \\`LatencyMs\\` indicates the test latency in milliseconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'description' => 'The details of the validation result.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ValidateConnection', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'learn', 'title' => '机器学习'], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'paiworkspace:ValidateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"success\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Message\\": \\"The connection is reachable.\\",\\n \\"Code\\": \\"403\\",\\n \\"Details\\": {\\n \\"key\\": \\"100\\"\\n }\\n}","type":"json"}]', 'translator' => 'manual', ], ], 'endpoints' => [ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-beijing.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-beijing.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-shanghai.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shanghai.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-hongkong.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-hongkong.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-heyuan.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-heyuan.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-heyuan.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-shenzhen.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shenzhen.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.ap-northeast-1.aliyuncs.com ', 'endpoint' => 'aiworkspace.ap-northeast-1.aliyuncs.com ', 'vpc' => 'aiworkspace-vpc.ap-northeast-1.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', 'endpoint' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', 'vpc' => 'aiworkspace-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.ap-southeast-1.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.ap-southeast-3.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-3.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-3.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.ap-southeast-5.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-southeast-5.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-southeast-5.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiworkspace.cn-hangzhou.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-hangzhou.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiworkspace.us-east-1.aliyuncs.com', 'endpoint' => 'aiworkspace.us-east-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.us-east-1.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiworkspace.us-west-1.aliyuncs.com', 'endpoint' => 'aiworkspace.us-west-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.us-west-1.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiworkspace.eu-central-1.aliyuncs.com', 'endpoint' => 'aiworkspace.eu-central-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.eu-central-1.aliyuncs.com'], ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'aiworkspace.ap-south-1.aliyuncs.com', 'endpoint' => 'aiworkspace.ap-south-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.ap-south-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'aiworkspace-vpc.cn-shanghai-finance-1.aliyuncs.com'], ], 'errorCodes' => [ ['code' => '100400027', 'message' => 'Workspace not exists.', 'http_code' => 404, 'description' => ''], ['code' => '100600006', 'message' => 'Workspace member not found error.', 'http_code' => 404, 'description' => 'Workspace member does not exist'], ['code' => '100700008', 'message' => 'No permission.', 'http_code' => 404, 'description' => 'No permission'], ], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResources'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConfig'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImageLabels'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFeatures'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnection'], ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJob'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageLabels'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetExperiment'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserConfigs'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnections'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCodeSources'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCodeSource'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRuns'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetJobConfig'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperiment'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataset'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultWorkspace'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataset'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMembers'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJob'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModel'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConnection'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptDataworksEvent'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateExperiment'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'LogRunMetrics'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMemberRole'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetJobConfig'], ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJob'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDefaultWorkspace'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataset'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersion'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCodeSource'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetFileMetas'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProductOrders'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigs'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMeta'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRunLabel'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigs'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListQuotas'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJobConfig'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMemberRole'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserConfig'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModelVersion'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersion'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspaceResource'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersionLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetFileMetas'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetVersions'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspaceResource'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaceUsers'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCodeSource'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetFileMetas'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModel'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModel'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPermissions'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'GetRun'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersionLabels'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'SetExperimentLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermission'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfig'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateRun'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelVersionLabels'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspaceResource'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImage'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetFileMetasStatistics'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddImage'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobConfigs'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserConfigs'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetVersion'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteExperimentLabel'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDatasetJobConfig'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetImage'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetVersion'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModelVersions'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModelVersionLabels'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModels'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCodeSource'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDatasetVersion'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDataset'], ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetJob'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataset'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasets'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImages'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModelLabels'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'DeleteRun'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfig'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishImage'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'CreateRun'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListRunMetrics'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishCodeSource'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveImageLabels'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'ListExperiment'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDatasetFileMetas'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatasetVersion'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModelVersion'], ['threshold' => '50', 'countWindow' => 3, 'regionId' => '*', 'api' => 'UpdateExperiment'], ['threshold' => '15', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDatasetJob'], ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDatasetJobs'], ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModel'], ], 'product' => ['code' => 'learn', 'title' => 'AIWorkSpace'], ], 'ram' => [ 'productCode' => 'PAIWorkspace', 'productName' => 'Platform for AI', 'ramCodes' => ['paiworkspace', 'pai', 'paiimage', 'paicodesource', 'paidataset', 'paimodel', 'paiexperiment', 'paiservicetemplate', 'paiconnection'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'CreateWorkspaceRole', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:AddWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListResources', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], [ 'apiName' => 'ListWorkspaces', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaces', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddMemberRole', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:AddMemberRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDefaultWorkspace', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:UpdateDefaultWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetMember', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListWorkspaceUsers', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaceUsers', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], [ 'apiName' => 'GetInstanceJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetInstanceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ValidateConnection', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'paiworkspace:ValidateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListConnections', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListConnections', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMembers', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPermissions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateWorkspaceResource', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateConnection', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteWorkspace', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], [ 'apiName' => 'DeleteWorkspaceResource', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:DeleteWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMembers', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:DeleteMembers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteWorkspaceRoles', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:RemoveWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListWorkspaceRoles', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListWorkspaceRoles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateWorkspaceRole', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListConfigs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiworkspace:ListConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteConnection', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiworkspace:DeleteConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateWorkspaceResource', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateWorkspaceResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetWorkspaceRole', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetWorkspaceRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveMemberRole', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:RemoveMemberRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetConnection', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetWorkspace', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], [ 'apiName' => 'GetDefaultWorkspace', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiworkspace:GetDefaultWorkspace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateWorkspace', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ], ], ], [ 'apiName' => 'CreateWorkspace', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiworkspace:CreateWorkspace', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateConnection', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConnection', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateConfigs', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiworkspace:UpdateConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateMember', 'description' => '', 'operationType' => '', 'ramAction' => [ 'action' => 'paiworkspace:CreateMember', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPermission', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'pai:AdministratePAI', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProducts', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListProducts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListUserConfigs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListUserConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFeatures', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListFeatures', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SetUserConfigs', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'pai:SetUserConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteUserConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'pai:DeleteUserConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListQuotas', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'pai:ListQuotas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateProductOrders', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'pai:CreateOrder', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetImage', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiimage:GetImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddImageLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:AddImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddImage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:AddImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PublishImage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiimage:PublishImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateImageBuild', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiimage:CreateImageBuild', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListImageLabels', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiimage:ListImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveImage', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiimage:RemoveImage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListImages', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiimage:ListImages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveImageLabels', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiimage:RemoveImageLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCodeSource', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paicodesource:CreateCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCodeSource', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paicodesource:DeleteCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateCodeSource', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paicodesource:UpdateCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PublishCodeSource', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paicodesource:PublishCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCodeSource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paicodesource:GetCodeSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCodeSources', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paicodesource:ListCodeSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetVersion', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDataset', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetFileMeta', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetFileMeta', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasetJobs', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:ListDatasetJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasetFileMetas', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetFileMetas', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetFileMetasStatistics', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetFileMetasStatistics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetLabels', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasetJobConfigs', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:ListDatasetJobConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDataset', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetJobConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetFileMetas', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasetVersions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasetVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetVersion', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetVersionLabels', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDatasetVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasets', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paidataset:ListDatasets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDatasetVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PublishDataset', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:PublishDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDatasetJobConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetVersion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDatasetFileMetas', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paidataset:UpdateDatasetFileMetas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetVersionLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetJobConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDataset', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'StopDatasetJob', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'paidataset:StopDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDataset', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paidataset:DeleteDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDatasetJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paidataset:CreateDatasetJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetJobConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paidataset:GetDatasetJobConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetModel', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paimodel:GetModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteModelVersionLabels', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteModelVersion', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetModelVersion', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paimodel:GetModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListModels', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paimodel:ListModels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateModel', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateModelVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paimodel:UpdateModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateModel', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paimodel:UpdateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListModelVersions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paimodel:ListModelVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteModelLabels', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModelLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateModelLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateModelVersionLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelVersionLabels', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteModel', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paimodel:DeleteModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateModelVersion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paimodel:CreateModelVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListRunMetrics', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:ListRunMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateExperiment', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiexperiment:UpdateExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetRun', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:GetRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetExperiment', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'paiexperiment:GetExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListRuns', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'paiexperiment:ListRuns', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteExperiment', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListExperiment', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'paiexperiment:ListExperiments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteRunLabel', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteRunLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteRun', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateExperiment', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:CreateExperiment', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SetExperimentLabels', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:SetExperimentLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateRun', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'paiexperiment:UpdateRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteExperimentLabel', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'paiexperiment:DeleteExperimentLabel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateRun', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'paiexperiment:CreateRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'PAIWorkspace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:paiworkspace:{#Region}:{#AccountId}:workspace/{#WorkspaceId}'], ['validationType' => 'always', 'resourceType' => 'Connection', 'arn' => 'acs:paiworkspace:{#regionId}:{#accountId}:connection/*'], ], ], ];