diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/aiworkspace/2021-02-04/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/aiworkspace/2021-02-04/api-docs.php')
| -rw-r--r-- | data/en_us/aiworkspace/2021-02-04/api-docs.php | 20586 |
1 files changed, 20586 insertions, 0 deletions
diff --git a/data/en_us/aiworkspace/2021-02-04/api-docs.php b/data/en_us/aiworkspace/2021-02-04/api-docs.php new file mode 100644 index 0000000..3652518 --- /dev/null +++ b/data/en_us/aiworkspace/2021-02-04/api-docs.php @@ -0,0 +1,20586 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'AIWorkSpace', + 'version' => '2021-02-04', + ], + 'directories' => [ + [ + 'id' => 385742, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateExperiment', + 'UpdateExperiment', + 'GetExperiment', + 'ListExperiment', + 'DeleteExperiment', + 'SetExperimentLabels', + 'DeleteExperimentLabel', + 'CreateRun', + 'UpdateRun', + 'GetRun', + 'ListRuns', + 'DeleteRun', + 'DeleteRunLabel', + 'LogRunMetrics', + 'ListRunMetrics', + ], + ], + [ + 'id' => 385758, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddImage', + 'AddImageLabels', + 'GetImage', + 'ListImageLabels', + 'ListImages', + 'RemoveImage', + 'PublishImage', + 'RemoveImageLabels', + 'CreateImageBuild', + ], + ], + [ + 'id' => 385768, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 385769, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListPermissions', + 'GetPermission', + ], + ], + [ + 'id' => 385772, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeleteWorkspaceResource', + 'UpdateWorkspaceResource', + 'ListResources', + 'CreateWorkspaceResource', + ], + ], + [ + 'id' => 385777, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddMemberRole', + 'RemoveMemberRole', + 'DeleteMembers', + 'GetMember', + 'ListMembers', + 'CreateMember', + ], + ], + [ + 'id' => 385784, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UpdateConfigs', + 'GetConfig', + 'ListConfigs', + 'DeleteConfig', + 'UpdateConfig', + ], + ], + [ + 'id' => 385790, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListWorkspaces', + 'CreateWorkspace', + 'GetWorkspace', + 'DeleteWorkspace', + 'UpdateWorkspace', + ], + ], + 'GetDefaultWorkspace', + 'UpdateDefaultWorkspace', + 'ListWorkspaceUsers', + 'ListQuotas', + ], + ], + [ + 'id' => 385800, + 'title' => null, + 'type' => 'directory', + 'children' => [ + [ + 'id' => 385801, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDatasetFileMetasStatistics', + 'StopDatasetJob', + 'GetDatasetJob', + 'CreateDatasetFileMetas', + 'UpdateDatasetJob', + 'ListDatasetJobs', + 'DeleteDatasetJobConfig', + 'DeleteDatasetJob', + 'UpdateDatasetJobConfig', + 'UpdateDatasetFileMetas', + 'ListDatasetJobConfigs', + 'ListDatasetFileMetas', + 'GetDatasetJobConfig', + 'GetDatasetFileMeta', + 'DeleteDatasetFileMetas', + 'CreateDatasetJobConfig', + 'CreateDatasetJob', + ], + ], + 'CreateDataset', + 'GetDataset', + 'UpdateDataset', + 'PublishDataset', + 'ListDatasets', + 'DeleteDataset', + 'CreateDatasetLabels', + 'DeleteDatasetLabels', + 'CreateDatasetVersion', + 'GetDatasetVersion', + 'ListDatasetVersions', + 'UpdateDatasetVersion', + 'DeleteDatasetVersion', + 'DeleteDatasetVersionLabels', + 'DeleteDatasetVersionLabels', + 'CreateDatasetVersionLabels', + ], + ], + [ + 'id' => 385834, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateConnection', + 'GetConnection', + 'UpdateConnection', + 'ListConnections', + 'DeleteConnection', + 'ValidateConnection', + ], + ], + [ + 'id' => 385841, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateCodeSource', + 'DeleteCodeSource', + 'PublishCodeSource', + 'UpdateCodeSource', + 'GetCodeSource', + 'ListCodeSources', + ], + ], + [ + 'id' => 385848, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateModel', + 'UpdateModel', + 'GetModel', + 'ListModels', + 'DeleteModel', + 'CreateModelVersion', + 'UpdateModelVersion', + 'GetModelVersion', + 'ListModelVersions', + 'DeleteModelVersion', + 'CreateModelLabels', + 'DeleteModelLabels', + 'CreateModelVersionLabels', + 'DeleteModelVersionLabels', + ], + ], + [ + 'id' => 385863, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SetUserConfigs', + 'DeleteUserConfig', + 'ListUserConfigs', + ], + ], + [ + 'id' => 385867, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListProducts', + 'CreateProductOrders', + 'AcceptDataworksEvent', + 'ChangeResourceGroup', + 'ListFeatures', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'CodeSourceItem' => [ + 'title' => '', + 'description' => 'The code source struct.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => [ + 'title' => '', + 'description' => 'The code source ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'code-202**********', + 'backendName' => 'CodeSourceId', + ], + 'DisplayName' => [ + 'title' => '', + 'description' => 'The code source name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MyCodeSourceName1', + 'backendName' => 'DisplayName', + ], + 'Description' => [ + 'title' => '', + 'description' => 'The code source description.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'code source of dlc examples', + 'backendName' => 'Description', + ], + 'CodeRepo' => [ + 'title' => '', + 'description' => 'The address of the code repository.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://code.aliyun.com/****', + 'backendName' => 'CodeRepo', + ], + 'CodeBranch' => [ + 'title' => '', + 'description' => 'The code branch.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'master', + 'backendName' => 'CodeBranch', + ], + 'CodeCommit' => [ + 'title' => '', + 'description' => 'The code commit ID'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '44da10**********', + 'backendName' => 'CodeCommit', + ], + 'CodeRepoUserName' => [ + 'title' => '', + 'description' => 'The username of the code repository.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'user', + 'backendName' => 'CodeRepoUserName', + ], + 'CodeRepoAccessToken' => [ + 'title' => '', + 'description' => 'The token used to access the code repository.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'CodeRepoAccessToken', + ], + 'Accessibility' => [ + 'title' => '', + 'description' => 'The visibility of the code source. Valid values:'."\n" + ."\n" + .'* PRIVATE: Visible only to you and the administrator in the workspace.'."\n" + .'* PUBLIC: Visible to all users in the workspace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PUBLIC', + 'backendName' => 'Accessibility', + ], + 'UserId' => [ + 'title' => '', + 'description' => 'The ID of the creator.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1157290171663117', + 'backendName' => 'UserId', + ], + 'WorkspaceId' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1234', + 'backendName' => 'WorkspaceId', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-18T12:52:15Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifyTime' => [ + 'title' => '', + 'description' => 'The last modified time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-18T12:52:15Z', + 'backendName' => 'GmtModifyTime', + ], + 'MountPath' => [ + 'title' => '', + 'description' => 'The local mount path of the code.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '/root/code/', + 'backendName' => 'MountPath', + ], + ], + ], + 'Collection' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'CollectionName' => [ + 'title' => '', + 'description' => 'The name of the collection. The name must be globally unique.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'AI4D', + 'backendName' => 'CollectionName', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => '', + 'description' => 'The last update time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtModifiedTime', + ], + 'UserId' => [ + 'title' => '', + 'description' => 'The ID of the user that created the collection.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '155770209******', + 'backendName' => 'UserId', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '155770209******', + 'backendName' => 'OwnerId', + ], + ], + ], + 'Connection' => [ + 'title' => 'connection', + 'description' => 'The connection information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ConnectionType' => [ + 'title' => 'connection Type', + 'description' => 'The connection type. Valid values:'."\n" + ."\n" + .'* DashScopeConnection'."\n" + .'* OpenLLMConnection'."\n" + .'* MilvusConnection'."\n" + .'* OpenSearchConnection'."\n" + .'* LindormConnection'."\n" + .'* ElasticsearchConnection'."\n" + .'* HologresConnection'."\n" + .'* RDSConnection'."\n" + .'* CustomConnection'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ElasticsearchConnection', + 'backendName' => 'connectionType', + ], + 'Description' => [ + 'title' => 'description', + 'description' => 'The connection description.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + 'Accessibility' => [ + 'title' => 'accessibility', + 'description' => 'The workspace accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: accessible to all members in the workspace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PRIVATE', + 'backendName' => 'accessibility', + ], + 'Secrets' => [ + 'title' => 'secrets', + 'description' => 'The key-value configuration to be encrypted, such as the database logon password and the key for model connection.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The value for the encrypted connection configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Dsjk***hsl01'."\n", + ], + 'backendName' => 'secrets', + ], + 'WorkspaceId' => [ + 'title' => 'workspace Id', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '228**', + 'backendName' => 'workspaceId', + ], + 'Creator' => [ + 'title' => 'creator', + 'description' => 'The connection creator.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '20925961****557803', + 'backendName' => 'creator', + ], + 'ResourceMeta' => [ + 'title' => 'resource meta', + 'description' => 'The connection resource. This parameter is used for the connection configuration of the database type.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => 'instance name', + 'description' => 'The instance name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'instanceName', + ], + 'InstanceId' => [ + 'title' => 'instanceId', + 'description' => 'The instance ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ld-2vc1***v1zaqgzol', + 'backendName' => 'instanceId', + ], + ], + 'backendName' => 'resourceMeta', + ], + 'GmtModifiedTime' => [ + 'title' => 'gmtModifiedTime', + 'description' => 'The time when the connection was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-03-07T07:54:56Z'."\n", + 'backendName' => 'gmtModifiedTime', + ], + 'ConnectionName' => [ + 'title' => 'connection name', + 'description' => 'The connection name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'connectionName', + ], + 'ConnectionId' => [ + 'title' => 'connection Id', + 'description' => 'The connection ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'conn-pai9m***mi47', + 'backendName' => 'connectionId', + ], + 'Configs' => [ + 'title' => 'configs', + 'description' => 'The connection configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The value for the connection configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '12345', + ], + 'backendName' => 'configs', + ], + 'Models' => [ + 'title' => 'model', + 'description' => 'The models.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The model.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'title' => 'model', + 'description' => 'The model identifier.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'model_001', + 'backendName' => 'model', + ], + 'DisplayName' => [ + 'title' => 'display name', + 'description' => 'The display name of the model.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'displayName', + ], + 'ModelType' => [ + 'title' => 'model type', + 'description' => 'The model type. Valid values:'."\n" + ."\n" + .'* LLM'."\n" + .'* Embedding'."\n" + .'* ReRank'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'LLM', + 'backendName' => 'modelType', + ], + 'ToolCall' => [ + 'title' => 'tool call', + 'description' => 'Indicates whether tool calling was supported. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'toolCall', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'models', + 'itemName' => 'model', + ], + 'GmtCreateTime' => [ + 'title' => 'gmtCreateTime', + 'description' => 'The time when the connection was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-03-07T07:54:56Z'."\n", + 'backendName' => 'gmtCreateTime', + ], + ], + ], + 'Dataset' => [ + 'title' => 'A short description of struct', + 'description' => 'The dataset property.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => 'Dataset Id', + 'description' => 'The dataset ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'd-c0h44g3****j8o4348', + 'backendName' => 'DatasetId', + ], + 'UserId' => [ + 'title' => 'User Id', + 'description' => 'The user ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2485765****023475', + 'backendName' => 'UserId', + ], + 'OwnerId' => [ + 'title' => 'Owner Id', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1631044****3440', + 'backendName' => 'OwnerId', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'The dataset name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'myName', + 'backendName' => 'Name', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'The labels.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'visibility' => 'public', + 'example' => '{"Key": "env", "Value": "test"}', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + 'DataSourceType' => [ + 'title' => 'DataSourceType', + 'description' => 'The data source type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NAS'."\n" + .'* OSS'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAS' => 'NAS', + 'OSS' => 'OSS', + ], + 'example' => 'NAS', + 'backendName' => 'DataSourceType', + ], + 'Uri' => [ + 'title' => 'Uri', + 'description' => 'URI examples:'."\n" + ."\n" + .'* Object Storage Service (OSS) data source: `oss://bucket.endpoint/object`'."\n" + .'* File Storage NAS (NAS) data source: `nas://<nasfisid>.region/subpath/to/dir/`'."\n" + .'* Cloud Parallel File Storage (CPFS) 1.0 data source: `nas://<cpfs-fsid>.region/subpath/to/dir/`'."\n" + .'* CPFS 2.0 data source: `nas://<cpfs-fsid>.region/<protocolserviceid>/`'."\n" + ."\n" + .'> You can distinguish CPFS 1.0 and CPFS 2.0 file systems based on the format of the file system ID: The ID of the CPFS 1.0 file system is in the cpfs-<8-bit ASCII characters> format. The ID of the CPFS 2.0 file system is in the cpfs-<16-bit ASCII characters> format.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'nas://09f****f2.cn-hangzhou/', + 'backendName' => 'Uri', + ], + 'GmtCreateTime' => [ + 'title' => 'GmtCreateTime', + 'description' => 'The time when the dataset was created.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => 'GmtModifiedTime', + 'description' => 'The time when the dataset was modified.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + 'backendName' => 'GmtModifiedTime', + ], + 'DataType' => [ + 'title' => 'DataType', + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* COMMON (default)'."\n" + .'* PIC'."\n" + .'* TEXT'."\n" + .'* Video'."\n" + .'* AUDIO'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'VIDEO' => 'VIDEO', + 'COMMON' => 'COMMON', + 'TEXT' => 'TEXT', + 'PIC' => 'PIC', + 'AUDIO' => 'AUDIO', + ], + 'example' => 'COMMON', + 'backendName' => 'DataType', + ], + 'Property' => [ + 'title' => 'Property', + 'description' => 'The dataset property. Valid values:'."\n" + ."\n" + .'* FILE'."\n" + .'* DIRECTORY'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'DIRECTORY', + 'backendName' => 'Property', + ], + 'SourceType' => [ + 'title' => 'SourceType', + 'description' => 'The source type.'."\n" + .'Valid values:'."\n" + ."\n" + .'* PAI_PUBLIC_DATASET'."\n" + .'* ITAG'."\n" + .'* USER', + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => '', + 'ITAG' => '', + 'USER' => '', + ], + 'example' => 'USER', + 'backendName' => 'SourceType', + ], + 'SourceId' => [ + 'title' => 'SourceId', + 'description' => 'The source ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'jdnhf***fnrimv', + 'backendName' => 'SourceId', + ], + 'Description' => [ + 'title' => 'Description', + 'description' => 'The dataset description.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Description', + ], + 'WorkspaceId' => [ + 'title' => 'WorkspaceId', + 'description' => 'The ID of the workspace to which the dataset belongs.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '478**', + 'backendName' => 'WorkspaceId', + ], + 'Options' => [ + 'title' => 'Options', + 'description' => 'The extended field that can be used as an option. The value is a JSON string. When you use the dataset in Deep Learning Containers (DLC), you can use the mountPath field to specify the default mount path of the dataset.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + 'backendName' => 'Options', + ], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => 'The workspace accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): The dataset is accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The dataset is accessible to all members in the workspace.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + 'backendName' => 'Accessibility', + ], + 'ProviderType' => [ + 'title' => 'ProviderType', + 'description' => 'The provider type of the dataset. Valid values:'."\n" + ."\n" + .'* Ecs (default)'."\n" + .'* Lingjun'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Ecs', + 'backendName' => 'ProviderType', + ], + 'SourceDatasetId' => [ + 'title' => 'SourceDatasetId', + 'description' => 'The ID of the source dataset for the labeled dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'd-bvfasdfxxxxj8o411', + 'backendName' => 'SourceDatasetId', + ], + 'SourceDatasetVersion' => [ + 'title' => 'SourceDatasetVersion', + 'description' => 'The version of the source dataset for the labeled dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'v2', + 'backendName' => 'SourceDatasetVersion', + ], + 'TagTemplateType' => [ + 'title' => 'TagTemplateType', + 'description' => 'The labeling template of the iTAG labeled dataset.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'text-classification', + 'backendName' => 'TagTemplateType', + ], + 'LatestVersion' => [ + 'title' => 'LatestVersion', + 'description' => 'The latest dataset version.'."\n", + 'visibility' => 'Public', + 'backendName' => 'LatestVersion', + '$ref' => '#/components/schemas/DatasetVersion', + ], + 'MountAccess' => [ + 'title' => 'MountAccess', + 'description' => 'MountAccess'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'RO RW', + 'backendName' => 'MountAccess', + ], + 'MountAccessReadWriteRoleIdList' => [ + 'title' => 'MountAccessReadWriteRoleIdList', + 'description' => 'The IDs of the roles that have read and write permissions on the dataset in the workspace. The IDs starting with PAI is the IDs of the basic roles, and the IDs starting with role- is the IDs of the custom roles. If the list contains "\\*", all roles have read and write permissions.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the workspace role.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PAI.AlgoOperator', + 'extendType' => 'true', + ], + 'backendName' => 'MountAccessReadWriteRoleIdList', + 'itemName' => 'MountAccessReadWriteRoleIdList', + ], + 'ImportInfo' => [ + 'title' => 'ImportInfo', + 'description' => 'The dataset import information, such as OSS, NAS, and CPFS.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'{ "region": "${region}",//The region ID. "bucket": "${bucket}",//The bucket name. "path": "${path}" //The file path. }'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'**CPFS**'."\n" + ."\n" + .'**CPFS for Lingjun**'."\n", + 'visibility' => 'Public', + '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" + .'}', + 'backendName' => 'ImportInfo', + ], + ], + ], + 'DatasetFileMeta' => [ + 'title' => 'A short description of struct', + 'description' => 'The metadata details of the dataset file.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DatasetFileMetaId' => [ + 'title' => 'Dataset FileMeta Id', + 'description' => 'The metadata ID of the dataset file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6', + 'backendName' => 'DatasetFileMetaId', + ], + 'Uri' => [ + 'title' => 'Uri', + 'description' => 'The URI of the file. Used to record the unique path of the file. File paths in Object Storage Service (OSS) and File Storage NAS (NAS) are supported.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'oss://${bucket}/${path}'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'nas://${fileSystemId}/${path}'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://test-bucket/dataset/cat.png', + 'backendName' => 'Uri', + ], + 'FileName' => [ + 'title' => 'File Name', + 'description' => 'The file name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cat.png', + 'backendName' => 'FileName', + ], + 'DownloadUrl' => [ + 'title' => 'Download Url', + 'description' => 'The download URL of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=1712801702&OSSAccessKeyId=****************&Signature=x4oSjZcXOn7FHMCT1D****NuNjs%3D', + 'backendName' => 'DownloadUrl', + ], + 'Score' => [ + 'title' => 'Score', + 'description' => 'The similarity score.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6', + 'backendName' => 'Score', + ], + 'DataSize' => [ + 'title' => 'Size', + 'description' => 'The file size. Unit: bytes.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120000', + 'backendName' => 'DataSize', + ], + 'FileFingerPrint' => [ + 'title' => 'FileFingerPrint', + 'description' => 'The file fingerprint, used to determine the uniqueness of the file content. This value changes after the file content is modified. OSS files use ETags, and NAS files use MD5 values.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", + 'backendName' => 'FileFingerPrint', + ], + 'FileUpdateTime' => [ + 'title' => '', + 'description' => 'The last modified time of the file. A UTC timestamp in the ISO 8601 format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2025-01-12T14:36:01Z', + 'backendName' => 'FileUpdateTime', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags of the metadata, in JSON string format. Including:'."\n" + ."\n" + .'* Algorithm tag group:'."\n" + ."\n" + .' * ai: tags from all algorithm tagging tasks on this metadata.'."\n" + ."\n" + .'* User-defined tag group:'."\n" + ."\n" + .' * user: tags added by the user to this metadata.'."\n" + .' * user-delete-ai-tags: tags from the algorithm tag group that the user needs to delete.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "ai":'."\n" + .' ['."\n" + .' "Felis catus",'."\n" + .' "Shorthair"'."\n" + .' ],'."\n" + .' "user":'."\n" + .' ['."\n" + .' "cat",'."\n" + .' "White"'."\n" + .' ]'."\n" + .'}', + 'backendName' => 'Tags', + ], + 'ThumbnailUrl' => [ + 'title' => 'Thumbnail Url', + 'description' => 'The URL of the thumbnail.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'https://test-bucket.oss-cn-shanghai.aliyuncs.com/dataset/cat.png?Expires=171280****&OSSAccessKeyId=LTAI************&Signature=****jZcXOn7FHMCT1DLE22NuNjs%3D', + 'backendName' => 'ThumbnailUrl', + ], + 'MetaAttributes' => [ + 'title' => '', + 'description' => 'The specific metadata of the file. For example, the width and height of an image file, or the bitrate and resolution of a video file. This parameter cannot be used for retrieval. In JSON String format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{ "ImageHeight": 400, "ImageWidth": 800 }', + 'backendName' => 'MetaAttributes', + ], + 'SyncTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'SyncTime', + 'parseType' => 'java.util.Date', + ], + 'TagUpdateTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'TagUpdateTime', + 'parseType' => 'java.util.Date', + ], + 'SemanticIndexJobId' => [ + 'title' => '', + 'description' => 'The ID of the last semantic indexing job.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsjob-klfwtjto****scvt3', + 'backendName' => 'SemanticIndexJobId', + ], + 'SemanticIndexUpdateTime' => [ + 'title' => '', + 'description' => 'The last update time of the semantic index. A UTC timestamp in the ISO 8601 format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'SemanticIndexUpdateTime', + ], + 'FileCreateTime' => [ + 'title' => '', + 'description' => 'The time when the file was created. A UTC timestamp in the ISO 8601 format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'FileCreateTime', + ], + 'FileType' => [ + 'title' => '', + 'description' => 'The file type.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'image' => 'image', + 'application' => 'application', + 'video' => 'video', + 'audio' => 'audio', + 'text' => 'text', + ], + 'example' => 'image', + 'backendName' => 'FileType', + ], + 'ContentType' => [ + 'title' => '', + 'description' => 'The MIME Type of the file.'."\n", + 'visibility' => 'Public', + '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', + 'backendName' => 'ContentType', + ], + ], + ], + 'DatasetFileMetaConentUpdate' => [ + 'title' => 'A short description of struct', + 'description' => 'The details of the file metadata to be updated.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '', + 'description' => 'The file name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '00001.jpeg'."\n", + 'backendName' => 'FileName', + ], + 'Comment' => [ + 'title' => '', + 'description' => 'The file comment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Comment', + ], + 'FileCreateTime' => [ + 'title' => '', + 'description' => 'The time when the file is created. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2025-01-12T14:36:01Z'."\n", + 'backendName' => 'FileCreateTime', + ], + 'FileUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the file is last modified. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2025-01-12T14:36:01Z'."\n", + 'backendName' => 'FileUpdateTime', + ], + 'DataSize' => [ + 'title' => '', + 'description' => 'The file size. Unit: byte.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + 'backendName' => 'DataSize', + ], + 'FileType' => [ + 'title' => '', + 'description' => 'The file type, which is the same as Multipurpose Internet Mail Extensions (MIME) type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image'."\n" + .'* application'."\n" + .'* audio'."\n" + .'* video'."\n" + .'* text'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => '', + 'application' => '', + 'audio' => '', + 'video' => '', + 'text' => '', + ], + 'example' => 'image', + 'backendName' => 'FileType', + ], + 'ContentType' => [ + 'title' => 'image/jpeg', + 'description' => 'The MIME type of the file. The value consists of a type and a subtype.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image/png'."\n" + .'* image/svg+xml'."\n" + .'* image/jpeg'."\n" + .'* image/tiff'."\n" + .'* image/gif'."\n" + .'* image/bmp'."\n" + .'* image/x-icon'."\n" + .'* image/heic'."\n" + .'* image/webp'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + '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', + ], + 'example' => 'image/jpeg'."\n", + 'backendName' => 'ContentType', + ], + 'MetaAttributes' => [ + 'title' => '', + 'description' => 'The specific metadata of the file, such as the width and height of an image and the bitrate and resolution of a video file. You cannot retrieve the metadata. The value is a JSON string.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "Image":'."\n" + .' {'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "Channel": 3'."\n" + .' }'."\n" + .'}', + 'backendName' => 'MetaAttributes', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags to be updated.'."\n" + ."\n" + .'* Update an algorithm tag group (a valid TagJobId must be set):'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "ai":["Lane line", "Water horse", "Sunny day"]'."\n" + .' }'."\n" + ."\n" + .'* Update a user-defined tag group (add or remove indicates that tags are added or deleted): Tag groups that can be updated:'."\n" + ."\n" + .' * user: a list of user-defined tags that can be added to or deleted from a single piece of metadata.'."\n" + .' * user-delete-ai-tags: a list of tags that you want to delete from an algorithm tag group.'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "user":{'."\n" + .' "add":["Lane line","Sunny day"],'."\n" + .' "remove":["Water horse"] },'."\n" + .' "user-delete-ai-tags":{'."\n" + .' "add": ["Ground shadow"],'."\n" + .' "remove": []'."\n" + .' }'."\n" + .' }'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{"ai":["cat"], "user":["black"]}', + 'backendName' => 'Tags', + ], + 'DatasetFileMetaId' => [ + 'title' => 'uuid', + 'description' => 'The metadata ID of the dataset file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", + 'backendName' => 'DatasetFileMetaId', + ], + 'SemanticIndexJobId' => [ + 'title' => '', + 'description' => 'The ID of the semantic index-based job.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsjob-klfwt*****l0escvt3', + 'backendName' => 'SemanticIndexJobId', + ], + 'SemanticIndexUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the semantic index is created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'SemanticIndexUpdateTime', + ], + 'FileFingerPrint' => [ + 'title' => '', + 'description' => 'The fingerprint information of the file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '124FB71******7BE45608CDEA4DE54B3', + 'backendName' => 'FileFingerPrint', + ], + ], + ], + 'DatasetFileMetaContentCreate' => [ + 'title' => 'A short description of struct', + 'description' => 'The file metadata details.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '', + 'description' => 'The file name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '00001.jpeg', + 'backendName' => 'FileName', + ], + 'Uri' => [ + 'title' => 'oss/nas/cpfs uri', + 'description' => 'The URI of the file. Used to record the unique path of the file. File paths in Object Storage Service (OSS) and File Storage NAS (NAS) are supported.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'oss://${bucket}/${path}'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'nas://${fileSystemId}/${path}'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" + .'nas://0e25d***dff/dataset/1653421.jpg', + 'backendName' => 'Uri', + ], + 'Comment' => [ + 'title' => '', + 'description' => 'The file comment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Comment', + ], + 'FileCreateTime' => [ + 'title' => '', + 'description' => 'The time when the file was created. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2025-01-12T14:36:01Z', + 'backendName' => 'FileCreateTime', + ], + 'FileUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the file was last modified. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'required' => true, + 'example' => '2025-01-12T14:36:01Z', + 'backendName' => 'FileUpdateTime', + ], + 'FileFingerPrint' => [ + 'title' => 'md5/oss etag', + 'description' => 'The file fingerprint. Used to check the uniqueness of the file. This value changes after the file content is modified. OSS files use ETags, and NAS files use MD5 values.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'D41D8CD98F*****E9800998ECF8', + 'backendName' => 'FileFingerPrint', + ], + 'DataSize' => [ + 'title' => '', + 'description' => 'The file size. Unit: bytes.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + 'backendName' => 'DataSize', + ], + 'FileType' => [ + 'title' => '', + 'description' => 'The file type. The same as MIME type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image'."\n" + .'* application'."\n" + .'* audio'."\n" + .'* video'."\n" + .'* text'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'image' => '', + 'application' => '', + 'audio' => '', + 'video' => '', + 'text' => '', + ], + 'example' => 'image', + 'backendName' => 'FileType', + ], + 'ContentType' => [ + 'title' => 'image/jpeg', + 'description' => 'The MIME type of the file. It contains Type and SubType.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* image/png: PNG.'."\n" + .'* image/jpeg: JPEG.'."\n" + .'* image/tiff: TIFF.'."\n" + .'* image/bmp: BMP.'."\n" + .'* image/gif: GIF.'."\n" + .'* image/x-icon: ICON.'."\n" + .'* image/svg+xml: SVG.'."\n" + .'* image/webp: WEBP.'."\n" + .'* image/heic: HEIC'."\n", + 'visibility' => 'Public', + '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', + 'backendName' => 'ContentType', + ], + 'MetaAttributes' => [ + 'title' => '', + 'description' => 'The specific metadata of the file. You cannot retrieve the metadata. The value is a JSON string.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "Image":'."\n" + .' {'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "Channel": 3'."\n" + .' }'."\n" + .'}', + 'backendName' => 'MetaAttributes', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags manually added. The value is a JSON string. Operable tag group:'."\n" + ."\n" + .'* user: the list of tags to add to a metadata entry.'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "user":{'."\n" + .' "add":["lane line","sunny"]'."\n" + .' }'."\n" + .' }'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'deprecated' => false, + 'example' => '{"user":["cat", "White"]}', + 'backendName' => 'Tags', + ], + 'SyncTime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Private', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'SyncTime', + 'parseType' => 'java.util.Date', + ], + ], + ], + 'DatasetFileMetaContentGet' => [ + 'title' => 'A short description of struct', + 'description' => 'The obtained metadata details.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'title' => '', + 'description' => 'The file name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '00001.jpeg', + 'backendName' => 'FileName', + ], + 'Uri' => [ + 'title' => 'oss/nas/cpfs uri', + 'description' => 'The unique URI of the file. Used to record the unique path of the file. File paths in OSS and NAS are supported.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'oss://${bucket}/${path}'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'nas://${fileSystemId}/${path}'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://*****-test/dataset/1653421.jpg'."\n" + .'nas://0e25d***dff/dataset/1653421.jpg'."\n", + 'backendName' => 'Uri', + ], + 'Comment' => [ + 'title' => '', + 'description' => 'The file comment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Comment', + ], + 'FileCreateTime' => [ + 'title' => '', + 'description' => 'The time when the file was created. Format: ISO8601.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2025-01-12T14:36:01Z', + 'backendName' => 'FileCreateTime', + ], + 'FileUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the file was last modified. Format: ISO8601.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'required' => false, + 'example' => '2025-01-12T14:36:01Z', + 'backendName' => 'FileUpdateTime', + ], + 'FileFingerPrint' => [ + 'title' => 'md5/oss etag', + 'description' => 'The fingerprint value of the file. Used to check the uniqueness of the file. This value changes after the file content is modified. OSS files use ETags, and NAS files use MD5.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => 'D41D8CD98F*****E9800998ECF8'."\n", + 'backendName' => 'FileFingerPrint', + ], + 'DataSize' => [ + 'title' => '', + 'description' => 'The file size. Unit: byte.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + 'backendName' => 'DataSize', + ], + 'FileType' => [ + 'title' => '', + 'description' => 'The file type. The same as MIME type.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* image'."\n" + .'* application'."\n" + .'* audio'."\n" + .'* video'."\n" + .'* text'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'image' => '', + 'application' => '', + 'audio' => '', + 'video' => '', + 'text' => '', + ], + 'example' => 'image', + 'backendName' => 'FileType', + ], + 'ContentType' => [ + 'title' => 'image/jpeg', + 'description' => 'The MIME type of the file. It contains a Type and a SubType.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* image/png: PNG'."\n" + .'* image/jpeg: JPEG'."\n" + .'* image/tiff: TIFF'."\n" + .'* image/bmp: BMP'."\n" + .'* image/gif: GIF'."\n" + .'* image/x-icon: ICON'."\n" + .'* image/svg + xml: SVG'."\n" + .'* image/heic: HEIC'."\n" + .'* image/webp: WEBP'."\n", + 'visibility' => 'Public', + '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' => 'text/png', + 'backendName' => 'ContentType', + ], + 'MetaAttributes' => [ + 'title' => '', + 'description' => 'The specific metadata of the file. You cannot retrieve the metadata. In JSON String format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "Image":'."\n" + .' {'."\n" + .' "Width": 1920,'."\n" + .' "Height": 1080,'."\n" + .' "Channel": 3'."\n" + .' }'."\n" + .'}', + 'backendName' => 'MetaAttributes', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags for the metadata. The tags are divided into the following groups:'."\n" + ."\n" + .'* Algorithm tag group:'."\n" + ."\n" + .' * ai: a list of tags that are aggregated by all algorithm tagging tasks for a single piece of metadata.'."\n" + ."\n" + .'* User-defined tag groups:'."\n" + ."\n" + .' * user: a list of user-defined tags that are added to a single piece of metadata.'."\n" + .' * user-delete-ai-tags: a list of tags that you want to delete from an algorithm tag group.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "ai":'."\n" + .' ['."\n" + .' "Felis catus",'."\n" + .' "Shorthair"'."\n" + .' ],'."\n" + .' "user":'."\n" + .' ['."\n" + .' "cat",'."\n" + .' "White"'."\n" + .' ]'."\n" + .'}', + 'backendName' => 'Tags', + ], + 'DatasetFileMetaId' => [ + 'title' => 'uuid', + 'description' => 'The metadata ID of the dataset file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", + 'backendName' => 'DatasetFileMetaId', + ], + 'FileDir' => [ + 'title' => '', + 'description' => 'The directory of the file that is stored in OSS, NAS, or Cloud Parallel File Storage (CPFS).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'icp_certificate_card/icp/1577179298694813/1716429710367', + 'backendName' => 'FileDir', + ], + 'TagUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the tag is last modified. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'TagUpdateTime', + ], + 'SemanticIndexJobId' => [ + 'title' => '', + 'description' => 'The ID of the semantic index-based job.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsjob-klfwtjtov*****scvt3', + 'backendName' => 'SemanticIndexJobId', + ], + 'SemanticIndexUpdateTime' => [ + 'title' => '', + 'description' => 'The time when the semantic index-based job is created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'format' => 'iso8601', + 'example' => '2021-01-12T14:36:01.000Z', + 'backendName' => 'SemanticIndexUpdateTime', + ], + ], + ], + 'DatasetFileMetaResponse' => [ + 'title' => 'A short description of struct', + 'description' => 'The returned result of the metadata operation for a single file.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DatasetFileMetaId' => [ + 'title' => '', + 'description' => 'The metadata ID of the dataset file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => '07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6', + 'backendName' => 'DatasetFileMetaId', + ], + 'Result' => [ + 'title' => 'Not Found/Failed ...', + 'description' => 'The description of the reason why the metadata operation failed.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'Not Found', + 'backendName' => 'Result', + ], + 'Uri' => [ + 'title' => 'oss/nas/cpfs uri', + 'description' => 'The file URI.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://l*****-test/dataset/1653421.jpg', + 'backendName' => 'Uri', + ], + ], + ], + 'DatasetJob' => [ + 'title' => '', + 'description' => 'The dataset job.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DatasetJobId' => [ + 'title' => '', + 'description' => 'The job ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsjob-9jx1*****uj9e', + 'backendName' => 'DatasetJobId', + ], + 'JobAction' => [ + 'title' => '', + 'description' => 'The job action.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'SemanticIndex', + 'backendName' => 'JobAction', + ], + 'CreateTime' => [ + 'title' => '', + 'description' => 'The job creation time (UTC).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-06-20T04:05:59Z', + 'backendName' => 'CreateTime', + ], + 'FinishTime' => [ + 'title' => '', + 'description' => 'The job finish time (UTC).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-06-20T06:03:48Z', + 'backendName' => 'FinishTime', + ], + 'Status' => [ + 'title' => '', + 'description' => 'The job status.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Running', + 'backendName' => 'Status', + ], + 'Description' => [ + 'title' => '', + 'description' => 'The job description.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'Description', + ], + 'JobMode' => [ + 'title' => '', + 'description' => 'The job mode.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Full'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Full' => '', + ], + 'example' => 'Full', + 'backendName' => 'JobMode', + ], + 'JobSpec' => [ + 'title' => '', + 'description' => 'The job details.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{\\"modelId\\":\\"xxx\\"}', + 'backendName' => 'JobSpec', + ], + 'Logs' => [ + 'title' => '', + 'description' => 'The job logs.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The content of the log entry.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.', + 'extendType' => 'true', + ], + 'backendName' => 'Logs', + 'itemName' => 'Log', + ], + 'TotalFileCount' => [ + 'title' => '', + 'description' => 'The number of job files.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + 'backendName' => 'TotalFileCount', + ], + 'CompletedFileCount' => [ + 'title' => '', + 'description' => 'The number of completed files.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '990', + 'backendName' => 'CompletedFileCount', + ], + 'FailedFileCount' => [ + 'title' => '', + 'description' => 'The number of failed files.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'FailedFileCount', + ], + 'DatasetVersion' => [ + 'title' => '', + 'description' => 'The dataset version.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'v1', + 'backendName' => 'DatasetVersion', + ], + 'WorkspaceId' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '145883', + 'backendName' => 'WorkspaceId', + ], + ], + ], + 'DatasetJobConfig' => [ + 'title' => 'A short description of struct', + 'description' => 'The dataset job configurations.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DatasetJobConfigId' => [ + 'title' => 'DatasetJobConfigId', + 'description' => 'The ID of the dataset job configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dscfg-xxxxxxxxxxxx', + 'backendName' => 'DatasetJobConfigId', + ], + 'CreateTime' => [ + 'title' => 'CreateTime', + 'description' => 'The time when the dataset job was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-01-14T01:37:37Z', + 'backendName' => 'CreateTime', + ], + 'ModifyTime' => [ + 'title' => 'ModifyTime', + 'description' => 'The time when the dataset job was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2024-10-11T02:18:54Z', + 'backendName' => 'ModifyTime', + ], + 'ConfigType' => [ + 'title' => 'ConfigType', + 'description' => 'The type of the dataset job configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'MultimodalIntelligentTag', + 'backendName' => 'ConfigType', + ], + 'Config' => [ + 'title' => 'Config', + 'description' => 'The content of the dataset job configuration, in the JSON format.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', + 'backendName' => 'Config', + ], + 'WorkspaceId' => [ + 'title' => 'WorkspaceId', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '234*34', + 'backendName' => 'WorkspaceId', + ], + ], + ], + 'DatasetLabel' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key', + 'description' => 'Key'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Key', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => 'Value'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Value', + ], + ], + ], + 'DatasetShareRelationship' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'REVOKED' => 'REVOKED', + 'ACTIVE' => 'ACTIVE', + 'EXPIRED' => 'EXPIRED', + 'INVALID' => 'INVALID', + ], + 'example' => 'ACTIVE', + 'backendName' => 'status', + ], + 'SourceTenantId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '148***************115', + 'backendName' => 'sourceTenantId', + ], + 'SourceWorkspaceId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '33**19', + 'backendName' => 'sourceWorkspaceId', + ], + 'TenantId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '153***************249', + 'backendName' => 'tenantId', + ], + 'WorkspaceId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '42**2', + 'backendName' => 'workspaceId', + ], + 'AllowedMountAccessLevels' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'RW' => 'RW', + 'RO' => 'RO', + ], + 'example' => 'RO', + 'extendType' => 'true', + ], + 'required' => false, + 'backendName' => 'allowedMountAccessLevels', + ], + 'IsSecureMode' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + 'backendName' => 'isSecureMode', + ], + 'SharedAt' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2025-08-26T12:23:58Z', + 'backendName' => 'sharedAt', + ], + 'ExpiresAt' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2026-08-27T12:23:58Z', + 'backendName' => 'expiresAt', + ], + ], + ], + 'DatasetVersion' => [ + 'title' => 'Dataset Version struct', + 'description' => 'Dataset Version struct'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'VersionName' => [ + 'title' => 'version name', + 'description' => 'version name'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'v1', + 'backendName' => 'VersionName', + ], + 'GmtCreateTime' => [ + 'title' => 'create time', + 'description' => 'create time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => 'modify time', + 'description' => 'modify time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + 'backendName' => 'GmtModifiedTime', + ], + 'Property' => [ + 'title' => 'property', + 'description' => 'property'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'FILE', + 'backendName' => 'Property', + ], + 'DataSourceType' => [ + 'title' => 'DataSourceType', + 'description' => 'DataSourceType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'OSS', + 'backendName' => 'DataSourceType', + ], + 'Uri' => [ + 'title' => 'Uri', + 'description' => 'Uri'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'OSS://xxx', + 'backendName' => 'Uri', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'Labels'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + 'description' => '', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + 'Options' => [ + 'title' => 'Options', + 'description' => 'Options'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + 'backendName' => 'Options', + ], + 'SourceType' => [ + 'title' => 'SourceType', + 'description' => 'SourceType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'USER', + 'backendName' => 'SourceType', + ], + 'Description' => [ + 'title' => 'Description', + 'description' => 'Description'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'base model v1', + 'backendName' => 'Description', + ], + 'SourceId' => [ + 'title' => 'SourceId', + 'description' => 'SourceId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'd-65mrsr5fub4u74lej3', + 'backendName' => 'SourceId', + ], + 'DataCount' => [ + 'title' => 'DataCount', + 'description' => 'DataCount'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + 'backendName' => 'DataCount', + ], + 'DataSize' => [ + 'title' => 'DataSize', + 'description' => 'DataSize'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + 'backendName' => 'DataSize', + ], + 'MountAccess' => [ + 'title' => 'MountAccess', + 'description' => 'MountAccess'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'RO', + 'backendName' => 'MountAccess', + ], + 'ImportInfo' => [ + 'title' => 'ImportInfo', + 'description' => 'ImportInfo'."\n", + 'visibility' => 'Public', + '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" + .'}', + 'backendName' => 'ImportInfo', + ], + ], + ], + 'Experiment' => [ + 'title' => 'A short description of struct', + 'description' => 'The experiment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ExperimentId' => [ + 'title' => 'ExperimentId', + 'description' => 'ExperimentId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'ExperimentId', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'Name'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Name', + ], + 'WorkspaceId' => [ + 'title' => 'WorkspaceId', + 'description' => 'WorkspaceId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'WorkspaceId', + ], + 'ArtifactUri' => [ + 'title' => 'ArtifactUri', + 'description' => 'ArtifactUri'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'ArtifactUri', + ], + 'TensorboardLogUri' => [ + 'title' => 'TensorboardLogUri', + 'description' => 'TensorboardLogUri'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'TensorboardLogUri', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'Labels'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/ExperimentLabel', + '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' => 'GmtCreatedTime', + 'description' => 'GmtCreatedTime'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtCreatedTime', + ], + 'GmtModifiedTime' => [ + 'title' => 'GmtModifiedTime', + 'description' => 'GmtModifiedTime'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtModifiedTime', + ], + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RequestId', + ], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => 'Accessibility'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Accessibility', + ], + 'LatestRun' => [ + 'title' => 'LatestRun', + 'description' => 'LatestRun'."\n", + 'visibility' => 'Public', + 'backendName' => 'LatestRun', + '$ref' => '#/components/schemas/Run', + ], + ], + ], + 'ExperimentLabel' => [ + 'title' => 'A short description of struct', + 'description' => 'The experiment label.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key of Experiment Label', + 'description' => 'Key of Experiment Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'key', + 'backendName' => 'Key', + ], + 'Value' => [ + 'title' => 'Value of Experiment Label', + 'description' => 'Value of Experiment Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'value', + 'backendName' => 'Value', + ], + 'GmtCreateTime' => [ + 'title' => 'Create time', + 'description' => 'Create time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-12-27T03:30:04Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => 'Modified time', + 'description' => 'Modified time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-12-27T03:30:04Z', + 'backendName' => 'GmtModifiedTime', + ], + 'ExperimentId' => [ + 'title' => 'ExperimentId', + 'description' => 'ExperimentId'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'exp-890waerw09a0f', + 'backendName' => 'ExperimentId', + ], + ], + ], + 'Label' => [ + 'title' => 'A short description of struct', + 'description' => 'The label structure.'."\n", + 'visibility' => 'public', + '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", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'env', + '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", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'Value', + ], + ], + ], + 'LabelInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'TrialLabelInfo'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key of Label', + 'description' => 'Key of Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'key', + 'backendName' => 'Key', + ], + 'Value' => [ + 'title' => 'Value of Label', + 'description' => 'Value of Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'value', + 'backendName' => 'Value', + ], + ], + ], + 'LineageEntity' => [ + 'title' => 'A short description of struct', + 'description' => 'The lineage entity.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Attributes' => [ + 'title' => 'Attributes', + 'description' => 'Attributes'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'Attributes', + ], + 'EntityType' => [ + 'title' => 'EntityType', + 'description' => 'EntityType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'EntityType', + ], + 'Name' => [ + 'title' => 'Name', + 'description' => 'Name'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Name', + ], + 'QualifiedName' => [ + 'title' => 'QualifiedName', + 'description' => 'QualifiedName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'QualifiedName', + ], + ], + ], + 'LineageRelation' => [ + 'title' => 'A short description of struct', + 'description' => 'LineageRelation'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'DestEntityQualifiedName' => [ + 'title' => 'DestEntityQualifiedName', + 'description' => 'DestEntityQualifiedName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'DestEntityQualifiedName', + ], + 'RelationshipGuid' => [ + 'title' => 'RelationshipGuid', + 'description' => 'RelationshipGuid'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RelationshipGuid', + ], + 'SrcEntityQualifiedName' => [ + 'title' => 'SrcEntityQualifiedName', + 'description' => 'SrcEntityQualifiedName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'SrcEntityQualifiedName', + ], + ], + ], + 'Model' => [ + 'title' => 'A short description of struct', + 'description' => 'The model.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ModelId' => [ + 'title' => '', + 'description' => 'The model ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'model-1123*****', + 'backendName' => 'ModelId', + ], + 'ModelName' => [ + 'title' => '', + 'description' => 'The model name.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'ModelName', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The time when the model was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => '', + 'description' => 'The time when the model was last modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtModifiedTime', + ], + 'WorkspaceId' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '234**', + 'backendName' => 'WorkspaceId', + ], + 'UserId' => [ + 'title' => '', + 'description' => 'The user ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1557702098******', + 'backendName' => 'UserId', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1557702098******', + 'backendName' => 'OwnerId', + ], + 'ModelDescription' => [ + 'title' => '', + 'description' => 'The model description.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + '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", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PUBLIC', + 'backendName' => 'Accessibility', + ], + 'LatestVersion' => [ + 'title' => '', + 'description' => 'The latest version of the model.'."\n", + 'visibility' => 'public', + 'backendName' => 'LatestVersion', + '$ref' => '#/components/schemas/ModelVersion', + ], + 'Labels' => [ + 'title' => '', + 'description' => 'The labels.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + 'OrderNumber' => [ + 'title' => '', + 'description' => 'The sequence number of the model.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + 'backendName' => 'OrderNumber', + ], + 'Origin' => [ + 'title' => '', + 'description' => 'The community or organization to which the source model belongs, such as ModelScope or Hugging Face.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ModelScope', + 'backendName' => 'Origin', + ], + 'Domain' => [ + 'title' => '', + 'description' => 'The domain where the model is applied, such as nlp (Natural Language Processing) and cv (Computer Vision).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'nlp', + 'backendName' => 'Domain', + ], + 'Task' => [ + 'title' => '', + 'description' => 'The task. The specific issue that the model resolves, such as text-classification.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'text-classifiaction', + 'backendName' => 'Task', + ], + 'ModelDoc' => [ + 'title' => '', + 'description' => 'The model document.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://***.md', + 'backendName' => 'ModelDoc', + ], + 'Provider' => [ + 'title' => '', + 'description' => 'The model provider.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'pai', + 'backendName' => 'Provider', + ], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'The additional information.'."\n", + 'visibility' => 'Public', + '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" + .'}', + 'backendName' => 'ExtraInfo', + ], + 'ModelType' => [ + 'title' => '', + 'description' => 'The model type, such as checkpoint and LoRA.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Checkpoint', + 'backendName' => 'ModelType', + ], + ], + ], + 'ModelVersion' => [ + 'title' => 'A short description of struct', + 'description' => 'The model version.'."\n", + 'visibility' => 'public', + '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", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '0.1.0', + 'backendName' => 'VersionName', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The time when the model was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => '', + 'description' => 'The time when the model was last modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '2021-01-21T17:12:35Z', + 'backendName' => 'GmtModifiedTime', + ], + 'UserId' => [ + 'title' => '', + 'description' => 'The user ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '155770209******', + 'backendName' => 'UserId', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '155770209******', + '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://<bucket>.<endpoint>/object` format. The endpoint can be queried in the OSS console, such as `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', + 'backendName' => 'Uri', + ], + 'VersionDescription' => [ + 'title' => '', + 'description' => 'The model version description.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'VersionDescription', + ], + 'Labels' => [ + 'title' => '', + 'description' => 'The labels.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Label', + ], + 'backendName' => 'Labels', + 'itemName' => 'Labels', + ], + '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", + 'visibility' => 'public', + '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', + 'backendName' => 'FormatType', + ], + 'FrameworkType' => [ + 'title' => '', + 'description' => 'The model framework.'."\n" + ."\n" + .'* Pytorch'."\n" + .'* XGBoost'."\n" + .'* Keras'."\n" + .'* Caffe'."\n" + .'* Alink'."\n" + .'* Xflow'."\n" + .'* TensorFlow'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pytorch' => 'Pytorch', + 'XGBoost' => 'XGBoost', + 'Keras' => 'Keras', + 'Caffe' => 'Caffe', + 'Alink' => 'Alink', + 'Xflow' => 'Xflow', + 'TensorFlow' => 'TensorFlow', + ], + 'example' => 'TensorFlow', + 'backendName' => 'FrameworkType', + ], + 'Options' => [ + 'title' => '', + 'description' => 'The extended field. The value is a JSON string.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '{}', + 'backendName' => 'Options', + ], + 'Metrics' => [ + 'title' => '', + 'description' => 'The model metrics.'."\n", + 'visibility' => 'public', + '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" + .'}', + 'backendName' => 'Metrics', + ], + 'TrainingSpec' => [ + 'title' => '', + 'description' => 'The training configuration, used for fine-tuning and incremental training.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{}', + 'backendName' => 'TrainingSpec', + ], + '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", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}', + 'backendName' => 'InferenceSpec', + ], + 'EvaluationSpec' => [ + 'title' => '', + 'description' => 'The evaluation configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '{}', + 'backendName' => 'EvaluationSpec', + ], + 'CompressionSpec' => [ + 'title' => '', + 'description' => 'The compression configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '{}', + 'backendName' => 'CompressionSpec', + ], + 'SourceType' => [ + 'title' => '', + 'description' => 'The source type of the model. Default value: Custom.'."\n" + ."\n" + .'* Custom'."\n" + .'* PAIFlow'."\n" + .'* TrainingService'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'PAIFlow' => 'PAIFlow', + 'Custom' => 'Custom', + 'TrainingService' => 'TrainingService', + ], + 'example' => 'PAIFlow', + '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=<region_id>,workspaceId=<workspace_id>,kind=<kind>,id=<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", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'region=cn-shanghai,workspaceId=13**,kind=PipelineRun,id=run-sakdb****jdf', + 'backendName' => 'SourceId', + ], + 'ApprovalStatus' => [ + 'title' => '', + 'description' => 'The approval status. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Approved'."\n" + .'* Rejected'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Approved', + 'backendName' => 'ApprovalStatus', + ], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'The additional information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '{'."\n" + .' "CoverUris": ["https://e***u.oss-cn-hangzhou.aliyuncs.com/st****017.preview.png"],'."\n" + .' "TrainedWords": ["albedo_overlord"]'."\n" + .'}', + 'backendName' => 'ExtraInfo', + ], + ], + ], + 'ModulePermissions' => [ + 'title' => 'A short description of struct', + 'description' => 'A short description of struct'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'title' => 'ModuleName', + 'description' => 'ModuleName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'ModuleName', + ], + 'PermissionType' => [ + 'title' => 'PermissionType', + 'description' => 'PermissionType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'PermissionType', + ], + 'Permissions' => [ + 'title' => 'Permissions', + 'description' => 'Permissions'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'PermissionCodes' => [ + 'title' => 'PermissionCodes', + 'description' => 'PermissionCodes'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'string', + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'PermissionCodes', + ], + 'PermissionRules' => [ + 'title' => 'PermissionRules', + 'description' => 'PermissionRules'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => 'Accessibility'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Accessibility', + ], + 'EntityAccessType' => [ + 'title' => 'EntityAccessType', + 'description' => 'EntityAccessType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'EntityAccessType', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'PermissionRules', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'Permissions', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'parseType' => 'struct', + 'itemName' => 'ModulePermissions', + ], + 'Relation' => [ + 'title' => 'A short description of struct', + 'description' => 'Relation'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ErrMsg' => [ + 'title' => 'ErrMsg', + 'description' => 'ErrMsg'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'ErrMsg', + ], + 'LineageRelation' => [ + 'title' => 'LineageRelation', + 'description' => 'LineageRelation'."\n", + 'visibility' => 'Public', + 'backendName' => 'LineageRelation', + '$ref' => '#/components/schemas/LineageRelation', + ], + 'Result' => [ + 'title' => 'Result', + 'description' => 'Result'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'Result', + ], + ], + ], + 'Relationship' => [ + 'title' => 'A short description of struct', + 'description' => 'Relationship'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Attributes' => [ + 'title' => 'Attributes', + 'description' => 'Attributes'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'Attributes', + ], + 'DataChannel' => [ + 'title' => 'DataChannel', + 'description' => 'DataChannel'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'DataChannel', + ], + 'RelationshipGuid' => [ + 'title' => 'RelationshipGuid', + 'description' => 'RelationshipGuid'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RelationshipGuid', + ], + 'RelationshipType' => [ + 'title' => 'RelationshipType', + 'description' => 'RelationshipType'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RelationshipType', + ], + ], + ], + 'Run' => [ + 'title' => '', + 'description' => 'The run.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => '', + 'description' => 'The visibility.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Accessibility', + ], + 'SourceId' => [ + 'title' => '', + 'description' => 'The ID of the source PAI workload.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'SourceId', + ], + 'SourceType' => [ + 'title' => '', + 'description' => 'The type of the source PAI workload.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'SourceType', + ], + 'WorkspaceId' => [ + 'title' => '', + 'description' => 'The ID of the workspace to which the run belongs.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'WorkspaceId', + ], + 'Params' => [ + 'title' => '', + 'description' => 'The hyperparameters of the run.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RunParam', + 'description' => '', + ], + 'backendName' => 'Params', + ], + 'Labels' => [ + 'title' => '', + 'description' => 'The labels added to the run.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RunLabel', + 'description' => '', + ], + 'backendName' => 'Labels', + ], + 'GmtModifiedTime' => [ + 'title' => '', + 'description' => 'The last modified time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtModifiedTime', + ], + 'Name' => [ + 'title' => '', + 'description' => 'Parameter'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'Name', + ], + 'Metrics' => [ + 'title' => '', + 'description' => 'The metrics of the run.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/RunMetric', + 'description' => '', + ], + 'backendName' => 'Metrics', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => 'The ID of the owner account.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'OwnerId', + ], + 'ExperimentId' => [ + 'title' => '', + 'description' => 'The ID of the experiment that corresponds to the run.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'ExperimentId', + ], + 'UserId' => [ + 'title' => '', + 'description' => 'The owner ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'UserId', + ], + 'RunId' => [ + 'title' => '', + 'description' => 'The run ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RunId', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtCreateTime', + ], + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RequestId', + ], + ], + ], + 'RunLabel' => [ + 'title' => '', + 'description' => 'The run label details.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '', + 'description' => 'The label value.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'Value', + ], + 'RunId' => [ + 'title' => '', + 'description' => 'The ID of the run.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'RunId', + ], + 'GmtCreateTime' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => '', + 'description' => 'The last modified time.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'GmtModifiedTime', + ], + 'Key' => [ + 'title' => '', + 'description' => 'The label key.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'Key', + ], + ], + ], + 'RunMetric' => [ + 'title' => '', + 'description' => 'The job metrics.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '', + 'description' => 'The metric value.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'backendName' => 'Value', + ], + 'Step' => [ + 'title' => '', + 'description' => 'The step number that generated the metric.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'backendName' => 'Step', + ], + 'Timestamp' => [ + 'title' => '', + 'description' => 'The timestamp when the metric was generated.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'backendName' => 'Timestamp', + ], + 'Key' => [ + 'title' => '', + 'description' => 'The metric name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'Key', + ], + ], + ], + 'RunParam' => [ + 'title' => '', + 'description' => 'The job parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '', + 'description' => 'The value of the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'Value', + ], + 'Key' => [ + 'title' => '', + 'description' => 'The name of the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'Key', + ], + ], + ], + 'ServiceTemplate' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ServiceTemplateId' => [ + 'title' => '', + 'description' => '', + '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' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '155770209****904', + 'backendName' => 'UserId', + ], + 'OwnerId' => [ + 'title' => '', + 'description' => '', + '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' => 'TrialLabel'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key of Trial Label', + 'description' => 'Key of Trial Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'key', + 'backendName' => 'Key', + ], + 'Value' => [ + 'title' => 'Value of Trial Label', + 'description' => 'Value of Trial Label'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'value', + 'backendName' => 'Value', + ], + 'GmtCreateTime' => [ + 'title' => 'Create time', + 'description' => 'Create time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-12-27T03:30:04Z', + 'backendName' => 'GmtCreateTime', + ], + 'GmtModifiedTime' => [ + 'title' => 'Modified time', + 'description' => 'Modified time'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2023-12-27T03:30:04Z', + 'backendName' => 'GmtModifiedTime', + ], + 'TrialId' => [ + 'title' => 'trl-v0fw9a0sd8f9af', + 'description' => 'trl-v0fw9a0sd8f9af'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'TrialId', + ], + ], + ], + ], + ], + 'apis' => [ + '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' => 'body参数', + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '478**', + ], + 'Labels' => [ + 'title' => '标签', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/LabelInfo', + ], + 'required' => false, + ], + 'Name' => [ + 'title' => '名称', + 'description' => 'The experiment name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must start with a letter.'."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must be 1 to 63 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-test', + ], + 'ArtifactUri' => [ + 'title' => 'Artifact路径', + 'description' => 'The default artifact output path of all jobs that are associated with the experiment. Only Object Storage Service (OSS) paths are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-bucket.oss-cn-hangzhou.aliyuncs.com/test', + ], + 'Accessibility' => [ + 'description' => 'The visibility of the experiment. Valid values: PRIVATE (the experiment is visible only to the creator and the Alibaba Cloud account) and PUBLIC (the experiment is visible to all users). This parameter is optional and the default value is PRIVATE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PRIVATE', + 'enum' => [ + 'PRIVATE', + 'PUBLIC', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ExperimentId' => [ + 'title' => '若创建接口为异步实现，则需返回明确的JobId。', + 'description' => 'The returned data. If the operation is asynchronously implemented, the job ID is returned.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"请求ID\\",\\n \\"ExperimentId\\": \\"API请求完成创建的实验ID\\"\\n}","type":"json"}]', + 'title' => 'CreateExperiment', + ], + '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' => 'body参数', + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'description' => 'The experiment name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must start with a letter.'."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must be 1 to 63 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + 'Accessibility' => [ + 'description' => 'The accessibility of the experiment in the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The experiment is accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The experiment is accessible to all users in the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'enum' => [ + 'PRIVATE', + 'PUBLIC', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The experiment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-1zpfthdx******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'UpdateExperiment', + ], + 'GetExperiment' => [ + 'summary' => 'Obtains 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 ID of the experiment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'exp-1zpfthdx******', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取关联到Experiment的最新Run信息', + 'description' => 'Specifies whether to obtain the latest run information associated with the experiment'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The experiment instance information.'."\n", + '$ref' => '#/components/schemas/Experiment', + ], + ], + ], + '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\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\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\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetExperiment', + ], + 'ListExperiment' => [ + 'summary' => 'Lists 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 experiment name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'exp-test', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workspace to which the experiment belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n" + ."\n" + .'> If you do not specify a workspace ID, the system returns the experiments in the default workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '151739', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag filter conditions. Multiple conditions are separated by commas (,). The format of a single condition filter is `key=value`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'is_evaluation:true', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The field used for sorting. The GmtCreateTime field is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + 'default' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The order of specific fields of results in a paged query (ascending or descending).'."\n" + ."\n" + .'* ASC: ascending order'."\n" + .'* DESC: descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'default' => 'DESC', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The page number. The value starts from 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'The strings used for sorting. The following fields can be used for sorting: GmtCreateTime, Name, GmtModifiedTime, and ExperimentId. The sorting order can be ASC (default) and DESC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime DESC,Name ASC', + ], + ], + [ + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token, which starts from 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries in the request. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取于实验相关的LatestRun', + 'description' => 'Specifies whether to obtain the LatestRun value that is related to the experiment.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'False', + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The optional parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'match_name_exactly' => [ + 'title' => '是否精确匹配名称，可以填“true“/”false“', + 'description' => 'Specifies whether to exactly match the experiment by name. Valid values: true and false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0C6835C5-A424-5AFB-ACC2-F1E3CA1ABF7C', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Experiments' => [ + 'description' => 'The list of experiments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The experiment details.'."\n", + '$ref' => '#/components/schemas/Experiment', + ], + ], + 'NextPageToken' => [ + 'description' => 'The pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\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\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n }\\n ],\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', + 'title' => 'ListExperiment', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-1zpfthdx******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + 'title' => 'DeleteExperiment', + ], + 'SetExperimentLabels' => [ + 'summary' => 'Updates a experiment tag.', + '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' => 'body参数', + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details about a tag, including the tag key and tag value.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/LabelInfo', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The experiment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-1zpfthdx******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'SetExperimentLabels', + ], + 'DeleteExperimentLabel' => [ + 'summary' => 'Deletes an experiment tag.', + '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 ID of the experiment.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-1zpfthdx******', + ], + ], + [ + 'name' => 'Key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The key of the experiment tag to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'is_evaluate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteExperimentLabel', + ], + 'CreateRun' => [ + 'summary' => 'Creates a run. A run is an experiment that can be associated with a specific workload or simply a 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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Run的名称，若创建时名称为空，则会使用服务端随机生成的RunID作为名称', + 'description' => 'The name of the run. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must start with a letter.'."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must be 1 to 63 characters in length.'."\n" + ."\n" + .'If the name is left empty when you create a run, a random run ID generated by the server is used as the name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + 'SourceType' => [ + 'title' => 'Run关联的PAI Workload类型', + 'description' => 'The type of the workload source that is associated with the run. Valid values: TrainingService and DLC. You can also leave this parameter empty. This parameter is optional and left empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLC', + ], + 'SourceId' => [ + 'title' => 'Run关联的PAI Workload ID', + 'description' => 'The ID of the workload associated with the run.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'job-jdnhf***fnrimv', + ], + 'ExperimentId' => [ + 'title' => 'Run关联的实验ID', + 'description' => 'The ID of the experiment that corresponds to the run.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'exp-6thbb5xrbmp*****', + ], + 'Labels' => [ + 'title' => 'Run的标签', + 'description' => 'The list of tags added to the run.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag details.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'Params' => [ + 'description' => 'The parameters of the run.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the parameter.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/RunParam', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + 'RunId' => [ + 'description' => 'The run ID.'."\n", + 'type' => 'string', + 'example' => 'run-1meoz7VJd2C6f****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"RunId\\": \\"run-1meoz7VJd2C6f****\\"\\n}","type":"json"}]', + 'title' => 'CreateRun', + ], + 'UpdateRun' => [ + 'summary' => 'Updates the run information.', + '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 run ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The run name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must start with a letter.'."\n" + .'* The name can contain letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must be 1 to 63 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + 'Labels' => [ + 'description' => 'The labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'Params' => [ + 'description' => 'The parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/RunParam', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + 'title' => 'UpdateRun', + ], + 'GetRun' => [ + 'summary' => 'Queries the run information.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取Metrics, Params, Labels信息', + 'description' => 'Specifies whether to obtain the Metrics, Params, and Labels information. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The run instance information.'."\n", + '$ref' => '#/components/schemas/Run', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\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\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetRun', + ], + 'ListRuns' => [ + 'summary' => 'Queries a list of runs.', + '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 run name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workspace to which the experiment belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n" + ."\n" + .'> If you do not specify a workspace ID, the system returns the runs of the default workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22840', + ], + ], + [ + 'name' => 'ExperimentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Run所属实验ID', + 'description' => 'The ID of the experiment that the run belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'exp-1zpfthdx******', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Run关联的PAI Workload类型', + 'description' => 'The type of the workload associated with the run.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TrainingService', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Run关联的PAI Workload ID', + 'description' => 'The ID of the workload associated with the run.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'job-rbvg5wzlj****', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'title' => '任务的标签，精确匹配'."\n" + .'● 支持单标签查询:"is_evaluation:true"'."\n" + .'● 多标签场景（非特殊场景不推荐，可能存在性能问题）:"is_evaluation:true,LLM_evaluation:true" 使用英文逗号分隔，表示多个标签key-value需要同时匹配', + 'description' => 'The label. Exact match is supported. Valid values:'."\n" + ."\n" + .'* Single-label query: Set the value to is_evaluation.'."\n" + .'* Multi-label query (not recommended in non-special scenarios and may have performance issues): Set the value to is_evaluation:true,LLM_evaluation:true. Multiple labels are separated with commas (,), indicating that the key-value pairs of multiple labels must be matched at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'is_evaluation:true', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to show detailed information, including Metrics, Params, and Labels. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'GmtCreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-30T12:51:33.028Z', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The strings by which the results are sorted. The following parameters can be used to sort the results: GmtCreateTime and Name. The sorting order can be ASC (default) and DESC. Separate multiple strings with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime DESC,Name ASC', + ], + ], + [ + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token, which starts from 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries in the request. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. The value must be greater than 0. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The field used for sorting. Valid values:'."\n" + ."\n" + .'* Name: the name of the run.'."\n" + .'* GmtCreateTime: the time when the run is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + 'default' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. This parameter must be used together with SortBy.'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC (default)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'default' => 'DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + 'Runs' => [ + 'description' => 'The runs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the run instance.'."\n", + '$ref' => '#/components/schemas/Run', + ], + ], + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned. By default, this parameter is not returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NextPageToken' => [ + 'description' => 'The pagination token that is used to retrieve the next page. You do not need to specify this parameter for the first request. You must specify the pagination token in the result of the previous query. If the pagination token is 0, no next page exists. You can obtain the pagination token that is used to retrieve the next page in the value of the **NextPageToken** field.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"Runs\\": [\\n {\\n \\"Accessibility\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\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\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 0,\\n \\"Step\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"OwnerId\\": \\"\\",\\n \\"ExperimentId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"RunId\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": 0\\n}","type":"json"}]', + 'title' => 'ListRuns', + ], + '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'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + 'title' => 'DeleteRun', + ], + 'DeleteRunLabel' => [ + 'summary' => 'Deletes a tag that is added to 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 run ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'path', + 'schema' => [ + 'description' => 'The key of the run tag to be deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'is_evaluate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + 'title' => 'DeleteRunLabel', + ], + 'LogRunMetrics' => [ + 'summary' => 'Logs multiple metrics for a run at a time.', + '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 run ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Metrics' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metric details.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/RunMetric', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + 'title' => 'LogRunMetrics', + ], + 'ListRunMetrics' => [ + 'summary' => 'Lists the metrics 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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'run-1qJhzJ2YXgX****', + ], + ], + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric key of the run.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'loss', + ], + ], + [ + 'name' => 'PageToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token, which starts from 0. Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries in the request. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + 'Metrics' => [ + 'description' => 'The metrics.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the metric.'."\n", + '$ref' => '#/components/schemas/RunMetric', + ], + ], + 'NextPageToken' => [ + 'description' => 'The pagination token that is used to retrieve the next page. You do not need to specify this parameter for the first request. You must specify the pagination token in the result of the previous query. If the pagination token is 0, no next page exists. You can obtain the pagination token that is used to retrieve the next page in the value of the **NextPageToken** field.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'ListRunMetrics', + ], + '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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '镜像名称', + 'description' => 'The image name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must be 1 to 50 characters in length.'."\n" + .'* The name can contain lowercase letters, digits, and hyphens (-). The name must start with a lowercase letter.'."\n" + .'* The name must be unique in a workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'nlp-compression', + ], + 'Description' => [ + 'title' => '镜像描述', + 'description' => 'The image description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'ImageUri' => [ + 'title' => '镜像地址', + 'description' => 'The URL of the image, which can be repeated. You can call [ListImage](~~449118~~) to view the image URL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'registry.cn-hangzhou.aliyuncs.com/pai-compression/nlp:gpu', + ], + 'Labels' => [ + 'title' => '镜像标签，是个数组', + 'description' => 'The image tag, which is an array. Each element in the array contains a key-value pair. Alibaba Cloud images have the system.official=true tag. You can add the following keys to an image:'."\n" + ."\n" + .'* system.chipType'."\n" + .'* system.dsw.cudaVersion'."\n" + .'* system.dsw.fromImageId'."\n" + .'* system.dsw.fromInstanceId'."\n" + .'* system.dsw.id'."\n" + .'* system.dsw.os'."\n" + .'* system.dsw.osVersion'."\n" + .'* system.dsw.resourceType'."\n" + .'* system.dsw.rootImageId'."\n" + .'* system.dsw.stage'."\n" + .'* system.dsw.tag'."\n" + .'* system.dsw.type'."\n" + .'* system.framework'."\n" + .'* system.origin'."\n" + .'* system.pythonVersion'."\n" + .'* system.source'."\n" + .'* system.supported.dlc'."\n" + .'* system.supported.dsw'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.chipType', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GPU', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'WorkspaceId' => [ + 'title' => '工作空间id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '15******45', + ], + 'Accessibility' => [ + 'title' => '可见性 Public 公有 Private 私有', + 'description' => 'The accessibility of the image. Valid values:'."\n" + ."\n" + .'* PUBLIC: The image is accessible to all members in the workspace.'."\n" + .'* PRIVATE: The image is accessible only to the image creator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLIC', + ], + 'Size' => [ + 'description' => 'The size of the image. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'ImageId' => [ + 'description' => 'The image ID. If you do not specify this parameter, the system automatically generates an image ID. The image ID must start with image- followed by 18 characters in letters or digits.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'image-k83*****cv', + ], + 'SourceType' => [ + 'title' => '镜像来源类型：'."\n" + .' Import : 导入'."\n" + .' Build ：构建', + 'type' => 'string', + 'required' => false, + ], + 'SourceId' => [ + 'title' => '镜像来源 ID。 当镜像来源类型是“构建”时，来源 ID 对应镜像构建 ID。', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'ImageId' => [ + 'title' => '镜像 id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-4c62******53uor', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ImageId\\": \\"image-4c62******53uor\\"\\n}","type":"json"}]', + 'title' => 'AddImage', + ], + 'AddImageLabels' => [ + 'summary' => 'Adds tags to an 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' => '镜像Id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'image-4c62******53uor'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '数据', + 'description' => 'The image tag information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '标签', + 'description' => 'The list of image tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key', + 'description' => 'The tag key. The following keys can be added:'."\n" + ."\n" + .'* system.chipType'."\n" + .'* system.dsw.cudaVersion'."\n" + .'* system.dsw.fromImageId'."\n" + .'* system.dsw.fromInstanceId'."\n" + .'* system.dsw.id'."\n" + .'* system.dsw.os'."\n" + .'* system.dsw.osVersion'."\n" + .'* system.dsw.resourceType'."\n" + .'* system.dsw.rootImageId'."\n" + .'* system.dsw.stage'."\n" + .'* system.dsw.tag'."\n" + .'* system.dsw.type'."\n" + .'* system.framework'."\n" + .'* system.origin'."\n" + .'* system.pythonVersion'."\n" + .'* system.source'."\n" + .'* system.supported.dlc'."\n" + .'* system.supported.dsw'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.chipType', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GPU', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'AddImageLabels', + ], + 'GetImage' => [ + 'summary' => 'Obtains the information about 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' => '镜像id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'image-4c62******53uor', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否显示非必要信息：Labels', + 'description' => 'Specifies whether to display non-essential information, which contains tags. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the image is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'GmtModifiedTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the image is modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Name' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'nlp-compression'."\n", + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The image description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ImageUri' => [ + 'title' => '镜像地址，包含版本号', + 'description' => 'The image address, which contains the version number.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu'."\n", + ], + 'UserId' => [ + 'title' => '创建人', + 'description' => 'The user ID of the image.'."\n", + 'type' => 'string', + 'example' => '15577******8921', + ], + 'ParentUserId' => [ + 'title' => '创建人父账户', + 'description' => 'The Alibaba Cloud account of the creator.'."\n", + 'type' => 'string', + 'example' => '15577******8921', + ], + 'Labels' => [ + 'title' => '镜像标签', + 'description' => 'The image tags, which are of the array data type. Each element in the array contains a key-value pair. The key of official tags is system.official and the tag value is true.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'system.chipType'."\n", + ], + 'Value' => [ + 'title' => 'Value', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'GPU', + ], + ], + ], + ], + 'WorkspaceId' => [ + 'title' => '工作空间id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '15945', + ], + 'Accessibility' => [ + 'title' => '可见性', + 'description' => 'The accessibility of the image. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members can access the workspace.'."\n" + .'* PRIVATE: Only the creator can access the workspace.'."\n", + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'Size' => [ + 'description' => 'The size of the image. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SourceType' => [ + 'title' => '镜像来源类型', + 'description' => '镜像来源类型', + 'type' => 'string', + ], + 'SourceId' => [ + 'title' => '镜像来源 ID', + 'description' => '镜像来源 ID', + 'type' => 'string', + ], + ], + ], + ], + ], + '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模型压缩训练镜像\\\\n\\",\\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', + ], + 'ListImageLabels' => [ + 'summary' => 'Lists all tags of an image.', + '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 tag keys, separated with commas (,). System tags start with system and take effect independently from LabelFilter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.framework,system.official', + ], + ], + [ + 'name' => 'LabelFilter', + 'in' => 'query', + 'schema' => [ + 'title' => 'image过滤条件，获取满足条件的image的所有label', + 'description' => 'The tag filter conditions, separated with commas (,). The format of a single condition filter is `key=value`. Takes effect independently from LabelKeys.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.framework=XGBoost 1.6.0,system.official=true', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'title' => '镜像id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'image-4c62******53uor'."\n", + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The region where the image resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Labels' => [ + 'title' => '镜像标签', + 'description' => 'The image tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'system.chipType', + ], + 'Value' => [ + 'title' => '值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'GPU', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的数量', + 'description' => 'The total number of the images that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => 'ListImageLabels', + ], + 'ListImages' => [ + 'summary' => 'Queries a list of images.', + '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 image name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tensorflow_2.9', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页，从1开始，默认1', + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The field used for sorting. The GmtCreateTime field is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向： ASC - 升序 DESC - 降序', + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. This parameter must be used together with SortBy. Default value: ASC. Valid values:'."\n" + ."\n" + .'* ASC: ascending order'."\n" + .'* DESC: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'title' => '过滤值 以逗号分隔', + 'description' => 'The tag filter conditions. Multiple conditions are separated by commas (,). The format of a single condition filter is `key=value`. The following keys are supported:'."\n" + ."\n" + .'* system.chipType'."\n" + .'* system.dsw.cudaVersion'."\n" + .'* system.dsw.fromImageId'."\n" + .'* system.dsw.fromInstanceId'."\n" + .'* system.dsw.id'."\n" + .'* system.dsw.os'."\n" + .'* system.dsw.osVersion'."\n" + .'* system.dsw.resourceType'."\n" + .'* system.dsw.rootImageId'."\n" + .'* system.dsw.stage'."\n" + .'* system.dsw.tag'."\n" + .'* system.dsw.type'."\n" + .'* system.framework'."\n" + .'* system.origin'."\n" + .'* system.pythonVersion'."\n" + .'* system.source'."\n" + .'* system.supported.dlc'."\n" + .'* system.supported.dsw'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.framework=XGBoost 1.6.0,system.official=true'."\n", + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否显示非必要信息：Labels', + 'description' => 'Specifies whether to display non-essential information, which contains tags. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20******55', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image name and description that are used for fuzzy search.'."\n", + 'type' => 'string', + 'required' => false, + '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 visible to all users.'."\n" + .'* PRIVATE: The image is visible only to you and the administrator of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLIC', + ], + ], + [ + 'name' => 'ImageUri', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of returned images.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Images' => [ + 'title' => '镜像列表', + 'description' => 'The images.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the image.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'tensorflow_2.9', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the image is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Description' => [ + 'title' => '镜像描述', + 'description' => 'The image description.'."\n", + 'type' => 'string', + 'example' => 'desc', + ], + 'ImageUri' => [ + 'title' => '镜像地址，包含版本号', + 'description' => 'The image address, which includes the version number.'."\n", + 'type' => 'string', + 'example' => 'registry-vpc.cn-shanghai.aliyuncs.com/******/pai:python_3.8.10-tensorflow_2.9.0', + ], + 'Labels' => [ + 'title' => '镜像标签，是个map', + 'description' => 'The image tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Key', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'system.chipType', + ], + 'Value' => [ + 'title' => 'Value', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'GPU', + ], + ], + ], + ], + 'ImageId' => [ + 'title' => '镜像id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-tzi7f9******s45t', + ], + 'Accessibility' => [ + 'title' => '可见性', + 'description' => 'The accessibility of the image. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members can access the image.'."\n" + .'* PRIVATE: Only the creator can access the image.'."\n", + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the image is modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z'."\n", + ], + 'UserId' => [ + 'title' => '创建人', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '15577******82932', + ], + 'ParentUserId' => [ + 'title' => '父创建人', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '15577******82932', + ], + 'WorkspaceId' => [ + 'title' => '工作空间id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '20******55', + ], + 'Size' => [ + 'description' => 'The image size. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'SourceType' => [ + 'title' => '镜像来源类型', + 'description' => '镜像来源类型', + 'type' => 'string', + ], + 'SourceId' => [ + 'title' => '镜像来源 ID', + 'description' => '镜像来源 ID', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => 'ListImages', + ], + 'RemoveImage' => [ + 'summary' => 'Removes 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' => '镜像 id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'image-rbv******c9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'RemoveImage', + ], + 'PublishImage' => [ + 'summary' => 'Publishes an image. After the image is published, the visibility of the image is changed 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' => '镜像Id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'image-dk******fa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + ], + 'ImageId' => [ + 'title' => '镜像 id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-dk******fa', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\",\\n \\"ImageId\\": \\"image-dk******fa\\"\\n}","type":"json"}]', + 'title' => 'PublishImage', + ], + 'RemoveImageLabels' => [ + 'summary' => 'Removes an image tag.', + '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' => '镜像 Id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'image-d8df******dsjfd', + ], + ], + [ + 'name' => 'LabelKey', + 'in' => 'path', + 'schema' => [ + 'title' => 'label 的 key', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'RemoveImageLabels', + ], + 'CreateImageBuild' => [ + 'summary' => '创建镜像构建任务', + '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' => [ + 'title' => '幂等参数', + 'description' => '', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'body参数', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => '可见性', + 'description' => '镜像构建的可见性，可能值： - PUBLIC：当前工作空间所有成员都可以操作。 - PRIVATE：只有创建者可以操作。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PUBLIC', + ], + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => '镜像构建所属的工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + 'Resource' => [ + 'title' => '构建任务运行资源', + 'description' => '构建任务运行资源', + 'type' => 'object', + 'properties' => [ + 'EcsSpec' => [ + 'title' => '后付费资源规格', + 'description' => '后付费资源规格', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'ResourceConfig' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'Memory' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8Gi', + ], + ], + 'required' => false, + ], + 'ResourceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'quotaadzoqup693z', + ], + 'ResourceType' => [ + 'title' => '资源类型，使用预付费资源组时，此参数必填。当前仅支持 Lingjun', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Lingjun' => 'Lingjun', + ], + 'example' => 'Lingjun', + ], + ], + 'required' => true, + ], + 'UserVpc' => [ + 'title' => '用户专有网络信息', + 'description' => '用户专有网络信息。使用企业版 ACR 实例时，此参数必填，指定在用户 ACR 实例的访问控制里已添加的专有网络。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => '专有网络 ID', + 'description' => '专有网络 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-abcdef**', + ], + 'SwitchId' => [ + 'title' => '交换机 ID', + 'description' => '交换机 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vs-abcdef**', + ], + 'SecurityGroupId' => [ + 'title' => '安全组 ID', + 'description' => '安全组 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-abcdef**', + ], + 'ExtendedCidrs' => [ + 'title' => '扩展网段', + 'description' => '扩展网段', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'CIDR', + ], + 'required' => false, + ], + 'DefaultRoute' => [ + 'title' => '默认路由网卡出口', + 'description' => '默认路由网卡出口', + 'type' => 'string', + 'required' => false, + 'example' => 'eth1', + ], + ], + 'required' => false, + ], + 'TargetRegistry' => [ + 'title' => '目标镜像服务配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-**abcd', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'AcrEnterprise', + ], + ], + 'required' => true, + ], + 'OverwriteImageTag' => [ + 'title' => '是否覆盖更新镜像', + 'description' => '是否覆盖更新 ACR 镜像仓库中已存在的镜像 tag。', + 'type' => 'boolean', + 'required' => false, + ], + 'BuildConfig' => [ + 'title' => '构建配置', + 'description' => '构建配置，指定待构建的 Dockerfile 文件内容。', + 'type' => 'object', + 'properties' => [ + 'Dockerfile' => [ + 'title' => 'Dockerfile文件内容', + 'description' => 'Dockerfile文件内容', + 'type' => 'string', + 'required' => true, + 'example' => 'FROM ubuntu:18:04'."\n" + .'RUN pip3 install numpy==1.19.5', + ], + 'BuildType' => [ + 'title' => 'BuildType 当前支持以下两种类型：'."\n" + .'PackageInstallation ： 基于指定镜像安装软件包。'."\n" + .'CustomDockerfile：基于定制 Dockerfile。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PackageInstallation', + ], + 'RegistryAuths' => [ + 'title' => '私有仓库鉴权信息。', + 'description' => '', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com": {'."\n" + .' "Auth": "dXNlcjp0ZXN0"'."\n" + .' }'."\n" + .'}', + ], + ], + 'required' => true, + ], + 'RegionId' => [ + 'title' => '地域ID', + 'description' => '代表region的资源属性字段', + 'type' => 'string', + 'required' => false, + ], + 'ImageBuildJobName' => [ + 'title' => '镜像构建任务名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'build-my-image', + ], + 'Image' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-v1', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Uri' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com/pai-test/pai-test:test-v1', + ], + 'Labels' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ImageBuildId' => [ + 'title' => '资源一级ID', + 'description' => '代表资源一级ID的资源属性字段', + 'type' => 'string', + 'example' => 'build-****ks92', + ], + 'ImageBuildJobId' => [ + 'title' => '构建任务 ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'dlc-****ks92', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageBuildId\\": \\"build-****ks92\\",\\n \\"ImageBuildJobId\\": \\"dlc-****ks92\\"\\n}","type":"json"}]', + ], + 'ListPermissions' => [ + 'summary' => 'Lists the permissions that a user has 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' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2AE63638-5420-56DC-B******8174039A0', + ], + 'Permissions' => [ + 'title' => '权限列表', + 'description' => 'The permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission.'."\n", + 'type' => 'object', + 'properties' => [ + 'PermissionCode' => [ + 'title' => '权限 code', + 'description' => 'The permission name, which is unique in a region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~). The example value PaiDLC:GetTensorboard indicates the permission to view details about a TensorBoard job on the Deep Learning Containers (DLC) page.'."\n", + 'type' => 'string', + 'example' => 'PaiDLC:GetTensorboard', + ], + 'PermissionRules' => [ + 'description' => 'The permission rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', + 'description' => 'The accessibility of the permission rule. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members in the workspace can access the permission rule.'."\n" + .'* PRIVATE: Only the creator can access the permission rule.'."\n" + .'* ANY: All users can access the permission rule.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'EntityAccessType' => [ + 'title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', + 'description' => 'The type of access. If you set Accessibility to PUBLIC, all users can access the workspace. This parameter is invalid. If you set Accessibility to PRIVATE, the permissions are determined based on the value of EntityAccessType. The value of EntityAccessType can be:'."\n" + ."\n" + .'* CREATOR: Only the creator can access the workspace.'."\n" + .'* ANY: All users can access the workspace.'."\n", + 'type' => 'string', + 'example' => 'CREATOR', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的数量', + 'description' => 'The number of permissions that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'ListPermissions', + ], + 'GetPermission' => [ + 'summary' => 'Obtains permissions on 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' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'PermissionCode', + 'in' => 'path', + 'schema' => [ + 'title' => '权限 code', + 'description' => 'The permission name, which is unique in a region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~). For more information about how to obtain the permission name, see [ListPermissions](~~449132~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PaiDLC:GetTensorboard'."\n", + ], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => [ + 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', + 'description' => 'The accessibility. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members in the workspace can access the workspace.'."\n" + .'* PRIVATE: Only the creator can access the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLIC', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => [ + 'title' => '创建者', + 'description' => 'The UID of the Alibaba Cloud account that is used to create the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '17915******4216', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'job/dlc-ksd******s12', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration. Separate multiple configurations with commas (,). Valid values:'."\n" + ."\n" + .'* ResourceEmpty: The Resource parameter is not configured.'."\n" + .'* DisableRam: The RAM check is not performed.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceEmpty,DisableRam', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + ], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'PermissionCode' => [ + 'title' => '权限', + 'description' => 'The permission name, which is unique in a region. For more information about permissions, see [Appendix: Roles and permissions](~~2840449~~).'."\n", + 'type' => 'string', + 'example' => 'PaiDLC:ListJobs', + ], + 'PermissionRules' => [ + 'description' => 'The permission rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'title' => '待鉴权实例的可见性 PUBLIC表示当前工作空间所有人都可以访问 PRIVATE表示只有Owner可以访问', + 'description' => 'The accessibility. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members can access the workspace.'."\n" + .'* PRIVATE: Only the creator can access the workspace.'."\n" + .'* ANY: All users can access the workspace.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'EntityAccessType' => [ + 'title' => '存取类型 CREATOR 代表能看自已创建的 OTHERS 代表可以看别人创建的 ALL代表所有', + 'description' => 'The access type. If you set Accessibility to PUBLIC, all users can access the workspace. This parameter is invalid. If you set Accessibility to PRIVATE, the value of this parameter can be:'."\n" + ."\n" + .'* PRIVATE: Only the creator can access the workspace.'."\n" + .'* ANY: All users can access the workspace.'."\n", + 'type' => 'string', + 'example' => 'CREATOR', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetPermission', + ], + 'DeleteWorkspaceResource' => [ + 'summary' => 'Deletes a resource from a workspace. The resource is not deleted at the underlying layer.', + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => '**This field is no longer used and will be removed. Use the ResourceType field instead.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLC', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group. You can call [ListResources](~~449143~~) to obtain the name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to perform. Valid values:'."\n" + ."\n" + .'* DetachAndDelete: disassociates a resource from a workspace and deletes the resource in the workspace. This is the default value.'."\n" + .'* Detach: disassociates a resource group from a workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DetachAndDelete', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'* ECS'."\n" + .'* Lingjun'."\n" + .'* ACS'."\n" + .'* FLINK'."\n" + .'* MaxCompute (This resource type is valid only if Option is set to Detach.)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DLC', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags. Multiple tags are separated by commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.supported.eas=true', + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource IDs. Multiple resource IDs are separated by commas (,). The GroupName values for the specified resources must be the same. You cannot leave both GroupName and ResourceIds empty. You can specify both parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Resource-dks******jkf,Resource-adf******dss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'ResourceIds' => [ + 'description' => 'The resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'Resource-dks******jkf', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\"\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteWorkspaceResource', + ], + 'UpdateWorkspaceResource' => [ + 'summary' => 'Updates the resources of a workspace.', + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'IsDefault' => [ + 'title' => '是否默认资源实例，目前只能填 true，不支持填 false', + 'description' => 'Specifies whether the resource is the default resource. This parameter can only be set to true and cannot be set to false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ProductType' => [ + 'description' => '**This field is no longer used and will be removed. Use the ResourceType field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + 'GroupName' => [ + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group-kjds******sd', + ], + 'ResourceType' => [ + 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'* MaxCompute'."\n" + .'* ECS'."\n" + .'* Lingjun'."\n" + .'* ACS'."\n" + .'* FLINK'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + 'Labels' => [ + 'description' => 'The resource tags. If you specify multiple tags, only resources that meet all the specified tag-based filter conditions are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.******', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'True', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ResourceIds' => [ + 'description' => 'The resource IDs.'."\n" + ."\n" + .'You cannot leave both GroupName and ResourceIds empty. If you specify both the parameters, the value of GroupName of each resource ID in the dataset must be the same.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Resource-dks******jkf', + ], + 'required' => false, + ], + 'Spec' => [ + 'description' => 'The specification of the resource.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "clusterType": "share"'."\n" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'ResourceIds' => [ + 'description' => 'The updated resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The updated resource ID.'."\n", + 'type' => 'string', + 'example' => 'Resource-dks******jkf'."\n", + ], + 'example' => 'Resource-dks******jkf', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ResourceIds\\": [\\n \\"Resource-dks******jkf\\\\n\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<UpdateWorkspaceResourceResponse>\\n <RequestId>1e195c5116124202371861018d5bde</RequestId>\\n</UpdateWorkspaceResourceResponse>","errorExample":""}]', + 'title' => 'UpdateWorkspaceResource', + ], + 'ListResources' => [ + 'summary' => 'Queries the resources that are 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' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n" + ."\n" + .'* This parameter is required when the Option parameter is set to ListResourceByWorkspace.'."\n" + .'* You do not need to configure this parameter when the Option parameter is set to ListResource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页，从1开始，默认1', + 'description' => 'The page number. The pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProductTypes', + 'in' => 'query', + 'schema' => [ + 'title' => '逗号分隔的产品类型，可选值 MaxCompute，DLC', + 'description' => '**This field is no longer used and will be removed. Use the ResourceType field instead.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '资源的group名字', + 'description' => 'The name of the resource group. You can call [ListResources](~~449143~~) to obtain the name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group', + ], + ], + [ + 'name' => 'ResourceName', + 'in' => 'query', + 'schema' => [ + 'title' => '资源的名字', + 'description' => 'The resource name. The value must meet the following requirements:'."\n" + ."\n" + .'* The name must be 3 to 28 characters in length.'."\n" + .'* The name is unique in the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'resource', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'schema' => [ + 'title' => '选项，目前支持 ListResourceByWorkspace 列举某个工作空间的资源 GetResource 获取所有工作空间下的资源 GetResourceGroup 获取所有工作空间下的资源组 ListResourceSummaryByWorkspaces 列举一组工作空间的资源汇总', + 'description' => 'The operation to perform. Valid values:'."\n" + ."\n" + .'* ListResourceByWorkspace: obtains the resources in the workspace. This is the default value.'."\n" + .'* ListResource: obtains the resources of the user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ListResourceByWorkspace', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to show detailed information, which includes the Quotas field. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource types. Valid values:'."\n" + ."\n" + .'* MaxCompute'."\n" + .'* ECS'."\n" + .'* Lingjun'."\n" + .'* ACS'."\n" + .'* FLINK'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + ], + [ + 'name' => 'QuotaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The quota IDs, which are separated by commas (,). Only resources that contain all the specified quotas are returned.'."\n" + ."\n" + .'> This parameter is available only for resources whose ResourceTypes is ACS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'quota-k******da,quota-cd******w', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tag-based filter conditions. Multiple conditions are separated by commas (,). Only resources that meet all the specified tag-based filter conditions are returned.'."\n" + ."\n" + .'This parameter is available only for resources whose ProductType is ACS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.supported.dsw=true,system.supported.dlc=true', + ], + ], + [ + 'name' => 'VerboseFields', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fields to return. Multiple fields are separated by commas (,). Valid values:'."\n" + ."\n" + .'* Quota'."\n" + .'* Label'."\n" + .'* IsDefault'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Quota,IsDefault', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1e195c5116124202371861018d5bde', + ], + 'Resources' => [ + 'title' => '资源列表', + 'description' => 'The resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源 id', + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'Name' => [ + 'title' => '资源名 长度需要在3到27个字符 region内唯一', + 'description' => 'The resource name.'."\n", + 'type' => 'string', + 'example' => 'ResourceName', + ], + 'ProductType' => [ + 'title' => '产品类型， 支持PAI，MaxCompute', + 'description' => '**This field is no longer used and will be removed. Use the ResourceType field.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'EnvType' => [ + 'title' => '环境， 支持dev（开发）、prod（生产）', + 'description' => 'The environment type. Valid values:'."\n" + ."\n" + .'* dev: development environment'."\n" + .'* prod: production environment'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + 'WorkspaceId' => [ + 'title' => '所属的工作空间 id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'IsDefault' => [ + 'title' => '是否默认资源 每个类型都有一个默认的资源', + 'description' => 'Indicates whether the resource is the default resource. Each type of resources has a default resource. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Quotas' => [ + 'description' => 'The quotas.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a quota.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '配额名称', + 'description' => 'The quota name.'."\n", + 'type' => 'string', + 'example' => 'QuotaName', + ], + 'ProductCode' => [ + 'title' => '商品 code', + 'description' => 'The product code. Valid values:'."\n" + ."\n" + .'* PAI_isolate: CPU subscription resource groups of PAI'."\n" + .'* PAI_share: GPU pay-as-you-go resource groups of PAI'."\n" + .'* MaxCompute_share: pay-as-you-go resource groups of MaxCompute'."\n" + .'* MaxCompute_isolate: subscription resource groups of MaxCompute'."\n" + .'* DataWorks_isolate: subscription resource groups of DataWorks'."\n" + .'* DataWorks_share: pay-as-you-go resource groups of DataWorks'."\n" + .'* DLC_share: pay-as-you-go resource groups of Deep Learning Containers (DLC)'."\n", + 'type' => 'string', + 'example' => 'MaxCompute_isolate', + ], + 'QuotaType' => [ + 'title' => '产品类型， 支持PAI，MaxCompute', + 'description' => 'The quota type. Valid values:'."\n" + ."\n" + .'* PAI'."\n" + .'* MaxCompute'."\n" + .'* DLC'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'Mode' => [ + 'title' => '模式 isolate 预付费 share 后付费 develop 开发模式', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* isolate: subscription'."\n" + .'* share: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'develop', + ], + 'Specs' => [ + 'title' => '规格描述列表', + 'description' => 'The quota specifications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The specification information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '规格名字', + 'description' => 'The specification name.'."\n", + 'type' => 'string', + 'example' => 'cu', + ], + 'Value' => [ + 'title' => '规格描述', + 'description' => 'The specification description.'."\n", + 'type' => 'string', + 'example' => '11500', + ], + ], + ], + 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', + ], + 'CardType' => [ + 'title' => '卡类型，支持cpu、gpu', + 'description' => 'The resource group type. Valid values:'."\n" + ."\n" + .'* CPU'."\n" + .'* GPU'."\n", + 'type' => 'string', + 'example' => 'cpu', + ], + 'Id' => [ + 'title' => '配额id', + 'description' => 'The quota ID.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'DisplayName' => [ + 'description' => 'The alias of the quota.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Spec' => [ + 'title' => '对于MaxCompute是个json，有如下key： Endpoint Project', + 'description' => 'The resource specification.'."\n", + 'type' => 'object', + 'example' => '对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}', + ], + 'GroupName' => [ + 'title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', + 'description' => 'The name of the resource group, which is unique within the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => 'groupName', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the resource group is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Executor' => [ + 'description' => 'This parameter is invalid and deprecated.'."\n", + 'type' => 'object', + 'properties' => [ + 'OwnerId' => [ + 'description' => 'This parameter is invalid and deprecated.'."\n", + 'type' => 'string', + 'example' => '110973******7793', + ], + ], + ], + 'Encryption' => [ + 'description' => 'The encryption information, which is valid only for MaxCompute resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => 'Indicates whether the resources are encrypted.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Algorithm' => [ + 'description' => 'The encryption algorithm.'."\n", + 'type' => 'string', + 'example' => 'AESCTR', + ], + 'Key' => [ + 'description' => 'The primary key for the encryption.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT', + ], + ], + ], + 'ResourceType' => [ + 'description' => 'The resource type. Valid values:'."\n" + ."\n" + .'* MaxCompute'."\n" + .'* DLC'."\n" + .'* FLINK'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'system.supported.dsw', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的作业数量', + 'description' => 'The number of resources that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<ListResourcesResponse>\\n <RequestId>1e195c5116124202371861018d5bde</RequestId>\\n <Resources>\\n <id>123</id>\\n <Name>ResourceName</Name>\\n <ProductType>MaxCompute</ProductType>\\n <EnvType>prod</EnvType>\\n <WorkspaceId>123</WorkspaceId>\\n <IsDefault>true</IsDefault>\\n <Quotas>\\n <Name>QuotaName</Name>\\n <ProductCode>MaxCompute_isolate</ProductCode>\\n <QuotaType>MaxCompute</QuotaType>\\n <Mode>develop</Mode>\\n <Specs>\\n <Name>quota</Name>\\n <Value>{\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}</Value>\\n </Specs>\\n <CardType>cpu</CardType>\\n <Id>123</Id>\\n </Quotas>\\n <GroupName>groupName</GroupName>\\n <GmtCreateTime>2021-01-21T17:12:35.232Z</GmtCreateTime>\\n <ResourceSummary>\\n <ProductType>DLC</ProductType>\\n <Count>2</Count>\\n </ResourceSummary>\\n </Resources>\\n <TotalCount>2</TotalCount>\\n</ListResourcesResponse>","errorExample":""}]', + 'title' => 'ListResources', + ], + 'CreateWorkspaceResource' => [ + 'summary' => 'Associates resources with a workspace.', + 'path' => '/api/v1/workspaces/{WorkspaceId}/resources', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Resources' => [ + 'title' => '资源列表', + 'description' => 'The resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '资源名 长度需要在3到27个字符 region内唯一', + 'description' => 'The resource name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must be 3 to 28 characters in length, and can contain only letters, digits, and underscores (\\_). The name must start with a letter.'."\n" + .'* The name must be unique in the region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ResourceName', + ], + 'ProductType' => [ + 'title' => '产品类型， 支持PAI，MaxCompute', + 'description' => '**This parameter is no longer used and will be removed. Use the ResourceType parameter instead.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + 'EnvType' => [ + 'title' => '环境， 支持dev（开发）、prod（生产）', + 'description' => 'The environment type. Valid values:'."\n" + ."\n" + .'* dev: development environment'."\n" + .'* prod: production environment'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'prod', + ], + 'WorkspaceId' => [ + 'title' => '所属的工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + 'IsDefault' => [ + 'title' => '是否默认资源 每个类型都有一个默认的资源', + 'description' => 'Specifies whether the resource is the default resource. Each type of resources has a default resource. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Quotas' => [ + 'description' => 'The quotas. Only MaxCompute quotas are available.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The quota.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '配额名称', + 'description' => 'The quota ID. You can call [ListQuotas](~~449144~~) to obtain the quota ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '232892******92912', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Spec' => [ + 'description' => 'The resource specifications in the JSON format.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '', + 'title' => '', + ], + 'GroupName' => [ + 'title' => '分组名，主账户内唯一 一个 GroupName 下可能有一个 dev 资源和一个 prod 资源', + 'description' => 'The name of the resource group, which is unique within your Alibaba Cloud account. This parameter is required for MaxCompute, Elastic Compute Service (ECS), Lingjun, Alibaba Cloud Container Compute Service (ACS), and Realtime Compute for Apache Flink resources.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'groupName', + ], + 'ResourceType' => [ + 'description' => 'The resource types. Valid values:'."\n" + ."\n" + .'* MaxCompute'."\n" + .'* ECS'."\n" + .'* Lingjun'."\n" + .'* ACS'."\n" + .'* FLINK'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MaxCompute', + ], + 'Labels' => [ + 'description' => 'The labels added to the resource.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The label key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system.support.eas', + ], + 'Value' => [ + 'description' => 'The label value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'Option' => [ + 'description' => 'The operation to perform. Valid values:'."\n" + ."\n" + .'* CreateAndAttach: creates resources and associates the resources with a workspace.'."\n" + .'* Attach: associates resources with a workspace.'."\n" + ."\n" + .'> MaxCompute supports only the Attach operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateAndAttach', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1e195c5116124202371861018d5bde', + ], + 'Resources' => [ + 'title' => '资源集合', + 'description' => 'The resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源Id', + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of resources.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"Resources\\": [\\n {\\n \\"Id\\": \\"1234\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + 'title' => 'CreateWorkspaceResource', + ], + 'AddMemberRole' => [ + 'summary' => 'Adds a role to a member in a workspace. After you add a role to a member, the member is granted the permissions of the role.', + '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' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'path', + 'schema' => [ + 'title' => '成员 id', + 'description' => 'The member ID. You can call [ListMembers](~~449135~~) to obtain the member ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883-215139******688039', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'path', + 'schema' => [ + 'title' => '角色', + 'description' => 'The name of the role. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](~~2840449~~). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PAI.AlgoDeveloper', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'AddMemberRole', + ], + 'RemoveMemberRole' => [ + 'summary' => 'Removes a member role.', + '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' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'path', + 'schema' => [ + 'title' => '成员 id', + 'description' => 'The member ID. You can call [ListMembers](~~449135~~) to obtain the member ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883-21513926******88039', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'path', + 'schema' => [ + 'title' => '角色', + 'description' => 'The role name. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](~~2840449~~). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PAI.AlgoDeveloper', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'RemoveMemberRole', + ], + 'DeleteMembers' => [ + 'summary' => 'Deletes a member 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' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883', + ], + ], + [ + 'name' => 'MemberIds', + 'in' => 'query', + 'schema' => [ + 'title' => '需要删除的成员 Id 列表，以逗号分隔', + 'description' => 'The list of member IDs. Separate multiple member IDs with commas (,). You can call [ListMembers](~~449135~~) to obtain the member ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883-21513926******88039,145883-2769726******87513', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', + ], + 'Code' => [ + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => '100600017', + ], + 'Message' => [ + 'description' => 'The error message returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'Owner not allowed to delete', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\",\\n \\"Code\\": \\"100600017\\",\\n \\"Message\\": \\"Owner not allowed to delete\\"\\n}","type":"json"}]', + 'title' => 'DeleteMembers', + ], + 'GetMember' => [ + 'summary' => 'Obtains a member in a workspace.', + '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' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '用户id', + 'description' => 'The ID of the Alibaba Cloud account. You can call [ListWorkspaceUsers](~~449133~~) to obtain the ID of the Alibaba Cloud account. You must specify only one of the following parameters: UserId and MemberId.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '21513926******88039', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The member ID. You must specify only one of the following parameters: UserId and MemberId.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '145883-21513926******88039', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'UserId' => [ + 'title' => '用户 id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '21513926******88039', + ], + 'MemberName' => [ + 'title' => '云账号用户名', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Roles' => [ + 'title' => '角色列表', + 'description' => 'The list of roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the role. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](https://pai.console.aliyun.com/?spm=api-workbench.API%20Explorer.0.0.7a862392uO09Se\\®ionId=cn-shanghai#/workspace/permission). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'example' => 'myRole1', + ], + ], + 'DisplayName' => [ + 'title' => '成员显示名', + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'myDisplayName', + ], + 'MemberId' => [ + 'title' => '成员 id', + 'description' => 'The member ID.'."\n", + 'type' => 'string', + 'example' => '145883-21513926******88039'."\n", + ], + 'AccountType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetMember', + ], + 'ListMembers' => [ + 'summary' => 'Obtains the members in a workspace.', + 'path' => '/api/v1/workspaces/{WorkspaceId}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '14243', + 'abilityTreeNodes' => [ + 'FEATURElearnZBMZHZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页，从1开始，默认1', + 'description' => 'The page number of the workspace list. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Roles', + 'in' => 'query', + 'schema' => [ + 'title' => 'Role 过滤列表，逗号分隔', + 'description' => 'The roles that are used to filter members. Multiple roles are separated by commas (,). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAI.AlgoDeveloper', + ], + ], + [ + 'name' => 'MemberName', + 'in' => 'query', + 'schema' => [ + 'title' => '成员名', + 'description' => 'The member name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zhangsan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Members' => [ + 'title' => '成员列表', + 'description' => 'The members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The member details.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户 id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '215139******88039', + ], + 'MemberName' => [ + 'title' => '云账号用户名', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the user is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Roles' => [ + 'title' => '角色列表', + 'description' => 'The list of roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The names of the roles. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](~~2840449~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'example' => 'PAI.AlgoDeveloper', + ], + ], + 'DisplayName' => [ + 'title' => '成员显示名', + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'example' => 'myDisplayName', + ], + 'MemberId' => [ + 'title' => '成员 id', + 'description' => 'The member ID.'."\n", + 'type' => 'string', + 'example' => '14588*****51688039', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'AccountType' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的数量', + 'description' => 'The number of members that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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\\": \\"\\",\\n \\"AccountType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": 1\\n}","type":"json"}]', + 'title' => 'ListMembers', + ], + 'CreateMember' => [ + 'summary' => 'Adds a user to a workspace as a member. You can add multiple users as members.', + 'path' => '/api/v1/workspaces/{WorkspaceId}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Members' => [ + 'title' => '用户列表', + 'description' => 'The members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the members.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户 id', + 'description' => 'The member IDs. Multiple member IDs are separated by commas (,). You can call [ListMembers](~~449135~~) to obtain the member IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '21513926******88039', + ], + 'Roles' => [ + 'title' => '角色列表', + 'description' => 'The list of roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the role. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAI.AlgoDeveloper', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', + ], + 'Members' => [ + 'title' => '成员列表', + 'description' => 'The returned members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户 id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '21513926******88039'."\n", + ], + 'Roles' => [ + 'title' => '角色列表', + 'description' => 'The list of roles.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The names of the roles. For more information about the mappings between role names and permissions, see [Appendix: Roles and permissions](https://pai.console.aliyun.com/?regionId=cn-shanghai#/workspace/permission). Valid values:'."\n" + ."\n" + .'* PAI.AlgoDeveloper: algorithm developer'."\n" + .'* PAI.AlgoOperator: algorithm O\\&M engineer'."\n" + .'* PAI.LabelManager: labeling administrator'."\n" + .'* PAI.MaxComputeDeveloper: MaxCompute developer'."\n" + .'* PAI.WorkspaceAdmin: administrator'."\n" + .'* PAI.WorkspaceGuest: guest'."\n" + .'* PAI.WorkspaceOwner: owner'."\n", + 'type' => 'string', + 'example' => 'PAI.AlgoDeveloper', + ], + ], + 'DisplayName' => [ + 'title' => '成员显示名', + 'description' => 'The display name.'."\n", + 'type' => 'string', + 'example' => 'myDisplayName', + ], + 'MemberId' => [ + 'title' => '成员 id', + 'description' => 'The member ID.'."\n", + 'type' => 'string', + 'example' => '145883-21513926******88039'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'CreateMember', + ], + 'UpdateConfigs' => [ + 'summary' => 'Updates or adds 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' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '83***', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'title' => '配置列表', + 'description' => 'The list of workspace configurations to update or add.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A workspace configuration item to update or add.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item. Supported keys:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: The predefined tags of the workspace. All created resources must have tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tempStoragePath', + ], + 'ConfigValue' => [ + 'title' => '配置值', + 'description' => 'The value of the configuration item.'."\n" + ."\n" + .'* When ConfigKey is predefinedTags, the ConfigValue follows this format: \\[{"Type":"Tag","Key":"Key1","Value":"{"Products":"DLC,DSW,EAS","Values":"value1,value2,value3"}"}]. "Products" indicates the products that use the predefined tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test/s/', + ], + 'CategoryName' => [ + 'description' => 'The category of the configuration item. Supported categories:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle'."\n" + .'* DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CommonResourceConfig', + ], + 'Labels' => [ + 'description' => 'The tags of the configuration item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A key of the configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'UpdateConfigs', + ], + 'GetConfig' => [ + 'summary' => 'Obtains a workspace configuration item.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1234******2', + ], + ], + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the configuration item. Valid values:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle'."\n" + .'* DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CommonResourceConfig', + ], + ], + [ + 'name' => 'ConfigKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the configuration item. Valid values:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* priorityConfig: Priority configuration. This key can be used only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: Predefined tags of the workspace. Created resources must include tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tempStoragePath', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234******2'."\n", + ], + 'ConfigKey' => [ + 'description' => 'The key of the configuration item. Valid values:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* priorityConfig: Priority configuration. This key can be used only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: Predefined tags of the workspace. Created resources must include tags.'."\n", + 'type' => 'string', + 'example' => 'tempStoragePath', + ], + 'ConfigValue' => [ + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'oss://***', + ], + 'CategoryName' => [ + 'description' => 'The category of the configuration item. Valid values:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle'."\n" + .'* DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'example' => 'CommonResourceConfig', + ], + 'Labels' => [ + 'description' => 'The tags of the configuration item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A tag of the configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'GmtCreateTime' => [ + 'type' => 'string', + ], + 'GmtModifiedTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => 'GetConfig', + ], + 'ListConfigs' => [ + 'summary' => 'Obtains a list of workspace configurations.', + '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' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '87***', + ], + ], + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the configuration item. Supported categories:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle'."\n" + .'* DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CommonResourceConfig', + ], + ], + [ + 'name' => 'ConfigKeys', + 'in' => 'query', + 'schema' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item. Supported keys:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* priorityConfig: Priority configuration. This key can be used only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: The predefined tags of the workspace. All created resources must have tags'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tempStoragePath', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tags used as filter conditions. Separate multiple tags with commas (,). These conditions are in an AND relationship.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1=value1,key2=value2', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to show the tag information.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", + ], + 'Configs' => [ + 'title' => '配置列表', + 'description' => 'The configuration items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item. Supported keys:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: The predefined tags of the workspace. All created resources must have tags'."\n", + 'type' => 'string', + 'example' => 'tempTableLifecycle', + ], + 'ConfigValue' => [ + 'title' => '配置值', + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'oss://***'."\n", + ], + 'Labels' => [ + 'description' => 'The tags of the configuration item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A key of the configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'value1'."\n", + ], + ], + ], + ], + 'GmtCreateTime' => [ + 'type' => 'string', + ], + 'GmtModifiedTime' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '返回数量', + 'description' => 'The number of items returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => 'ListConfigs', + ], + 'DeleteConfig' => [ + 'summary' => 'Deletes workspace configurations.', + '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' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '98***', + ], + ], + [ + 'name' => 'ConfigKey', + 'in' => 'path', + 'schema' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item. Valid values:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* priorityConfig: Priority configuration. This key can be used only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: Predefined tags of the workspace. Created resources must include tags.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tempStoragePath', + ], + ], + [ + 'name' => 'CategoryName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the configuration item. Valid values:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle - DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CommonResourceConfig', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter conditions. Separate multiple conditions with commas (,). The conditions have an AND relationship.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1=value;key2=value2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'DeleteConfig', + ], + 'UpdateConfig' => [ + 'summary' => 'Updates or adds a workspace configuration item.', + '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 workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1234******2'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'description' => 'The key of the configuration item. Valid values:'."\n" + ."\n" + .'* tempStoragePath: Temporary storage path. This key can be used only when CategoryName is set to CommonResourceConfig.'."\n" + .'* isAutoRecycle: Automatic recycle configuration. This key can be used only when CategoryName is set to DLCAutoRecycle.'."\n" + .'* priorityConfig: Priority configuration. This key can be used only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig.'."\n" + .'* quotaMaximumDuration: Maximum run time of DLC jobs for a quota. This key can be used only when CategoryName is set to QuotaMaximumDuration.'."\n" + .'* predefinedTags: Preset tags of the workspace. Created resources must include tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tempStoragePath', + ], + 'ConfigValue' => [ + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://***'."\n", + ], + 'CategoryName' => [ + 'description' => 'The category of the configuration item. Valid values:'."\n" + ."\n" + .'* CommonResourceConfig'."\n" + .'* DLCAutoRecycle'."\n" + .'* DLCPriorityConfig'."\n" + .'* DSWPriorityConfig'."\n" + .'* QuotaMaximumDuration'."\n" + .'* CommonTagConfig'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CommonResourceConfig', + ], + 'Labels' => [ + 'description' => 'The tags of the configuration item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag of the configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A******C83E'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A******C83E\\\\n\\"\\n}","type":"json"}]', + 'title' => 'UpdateConfig', + ], + 'ListWorkspaces' => [ + 'summary' => 'Lists all workspaces in a region.', + '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' => '分页，从1开始，默认1', + 'description' => 'The page number of the workspace list. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小，默认20', + 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段：CreateTime', + 'description' => 'Specifies how to sort the results. Default value: GmtCreateTime. Valid values:'."\n" + ."\n" + .'* GmtCreateTime: Sort by the time when created.'."\n" + .'* GmtModifiedTime: Sort by the time when modified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向： ASC - 升序 DESC - 降序', + 'description' => 'The order of results (ascending or descending). Valid values:'."\n" + ."\n" + .'* ASC: ascending order. This is the default value.'."\n" + .'* DESC: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'WorkspaceName', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间名字', + 'description' => 'The name of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'ModuleList', + 'in' => 'query', + 'schema' => [ + 'title' => '逗号分割的模块列表，目前填入PAI', + 'description' => 'The modules, separated by commas (,). Default value: PAI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAI', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态', + 'description' => 'The workspace status. Valid values:'."\n" + ."\n" + .'* ENABLED'."\n" + .'* INITIALIZING'."\n" + .'* FAILURE'."\n" + .'* DISABLED'."\n" + .'* FROZEN'."\n" + .'* UPDATING'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'schema' => [ + 'title' => '逗号分隔的选项', + 'description' => 'The query options. Valid values:'."\n" + ."\n" + .'* GetWorkspaces (default): Obtains a list of Workspaces.'."\n" + .'* GetResourceLimits: Obtains a list of ResourceLimits.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GetWorkspaces', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否显示详细信息，默认true', + 'description' => 'Specifies whether to display workspace details. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'title' => 'GetWorkspaceFields的Field字段', + 'description' => 'The list of returned fields of workspace details. Used to limit the fields in the returned results. Separate multiple fields with commas (,). Currently, only Id is supported, which is the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Id', + ], + ], + [ + 'name' => 'WorkspaceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id列表', + 'description' => 'The workspace IDs. Separate multiple IDs by commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123,234', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID. To obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwp7rky****', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + '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.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Workspace details.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'WorkspaceName' => [ + 'title' => '工作空间名字', + 'description' => 'The name of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace-example', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace was created. The time (UTC+0) follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ss.SSSZ format.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace was modified. The time (UTC+0) follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ss.SSSZ format.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The description of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace description example', + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => 'The user ID of the creator.'."\n", + 'type' => 'string', + 'example' => '122424353535', + ], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式', + 'description' => 'The environment types of the workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment type of the workspace. Valid values:'."\n" + ."\n" + .'* Workspaces in basic mode can run only in the production environment (prod).'."\n" + .'* Workspaces in standard mode can run in both the development and production environments (dev and prod).'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Status' => [ + 'title' => '工作空间状态', + 'description' => 'The status of the workspace.'."\n", + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'AdminNames' => [ + 'title' => '管理员名字', + 'description' => 'The names of the administrator accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the administrator account.'."\n", + 'type' => 'string', + 'example' => 'demo_test@***.aliyunid.com', + ], + ], + 'IsDefault' => [ + 'title' => '是否为默认工作空间', + 'description' => 'Indicates whether the workspace is the default workspace.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExtraInfos' => [ + 'title' => '附加信息', + 'description' => 'the additional information. Only contains TenantId.'."\n", + 'type' => 'object', + 'example' => '{"TenantId": "4286******98"}', + ], + 'resourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmwp7rky****', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的作业数量', + 'description' => 'The number of workspaces that meet the query conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ResourceLimits' => [ + 'title' => '资源限制', + 'description' => 'The type and quantity of resources that can be activated in a workspace. This list is returned when the Option is set to GetResourceLimits. Valid values:'."\n" + ."\n" + .'* MaxCompute_share: pay-as-you-go MaxCompute'."\n" + .'* MaxCompute_isolate: subscription MaxCompute'."\n" + .'* DLC_share: pay-as-you-go DLC'."\n" + .'* PAI_Isolate: subscription PAI'."\n" + .'* PAI_share: pay-as-you-go PAI'."\n" + .'* DataWorks_isolate: subscription DataWorks'."\n" + .'* DataWorks_share: pay-as-you-go DataWorks'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "MaxCompute_share": 1,'."\n" + .' "MaxCompute_isolate": 1,'."\n" + .' "DLC_share": 1'."\n" + .'}', + ], + ], + ], + ], + ], + '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 }\\n ],\\n \\"TotalCount\\": 1,\\n \\"ResourceLimits\\": {\\n \\"MaxCompute_share\\": 1,\\n \\"MaxCompute_isolate\\": 1,\\n \\"DLC_share\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListWorkspaces', + 'description' => 'You can use the option parameter to specify query options, so as to obtain different information about the workspaces.'."\n", + ], + '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 body.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceName' => [ + 'title' => '名字 3-23 个字符, 需要字母开头，只能包含字母下划线和数字，region内唯一', + 'description' => 'The name of the workspace. Format:'."\n" + ."\n" + .'* The name must be 3 to 23 characters in length, and can contain letters, underscores (\\_), and digits.'."\n" + .'* The name must start with a letter.'."\n" + .'* It must be unique in the current region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'workspace_example', + ], + 'Description' => [ + 'title' => '描述，最多80个字符', + 'description' => 'The description of the workspace. The description can be up to 80 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'description', + ], + 'DisplayName' => [ + 'title' => '显示名称', + 'description' => 'The display name of the workspace. You can set it based on the purpose of the workspace. If left empty, the name of the workspace is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'display name', + ], + 'EnvTypes' => [ + 'title' => '环境列表', + 'description' => 'The environment of the workspace.'."\n" + ."\n" + .'* Workspaces in basic mode can run only in the production environment (prod).'."\n" + .'* Workspaces in standard mode can run in both the development and production environments (dev and prod).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment type. Valid values:'."\n" + ."\n" + .'* dev: development environment'."\n" + .'* prod: production environment'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dev', + ], + 'required' => true, + ], + 'ResourceGroupId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1e195c5116124202371861018d5bde', + ], + 'WorkspaceId' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1e195c5116124202371861018d5bde\\",\\n \\"WorkspaceId\\": \\"1234\\"\\n}","type":"json"}]', + 'title' => 'CreateWorkspace', + ], + 'GetWorkspace' => [ + 'summary' => 'Queries the details about 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. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display supplementary information such as the workspace owner. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C', + ], + 'WorkspaceId' => [ + 'title' => '工作空间 id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'WorkspaceName' => [ + 'title' => '项目空间名称， region 内唯一', + 'description' => 'The name of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace-example', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace is modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'DisplayName' => [ + 'title' => '显示名称', + 'description' => 'The display name of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace-example', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The description of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace description example', + ], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式', + 'description' => 'The environment information of the workspace.'."\n" + ."\n" + .'* Workspaces in basic mode can run only in the production environment.'."\n" + .'* Workspaces in standard mode can run in both the development and production environments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment type. Valid values:'."\n" + ."\n" + .'* dev: development environment'."\n" + .'* prod: production environment'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => 'The ID of the user who creates the workspace.'."\n", + 'type' => 'string', + 'example' => '1157******94123', + ], + 'Status' => [ + 'title' => '工作空间状态', + 'description' => 'The workspace state. Valid values:'."\n" + ."\n" + .'* ENABLED'."\n" + .'* INITIALIZING'."\n" + .'* FAILURE:'."\n" + .'* DISABLED'."\n" + .'* FROZEN'."\n" + .'* UPDATING'."\n", + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'AdminNames' => [ + 'title' => '管理员账户', + 'description' => 'The names of the administrator accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the administrator account. This parameter is valid only when Verbose is set to true.'."\n", + 'type' => 'string', + 'example' => 'demo_test@***.aliyunid.com', + ], + ], + 'IsDefault' => [ + 'title' => '是否为默认工作空间', + 'description' => 'Indicates whether the workspace is the default workspace. Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExtraInfos' => [ + 'title' => '附加信息', + 'description' => 'The additional information, which only contains the TenantId field.'."\n", + 'type' => 'object', + 'example' => '{"TenantId": "4286******98"}', + ], + 'Owner' => [ + 'description' => 'The information about the workspace owner. This parameter is valid only when Verbose is set to true.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserKp' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1157******94123', + ], + 'UserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1157******94123', + ], + 'UserName' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'mings****t', + ], + 'DisplayName' => [ + 'description' => 'The display name.'."\n", + 'type' => 'string', + 'example' => 'mings****t', + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmwp7rkyq****', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetWorkspace', + ], + 'DeleteWorkspace' => [ + 'summary' => 'Deletes a workspace. After you delete a workspace, the associated resources are not automatically released. You must manually release the resources.', + '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' => '工作空间id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteWorkspace', + ], + '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' => '项目空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '显示名称', + 'description' => 'The display name of the workspace.'."\n" + ."\n" + .'* The name must be 3 to 23 characters in length, and can contain letters, underscores (\\_), and digits.'."\n" + .'* The name must start with a letter.'."\n" + .'* The name must be unique in the current region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-example', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The workspace description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Description', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'UpdateWorkspace', + ], + 'GetDefaultWorkspace' => [ + 'summary' => 'Queries information about 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 show the details of the default workspace. The details include the conditions of the workspace in different phases. Valid values:'."\n" + ."\n" + .'* false (default)'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'WorkspaceId' => [ + 'title' => '工作空间 ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'WorkspaceName' => [ + 'title' => '项目空间名称， region 内唯一', + 'description' => 'The workspace name, which is unique in a region.'."\n", + 'type' => 'string', + 'example' => 'workspace-example', + ], + 'GmtCreateTime' => [ + 'title' => '创建 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace was created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改 UTC 时间，日期格式 iso8601', + 'description' => 'The time when the workspace was modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-21T17:12:35.232Z', + ], + 'DisplayName' => [ + 'title' => '显示名称', + 'description' => 'The display name of the workspace.'."\n", + 'type' => 'string', + 'example' => 'workspace-example', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'The workspace description.'."\n", + 'type' => 'string', + 'example' => 'workspace description example', + ], + 'EnvTypes' => [ + 'title' => '环境，用作判断简单模式还是标准模式，含义见', + 'description' => 'The environments of the workspace. Valid values:'."\n" + ."\n" + .'* Workspaces in basic mode can run only in the production environment.'."\n" + .'* Workspaces in standard mode can run in both the development and production environments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'* dev: development environment'."\n" + .'* prod: production environment'."\n", + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => 'The UID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '17915******4216'."\n", + ], + 'Owner' => [ + 'title' => '拥有者', + 'description' => 'The UID of the Alibaba Cloud account.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '17915******4216', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'username', + ], + 'UserKp' => [ + 'title' => '用户kp', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '17915******4216', + ], + ], + ], + 'Status' => [ + 'title' => '工作空间状态', + 'description' => 'The workspace status. Valid values:'."\n" + ."\n" + .'* ENABLED'."\n" + .'* INITIALIZING'."\n" + .'* FAILURE'."\n" + .'* DISABLED'."\n" + .'* FROZEN'."\n" + .'* UPDATING'."\n", + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'Conditions' => [ + 'title' => '任务详情 创建默认工作空间会有多个任务依次进行，如果一个任务未开始，不会显示在任务详情里。', + 'description' => 'The conditions of the default workspace in the creation process.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The condition of the default workspace in the creation process.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'* CREATING: The workspace is being created.'."\n" + .'* WORKSPACE_CREATED: The workspace is created.'."\n" + .'* MEMBERS_ADDED: The member is added.'."\n" + .'* ENABLED: The workspace is created and the member is added.'."\n", + 'type' => 'string', + 'example' => 'CREATING ', + ], + 'Code' => [ + 'title' => '返回码，正常是200，其他都是错误', + 'description' => 'The returned status code. HTTP status code 200 indicates that the request was successful. Other HTTP status codes indicate that the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'title' => '消息', + 'description' => 'The error message. If the returned status code is 200, this parameter is empty.'."\n", + 'type' => 'string', + 'example' => 'Create Failed', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetDefaultWorkspace', + ], + 'UpdateDefaultWorkspace' => [ + 'summary' => 'Specifies a workspace as the default workspace.', + '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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '显示名称', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '17915******4216', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"17915******4216\\"\\n}","type":"json"}]', + 'title' => 'UpdateDefaultWorkspace', + ], + 'ListWorkspaceUsers' => [ + 'summary' => 'Lists the users who do not belong to a workspace. These users can be added to the workspace as members.', + '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' => '工作空间 id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The display names of users who can be added to the workspace as members.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'doctest****', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1e195c5116124202371861018d5bde', + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的用户数量', + 'description' => 'The number of users who meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Users' => [ + 'title' => '用户列表', + 'description' => 'The users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The user.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '用户 id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1611******3000', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'she******mo', + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'ListWorkspaceUsers', + ], + 'ListQuotas' => [ + 'summary' => 'Obtains the list of 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 quota name. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'quota-name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'Quotas' => [ + 'title' => '配额列表', + 'description' => 'The returned quotas.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the quota.'."\n", + 'type' => 'object', + 'properties' => [ + 'QuotaType' => [ + 'title' => '产品类型， 支持PAI，MaxCompute', + 'description' => 'The quota type. Valid value:'."\n" + ."\n" + .'PAI: indicates GPU resource groups of MaxCompute.'."\n", + 'type' => 'string', + 'example' => 'MaxCompute', + ], + 'Mode' => [ + 'title' => '模式 isolate 预付费 share 后付费 develop 开发模式', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* isolate: subscription'."\n" + .'* share: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'isolate', + ], + 'ProductCode' => [ + 'title' => '产品代码', + 'description' => 'The product code. Valid values:'."\n" + ."\n" + .'* PAI_isolate: CPU subscription resource groups of PAI'."\n" + .'* PAI_share: GPU pay-as-you-go resource groups of PAI'."\n", + 'type' => 'string', + 'example' => 'MaxCompute_share', + ], + 'Name' => [ + 'title' => 'quota名字', + 'description' => 'The quota name.'."\n", + 'type' => 'string', + 'example' => 'quota-name', + ], + 'Specs' => [ + 'title' => '规格描述列表', + 'description' => 'The quota specifications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The specification description.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '规格名', + 'description' => 'The specification name.'."\n", + 'type' => 'string', + 'example' => 'cu', + ], + 'Value' => [ + 'title' => '规格描述', + 'description' => 'The specification value.'."\n", + 'type' => 'string', + 'example' => '11500', + ], + 'Type' => [ + 'title' => '类型，可为空', + 'description' => 'The specification type. The parameter can be left empty.'."\n", + 'type' => 'string', + 'example' => 'string', + ], + ], + ], + 'example' => '{\\"cu\\":\\"11500\\",\\"minCu\\":\\"2300\\",\\"parentId\\":\\"0\\"}', + ], + 'Id' => [ + 'title' => 'quota的id', + 'description' => 'The quota ID.'."\n", + 'type' => 'string', + 'example' => '1828233', + ], + 'DisplayName' => [ + 'description' => 'The alias of the quota.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的数量', + 'description' => 'The number of quotas that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"<ListQuotasResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <Quotas>\\n <QuotaType>MaxCompute</QuotaType>\\n <Mode>isolate</Mode>\\n <ProductCode>MaxCompute_share</ProductCode>\\n <Name>quota-name</Name>\\n <Specs>\\n <Name>name</Name>\\n <Value>{\\\\\\"cu\\\\\\":\\\\\\"11500\\\\\\",\\\\\\"minCu\\\\\\":\\\\\\"2300\\\\\\",\\\\\\"parentId\\\\\\":\\\\\\"0\\\\\\"}</Value>\\n <Type>abc</Type>\\n </Specs>\\n <Id>1828233</Id>\\n </Quotas>\\n <TotalCount>2</TotalCount>\\n</ListQuotasResponse>","errorExample":""}]', + 'title' => 'ListQuotas', + ], + 'GetDatasetFileMetasStatistics' => [ + 'summary' => 'Obtains metadata statistics of 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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '145883', + ], + ], + [ + 'name' => 'AggregateBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Aggregates statistics based on the specified metadata field. The value is not case-sensitive. If not specified, the total number of dataset file metadata will be returned, instead of aggregation lists. Valid values:'."\n" + ."\n" + .'* filedir: the directory path of the file'."\n" + .'* file_type: the file type'."\n" + .'* tags.user: user-defined tag'."\n" + .'* tags.user-delete-ai-tags: algorithm tags deleted by the user'."\n" + .'* tags.ai: algorithm tags (aggregated by all tagging tasks)'."\n" + .'* tags.all: algorithm tags and user-defined tags (excluding alogorithm tags deleted by the user)'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'filetype' => '', + 'tags.user' => '', + 'tags.ai' => '', + 'filedir' => '', + 'tags.user-delete-ai-tags' => '', + 'tags.all' => '', + ], + 'example' => 'filedir', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of results to be returned from a single query when the NextToken parameter is used in the query. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + 'TotalCount' => [ + 'description' => 'The returned number. Example: the number of metadata records or the number of user-defined tags.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '73', + ], + 'DatasetFileMetasStats' => [ + 'description' => 'The details of the returned aggregation list, including the number of each aggregate item. The list is by default sorted in descending order based on the count number.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Aggregate items and their numbers.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetasStat', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\",\\n \\"TotalCount\\": 73,\\n \\"DatasetFileMetasStats\\": [\\n {\\n \\"Key\\": \\"cat\\",\\n \\"Count\\": 10\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetDatasetFileMetasStatistics', + ], + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the dataset job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsjob-9jx1*****uj9e', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '478**', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F620FFD3-FFDC-5873-A70C-6971CC45F467', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F620FFD3-FFDC-5873-A70C-6971CC45F467\\"\\n}","type":"json"}]', + 'title' => 'StopDatasetJob', + ], + 'GetDatasetJob' => [ + 'summary' => 'Obtains 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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the dataset job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsjob-9jx1xxxxxxuj9e', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '478**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D', + ], + 'JobAction' => [ + 'description' => 'The action that is performed on the job.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SemanticIndex: semantic indexing'."\n" + .'* IntelligentTag: smart labeling'."\n" + .'* FileMetaExport: metadata export'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SemanticIndex' => '', + 'IntelligentTag' => '', + 'FileMetaExport' => '', + ], + 'example' => 'SemanticIndex', + ], + 'JobMode' => [ + 'description' => 'The job mode.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Full: full data mode.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Full' => '', + ], + 'example' => 'Full', + ], + 'CreateTime' => [ + 'description' => 'The time when the job is started.'."\n", + 'type' => 'string', + 'example' => '2024-11-15T07:06:42Z', + ], + 'FinishTime' => [ + 'description' => 'The time when the job ends.'."\n", + 'type' => 'string', + 'example' => '2024-07-16T02:03:23Z', + ], + 'JobSpec' => [ + 'description' => 'The job details.'."\n", + 'type' => 'string', + 'example' => '{\\"modelId\\":\\"xxx\\"}', + ], + 'Status' => [ + 'description' => 'The job state.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Succeeded'."\n" + .'* Failed'."\n" + .'* Running'."\n" + .'* Pending'."\n" + .'* PartialFailed'."\n" + .'* Deleting'."\n" + .'* ManuallyStop'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Succeeded' => '', + 'Failed' => '', + 'Running' => '', + 'Pending' => '', + 'PartialFailed' => '', + 'Deleting' => '', + 'ManuallyStop' => '', + ], + 'example' => 'Running', + ], + 'Description' => [ + 'description' => 'The job description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Logs' => [ + 'description' => 'The job logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The job log.'."\n", + 'type' => 'string', + 'example' => '2025-02-17 09:58:10.143 INFO: Job completed successfully.', + ], + ], + 'TotalFileCount' => [ + 'description' => 'The total number of job files.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'CompletedFileCount' => [ + 'description' => 'The total number of completed files.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '990', + ], + 'FailedFileCount' => [ + 'description' => 'The total number of failed files.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + '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\\": \\"这是一个任务描述。\\",\\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', + ], + 'CreateDatasetFileMetas' => [ + 'summary' => 'Creates the metadata records of multiple files in a dataset at a time.', + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => 'The ID of the workspace to which the dataset belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '478**', + ], + 'DatasetVersion' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + 'DatasetFileMetas' => [ + 'description' => 'The metadata of the file.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata details.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/DatasetFileMetaContentCreate', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Status' => [ + 'description' => 'Indicates whether the metadata records of all dataset files were created. The value true indicates that the metadata records of all dataset files are created. If the value is false, view the failure details specified by FailedDetails.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'FailedDetails' => [ + 'description' => 'The metadata that failed to be created.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of metadata that failed to be created.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetaResponse', + ], + ], + 'SucceedDetails' => [ + 'description' => 'The metadata that is created.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of metadata that is created.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetaResponse', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"SucceedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'CreateDatasetFileMetas', + ], + 'UpdateDatasetJob' => [ + 'summary' => 'Updates a dataset job.', + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The dataset job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsjob-9jx1*****uj9e', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '478**', + ], + 'Description' => [ + 'description' => 'The dataset job description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'UpdateDatasetJob', + ], + 'ListDatasetJobs' => [ + 'summary' => 'Lists jobs in a dataset.', + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'JobAction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action to be performed on the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SemanticIndex', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', + ], + 'TotalCount' => [ + 'description' => 'The total number of jobs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + ], + 'DatasetJobs' => [ + 'description' => 'The jobs in the dataset.'."\n", + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DatasetJob', + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\",\\n \\"TotalCount\\": 1,\\n \\"DatasetJobs\\": [\\n {\\n \\"DatasetJobId\\": \\"\\",\\n \\"JobAction\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"FinishTime\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"JobMode\\": \\"\\",\\n \\"JobSpec\\": \\"\\",\\n \\"Logs\\": [\\n \\"\\"\\n ],\\n \\"TotalFileCount\\": 0,\\n \\"CompletedFileCount\\": 0,\\n \\"FailedFileCount\\": 0,\\n \\"DatasetVersion\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDatasetJobs', + ], + 'DeleteDatasetJobConfig' => [ + 'summary' => 'Deletes a job configuration for a dataset.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'DatasetJobConfigId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The configuration ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dscfg-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '513663', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatasetJobConfig', + ], + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetJobId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The ID of the dataset job.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsjob-9jx1******uj9e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatasetJob', + ], + 'UpdateDatasetJobConfig' => [ + 'summary' => 'Updates a job configuration for a dataset.', + '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 dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetJobConfigId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The configuration ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dscfg-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '167497', + ], + 'ConfigType' => [ + 'description' => 'The configuration type.'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + .'* MultimodalSemanticIndex'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', + 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', + ], + 'example' => 'MultimodalSemanticIndex', + ], + 'Config' => [ + 'description' => 'The configuration content. Formats:'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + ."\n" + .'{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'."\n" + ."\n" + .'* MultimodalSemanticIndex'."\n" + ."\n" + .'{ "defaultModelId": "xxx" "defaultModelVersion":"1.0.0" }'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D619B5C4B9\\"\\n}","type":"json"}]', + 'title' => 'UpdateDatasetJobConfig', + ], + 'UpdateDatasetFileMetas' => [ + 'summary' => 'Updates the metadata records of multiple files in a dataset at a time.', + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'WorkspaceId' => [ + 'description' => 'The ID of the workspace to which the dataset belongs. To obtain the workspace ID, see [ListWorkspaces](~~449124~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '796**', + ], + 'DatasetFileMetas' => [ + 'description' => 'The metadata records to be updated for the dataset files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the file metadata to be updated.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/DatasetFileMetaConentUpdate', + ], + 'required' => true, + ], + 'TagJobId' => [ + 'description' => 'The ID of the tagging job that is associated with the metadata tag of the dataset file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dsjob-hv0b1****u8taig3y', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Status' => [ + 'description' => 'Indicates whether the metadata records of all dataset files were updated. Valid values: true and false. If the value is false, view the failure details specified by FailedDetails.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailedDetails' => [ + 'description' => 'The metadata records that fail to be updated for the dataset files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata record that fails to be updated for the dataset file.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetaResponse', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'UpdateDatasetFileMetas', + ], + 'ListDatasetJobConfigs' => [ + 'summary' => 'Queries the dataset job configurations at a time.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '431514', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration type.'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + .'* MultimodalSemanticIndex'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', + 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', + ], + 'example' => 'MultimodalIntelligentTag', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'DatasetJobConfigs' => [ + 'description' => 'The dataset job configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset job configuration.'."\n", + '$ref' => '#/components/schemas/DatasetJobConfig', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 15,\\n \\"DatasetJobConfigs\\": [\\n {\\n \\"DatasetJobConfigId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ModifyTime\\": \\"\\",\\n \\"ConfigType\\": \\"\\",\\n \\"Config\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"DatasetVersion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDatasetJobConfigs', + ], + 'ListDatasetFileMetas' => [ + 'summary' => 'Queries a list of dataset files.', + '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' => 'A short description of struct', + 'description' => 'The dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workspace to which the dataset belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '105173', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retrieval type.'."\n" + ."\n" + .'* TAG (default)'."\n" + .'* VECTOR'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TAG' => '', + 'MIX' => '', + 'VECTOR' => '', + ], + 'example' => 'TAG', + ], + ], + [ + 'name' => 'QueryText', + 'in' => 'query', + 'schema' => [ + 'description' => 'The text content to be queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of search results to return. A maximum of Top K search results can be returned. This parameter is valid only when QueryType is set to VECTOR.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '1', + 'example' => '100', + 'default' => '10', + ], + ], + [ + 'name' => 'ScoreThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'The similarity score. Only dataset files whose similarity score is greater than the value of ScoreThreshold are returned. This parameter is valid only when QueryType is set to VECTOR.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.6', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token.'."\n" + ."\n" + .'> If you do not configure this parameter, the data on the first page is returned. A return value other than Null of this parameter indicates that not all entries have been returned. You can use this value as an input parameter to obtain entries on the next page. The value Null indicates that all query results have been returned.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '90a6ee35-****-4cd4-927e-1f45e1cb8b62_1729644433000', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used to sort the results. Default value: GmtCreateTime. Valid values:'."\n" + ."\n" + .'* FileCreateTime (default): The results are sorted by the time when the file is created.'."\n" + .'* FileUpdateTime: The results are sorted by the time when the file is last modified.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'FileCreateTime' => '', + 'FileUpdateTime' => '', + ], + 'example' => 'FileCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. This parameter must be used together with SortBy. Default value: ASC.'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '', + 'DESC' => '', + ], + 'example' => 'DESC', + ], + ], + [ + 'name' => 'EndFileUpdateTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update time range to query. The end time. The time follows the ISO 8601 standard. This parameter is valid only when QueryType is set to TAG.'."\n", + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2025-01-12T14:36:01Z'."\n", + ], + ], + [ + 'name' => 'StartFileUpdateTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The update time range to query. The start time. The time follows the ISO 8601 standard. This parameter is valid only when QueryType is set to TAG.'."\n", + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2025-01-12T14:36:01Z'."\n", + ], + ], + [ + 'name' => 'QueryImage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://test-xxx-oss/car/0001.png', + ], + ], + [ + 'name' => 'ThumbnailMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'w_100', + ], + ], + [ + 'name' => 'DatasetFileMetaIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 20, + ], + ], + [ + 'name' => 'QueryTagsIncludeAll', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QueryTagsIncludeAny', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QueryTagsExclude', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'simple', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QueryFileName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'shuima', + ], + ], + [ + 'name' => 'QueryFileDir', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cars/20250221/', + ], + ], + [ + 'name' => 'QueryFileTypeIncludeAny', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QueryContentTypeIncludeAny', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'StartTagUpdateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2025-01-12T14:36:01.000Z'."\n", + ], + ], + [ + 'name' => 'EndTagUpdateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2025-01-12T14:36:01.000Z'."\n", + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'QueryExpression', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'ACTIVE', + 'ALL', + 'DELETED', + ], + ], + ], + [ + 'name' => 'QueryVideo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'example' => '30', + ], + 'NextToken' => [ + 'description' => 'The pagination token. If the number of results exceeds the maximum number of entries allowed per page, a pagination token is returned. This token can be used as an input parameter to obtain the next page of results. If all results are obtained, no token is returned.'."\n", + 'type' => 'string', + 'example' => '90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000', + ], + 'DatasetFileMetas' => [ + 'description' => 'The metadata records of the dataset files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata details of the dataset file.'."\n", + '$ref' => '#/components/schemas/DatasetFileMeta', + ], + ], + 'DatasetId' => [ + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-rbvg5*****jhc9ks92'."\n", + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '105173', + ], + 'DatasetVersion' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 30,\\n \\"NextToken\\": \\"90******-f5c5-4cd4-927e-1f45e1cb8b62_1729644433000\\",\\n \\"DatasetFileMetas\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Uri\\": \\"oss://test-bucket/dataset/car.png\\",\\n \\"FileName\\": \\"car.png\\",\\n \\"DownloadUrl\\": \\"\\",\\n \\"Score\\": 0.6,\\n \\"DataSize\\": 12,\\n \\"FileFingerPrint\\": \\"\\",\\n \\"FileUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"Tags\\": \\"\\",\\n \\"ThumbnailUrl\\": \\"\\",\\n \\"MetaAttributes\\": \\"{ \\\\\\"ImageHeight\\\\\\": 400, \\\\\\"ImageWidth\\\\\\": 800 }\\",\\n \\"SyncTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"\\",\\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\\": \\"\\"\\n }\\n ],\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\\\n\\",\\n \\"WorkspaceId\\": \\"105173\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]', + 'title' => 'ListDatasetFileMetas', + ], + 'GetDatasetJobConfig' => [ + 'summary' => 'Obtains a job configuration for a dataset.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'DatasetJobConfigId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The configuration ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dscfg-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '114243', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5BFFEE3-6025-443F-8A03-02D619B5C4B9', + ], + 'CreateTime' => [ + 'description' => 'The time when the configuration is created.'."\n", + 'type' => 'string', + 'example' => '2024-10-16T01:44:10Z', + ], + 'ModifyTime' => [ + 'description' => 'The time when the configuration is modified.'."\n", + 'type' => 'string', + 'example' => '2024-12-26T02:17:18Z', + ], + 'ConfigType' => [ + 'description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + .'* MultimodalSemanticIndex'."\n", + 'type' => 'string', + 'example' => 'MultimodalIntelligentTag', + ], + 'Config' => [ + 'description' => 'The configuration content. Configuration format for MultimodalIntelligentTag:'."\n" + ."\n" + .'{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'."\n" + ."\n" + .'MultimodalSemanticIndex'."\n" + ."\n" + .'{ "defaultModelId": "xxx" "defaultModelVersion":"1.0.0" }'."\n", + 'type' => 'string', + 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', + ], + 'DatasetId' => [ + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-lfd60v0p****ujtsdx', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '114243', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'GetDatasetJobConfig', + ], + 'GetDatasetFileMeta' => [ + 'summary' => 'Queries the metadata records of specific files 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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'DatasetFileMetaId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The metadata ID of the dataset file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'DatasetFileMeta' => [ + 'description' => 'The queried metadata records of dataset files.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetaContentGet', + ], + 'DatasetVersion' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'DatasetId' => [ + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-rbvg5wz****c9ks92', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetFileMeta\\": {\\n \\"FileName\\": \\"\\",\\n \\"Uri\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"FileCreateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"FileFingerPrint\\": \\"\\",\\n \\"DataSize\\": 0,\\n \\"FileType\\": \\"\\",\\n \\"ContentType\\": \\"\\",\\n \\"MetaAttributes\\": \\"\\",\\n \\"Tags\\": \\"\\",\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"FileDir\\": \\"\\",\\n \\"TagUpdateTime\\": \\"2021-01-12T14:36:01.000Z\\",\\n \\"SemanticIndexJobId\\": \\"\\",\\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"}]', + 'title' => 'GetDatasetFileMeta', + ], + 'DeleteDatasetFileMetas' => [ + 'summary' => 'Deletes the metadata records of multiple files in a dataset at a time.', + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'DatasetVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workspace to which the dataset belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '132602', + ], + ], + [ + 'name' => 'DatasetFileMetaIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metadata ID of the dataset file.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Status' => [ + 'description' => 'Indicates whether the metadata records of all dataset files were deleted. The value true indicates that the metadata records of all dataset files are deleted. If the value is false, view the failure details specified by FailedDetails.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailedDetails' => [ + 'description' => 'The metadata records that fail to be deleted for the dataset files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metadata record that fails to be deleted for the dataset file.'."\n", + '$ref' => '#/components/schemas/DatasetFileMetaResponse', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Status\\": true,\\n \\"FailedDetails\\": [\\n {\\n \\"DatasetFileMetaId\\": \\"\\",\\n \\"Result\\": \\"\\",\\n \\"Uri\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DeleteDatasetFileMetas', + ], + 'CreateDatasetJobConfig' => [ + 'summary' => 'Creates a job configuration for a dataset.', + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wzlj****9ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '454716', + ], + 'ConfigType' => [ + 'description' => 'The configuration type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + .'* MultimodalSemanticIndex'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'MultimodalIntelligentTag' => 'MultimodalIntelligentTag', + 'MultimodalSemanticIndex' => 'MultimodalSemanticIndex', + ], + 'example' => 'MultimodalIntelligentTag', + ], + 'Config' => [ + 'description' => 'The configuration content. Format:'."\n" + ."\n" + .'* MultimodalIntelligentTag'."\n" + ."\n" + .'{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }'."\n" + ."\n" + .'* MultimodalSemanticIndex'."\n" + ."\n" + .'{ "defaultModelId": "xxx" "defaultModelVersion":"1.0.0" }'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{ "apiKey":"sk-xxxxxxxxxxxxxxxxxxxxx" }', + ], + 'DatasetVersion' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'DatasetJobConfigId' => [ + 'description' => 'The configuration ID.'."\n", + 'type' => 'string', + 'example' => 'dscfg-xxxxxxxxxxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"DatasetJobConfigId\\": \\"dscfg-xxxxxxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetJobConfig', + ], + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetVersion' => [ + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '478**', + ], + 'JobAction' => [ + 'description' => 'The job action.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SemanticIndex'."\n" + .'* IntelligentTag'."\n" + .'* FileMetaExport'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SemanticIndex' => '', + 'IntelligentTag' => '', + 'FileMetaExport' => '', + ], + 'example' => 'SemanticIndex', + ], + 'JobMode' => [ + 'description' => 'The job mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Full: full mode.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Full' => '', + ], + 'example' => 'Full', + ], + 'Description' => [ + 'description' => 'The job description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'JobSpec' => [ + 'description' => 'The job configuration.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{\\"modelId\\":\\"xxx\\"}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '99341606-****-0757724D97EE', + ], + 'DatasetJobId' => [ + 'description' => 'The ID of the dataset job.'."\n", + 'type' => 'string', + 'example' => 'dsjob-9jx1******uj9e', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99341606-****-0757724D97EE\\",\\n \\"DatasetJobId\\": \\"dsjob-9jx1******uj9e\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetJob', + 'requestParamsDescription' => 'JobSpec parameter description: (1) Semantic indexing task'."\n" + ."\n" + .'Example: `{ "modelId": "xxx", "modelVersion": "1.0.0", "contentList": ["file"] }`'."\n" + ."\n" + .'modelId indicates the model ID, modelVersion indicates the model version, and contentList indicates the index content. Only files are supported.'."\n" + ."\n" + .'(2) Smart labeling task'."\n" + ."\n" + .'Example: `{ "modelId": "qwen-max-0428" }`'."\n" + ."\n" + .'modelId indicates the ID of the labeling model.'."\n" + ."\n" + .'(3) Metadata export task'."\n" + ."\n" + .'Example: `{ "source": "TAG", "queryText": "Car", "topK": 100, "scoreThreshold":0.6, "fileUri": "oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath" }`'."\n" + ."\n" + .'source indicates the result source. The value TAG indicates that the source is a tag, and the value VECTOR indicates that the source is an embedding vector. queryText indicates the text content to be queried. topK indicates the maximum number of exports. scoreThreshold indicates the similarity score. Only results whose similarity score is greater than the value of ScoreThreshold are returned. This parameter is valid when Source is set to VECTOR. fileUri indicates the OSS storage path of the exported file.'."\n", + ], + '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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'Name', + 'description' => 'The dataset name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name must start with a letter, digit, or Chinese character.'."\n" + .'* The name can contain underscores (\\_) and hyphens (-).'."\n" + .'* The name must be 1 to 127 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'myName', + ], + 'Property' => [ + 'title' => 'Property', + 'description' => 'The property of the dataset. Valid values:'."\n" + ."\n" + .'* FILE'."\n" + .'* DIRECTORY'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'DIRECTORY', + ], + 'DataSourceType' => [ + 'title' => 'DataSourceType', + 'description' => 'The data source type. Valid values:'."\n" + ."\n" + .'* OSS: Object Storage Service (OSS).'."\n" + .'* NAS: File Storage NAS (NAS).'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAS' => 'NAS', + 'OSS' => 'OSS', + ], + 'example' => 'NAS', + ], + 'Uri' => [ + 'title' => 'Uri', + 'description' => 'The URI of the data source.'."\n" + ."\n" + .'* Value format if DataSourceType is set to OSS: `oss://bucket.endpoint/object`.'."\n" + .'* Value formats if DataSourceType is set to NAS: General-purpose NAS: `nas://<nasfisid>.region/subpath/to/dir/`. CPFS 1.0: `nas://<cpfs-fsid>.region/subpath/to/dir/`. CPFS 2.0: `nas://<cpfs-fsid>.region/<protocolserviceid>/`. You can distinguish CPFS 1.0 and CPFS 2.0 file systems based on the format of the file system ID: The ID for CPFS 1.0 is in the cpfs-<8-bit ASCII characters> format. The ID for CPFS 2.0 is in the cpfs-<16-bit ASCII characters> format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'nas://09f****f2.cn-hangzhou/', + ], + 'DataType' => [ + 'title' => 'DataType', + 'description' => 'The type of the dataset. Default value: COMMON. Valid values:'."\n" + ."\n" + .'* COMMON: common'."\n" + .'* PIC: picture'."\n" + .'* TEXT: text'."\n" + .'* Video: video'."\n" + .'* AUDIO: audio'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VIDEO' => 'VIDEO', + 'COMMON' => 'COMMON', + 'TEXT' => 'TEXT', + 'PIC' => 'PIC', + 'AUDIO' => 'AUDIO', + ], + 'example' => 'COMMON', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag to be added to the dataset.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'SourceType' => [ + 'title' => 'SourceType', + 'description' => 'The type of the data source. Default value: USER.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PAI_PUBLIC_DATASET: a public dataset of PAI.'."\n" + .'* ITAG: a dataset generated from a labeling job of iTAG.'."\n" + .'* USER: a dataset registered by a user.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => '', + 'ITAG' => '', + 'USER' => '', + ], + 'example' => 'USER', + ], + 'SourceId' => [ + 'title' => 'SourceId', + 'description' => 'The data source ID.'."\n" + ."\n" + .'* If SourceType is set to USER, the value of SourceId is a custom string.'."\n" + .'* If SourceType is set to ITAG, the value of SourceId is the ID of the labeling job of iTAG.'."\n" + .'* If SourceType is set to PAI_PUBLIC_DATASET, SourceId is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jdnhf***fnrimv', + ], + 'Description' => [ + 'title' => 'Description', + 'description' => 'The description of the dataset. Descriptions are used to differentiate datasets.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'WorkspaceId' => [ + 'title' => 'WorkspaceId', + 'description' => 'The ID of the workspace to which the dataset belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID. If you do not specify this parameter, the default workspace is used. If the default workspace does not exist, an error is reported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '478**', + ], + 'Options' => [ + 'title' => 'Options', + 'description' => 'The extended field, which is a JSON string. When you use the dataset in Deep Learning Containers (DLC), you can configure the mountPath field to specify the default mount path of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + ], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => 'The workspace accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE: The workspace is accessible only to you and the administrator of the workspace. This is the default value.'."\n" + .'* PUBLIC: The workspace is accessible to all users.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + ], + 'ProviderType' => [ + 'title' => 'ProviderType', + 'description' => 'The source type of the dataset. Valid values:'."\n" + ."\n" + .'* Ecs (default)'."\n" + .'* Lingjun'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Ecs', + ], + 'Provider' => [ + 'description' => 'The dataset provider. The value cannot be set to pai.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Github', + ], + 'UserId' => [ + 'title' => '数据集所有者', + 'description' => 'The ID of the Alibaba Cloud account to which the dataset belongs. The workspace owner and administrator have permissions to create datasets for specified members in the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2485765****023475', + ], + 'SourceDatasetId' => [ + 'title' => 'iTag标注集的源数据集', + 'description' => 'The ID of the source dataset for the labeled dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-bvfasdfxxxxj8o411', + ], + 'SourceDatasetVersion' => [ + 'title' => 'iTag标注集的源数据集版本', + 'description' => 'The version of the source dataset for the labeled dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v2', + ], + 'VersionDescription' => [ + 'description' => 'The description of the dataset of the initial version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The initial version'."\n", + ], + 'VersionLabels' => [ + 'description' => 'The list of tags to be added to the dataset of the initial version.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag to be added to the dataset of the initial version.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'DataSize' => [ + 'description' => 'The size of the dataset file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '999999999999', + 'minimum' => '1', + 'example' => '10000', + ], + 'DataCount' => [ + 'description' => 'The number of dataset files.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '999999999999', + 'minimum' => '1', + 'example' => '500', + ], + 'MountAccessReadWriteRoleIdList' => [ + 'description' => 'The list of role names in the workspace that have read and write permissions on the mounted database. The names start with PAI are basic role names and the names start with role- are custom role names. If the list contains asterisks (\\*), all roles have read and write permissions.'."\n" + ."\n" + .'* If you set the value to \\["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"], the account of the specified role is granted the read and write permissions.'."\n" + .'* If you set the value to \\["\\*"], all accounts are granted the read and write permissions.'."\n" + .'* If you set the value to \\[], only the creator of the dataset has the read and write permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the workspace role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAI.AlgoOperator', + ], + 'required' => false, + ], + 'ImportInfo' => [ + 'description' => 'The dataset configurations to be imported to a storage, such as OSS, NAS, or Cloud Parallel File Storage (CPFS).'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID.\\'."\n" + .'"bucket": "${bucket}",//The bucket name.\\'."\n" + .'"path": "${path}" // The file path.\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**NAS**'."\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 point of the file system.\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID.\\'."\n" + .'"fileSystemId": "${file_system_id}", // The file system ID.\\'."\n" + .'"protocolServiceId":"${protocol_service_id}", // The file system protocol service.\\'."\n" + .'"exportId": "${export_id}", // The file system export directory.\\'."\n" + .'"path": "${path}", // The file system path.\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS for Lingjun**'."\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 point of the file system, CPFS for Lingjun only.\\'."\n" + .'"isVpcMount": boolean, // Whether the mount point is a virtual private cloud (VPC) mount point, CPFS for Lingjun only.\\'."\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" + .'}', + ], + 'Edition' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F', + ], + 'DatasetId' => [ + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\",\\n \\"DatasetId\\": \\"d-rbvg5*****jhc9ks92\\"\\n}","type":"json"}]', + 'title' => 'CreateDataset', + ], + 'GetDataset' => [ + 'summary' => 'Obtains 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' => 'Dataset Id', + 'description' => 'The dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'DatasetId' => [ + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-rbvg5wz****c9ks92', + ], + 'Name' => [ + 'description' => 'The dataset name.'."\n", + 'type' => 'string', + 'example' => 'myName', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'GmtCreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'GmtModifiedTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'UserId' => [ + 'description' => 'The ID of the user to which the dataset belongs.'."\n", + 'type' => 'string', + 'example' => '2485765****023475', + ], + 'OwnerId' => [ + 'description' => 'The ID of the Alibaba Could account.'."\n", + 'type' => 'string', + 'example' => '1631044****3440', + ], + 'Property' => [ + 'description' => 'The property of the dataset of the initial version v1. Valid values:'."\n" + ."\n" + .'* FILE'."\n" + .'* DIRECTORY'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'DIRECTORY', + ], + 'DataSourceType' => [ + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* OSS: Object Storage Service (OSS)'."\n" + .'* NAS: File Storage NAS (NAS)'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'NAS' => 'NAS', + 'OSS' => 'OSS', + ], + 'example' => 'NAS', + ], + 'Uri' => [ + 'description' => 'The URI of the initial version v1.'."\n" + ."\n" + .'* Sample format for the OSS data source: `oss://bucket.endpoint/object`'."\n" + .'* Sample formats for the NAS data source: `nas://<nasfisid>.region/subpath/to/dir/`: General-purpose NAS. `nas://<cpfs-fsid>.region/subpath/to/dir/`: Cloud Parallel File Storage (CPFS) 1.0. `nas://<cpfs-fsid>.region/<protocolserviceid>/`: CPFS 2.0. You can distinguish CPFS 1.0 and CPFS 2.0 file systems based on the format of the file system ID. The ID for CPFS 1.0 is in the cpfs-<8-bit ASCII characters> format. The ID for CPFS 2.0 is in the cpfs-<16-bit ASCII characters> format.'."\n", + 'type' => 'string', + 'example' => 'nas://09f****f2.cn-hangzhou/', + ], + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag to be added to the dataset.'."\n", + 'example' => '{"Key": "env", "Value": "test"}', + '$ref' => '#/components/schemas/Label', + ], + ], + 'DataType' => [ + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* COMMON: common'."\n" + .'* PIC: picture'."\n" + .'* TEXT: text'."\n" + .'* VIDEO: video'."\n" + .'* AUDIO: audio'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'VIDEO' => 'VIDEO', + 'COMMON' => 'COMMON', + 'TEXT' => 'TEXT', + 'PIC' => 'PIC', + 'AUDIO' => 'AUDIO', + ], + 'example' => 'COMMON', + ], + 'SourceType' => [ + 'description' => 'The type of the source for the dataset v1 (initial version). Valid values:'."\n" + ."\n" + .'* PAI-PUBLIC-DATASET: a public dataset of Platform for AI (PAI).'."\n" + .'* ITAG: a dataset generated from a labeling job of iTAG.'."\n" + .'* USER: a dataset registered by a user.', + 'type' => 'string', + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => '', + 'ITAG' => '', + 'USER' => '', + ], + 'example' => 'USER', + ], + 'SourceId' => [ + 'description' => 'The ID of the source for the dataset v1 (initial version). Valid values:'."\n" + ."\n" + .'* If SourceType is set to USER, the value of SourceId can be a custom string.'."\n" + .'* If SourceType is set to ITAG, the value of SourceId is the ID of the labeling job of iTAG.'."\n" + .'* If SourceType is set to PAI_PUBLIC_DATASET, SourceId is empty by default.'."\n", + 'type' => 'string', + 'example' => 'jdnhf***fnrimv', + ], + 'WorkspaceId' => [ + 'description' => 'The ID of the workspace to which the dataset belongs.'."\n", + 'type' => 'string', + 'example' => '478**', + ], + 'Options' => [ + 'description' => 'The extended fields of the dataset v1 (initial version). The value is a JSON string. When you use the dataset in Deep Learning Containers (DLC), you can use the mountPath field to specify the default mount path of the dataset.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + ], + 'Accessibility' => [ + 'description' => 'The visibility of the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The workspace is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The workspace is visible to all users.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + ], + 'ProviderType' => [ + 'description' => 'The type of the data source for the dataset. Valid values:'."\n" + ."\n" + .'* Ecs (default)'."\n" + .'* Lingjun'."\n", + 'type' => 'string', + 'example' => 'Ecs', + ], + 'Provider' => [ + 'description' => 'The dataset provider. If the value pai is returned, the dataset is a public dataset in PAI.'."\n", + 'type' => 'string', + 'example' => 'pai', + ], + 'SourceDatasetId' => [ + 'description' => 'The ID of the source dataset generated from a labeling job of iTAG.'."\n", + 'type' => 'string', + 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n", + ], + 'SourceDatasetVersion' => [ + 'description' => 'The version of the source dataset generated from a labeling job of iTAG.'."\n", + 'type' => 'string', + 'example' => 'v2', + ], + 'TagTemplateType' => [ + 'description' => 'The labeling template for the source dataset generated from a labeling job of iTAG.'."\n", + 'type' => 'string', + 'example' => 'TextClassification', + ], + 'LatestVersion' => [ + 'description' => 'The latest version of the dataset.'."\n", + '$ref' => '#/components/schemas/DatasetVersion', + ], + 'MountAccess' => [ + 'description' => 'The access permission on the dataset when the dataset is mounted. Valid values:'."\n" + ."\n" + .'* RO: read-only permissions'."\n" + .'* RW: read and write permissions'."\n", + 'type' => 'string', + 'example' => 'RW', + ], + 'MountAccessReadWriteRoleIdList' => [ + 'description' => 'The list of role names in the workspace that have read and write permissions on the mounted database. The names start with PAI are basic role names and the names start with role- are custom role names. If the list contains asterisks (\\*), all roles have read and write permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the workspace role.'."\n", + 'type' => 'string', + 'example' => 'PAI.AlgoOperator', + ], + ], + 'ImportInfo' => [ + 'description' => 'The dataset configurations to be imported to a storage, such as OSS, NAS, or CPFS.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID\\'."\n" + .'"bucket": "${bucket}",// The bucket name\\'."\n" + .'"path": "${path}" // The file path\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**NAS**'."\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 point of the file system\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID\\'."\n" + .'"fileSystemId": "${file_system_id}", // The file system ID\\'."\n" + .'"protocolServiceId":"${protocol_service_id}", // The file system protocol service\\'."\n" + .'"exportId": "${export_id}", // The file system export directory\\'."\n" + .'"path": "${path}", // The file system path\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS for Lingjun**'."\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 point of the file system, CPFS for Lingjun only\\'."\n" + .'"isVpcMount": boolean, // Whether the mount point is a VPC mount point, CPFS for Lingjun only\\'."\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' => [ + 'type' => 'string', + ], + 'IsShared' => [ + 'type' => 'boolean', + ], + 'SharedFrom' => [ + '$ref' => '#/components/schemas/DatasetShareRelationship', + ], + 'SharingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SharedTo' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DatasetShareRelationship', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"\\",\\n \\"Value\\": \\"\\"\\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\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\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\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetDataset', + ], + 'UpdateDataset' => [ + 'summary' => 'Updates the name, description, and other information about a dataset.', + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The dataset name. You can call [ListDatasets](~~457222~~) to obtain the dataset name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + 'Description' => [ + 'description' => 'The description of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Options' => [ + 'description' => 'The extended field, which is a JSON string. When you use the dataset in Deep Learning Containers (DLC), you can set mountPath to specify the default mount path of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + ], + 'Edition' => [ + 'type' => 'string', + 'required' => false, + ], + 'MountAccessReadWriteRoleIdList' => [ + 'description' => 'The list of role names in the workspace that have read and write permissions on the mounted database. The names starting with PAI are basic role names, and the names starting with role- are custom role names. If the list contains asterisks (\\*), all roles have read and write permissions.'."\n" + ."\n" + .'* If you set the value to \\["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"], the account of the specified role is granted the read and write permissions.'."\n" + .'* If you set the value to \\["\\*"], all accounts are granted the read and write permissions.'."\n" + .'* If you set the value to \\[], only the creator of the dataset has the read and write permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the workspace role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PAI.AlgoOperator'."\n", + ], + 'required' => false, + ], + 'SharingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SharedTo' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DatasetShareRelationship', + ], + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'UpdateDataset', + ], + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5w****c9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + 'title' => 'PublishDataset', + ], + '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. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order of specific fields of the entries on the returned page. Valid values: ASC and DESC. Default value: ASC.'."\n" + ."\n" + .'* ASC: The entries are sorted in ascending order.'."\n" + .'* DESC: The entries are sorted in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => 'ASC', + 'DESC' => 'DESC', + ], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset name. Fuzzy search based on the dataset name is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'myName', + ], + ], + [ + 'name' => 'Properties', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset properties. Multiple properties are separated by commas (,). Valid values:'."\n" + ."\n" + .'* DIRECTORY'."\n" + .'* FILE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'FILE', + ], + ], + [ + 'name' => 'DataSourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The storage types of the data source. Multiple data source types are separated by commas (,). Valid values:'."\n" + ."\n" + .'* NAS: File Storage NAS (NAS).'."\n" + .'* OSS: Object Storage Service (OSS).'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NAS' => 'NAS', + 'OSS' => 'OSS', + ], + 'example' => 'OSS', + ], + ], + [ + 'name' => 'DataTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset types. Multiple dataset types are separated by commas (,). Valid values:'."\n" + ."\n" + .'* Video: video'."\n" + .'* COMMON: common'."\n" + .'* TEXT: text'."\n" + .'* PIC: picture'."\n" + .'* AUDIO: audio'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VIDEO' => 'VIDEO', + 'COMMON' => 'COMMON', + 'TEXT' => 'TEXT', + 'PIC' => 'PIC', + 'AUDIO' => 'AUDIO', + ], + 'example' => 'COMMON,TEXT', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data source ID.'."\n" + ."\n" + .'* If SourceType is set to USER, the value of SourceId is a custom string.'."\n" + .'* If SourceType is set to ITAG, the value of SourceId is the ID of the labeling job of iTAG.'."\n" + .'* If SourceType is set to PAI_PUBLIC_DATASET, SourceId is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-rbvg5wzljzjhc9ks92', + ], + ], + [ + 'name' => 'SourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source types. Multiple source types are separated by commas (,). Valid values:'."\n" + ."\n" + .'* PAI-PUBLIC-DATASET: a public dataset of Platform for AI (PAI).'."\n" + .'* ITAG: a dataset generated from a labeling job of iTAG.'."\n" + .'* USER: a dataset registered by a user.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', + 'ITAG' => 'ITAG', + 'USER' => 'USER', + ], + 'example' => 'USER,ITAG', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Workspace Id', + 'description' => 'The ID of the workspace to which the dataset belongs. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID. If you do not specify this parameter, the default workspace is used. If the default workspace does not exist, an error is reported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '324**', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset tag, which is used to filter datasets. Datasets whose tag key or tag value contains a specified string are filtered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset provider. If the value pai is returned, the dataset is a public dataset provided by PAI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pai', + ], + ], + [ + 'name' => 'SourceDatasetId', + 'in' => 'query', + 'schema' => [ + 'title' => 'iTag标注集的源数据集。', + 'description' => 'The ID of the iTAG labeled dataset that is used as the source dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-rcdg3wxxxxxhc5jk87'."\n", + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The field used for sorting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'ShareScope', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Datasets' => [ + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset.'."\n", + '$ref' => '#/components/schemas/Dataset', + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-c0h44g3wlwkj8o4348\\",\\n \\"UserId\\": \\"2004110000006048\\",\\n \\"OwnerId\\": \\"1004110000006048\\",\\n \\"Name\\": \\"AnimalDataset\\",\\n \\"DataSourceType\\": \\"OSS URL\\",\\n \\"Uri\\": \\"oss://xxx\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"DataType\\": \\"COMMON PIC TEXT VIDEO AUDIO\\",\\n \\"Property\\": \\"FILE DIRECTORY TABULAR\\",\\n \\"SourceType\\": \\"USER ITAG PAI_PUBLIC_DATASET\\",\\n \\"SourceId\\": \\"Source Id\\",\\n \\"Description\\": \\"Animal images.\\",\\n \\"WorkspaceId\\": \\"Workspace Id\\",\\n \\"Options\\": \\"jsonstring\\",\\n \\"Accessibility\\": \\"PRIVATE PUBLIC\\",\\n \\"ProviderType\\": \\"Ecs\\",\\n \\"SourceDatasetId\\": \\"d-bvfasdf4wxxj8o411\\",\\n \\"SourceDatasetVersion\\": \\"v2\\",\\n \\"TagTemplateType\\": \\"text-classification\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"v1\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\n },\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\",\\n \\"Edition\\": \\"BASIC\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"MountAccessReadWriteRoleIdList\\": [\\n \\"PAI.AlgoOperator\\"\\n ],\\n \\"IsShared\\": true,\\n \\"SharedFrom\\": {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n },\\n \\"SharingConfig\\": {\\n \\"SharedTo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"SourceTenantId\\": \\"\\",\\n \\"SourceWorkspaceId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"IsSecureMode\\": true,\\n \\"SharedAt\\": \\"\\",\\n \\"ExpiresAt\\": \\"\\",\\n \\"AllowedMountAccessLevels\\": [\\n \\"\\"\\n ],\\n \\"Extra\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + 'title' => 'ListDatasets', + ], + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wzlj****9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + 'title' => 'DeleteDataset', + ], + 'CreateDatasetLabels' => [ + 'summary' => 'Creates tags for a dataset.', + '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' => 'Dataset Id', + 'description' => 'The dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that is added to the dataset.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A083731B-4973-54D1-B324-E53****4DD44', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A083731B-4973-54D1-B324-E53****4DD44\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetLabels', + 'description' => 'Before you call this operation, take note of the following items:'."\n" + ."\n" + .'* The tag key and value are not empty strings and cannot exceed 128 characters in length.'."\n" + .'* The tag key cannot start with any of the following strings: "aliyun", "acs", "http://", and "https://".'."\n", + ], + 'DeleteDatasetLabels' => [ + 'summary' => 'Deletes a dataset tag.', + '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' => 'DatasetId', + 'description' => 'The dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-rbvg5****jhc9ks92', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key. You can call [GetDataset](~~457218~~) to obtain the tag key. Multiple tag keys are separated by commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1,key2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '64B50C1D-D4C2-560C-86A3-A6ED****16D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B50C1D-D4C2-560C-86A3-A6ED****16D\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatasetLabels', + ], + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Property' => [ + 'description' => 'The property of the dataset. Valid values:'."\n" + ."\n" + .'* FILE'."\n" + .'* DIRECTORY'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'DIRECTORY', + ], + 'DataSourceType' => [ + 'description' => 'The type of the data source. Separate multiple types with commas (,). Valid values:'."\n" + ."\n" + .'* NAS: File Storage NAS (NAS).'."\n" + .'* OSS: Object Storage Service (OSS).'."\n" + .'* CPFS'."\n" + ."\n" + .'Note: The DataSourceType value of a dataset version must be the same as that of the dataset. When you create a dataset version, the system checks whether the values are the same.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAS' => 'NAS', + 'OSS' => 'OSS', + ], + 'example' => 'OSS', + ], + 'Uri' => [ + 'description' => 'Example format:'."\n" + ."\n" + .'* Value format when DataSourceType is set to OSS: `oss://bucket.endpoint/object`.'."\n" + .'* Value formats when DataSourceType is set to NAS: General-purpose NAS: `nas://<nasfisid>.region/subpath/to/dir/`. CPFS 1.0: `nas://<cpfs-fsid>.region/subpath/to/dir/`. CPFS 2.0: `nas://<cpfs-fsid>.region/<protocolserviceid>/`. You can distinguish CPFS 1.0 and CPFS 2.0 file systems based on the format of the file system ID: The ID for CPFS 1.0 is in the cpfs-<8-bit ASCII characters> format. The ID for CPFS 2.0 is in the cpfs-<16-bit ASCII characters> format.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', + ], + 'Labels' => [ + 'description' => 'The tags of the dataset version.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'SourceType' => [ + 'description' => 'The type of the data source. Default value: USER. Valid values:'."\n" + ."\n" + .'* PAI-PUBLIC-DATASET: a public dataset of Platform for AI (PAI).'."\n" + .'* ITAG: a dataset generated from a labeling job of iTAG.'."\n" + .'* USER: a dataset registered by a user.'."\n" + ."\n" + .'For each job type:'."\n" + ."\n" + .'* PAI_PUBLIC_DATASET: PAI_PUBLIC_DATASET.'."\n" + .'* ITAG: ITAG.'."\n" + .'* USER: USER.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', + 'ITAG' => 'ITAG', + 'USER' => 'USER', + ], + 'example' => 'USER', + ], + 'SourceId' => [ + 'description' => 'The ID of the data source.'."\n" + ."\n" + .'* If SourceType is set to USER, the value of SourceId can be a custom string.'."\n" + .'* If SourceType is set to ITAG, the value of SourceId is the ID of the labeling job of iTAG.'."\n" + .'* If SourceType is set to PAI_PUBLIC_DATASET, SourceId is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-a0xbe5n03bhqof46ce', + ], + 'Options' => [ + 'description' => 'The extended field, which is of the JsonString type. When you use the dataset in Deep Learning Containers (DLC), you can use the mountPath field to specify the default mount path of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + ], + 'Description' => [ + 'description' => 'The description of the dataset. Descriptions are used to differentiate datasets.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'DataSize' => [ + 'description' => 'The size of the dataset file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '19000', + ], + 'DataCount' => [ + 'description' => 'The number of dataset files.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + 'ImportInfo' => [ + 'description' => 'The dataset storage import configurations, such as OSS, NAS, and CPFS.'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID\\'."\n" + .'"bucket": "${bucket}",//The bucket name\\'."\n" + .'"path": "${path}" // The file path\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**NAS**'."\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 point of the file system\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID\\'."\n" + .'"fileSystemId": "${file_system_id}", // The file system ID\\'."\n" + .'"protocolServiceId":"${protocol_service_id}", // The file system protocol service\\'."\n" + .'"exportId": "${export_id}", // The file system export directory\\'."\n" + .'"path": "${path}", // The file system path\\'."\n" + .'}\\'."\n" + ."\n\n" + .'**CPFS for Lingjun**'."\n" + ."\n" + .'{\\'."\n" + .'"region": "${region}",// The region ID\\'."\n" + .'"fileSystemId": "${file_system_id}", // The file system ID\\'."\n" + .'"path": "${path}", // The ile system path\\'."\n" + .'"mountTarget": "${mount_target}" // The mount point of the file system, CPFS for Lingjun only\\'."\n" + .'"isVpcMount": boolean, // Whether the mount point is a VPC mount point, CPFS for Lingjun only\\'."\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" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + ], + 'VersionName' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41A847C8-3D12-5F24-8CE9-7F9EB2DA9ECD\\",\\n \\"VersionName\\": \\"v1\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetVersion', + ], + 'GetDatasetVersion' => [ + 'summary' => 'Obtains the information about a specified version of a dataset.', + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The version name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => 'C55DF3DA-F120-5E37-A374-F49365531701', + ], + 'DatasetId' => [ + 'title' => '资源一级ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'd-dkdbnnap0g7b6su4yg', + 'pattern' => '', + 'default' => '', + ], + 'VersionName' => [ + 'title' => '数据集版本', + 'description' => 'The version name of the dataset.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'v1', + 'pattern' => '', + 'default' => '', + ], + 'Property' => [ + 'title' => '数据集的属性。', + 'description' => 'The property of the dataset.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'DIRECTORY', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'FILE', + 'DIRECTORY', + ], + ], + 'GmtCreateTime' => [ + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2023-12-13T10:22:05.694Z', + ], + 'GmtModifiedTime' => [ + 'title' => '创建时间。', + 'description' => 'The last modification time.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => '2023-12-13T10:22:05.694Z', + 'pattern' => '', + 'default' => '', + ], + 'DataSourceType' => [ + 'title' => '数据源类型。', + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'OSS', + 'NAS', + 'CPFS', + ], + ], + 'Uri' => [ + 'title' => 'Uri配置样例', + 'description' => 'The sample URI of the dataset.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'oss://ai4d-br7hx9ngzelo2o6uip.oss-cn-shanghai.aliyuncs.com/365349/data-1157703270994901/datasets/aka108o/', + 'pattern' => '', + 'default' => '', + ], + 'Labels' => [ + 'title' => '资源标签', + 'description' => 'The resource tags.'."\n", + 'type' => 'array', + 'items' => [ + 'deprecated' => false, + '$ref' => '#/components/schemas/Label', + 'description' => '', + ], + 'deprecated' => false, + 'maxItems' => 20, + ], + 'Options' => [ + 'title' => '扩展字段。', + 'description' => 'The extended fields.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + 'pattern' => '', + 'default' => '', + ], + 'SourceType' => [ + 'title' => '数据来源类型', + 'description' => 'The type of the data source.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'USER', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'USER', + 'ITAG', + 'PAI_PUBLIC_DATASET', + 'CLEANING', + 'ENHANCE', + 'ADDVERSION', + ], + ], + 'Description' => [ + 'title' => '版本描述', + 'description' => 'The version description.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'pattern' => '', + 'default' => '', + ], + 'SourceId' => [ + 'title' => '数据集来源ID。', + 'description' => 'The ID of the source dataset.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'd-rbvg5wzljzjhc9ks92', + 'default' => '', + ], + 'DataCount' => [ + 'title' => '数据量', + 'description' => 'The number of data records.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '10000', + 'pattern' => '', + 'default' => '', + ], + 'DataSize' => [ + 'title' => '数据集大小。', + 'description' => 'The size of the dataset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '10000', + 'pattern' => '', + 'default' => '', + ], + 'MountAccess' => [ + 'description' => 'The access permission on the dataset when the dataset is mounted. Valid values:'."\n" + ."\n" + .'* RO: read-only permissions'."\n" + .'* RW: read and write permissions'."\n", + 'type' => 'string', + 'example' => 'RO', + ], + 'ImportInfo' => [ + 'description' => 'The dataset configurations to be imported to a storage, such as Object Storage Service (OSS), File Storage NAS (NAS), or Cloud Parallel File Storage (CPFS).'."\n" + ."\n" + .'**OSS**'."\n" + ."\n" + .'{ "region": "${region}",// The region ID. $bucket = $options\\["bucket"]; // The bucket name. "path": "${path}" // The file path. }'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'**CPFS**'."\n" + ."\n" + .'**CPFS for Lingjun**'."\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" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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\\": \\"\\",\\n \\"Value\\": \\"\\"\\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"}]', + 'title' => 'GetDatasetVersion', + ], + 'ListDatasetVersions' => [ + 'summary' => 'Lists 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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wz****c9ks92', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. Default value: ASC. Valid values:'."\n" + ."\n" + .'* ASC: ascending order'."\n" + .'* DESC: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => 'ASC', + 'DESC' => 'DESC', + ], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset tag keys, which are used to filter datasets. Datasets whose tag keys or tag values contain a specified string are filtered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1,key2', + ], + ], + [ + 'name' => 'LabelValues', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset tag values, which are used to filter datasets. Datasets whose tag keys or tag values contain a specified string are filtered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1,value2', + ], + ], + [ + 'name' => 'Properties', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dataset properties. Valid values:'."\n" + ."\n" + .'* DIRECTORY'."\n" + .'* FILE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DIRECTORY' => 'DIRECTORY', + 'FILE' => 'FILE', + ], + 'example' => 'DIRECTORY', + ], + ], + [ + 'name' => 'SourceTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source type. Valid values:'."\n" + ."\n" + .'* PAI-PUBLIC-DATASET: a public dataset of Platform for AI (PAI).'."\n" + .'* ITAG: a dataset generated from a labeling job of iTAG.'."\n" + .'* USER: a dataset registered by a user.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAI_PUBLIC_DATASET' => 'PAI_PUBLIC_DATASET', + 'ITAG' => 'ITAG', + 'USER' => 'USER', + ], + 'example' => 'USER', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data source ID.'."\n" + ."\n" + .'* If SourceType is set to USER, the value of SourceId is a custom string.'."\n" + .'* If SourceType is set to ITAG, the value of SourceId is the ID of the labeling job of iTAG.'."\n" + .'* If SourceType is set to PAI_PUBLIC_DATASET, SourceId is empty by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-a0xbe5n03bhqof46ce', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used to sort the results in queries by page. Default value: GmtCreateTime.'."\n" + .'Valid values:'."\n" + ."\n" + .'* SourceType'."\n" + .'* DataSourceType'."\n" + .'* DataSize'."\n" + .'* DataCount'."\n" + .'* Property'."\n" + .'* GmtCreateTime: The results are sorted by creation time. This is the default value.'."\n" + .'* GmtModifiedTime: The results are sorted by modification time.'."\n" + .'* DatasetId', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SourceType' => 'SourceType', + 'DataSourceType' => 'DataSourceType', + 'DataSize' => 'DataSize', + 'DataCount' => 'DataCount', + 'Property' => 'Property', + 'GmtCreateTime' => 'GmtCreateTime', + 'GmtModifiedTime' => 'GmtModifiedTime', + 'DatasetId' => 'DatasetId', + ], + 'example' => 'GmtCreateTime', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0648C5BB-68D0-54D2-92A5-607135B8806B', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The number of dataset versions that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'DatasetVersions' => [ + 'description' => 'The dataset versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset version name.'."\n", + '$ref' => '#/components/schemas/DatasetVersion', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Property\\": \\"FILE\\",\\n \\"DataSourceType\\": \\"OSS\\",\\n \\"Uri\\": \\"OSS://xxx\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"DataCount\\": 0,\\n \\"DataSize\\": 0,\\n \\"MountAccess\\": \\"RO RW\\",\\n \\"ImportInfo\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDatasetVersions', + ], + 'UpdateDatasetVersion' => [ + 'summary' => 'Updates the information about a specified version of a dataset.', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5****jhc9ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Options' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "mountPath": "/mnt/data/"'."\n" + .'}', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'DataSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000', + ], + 'DataCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + 'title' => 'UpdateDatasetVersion', + ], + 'DeleteDatasetVersion' => [ + 'summary' => 'Deletes the information about a specified version of a dataset. Version v1 cannot be deleted by using this operation. When you call the DeleteDataset operation to delete a dataset, it can be deleted at the same time.', + '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. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-lfd60v0p****ujtsdx', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The dataset version name. The version number must be later than v1. Version v1 can only be deleted when the dataset is deleted.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatasetVersion', + ], + 'DeleteDatasetVersionLabels' => [ + 'summary' => 'Deletes tags for a dataset version.', + '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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5*****jhc9ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + [ + 'name' => 'Keys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag keys. Multiple tags are separated by commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'key1,key2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B2E89D7E-74F8-5656-A5D6-81D83403F9A8\\"\\n}","type":"json"}]', + 'title' => 'DeleteDatasetVersionLabels', + ], + 'CreateDatasetVersionLabels' => [ + 'summary' => 'Creates tags 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 dataset ID. You can call [ListDatasets](~~457222~~) to obtain the dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'd-rbvg5wzlj****9ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The dataset version name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag to be added to the dataset.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request'."\n", + 'type' => 'string', + 'example' => '8D7B2E70-F770-505B-A672-09F1D8F2EC1E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D7B2E70-F770-505B-A672-09F1D8F2EC1E\\"\\n}","type":"json"}]', + 'title' => 'CreateDatasetVersionLabels', + ], + 'CreateConnection' => [ + 'summary' => 'Creates a connection. This API is used to connect Platform for AI (PAI) to customer models and databases in LangStudio and multimodal dataset search scenarios.', + '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 data. The parameters that are required to create the connection.'."\n", + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'description' => 'The accessibility of the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The workspace is accessible only to you and the administrator of the workspace. This is the default value.'."\n" + .'* PUBLIC: The workspace is accessible to all users in the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + 'default' => 'PRIVATE', + ], + 'Configs' => [ + 'description' => 'The connection configurations, in key-value pairs. The key varies based on the connection type. For more information, see the supplementary notes below the request parameters.'."\n", + 'type' => 'object', + 'required' => true, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '6379', + 'description' => 'The value of the connection configuration.'."\n", + ], + ], + 'ConnectionName' => [ + 'description' => 'The connection name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'llm-connection', + ], + 'ConnectionType' => [ + 'description' => 'The connection type. Valid values:'."\n" + ."\n" + .'* DashScopeConnection: Alibaba Cloud Model Studio connection'."\n" + .'* OpenLLMConnection: open source model connection'."\n" + .'* MilvusConnection: Milvus connection'."\n" + .'* OpenSearchConnection: OpenSearch connection'."\n" + .'* LindormConnection: Lindorm connection'."\n" + .'* ElasticsearchConnection: Elasticsearch connection'."\n" + .'* HologresConnection: Hologres connection'."\n" + .'* RDSConnection: RDS connection'."\n" + .'* CustomConnection: custom connection'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ElasticsearchConnection' => 'ElasticsearchConnection', + 'MilvusConnection' => 'MilvusConnection', + 'OpenSearchConnection' => 'OpenSearchConnection', + 'HologresConnection' => 'HologresConnection', + 'DashScopeConnection' => 'DashScopeConnection', + 'LindormConnection' => 'LindormConnection', + 'RDSConnection' => 'RDSConnection', + 'OpenLLMConnection' => 'OpenLLMConnection', + 'CustomConnection' => 'CustomConnection', + ], + 'example' => 'DashScopeConnection', + ], + 'Description' => [ + 'description' => 'The connection description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Secrets' => [ + 'description' => 'The configuration to be encrypted. Examples: the database logon account and password and the key of the model service.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The value of the connection configuration to be encrypted.'."\n", + 'example' => 'Dsjk***hsl01', + ], + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123**45', + ], + 'ResourceMeta' => [ + 'description' => 'The instance resource information of the connection, which applies to database connections.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ld-uf69****9nqjjes', + ], + 'Extra' => [ + 'type' => 'string', + ], + ], + 'required' => false, + ], + 'Models' => [ + 'description' => 'The models, which apply to model service connections.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model.'."\n", + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => 'The model identifier.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'model_001', + ], + 'DisplayName' => [ + 'description' => 'The display name of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'ModelType' => [ + 'description' => 'The model type. Valid values:'."\n" + ."\n" + .'* LLM'."\n" + .'* Embedding'."\n" + .'* ReRank'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Embedding' => 'Embedding', + 'LLM' => 'LLM', + 'ReRank' => 'ReRank', + ], + 'example' => 'LLM', + ], + 'ToolCall' => [ + 'description' => 'Specifies whether a tool can be called by using ToolCall. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'ConnectionId' => [ + 'description' => 'The connection ID.'."\n", + 'type' => 'string', + 'example' => 'conn-pai9m***mi47', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ConnectionId\\": \\"conn-pai9m***mi47\\"\\n}","type":"json"}]', + 'title' => 'CreateConnection', + 'requestParamsDescription' => 'Examples of the Configs and Secrets settings for each connection type:'."\n" + ."\n" + .'* **DashScopeConnection/OpenLLMConnection**'."\n" + ."\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" + .'* **OpenSearchConnection/LindormConnection/ElasticsearchConnection**'."\n" + ."\n" + .'```'."\n" + ."\n" + .'{'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Confgs": {'."\n" + .' "uri": "xxx",'."\n" + .' "username": "xxx"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'* **MilvusConnection**'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' {'."\n" + .' "Secrets": {'."\n" + .' "password": "xxx"'."\n" + .' },'."\n" + .' "Confgs": {'."\n" + .' "uri": "xxx",'."\n" + .' "username": "xxx"'."\n" + .' }'."\n" + .' }'."\n" + ."\n" + .'* **HologresConnection**'."\n" + ."\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" + .'* **RDSConnection**'."\n" + ."\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" + .'* **CustomConnection**'."\n" + ."\n" + .'A custom format is used.'."\n", + ], + 'GetConnection' => [ + 'summary' => 'Obtains the connection details.', + '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. You can call [ListConnections](url) to obtain the connection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'conn-pai9m***mi47'."\n", + ], + ], + [ + 'name' => 'EncryptOption', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption settings. Valid values:'."\n" + ."\n" + .'* PlainText'."\n" + .'* Secret'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PlainText', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'WorkspaceId' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '11**43', + ], + 'Accessibility' => [ + 'description' => 'The resource accessibility. Valid values:'."\n" + ."\n" + .'* PUBLIC: All members in the workspace can access the workspace.'."\n" + .'* PRIVATE: Only the creator can access the workspace.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'ConnectionId' => [ + 'description' => 'The connection ID.'."\n", + 'type' => 'string', + 'example' => 'conn-pai9m***mi47', + ], + 'ConnectionType' => [ + 'description' => 'The type of the connection. Valid values:'."\n" + ."\n" + .'* DashScopeConnection: Alibaba Cloud Model Studio connection.'."\n" + .'* OpenLLMConnection: Open source model connection.'."\n" + .'* MilvusConnection: Milvus connection.'."\n" + .'* OpenSearchConnection: OpenSearch connection.'."\n" + .'* LindormConnection: Lindorm connection.'."\n" + .'* ElasticsearchConnection: Elasticsearch connection.'."\n" + .'* HologresConnection: Hologres connection.'."\n" + .'* RDSConnection: RDS connection.'."\n" + .'* CustomConnection: Custom connection.'."\n", + 'type' => 'string', + 'example' => 'OpenSearchConnection', + ], + 'ConnectionName' => [ + 'description' => 'The connection name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The connection description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Configs' => [ + 'description' => 'The connection configuration.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '12345', + 'description' => 'The value of the connection configuration.'."\n", + ], + ], + 'Secrets' => [ + 'description' => 'The encrypted configuration, in key-value pairs. Examples: the database logon password and the key of the model connection.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'Dsjk***hsl01', + 'description' => 'The value of the encrypted connection configuration.'."\n", + ], + ], + 'GmtCreateTime' => [ + 'description' => 'The time when the connection is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2025-03-07T07:54:56Z', + ], + 'GmtModifiedTime' => [ + 'description' => 'The time when the connection is modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2025-03-07T07:54:56Z', + ], + 'Creator' => [ + 'description' => 'The creator of the connection.'."\n", + 'type' => 'string', + 'example' => '28632***898231', + ], + 'ResourceMeta' => [ + 'description' => 'The instance resource information of the connection, which applies to database connections.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'ld-2vc1***v1zaqgzol', + ], + 'InstanceName' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Extra' => [ + 'type' => 'string', + ], + ], + ], + 'Models' => [ + 'description' => 'The models, which apply to model service connections.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => 'The model identifier.'."\n", + 'type' => 'string', + 'example' => 'model_001', + ], + 'DisplayName' => [ + 'description' => 'The display name of the model.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ModelType' => [ + 'description' => 'The model type. Valid values:'."\n" + ."\n" + .'* LLM'."\n" + .'* Embedding'."\n" + .'* ReRank'."\n", + 'type' => 'string', + 'example' => 'LLM', + ], + 'ToolCall' => [ + 'description' => 'Indicates whether a tool can be called by using ToolCall. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"数据库连接\\",\\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\\": \\"测试实例。\\",\\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', + ], + 'UpdateConnection' => [ + 'summary' => 'Updates a connection.', + '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. You can call [ListConnections](url) to obtain the connection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'conn-pai9m***mi47', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'description' => 'The connection configuration. The connection configuration is in the key-value format. The keys configured for different connection types are different. For more information, see the supplementary description of the request parameters in CreateConnection.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '6379', + 'description' => 'The value for the connection configuration.'."\n", + ], + ], + 'Description' => [ + 'description' => 'The connection description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Secrets' => [ + 'description' => 'The key-value configuration to be encrypted, such as the database logon password and the key for model connection.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'Dakbjas**aljksdn', + 'description' => 'The value for the encrypted connection configuration.'."\n", + ], + ], + 'Models' => [ + 'description' => 'The models.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model.'."\n", + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => 'The model identifier.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'model_001', + ], + 'DisplayName' => [ + 'description' => 'The display name of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'car_tag', + ], + 'ModelType' => [ + 'description' => 'The model type. Valid values:'."\n" + ."\n" + .'* LLM'."\n" + .'* Embedding'."\n" + .'* ReRank'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LLM', + ], + 'ToolCall' => [ + 'description' => 'Indicates whether tool calling is supported. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The message returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + 'title' => 'UpdateConnection', + ], + 'ListConnections' => [ + 'summary' => 'Lists 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' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '478**', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that indicates the start position from which to retrieve data on the next page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used to sort the results in queries by page. Default value: GmtCreateTime. Valid value:'."\n" + ."\n" + .'* GmtCreateTime: The results are sorted by creation time. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. This parameter must be used together with SortBy.'."\n" + ."\n" + .'* ASC: ascending order.'."\n" + .'* DESC: descending order. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'ConnectionIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The list of connection IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The connection ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'conn-ljasd***jsx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The connection name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ConnectionTypes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The list of connection types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The connection type. Valid values:'."\n" + ."\n" + .'* DashScopeConnection: Alibaba Cloud Model Studio connection.'."\n" + .'* OpenLLMConnection: Open source model connection.'."\n" + .'* MilvusConnection: Milvus connection.'."\n" + .'* OpenSearchConnection: OpenSearch connection.'."\n" + .'* LindormConnection: Lindorm connection.'."\n" + .'* ElasticsearchConnection: Elasticsearch connection.'."\n" + .'* HologresConnection: Hologres connection.'."\n" + .'* RDSConnection: RDS connection.'."\n" + .'* CustomConnection: Custom connection.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OpenLLMConnection', + ], + 'required' => false, + ], + ], + [ + 'name' => 'EncryptOption', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption settings. Valid values:'."\n" + ."\n" + .'* PlainText'."\n" + .'* Secret'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PlainText', + ], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => [ + 'description' => 'The model identifier.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'model_001', + ], + ], + [ + 'name' => 'ModelTypes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The list of model types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model type. Valid values:'."\n" + ."\n" + .'* LLM'."\n" + .'* Embedding'."\n" + .'* ReRank'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LLM', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ToolCall', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether a tool can be called by using ToolCall. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Connections' => [ + 'description' => 'The connection list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The connection.'."\n", + '$ref' => '#/components/schemas/Connection', + ], + ], + 'MaxResults' => [ + 'description' => 'The maximum number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'description' => 'The pagination token that indicates the start position from which to retrieve data on the next page.'."\n", + 'type' => 'string', + 'example' => '15', + ], + 'TotalCount' => [ + 'description' => 'The total number of connections that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B2C51F93-1C07-5477-9705-5FDB****F19F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Connections\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"ConnectionType\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"Secrets\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"WorkspaceId\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"ResourceMeta\\": {\\n \\"InstanceName\\": \\"\\",\\n \\"Extra\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n },\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"ConnectionName\\": \\"\\",\\n \\"ConnectionId\\": \\"\\",\\n \\"Configs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Models\\": [\\n {\\n \\"ToolCall\\": true,\\n \\"Model\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"ModelType\\": \\"\\"\\n }\\n ],\\n \\"GmtCreateTime\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"15\\",\\n \\"TotalCount\\": 27,\\n \\"RequestId\\": \\"B2C51F93-1C07-5477-9705-5FDB****F19F\\"\\n}","type":"json"}]', + 'title' => 'ListConnections', + ], + 'DeleteConnection' => [ + 'summary' => 'Deletes a connection.', + '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. You can call [ListConnections](url) to obtain the connection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'conn-pai9m***mi47', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned information.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteConnection', + ], + 'ValidateConnection' => [ + 'summary' => '验证连接', + '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' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'https://dashscope.aliyuncs.com/compatible-mode/v1', + ], + ], + 'ConnectionId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'conn-x2wz5zvvbyf2420fi9', + ], + 'ConnectionType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DashScopeConnection', + ], + 'Secrets' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => 'ZGJiZWQ2ZDY3MTMyYjJk****************NjE2NDg1NzM0YzlkZg==', + ], + ], + 'ValidateType' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Connectivity', + ], + 'WorkspaceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The connection is reachable.', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '403', + ], + 'Details' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + ], + 'CreateCodeSource' => [ + 'summary' => 'Creates a code build in Platform for AI (PAI). You can configure Git branches and commit IDs. After the code build is created, you can reference the code build in a Deep Learning Containers (DLC) job.', + '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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + 'DisplayName' => [ + 'title' => '代码源配置名称', + 'description' => 'The name of the code build.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MyCodeSource1', + ], + 'Description' => [ + 'title' => '代码源详细描述', + 'description' => 'The description of the code build, which helps you distinguish between code builds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'code source of dlc examples', + ], + 'CodeRepo' => [ + 'title' => '代码仓库地址', + 'description' => 'The URL of the code repository.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://code.aliyun.com/******', + ], + 'CodeRepoUserName' => [ + 'title' => '代码仓库的用户名', + 'description' => 'The username of the code repository.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'use***', + ], + 'CodeRepoAccessToken' => [ + 'title' => '代码仓库访问Token', + 'description' => 'The token used to access the code repository.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'CodeBranch' => [ + 'title' => '代码分支', + 'description' => 'The code branch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'master', + ], + 'MountPath' => [ + 'title' => '代码本地挂载目录，默认挂载到/root/code/下', + 'description' => 'The local mount path of the code. By default, the code is mounted to the /root/code/ path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/root/code/code-source-1', + ], + 'Accessibility' => [ + 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', + 'description' => 'The visibility of the code build. Valid values:'."\n" + ."\n" + .'* PUBLIC: The code build is visible to all members in the workspace.'."\n" + .'* PRIVATE: The code build is visible only to you and the administrator of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + ], + 'CodeCommit' => [ + 'title' => '代码的CommitID。CodeCommit的优先级大于CodeBranch，即如果您填写了CodeCommit，则CodeBranch不会生效。', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => [ + 'title' => '创建的代码源配置的ID', + 'description' => 'The ID of the created code build.'."\n", + 'type' => 'string', + 'example' => 'code-20********', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3**********', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20********\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3**********\\"\\n}","type":"json"}]', + 'title' => 'CreateCodeSource', + ], + 'DeleteCodeSource' => [ + 'summary' => 'Deletes a code source based on the provided 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 to be deleted. You can call [ListCodeSources](~~459922~~) to query the code source ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'code-20210111103721-85qz78ia96lu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => [ + 'title' => '被删除的代码源配置ID', + 'description' => 'The ID of the deleted code source.'."\n", + 'type' => 'string', + 'example' => 'code-20210111103721-85qz78ia96lu', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteCodeSource', + ], + 'PublishCodeSource' => [ + 'summary' => 'Publishes a private code source to a workspace to make the code source publicly accessible.', + '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 be published. You can call [ListCodeSources](~~459922~~) to query the code source ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'code-a797*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => [ + 'title' => '被删除的代码源配置ID', + 'description' => 'The ID of the code source that is successfully published.'."\n", + 'type' => 'string', + 'example' => 'code-a797*******', + ], + 'RequestId' => [ + 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSourceId\\": \\"code-a797*******\\",\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'PublishCodeSource', + ], + 'UpdateCodeSource' => [ + 'summary' => 'Updates a code build.', + 'path' => '/api/v1/codesources/{CodeSourceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'free', + 'abilityTreeCode' => '246302', + 'abilityTreeNodes' => [ + 'FEATURElearnFOSXQT', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CodeSourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码配置的ID', + 'description' => 'The ID of the code build. You can call CreateCodeSource, GetCodeSource, or ListCodeSources to obtain the ID of the code build.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'code-202**********', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '代码配置的名称', + 'description' => 'The name of the code build.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MyCodeSource1', + ], + 'Description' => [ + 'title' => '代码配置的描述', + 'description' => 'The description of the code build.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'CodeRepo' => [ + 'title' => '代码仓库地址', + 'description' => 'The address of the code repository.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://code.aliyun.com/******', + ], + 'CodeBranch' => [ + 'title' => '代码分支', + 'description' => 'The name of the code branch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dev', + ], + 'CodeCommit' => [ + 'title' => '代码的CommitID', + 'description' => 'The code commit ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3a6*****', + ], + 'CodeRepoUserName' => [ + 'title' => '用于访问代码仓库的用户名', + 'description' => 'The username used to access the code repository.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo-user', + ], + 'CodeRepoAccessToken' => [ + 'title' => '用户名对应的访问Token', + 'description' => 'The access token corresponding to the username.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'MountPath' => [ + 'title' => '默认的挂载路径', + 'description' => 'The default mount path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/root/code/code-source-1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '40325405-579C-4D82****', + ], + 'CodeSourceId' => [ + 'title' => '代码配置的ID', + 'description' => 'The ID of the code build.'."\n", + 'type' => 'string', + 'example' => 'code-20********', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"CodeSourceId\\": \\"code-20********\\"\\n}","type":"json"}]', + 'title' => 'UpdateCodeSource', + ], + 'GetCodeSource' => [ + 'summary' => 'Obtains the details of a code source.', + 'path' => '/api/v1/codesources/{CodeSourceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CodeSourceId', + 'in' => 'path', + 'schema' => [ + 'title' => '代码源配置ID', + 'description' => 'The ID of the code source. You can call [ListCodeSources](~~459922~~) to query the code source ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'code-202**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeSourceId' => [ + 'title' => '代码源配置ID', + 'description' => 'The ID of the code source.'."\n", + 'type' => 'string', + 'example' => 'code-202**********', + ], + 'DisplayName' => [ + 'title' => '代码源配置名字', + 'description' => 'The name of the code source.'."\n", + 'type' => 'string', + 'example' => 'MyCodeSource1', + ], + 'Description' => [ + 'title' => '详细描述', + 'description' => 'The description of the code source.'."\n", + 'type' => 'string', + 'example' => 'This is my data source 1.', + ], + 'CodeRepo' => [ + 'title' => '代码仓库地址', + 'description' => 'The address of the code repository.'."\n", + 'type' => 'string', + 'example' => 'https://code.aliyun.com/pai-dlc/examples.git', + ], + 'CodeBranch' => [ + 'title' => '代码仓库分支', + 'description' => 'The code repository branch.'."\n", + 'type' => 'string', + 'example' => 'master', + ], + 'CodeCommit' => [ + 'title' => '代码Commit', + 'description' => 'The code commit ID.'."\n", + 'type' => 'string', + 'example' => '44da10***********', + ], + 'CodeRepoUserName' => [ + 'title' => '代码仓库的用户名', + 'description' => 'The username of the code repository.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'CodeRepoAccessToken' => [ + 'title' => '访问代码仓库的token', + 'description' => 'The token used to access the code repository.'."\n", + 'type' => 'string', + 'example' => 'xxxx', + ], + 'MountPath' => [ + 'title' => '代码本地挂载目录，默认挂载到/root/code/下', + 'description' => 'The local mount path of the code.'."\n", + 'type' => 'string', + 'example' => '/root/code', + ], + 'Accessibility' => [ + 'title' => '代码是否是本工作空间内公开的，可选值PRIVATE、PUBLIC', + 'description' => 'The visibility of the code source. Valid values:'."\n" + ."\n" + .'* PRIVATE: Visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: Visible to all members in the workspace.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + ], + 'UserId' => [ + 'title' => '代码配置源的创建者ID', + 'description' => 'The ID of the creator.'."\n", + 'type' => 'string', + 'example' => '1722********', + ], + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '1234', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the code source was created, in the ISO8601 format.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T23:36:01.123Z', + ], + 'GmtModifyTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the code source was modified, in the ISO8601 format.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T23:36:01.123Z', + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + '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}","type":"json"}]', + 'title' => 'GetCodeSource', + ], + 'ListCodeSources' => [ + 'summary' => 'Lists code sources. Pagination, sorting, and filtering by condition are supported.', + '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 source. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MyDataSource', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '取第几页的数据', + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '用于排序的字段名，可选字段名："DisplayName" "GmtCreateTime" "GmtModifyTime"', + 'description' => 'The field used for sorting. Valid values:'."\n" + ."\n" + .'* GmtModifyTime: the time when the code source was modified.'."\n" + .'* DisplayName: the display name.'."\n" + .'* CodeSourceId: the code source ID.'."\n" + .'* GmtCreateTime: the time when the code source was created. This is the default value.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'GmtModifyTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序, 枚举值 desc 或者 asc', + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. Valid values:'."\n" + ."\n" + .'* ASC (default)'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'desc', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeSources' => [ + 'title' => '代码源配置列表', + 'description' => 'The code sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the code source.'."\n", + '$ref' => '#/components/schemas/CodeSourceItem', + ], + ], + 'TotalCount' => [ + 'title' => '符合过滤条件的代码源配置的总数量', + 'description' => 'The total number of code sources that meet the filter conditions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CodeSources\\": [\\n {\\n \\"CodeSourceId\\": \\"code-20210111103721-85qz78ia96lu\\",\\n \\"DisplayName\\": \\"MyCodeSourceName1\\",\\n \\"Description\\": \\"code source of dlc examples\\",\\n \\"CodeRepo\\": \\"https://code.aliyun.com/pai-dlc/examples.git\\",\\n \\"CodeBranch\\": \\"master\\",\\n \\"CodeCommit\\": \\"44da109b59f8596152987eaa8f3b2487bb72ea63\\",\\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 }\\n ],\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'ListCodeSources', + ], + 'CreateModel' => [ + 'summary' => 'Creates a model. A model is a collection of model versions. When you create a model, you must specify 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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'ModelName' => [ + 'title' => 'ModelName', + 'description' => 'The name of the model. The name must be 1 to 127 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + 'Labels' => [ + 'title' => 'Labels', + 'description' => 'The tags. This parameter will be deprecated and replaced by Tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'Tag' => [ + 'title' => 'Tag', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag. This is the same as Label.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'ModelDescription' => [ + 'title' => 'ModelDescription', + 'description' => 'The model description, used to distinguish different models.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'WorkspaceId' => [ + 'title' => 'WorkspaceId', + 'description' => 'The workspace ID. Call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '796**', + ], + 'Accessibility' => [ + 'title' => 'Accessibility', + 'description' => 'The visibility of the model in the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): Visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: Vvisible to all users in the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => 'PUBLIC', + 'PRIVATE' => 'PRIVATE', + ], + 'example' => 'PRIVATE', + ], + 'Origin' => [ + 'title' => '模型源', + 'description' => 'The source of the model. The community or organization to which the source model belongs, such as ModelScope or HuggingFace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ModelScope', + ], + 'Domain' => [ + 'title' => '领域', + 'description' => 'The domain of the model. Describes the domain in which the model is for. Example: nlp (natural language processing), cv (computer vision), and others.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nlp', + ], + 'Task' => [ + 'title' => '模型任务', + 'description' => 'The task of the model. Describes the specific problem that the model solves. Example: text-classification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text-classification', + ], + 'ModelDoc' => [ + 'title' => '模型介绍文档', + 'description' => 'The documentation of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://*.md', + ], + 'OrderNumber' => [ + 'title' => '序号', + 'description' => 'The sequence number of the model. Can be used for custom sorting.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'ModelType' => [ + 'title' => '模型类型', + 'description' => 'The model type. Example: Checkpoint or LoRA.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Checkpoint', + ], + 'ExtraInfo' => [ + 'title' => '其它信息', + 'description' => 'Other information about the model.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9DAD3112-AE22-5563-9A02-5C7E8****E35', + ], + 'ModelId' => [ + 'description' => 'The model ID.'."\n", + 'type' => 'string', + 'example' => 'model-rbvg5wzljz****ks92', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DAD3112-AE22-5563-9A02-5C7E8****E35\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\"\\n}","type":"json"}]', + 'title' => 'CreateModel', + ], + 'UpdateModel' => [ + 'summary' => 'Updates the basic configuration information about 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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5wz******ks92', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request data.'."\n", + 'type' => 'object', + 'properties' => [ + 'ModelName' => [ + 'title' => '模型名称', + 'description' => 'The model name, which must be 1 to 127 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'ModelDescription' => [ + 'title' => '模型描述', + 'description' => 'The model description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Accessibility' => [ + 'title' => '可见度', + 'description' => 'The visibility of the model in the workspace. Valid values:'."\n" + ."\n" + .'* PRIVATE: The model is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The model is visible to all users in the workspace.'."\n", + '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. Valid values: ModelScope and HuggingFace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ModelScope', + ], + 'Domain' => [ + 'title' => '领域', + 'description' => 'The domain. This parameter describes the domain in which the model is applied. Valid values: nlp (natural language processing) and cv (computer vision).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nlp', + ], + 'Task' => [ + 'title' => '模型任务', + 'description' => 'The task. This parameter specifies the specific issue that the model resolves. Example: text-classification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text-classification', + ], + 'ModelDoc' => [ + 'title' => '模型介绍文档', + 'description' => 'The documentation of the model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://*.md', + ], + 'OrderNumber' => [ + 'title' => '序号', + 'description' => 'The sequence number of the model. This parameter can be used for custom sorting.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'ModelType' => [ + 'title' => '模型类型', + 'description' => 'The model type. Valid values: Checkpoint and LoRA.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Checkpoint', + ], + 'ExtraInfo' => [ + 'title' => '其它信息', + 'description' => 'Other information about the model.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0F049F0-8D69-5BAC-8F10-B******A34C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0F049F0-8D69-5BAC-8F10-B******A34C\\"\\n}","type":"json"}]', + 'title' => 'UpdateModel', + ], + 'GetModel' => [ + 'summary' => 'Obtains 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' => 'Model Id', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5****c9ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'ModelId' => [ + 'title' => '模型ID', + 'description' => 'The model ID.'."\n", + 'type' => 'string', + 'example' => 'model-rbvg5wzljz****ks92', + ], + 'ModelName' => [ + 'title' => '模型名称', + 'description' => 'The model name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'ModelDescription' => [ + 'title' => '模型描述', + 'description' => 'The model description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the model is created, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'GmtModifiedTime' => [ + 'title' => '最后更新时间', + 'description' => 'The time when the model is last modified, in UTC. The time follows the ISO 8601 standard.'."\n", + 'type' => 'string', + 'example' => '2021-01-30T12:51:33.028Z', + ], + 'UserId' => [ + 'title' => '创建模型的用户ID', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1234567890******', + ], + 'OwnerId' => [ + 'title' => '云账号ID', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '1234567890******', + ], + 'Origin' => [ + 'title' => '模型源', + 'description' => 'The source of the model. The community or organization to which the model belongs, such as ModelScope or HuggingFace.'."\n", + 'type' => 'string', + 'example' => 'ModelScope', + ], + 'Provider' => [ + 'title' => '提供者', + 'description' => 'The provider.'."\n", + 'type' => 'string', + 'example' => 'pai', + ], + 'Domain' => [ + 'title' => '领域', + 'description' => 'The domain. This parameter specifies the domain for which the model is developed. Valid values: nlp and cv. nlp indicates natural language processing and cv indicates computer vision.'."\n", + 'type' => 'string', + 'example' => 'cv', + ], + 'Task' => [ + 'title' => '任务', + 'description' => 'The task of the model. This parameter describes specific issues that the model solves, such as text-classification.'."\n", + 'type' => 'string', + 'example' => 'text-classification', + ], + 'ModelDoc' => [ + 'title' => '模型文档', + 'description' => 'The documentation of the model.'."\n", + 'type' => 'string', + 'example' => 'https://***.md', + ], + 'Labels' => [ + 'title' => '模型的标签', + 'description' => 'The model tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + '$ref' => '#/components/schemas/Label', + ], + ], + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '234**', + ], + 'Accessibility' => [ + 'title' => '可见性', + 'description' => 'The visibility of the workspace.'."\n" + ."\n" + .'* PRIVATE: The workspace is visible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The workspace is visible to all users.'."\n", + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'LatestVersion' => [ + 'title' => '模型的最新版本', + 'description' => 'The latest version of the model.'."\n", + '$ref' => '#/components/schemas/ModelVersion', + ], + 'ModelType' => [ + 'title' => '模型类型', + 'description' => 'The model type.'."\n", + 'type' => 'string', + 'example' => 'Checkpoint', + ], + 'ExtraInfo' => [ + 'title' => '其它信息', + 'description' => 'Other information about the model.'."\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" + .'}', + ], + 'OrderNumber' => [ + 'title' => '序号', + 'description' => 'The sequence number of the model.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ParameterSize' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GmtLatestVersionModifiedTime' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"ModelId\\": \\"model-rbvg5wzljz****ks92\\",\\n \\"ModelName\\": \\"情感分析\\",\\n \\"ModelDescription\\": \\"通用情感分析。\\",\\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\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"WorkspaceId\\": \\"234**\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"LatestVersion\\": {\\n \\"VersionName\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\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', + ], + 'ListModels' => [ + 'summary' => 'Queries 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. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序', + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. Default value: ASC.'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序依据', + 'description' => 'The field used to sort the results. The GmtCreateTime field is used for sorting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间ID', + 'description' => 'The workspace ID. Only models in this workspace are queried. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '324**', + ], + ], + [ + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => [ + 'title' => '模型名称', + 'description' => 'The model name used to filter the returned models.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'title' => '标签', + 'description' => 'The label. Models whose label key or label value contains a specific label are filtered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => [ + 'title' => '模型提供者', + 'description' => 'The provider. If you configure this parameter, only the models exposed by the provider are returned. If you leave this parameter empty, only models owned by the user are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pai', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => '领域', + 'description' => 'The domain. Only models in the domain are returned. Valid values: nlp (Natural Language Processing) and cv (Computer Vision).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nlp', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'title' => '模型任务', + 'description' => 'The task used to filter the models that belong to the task type. Example: text-classification.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text-classification', + ], + ], + [ + 'name' => 'Origin', + 'in' => 'query', + 'schema' => [ + 'title' => '模型源', + 'description' => 'The model source used to filter the models that belong to a community or organization, such as ModelScope and Hugging Face.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ModelScope', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选请求串', + 'description' => 'The query condition. For example, if you set the value to nlp, all models that match ModelName, Domain, Task, LabelKey, and LabelValue are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nlp', + ], + ], + [ + 'name' => 'ModelType', + 'in' => 'query', + 'schema' => [ + 'title' => '模型类型', + 'description' => 'The model type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Endpoint', + ], + ], + [ + 'name' => 'Collections', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '模型所在Collection，支持填写多个，用英文逗号分割', + 'description' => 'The collection where the model is located. You can specify multiple collections and separate them with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AI4D,QuickStart', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags of the model.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag of the model.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Conditions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Column' => [ + 'type' => 'string', + ], + 'Operator' => [ + 'type' => 'string', + ], + 'Value' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'Models' => [ + 'title' => '模型列表', + 'description' => 'The models.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model.'."\n", + '$ref' => '#/components/schemas/Model', + ], + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of models.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + '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\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"OrderNumber\\": 101,\\n \\"Origin\\": \\"ModelScope\\",\\n \\"Domain\\": \\"cv\\",\\n \\"Task\\": \\"text-classifiaction\\",\\n \\"ModelDoc\\": \\"https://***.md\\",\\n \\"Provider\\": \\"pai\\",\\n \\"ModelType\\": \\"Checkpoint\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ParameterSize\\": 1024,\\n \\"GmtLatestVersionModifiedTime\\": \\"2021-01-21T17:12:35Z\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + 'title' => 'ListModels', + ], + '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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5wzl****ks92', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteModel', + ], + 'CreateModelVersion' => [ + 'summary' => 'Creates a new version for the 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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'VersionName' => [ + 'title' => '模型版本，模型下唯一。', + 'description' => 'The model version, which is unique for each model. If you leave this parameter empty, the first version is **0.1.0** by default. After that, the minor version number is increased by 1 in sequence. For example, the second version number is **0.2.0**. A version number consists of a major version number, a minor version number, and a stage version number, separated by periods (.). The major version number and minor version number are numeric. The stage version number begins with a digit and can include numbers, underscores, and letters. For example, the version number is 1.1.0 or 2.3.4\\_beta.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.1.0', + ], + 'Uri' => [ + 'title' => '版本Uri', + 'description' => 'The URI of the model version, which is the location where the model is stored. Valid values:'."\n" + ."\n" + .'* The HTTP(S) address of the model. Example: `https://myweb.com/mymodel.tar.gz`.'."\n" + .'* The OSS path of the model, in the format of `oss://<bucket>.<endpoint>/object`. For information about endpoints, see [OSS regions and endpoints](~~31837~~). Example: `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/', + ], + 'Labels' => [ + 'title' => '标签', + 'description' => 'The labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + 'VersionDescription' => [ + 'title' => '版本描述', + 'description' => 'The version description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'FormatType' => [ + 'title' => '模型类型', + 'description' => 'The model format. Valid values:'."\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', + '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 model framework. Valid values:'."\n" + ."\n" + .'* Pytorch'."\n" + .'* XGBoost'."\n" + .'* Keras'."\n" + .'* Caffe'."\n" + .'* Alink'."\n" + .'* Xflow'."\n" + .'* TensorFlow'."\n", + '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 field. This is a JSON string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + 'Metrics' => [ + 'title' => '指标', + 'description' => 'The metrics for the model. The length after serialization is limited to 8,192.'."\n", + '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, which is used for fine-tuning and incremental training.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'InferenceSpec' => [ + 'title' => '描述如何应用于下游的推理应用', + 'description' => 'Describes how to apply to downstream inference services. For example, describe the processor and container of EAS. Example: `{ "processor": "tensorflow_gpu_1.12" }`'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "processor": "tensorflow_gpu_1.12"'."\n" + .'}', + ], + 'SourceType' => [ + 'title' => '来源类型', + 'description' => 'The type of the model source. Valid values:'."\n" + ."\n" + .'* Custom (default)'."\n" + .'* PAIFlow'."\n" + .'* TrainingService: the Platform for AI (PAI) training service.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAIFlow' => 'PAIFlow', + 'Custom' => 'Custom', + 'TrainingService' => 'TrainingService', + ], + 'example' => 'PAIFlow', + ], + 'SourceId' => [ + 'title' => '来源ID', + 'description' => 'The ID of the model source.'."\n" + ."\n" + .'* If SourceType is set to Custom, this parameter is not limited.'."\n" + .'* If SourceType is set to PAIFlow or TrainingService, the ID of the model source is in the following format:'."\n" + ."\n" + .'<!---->'."\n" + ."\n" + .' region=<region_id>,workspaceId=<workspace_id>,kind=<kind>,id=<id>'."\n" + ."\n" + .'Take note of the following parameters:'."\n" + ."\n" + .'* region indicates the region ID.'."\n" + .'* workspaceId indicates the workspace ID.'."\n" + .'* kind indicates the type. Valid values: PipelineRun (PAIFlow) and ServiceJob (training service).'."\n" + .'* id indicates the unique identifier.'."\n", + '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'."\n" + .'* Approved'."\n" + .'* Rejected'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Approved', + ], + 'EvaluationSpec' => [ + 'title' => '评测配置', + 'description' => 'The evaluation configuration.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'CompressionSpec' => [ + 'title' => '压缩配置', + 'description' => 'The compression configuration.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'ExtraInfo' => [ + 'title' => '其它信息', + 'description' => 'The additional information.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => [ + 'title' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-dfs1****5c', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '21645FCD-BAB9-5742-89AE-AEB27****B2E', + ], + 'VersionName' => [ + 'title' => '模型名称', + 'description' => 'The version of the model.'."\n", + 'type' => 'string', + 'example' => '0.1.0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21645FCD-BAB9-5742-89AE-AEB27****B2E\\",\\n \\"VersionName\\": \\"0.1.0\\"\\n}","type":"json"}]', + 'title' => 'CreateModelVersion', + ], + '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 parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'VersionDescription' => [ + 'title' => '模型版本描述', + 'description' => 'The model version description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Metrics' => [ + 'title' => '指标', + 'description' => 'The model metrics. The length after serialization is limited to 8,192.'."\n", + '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 used for fine-tuning and incremental training.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'InferenceSpec' => [ + 'title' => '描述下游的推理应用', + 'description' => 'Describes how to apply to downstream inference services. For example, describes the processor and container of Elastic Algorithm Service (EAS). Example: `{ "processor": "tensorflow_gpu_1.12" }`.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{ "processor": "tensorflow_gpu_1.12" }', + ], + 'Options' => [ + 'title' => '扩展字段。', + 'description' => 'The extended field, which is of the JsonString type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + 'SourceType' => [ + 'title' => '来源类型', + 'description' => 'The type of the model source. Valid values:'."\n" + ."\n" + .'* Custom (default)'."\n" + .'* PAIFlow'."\n" + .'* TrainingService'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAIFlow' => 'PAIFlow', + 'Custom' => 'Custom', + 'TrainingService' => 'TrainingService', + ], + 'example' => 'PAIFlow', + ], + 'SourceId' => [ + 'title' => '来源ID', + '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=<region_id>,workspaceId=<workspace_id>,kind=<kind>,id=<id>'."\n" + ."\n" + .'Take note of the following parameters:'."\n" + ."\n" + .'* region is the region ID.'."\n" + .'* workspaceId is the ID of the workspace.'."\n" + .'* kind is the type. Valid values: PipelineRun (PAIFlow) and ServiceJob (training service).'."\n" + .'* id is a unique identifier.'."\n", + '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'."\n" + .'* Approved'."\n" + .'* Rejected'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Approved', + ], + 'EvaluationSpec' => [ + 'title' => '评测配置', + 'description' => 'The evaluation configuration.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'CompressionSpec' => [ + 'title' => '压缩配置', + 'description' => 'The compression configuration.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + 'ExtraInfo' => [ + 'title' => '其它信息', + 'description' => 'The additional information.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => [ + 'title' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-dfs1****5c', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型版本', + 'description' => 'The model version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5BFFEE3-6025-443F-8A03-02D61***C4B9', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5BFFEE3-6025-443F-8A03-02D61***C4B9\\"\\n}","type":"json"}]', + 'title' => 'UpdateModelVersion', + ], + 'GetModelVersion' => [ + 'summary' => 'Queries 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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5wzljz****ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型版本', + 'description' => 'The model version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + '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-30T12:51:33.028Z', + ], + '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-30T12:51:33.028Z', + ], + 'UserId' => [ + 'title' => '创建者ID', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1234567890******', + ], + 'OwnerId' => [ + 'title' => '云账号ID', + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '1234567890******', + ], + 'Uri' => [ + 'title' => '模型Uri', + 'description' => 'The URI of the model version, which is the location where the model is stored. Valid values:'."\n" + ."\n" + .'* The HTTP(S) address of the model. Example: `https://myweb.com/mymodel.tar.gz`.'."\n" + .'* The Object Storage Service (OSS) path of the model, in the format of `oss://<bucket>.<endpoint>/object`. For endpoint, see [OSS regions and endpoints](~~31837~~). Example: `oss://mybucket.oss-cn-beijing.aliyuncs.com/mypath/`.'."\n", + 'type' => 'string', + 'example' => 'oss://t***.cn-beijing.oss.aliyuncs.com/mod**/', + ], + 'Labels' => [ + 'title' => '模型版本标签', + 'description' => 'The labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + '$ref' => '#/components/schemas/Label', + ], + ], + 'Options' => [ + 'title' => '扩展字段', + 'description' => 'The extended field. The value of this parameter is a JSON string.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'VersionName' => [ + 'title' => '版本名', + 'description' => 'The model version.'."\n", + 'type' => 'string', + 'example' => '0.1.0', + ], + 'VersionDescription' => [ + 'title' => '版本描述', + 'description' => 'The version description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'TrainingSpec' => [ + 'title' => '训练配置', + 'description' => 'The training configurations used for fine-tuning and incremental training.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'InferenceSpec' => [ + 'title' => '下游部署配置', + 'description' => 'Describes how to apply to downstream inference services. For example, describes the processor and container of Elastic Algorithm Service (EAS).'."\n", + 'type' => 'object', + 'example' => '{'."\n" + .' "Processor": "tensorflow_gpu_1.12"'."\n" + .'}', + ], + 'FormatType' => [ + 'title' => '模型格式', + 'description' => 'The model format. Valid values:'."\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', + ], + 'FrameworkType' => [ + 'title' => '模型框架', + 'description' => 'The model framework. Valid values:'."\n" + ."\n" + .'* Pytorch -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', + ], + 'SourceType' => [ + 'title' => '来源类型', + 'description' => 'The source type of the model. Valid values:'."\n" + ."\n" + .'* Custom'."\n" + .'* PAIFlow'."\n" + .'* TrainingService'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PAIFlow' => 'PAIFlow', + 'Custom' => 'Custom', + 'TrainingService' => 'TrainingService', + ], + 'example' => 'PAIFlow', + ], + 'SourceId' => [ + 'title' => '来源ID', + '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=<region_id>,workspaceId=<workspace_id>,kind=<kind>,id=<id>'."\n" + ."\n" + .'Take note of the following parameters:'."\n" + ."\n" + .'* region is the region ID.'."\n" + .'* workspaceId is the ID of the workspace.'."\n" + .'* kind is the type. Valid values: PipelineRun (PAIFlow) and ServiceJob (training service).'."\n" + .'* id is a unique identifier.'."\n", + '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'."\n" + .'* Approved'."\n" + .'* Rejected'."\n", + 'type' => 'string', + 'example' => 'Approved', + ], + 'EvaluationSpec' => [ + 'title' => '评测配置', + 'description' => 'The evaluation configuration.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'CompressionSpec' => [ + 'title' => '压缩配置', + 'description' => 'The compression configuration.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + '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" + .'}', + ], + 'Metrics' => [ + 'title' => '指标', + 'description' => 'The metrics.'."\n", + 'type' => 'object', + 'example' => '{}', + ], + 'DistillationSpec' => [ + 'type' => 'object', + ], + ], + ], + ], + ], + '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\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Options\\": \\"{}\\",\\n \\"VersionName\\": \\"0.1.0\\",\\n \\"VersionDescription\\": \\"通用情感分析。\\",\\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', + ], + 'ListModelVersions' => [ + 'summary' => 'Queries 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. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '顺序', + 'description' => 'The order in which the entries are sorted by the specific field on the returned page. Default value: ASC.'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序依据', + 'description' => 'The field used to sort the results. The GmtCreateTime field is used for sorting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'query', + 'schema' => [ + 'title' => '模型版本名称', + 'description' => 'The model version used to filter model versions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.1', + ], + ], + [ + 'name' => 'FormatType', + 'in' => 'query', + 'schema' => [ + 'title' => '模型格式类型', + 'description' => 'The model format used to filter model versions. Valid values:'."\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', + '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 framework used to filter model versions.'."\n" + ."\n" + .'* Pytorch -XGBoost'."\n" + .'* Keras'."\n" + .'* Caffe'."\n" + .'* Alink'."\n" + .'* Xflow'."\n" + .'* TensorFlow'."\n", + '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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-dajbueh******', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '来源类型', + 'description' => 'The source type used to filter model versions. Valid values:'."\n" + ."\n" + .'* Custom (default)'."\n" + .'* PAIFlow'."\n" + .'* TrainingService'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PAIFlow' => 'PAIFlow', + 'Custom' => 'Custom', + 'TrainingService' => 'TrainingService', + ], + 'example' => 'PAIFlow', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '来源ID', + '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=<region_id>,workspaceId=<workspace_id>,kind=<kind>,id=<id>'."\n" + ."\n" + .'Take note of the following parameters:'."\n" + ."\n" + .'* region is the region ID.'."\n" + .'* workspaceId is the ID of the workspace.'."\n" + .'* kind is the type. Valid values: PipelineRun (PAIFlow) and ServiceJob (training service).'."\n" + .'* id is a unique identifier.'."\n", + '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. Model versions whose label key or label value contains a specific label are filtered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + ], + [ + 'name' => 'ApprovalStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '准入状态', + 'description' => 'The approval status based on which the model versions are queried. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Approved'."\n" + .'* Rejected'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Approved', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC***3C83E', + ], + 'Versions' => [ + 'title' => '模型版本列表', + 'description' => 'The model versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The model version.'."\n", + '$ref' => '#/components/schemas/ModelVersion', + ], + ], + 'TotalCount' => [ + 'title' => '总数', + 'description' => 'The total number of model versions.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC***3C83E\\",\\n \\"Versions\\": [\\n {\\n \\"VersionName\\": \\"1.0.0\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35Z\\",\\n \\"UserId\\": \\"155770209******\\",\\n \\"OwnerId\\": \\"155770209******\\",\\n \\"Uri\\": \\"oss://bucket/path-to-model\\",\\n \\"VersionDescription\\": \\"\\",\\n \\"FormatType\\": \\"SavedModel\\",\\n \\"FrameworkType\\": \\"TensorFlow\\",\\n \\"Options\\": \\"\\",\\n \\"SourceType\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"ApprovalStatus\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Metrics\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TrainingSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"InferenceSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EvaluationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"CompressionSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"DistillationSpec\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","type":"json"}]', + 'title' => 'ListModelVersions', + ], + '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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5wzljz****ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型版本', + 'description' => 'The model version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.1.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteModelVersion', + ], + 'CreateModelLabels' => [ + 'summary' => 'Creates a tag 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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-1dkasjfhds23dft', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F81D9EC0-1872-50F5-A96C-A0647D****1D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F81D9EC0-1872-50F5-A96C-A0647D****1D\\"\\n}","type":"json"}]', + 'title' => 'CreateModelLabels', + ], + 'DeleteModelLabels' => [ + 'summary' => 'Deletes the labels of a model.', + '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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-d8dfd****sjfd', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => [ + 'title' => '需要删除的标签Keys', + 'description' => 'The label key to be deleted. To delete multiple label keys, separate them with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1,key2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteModelLabels', + ], + 'CreateModelVersionLabels' => [ + 'summary' => 'Creates a tag 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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '版本标签', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Label', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ModelId', + 'in' => 'path', + 'schema' => [ + 'title' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-rbvg5wzljz****ks92', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型版本', + 'description' => 'The model version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.1.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'CreateModelVersionLabels', + ], + 'DeleteModelVersionLabels' => [ + 'summary' => 'Delete a model version tag.', + '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' => '模型ID', + 'description' => 'The model ID. You can call [ListModels](~~461944~~) to obtain the model ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'model-d8dfd****sjfd', + ], + ], + [ + 'name' => 'VersionName', + 'in' => 'path', + 'schema' => [ + 'title' => '模型版本', + 'description' => 'The version of the model.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.1.1', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => [ + 'title' => '版本标签Keys', + 'description' => 'The key of the tag to be deleted. Separate multiple tag keys with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1,key2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\"\\n}","type":"json"}]', + 'title' => 'DeleteModelVersionLabels', + ], + 'SetUserConfigs' => [ + 'summary' => 'Updates the 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 configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Configs' => [ + 'title' => '配置列表', + 'description' => 'The configurations list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'customizePAIAssumedRole', + ], + 'ConfigValue' => [ + 'title' => '配置值', + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'role', + ], + 'CategoryName' => [ + 'description' => 'The category. Only DataPrivacyConfig is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DataPrivacyConfig', + ], + 'Scope' => [ + 'description' => 'The scope. Valid values: subUser and owner.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'owner', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'dsjk****dfjksdf', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', + 'title' => 'SetUserConfigs', + ], + 'DeleteUserConfig' => [ + 'summary' => 'Deletes user configurations.', + '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 item keys. Currently, only customizePAIAssumedRole.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tempStoragePath', + ], + ], + [ + 'name' => 'CategoryName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The category. Currently, only DataPrivacyConfig is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DataPrivacyConfig', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scope. Valid values: subUser and owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'subUser', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'dsjk****dfjksdf', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"dsjk****dfjksdf\\"\\n}","type":"json"}]', + 'title' => 'DeleteUserConfig', + ], + 'ListUserConfigs' => [ + 'summary' => 'Queries user information.', + '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' => 'The configuration item keys. Currently, only customizePAIAssumedRole is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'customizePAIAssumedRole', + ], + ], + [ + 'name' => 'CategoryNames', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category. Currently, only DataPrivacyConfig is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DataPrivacyConfig', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'sdjksdk-******-dsfds', + ], + 'Configs' => [ + 'title' => '配置列表', + 'description' => 'The configurations list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A configuration item.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'title' => '配置键', + 'description' => 'The key of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'customizePAIAssumedRole', + ], + 'ConfigValue' => [ + 'title' => '配置值', + 'description' => 'The value of the configuration item.'."\n", + 'type' => 'string', + 'example' => 'role', + ], + 'CategoryName' => [ + 'description' => 'The category. Currently, only DataPrivacyConfig is supported.'."\n", + 'type' => 'string', + 'example' => 'DataPrivacyConfig', + ], + 'Scope' => [ + 'description' => 'The scope. Currently, subUser and owner are supported.'."\n", + 'type' => 'string', + 'example' => 'subUser', + ], + ], + ], + ], + 'TotalCount' => [ + 'title' => '返回数量', + 'description' => 'The number of items returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + ], + ], + ], + ], + '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"}]', + 'title' => 'ListUserConfigs', + ], + 'ListProducts' => [ + 'summary' => '列举产品', + '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' => [ + 'title' => '逗号分割的商品 code', + 'type' => 'string', + 'required' => false, + 'example' => 'PAI_isolate', + ], + ], + [ + 'name' => 'ServiceCodes', + 'in' => 'query', + 'schema' => [ + 'title' => '逗号分割的服务 code', + 'type' => 'string', + 'example' => 'oss', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 id', + 'type' => 'string', + 'example' => '1e195c5116124202371861018d5bde', + ], + 'Products' => [ + 'title' => '产品列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PurchaseUrl' => [ + 'title' => '购买链接', + 'type' => 'string', + 'example' => 'https://common-buy.aliy', + ], + 'ProductCode' => [ + 'title' => '商品 code', + 'type' => 'string', + 'example' => 'DataWorks_isolate', + ], + 'IsPurchased' => [ + 'title' => '是否已购买', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HasPermissionToPurchase' => [ + 'title' => 'Whether user has permission to purchase', + 'type' => 'boolean', + ], + 'ProductId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Services' => [ + 'title' => '服务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsOpen' => [ + 'title' => '是否开通', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OpenUrl' => [ + 'title' => '开通链接', + 'type' => 'string', + ], + 'ServiceCode' => [ + 'title' => '服务Code', + 'type' => 'string', + 'example' => 'oss', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateProductOrders' => [ + 'summary' => 'Creates a pay-as-you-go order for DataWorks, OSS, PAI, or 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 order.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoPay' => [ + 'title' => '是否自动购买所有产品', + 'description' => 'Specifies whether to automatically pay for the provided products.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Products' => [ + 'description' => 'The list of products to be purchased. Separate them with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A product to be purchased.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoRenew' => [ + 'description' => 'Specifies whether to automatically renew the product.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'ProductCode' => [ + 'description' => 'The product code. Valid values:'."\n" + ."\n" + .'* DataWorks_share: pay-as-you-go DataWorks'."\n" + .'* MaxCompute_share: pay-as-you-go MaxCompute'."\n" + .'* PAI_share: pay-as-you-go PAI.'."\n" + .'* OSS_share: pay-as-you-go OSS'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'MaxCompute_share' => 'MaxCompute_share', + 'OSS_share' => 'OSS_share', + 'DataWorks_share' => 'DataWorks_share', + 'PAI_share' => 'PAI_share', + ], + 'example' => 'DataWorks_share', + ], + 'ChargeType' => [ + 'description' => 'The billing method. Only POSTPAY is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'POSTPAY' => 'POSTPAY', + ], + 'example' => 'POSTPAY', + ], + 'OrderType' => [ + 'description' => 'The type of the order. Only BUY is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'BUY' => 'BUY', + ], + 'example' => 'BUY', + ], + 'PricingCycle' => [ + 'description' => 'The billing cycle. Valid values:'."\n" + ."\n" + .'* Month: The price is calculated every month. DataWorks_share only supports Month.'."\n" + .'* Hour: The price is calculated every hour. OSS_share and MaxCompute_share only support Hour.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Month' => 'Month', + 'Hour' => 'Hour', + ], + 'example' => 'Month', + ], + 'Duration' => [ + 'description' => 'The purchase duration. You can use this parameter together with pricingCycle. Only 1 is supported.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'InstanceProperties' => [ + 'description' => 'The properties of the instance.'."\n" + ."\n" + .'* DataWorks_share: \\[ { "Code": "region", "Value": "cn-shanghai" } ]'."\n" + .'* OSS_share: \\[ { "Code": "commodity_type", "Value": "oss", "Name": "Object Storage Service" }, { "Code": "ord_time", "Value": "1:Hour", "Name": "1 Hour" } ]'."\n" + .'* PAI_share: None'."\n" + .'* China bid MaxCompute_share: \\[ { "Code": "region", "Value": "cn-hangzhou" }, { "Code": "odps_specification_type", "Value": "OdpsStandard" }, { "Code": "ord_time", "Value": "1:Hour" } ]'."\n" + .'* International bid MaxCompute_share: \\[ { "Code": "region", "Value": "cn-hangzhou" }, { "Code": "ord_time", "Value": "1:Hour" } ]'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A property of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The property code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'commodity_type', + ], + 'Name' => [ + 'description' => 'The property name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'Value' => [ + 'description' => 'The property value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned body.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ksdjf-jksd-*****slkdjf', + ], + 'OrderId' => [ + 'title' => '订单id', + 'description' => 'The purchase order ID.'."\n", + 'type' => 'string', + 'example' => '210292536260646', + ], + 'Message' => [ + 'title' => '消息', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'BuyProductRequestId' => [ + 'title' => '产品购买请求id', + 'description' => 'The ID of the product purchase request.'."\n", + 'type' => 'string', + 'example' => '3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb', + ], + 'ProductIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ksdjf-jksd-*****slkdjf\\",\\n \\"OrderId\\": \\"210292536260646\\",\\n \\"Message\\": \\"正常\\",\\n \\"BuyProductRequestId\\": \\"3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb\\",\\n \\"ProductIds\\": [\\n \\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateProductOrdersResponse>\\n <requestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</requestId>\\n <OrderId>210292536260646</OrderId>\\n <Message>正常</Message>\\n <BuyProductRequestId>3ed6a882-0d85-4dd8-ad36-cd8d74ab9fdb</BuyProductRequestId>\\n</CreateProductOrdersResponse>","errorExample":""}]', + 'title' => 'CreateProductOrders', + ], + 'AcceptDataworksEvent' => [ + 'summary' => 'Receives and processes system event messages sent by 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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'description' => 'The message ID. You can obtain the ID from the message received when an extension point event is triggered. For more information about the message format, see [Message formats](~~436911~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '539306ba-*****-41a0-****-6dc81060985c', + ], + 'Data' => [ + 'description' => 'The event content in the message.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{"eventCode":"d****ct","projectId":"8***6","tenantId":4*******8,"operator":"115*****901"}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'ADF6D849-*****-7E7030F0CE53', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ADF6D849-*****-7E7030F0CE53\\"\\n}","type":"json"}]', + 'title' => 'AcceptDataworksEvent', + 'description' => 'This operation can be called only by the internal system and cannot be called by external users.'."\n", + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Changes the resource group to which a resource belongs based on the ID.', + '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 data.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The resource ID, which is the workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12**56', + ], + 'NewResourceGroupId' => [ + 'description' => 'The ID of the target resource group. For information about how to obtain the ID of a resource group, see [View basic information of a resource group](~~151181~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-df********534dy', + ], + 'ResourceType' => [ + 'description' => 'The resource group type, which must be set to workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workspace', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The object.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6****27E-****-5144-A002-89C****8660F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6****27E-****-5144-A002-89C****8660F\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + ], + 'ListFeatures' => [ + 'summary' => 'Queries a list of features.', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PaiConsole:IntegrateWithWorkspace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '5A14FA81-DD4E-******-6343FE44B941', + ], + 'TotalCount' => [ + 'title' => '特性总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Features' => [ + 'title' => '特性列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PaiConsole:IntegrateWithWorkspace'."\n", + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A14FA81-DD4E-******-6343FE44B941\\",\\n \\"TotalCount\\": 2,\\n \\"Features\\": [\\n \\"PaiConsole:IntegrateWithWorkspace\\\\n\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListFeatures', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'aiworkspace.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'aiworkspace.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'aiworkspace.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'aiworkspace.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'aiworkspace.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'aiworkspace.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'aiworkspace.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'aiworkspace.cn-guangzhou.aliyuncs.com ', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'aiworkspace.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'aiworkspace.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'aiworkspace.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'aiworkspace.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'aiworkspace.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'aiworkspace.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'aiworkspace.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'aiworkspace.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'aiworkspace.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'aiworkspace.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'aiworkspace.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'aiworkspace.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'aiworkspace.me-east-1.aliyuncs.com', + ], + ], +]; |