diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/pailangstudio | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/pailangstudio')
| -rw-r--r-- | data/en_us/pailangstudio/2024-07-10/api-docs.php | 7682 |
1 files changed, 4275 insertions, 3407 deletions
diff --git a/data/en_us/pailangstudio/2024-07-10/api-docs.php b/data/en_us/pailangstudio/2024-07-10/api-docs.php index edeef14..114e77f 100644 --- a/data/en_us/pailangstudio/2024-07-10/api-docs.php +++ b/data/en_us/pailangstudio/2024-07-10/api-docs.php @@ -1,1555 +1,1257 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'PAILangStudio', - 'version' => '2024-07-10', - ], + 'info' => ['style' => 'ROA', 'product' => 'PAILangStudio', 'version' => '2024-07-10'], 'directories' => [ - 'CreateKnowledgeBase', - 'GetKnowledgeBase', - 'UpdateKnowledgeBase', - 'DeleteKnowledgeBase', - 'ListKnowledgeBases', - 'RetrieveKnowledgeBase', - 'CreateKnowledgeBaseJob', - 'GetKnowledgeBaseJob', - 'UpdateKnowledgeBaseJob', - 'DeleteKnowledgeBaseJob', - 'ListKnowledgeBaseJobs', - 'UpdateKnowledgeBaseChunk', - 'ListKnowledgeBaseChunks', + [ + 'children' => ['CreateRuntime', 'UpdateRuntime', 'GetRuntime', 'ListRuntimes', 'DeleteRuntime'], + 'type' => 'directory', + 'title' => 'Runtime', + ], + [ + 'children' => ['UpdateDeployment', 'DeleteDeployment'], + 'type' => 'directory', + 'title' => 'Deployment tasks', + ], + [ + 'children' => ['GetSnapshot', 'UpdateSnapshot', 'ListSnapshots'], + 'type' => 'directory', + 'title' => 'Snapshot management', + ], + [ + 'children' => ['RetrieveKnowledgeBase', 'CreateKnowledgeBaseJob', 'GetKnowledgeBaseJob', 'UpdateKnowledgeBaseJob', 'DeleteKnowledgeBaseJob', 'ListKnowledgeBaseJobs', 'UpdateKnowledgeBaseChunk', 'ListKnowledgeBaseChunks'], + 'type' => 'directory', + 'title' => 'Knowledge base', + ], + [ + 'children' => ['CreateDeployment', 'CreateKnowledgeBase', 'CreateSnapshot', 'DeleteKnowledgeBase', 'DeleteSnapshot', 'GetDeployment', 'GetKnowledgeBase', 'ListDeployments', 'ListKnowledgeBases', 'UpdateKnowledgeBase'], + 'title' => 'Others', + 'type' => 'directory', + ], ], 'components' => [ 'schemas' => [ - 'KnowledgeBase' => [ - 'description' => '', - 'visibility' => 'Public', + 'Connection' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '478***', - 'backendName' => 'workspaceId', - ], - 'Accessibility' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'PRIVATE', - 'backendName' => 'accessibility', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-12-15T14:46:23Z', - 'backendName' => 'gmtCreateTime', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-12-18T19:32:58Z', - 'backendName' => 'gmtModifiedTime', - ], - 'Name' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myName', - 'backendName' => 'name', - ], - 'KnowledgeBaseId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'd-nacr******sxd2', - 'backendName' => 'knowledgeBaseId', - ], - 'Description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base.', - 'backendName' => 'description', + 'WorkspaceId' => ['type' => 'string'], + 'Accessibility' => ['type' => 'string'], + 'ConnectionId' => ['type' => 'string'], + 'ConnectionType' => ['type' => 'string'], + 'ConnectionName' => ['type' => 'string'], + 'CustomType' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'Configs' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'KnowledgeBaseType' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TEXT', - 'backendName' => 'knowledgeBaseType', + 'Secrets' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'DatasetId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'd-lvb6****865w', - 'backendName' => 'datasetId', + 'GmtCreateTime' => ['type' => 'string'], + 'GmtModifiedTime' => ['type' => 'string'], + 'Creator' => ['type' => 'string'], + 'ResourceMeta' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => ['title' => '资源实例名称', 'description' => '资源实例名称', 'type' => 'string'], + 'InstanceId' => ['title' => '资源实例ID', 'description' => '资源实例ID', 'type' => 'string'], + ], ], - 'DataSources' => [ - 'description' => '', - 'visibility' => 'Public', + 'Models' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', - 'readOnly' => true, - 'descriptionEn' => 'Uri', - ], + 'Model' => ['title' => '模型名', 'description' => '模型名', 'type' => 'string'], + 'ModelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string'], + 'DisplayName' => ['title' => '模型展示名称', 'description' => '模型展示名称', 'type' => 'string'], + 'ToolCall' => ['title' => '是否支持ToolCall', 'description' => '是否支持ToolCall', 'type' => 'boolean'], + 'SupportVision' => ['title' => '是否支持Vision', 'description' => '是否支持Vision', 'type' => 'boolean'], + 'SupportReasoning' => ['title' => '是否支持Reasoning', 'description' => '是否支持Reasoning', 'type' => 'boolean'], + 'SupportResponseSchema' => ['title' => '是否支持输出Schema', 'description' => '是否支持输出Schema', 'type' => 'boolean'], + 'MaxModelLength' => ['title' => '最大上下文长度', 'description' => '最大上下文长度', 'type' => 'integer', 'format' => 'int32'], ], - 'extendType' => 'true', ], - 'backendName' => 'dataSources', - 'itemName' => 'DataSources', ], - 'OutputDir' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - 'backendName' => 'outputDir', - ], - 'ChunkConfig' => [ - 'description' => '', - 'visibility' => 'Public', + ], + ], + 'Deployment' => [ + 'description' => 'Deployment job details.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478***', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility. Valid values:'."\n" + .'- PRIVATE: In this workspace, the resource is visible only to you and administrators.'."\n" + .'- PUBLIC: In this workspace, the resource is visible to all users.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Updated At.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''], + 'DeploymentId' => ['description' => 'The ID of the deployment job.', 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''], + 'DeploymentStatus' => ['description' => 'Task status of the deployment. Valid values:'."\n" + .'* Creating: Creating.'."\n" + .'* Failed: Deployment failed.'."\n" + .'* Stopping: Stopping.'."\n" + .'* Waiting: Waiting.'."\n" + .'* Starting: Starting.'."\n" + .'* Running: Running.'."\n" + .'* Pending: Pending.'."\n" + .'* WaitForConfirm: Waiting for confirmation.'."\n" + .'* Canceled: Canceled.'."\n" + .'* Succeed: Succeeded.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'OperationType' => ['description' => 'Operation type. Valid values:'."\n" + .'* Create: Create a new service.'."\n" + .'* Update: Update an existing service.', 'type' => 'string', 'example' => 'Create', 'title' => ''], + 'ResourceType' => ['description' => 'The type of resource to deploy. Valid values:'."\n" + .'* Flow: A workflow project'."\n" + .'* Code: A code-based project', 'type' => 'string', 'example' => 'Flow', 'title' => ''], + 'ResourceId' => ['description' => 'Resource ID to be deployed.', 'type' => 'string', 'example' => 'flow-asdf******123', 'title' => ''], + 'ResourceSnapshotId' => ['description' => 'Snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If not provided, the system first creates a new snapshot of the resource and then performs the deployment.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''], + 'ServiceName' => ['description' => 'Service name.', 'type' => 'string', 'example' => 'myservice01', 'title' => ''], + 'Description' => ['description' => 'Service description.', 'type' => 'string', 'example' => 'This is description', 'title' => ''], + 'WorkDir' => ['description' => 'OSS working directory for the service. It stores operational logs, conversation history, and other data.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'EnableTrace' => ['description' => 'Specifies whether to enable Tracing Analysis.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ChatHistoryConfig' => [ + 'description' => 'Chat history configuration.', 'type' => 'object', 'properties' => [ - 'ChunkSize' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - 'readOnly' => true, - 'descriptionEn' => 'Chunk size', - ], - 'ChunkOverlap' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'readOnly' => true, - 'descriptionEn' => 'Chunk overlap', - ], - 'ChunkDuration' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'readOnly' => true, - 'descriptionEn' => 'Chunk duration', - ], - 'ChunkStrategy' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'StorageType' => [ + 'title' => '存储类型', + 'description' => 'The storage method. Valid values:'."\n" + .'* LOCAL: Chat history is stored in a local SQLite file and does not support multi-instance deployment.'."\n" + .'* OSS: Chat history is stored in a specific path under the service OSS workspace path.'."\n" + .'* RDS: Chat history is stored in an RDS table, and an RDS connection must be specified.', 'type' => 'string', - 'example' => 'Default', + 'example' => 'RDS', 'readOnly' => true, - 'descriptionEn' => 'Chunk strategy', - 'default' => 'Default', + 'enum' => ['LOCAL', 'RDS', 'OSS'], ], + 'ConnectionName' => ['title' => '连接名称', 'description' => 'The connection name. This parameter is required when the chat history storage type is RDS.', 'type' => 'string', 'example' => 'myconnection', 'readOnly' => true], ], - 'backendName' => 'chunkConfig', + 'title' => '', + 'example' => '', ], - 'EmbeddingConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'ContentModerationConfig' => [ + 'description' => 'Content moderation configuration.', 'type' => 'object', 'properties' => [ - 'EmbeddingType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => 'DashScope', - 'descriptionEn' => 'Embedding type', - ], - 'ConnectionName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myEmbeddingConn', - 'descriptionEn' => 'Embedding connection name', - ], - 'ConnectionId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'conn-r3o7******38bh', - 'descriptionEn' => 'Embedding connection id', - ], - 'Model' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'text-embedding-v4', - 'descriptionEn' => 'Model', + 'EnableInputModeration' => ['title' => '启用输入内容审查', 'description' => 'Specifies whether to enable security review for input.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => '启用输出内容审查', 'description' => 'Specifies whether to enable content moderation for output.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => '流式输出内容送审缓存大小', 'description' => 'The cache size for streaming output content submitted for moderation. The default value is 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', + ], + 'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see the [deployment configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS.', 'type' => 'string', 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''], + 'DeploymentStages' => [ + 'description' => 'Stage information of the deployment.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Stage' => ['title' => '阶段', 'description' => 'Deployment stage.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'StageName' => ['title' => '阶段名称', 'description' => 'Name of the deployment stage.', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true], + 'Description' => ['title' => '描述', 'description' => 'Description of the deployment stage.', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true], + 'GmtStartTime' => ['title' => '开始时间', 'description' => 'Start Time.', 'type' => 'string', 'example' => '2025-09-23T10:25:38Z', 'readOnly' => true], + 'GmtEndTime' => ['title' => '结束时间', 'description' => 'End time.', 'type' => 'string', 'example' => '2025-09-19T10:34:01Z', 'readOnly' => true], + 'StageStatus' => ['title' => '阶段状态', 'description' => 'Status of the deployment stage. Valid values:'."\n" + .'* NotStarted: Not started.'."\n" + .'* WaitForConfirm: Waiting for confirmation.'."\n" + .'* Waiting: Waiting.'."\n" + .'* Creating: Creating.'."\n" + .'* Running: Running.', 'type' => 'string', 'example' => 'Running', 'readOnly' => true], + 'ErrorMessage' => ['title' => '错误信息', 'description' => 'Error message.', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true], + 'StageInfo' => ['title' => '阶段信息', 'description' => 'Information about the deployment stage.', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29k******b0hotn\\"}', 'readOnly' => true], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'embeddingConfig', + 'title' => '', + 'example' => '', ], - 'VectorDBConfig' => [ + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'This is error message', 'title' => ''], + 'AutoApproval' => ['description' => 'Specifies whether to automatically skip the deployment confirmation step.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Flow' => [ + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Accessibility' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowStoragePath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WorkDir' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreateFrom' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowTemplateId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Runtime' => [ + 'type' => 'object', + 'properties' => [ + 'RuntimeId' => ['title' => '运行时ID', 'description' => '运行时ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RuntimeName' => ['title' => '运行时名称', 'description' => '运行时名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RuntimeType' => ['title' => '运行时类型', 'description' => '运行时类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RuntimeStatus' => ['title' => '运行时状态', 'description' => '运行时状态', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'SupportSSEStream' => ['title' => '是否支持SSE', 'description' => '是否支持SSE', 'type' => 'boolean', 'readOnly' => true, 'example' => ''], + ], 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'example' => '', + ], + 'Version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RuntimeId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SourceUri' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CodeModeRunInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FlowRun' => [ + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Accessibility' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FlowRunId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RunStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RunMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NodeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Variant' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Exception' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RunResult' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModifiedTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtStartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtFinishTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Duration' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RunName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EcsSpec' => [ 'type' => 'object', 'properties' => [ - 'VectorDBType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Milvus', - 'descriptionEn' => 'VectorDB type', - ], - 'ConnectionName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myConnName', - 'descriptionEn' => 'VectorDB connection name', - ], - 'ConnectionId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'conn-v2wq****z7rg', - 'descriptionEn' => 'Embedding connection id', + 'InstanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'CPU' => ['title' => 'CPU信息', 'description' => 'CPU信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'GPU' => ['title' => 'GPU信息', 'description' => 'GPU信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'Memory' => ['title' => '内存信息', 'description' => '内存信息', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'SharedMemory' => ['title' => '共享内存', 'description' => '共享内存', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'PodCount' => ['title' => 'Pod数量', 'description' => 'Pod数量', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'GPUMemory' => ['title' => 'GPU显存', 'description' => 'GPU显存', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'GPUCorePercentage' => ['title' => 'GPU算力占比', 'description' => 'GPU算力占比', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'ExtraEphemeralStorage' => ['title' => '额外系统盘', 'description' => '额外系统盘', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'QuotaId' => ['title' => '资源配额ID', 'description' => '资源配额ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'QuotaType' => ['title' => '资源配额类型', 'description' => '资源配额类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ResourceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DataSources' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Uri' => ['title' => '统一资源识别码', 'description' => '统一资源识别码', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], - 'CollectionName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'my_collection', - 'descriptionEn' => 'Collectio name', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DataColumnMapping' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EvaluationConfigs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowSource' => [ + 'title' => '应用流来源', + 'description' => '应用流来源', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + ], + 'readOnly' => true, + 'example' => '', + ], + 'DataColumnMapping' => [ + 'title' => '映射配置', + 'description' => '映射配置', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'readOnly' => true, + 'example' => '', + ], + 'InputsOverrideConfig' => ['title' => '输入配置', 'description' => '输入配置', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Name' => ['title' => '评测名称', 'description' => '评测名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Type' => ['title' => '评测类型', 'description' => '评测类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Inputs' => ['title' => '评测输入', 'description' => '评测输入', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'vectorDBConfig', + 'description' => '', + 'title' => '', + 'example' => '', ], 'UserVpc' => [ - 'description' => '', - 'visibility' => 'Private', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-y7d8****io93', - 'descriptionEn' => 'VPC ID', - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], - 'backendName' => 'userVpc', - ], - 'Creator' => [ 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1247****1467', - 'backendName' => 'creator', + 'title' => '', + 'example' => '', ], - 'RuntimeId' => [ + 'Envs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '环境键', 'description' => '环境键', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Value' => ['title' => '环境值', 'description' => '环境值', 'type' => 'string', 'readOnly' => true, 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rtime-78****d6', - 'backendName' => 'runtimeId', + 'title' => '', + 'example' => '', ], - 'ScheduleConfig' => [ + 'Labels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'readOnly' => true, 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'visibility' => 'Private', + 'title' => '', + 'example' => '', + ], + 'CredentialConfig' => [ 'type' => 'object', 'properties' => [ - 'InstanceMode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'T+1', - 'descriptionEn' => 'Instance mode', - 'default' => 'Immediately', - 'enum' => [ - 'Immediately', - 'T+1', - ], - ], - 'Recurrence' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - 'descriptionEn' => 'Recurrence', - 'default' => 'Normal', - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], - ], - 'RerunMode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '***', - 'descriptionEn' => 'Rerun mode', - 'default' => 'Allowed', - 'enum' => [ - 'Allowed', - 'Denied', - 'FailureAllowed', - ], - ], - 'FailureRerunConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'RerunTimes' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'descriptionEn' => 'Rerun times', - 'default' => '3', - ], - 'RerunInterval' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1800', - 'descriptionEn' => 'Rerun interval', - 'default' => '180', - ], - ], - 'descriptionEn' => 'Failure rerun config', - ], - 'Timeout' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'descriptionEn' => 'Run timeout', - 'default' => '86400', - ], - 'TriggerConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Cron' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0 0/10 * * * ?', - 'descriptionEn' => 'Cron expression', - ], - 'StartTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-14T02:22:01Z', - 'descriptionEn' => 'Start time', - ], - 'EndTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-14T02:30:00Z', - 'descriptionEn' => 'End time', - ], - ], - 'descriptionEn' => 'Trigger config', - ], - 'ResourceGroupConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'ResourceGroup' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{}', - 'descriptionEn' => 'ResourceGroup ', - ], - 'Id' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '113', - 'descriptionEn' => 'ResourceGroup ID', - ], - ], - 'descriptionEn' => 'ResourceGroup config', - ], - 'EcsSpecs' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否启用Credential注入', 'type' => 'boolean', 'readOnly' => true, 'example' => ''], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'AliyunEnvRoleKey', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'CredentialConfigItems' => [ + 'title' => 'Credential配置项列表', + 'description' => 'Credential配置项列表', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Worker', - 'readOnly' => true, - 'backendName' => 'Type', - 'descriptionEn' => 'Node type', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.c6.large', - 'readOnly' => true, - 'backendName' => 'InstanceType', - 'descriptionEn' => 'Instance type', - ], - 'PodCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - 'backendName' => 'PodCount', - 'descriptionEn' => 'Pod count', - ], - 'CPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'readOnly' => true, - 'backendName' => 'CPU', - 'descriptionEn' => 'CPU', - ], - 'GPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - 'backendName' => 'GPU', - 'descriptionEn' => 'GPU', - ], - 'Memory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - 'backendName' => 'Memory', - 'descriptionEn' => 'Memory', - ], - 'SharedMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - 'backendName' => 'SharedMemory', - 'descriptionEn' => 'Shared memory', - ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'V100', - 'readOnly' => true, - 'backendName' => 'GPUType', - 'descriptionEn' => 'GPU type', - ], - 'Driver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '550.127.08', + 'Key' => ['title' => 'Key', 'description' => 'Key', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Type' => ['title' => 'Type', 'description' => 'Type', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '角色列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'AssumeRoleFor', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RoleType' => ['title' => '角色类型', 'description' => '角色类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RoleArn' => ['title' => '角色名称', 'description' => '角色名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + ], + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'readOnly' => true, - 'backendName' => 'Driver', - 'descriptionEn' => 'Driver version', + 'example' => '', ], ], - 'extendType' => 'true', + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'descriptionEn' => 'ECS config', + 'readOnly' => true, + 'example' => '', ], - 'UserVpc' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-wz90****5v23', - 'descriptionEn' => 'VPC ID', - ], - 'VSwitchId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vsw-wz9r****ng10', - 'descriptionEn' => 'Switch ID', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RunTimeout' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ChildRuns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FlowRunId' => ['title' => '应用流运行ID', 'description' => '应用流运行ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RunName' => ['title' => '运行名称', 'description' => '运行名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RunMode' => ['title' => '运行模式', 'description' => '运行模式', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'RunStatus' => ['title' => '运行状态', 'description' => '运行状态', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'GmtModifiedTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'GmtStartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'GmtFinishTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Duration' => ['title' => '运行时长', 'description' => '运行时长', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'example' => ''], + 'FlowSource' => [ + 'title' => '应用流来源', + 'description' => '应用流来源', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], - 'SecurityGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sg-wz9i****1129', - 'descriptionEn' => 'Security group ID', + 'readOnly' => true, + 'example' => '', + ], + 'JobInfo' => [ + 'title' => '任务信息', + 'description' => '任务信息', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], + 'readOnly' => true, + 'example' => '', ], - 'descriptionEn' => 'User VPC config', - ], - 'ResourceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'quota89**76', - 'descriptionEn' => 'Resource ID', - ], - 'Status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Success', - 'descriptionEn' => 'Schedule config status', - ], - 'GmtCreateTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-29T02:07:14Z', - 'descriptionEn' => 'Schedule config create time', + 'RunResult' => ['title' => '运行结果', 'description' => '运行结果', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], - 'GmtModifiedTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2025-04-29T02:40:36Z', - 'descriptionEn' => 'Schedule config modified time', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NodeRunInfos' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeName' => ['title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Status' => ['title' => '节点状态', 'description' => '节点状态', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Inputs' => ['title' => '输入', 'description' => '输入', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Output' => ['title' => '输出', 'description' => '输出', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Duration' => ['title' => '耗时', 'description' => '耗时', 'type' => 'string', 'readOnly' => true, 'example' => ''], + 'Stdout' => ['title' => '日志信息', 'description' => '日志信息', 'type' => 'string', 'readOnly' => true, 'example' => ''], ], - 'ScheduleWorkflowId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '6237****9023', - 'descriptionEn' => 'Schedule config workflow ID', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EvaluationWorkerCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'FlowTemplate' => [ + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['type' => 'string'], + 'Accessibility' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'FlowStoragePath' => ['type' => 'string'], + 'FlowTemplateId' => ['type' => 'string'], + 'FlowType' => ['type' => 'string'], + 'TemplateGroup' => ['type' => 'string'], + 'TemplateName' => ['type' => 'string'], + 'Url' => ['type' => 'string'], + 'FlowFiles' => ['type' => 'string'], + 'DisplayName' => ['type' => 'string'], + 'DisplayNameI18N' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'DescriptionI18N' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], + ], + 'Version' => ['type' => 'string'], + 'Locale' => ['type' => 'string'], + 'ReferenceCount' => ['type' => 'integer', 'format' => 'int32'], + 'AliyunDocumentId' => ['type' => 'string'], + 'Labels' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string'], + 'Value' => ['title' => '标签Value', 'description' => '标签Value', 'type' => 'string'], ], - 'ScheduleCycleTaskId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '11**67', - 'descriptionEn' => 'Schedule cycle task ID', + ], + ], + ], + ], + 'KnowledgeBase' => [ + 'description' => 'Knowledge base.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'ID of the workspace where the knowledge base resides.', 'type' => 'string', 'example' => '478***', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility. Possible values are:'."\n" + .'- PRIVATE: visible only to you and administrators within this workspace.'."\n" + .'- PUBLIC: visible to everyone within this workspace.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Knowledge base creation time (UTC).', 'type' => 'string', 'example' => '2024-12-15T14:46:23Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The knowledge base modification time (UTC). ', 'type' => 'string', 'example' => '2025-12-18T19:32:58Z', 'title' => ''], + 'Name' => ['description' => 'The knowledge base name. ', 'type' => 'string', 'example' => 'myName', 'title' => ''], + 'KnowledgeBaseId' => ['description' => 'ID of the knowledge base.', 'type' => 'string', 'example' => 'd-nacr******sxd2', 'title' => ''], + 'Description' => ['description' => 'Description of the knowledge base.', 'type' => 'string', 'example' => 'This is a description of the knowledge base.', 'title' => ''], + 'KnowledgeBaseType' => ['description' => 'Type of the knowledge base.'."\n" + .'- TEXT: document.'."\n" + .'- STRUCTURED: structured data.'."\n" + .'- IMAGE: image.'."\n" + .'- VIDEO: video.', 'type' => 'string', 'example' => 'TEXT', 'title' => ''], + 'DatasetId' => ['description' => 'The dataset ID corresponding to the knowledge base. ', 'type' => 'string', 'example' => 'd-lvb6****865w', 'title' => ''], + 'DataSources' => [ + 'description' => 'Data sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data sources.', + 'type' => 'object', + 'properties' => [ + 'Uri' => ['title' => '统一资源识别码', 'description' => 'Source file storage path.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], ], + 'title' => '', + 'example' => '', ], - 'backendName' => 'scheduleConfig', + 'title' => '', + 'example' => '', ], + 'OutputDir' => ['description' => 'Storage path for output data.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''], + 'ChunkConfig' => [ + 'description' => 'File chunk configuration.', + 'type' => 'object', + 'properties' => [ + 'ChunkSize' => ['title' => '分块大小', 'description' => 'Chunk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'readOnly' => true], + 'ChunkOverlap' => ['title' => '分块重叠大小', 'description' => 'Chunk overlap size.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'readOnly' => true], + 'ChunkDuration' => ['title' => '分块时长', 'description' => 'Chunk duration, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'readOnly' => true], + 'ChunkStrategy' => ['title' => '分块策略', 'description' => 'Chunking policy. The policy types are as follows:'."\n" + .'- Default: The system default chunking policy.'."\n" + .'- Asr: Chunk by audio content.', 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], + ], + 'title' => '', + 'example' => '', + ], + 'EmbeddingConfig' => [ + 'description' => 'Vector index configuration.', + 'type' => 'object', + 'properties' => [ + 'ConnectionName' => ['title' => 'Embedding连接名称', 'description' => 'Name of the index service connection.', 'type' => 'string', 'example' => 'myEmbeddingConn'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => 'ID of the index service connection.', 'type' => 'string', 'example' => 'conn-r3o7******38bh'], + 'Model' => ['title' => '模型', 'description' => 'Model name.', 'type' => 'string', 'example' => 'text-embedding-v4'], + ], + 'title' => '', + 'example' => '', + ], + 'VectorDBConfig' => [ + 'description' => 'Vector database configuration.', + 'type' => 'object', + 'properties' => [ + 'VectorDBType' => ['title' => 'VectorDB类型', 'description' => 'The vector database type. The following values are supported: '."\n" + .'- Elasticsearch '."\n" + .'- Milvus '."\n" + .'- Faiss ', 'type' => 'string', 'example' => 'Milvus'], + 'ConnectionName' => ['title' => 'VectorDB连接名称', 'description' => 'Name of the vector database connection.', 'type' => 'string', 'example' => 'myConnName'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => 'ID of the vector database connection.', 'type' => 'string', 'example' => 'conn-v2wq****z7rg'], + 'CollectionName' => ['title' => 'Collection名称', 'description' => 'Name of the table or collection in the vector database.', 'type' => 'string', 'example' => 'my_collection'], + ], + 'title' => '', + 'example' => '', + ], + 'Creator' => ['description' => 'The User ID of the creator. ', 'type' => 'string', 'example' => '1247****1467', 'title' => ''], + 'RuntimeId' => ['description' => 'Runtime ID.', 'type' => 'string', 'example' => 'rtime-78****d6', 'title' => ''], 'MetaDataConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Metadata configuration.', 'type' => 'object', 'properties' => [ 'CustomMetaData' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '自定义元数据', + 'description' => 'Custom metadata.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Custom metadata.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'column1', - 'descriptionEn' => 'Metadata key', - ], - 'ValueType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'String', - 'descriptionEn' => 'Metadata value type', - ], - 'ReferenceCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'readOnly' => true, - 'descriptionEn' => 'Reference count', - ], - 'ValueCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'readOnly' => true, - 'descriptionEn' => 'Value count', - ], + 'Key' => ['title' => '元数据Key', 'description' => 'The metadata field name.', 'type' => 'string', 'example' => 'column1'], + 'ValueType' => ['title' => '元数据Value类型', 'description' => 'The metadata field type.', 'type' => 'string', 'example' => 'String'], + 'ReferenceCount' => ['title' => '引用次数', 'description' => 'The number of references.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true], + 'ValueCount' => ['title' => '值的个数', 'description' => 'The number of values.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'itemName' => 'CustomMetaData', - 'descriptionEn' => 'Custom metadata', + 'example' => '', ], ], - 'backendName' => 'metaDataConfig', + 'title' => '', + 'example' => '', ], 'AutoUpdateConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The auto update configuration for the knowledge base. ', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Enable', - 'descriptionEn' => 'Auto update status', - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'quota87**45', - 'descriptionEn' => 'Resource id', - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - 'descriptionEn' => 'Max running time', - ], + 'Status' => ['title' => '知识库自动更新状态', 'description' => 'The toggle status of auto update for the knowledge base. '."\n" + .'- Enable: Auto update is enabled. '."\n" + .'- Disable: Auto update is disabled. ', 'type' => 'string', 'example' => 'Enable', 'default' => 'Disable'], + 'ResourceId' => ['title' => '资源组ID', 'description' => 'The resource group ID. An empty value or "public-cluster" indicates public resources. ', 'type' => 'string', 'example' => 'quota87**45'], + 'MaxRunningTimeInSeconds' => ['title' => '任务最大运行时间', 'description' => 'The maximum job runtime, in seconds. ', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], 'EmbeddingConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => 'Embedding配置', + 'description' => 'The vector indexing configuration. ', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'descriptionEn' => 'Embedding batch size', - ], - 'Concurrency' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'descriptionEn' => 'Embedding concurrency', - ], + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => 'The index batch size. Valid for document and structured data type knowledge bases. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => 'The index concurrency. Valid for image and video type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'], ], - 'descriptionEn' => 'Embedding config', - ], - 'UserVpc' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'descriptionEn' => 'Vpc config', - '$ref' => '#/components/schemas/UserVpc', + 'example' => '', ], + 'UserVpc' => ['title' => '用户VPC配置', 'description' => 'User VPC configuration. ', '$ref' => '#/components/schemas/UserVpc', 'example' => ''], 'EcsSpecs' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '运行资源配置', + 'description' => 'List of runtime resource configurations. ', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Runtime resource. ', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Worker', - 'backendName' => 'Type', - 'descriptionEn' => 'Node type', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.c6.large', - 'backendName' => 'InstanceType', - 'descriptionEn' => 'Instance type', - ], - 'PodCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'PodCount', - 'descriptionEn' => 'Pod count', - ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'V100', - 'backendName' => 'GPUType', - 'descriptionEn' => 'GPU type', - ], - 'CPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'backendName' => 'CPU', - 'descriptionEn' => 'CPU', - ], - 'GPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'GPU', - 'descriptionEn' => 'GPU', - ], - 'Memory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'backendName' => 'Memory', - 'descriptionEn' => 'Memory', - ], - 'SharedMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'backendName' => 'SharedMemory', - 'descriptionEn' => 'Shared memory', - ], - 'Driver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '550.127.08', - 'backendName' => 'Driver', - 'descriptionEn' => 'Driver version', - ], + 'Type' => ['title' => '节点类型', 'description' => 'File Type. Possible values are Head and Worker. ', 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '机型名称', 'description' => 'Instance type name. ', 'type' => 'string', 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '副本数量', 'description' => 'Number of replicas. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. ', 'type' => 'string', 'example' => 'V100'], + 'CPU' => ['title' => 'CPU核数', 'description' => 'Number of CPU cores. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'Number of GPU cards. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Memory' => ['title' => '内存大小', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => 'Shared memory capacity, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'Driver' => ['title' => '驱动版本', 'description' => 'Driver version. ', 'type' => 'string', 'example' => '550.127.08'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'itemName' => 'EcsSpecElem', - 'descriptionEn' => 'Running resource config', + 'example' => '', ], ], - 'backendName' => 'autoUpdateConfig', - ], - 'VersionName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'v1', - 'backendName' => 'versionName', + 'title' => '', + 'example' => '', ], + 'VersionName' => ['description' => 'Knowledge base version. Default is v1.', 'type' => 'string', 'example' => 'v1', 'title' => ''], 'IndexColumnConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Field configuration for columns. Valid only for structured data knowledge bases. ', 'type' => 'object', 'properties' => [ 'EmbeddingColumns' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => 'Embedding列', + 'description' => 'Vector index columns. Fields in this list are vectorized and participate in retrieval. ', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Vector index column. ', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - 'descriptionEn' => 'Column key', - ], + 'Key' => ['title' => '列Key', 'description' => 'Column name. ', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'readOnly' => true, - 'itemName' => 'EmbeddingColumn', - 'descriptionEn' => 'Embedding columns', + 'example' => '', ], 'ContentColumns' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '内容检索列', + 'description' => 'Content filtering columns. Fields in this list support retrieval by keyword.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Content filtering columns.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - 'descriptionEn' => 'Column key', - ], + 'Key' => ['title' => '列Key', 'description' => 'Column name.', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], 'readOnly' => true, - 'itemName' => 'ContentColumn', - 'descriptionEn' => 'Content columns', + 'example' => '', ], 'ColumnDefinitions' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'title' => '所有列名', + 'description' => 'All column names. ', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - 'descriptionEn' => 'Column key', - ], + 'Key' => ['title' => '列Key', 'description' => 'Column name.', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], 'readOnly' => true, - 'itemName' => 'ColumnDefinition', - 'descriptionEn' => 'Column definitions', + 'example' => '', ], ], - 'backendName' => 'indexColumnConfig', - ], - 'IndexManifest' => [ - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '{}', - 'backendName' => 'indexManifest', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'KnowledgeBaseFileChunk' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Knowledge base segment. ', 'type' => 'object', 'properties' => [ - 'Score' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9832', - 'backendName' => 'score', - ], - 'ChunkId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '7fjs******90fs', - 'backendName' => 'chunkId', - ], - 'ChunkStart' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'chunkStart', - ], - 'ChunkEnd' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - 'backendName' => 'chunkEnd', - ], - 'ChunkSequence' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'backendName' => 'chunkSequence', - ], - 'ChunkContent' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'content of chunk', - 'backendName' => 'chunkContent', - ], - 'ChunkSize' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3452', - 'backendName' => 'chunkSize', - ], - 'ChunkStatus' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Enable', - 'backendName' => 'chunkStatus', - ], - 'DownloadUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNmxRtIx2Ue&Signature=PepwMeJs%2Bfz9aypuvMPUSVFF', - 'backendName' => 'downloadUrl', - ], - 'ThumbnailUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNmxRtIx2Ue&Signature=PepwMeJs%2Bfz9aypuvMPUSVFF&x-oss-process=video%2Fsnapshot%2Ct_0%2Cf_jpg%2Ch_200', - 'backendName' => 'thumbnailUrl', - ], + 'Score' => ['description' => 'Relevance of the result to the query content. ', 'type' => 'number', 'format' => 'float', 'example' => '0.9832', 'title' => ''], + 'ChunkId' => ['description' => 'Segment ID. ', 'type' => 'string', 'example' => '7fjs******90fs', 'title' => ''], + 'ChunkStart' => ['description' => 'Start position of the segment. Returns the time in milliseconds from the start of file playback. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ChunkEnd' => ['description' => 'End position of the segment. Returns the time in milliseconds from the start of file playback. ', 'type' => 'integer', 'format' => 'int32', 'example' => '30000', 'title' => ''], + 'ChunkSequence' => ['description' => 'Ordinal number of the segment within the file. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ChunkContent' => ['description' => 'Segment content. ', 'type' => 'string', 'example' => 'content of chunk', 'title' => ''], + 'ChunkSize' => ['description' => 'Segment size. ', 'type' => 'integer', 'format' => 'int32', 'example' => '3452', 'title' => ''], + 'ChunkStatus' => ['description' => 'Segment status. '."\n" + ."\n" + .'- Enable: enabled. '."\n" + .'- Disable: disabled. ', 'type' => 'string', 'example' => 'Enable', 'title' => ''], + 'DownloadUrl' => ['description' => 'Segment download URL. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', 'title' => ''], + 'ThumbnailUrl' => ['description' => 'Segment thumbnail. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', 'title' => ''], 'ChunkAttachment' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Segment attachment. ', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Attachment information. ', 'type' => 'object', 'properties' => [ - 'PlaceholderId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'IMAGE_PLACEHOLDER_0', - 'backendName' => 'placeholderId', - ], - 'Type' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'image', - 'backendName' => 'type', - ], - 'Uri' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://mybucket/file1/img1.jpg', - 'backendName' => 'uri', - ], - 'DownloadUrl' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNmxRtIx2Ue&Signature=YEOPgNII9xxCLrfkWvWjQN9pkXo%3D', - 'backendName' => 'downloadUrl', - ], + 'PlaceholderId' => ['description' => 'Placeholder ID. ', 'type' => 'string', 'example' => 'IMAGE_PLACEHOLDER_0', 'title' => ''], + 'Type' => ['description' => 'Attachment type. ', 'type' => 'string', 'example' => 'image', 'title' => ''], + 'Uri' => ['description' => 'Attachment URI. ', 'type' => 'string', 'example' => 'oss://mybucket/file1/img1.jpg', 'title' => ''], + 'DownloadUrl' => ['description' => 'Attachment download URL. ', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******', 'title' => ''], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'chunkAttachment', + 'title' => '', + 'example' => '', ], 'MetaData' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Original file information. ', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'abc.txt', - 'backendName' => 'fileName', - ], - 'FileUri' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://mybucket/path/abc.txt', - 'backendName' => 'fileUri', - ], - 'FileMetaId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sd8c******67ux', - 'backendName' => 'fileMetaId', - ], + 'FileName' => ['description' => 'File name. ', 'type' => 'string', 'example' => 'abc.txt', 'title' => ''], + 'FileUri' => ['description' => 'File Path. ', 'type' => 'string', 'example' => 'oss://mybucket/path/abc.txt', 'title' => ''], + 'FileMetaId' => ['description' => 'File metadata ID. ', 'type' => 'string', 'example' => 'sd8c******67ux', 'title' => ''], ], - 'backendName' => 'metaData', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'KnowledgeBaseJob' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Knowledge base job.', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '478**', - 'backendName' => 'workspaceId', - ], - 'Accessibility' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'PRIVATE', - 'backendName' => 'accessibility', - ], - 'Creator' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2003******4844', - 'backendName' => 'creator', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-13T01:43:15Z', - 'backendName' => 'gmtCreateTime', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-13T03:05:22Z', - 'backendName' => 'gmtModifiedTime', - ], - 'KnowledgeBaseId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'd-ksicx823d', - 'backendName' => 'knowledgeBaseId', - ], - 'KnowledgeBaseJobId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'kbjob-9m******54', - 'backendName' => 'knowledgeBaseJobId', - ], - 'JobAction' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SyncIndex', - 'backendName' => 'jobAction', - ], - 'Description' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base job.', - 'backendName' => 'description', - ], - 'Status' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Running', - 'backendName' => 'status', - ], - 'ResourceId' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'quota89**76', - 'backendName' => 'resourceId', - ], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '478**', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility. Possible values are:'."\n" + .'- PRIVATE: In this workspace, visible only to you and administrators.'."\n" + .'- PUBLIC: In this workspace, visible to everyone.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Creator' => ['description' => 'The User ID of the creator.', 'type' => 'string', 'example' => '2003******4844', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Job creation time (UTC).', 'type' => 'string', 'example' => '2024-05-13T01:43:15Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Job update time (UTC).', 'type' => 'string', 'example' => '2024-05-13T03:05:22Z', 'title' => ''], + 'KnowledgeBaseId' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''], + 'KnowledgeBaseJobId' => ['description' => 'The knowledge base job ID.', 'type' => 'string', 'example' => 'kbjob-9m******54', 'title' => ''], + 'JobAction' => ['description' => 'Operation type of the job. '."\n" + .'- SyncIndex: Update knowledge base index', 'type' => 'string', 'example' => 'SyncIndex', 'title' => ''], + 'Description' => ['description' => 'The description of the knowledge base job.', 'type' => 'string', 'example' => 'This is a description of the knowledge base job.', 'title' => ''], + 'Status' => ['description' => 'The status of the knowledge base job.'."\n" + ."\n" + .'- Running: The job is running.'."\n" + .'- Success: The job succeeded.'."\n" + .'- Failed: The job failed.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ResourceId' => ['description' => 'Resource ID.', 'type' => 'string', 'example' => 'quota89**76', 'title' => ''], 'EcsSpecs' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Machine resources used for running the job.', 'type' => 'array', 'items' => [ - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Worker', - 'readOnly' => true, - 'backendName' => 'Type', - 'descriptionEn' => 'Node type', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ecs.c6.large', - 'readOnly' => true, - 'backendName' => 'InstanceType', - 'descriptionEn' => 'Instance type', - ], - 'PodCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - 'backendName' => 'PodCount', - 'descriptionEn' => 'Pod count', - ], - 'CPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'readOnly' => true, - 'backendName' => 'CPU', - 'descriptionEn' => 'CPU', - ], - 'GPU' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - 'backendName' => 'GPU', - 'descriptionEn' => 'GPU', - ], - 'Memory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - 'backendName' => 'Memory', - 'descriptionEn' => 'Memory', - ], - 'SharedMemory' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - 'backendName' => 'SharedMemory', - 'descriptionEn' => 'Shared memory', - ], - 'GPUType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'V100', - 'readOnly' => true, - 'backendName' => 'GPUType', - 'descriptionEn' => 'GPU type', - ], - 'Driver' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '550.127.08', - 'readOnly' => true, - 'backendName' => 'Driver', - 'descriptionEn' => 'Driver version', - ], + 'Type' => ['title' => '节点类型', 'description' => 'Node type. Possible values are Head and Worker.', 'type' => 'string', 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'], + 'InstanceType' => ['title' => '机型名称', 'description' => 'Instance type name. ', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true], + 'PodCount' => ['title' => '副本数量', 'description' => 'Number of replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'CPU' => ['title' => 'CPU核数', 'description' => 'Number of CPU cores. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'Number of GPU cards. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'Memory' => ['title' => '内存大小', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => 'Shared memory capacity, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. ', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'Driver version. ', 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true], ], - 'extendType' => 'true', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'ecsSpecs', - 'itemName' => 'EcsSpecElem', + 'title' => '', + 'example' => '', ], 'UserVpc' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'VPC information for resource execution.', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-wz90****5v23', - 'descriptionEn' => 'VPC ID', - ], - 'VSwitchId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vsw-wz9r****ng10', - 'descriptionEn' => 'Switch ID', - ], - 'SecurityGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sg-wz91****e10e', - 'descriptionEn' => 'Security group ID', - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['title' => '交换机ID', 'description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-wz91****e10e'], ], - 'backendName' => 'userVpc', + 'title' => '', + 'example' => '', ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - 'backendName' => 'maxRunningTimeInSeconds', + 'MaxRunningTimeInSeconds' => ['description' => 'Maximum job runtime, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'GmtFinishTime' => ['description' => 'The end time of the job (UTC).', 'type' => 'string', 'example' => '2024-05-13T04:03:27Z', 'title' => ''], + 'ErrorMessage' => ['description' => 'Job abnormal information.', 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', 'title' => ''], + 'PipelineRunInfo' => [ + 'description' => 'Workflow run information.', + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => ['title' => 'PaiFlow工作流运行ID', 'description' => 'PaiFlow workflow run ID', 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', ], - 'GmtFinishTime' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2024-05-13T04:03:27Z', - 'backendName' => 'gmtFinishTime', + 'KnowledgeBaseJobResult' => [ + 'description' => 'Task result.', + 'type' => 'object', + 'properties' => [ + 'TotalFileCount' => ['title' => '总处理文件数', 'description' => 'Total number of files processed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AddChunkCount' => ['title' => '增加Chunk数量', 'description' => 'Total number of shards increased.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DeleteChunkCount' => ['title' => '删除Chunk数量', 'description' => 'Total number of shards deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], + 'title' => '', + 'example' => '', ], - 'ErrorMessage' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', - 'backendName' => 'errorMessage', + 'EmbeddingConfig' => [ + 'description' => 'Index configuration.', + 'type' => 'object', + 'properties' => [ + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => 'Index batch size. Valid for document and structured data type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => 'Index concurrency. Valid for image and video type knowledge bases.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', ], - 'PipelineRunInfo' => [ - 'description' => '', - 'visibility' => 'Public', + ], + 'title' => '', + 'example' => '', + ], + 'Runtime' => [ + 'description' => 'Runtime details.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'example' => '478***', 'title' => ''], + 'RuntimeId' => ['description' => 'Runtime ID. ', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''], + 'RuntimeName' => ['description' => 'The Name of the runtime. ', 'type' => 'string', 'example' => 'dev01', 'title' => ''], + 'RuntimeType' => ['description' => 'Runtime type. ', 'type' => 'string', 'example' => 'DSW', 'title' => ''], + 'RuntimeStatus' => ['description' => 'Runtime status. Valid values:'."\n" + .'* Creating: Creation in progress'."\n" + .'* SaveFailed: Failed to save image'."\n" + .'* Stopped: Stopped'."\n" + .'* Failed: Failed'."\n" + .'* ResourceAllocating: Resource allocation in progress'."\n" + .'* Stopping: Stopping in progress'."\n" + .'* Updating: Update in progress'."\n" + .'* Saving: Image saving in progress'."\n" + .'* Queuing: Queuing'."\n" + .'* Recovering: Instance recovery in progress'."\n" + .'* Starting: Creation in progress'."\n" + .'* Running: Running'."\n" + .'* Saved: Image saved successfully'."\n" + .'* Deleting: Deletion in progress'."\n" + .'* EnvPreparing: Environment preparation in progress', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Updated At.', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z', 'title' => ''], + 'Creator' => ['description' => 'Creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility. Possible values:'."\n" + .'- PRIVATE: In this workspace, visible only to you and administrators.'."\n" + .'- PUBLIC: In this workspace, visible to everyone.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'EcsSpec' => [ + 'description' => 'ECS resource configuration ', 'type' => 'object', 'properties' => [ - 'PipelineRunId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'flow-fi8z******g4gy', - 'readOnly' => true, - 'descriptionEn' => 'PaiFlow pipeline run ID', - ], + 'InstanceType' => ['title' => '实例类型', 'description' => 'Instance type. ', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU type. Valid values: '."\n" + .'* V100 '."\n" + .'* A100 '."\n" + .'* T4 '."\n" + .'* A10 '."\n" + .'* P100 ', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'CPU' => ['title' => 'CPU数量', 'description' => 'Number of CPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU数量', 'description' => 'Number of GPUs. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'readOnly' => true], + 'Memory' => ['title' => '内存信息', 'description' => 'Memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存', 'description' => 'Shared memory size, in GB. ', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU driver version. ', 'type' => 'string', 'example' => '535.161.08', 'readOnly' => true], ], - 'backendName' => 'pipelineRunInfo', + 'title' => '', + 'example' => '', ], - 'KnowledgeBaseJobResult' => [ - 'description' => '', - 'visibility' => 'Public', + 'ResourceId' => ['description' => 'Resource quota ID. ', 'type' => 'string', 'example' => 'quota18******zv9', 'title' => ''], + 'UserVpc' => [ + 'description' => 'User VPC configuration.', 'type' => 'object', 'properties' => [ - 'TotalFileCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'descriptionEn' => 'Total file count', + 'VpcId' => ['title' => 'VPC ID', 'description' => 'Virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => 'Security group ID.', 'type' => 'string', 'example' => 'sg-wz9i****1129', 'readOnly' => true], + 'DefaultRoute' => ['title' => '默认路由', 'description' => 'Default route.', 'type' => 'string', 'example' => 'eth0', 'readOnly' => true], + 'ExtendedCIDRs' => [ + 'title' => '扩展网段', + 'description' => 'Extended CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'Extended CIDR block.', 'type' => 'string', 'example' => '172.16.1.0/24', 'readOnly' => true, 'title' => ''], + 'readOnly' => true, + 'example' => '', ], - 'AddChunkCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'descriptionEn' => 'Add chunk count', + ], + 'title' => '', + 'example' => '', + ], + 'Envs' => [ + 'description' => 'Environment variables. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '环境键', 'description' => 'Environment key. ', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true], + 'Value' => ['title' => '环境值', 'description' => 'The environment value.', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true], ], - 'DeleteChunkCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'descriptionEn' => 'Delete chunk count', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'Labels. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => 'Tag key. ', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true], + 'Value' => ['title' => '标签值', 'description' => 'Tag value. ', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true], ], - 'FileMetas' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DataSources' => [ + 'description' => 'Mounted data sources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['title' => '数据集ID', 'description' => 'Dataset ID. Specify either this parameter or Uri.', 'type' => 'string', 'example' => 'd-umns******zij4szhc', 'readOnly' => true], + 'Uri' => ['title' => '统一资源识别码', 'description' => 'OSS path of the data source. Specify either this parameter or DatasetId.', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], + 'MountPath' => ['title' => '挂载路径', 'description' => 'Mount path.', 'type' => 'string', 'example' => '/mnt/data', 'readOnly' => true], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RunTimeout' => ['description' => 'Timeout in seconds for a single test run executed on the runtime.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''], + 'CredentialConfig' => [ + 'description' => 'Credential configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => 'Whether to enable credential injection.', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'Environment variable role key.', 'type' => 'string', 'example' => '0', 'readOnly' => true], + 'CredentialConfigItems' => [ + 'title' => 'Credential配置项列表', + 'description' => 'List of credential configuration items.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'FileMetaId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ks3fje****8cedew', - 'descriptionEn' => 'File meta Id', - ], - 'FileName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'abc.pdf', - 'descriptionEn' => 'File name', - ], - 'FileUri' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://mybucket/path/abc.pdf', - 'descriptionEn' => 'OSS uri', - ], - 'Action' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Add', - 'descriptionEn' => 'Action', + 'Key' => ['title' => 'Key', 'description' => 'The key that identifies the configuration. ', 'type' => 'string', 'example' => '0', 'readOnly' => true], + 'Type' => ['title' => 'Type', 'description' => 'Configuration type. Valid values include:'."\n" + .'* Role: Role assumption'."\n" + .'* RoleChain: Role chain assumption', 'type' => 'string', 'example' => 'Role', 'readOnly' => true], + 'Roles' => [ + 'title' => '角色列表', + 'description' => 'List of configured roles.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'The entity that assumes the role. ', 'type' => 'string', 'example' => '1095******785714', 'readOnly' => true], + 'RoleType' => ['title' => '角色类型', 'description' => 'The type of the role to assume. Valid values include: '."\n" + .'* service: assumed by a service '."\n" + .'* user: assumed by a regular user Account ', 'type' => 'string', 'example' => 'service', 'readOnly' => true], + 'RoleArn' => ['title' => '角色名称', 'description' => 'The role ARN. ', 'type' => 'string', 'example' => 'acs:ram::1095******785714:role/testrole', 'readOnly' => true], + ], + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'readOnly' => true, + 'example' => '', ], ], - 'extendType' => 'true', + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'readOnly' => true, - 'itemName' => 'FileMetas', - 'descriptionEn' => 'File meta data', + 'example' => '', ], ], - 'backendName' => 'knowledgeBaseJobResult', + 'title' => '', + 'example' => '', ], - 'EmbeddingConfig' => [ - 'description' => '', - 'visibility' => 'Public', + 'WorkDir' => ['description' => 'OSS path of the working directory. ', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'Version' => ['description' => 'Runtime image version. ', 'type' => 'string', 'example' => '2.0.0', 'title' => ''], + 'RuntimeLog' => ['description' => 'Runtime log.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log', 'title' => ''], + 'AutoUpdateImage' => ['description' => 'Indicates whether to automatically update the image. When a new image version is available, the system automatically updates the runtime image during off-peak hours. ', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Snapshot' => [ + 'description' => 'Details of the snapshot.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478**', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the snapshot. Valid values:'."\n" + ."\n" + .'- `PRIVATE`: The snapshot is visible only to its creator and administrators in the workspace.'."\n" + ."\n" + .'- `PUBLIC`: The snapshot is visible to everyone in the workspace.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time the snapshot was created.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the snapshot was last modified.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''], + 'SnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 'snap-qhn3******b369c0vo', 'title' => ''], + 'SnapshotName' => ['description' => 'The snapshot name.', 'type' => 'string', 'example' => 'name01', 'title' => ''], + 'Description' => ['description' => 'The snapshot description.', 'type' => 'string', 'example' => 'This is description', 'title' => ''], + 'SnapshotResourceType' => ['description' => 'The type of resource the snapshot captures. Valid values:'."\n" + ."\n" + .'- `Flow`: A workflow.', 'type' => 'string', 'example' => 'Flow', 'title' => ''], + 'SnapshotResourceId' => ['description' => 'The ID of the source resource for the snapshot.', 'type' => 'string', 'example' => 'flow-6rymo******m7j0z4p', 'title' => ''], + 'CreationType' => ['description' => 'The creation type of the snapshot. Valid values:'."\n" + ."\n" + .'- `ManualCreated`: The snapshot was created manually.'."\n" + ."\n" + .'- `DeploymentAutoCreated`: The snapshot was automatically created by a deployment service.'."\n" + ."\n" + .'- `EvaluationAutoCreated`: The snapshot was automatically created by an evaluation task.', 'type' => 'string', 'example' => 'ManualCreated', 'title' => ''], + 'SnapshotStoragePath' => ['description' => 'The OSS path to the snapshot\'s source files.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src', 'title' => ''], + 'WorkDir' => ['description' => 'The OSS working directory where the snapshot is stored.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'SnapshotUrl' => ['description' => 'The download URL for the snapshot.', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile', 'title' => ''], + 'SnapshotStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UserVpc' => [ + 'description' => 'User VPC information.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => '用户VPC的ID', 'description' => 'The ID of the user\'s VPC', 'type' => 'string', 'example' => 'vpc-m5ec******44cn'], + 'VSwitchId' => ['title' => '用户交换机的ID', 'description' => 'The ID of the user\'s vSwitch', 'type' => 'string', 'example' => 'vsw-hp32******z9qo'], + 'SecurityGroupId' => ['title' => '用户安全组的ID', 'description' => 'The ID of the user\'s security group', 'type' => 'string', 'example' => 'sg-bp1f******iy9h'], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'apis' => [ + 'CreateDeployment' => [ + 'summary' => 'Create a deployment job.', + 'path' => '/api/v1/langstudio/deployments', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body. ', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ + 'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], + 'Accessibility' => [ + 'description' => 'Workspace visibility. Valid values: '."\n" + .'- PRIVATE: The service is visible only to you and administrators within this workspace. '."\n" + .'- PUBLIC: The service is visible to all users within this workspace. ', + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'readOnly' => true, - 'descriptionEn' => 'Embedding batch size', ], - 'Concurrency' => [ + 'ResourceType' => ['description' => 'The resource type to deploy. Valid values:'."\n" + .'* Flow: A pipeline project'."\n" + .'* Code: A code project', 'type' => 'string', 'required' => false, 'example' => 'Flow', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the resource to deploy.', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123', 'title' => ''], + 'ResourceSnapshotId' => ['description' => 'The snapshot ID of the resource to deploy. If this parameter is provided, the system deploys directly based on this snapshot. If this parameter is not provided, the system creates a new snapshot of the resource and then executes the deployment.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], + 'ServiceName' => ['description' => 'Service name. Format requirements:'."\n" + .'* Supports lowercase letters, digits, and underscores'."\n" + .'* Must start with a letter'."\n" + .'* Length must be 1 to 45 characters', 'type' => 'string', 'required' => false, 'example' => 'myservice01', 'title' => ''], + 'Description' => ['description' => 'Service description. ', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''], + 'EnableTrace' => ['description' => 'Indicates whether to enable Tracing Analysis. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ChatHistoryConfig' => [ + 'description' => 'Chat history configuration. ', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => 'Storage Type ', + 'description' => 'Storage class. Valid values: '."\n" + .'* LOCAL: Chat history is stored in a local SQLite file. This option does not support multi-instance deployment. '."\n" + .'* OSS: Chat history is stored under a specific path within the service\'s OSS workspace path. '."\n" + .'* RDS: Chat history is stored in an RDS table, and an RDS connection must be specified. ', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'readOnly' => true, + 'enum' => ['LOCAL', 'RDS', 'OSS'], + ], + 'ConnectionName' => ['title' => 'Connection Name ', 'description' => 'Connection name. This parameter is required when the chat history storage type is RDS. ', 'type' => 'string', 'required' => false, 'example' => 'rdsconnection', 'readOnly' => true], + ], + 'required' => false, 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'readOnly' => true, - 'descriptionEn' => 'Embedding concurrency', + 'example' => '', + ], + 'WorkDir' => ['description' => 'The OSS working directory for the service. It is used to store the service\'s runtime logs, conversation history, and other data.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'ContentModerationConfig' => [ + 'description' => 'Content moderation configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableInputModeration' => ['title' => 'Enable input content moderation', 'description' => 'Whether to enable security review for input.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => 'Enable output content moderation', 'description' => 'Whether to enable content moderation for output.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => 'Streaming output content moderation cache size', 'description' => 'The cache size for streaming output content submitted for moderation. Default value: 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'readOnly' => true], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see [Deployment Configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS.', 'type' => 'string', 'required' => false, 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''], + 'AutoApproval' => ['description' => 'Indicates whether to automatically skip the deployment confirmation step. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - 'backendName' => 'embeddingConfig', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'UserVpc' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vpc-m5ec******44cn', - 'backendName' => 'VpcId', - 'descriptionEn' => 'Vpc id', - ], - 'VSwitchId' => [ + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return Result. ', + 'type' => 'object', + 'properties' => [ + 'DeploymentId' => ['description' => 'Deployment record ID. '."\n", 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''], + 'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'vsw-hp32******z9qo', - 'backendName' => 'VSwitchId', - 'descriptionEn' => 'VSwitch id', + 'example' => '', ], - 'SecurityGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sg-bp1f******iy9h', - 'backendName' => 'SecurityGroupId', - 'descriptionEn' => 'Security group id', + ], + ], + 'title' => 'Create Deployment Job ', + 'description' => '请确保在使用该接口前，已充分了解PAI-EAS产品的收费方式和[价格](https://help.aliyun.com/zh/pai/billing-of-eas)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', ], - ], - 'apis' => [ 'CreateKnowledgeBase' => [ 'summary' => 'Create a knowledge base.', 'path' => '/api/v1/langstudio/knowledgebases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ @@ -1557,291 +1259,218 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], + 'WorkspaceId' => ['description' => 'The ID of the workspace. For more information about how to obtain the ID of a workspace, see [ListWorkspaces](~~449124~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''], 'Accessibility' => [ - 'description' => '', + '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 model is visible to all users in the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'PUBLIC', 'default' => 'PUBLIC', - 'enum' => [ - 'PUBLIC', - 'PRIVATE', - ], - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'myName', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base.', + 'enum' => ['PUBLIC', 'PRIVATE'], + 'title' => '', ], + 'Name' => ['description' => 'The name of the knowledge base. The name must meet the following requirements:'."\n" + ."\n" + .'* Can contain letters, numbers, or underscores (\\_).'."\n" + .'* Starts with a letter.'."\n" + .'* Length is 1 to 127 characters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'myName', 'title' => ''], + 'Description' => ['description' => 'Custom description of the knowledge base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.', 'title' => ''], 'KnowledgeBaseType' => [ - 'description' => '', + 'description' => 'The type of the knowledge base. Specifies whether to disable the instance protection period. Default value: false. Valid values:'."\n" + ."\n" + .'* TEXT: Document.'."\n" + .'* STRUCTURED: Structured data.'."\n" + .'* IMAGE: Picture.'."\n" + .'* VIDEO: Video.'."\n", 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'STRUCTURED' => 'STRUCTURED', - 'IMAGE' => 'IMAGE', - 'VIDEO' => 'VIDEO', - 'TEXT' => 'TEXT', - ], + 'enumValueTitles' => ['STRUCTURED' => 'STRUCTURED', 'IMAGE' => 'IMAGE', 'VIDEO' => 'VIDEO', 'TEXT' => 'TEXT'], 'example' => 'TEXT', + 'title' => '', ], - 'OutputDir' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - ], + 'OutputDir' => ['description' => 'Storage path for output data.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''], 'DataSources' => [ - 'description' => '', + 'description' => 'Data source.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '统一资源识别码', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', - 'readOnly' => true, - ], + 'Uri' => ['title' => '', 'description' => 'Source file storage path.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], 'ChunkConfig' => [ - 'description' => '', + 'description' => 'File slicing configuration.'."\n", 'type' => 'object', 'properties' => [ - 'ChunkSize' => [ - 'title' => '分块大小', - 'description' => '分块大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - 'readOnly' => true, - ], - 'ChunkOverlap' => [ - 'title' => '分块重叠大小', - 'description' => '分块重叠大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - 'readOnly' => true, - ], - 'ChunkDuration' => [ - 'title' => '分块时长', - 'description' => '分块时长', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'readOnly' => true, - ], - 'ChunkStrategy' => [ - 'title' => '分块策略', - 'description' => '分块策略', - 'type' => 'string', - 'required' => false, - 'example' => 'Default', - 'readOnly' => true, - 'default' => 'Default', - ], + 'ChunkSize' => ['title' => '', 'description' => 'Chunk size'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'readOnly' => true], + 'ChunkOverlap' => ['title' => '', 'description' => 'Chunk overlap size'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'readOnly' => true], + 'ChunkDuration' => ['title' => '', 'description' => 'Chunk duration, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'readOnly' => true], + 'ChunkStrategy' => ['title' => '', 'description' => 'Chunking strategy. Supported strategies are as follows:'."\n" + ."\n" + .'* Default. System default slicing strategy.'."\n" + .'* Asr. Split by audio content; valid for video knowledge bases.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'EmbeddingConfig' => [ - 'description' => '', + 'description' => 'Vector index configuration.'."\n", 'type' => 'object', 'properties' => [ - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => 'Embedding连接ID', - 'type' => 'string', - 'required' => true, - 'example' => 'conn-r3o7******38bh', - 'readOnly' => true, - ], - 'Model' => [ - 'title' => '模型', - 'description' => '模型', - 'type' => 'string', - 'required' => true, - 'example' => 'text-embedding-v4', - 'readOnly' => true, - ], + 'ConnectionId' => ['title' => '', 'description' => 'Index service connection ID. For more information about how to obtain the connection ID, see [ListConnections](~~2922801~~). The connection types supported by each type of knowledge base are as follows:'."\n" + ."\n" + .'* Documents: BaiLian LLM Service, General Embedding Model Service, AI Search Open Platform Model Service.'."\n" + .'* Structured Data: BaiLian LLM Service, General Embedding Model Service, AI Search Open Platform Model Service.'."\n" + .'* Images: BaiLian LLM Service, General Multimodal Embedding Model Service.'."\n" + .'* Videos: BaiLian LLM Service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'conn-r3o7******38bh', 'readOnly' => true], + 'Model' => ['title' => '', 'description' => 'Model name. Specifically, when selecting the BaiLian LLM Service, the models supported by each type of knowledge base are as follows:'."\n" + ."\n" + .'* Documents: text-embedding-v1, text-embedding-v2, text-embedding-v3, text-embedding-v4'."\n" + .'* Structured Data: text-embedding-v1, text-embedding-v2, text-embedding-v3, text-embedding-v4'."\n" + .'* Images: multimodal-embedding-v1'."\n" + .'* Videos: qwen2.5-vl-embedding'."\n", 'type' => 'string', 'required' => true, 'example' => 'text-embedding-v4', 'readOnly' => true], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'VectorDBConfig' => [ - 'description' => '', + 'description' => 'Vector store configuration.'."\n", 'type' => 'object', 'properties' => [ 'VectorDBType' => [ - 'title' => 'VectorDB类型', - 'description' => 'VectorDB类型', + 'title' => '', + 'description' => 'Vector database type. Supports the following values:'."\n" + ."\n" + .'* Elasticsearch'."\n" + .'* Milvus'."\n" + .'* Faiss (only supported for document and structured data knowledge bases)'."\n", 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'Elasticsearch' => 'Elasticsearch', - 'Faiss' => 'Faiss', - 'Milvus' => 'Milvus', - ], + 'enumValueTitles' => ['Elasticsearch' => 'Elasticsearch', 'Faiss' => 'Faiss', 'Milvus' => 'Milvus'], 'example' => 'Milvus', 'readOnly' => true, ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => 'Embedding连接ID', - 'type' => 'string', - 'required' => false, - 'example' => 'conn-7y5y******jja7', - 'readOnly' => true, - ], - 'CollectionName' => [ - 'title' => 'Collection名称', - 'description' => 'Collectioin名称', - 'type' => 'string', - 'required' => false, - 'example' => 'my_collection', - 'readOnly' => true, - ], + 'ConnectionId' => ['title' => '', 'description' => 'Vector database connection ID. For more information about how to obtain the connection ID, see [ListConnections](~~2922801~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'conn-7y5y******jja7', 'readOnly' => true], + 'CollectionName' => ['title' => '', 'description' => 'Vector database table or collection name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'my_collection', 'readOnly' => true], ], 'required' => true, + 'title' => '', + 'example' => '', ], - 'RuntimeId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rtime-apje******beaz', - ], + 'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''], 'MetaDataConfig' => [ - 'description' => '', + 'description' => 'The metadata configurations.'."\n", 'type' => 'object', 'properties' => [ 'CustomMetaData' => [ - 'title' => '自定义元数据', - 'description' => '自定义元数据', + 'title' => '', + 'description' => 'Custom metadata.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据Key', - 'type' => 'string', - 'required' => false, - 'example' => 'author', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据Value类型', - 'type' => 'string', - 'required' => false, - 'example' => 'String', - ], + 'Key' => ['title' => '', 'description' => 'Metadata field name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'author'], + 'ValueType' => ['title' => '', 'description' => 'Metadata field type. Currently, only the String class type is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'String'], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'IndexColumnConfig' => [ - 'description' => '', + 'description' => 'Structured knowledge base field column configuration.'."\n", 'type' => 'object', 'properties' => [ 'EmbeddingColumns' => [ - 'title' => 'Embedding列', - 'description' => 'Embedding列', + 'title' => '', + 'description' => 'Vector retrieval column. The fields in this list will be vectorized and participate in retrieval.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], ], 'required' => false, 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'readOnly' => true, + 'example' => '', ], 'ContentColumns' => [ - 'title' => '内容检索列', - 'description' => '内容检索列', + 'title' => '', + 'description' => 'Content filtering column. The fields in this list support keyword-based retrieval.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], ], 'required' => false, 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'readOnly' => true, + 'example' => '', ], 'ColumnDefinitions' => [ - 'title' => '所有列名', - 'description' => '所有列名', + 'title' => '', + 'description' => 'All column names.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '', 'description' => 'The column name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], ], 'required' => false, 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'readOnly' => true, + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -1850,800 +1479,637 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '478**', - ], - 'KnowledgeBaseId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-ksicx823d', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6', - 'title' => '请求ID', - ], + 'WorkspaceId' => ['description' => 'The workspace ID of the knowledge base.'."\n", 'type' => 'string', 'example' => '478**', 'title' => ''], + 'KnowledgeBaseId' => ['description' => 'Knowledge base ID.'."\n", 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'Request ID'."\n", 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', 'title' => 'CreateKnowledgeBase', - ], - 'GetKnowledgeBase' => [ - 'summary' => 'Get knowledge base.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + ], + 'CreateKnowledgeBaseJob' => [ + 'summary' => 'Create a Knowledge Base Task.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - ], - [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ksicx823d', - ], + 'schema' => ['description' => 'The ID of the Knowledge Base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''], ], [ - 'name' => 'VersionName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - 'title' => '请求ID', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '478**', - ], + 'WorkspaceId' => ['description' => 'The ID of the workspace. For information on how to obtain the workspace ID, see ListWorkspaces.[](~~449124~~)'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''], 'Accessibility' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-15T14:46:23Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-18T19:32:58Z', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myName', - ], - 'KnowledgeBaseId' => [ - 'description' => '', + 'description' => 'Workspace visibility. Possible values are:'."\n" + ."\n" + .'* PRIVATE: In this workspace, it is visible only to you and the administrator.'."\n" + .'* PUBLIC: This workspace is visible to all users.'."\n", 'type' => 'string', - 'example' => 'd-ksicx823d', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base.', - ], - 'KnowledgeBaseType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TEXT', - ], - 'DatasetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-cupbwkk5us9xpjz870', + 'required' => false, + 'example' => 'PUBLIC', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], + 'title' => '', ], - 'DataSources' => [ - 'description' => '', + 'Description' => ['description' => 'Knowledge base task description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.', 'title' => ''], + 'JobAction' => ['description' => 'The type of the task operation.'."\n" + ."\n" + .'* SyncIndex: updates the knowledge base index'."\n", 'type' => 'string', 'required' => false, 'example' => 'SyncIndex', 'title' => ''], + 'MaxRunningTimeInSeconds' => ['description' => 'The maximum running time for the task, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400', 'title' => ''], + 'ResourceId' => ['description' => 'The resource group ID. This field being empty or public-cluster indicates a public resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'quota89**76', 'title' => ''], + 'EcsSpecs' => [ + 'description' => 'Task Run Resource Configuration List Documentation and structured Knowledge Base contain only one Element and the Type is Worker. Images and Videos Knowledge Base contain two Elements and the Types are Head and Worker.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '统一资源识别码', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', - 'readOnly' => true, - ], + 'Type' => ['title' => '', 'description' => 'The type of the node. Possible values are Head and Worker.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'], + 'InstanceType' => ['title' => '', 'description' => 'The name of the instance type. Use of public resources must be filled in.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large', 'readOnly' => true], + 'PodCount' => ['title' => '', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'readOnly' => true], + 'CPU' => ['title' => '', 'description' => 'The number of CPU cores. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'readOnly' => true], + 'GPU' => ['title' => '', 'description' => 'The number of GPU cards. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'readOnly' => true], + 'Memory' => ['title' => '', 'description' => 'The memory size, in GB. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '', 'description' => 'The Shared Memory Capacity. Unit: GB. You must specify the resource quota to use.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => '', 'description' => 'GPU Class'."\n", 'type' => 'string', 'required' => false, 'example' => '16', 'readOnly' => true], + 'Driver' => ['title' => '', 'description' => 'The version of the GPU driver.'."\n", 'type' => 'string', 'required' => false, 'example' => '535.161.08', 'readOnly' => true], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'OutputDir' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - ], - 'ChunkConfig' => [ - 'description' => '', + 'UserVpc' => [ + 'description' => 'Task Run VPC Info.'."\n", 'type' => 'object', 'properties' => [ - 'ChunkSize' => [ - 'title' => '分块大小', - 'description' => '分块大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - 'readOnly' => true, - ], - 'ChunkOverlap' => [ - 'title' => '分块重叠大小', - 'description' => '分块重叠大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'readOnly' => true, - ], - 'ChunkDuration' => [ - 'title' => '分块时长', - 'description' => '分块时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'readOnly' => true, - ], - 'ChunkStrategy' => [ - 'title' => '分块策略', - 'description' => '分块策略', - 'type' => 'string', - 'example' => 'Default', - 'readOnly' => true, - 'default' => 'Default', - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '', 'description' => 'The vSwitch IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '', 'description' => 'The ID of a security group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-wz9i****1129', 'readOnly' => true], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'EmbeddingConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ConnectionName' => [ - 'title' => 'Embedding连接名称', - 'description' => 'Embedding连接名称', - 'type' => 'string', - 'example' => 'myEmbeddingConn', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => 'Embedding连接ID', - 'type' => 'string', - 'example' => 'conn-r3o7******38bh', - ], - 'Model' => [ - 'title' => '模型', - 'description' => '模型', - 'type' => 'string', - 'example' => 'text-embedding-v4', - ], - ], - ], - 'VectorDBConfig' => [ - 'description' => '', + 'description' => 'Index Configuration.'."\n", 'type' => 'object', 'properties' => [ - 'VectorDBType' => [ - 'title' => 'VectorDB类型', - 'description' => 'VectorDB类型', - 'type' => 'string', - 'example' => 'Milvus', - ], - 'ConnectionName' => [ - 'title' => 'VectorDB连接名称', - 'description' => 'VectorDB连接名称', - 'type' => 'string', - 'example' => 'myVectorConn', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => 'Embedding连接ID', - 'type' => 'string', - 'example' => 'conn-7y5y******jja7', - ], - 'CollectionName' => [ - 'title' => 'Collection名称', - 'description' => 'Collectioin名称', - 'type' => 'string', - 'example' => 'my_collection', - ], + 'BatchSize' => ['title' => '', 'description' => 'Index batch size. The knowledge base for documentation and structured data types is effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and video type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Creator' => [ - 'description' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseJobId' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'example' => 'kbjob-9mn******1z54', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'CreateKnowledgeBaseJob', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9mn******1z54\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'CreateRuntime' => [ + 'path' => '/api/v1/langstudio/runtimes', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'description' => 'Workspace visibility. Valid values:'."\n" + ."\n" + .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n" + ."\n" + .'- PUBLIC: Visible to everyone in this workspace.', 'type' => 'string', - 'example' => '2485765****023475', + 'example' => 'PRIVATE', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], + 'required' => false, + 'title' => '', ], - 'RuntimeId' => [ - 'description' => '', + 'WorkspaceId' => ['description' => 'Workspace ID. For more information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''], + 'RuntimeName' => ['description' => 'Runtime name. Requirements:'."\n" + ."\n" + .'- Can contain only letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- Must start with a letter.'."\n" + ."\n" + .'- Must be 1 to 256 characters long.', 'type' => 'string', 'required' => false, 'example' => 'dev01', 'title' => ''], + 'RuntimeType' => [ + 'description' => 'Runtime type. Valid value:'."\n" + ."\n" + .'- DSW: PAI-DSW instance.', 'type' => 'string', - 'example' => 'rtime-apje******beaz', + 'example' => 'DSW', + 'default' => 'DSW', + 'enum' => ['DSW'], + 'required' => false, + 'title' => '', ], - 'MetaDataConfig' => [ - 'description' => '', + 'EcsSpec' => [ + 'description' => 'ECS resource configuration.', 'type' => 'object', 'properties' => [ - 'CustomMetaData' => [ - 'title' => '自定义元数据', - 'description' => '自定义元数据', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据Key', - 'type' => 'string', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据Value类型', - 'type' => 'string', - ], - 'ReferenceCount' => [ - 'title' => '引用次数', - 'description' => '引用次数', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'ValueCount' => [ - 'title' => '值的个数', - 'description' => '值的个数', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - ], - ], - ], + 'InstanceType' => ['description' => 'Instance type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'ecs.c6.large'], + 'GPUType' => ['description' => 'GPU type. Valid values:'."\n" + ."\n" + .'- V100'."\n" + ."\n" + .'- A100'."\n" + ."\n" + .'- T4'."\n" + ."\n" + .'- A10'."\n" + ."\n" + .'- P100', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'V100'], + 'CPU' => ['description' => 'Number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '4'], + 'GPU' => ['description' => 'Number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '0'], + 'Memory' => ['description' => 'Memory size in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '8'], + 'SharedMemory' => ['description' => 'Shared memory in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '8'], + 'Driver' => ['description' => 'GPU driver version.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '535.161.08'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'AutoUpdateConfig' => [ - 'description' => '', + 'ResourceId' => ['description' => 'Resource quota ID.', 'type' => 'string', 'required' => false, 'example' => 'quota18******zv9', 'title' => ''], + 'UserVpc' => [ + 'description' => 'User VPC configuration.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '知识库自动更新状态', - 'description' => '知识库自动更新状态', - 'type' => 'string', - 'enumValueTitles' => [ - 'Enable' => 'Enable', - 'Disable' => 'Disable', - ], - 'example' => 'Enable', - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID', - 'type' => 'string', - 'example' => 'public-cluster', - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'EmbeddingConfig' => [ - 'title' => 'Embedding配置', - 'description' => 'Embedding配置', - 'type' => 'object', - 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => 'Embedding分批大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => 'Embedding并发数', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['description' => 'vSwitch ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['description' => 'Security group ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'sg-wz9i****1129'], + 'DefaultRoute' => ['description' => 'Default route.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'eth0'], + 'ExtendedCIDRs' => [ + 'title' => '', + 'description' => 'Extended CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'Extended CIDR block.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '172.16.1.0/24', 'title' => ''], + 'required' => false, + 'readOnly' => true, + 'example' => '', ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置', - '$ref' => '#/components/schemas/UserVpc', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Envs' => [ + 'description' => 'Environment variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Environment key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testKey1'], + 'Value' => ['description' => 'Environment value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testValue1'], ], - 'EcsSpecs' => [ - 'title' => '运行资源配置', - 'description' => '运行资源配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'example' => 'Worker', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - 'example' => 'ecs.c6.large', - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本', - 'type' => 'string', - ], - ], - ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'Labels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testKey1'], + 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'testValue1'], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'VersionName' => [ - 'description' => '', - 'type' => 'string', + 'DataSources' => [ + 'description' => 'Mounted data sources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'Dataset ID. Specify either this or Uri.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'd-umns******zij4szhc'], + 'Uri' => ['description' => 'OSS path of the data source. Specify either this or DatasetId.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/'], + 'MountPath' => ['description' => 'Mount path.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => '/mnt/data'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'IndexColumnConfig' => [ - 'description' => '', + 'CredentialConfig' => [ + 'description' => 'Credential configuration.', 'type' => 'object', 'properties' => [ - 'EmbeddingColumns' => [ - 'title' => 'Embedding列', - 'description' => 'Embedding列', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - 'readOnly' => true, - ], - 'ContentColumns' => [ - 'title' => '内容检索列', - 'description' => '内容检索列', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - 'readOnly' => true, - ], - 'ColumnDefinitions' => [ - 'title' => '所有列名', - 'description' => '所有列名', + 'EnableCredentialInject' => ['description' => 'Whether to enable credential injection.', 'type' => 'boolean', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'true'], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'Environment variable role key.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '0'], + 'CredentialConfigItems' => [ + 'title' => '', + 'description' => 'List of credential configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列Key', - 'type' => 'string', + 'Key' => ['title' => 'Key', 'description' => 'Key that identifies the configuration.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '0'], + 'Type' => ['title' => 'Type', 'description' => 'Configuration type. Valid values:'."\n" + ."\n" + .'- Role: Role assumption'."\n" + ."\n" + .'- RoleChain: Role chain assumption', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => 'Role'], + 'Roles' => [ + 'title' => '', + 'description' => 'List of configured roles.', + 'type' => 'array', + 'items' => [ + 'description' => 'Role information.', + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'Entity that assumes the role.', 'type' => 'string', 'readOnly' => true, 'required' => false, 'example' => '1095******785714'], + 'RoleType' => ['description' => 'Type of assumed role. Valid values:'."\n" + ."\n" + .'- service: Assumed by a service'."\n" + ."\n" + .'- user: Assumed by a regular user account', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'service'], + 'RoleArn' => ['description' => 'Role ARN.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'required' => false, 'example' => 'acs:ram::1095******785714:role/testrole'], + ], + 'required' => false, + 'readOnly' => true, + 'title' => '', + 'example' => '', + ], + 'required' => false, 'readOnly' => true, + 'example' => '', ], ], + 'required' => false, 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, 'readOnly' => true, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'RunTimeout' => ['description' => 'Timeout for a single test run on the runtime, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', 'title' => ''], + 'WorkDir' => ['description' => 'OSS path of the working directory.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'AutoUpdateImage' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"GmtCreateTime\\": \\"2024-12-15T14:46:23Z\\",\\n \\"GmtModifiedTime\\": \\"2025-12-18T19:32:58Z\\",\\n \\"Name\\": \\"myName\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"Description\\": \\"This is a description of the knowledge base.\\",\\n \\"KnowledgeBaseType\\": \\"TEXT\\",\\n \\"DatasetId\\": \\"d-cupbwkk5us9xpjz870\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\"\\n }\\n ],\\n \\"OutputDir\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 1024,\\n \\"ChunkOverlap\\": 200,\\n \\"ChunkDuration\\": 30,\\n \\"ChunkStrategy\\": \\"Default\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"ConnectionName\\": \\"myEmbeddingConn\\",\\n \\"ConnectionId\\": \\"conn-r3o7******38bh\\",\\n \\"Model\\": \\"text-embedding-v4\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"Milvus\\",\\n \\"ConnectionName\\": \\"myVectorConn\\",\\n \\"ConnectionId\\": \\"conn-7y5y******jja7\\",\\n \\"CollectionName\\": \\"my_collection\\"\\n },\\n \\"Creator\\": \\"2485765****023475\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"author\\",\\n \\"ValueType\\": \\"String\\",\\n \\"ReferenceCount\\": 5,\\n \\"ValueCount\\": 3\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"Enable\\",\\n \\"ResourceId\\": \\"quota89**76\\",\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 8,\\n \\"Concurrency\\": 1\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"VSwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"v1\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetKnowledgeBase', - ], - 'UpdateKnowledgeBase' => [ - 'summary' => 'Update Knowledge Base.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'put', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response.', + 'type' => 'object', + 'properties' => [ + 'RuntimeId' => ['description' => 'Runtime ID.', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'title' => 'CreateRuntime', + 'summary' => 'Creates a runtime.', + 'description' => 'Before using this API, make sure you fully understand the billing method and [pricing](https://help.aliyun.com/zh/pai/dsw-billing-description?spm=a2c4g.11186623.help-menu-30347.d_1_1_3.fb4453d9l200bE) for PAI-DSW.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'CreateSnapshot' => [ + 'summary' => 'Create a snapshot.', + 'path' => '/api/v1/langstudio/snapshots', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - ], - [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'Description' => [ - 'description' => '', + 'Accessibility' => [ + 'description' => 'Workspace visibility. Valid values:'."\n" + .'- PRIVATE: Visible only to you and administrators in this workspace.'."\n" + .'- PUBLIC: Visible to everyone in this workspace.', 'type' => 'string', 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], + 'title' => '', ], - 'RuntimeId' => [ - 'description' => '', + 'CreationType' => [ + 'description' => 'Snapshot creation type. Valid values:'."\n" + .'* ManualCreated: manual creation'."\n" + .'* DeploymentAutoCreated: automatic creation by service deployment'."\n" + .'* EvaluationAutoCreated: automatic creation by evaluation job', 'type' => 'string', 'required' => false, + 'example' => 'ManualCreated', + 'enum' => ['ManualCreated', 'DeploymentAutoCreated', 'EvaluationAutoCreated'], + 'title' => '', ], - 'BindRuntime' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'MetaDataConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CustomMetaData' => [ - 'title' => '自定义元数据', - 'description' => '自定义元数据', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据Key', - 'type' => 'string', - 'required' => false, - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据Value类型', - 'type' => 'string', - 'required' => false, - 'example' => 'String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'AutoUpdateConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '知识库自动更新状态', - 'description' => '知识库自动更新状态', - 'type' => 'string', - 'required' => false, - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID', - 'type' => 'string', - 'required' => false, - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'EmbeddingConfig' => [ - 'title' => 'Embedding配置', - 'description' => 'Embedding配置', - 'type' => 'object', - 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => 'Embedding分批大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => 'Embedding并发数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - ], - ], - 'required' => false, - ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置', - 'required' => false, - '$ref' => '#/components/schemas/UserVpc', - ], - 'EcsSpecs' => [ - 'title' => '运行资源配置', - 'description' => '运行资源配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'required' => false, - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - 'required' => false, - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - 'required' => false, - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本', - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], + 'SnapshotName' => ['description' => 'Snapshot name. Requirements:'."\n" + .'* Can contain only letters, digits, and underscores (_)'."\n" + .'* Must start with a letter'."\n" + .'* Length must be 1 to 256 characters', 'type' => 'string', 'required' => false, 'example' => 'snapshot01', 'title' => ''], + 'Description' => ['description' => 'Description of the snapshot.', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''], + 'WorkDir' => ['description' => 'OSS working directory for storing the snapshot.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''], + 'SnapshotResourceType' => [ + 'description' => 'Snapshot resource type. Valid values:'."\n" + .'* Flow: pipeline', + 'type' => 'string', 'required' => false, + 'example' => 'Flow', + 'enum' => ['Flow'], + 'title' => '', ], + 'SnapshotResourceId' => ['description' => 'Snapshot resource ID.', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******123', 'title' => ''], + 'SourceStoragePath' => ['description' => 'Create a snapshot from source files under the specified OSS folder.', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/path/to/snapshot/source', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Return Result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - 'title' => '请求ID', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], + 'SnapshotId' => ['description' => 'Snapshot ID.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''], + 'RequestId' => ['title' => 'Request ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', - 'title' => 'UpdateKnowledgeBase', + 'title' => 'Create Snapshot', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SnapshotId\\": \\"snap-asfg******123\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'DeleteDeployment' => [ + 'summary' => 'Delete a deployment job.', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'path', + 'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return Result. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Delete Deployment Job ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', ], 'DeleteKnowledgeBase' => [ 'summary' => 'Delete knowledge base.', 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478***', - ], + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''], ], [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['description' => 'The ID of the Knowledge Base.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''], ], ], 'responses' => [ @@ -2651,691 +2117,702 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26', - 'title' => '请求ID', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID'."\n", 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\"\\n}","type":"json"}]', 'title' => 'DeleteKnowledgeBase', - ], - 'ListKnowledgeBases' => [ - 'summary' => 'Queries a list of knowledge bases.', - 'path' => '/api/v1/langstudio/knowledgebases', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\"\\n}","type":"json"}]', + ], + 'DeleteKnowledgeBaseJob' => [ + 'summary' => 'Deletes a knowledge base task.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the workspace where the knowledge base resides.', 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''], ], [ - 'name' => 'KnowledgeBaseId', - 'in' => 'query', + 'name' => 'KnowledgeBaseJobId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the knowledge base task.', 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + 'title' => 'Delete a knowledge base task', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteRuntime' => [ + 'summary' => 'Delete a runtime.', + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ [ - 'name' => 'SortBy', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', + 'name' => 'RuntimeId', + 'in' => 'path', + 'schema' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', + 'description' => 'The information returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeleteRuntime', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'DeleteSnapshot' => [ + 'summary' => 'Delete a snapshot.', + 'path' => '/api/v1/langstudio/snapshots/{SnapshotId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ [ - 'name' => 'Creator', + 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], ], [ - 'name' => 'KnowledgeBaseType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => ['description' => 'Snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Return Result.', 'type' => 'object', 'properties' => [ - 'KnowledgeBases' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/KnowledgeBase', - ], - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '请求最大返回结果数', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'title' => '下次请求令牌', - 'example' => '11', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '总量', - 'example' => '25', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35686626-8D83-5ADE-B400-08A6613A6057', - 'title' => '请求ID', - ], + 'RequestId' => ['title' => 'Request ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBases\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"KnowledgeBaseId\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"KnowledgeBaseType\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"\\"\\n }\\n ],\\n \\"OutputDir\\": \\"\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 0,\\n \\"ChunkOverlap\\": 0,\\n \\"ChunkDuration\\": 0,\\n \\"ChunkStrategy\\": \\"\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"EmbeddingType\\": \\"\\",\\n \\"ConnectionName\\": \\"\\",\\n \\"ConnectionId\\": \\"\\",\\n \\"Model\\": \\"\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"\\",\\n \\"ConnectionName\\": \\"\\",\\n \\"ConnectionId\\": \\"\\",\\n \\"CollectionName\\": \\"\\"\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\"\\n },\\n \\"Creator\\": \\"\\",\\n \\"RuntimeId\\": \\"\\",\\n \\"ScheduleConfig\\": {\\n \\"InstanceMode\\": \\"\\",\\n \\"Recurrence\\": \\"\\",\\n \\"RerunMode\\": \\"\\",\\n \\"FailureRerunConfig\\": {\\n \\"RerunTimes\\": 0,\\n \\"RerunInterval\\": 0\\n },\\n \\"Timeout\\": 0,\\n \\"TriggerConfig\\": {\\n \\"Cron\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"EndTime\\": \\"\\"\\n },\\n \\"ResourceGroupConfig\\": {\\n \\"ResourceGroup\\": \\"\\",\\n \\"Id\\": \\"\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"InstanceType\\": \\"\\",\\n \\"PodCount\\": 0,\\n \\"CPU\\": 0,\\n \\"GPU\\": 0,\\n \\"Memory\\": 0,\\n \\"SharedMemory\\": 0,\\n \\"GPUType\\": \\"\\",\\n \\"Driver\\": \\"\\"\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"VSwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\"\\n },\\n \\"ResourceId\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"ScheduleWorkflowId\\": \\"\\",\\n \\"ScheduleCycleTaskId\\": \\"\\"\\n },\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"ValueType\\": \\"\\",\\n \\"ReferenceCount\\": 0,\\n \\"ValueCount\\": 0\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"\\",\\n \\"ResourceId\\": \\"\\",\\n \\"MaxRunningTimeInSeconds\\": 0,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 0,\\n \\"Concurrency\\": 0\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"VSwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"InstanceType\\": \\"\\",\\n \\"PodCount\\": 0,\\n \\"GPUType\\": \\"\\",\\n \\"CPU\\": 0,\\n \\"GPU\\": 0,\\n \\"Memory\\": 0,\\n \\"SharedMemory\\": 0,\\n \\"Driver\\": \\"\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"\\"\\n }\\n ]\\n },\\n \\"IndexManifest\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"20\\",\\n \\"TotalCount\\": 51,\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]', - 'title' => 'ListKnowledgeBases', - ], - 'RetrieveKnowledgeBase' => [ - 'summary' => 'Retrieve the knowledge base.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Delete Snapshot', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'GetDeployment' => [ + 'summary' => 'Retrieve the details of a deployment job.', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd-ksicx823d', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '174***', - ], - 'Query' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'TopK' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'ScoreThreshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - ], - 'MetaDataFilterConditions' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "FilterCondition": "and", '."\n" - .' "MetaDataFilters": ['."\n" - .' {'."\n" - .' "Key": "key1", '."\n" - .' "Value": "value1", '."\n" - .' "Operator": "=="'."\n" - .' },'."\n" - .' {'."\n" - .' "Key": "key2", '."\n" - .' "Value": "value2", '."\n" - .' "Operator": "!="'."\n" - .' },'."\n" - .' {'."\n" - .' "Key": "file_name", '."\n" - .' "Value": "prefix", '."\n" - .' "Operator": "contains"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'QueryMode' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'hybrid' => 'hybrid', - 'dense' => 'dense', - ], - 'example' => 'dense', - ], - 'VersionName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'RerankConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "ConnectionId":"conn-xxx",'."\n" - .' "Model": "qwen-max",'."\n" - .' "TopK": 5'."\n" - .'}', - ], - 'RewriteConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "ConnectionId":"conn-xxx",'."\n" - .' "Model": "qwen-max",'."\n" - .' "Temperature": 0.7,'."\n" - .' "TopP": 0.9,'."\n" - .' "PresencePenalty": 0.5,'."\n" - .' "FrequencyPenalty": 0.5,'."\n" - .' "Seed": 0,'."\n" - .' "MaxTokens": 1024,'."\n" - .' "Stop": [],'."\n" - .' "EnableThinking": true'."\n" - .'}', - ], - 'HybridStrategyConfig' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Strategy": "rrf",'."\n" - .' "RRFK":60,'."\n" - .' "Weight": 0.5'."\n" - .'}', - ], - ], - 'required' => false, - ], + 'name' => 'DeploymentId', + 'in' => 'path', + 'schema' => ['description' => 'Deployment task ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Return Result. ', 'type' => 'object', 'properties' => [ - 'KnowledgeBaseFileChunks' => [ - 'description' => '', + 'RequestId' => ['title' => 'Request ID ', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => 'The workspace ID. ', 'type' => 'string', 'example' => '478***', 'title' => ''], + 'Accessibility' => ['description' => 'The workspace visibility. Valid values: '."\n" + .'- PRIVATE: The resource is visible only to you and administrators in this workspace. '."\n" + .'- PUBLIC: The resource is visible to all users in this workspace. ', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Creator' => ['description' => 'Creator ID. ', 'type' => 'string', 'example' => '2003******4844', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Creation Time. ', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Updated At. ', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''], + 'DeploymentId' => ['description' => 'The ID of the deployment job. ', 'type' => 'string', 'example' => 'dploy-asdf******1234', 'title' => ''], + 'DeploymentStatus' => ['description' => 'Task Status. Valid values: '."\n" + .'* Creating: Creating. '."\n" + .'* Failed: Deployment failed. '."\n" + .'* Stopping: Stopping. '."\n" + .'* Waiting: Waiting. '."\n" + .'* Starting: Starting. '."\n" + .'* Running: Running. '."\n" + .'* Pending: Pending. '."\n" + .'* WaitForConfirm: Waiting for confirmation. '."\n" + .'* Canceled: Canceled. '."\n" + .'* Succeed: Succeeded. ', 'type' => 'string', 'example' => 'Succeed', 'title' => ''], + 'OperationType' => ['description' => 'Operation Type. Valid values: '."\n" + .'* Create: Create a new service. '."\n" + .'* Update: Update an existing service. ', 'type' => 'string', 'example' => 'Create', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type to be deployed. Valid values: '."\n" + .'* Flow: A pipeline project '."\n" + .'* Code: A Code project', 'type' => 'string', 'example' => 'Flow', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the resource to be deployed. ', 'type' => 'string', 'example' => 'flow-asdf******123', 'title' => ''], + 'ResourceSnapshotId' => ['description' => 'The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If not provided, the system creates a new snapshot of the resource before deployment. ', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''], + 'ServiceName' => ['description' => 'Service Name. Format requirements: '."\n" + .'* Supports lowercase letters, digits, and underscores. '."\n" + .'* Must start with a letter. '."\n" + .'* Length must be 1–45 characters. ', 'type' => 'string', 'example' => 'myservice01', 'title' => ''], + 'Description' => ['description' => 'The service description. ', 'type' => 'string', 'example' => 'This is description', 'title' => ''], + 'WorkDir' => ['description' => 'The OSS working directory for the service. It stores runtime logs, conversation history, and other data. ', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'EnableTrace' => ['description' => 'Indicates whether Tracing Analysis is enabled. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ChatHistoryConfig' => [ + 'description' => 'Chat history configuration. ', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => 'Storage Type ', + 'description' => 'The storage class. Valid values: '."\n" + .'* LOCAL: Chat history is stored in a local SQLite file. This option does not support multi-instance deployment. '."\n" + .'* OSS: Chat history is stored in a specific path under the service OSS workspace path. '."\n" + .'* RDS: Chat history is stored in an RDS Table, and an RDS connection must be specified. ', + 'type' => 'string', + 'example' => 'RDS', + 'readOnly' => true, + 'enum' => ['LOCAL', 'RDS', 'OSS'], + ], + 'ConnectionName' => ['title' => 'Connection Name ', 'description' => 'The connection name. This parameter is required when the chat history storage type is RDS. ', 'type' => 'string', 'example' => 'rdsconnection', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', + ], + 'ContentModerationConfig' => [ + 'description' => 'Content moderation configuration. ', + 'type' => 'object', + 'properties' => [ + 'EnableInputModeration' => ['title' => 'Enable input content moderation ', 'description' => 'Indicates whether to enable security review for input. ', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => 'Enable output content moderation ', 'description' => 'Indicates whether to enable content moderation for output. ', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => 'Cache size for streaming output content submitted for moderation ', 'description' => 'Cache size for streaming output content submitted for moderation. The default value is 5. ', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', + ], + 'DeploymentConfig' => ['description' => 'Deployment configuration. For details, see [Deployment Configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) in PAI-EAS documentation. ', 'type' => 'string', 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''], + 'DeploymentStages' => [ + 'description' => 'Stage information of the deployment. ', 'type' => 'array', 'items' => [ - '$ref' => '#/components/schemas/KnowledgeBaseFileChunk', + 'type' => 'object', + 'properties' => [ + 'Stage' => ['title' => 'Stage ', 'description' => 'Deployment stage. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'StageName' => ['title' => 'Stage Name ', 'description' => 'Deployment stage name. ', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true], + 'Description' => ['title' => 'Description ', 'description' => 'Deployment stage description. ', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true], + 'GmtStartTime' => ['title' => 'Start Time ', 'description' => 'Start Time. ', 'type' => 'string', 'example' => '2025-09-23T10:25:38+08:00', 'readOnly' => true], + 'GmtEndTime' => ['title' => 'End Time', 'description' => 'End time. ', 'type' => 'string', 'example' => '2025-09-23T10:35:38+08:00', 'readOnly' => true], + 'StageStatus' => ['title' => 'Stage Status ', 'description' => 'Deployment stage status. Valid values: '."\n" + .'* NotStarted: Not started. '."\n" + .'* WaitForConfirm: Waiting for confirmation. '."\n" + .'* Waiting: Waiting. '."\n" + .'* Creating: Creating. '."\n" + .'* Running: Running. '."\n" + .'* Succeed: Succeeded. '."\n" + .'* Failed: Failed. '."\n" + .'* Canceled: Canceled. ', 'type' => 'string', 'example' => 'Running', 'readOnly' => true], + 'ErrorMessage' => ['title' => 'Error Message ', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true], + 'StageInfo' => ['title' => 'Stage Information ', 'description' => 'Deployment stage information. ', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29kw8nubqb0hotn\\"}', 'readOnly' => true], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ErrorMessage' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'This is error message', 'title' => ''], + 'AutoApproval' => ['description' => 'Indicates whether deployment confirmation is automatically skipped. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseFileChunks\\": [\\n {\\n \\"Score\\": 0,\\n \\"ChunkId\\": \\"\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 0,\\n \\"ChunkSequence\\": 0,\\n \\"ChunkContent\\": \\"\\",\\n \\"ChunkSize\\": 0,\\n \\"ChunkStatus\\": \\"\\",\\n \\"DownloadUrl\\": \\"\\",\\n \\"ThumbnailUrl\\": \\"\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"Uri\\": \\"\\",\\n \\"DownloadUrl\\": \\"\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"\\",\\n \\"FileUri\\": \\"\\",\\n \\"FileMetaId\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'RetrieveKnowledgeBase', - ], - 'CreateKnowledgeBaseJob' => [ - 'summary' => 'Create a Knowledge Base Task.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Get Deployment Task Details ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2003******4844\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"DeploymentStatus\\": \\"Succeed\\",\\n \\"OperationType\\": \\"Create\\",\\n \\"ResourceType\\": \\"Flow\\",\\n \\"ResourceId\\": \\"flow-asdf******123\\",\\n \\"ResourceSnapshotId\\": \\"snap-asfg******123\\",\\n \\"ServiceName\\": \\"myservice01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"EnableTrace\\": true,\\n \\"ChatHistoryConfig\\": {\\n \\"StorageType\\": \\"RDS\\",\\n \\"ConnectionName\\": \\"rdsconnection\\"\\n },\\n \\"ContentModerationConfig\\": {\\n \\"EnableInputModeration\\": true,\\n \\"EnableOutputModeration\\": true,\\n \\"StreamingModerationThreshold\\": 5\\n },\\n \\"DeploymentConfig\\": \\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"langstudio_2026******3848_jro7\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instance\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"workspace_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"285***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enable_webservice\\\\\\\\\\\\\\":false},\\\\\\\\\\\\\\"cloud\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"computing\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instances\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g7.xlarge\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"networking\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"vpc_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vpc-bp1obprt******4bzo00d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vswitch_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vsw-bp1p6i36k******pmfhw8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"security_group_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sg-bp1djud4******zecl5a\\\\\\\\\\\\\\"}}}\\",\\n \\"DeploymentStages\\": [\\n {\\n \\"Stage\\": 1,\\n \\"StageName\\": \\"PrepareSnapshot\\",\\n \\"Description\\": \\"Create snapshot for deployment\\",\\n \\"GmtStartTime\\": \\"2025-09-23T10:25:38+08:00\\",\\n \\"GmtEndTime\\": \\"2025-09-23T10:35:38+08:00\\",\\n \\"StageStatus\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"This is error\\",\\n \\"StageInfo\\": \\"{\\\\\\\\\\\\\\"SnapshotId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"snap-i8j29kw8nubqb0hotn\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"This is error message\\",\\n \\"AutoApproval\\": true\\n}","type":"json"}]', + ], + 'GetKnowledgeBase' => [ + 'summary' => 'Get knowledge base.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '478**', 'title' => ''], + ], + [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd-ksicx823d', - ], + 'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-ksicx823d', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'VersionName', + 'in' => 'query', + 'schema' => ['description' => 'Knowledge Base Version. Default is v1.'."\n", 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - 'Accessibility' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - 'default' => 'PUBLIC', - 'enum' => [ - 'PUBLIC', - 'PRIVATE', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => 'The ID of the workspace where the knowledge base resides.'."\n", 'type' => 'string', 'example' => '478**', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility, possible values are:'."\n" + ."\n" + .'* PRIVATE: In this workspace, visible only to you and administrators.'."\n" + .'* PUBLIC: In this workspace, visible to everyone.'."\n", 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Knowledge base creation time (UTC).'."\n", 'type' => 'string', 'example' => '2024-12-15T14:46:23Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Knowledge base modification time (UTC).'."\n", 'type' => 'string', 'example' => '2025-12-18T19:32:58Z', 'title' => ''], + 'Name' => ['description' => 'Knowledge base name.'."\n", 'type' => 'string', 'example' => 'myName', 'title' => ''], + 'KnowledgeBaseId' => ['description' => 'Knowledge base ID.'."\n", 'type' => 'string', 'example' => 'd-ksicx823d', 'title' => ''], + 'Description' => ['description' => 'Knowledge base description.'."\n", 'type' => 'string', 'example' => 'This is a description of the knowledge base.', 'title' => ''], + 'KnowledgeBaseType' => ['description' => 'Knowledge base type.'."\n" + ."\n" + .'* TEXT: Document.'."\n" + .'* STRUCTURED: Structured data.'."\n" + .'* IMAGE: Picture.'."\n" + .'* VIDEO: Video.'."\n", 'type' => 'string', 'example' => 'TEXT', 'title' => ''], + 'DatasetId' => ['description' => 'The ID of the dataset corresponding to the knowledge base.'."\n", 'type' => 'string', 'example' => 'd-cupbwkk5us9xpjz870', 'title' => ''], + 'DataSources' => [ + 'description' => 'Data source.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uri' => ['title' => '', 'description' => 'Storage path for the source file.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base job.', - ], - 'JobAction' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'OutputDir' => ['description' => 'Storage path for the output data.'."\n", 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', 'title' => ''], + 'ChunkConfig' => [ + 'description' => 'File slicing configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'ChunkSize' => ['title' => '', 'description' => 'Chunk size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'readOnly' => true], + 'ChunkOverlap' => ['title' => '', 'description' => 'Chunk overlap size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'readOnly' => true], + 'ChunkDuration' => ['title' => '', 'description' => 'Chunk duration in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'readOnly' => true], + 'ChunkStrategy' => ['title' => '', 'description' => 'Chunking strategy. Strategy types are as follows:'."\n" + ."\n" + .'* Default. System default slicing strategy.'."\n" + .'* ASR. Split by audio content; valid for video knowledge bases.'."\n", 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], + ], + 'title' => '', + 'example' => '', ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', + 'EmbeddingConfig' => [ + 'description' => 'Vector index configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConnectionName' => ['title' => '', 'description' => 'Index service connection name.'."\n", 'type' => 'string', 'example' => 'myEmbeddingConn'], + 'ConnectionId' => ['title' => '', 'description' => 'Index service connection ID.'."\n", 'type' => 'string', 'example' => 'conn-r3o7******38bh'], + 'Model' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'text-embedding-v4'], + ], + 'title' => '', + 'example' => '', ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'public-cluster', + 'VectorDBConfig' => [ + 'description' => 'Vector database configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'VectorDBType' => ['title' => '', 'description' => 'Vector database type. Supported values are as follows:'."\n" + ."\n" + .'* Elasticsearch'."\n" + .'* Milvus'."\n" + .'* Faiss'."\n", 'type' => 'string', 'example' => 'Milvus'], + 'ConnectionName' => ['title' => '', 'description' => 'Vector database connection name.'."\n", 'type' => 'string', 'example' => 'myVectorConn'], + 'ConnectionId' => ['title' => '', 'description' => 'Vector database connection ID.'."\n", 'type' => 'string', 'example' => 'conn-7y5y******jja7'], + 'CollectionName' => ['title' => '', 'description' => 'Vector database table or collection name.'."\n", 'type' => 'string', 'example' => 'my_collection'], + ], + 'title' => '', + 'example' => '', ], - 'EcsSpecs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Worker', - 'readOnly' => true, - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.large', - 'readOnly' => true, - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'readOnly' => true, - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'readOnly' => true, - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'readOnly' => true, - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', - 'readOnly' => true, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - 'required' => false, - 'readOnly' => true, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本', - 'type' => 'string', - 'required' => false, - 'example' => '535.161.08', - 'readOnly' => true, + 'Creator' => ['description' => 'Creator user ID.'."\n", 'type' => 'string', 'example' => '2485765****023475', 'title' => ''], + 'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''], + 'MetaDataConfig' => [ + 'description' => 'Metadata configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomMetaData' => [ + 'title' => '', + 'description' => 'Custom metadata.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Custom metadata.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Metadata field name.'."\n", 'type' => 'string', 'example' => 'author'], + 'ValueType' => ['title' => '', 'description' => 'Metadata field type.'."\n", 'type' => 'string', 'example' => 'String'], + 'ReferenceCount' => ['title' => '', 'description' => 'The number of references to the permission policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], + 'ValueCount' => ['title' => '', 'description' => 'Number of values.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'UserVpc' => [ - 'description' => '', + 'AutoUpdateConfig' => [ + 'description' => 'Knowledge base auto-update configuration.'."\n", 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', + 'Status' => [ + 'title' => '', + 'description' => 'Knowledge base auto-update switch status.'."\n" + ."\n" + .'* Enable: Turn on auto-update.'."\n" + .'* Disable: Turn off auto-update.'."\n", 'type' => 'string', - 'required' => false, - 'readOnly' => true, + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], + 'example' => 'Enable', + 'default' => 'Disable', ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'required' => false, - 'readOnly' => true, + 'ResourceId' => ['title' => '', 'description' => 'Resource group ID. Empty or \'public-cluster\' indicates public resources.'."\n", 'type' => 'string', 'example' => 'quota89**76'], + 'MaxRunningTimeInSeconds' => ['title' => '', 'description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], + 'EmbeddingConfig' => [ + 'title' => '', + 'description' => 'Vector index configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'BatchSize' => ['title' => '', 'description' => 'Index batch size. Document and structured data type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Concurrency' => ['title' => '', 'description' => 'Index concurrency count. Image and video type knowledge base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'], + ], + 'example' => '', ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'required' => false, - 'readOnly' => true, + 'UserVpc' => ['title' => '', 'description' => 'User VPC configuration.'."\n", '$ref' => '#/components/schemas/UserVpc', 'example' => ''], + 'EcsSpecs' => [ + 'title' => '', + 'description' => 'Runtime resource configuration list.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Runtime resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '', 'description' => 'Number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GPUType' => ['title' => '', 'description' => 'The GPU type.'."\n", 'type' => 'string', 'example' => 'V100'], + 'CPU' => ['title' => '', 'description' => 'The number of vCPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'GPU' => ['title' => '', 'description' => 'The number of GPUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Memory' => ['title' => '', 'description' => 'The memory size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'SharedMemory' => ['title' => '', 'description' => 'The shared memory size. Unit: GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'Driver' => ['title' => '', 'description' => 'The version of the GPU driver.'."\n", 'type' => 'string', 'example' => '550.127.08'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'EmbeddingConfig' => [ - 'description' => '', + 'VersionName' => ['description' => 'Knowledge base version. Default is v1.'."\n", 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'IndexColumnConfig' => [ + 'description' => 'Column field configuration. The structured data type knowledge base is effective.'."\n", 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => 'Embedding分批大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', + 'EmbeddingColumns' => [ + 'title' => '', + 'description' => 'Vector index column. The fields in this list will be vectorized and participate in retrieval.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Vector retrieval column.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true], + ], + 'readOnly' => true, + 'title' => '', + 'example' => '', + ], 'readOnly' => true, + 'example' => '', ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => 'Embedding并发数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', + 'ContentColumns' => [ + 'title' => '', + 'description' => 'Content filtering column. The fields in this list support keyword-based retrieval.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Content filtering column.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true], + ], + 'readOnly' => true, + 'title' => '', + 'example' => '', + ], 'readOnly' => true, + 'example' => '', + ], + 'ColumnDefinitions' => [ + 'title' => '', + 'description' => 'All column names.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The column name.'."\n", 'type' => 'string', 'example' => 'column1', 'readOnly' => true], + ], + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'readOnly' => true, + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'KnowledgeBaseJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'kbjob-9mn******1z54', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - 'title' => '请求ID', - ], + 'title' => 'GetKnowledgeBase', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9mn******1z54\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', - 'title' => 'CreateKnowledgeBaseJob', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"GmtCreateTime\\": \\"2024-12-15T14:46:23Z\\",\\n \\"GmtModifiedTime\\": \\"2025-12-18T19:32:58Z\\",\\n \\"Name\\": \\"myName\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"Description\\": \\"This is a description of the knowledge base.\\",\\n \\"KnowledgeBaseType\\": \\"TEXT\\",\\n \\"DatasetId\\": \\"d-cupbwkk5us9xpjz870\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\"\\n }\\n ],\\n \\"OutputDir\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 1024,\\n \\"ChunkOverlap\\": 200,\\n \\"ChunkDuration\\": 30,\\n \\"ChunkStrategy\\": \\"Default\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"ConnectionName\\": \\"myEmbeddingConn\\",\\n \\"ConnectionId\\": \\"conn-r3o7******38bh\\",\\n \\"Model\\": \\"text-embedding-v4\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"Milvus\\",\\n \\"ConnectionName\\": \\"myVectorConn\\",\\n \\"ConnectionId\\": \\"conn-7y5y******jja7\\",\\n \\"CollectionName\\": \\"my_collection\\"\\n },\\n \\"Creator\\": \\"2485765****023475\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"author\\",\\n \\"ValueType\\": \\"String\\",\\n \\"ReferenceCount\\": 5,\\n \\"ValueCount\\": 3\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"Enable\\",\\n \\"ResourceId\\": \\"quota89**76\\",\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 8,\\n \\"Concurrency\\": 1\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-m5ec******44cn\\",\\n \\"VSwitchId\\": \\"vsw-hp32******z9qo\\",\\n \\"SecurityGroupId\\": \\"sg-bp1f******iy9h\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"v1\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetKnowledgeBaseJob' => [ - 'summary' => '查看知识库任务', + 'summary' => 'Retrieve a knowledge base job.', 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478***', - ], + 'schema' => ['description' => 'Knowledge Base Workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '478***', 'title' => ''], ], [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''], ], [ 'name' => 'KnowledgeBaseJobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', - ], + 'schema' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''], ], ], 'responses' => [ @@ -3343,1043 +2820,2434 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26', - 'title' => '请求ID', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '478***', - ], - 'Accessibility' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-09-24T07:33:53Z', - ], - 'GmtModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-11T08:58:35.438Z', - ], - 'KnowledgeBaseId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd-nacr******sxd2', - ], - 'KnowledgeBaseJobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'kbjob-9m******54', - ], - 'JobAction' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'UpdateScheduleConfig', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'project name pass the check', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'discovering', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'], + 'WorkspaceId' => ['description' => 'Knowledge Base workspace ID.'."\n", 'type' => 'string', 'example' => '478***', 'title' => ''], + 'Accessibility' => ['description' => 'Workspace visibility, possible values are:'."\n" + ."\n" + .'* PRIVATE: In this workspace, it is only visible to you and the administrators.'."\n" + .'* PUBLIC: In this workspace, visible to everyone.'."\n", 'type' => 'string', 'example' => 'PUBLIC', 'title' => ''], + 'Creator' => ['description' => 'Creator User ID.'."\n", 'type' => 'string', 'example' => '2003******4844', 'title' => ''], + 'GmtCreateTime' => ['description' => 'Task creation time (UTC).'."\n", 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'Task Update Time (UTC).'."\n", 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''], + 'KnowledgeBaseId' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'example' => 'd-nacr******sxd2', 'title' => ''], + 'KnowledgeBaseJobId' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'example' => 'kbjob-9m******54', 'title' => ''], + 'JobAction' => ['description' => 'Task Operation Type.'."\n" + ."\n" + .'* SyncIndex: Update Knowledge Base Index'."\n", 'type' => 'string', 'example' => 'UpdateScheduleConfig', 'title' => ''], + 'Description' => ['description' => 'Knowledge Base Task Description.'."\n", 'type' => 'string', 'example' => 'This is a description of the knowledge base job.', 'title' => ''], + 'Status' => ['description' => 'Knowledge Base Task Status'."\n" + ."\n" + .'* Running: The instance is in operation.'."\n" + .'* Success: Run successfully.'."\n" + .'* Failed: Run failed.'."\n", 'type' => 'string', 'example' => 'discovering', 'title' => ''], + 'ResourceId' => ['description' => 'The resource group ID. Empty or public-cluster indicates public resource.'."\n", 'type' => 'string', 'example' => 'quota89**76', 'title' => ''], 'EcsSpecs' => [ - 'description' => '', + 'description' => 'Run Resource Configuration List'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Run Resource Configuration List'."\n", 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'example' => 'Worker', - 'readOnly' => true, - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - 'example' => 'ecs.c6.large', - 'readOnly' => true, - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本', - 'type' => 'string', - 'example' => '535.161.08', - 'readOnly' => true, - ], + 'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'example' => 'Worker', 'readOnly' => true, 'default' => 'Worker'], + 'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true], + 'PodCount' => ['title' => '', 'description' => 'Number of copies.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'CPU' => ['title' => '', 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => '', 'description' => 'The number of GPU cards.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'Memory' => ['title' => '', 'description' => 'Memory size, in GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'SharedMemory' => ['title' => '', 'description' => 'Shared memory capacity, in units of GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => '', 'description' => 'GPU Class.'."\n", 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'Driver' => ['title' => '', 'description' => 'Driver Version.'."\n", 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'UserVpc' => [ - 'description' => '', + 'description' => 'Task Run VPC Info.'."\n", 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', - 'type' => 'string', - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['title' => '', 'description' => 'Switch ID.'."\n", 'type' => 'string', 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['title' => '', 'description' => 'Security Group ID.'."\n", 'type' => 'string', 'example' => 'sg-wz91****e10e'], ], + 'title' => '', + 'example' => '', ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'GmtFinishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-02-08T15:45:12Z', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - ], + 'MaxRunningTimeInSeconds' => ['description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '86400', 'title' => ''], + 'GmtFinishTime' => ['description' => 'Task end time (UTC).'."\n", 'type' => 'string', 'example' => '2025-02-08T15:45:12Z', 'title' => ''], + 'ErrorMessage' => ['description' => 'Task error info.'."\n", 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', 'title' => ''], 'PipelineRunInfo' => [ + 'description' => 'Workflow Run Info.'."\n", 'type' => 'object', 'properties' => [ - 'PipelineRunId' => [ - 'title' => 'PaiFlow工作流运行ID', - 'description' => 'PaiFlow工作流运行ID', - 'type' => 'string', - 'example' => 'flow-fi8z******g4gy', - 'readOnly' => true, - ], + 'PipelineRunId' => ['title' => '', 'description' => 'PaiFlow Workflow Run ID'."\n", 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true], ], + 'title' => '', + 'example' => '', ], 'KnowledgeBaseJobResult' => [ + 'description' => 'Task Result.'."\n", 'type' => 'object', 'properties' => [ - 'TotalFileCount' => [ - 'title' => '总处理文件数', - 'description' => '总处理文件数', - 'type' => 'integer', - 'format' => 'int32', - ], - 'AddChunkCount' => [ - 'title' => '增加Chunk数量', - 'description' => '增加Chunk数量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'DeleteChunkCount' => [ - 'title' => '删除Chunk数量', - 'description' => '删除Chunk数量', - 'type' => 'integer', - 'format' => 'int32', - ], + 'TotalFileCount' => ['title' => '', 'description' => 'Total Number of Processed Files'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AddChunkCount' => ['title' => '', 'description' => 'Increase the number of Chunks'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DeleteChunkCount' => ['title' => '', 'description' => 'Delete Chunk Quantity'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], + 'title' => '', + 'example' => '', ], 'EmbeddingConfig' => [ - 'description' => '', + 'description' => 'Index Configuration.'."\n", 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => 'Embedding分批大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'readOnly' => true, - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => 'Embedding并发数', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '2', - 'readOnly' => true, - ], + 'BatchSize' => ['title' => '', 'description' => 'Index batch size. Documentation and structured data types knowledge base is effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'readOnly' => true], + 'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and Video Type Knowledge Base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '2', 'readOnly' => true], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"Creator\\": \\"2003******4844\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"KnowledgeBaseId\\": \\"d-nacr******sxd2\\",\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9m******54\\",\\n \\"JobAction\\": \\"UpdateScheduleConfig\\",\\n \\"Description\\": \\"This is a description of the knowledge base job.\\",\\n \\"Status\\": \\"discovering\\",\\n \\"ResourceId\\": \\"quota89**76\\",\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"GPUType\\": \\"V100\\",\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz91****e10e\\"\\n },\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"GmtFinishTime\\": \\"2025-02-08T15:45:12Z\\",\\n \\"ErrorMessage\\": \\"Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z\\",\\n \\"PipelineRunInfo\\": {\\n \\"PipelineRunId\\": \\"flow-fi8z******g4gy\\"\\n },\\n \\"KnowledgeBaseJobResult\\": {\\n \\"TotalFileCount\\": 1,\\n \\"AddChunkCount\\": 10,\\n \\"DeleteChunkCount\\": 2\\n },\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 10,\\n \\"Concurrency\\": 2\\n }\\n}","type":"json"}]', - ], - 'UpdateKnowledgeBaseJob' => [ - 'summary' => 'Update Knowledge Base Task.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'put', + 'title' => 'Retrieve Knowledge Base Job', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'GetRuntime' => [ + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace. To get this ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], ], [ - 'name' => 'KnowledgeBaseJobId', + 'name' => 'RuntimeId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', - ], + 'schema' => ['description' => 'The ID of the runtime to retrieve.', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '285***', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => '478***', 'title' => ''], + 'RuntimeId' => ['description' => 'The runtime ID.', 'type' => 'string', 'example' => 'rtime-apje******beaz', 'title' => ''], + 'RuntimeName' => ['description' => 'The runtime name.', 'type' => 'string', 'example' => 'dev01', 'title' => ''], + 'RuntimeType' => ['description' => 'The runtime type.', 'type' => 'string', 'example' => 'DSW', 'title' => ''], + 'RuntimeStatus' => ['description' => 'The status of the runtime. Valid values:'."\n" + ."\n" + .'- `Creating`: The runtime is being created.'."\n" + ."\n" + .'- `SaveFailed`: The image failed to save.'."\n" + ."\n" + .'- `Stopped`: The runtime is stopped.'."\n" + ."\n" + .'- `Failed`: The runtime failed.'."\n" + ."\n" + .'- `ResourceAllocating`: Resources are being allocated.'."\n" + ."\n" + .'- `Stopping`: The runtime is stopping.'."\n" + ."\n" + .'- `Updating`: The runtime is updating.'."\n" + ."\n" + .'- `Saving`: The image is being saved.'."\n" + ."\n" + .'- `Queuing`: The task is queued.'."\n" + ."\n" + .'- `Recovering`: The instance is recovering.'."\n" + ."\n" + .'- `Starting`: The runtime is starting.'."\n" + ."\n" + .'- `Running`: The runtime is running.'."\n" + ."\n" + .'- `Saved`: The image is saved.'."\n" + ."\n" + .'- `Deleting`: The runtime is being deleted.'."\n" + ."\n" + .'- `EnvPreparing`: The environment is being prepared.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modified time.', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z', 'title' => ''], + 'Creator' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], + 'Accessibility' => ['description' => 'The workspace visibility.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'EcsSpec' => [ + 'description' => 'The ECS resource configuration.', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'ecs.c6.large'], + 'GPUType' => ['description' => 'The GPU type.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'V100'], + 'CPU' => ['description' => 'The number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '4'], + 'GPU' => ['description' => 'The number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '0'], + 'Memory' => ['description' => 'The memory size, in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '8'], + 'SharedMemory' => ['description' => 'The shared memory size, in GB.', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true, 'title' => '', 'example' => '8'], + 'Driver' => ['description' => 'The GPU driver version.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => '535.161.08'], + ], + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base job.', + 'ResourceId' => ['description' => 'The resource quota ID.', 'type' => 'string', 'example' => 'quota18******zv9', 'title' => ''], + 'UserVpc' => [ + 'description' => 'The user VPC configuration.', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'VPC ID', 'description' => 'The VPC ID.', 'type' => 'string', 'readOnly' => true, 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'sg-wz9i****1129'], + 'DefaultRoute' => ['description' => 'The default route.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'eth0'], + 'ExtendedCIDRs' => [ + 'title' => '', + 'description' => 'The extended CIDR blocks.', + 'type' => 'array', + 'items' => ['description' => 'An extended CIDR block.', 'type' => 'string', 'readOnly' => true, 'example' => '172.16.1.0/24', 'title' => ''], + 'readOnly' => true, + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Envs' => [ + 'description' => 'The environment variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The environment variable key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testKey1'], + 'Value' => ['description' => 'The environment variable value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testValue1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'The labels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The label key.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testKey1'], + 'Value' => ['description' => 'The label value.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'testValue1'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DataSources' => [ + 'description' => 'The mounted data sources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['description' => 'The dataset ID. Specify either this parameter or `Uri`.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'd-umns******zij4szhc'], + 'Uri' => ['description' => 'The OSS path to the data source. Specify either this parameter or `DatasetId`.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/'], + 'MountPath' => ['description' => 'The mount path.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => '/mnt/data'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RunTimeout' => ['description' => 'The timeout period, in seconds, for a single test run.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'title' => ''], + 'CredentialConfig' => [ + 'description' => 'The credential configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableCredentialInject' => ['description' => 'Indicates whether credential injection is enabled.', 'type' => 'boolean', 'readOnly' => true, 'title' => '', 'example' => 'true'], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'The environment variable role key.', 'type' => 'string', 'readOnly' => true, 'example' => '0'], + 'CredentialConfigItems' => [ + 'title' => '', + 'description' => 'The credential configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => 'The key that identifies the configuration.', 'type' => 'string', 'readOnly' => true, 'example' => '0'], + 'Type' => ['title' => 'Type', 'description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- `Role`: Assumes a single role.'."\n" + ."\n" + .'- `RoleChain`: Assumes a chain of roles.', 'type' => 'string', 'readOnly' => true, 'example' => 'Role'], + 'Roles' => [ + 'title' => '', + 'description' => 'The roles in the configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'The principal that assumes the role.', 'type' => 'string', 'readOnly' => true, 'example' => '1095******785714'], + 'RoleType' => ['description' => 'The type of role to assume. Valid values:'."\n" + ."\n" + .'- `service`: The role is assumed by a service.'."\n" + ."\n" + .'- `user`: The role is assumed by a RAM user.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'service'], + 'RoleArn' => ['description' => 'The role ARN.', 'type' => 'string', 'readOnly' => true, 'title' => '', 'example' => 'acs:ram::1095******785714:role/testrole'], + ], + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'readOnly' => true, + 'example' => '', + ], + ], + 'readOnly' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'readOnly' => true, + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'WorkDir' => ['description' => 'The OSS path to the working directory.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'Version' => ['description' => 'The runtime image version.', 'type' => 'string', 'example' => '2.0.0', 'title' => ''], + 'RuntimeLog' => ['description' => 'The runtime log.', 'type' => 'string', 'example' => 'oss://path/to/log/file', 'title' => ''], + 'AutoUpdateImage' => ['description' => 'Indicates whether to automatically update the image.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'GetRuntime', + 'summary' => 'Get runtime details.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RuntimeName\\": \\"dev01\\",\\n \\"RuntimeType\\": \\"DSW\\",\\n \\"RuntimeStatus\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:24:36Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EcsSpec\\": {\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 0,\\n \\"Memory\\": 8,\\n \\"SharedMemory\\": 8,\\n \\"Driver\\": \\"535.161.08\\"\\n },\\n \\"ResourceId\\": \\"quota18******zv9\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz9i****1129\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"ExtendedCIDRs\\": [\\n \\"172.16.1.0/24\\"\\n ]\\n },\\n \\"Envs\\": [\\n {\\n \\"Key\\": \\"testKey1\\",\\n \\"Value\\": \\"testValue1\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testKey1\\",\\n \\"Value\\": \\"testValue1\\"\\n }\\n ],\\n \\"DataSources\\": [\\n {\\n \\"DatasetId\\": \\"d-umns******zij4szhc\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\",\\n \\"MountPath\\": \\"/mnt/data\\"\\n }\\n ],\\n \\"RunTimeout\\": 180,\\n \\"CredentialConfig\\": {\\n \\"EnableCredentialInject\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"CredentialConfigItems\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"AssumeRoleFor\\": \\"1095******785714\\",\\n \\"RoleType\\": \\"service\\",\\n \\"RoleArn\\": \\"acs:ram::1095******785714:role/testrole\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"Version\\": \\"2.0.0\\",\\n \\"RuntimeLog\\": \\"oss://path/to/log/file\\",\\n \\"AutoUpdateImage\\": false\\n}","type":"json"}]', + ], + 'GetSnapshot' => [ + 'path' => '/api/v1/langstudio/snapshots/{SnapshotId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID. To obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35686626-8D83-5ADE-B400-08A6613A6057', - 'title' => '请求ID', - ], + 'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => 'The workspace ID. To obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'example' => '478**', 'title' => ''], + 'Accessibility' => ['description' => 'The visibility of the snapshot. Valid values:'."\n" + ."\n" + .'- PRIVATE: The snapshot is visible only to you and administrators.'."\n" + ."\n" + .'- PUBLIC: The snapshot is visible to all users.', 'type' => 'string', 'example' => 'PRIVATE', 'title' => ''], + 'Creator' => ['description' => 'The ID of the user who created the snapshot.', 'type' => 'string', 'example' => '2680******4103', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time the snapshot was created.', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the snapshot was last modified.', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z', 'title' => ''], + 'SnapshotId' => ['description' => 'The ID of the snapshot.', 'type' => 'string', 'example' => 'snap-asfg******123', 'title' => ''], + 'SnapshotName' => ['description' => 'The name of the snapshot.', 'type' => 'string', 'example' => 'snapshot01', 'title' => ''], + 'Description' => ['description' => 'A description of the snapshot.', 'type' => 'string', 'example' => 'This is description', 'title' => ''], + 'SnapshotResourceType' => ['description' => 'The resource type of the snapshot. Valid value:'."\n" + ."\n" + .'- Flow: A workflow.', 'type' => 'string', 'example' => 'Flow', 'title' => ''], + 'SnapshotResourceId' => ['description' => 'The ID of the snapshot resource.', 'type' => 'string', 'example' => 'flow-asfg******1234', 'title' => ''], + 'CreationType' => ['description' => 'The creation type of the snapshot. Valid values:'."\n" + ."\n" + .'- ManualCreated: The snapshot was created manually.'."\n" + ."\n" + .'- DeploymentAutoCreated: The snapshot was created automatically by a deployment service.'."\n" + ."\n" + .'- EvaluationAutoCreated: The snapshot was created automatically by an evaluation task.', 'type' => 'string', 'example' => 'ManualCreated', 'title' => ''], + 'SnapshotStoragePath' => ['description' => 'The OSS path to the snapshot\'s source file.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src', 'title' => ''], + 'WorkDir' => ['description' => 'The OSS working directory for the snapshot.', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + 'SnapshotUrl' => ['description' => 'The download URL for the snapshot.', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile', 'title' => ''], + 'SnapshotStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]', - 'title' => 'UpdateKnowledgeBaseJob', - ], - 'DeleteKnowledgeBaseJob' => [ - 'summary' => 'Delete Knowledge Base Task.', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'title' => 'Get Snapshot Details', + 'summary' => 'Retrieves the details of a snapshot.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\",\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"SnapshotId\\": \\"snap-asfg******123\\",\\n \\"SnapshotName\\": \\"snapshot01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"SnapshotResourceType\\": \\"Flow\\",\\n \\"SnapshotResourceId\\": \\"flow-asfg******1234\\",\\n \\"CreationType\\": \\"ManualCreated\\",\\n \\"SnapshotStoragePath\\": \\"oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"SnapshotUrl\\": \\"https://path/to/snapshot/zipfile\\",\\n \\"SnapshotStatus\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n}","type":"json"}]', + ], + 'ListDeployments' => [ + 'summary' => 'Retrieve a list of deployment jobs.', + 'path' => '/api/v1/langstudio/deployments', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'Pagination cursor used to retrieve the next page of results. '."\n" + ."\n" + .'* Leave empty for the first request. '."\n" + .'* For subsequent requests, pass the NextToken value returned in the previous response. ', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'Field used for sorting in paged queries. The default field is GmtCreateTime. Valid values are as follows: '."\n" + ."\n" + .'* GmtCreateTime (default): sort by creation time. '."\n" + .'* GmtModifiedTime: sort by updated time. ', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'Sorting order. '."\n" + ."\n" + .'- ASC: ascending. '."\n" + .'- DESC: descending. ', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'query', + 'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type to be deployed. Valid values: '."\n" + .'* Flow: A project of the pipeline pattern '."\n" + .'* Code: A project of the Code pattern ', 'type' => 'string', 'required' => false, 'example' => 'Flow', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['description' => 'The resource ID to be deployed. ', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the current page in a paged query. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of items displayed per page. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The creator ID. ', 'type' => 'string', 'required' => false, 'example' => '2680******4103', 'title' => ''], + ], + [ + 'name' => 'ResourceSnapshotId', + 'in' => 'query', + 'schema' => ['description' => 'The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys directly based on this snapshot. If it is not provided, the system first creates a new snapshot for the resource and then executes the deployment. ', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The service name. Fuzzy search by service name is supported. ', 'type' => 'string', 'required' => false, 'example' => 'myservice01', 'title' => ''], + ], + [ + 'name' => 'DeploymentStatus', + 'in' => 'query', + 'schema' => ['description' => 'The deployment job status. To query multiple statuses simultaneously, separate them with commas. ', 'type' => 'string', 'required' => false, 'example' => 'Creating,Running', 'title' => ''], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => ['description' => 'The operation type. Valid values: '."\n" + .'* Create: Create a service. '."\n" + .'* Update: Update an existing service. ', 'type' => 'string', 'required' => false, 'example' => 'Create', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '478***', + 'description' => 'Return Result. ', + 'type' => 'object', + 'properties' => [ + 'Deployments' => [ + 'description' => 'List of deployment jobs. ', + 'type' => 'array', + 'items' => ['description' => 'Details of a deployment job. ', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxResults' => ['title' => 'Maximum Number of Results Returned per Request ', 'description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => 'Next Request Token ', 'description' => 'Pagination cursor for the next request. ', 'type' => 'string', 'example' => '10'], + 'TotalCount' => ['title' => 'Total Count ', 'description' => 'Total quantity. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Deployments\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"DeploymentStatus\\": \\"Running\\",\\n \\"OperationType\\": \\"Create\\",\\n \\"ResourceType\\": \\"Flow\\",\\n \\"ResourceId\\": \\"flow-asdf******123\\",\\n \\"ResourceSnapshotId\\": \\"snap-asfg******123\\",\\n \\"ServiceName\\": \\"myservice01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"EnableTrace\\": true,\\n \\"ChatHistoryConfig\\": {\\n \\"StorageType\\": \\"RDS\\",\\n \\"ConnectionName\\": \\"myconnection\\"\\n },\\n \\"ContentModerationConfig\\": {\\n \\"EnableInputModeration\\": true,\\n \\"EnableOutputModeration\\": true,\\n \\"StreamingModerationThreshold\\": 5\\n },\\n \\"DeploymentConfig\\": \\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"langstudio_2026******3848_jro7\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instance\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"workspace_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"285***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enable_webservice\\\\\\\\\\\\\\":false},\\\\\\\\\\\\\\"cloud\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"computing\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"instances\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ecs.g7.xlarge\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"networking\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"vpc_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vpc-bp1obprt******4bzo00d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vswitch_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vsw-bp1p6i36k******pmfhw8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"security_group_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sg-bp1djud4******zecl5a\\\\\\\\\\\\\\"}}}\\",\\n \\"DeploymentStages\\": [\\n {\\n \\"Stage\\": 1,\\n \\"StageName\\": \\"PrepareSnapshot\\",\\n \\"Description\\": \\"Create snapshot for deployment\\",\\n \\"GmtStartTime\\": \\"2025-09-23T10:25:38Z\\",\\n \\"GmtEndTime\\": \\"2025-09-19T10:34:01Z\\",\\n \\"StageStatus\\": \\"Running\\",\\n \\"ErrorMessage\\": \\"This is error\\",\\n \\"StageInfo\\": \\"{\\\\\\\\\\\\\\"SnapshotId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"snap-i8j29k******b0hotn\\\\\\\\\\\\\\"}\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"This is error message\\",\\n \\"AutoApproval\\": true\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"10\\",\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => 'Retrieve a List of Deployment Jobs ', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListKnowledgeBaseChunks' => [ + 'summary' => 'Retrieve the knowledge base segment list.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'KnowledgeBaseJobId', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'KnowledgeBaseId', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Knowledge base ID. ', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'], + ], + [ + 'name' => 'VersionName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Knowledge base version. The default is v1. ', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'MetaData', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', + 'title' => '', + 'description' => 'Original file information. If empty, the entire knowledge base version is traversed. ', + 'type' => 'object', + 'properties' => [ + 'FileUri' => ['title' => '', 'description' => 'File URI. If FileMetaId is also provided, this parameter value is ignored. ', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucketpath/file1.txt', 'readOnly' => true], + 'FileMetaId' => ['title' => '', 'description' => 'File metadata ID. ', 'type' => 'string', 'required' => false, 'example' => 'xd8e****79du', 'readOnly' => true], + ], + 'required' => false, + 'example' => '1', ], ], + [ + 'name' => 'ChunkStatus', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Segment status. '."\n" + .'- Enable: Valid. '."\n" + .'- Disable: Invalid. ', 'type' => 'string', 'required' => false, 'example' => 'Enable'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Number of items per page. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6', - 'title' => '请求ID', + 'KnowledgeBaseChunks' => [ + 'title' => '', + 'description' => 'Segment list.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Segment details.', + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseChunkId' => ['title' => '', 'description' => 'Segment ID.', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-426655440000'], + 'KnowledgeBaseId' => ['title' => '', 'description' => 'Knowledge base ID.', 'type' => 'string', 'example' => 'd-ix****o9'], + 'VersionName' => ['title' => '', 'description' => 'Knowledge base version. ', 'type' => 'string', 'example' => 'v1'], + 'ChunkStart' => ['title' => '', 'description' => 'Segment start position. Returns the number of milliseconds from the start of file playback.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ChunkEnd' => ['title' => '', 'description' => 'Segment end position. Returns the number of milliseconds from the start of file playback.', 'type' => 'integer', 'format' => 'int32', 'example' => '30000'], + 'ChunkSequence' => ['title' => '', 'description' => 'Ordinal number of the segment within the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ChunkContent' => ['title' => '', 'description' => 'Segment content.', 'type' => 'string', 'example' => 'content'], + 'ChunkSize' => ['title' => '', 'description' => 'Segment size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1873'], + 'ChunkStatus' => ['title' => '', 'description' => 'Segment status. '."\n" + .'- Enable: enabled. '."\n" + .'- Disable: disabled. ', 'type' => 'string', 'example' => 'Enable'], + 'DownloadUrl' => ['title' => '', 'description' => 'Download URL of the segment. Returned for image and video files. ', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...'], + 'ThumbnailUrl' => ['title' => '', 'description' => 'Thumbnail of the segment. Returned for image and video files.', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...'], + 'ChunkAttachment' => [ + 'title' => '', + 'description' => 'List of segment attachments.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Segment attachment.', + 'type' => 'object', + 'properties' => [ + 'PlaceholderId' => ['title' => '', 'description' => 'Placeholder ID.', 'type' => 'string', 'example' => 'IMAGE_PLACEHOLDER_0', 'readOnly' => true], + 'Type' => ['title' => '', 'description' => 'Attachment type.', 'type' => 'string', 'example' => 'image', 'readOnly' => true], + 'Uri' => ['title' => '', 'description' => 'Attachment path.', 'type' => 'string', 'example' => 'oss://mybucket/path/file.txt', 'readOnly' => true], + 'DownloadUrl' => ['title' => '', 'description' => 'Download URL.', 'type' => 'string', 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...', 'readOnly' => true], + ], + 'example' => '', + ], + 'example' => '', + ], + 'MetaData' => [ + 'title' => '', + 'description' => 'Original file information.', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['title' => '', 'description' => 'File name. ', 'type' => 'string', 'example' => 'file1.txt', 'readOnly' => true], + 'FileUri' => ['title' => '', 'description' => 'File path.', 'type' => 'string', 'example' => 'oss://mybucketpath/file1.txt', 'readOnly' => true], + 'FileMetaId' => ['title' => '', 'description' => 'File metadata ID. ', 'type' => 'string', 'example' => 'xd8e****79du', 'readOnly' => true], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', ], + 'MaxResults' => ['title' => '', 'description' => 'Maximum number of records allowed to be returned in this request. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['title' => '', 'description' => 'Total number of segments.', 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', - 'title' => 'DeleteKnowledgeBaseJob', + 'title' => 'ListKnowledgeBaseChunks', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseChunks\\": [\\n {\\n \\"KnowledgeBaseChunkId\\": \\"123e4567-e89b-12d3-a456-426655440000\\",\\n \\"KnowledgeBaseId\\": \\"d-ix****o9\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 30000,\\n \\"ChunkSequence\\": 1,\\n \\"ChunkContent\\": \\"content\\",\\n \\"ChunkSize\\": 1873,\\n \\"ChunkStatus\\": \\"Enable\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ThumbnailUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"IMAGE_PLACEHOLDER_0\\",\\n \\"Type\\": \\"image\\",\\n \\"Uri\\": \\"oss://mybucket/path/file.txt\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"file1.txt\\",\\n \\"FileUri\\": \\"oss://mybucketpath/file1.txt\\",\\n \\"FileMetaId\\": \\"xd8e****79du\\"\\n }\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', ], 'ListKnowledgeBaseJobs' => [ 'summary' => 'Get the Knowledge Base task list.', 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], + 'schema' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], ], [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd-ksicx823d', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''], ], [ 'name' => 'KnowledgeBaseJobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kbjob-9m******54', - ], + 'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => false, 'example' => 'kbjob-9m******54', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '知识库任务状态。'."\n" + .'- Running: 运行中。'."\n" + .'- Success: 运行成功。'."\n" + .'- Failed: 运行失败。', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'JobAction', 'in' => 'query', + 'schema' => ['description' => '任务操作类型。'."\n" + .'- SyncIndex：更新知识库索引', 'type' => 'string', 'required' => false, 'example' => 'SyncIndex', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '使用 NextToken 方式查询时，每次最多返回的结果数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序字段。目前只支持GmtCreateTime。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseJobs' => [ + 'description' => '知识库任务列表。', + 'type' => 'array', + 'items' => ['description' => '知识库任务详情。', '$ref' => '#/components/schemas/KnowledgeBaseJob', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['title' => '下次请求令牌', 'description' => '返回下一次查询开始的位置。为空表示已经获取了全部数据。', 'type' => 'string', 'example' => '20'], + 'TotalCount' => ['title' => '总量', 'description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SyncIndex', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ListKnowledgeBaseJobs', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListKnowledgeBases' => [ + 'summary' => 'Queries a list of knowledge bases.', + 'path' => '/api/v1/langstudio/knowledgebases', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478***', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the knowledge base.'."\n", 'type' => 'string', 'required' => false, 'example' => 'myName', 'title' => ''], + ], + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'query', + 'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'd-nacr******sxd2', 'title' => ''], + ], [ 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'Used to mark the current starting position for reading; leaving it empty means starting from the beginning.'."\n", 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'When querying using NextToken, the maximum number of results returned each time.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'Sorting field. Currently, only GmtCreateTime is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which you want to sort the queried instances.'."\n" + ."\n" + .'* ASC: ascending order.'."\n" + .'* DESC: descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. Value range: greater than 0. Default value: 1. If MaxResults is passed in at the same time, the NextToken query method will be used, and this field value will be ignored.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of queries per page. If MaxResults is passed in at the same time, the quantity will be based on MaxResults.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'Creator user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '2680******4103', 'title' => ''], + ], + [ + 'name' => 'KnowledgeBaseType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the knowledge base.'."\n" + ."\n" + .'* TEXT: Document.'."\n" + .'* STRUCTURED: Structured data.'."\n" + .'* IMAGE: Image.'."\n" + .'* VIDEO: Video.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TEXT', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBases' => [ + 'description' => 'Knowledge base list.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Knowledge base details.'."\n", '$ref' => '#/components/schemas/KnowledgeBase', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxResults' => ['title' => '', 'description' => 'The maximum number of records allowed to be returned by this request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['title' => '', 'description' => 'Returns the position from which the next query starts. Empty indicates that all data has been retrieved.'."\n", 'type' => 'string', 'example' => '20'], + 'TotalCount' => ['title' => '', 'description' => 'Total number of records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '51'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBases\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"GmtCreateTime\\": \\"2024-12-15T14:46:23Z\\",\\n \\"GmtModifiedTime\\": \\"2025-12-18T19:32:58Z\\",\\n \\"Name\\": \\"myName\\",\\n \\"KnowledgeBaseId\\": \\"d-nacr******sxd2\\",\\n \\"Description\\": \\"This is a description of the knowledge base.\\",\\n \\"KnowledgeBaseType\\": \\"TEXT\\",\\n \\"DatasetId\\": \\"d-lvb6****865w\\",\\n \\"DataSources\\": [\\n {\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\"\\n }\\n ],\\n \\"OutputDir\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/\\",\\n \\"ChunkConfig\\": {\\n \\"ChunkSize\\": 1024,\\n \\"ChunkOverlap\\": 200,\\n \\"ChunkDuration\\": 20,\\n \\"ChunkStrategy\\": \\"Default\\"\\n },\\n \\"EmbeddingConfig\\": {\\n \\"ConnectionName\\": \\"myEmbeddingConn\\",\\n \\"ConnectionId\\": \\"conn-r3o7******38bh\\",\\n \\"Model\\": \\"text-embedding-v4\\"\\n },\\n \\"VectorDBConfig\\": {\\n \\"VectorDBType\\": \\"Milvus\\",\\n \\"ConnectionName\\": \\"myConnName\\",\\n \\"ConnectionId\\": \\"conn-v2wq****z7rg\\",\\n \\"CollectionName\\": \\"my_collection\\"\\n },\\n \\"Creator\\": \\"1247****1467\\",\\n \\"RuntimeId\\": \\"rtime-78****d6\\",\\n \\"MetaDataConfig\\": {\\n \\"CustomMetaData\\": [\\n {\\n \\"Key\\": \\"column1\\",\\n \\"ValueType\\": \\"String\\",\\n \\"ReferenceCount\\": 3,\\n \\"ValueCount\\": 8\\n }\\n ]\\n },\\n \\"AutoUpdateConfig\\": {\\n \\"Status\\": \\"Enable\\",\\n \\"ResourceId\\": \\"quota87**45\\",\\n \\"MaxRunningTimeInSeconds\\": 86400,\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 8,\\n \\"Concurrency\\": 1\\n },\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-m5ec******44cn\\",\\n \\"VSwitchId\\": \\"vsw-hp32******z9qo\\",\\n \\"SecurityGroupId\\": \\"sg-bp1f******iy9h\\"\\n },\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"Worker\\",\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"PodCount\\": 1,\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 1,\\n \\"Memory\\": 16,\\n \\"SharedMemory\\": 16,\\n \\"Driver\\": \\"550.127.08\\"\\n }\\n ]\\n },\\n \\"VersionName\\": \\"v1\\",\\n \\"IndexColumnConfig\\": {\\n \\"EmbeddingColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ContentColumns\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ],\\n \\"ColumnDefinitions\\": [\\n {\\n \\"Key\\": \\"column1\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"20\\",\\n \\"TotalCount\\": 51,\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]', + 'title' => 'ListKnowledgeBases', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListRuntimes' => [ + 'summary' => 'Retrieve the runtime list.', + 'path' => '/api/v1/langstudio/runtimes', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. The pagination token used in the next request to retrieve a new page of results.'."\n" + ."\n" + .'* This value is left empty during the first request.'."\n" + .'* The `NextToken` value returned by the previous response passed in subsequent requests.'."\n", 'type' => 'string', 'required' => false, 'example' => '""', 'title' => ''], + ], [ 'name' => 'MaxResults', 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records allowed to be returned by this request.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number in a paged query.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'RuntimeName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the runtime. Supports fuzzy search by name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dev01', 'title' => ''], + ], + [ + 'name' => 'RuntimeId', + 'in' => 'query', + 'schema' => ['description' => 'Runtime ID. Supports exact search by runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''], + ], + [ + 'name' => 'WorkDir', + 'in' => 'query', + 'schema' => ['description' => 'The OSS path of the working directory.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/', 'title' => ''], + ], + [ + 'name' => 'RuntimeStatus', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Runtime status. Valid values:'."\n" + ."\n" + .'* Creating: The data cache is being created.'."\n" + .'* SaveFailed: Failed to save the runtime image.'."\n" + .'* Stopped: The file system is stopped.'."\n" + .'* Failed: Failed'."\n" + .'* ResourceAllocating: Resource allocation in progress'."\n" + .'* Stopping: Stopping in progress'."\n" + .'* Updating: Updating in progress'."\n" + .'* Saving: Saving the runtime image in progress'."\n" + .'* Queuing: Queuing in progress'."\n" + .'* Recovering: The instance is recovering.'."\n" + .'* Starting: The instance is being created.'."\n" + .'* Running: The gateway is running.'."\n" + .'* Saved: The runtime image is saved.'."\n" + .'* Deleting: The mount target is being deleted.'."\n" + .'* EnvPreparing: Preparing environment.'."\n", + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'Running', + 'enumValueTitles' => [ + 'Creating' => '创建中', 'SaveFailed' => '镜像保存失败', 'Stopped' => '已停止', 'Failed' => '失败', 'ResourceAllocating' => '资源分配中', 'Stopping' => '停止中', 'Updating' => '更新中', 'Saving' => '镜像保存中', 'Queuing' => '排队中', 'Recovering' => '实例恢复中', + 'Starting' => '创建中', 'Running' => '运行中', 'Saved' => '镜像保存成功', 'Deleting' => '删除中', 'EnvPreparing' => '环境准备中', + ], + 'title' => '', ], ], [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The creator ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '2485765****023475', 'title' => ''], + ], + [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The field used to sort the results in paged queries. Default value: GmtCreateTime. Valid values are as follows:'."\n" + ."\n" + .'* GmtCreateTime (default value): Sort by the time when created.'."\n" + .'* GmtModifiedTime: Sorted by modification time.'."\n" + .'* Creator: The ID of the creator.'."\n" + .'* WorkDir: the working path.'."\n" + .'* RuntimeName: the runtime parameter.'."\n" + .'* Status: the status of the runtime.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', + 'enumValueTitles' => ['Status' => '运行时状态', 'RuntimeName' => '运行时名称', 'Creator' => '创建者 ID', 'WorkDir' => '工作路径', 'GmtCreateTime' => '按创建时间', 'GmtModifiedTime' => '按修改时间'], + 'title' => '', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sorting method.'."\n" + ."\n" + .'* ASC: ascending order.'."\n" + .'* DESC: Descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC', + 'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'], + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => 'Version'."\n", 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], + ], + [ + 'name' => 'Accessibility', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'enumValueTitles' => ['PUBLIC' => 'Visible within workspace ', 'PRIVATE' => 'Visible to creator '], + 'description' => 'Visibility. ', + 'title' => 'Visibility ', + 'type' => 'string', + 'example' => 'PRIVATE', 'required' => false, - 'example' => '1', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Runtimes' => [ + 'description' => 'The list of runtimes.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The details of the runtime.'."\n", '$ref' => '#/components/schemas/Runtime', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'MaxResults' => ['title' => '', 'description' => 'The maximum number of returned results for a request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => '', 'description' => 'The next request token.'."\n", 'type' => 'string', 'example' => '11'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of runtime.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Runtimes\\": [\\n {\\n \\"WorkspaceId\\": \\"478***\\",\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RuntimeName\\": \\"dev01\\",\\n \\"RuntimeType\\": \\"DSW\\",\\n \\"RuntimeStatus\\": \\"Running\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:24:36Z\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EcsSpec\\": {\\n \\"InstanceType\\": \\"ecs.c6.large\\",\\n \\"GPUType\\": \\"V100\\",\\n \\"CPU\\": 4,\\n \\"GPU\\": 0,\\n \\"Memory\\": 8,\\n \\"SharedMemory\\": 8,\\n \\"Driver\\": \\"535.161.08\\"\\n },\\n \\"ResourceId\\": \\"quota18******zv9\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-wz90****5v23\\",\\n \\"VSwitchId\\": \\"vsw-wz9r****ng10\\",\\n \\"SecurityGroupId\\": \\"sg-wz9i****1129\\",\\n \\"DefaultRoute\\": \\"eth0\\",\\n \\"ExtendedCIDRs\\": [\\n \\"172.16.1.0/24\\"\\n ]\\n },\\n \\"Envs\\": [\\n {\\n \\"Key\\": \\"testKey01\\",\\n \\"Value\\": \\"testValue01\\"\\n }\\n ],\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"testKey01\\",\\n \\"Value\\": \\"testValue01\\"\\n }\\n ],\\n \\"DataSources\\": [\\n {\\n \\"DatasetId\\": \\"d-umns******zij4szhc\\",\\n \\"Uri\\": \\"oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/\\",\\n \\"MountPath\\": \\"/mnt/data\\"\\n }\\n ],\\n \\"RunTimeout\\": 180,\\n \\"CredentialConfig\\": {\\n \\"EnableCredentialInject\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"CredentialConfigItems\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"AssumeRoleFor\\": \\"1095******785714\\",\\n \\"RoleType\\": \\"service\\",\\n \\"RoleArn\\": \\"acs:ram::1095******785714:role/testrole\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"Version\\": \\"2.0.0\\",\\n \\"RuntimeLog\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log\\",\\n \\"AutoUpdateImage\\": false\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"11\\",\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Runtime List', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListRuntimes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'ListSnapshots' => [ + 'summary' => 'Lists snapshots.', + 'path' => '/api/v1/langstudio/snapshots', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID. To find the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token used to retrieve the next page of results.'."\n" + ."\n" + .'- For the first request, leave this parameter empty.'."\n" + ."\n" + .'- For subsequent requests, set this parameter to the `NextToken` value from the previous response.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of items to return for this request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the results by. Defaults to `GmtCreateTime`. Valid values:'."\n" + ."\n" + .'- `GmtCreateTime` (default): Sorts by creation time.'."\n" + ."\n" + .'- `GmtModifiedTime`: Sorts by modification time.', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order.'."\n" + ."\n" + .'- `ASC`: Ascending order.'."\n" + ."\n" + .'- `DESC`: Descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of items to return per page. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SnapshotResourceType', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The type of the snapshot resource. Valid value:'."\n" + ."\n" + .'- `Flow`: A workflow.', + 'type' => 'string', + 'enum' => ['Flow'], 'required' => false, - 'example' => '10', + 'example' => 'Flow', + 'title' => '', ], ], + [ + 'name' => 'SnapshotResourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the snapshot resource.', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******1234', 'title' => ''], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The creator ID.', 'type' => 'string', 'required' => false, 'example' => '2003******4844', 'title' => ''], + ], + [ + 'name' => 'CreationType', + 'in' => 'query', + 'schema' => ['description' => 'The creation type of the snapshot. To specify multiple types, separate the values with a comma (,).', 'type' => 'string', 'required' => false, 'example' => 'ManualCreated,DeploymentAutoCreated', 'title' => ''], + ], + [ + 'name' => 'SnapshotStatus', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'PRIVATE', 'title' => '', 'description' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'KnowledgeBaseJobs' => [ - 'description' => '', + 'Snapshots' => [ + 'description' => 'The list of snapshots.', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/KnowledgeBaseJob', - ], - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '请求最大返回结果数', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'title' => '下次请求令牌', - 'example' => '11', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '总量', - 'example' => '25', + 'items' => ['description' => 'The snapshot details.', '$ref' => '#/components/schemas/Snapshot', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', + 'MaxResults' => ['title' => 'Maximum Number of Results Returned per Request', 'description' => 'The maximum number of items returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => 'Next Request Token', 'description' => 'The pagination token to retrieve the next page of results. This value is empty if there are no more results.', 'type' => 'string', 'example' => '11'], + 'TotalCount' => ['title' => 'Total Quantity', 'description' => 'The total number of snapshots.', 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Retrieve Snapshot List', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Snapshots\\": [\\n {\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2680******4103\\",\\n \\"GmtCreateTime\\": \\"2025-09-24T07:33:53Z\\",\\n \\"GmtModifiedTime\\": \\"2025-09-24T08:58:35Z\\",\\n \\"SnapshotId\\": \\"snap-qhn3******b369c0vo\\",\\n \\"SnapshotName\\": \\"name01\\",\\n \\"Description\\": \\"This is description\\",\\n \\"SnapshotResourceType\\": \\"Flow\\",\\n \\"SnapshotResourceId\\": \\"flow-6rymo******m7j0z4p\\",\\n \\"CreationType\\": \\"ManualCreated\\",\\n \\"SnapshotStoragePath\\": \\"oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src\\",\\n \\"WorkDir\\": \\"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/\\",\\n \\"SnapshotUrl\\": \\"https://path/to/snapshot/zipfile\\",\\n \\"SnapshotStatus\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"11\\",\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'RetrieveKnowledgeBase' => [ + 'summary' => 'Retrieves a knowledge base.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => 'The knowledge base ID.', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'The ID of the workspace where the knowledge base resides.', 'type' => 'string', 'required' => true, 'example' => '174***', 'title' => ''], + 'Query' => ['description' => 'The query content for retrieval.', 'type' => 'string', 'required' => true, 'example' => 'red car', 'title' => ''], + 'TopK' => ['description' => 'The number of top-ranked results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'ScoreThreshold' => ['description' => 'The similarity score threshold. This is a floating-point value. Valid values: 0 to 1.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', 'title' => ''], + 'MetaDataFilterConditions' => ['description' => 'Optional. The metadata filter conditions for retrieval. The value is a JSON string. The JSON fields are defined as follows:'."\n" + ."\n" + .'- FilterCondition: the logical relationship. Valid values: and, or.'."\n" + .'- MetaDataFilters: the filter conditions. Multiple conditions are processed based on the logical relationship specified by FilterCondition. Key specifies the metadata key. Value specifies the metadata value. Operator specifies the operator. Valid values: ==, !=, contains. The contains operator supports only the file_name field.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "FilterCondition": "and", '."\n" + .' "MetaDataFilters": ['."\n" + .' {'."\n" + .' "Key": "key1", '."\n" + .' "Value": "value1", '."\n" + .' "Operator": "=="'."\n" + .' },'."\n" + .' {'."\n" + .' "Key": "key2", '."\n" + .' "Value": "value2", '."\n" + .' "Operator": "!="'."\n" + .' },'."\n" + .' {'."\n" + .' "Key": "file_name", '."\n" + .' "Value": "prefix", '."\n" + .' "Operator": "contains"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'QueryMode' => [ + 'description' => 'The retrieval mode.'."\n" + ."\n" + .'- dense: semantic retrieval.'."\n" + .'- hybrid: hybrid retrieval.', + 'enumValueTitles' => ['hybrid' => 'hybrid', 'dense' => 'dense'], 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - 'title' => '请求ID', + 'required' => false, + 'example' => 'dense', + 'title' => '', ], + 'VersionName' => ['description' => 'The knowledge base version. Default value: v1.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], + 'RerankConfig' => ['description' => 'Optional. The rerank configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n" + ."\n" + .'- ConnectionId: the model service connection ID.'."\n" + ."\n" + .'- Model: the model name. If the connection type is Bailian, the supported model is gte-rerank-v2.'."\n" + ."\n" + .'- TopK: the number of top-ranked results to return.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "ConnectionId":"conn-xxx",'."\n" + .' "Model": "qwen-max",'."\n" + .' "TopK": 5'."\n" + .'}', 'title' => ''], + 'RewriteConfig' => ['description' => 'Optional. The rewrite configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n" + ."\n" + .'- ConnectionId: the model service connection ID.'."\n" + ."\n" + .'- Model: the model name. Models supported by Bailian connections include qwen3-max, qwen-plus, and qwen-flash.'."\n" + ."\n" + .'- Temprature: controls the randomness of the content generated by the large language model. A higher value produces more random results. Valid values: 0 to 2.0.'."\n" + ."\n" + .'- TopP: the probability threshold for nucleus sampling during generation. Valid values: 0 to 1.0.'."\n" + ."\n" + .'- PresensePenalty: the presence penalty. Valid values: -2.0 to 2.0.'."\n" + ."\n" + .'- FrequencyPenalty: the frequency penalty. Valid values: -2.0 to 2.0.'."\n" + ."\n" + .'- Seed: the random number seed. Valid values: 0 to 2147483647.'."\n" + ."\n" + .'- MaxTokens: controls the maximum length of the model-generated output.'."\n" + ."\n" + .'- Stop: the list of stop sequences. The model stops generating output when any sequence in the list is encountered. A maximum of 4 sequences are supported.'."\n" + ."\n" + .'- EnableThingking: specifies whether to enable reasoning.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "ConnectionId":"conn-xxx",'."\n" + .' "Model": "qwen-max",'."\n" + .' "Temperature": 0.7,'."\n" + .' "TopP": 0.9,'."\n" + .' "PresencePenalty": 0.5,'."\n" + .' "FrequencyPenalty": 0.5,'."\n" + .' "Seed": 0,'."\n" + .' "MaxTokens": 1024,'."\n" + .' "Stop": [],'."\n" + .' "EnableThinking": true'."\n" + .'}', 'title' => ''], + 'HybridStrategyConfig' => ['description' => 'Optional. The hybrid retrieval strategy configuration. The value is a JSON string. The JSON fields are defined as follows:'."\n" + ."\n" + .'- Strategy: the hybrid retrieval strategy. Valid values: rrf (reciprocal rank fusion) and weighted (weighted fusion).'."\n" + ."\n" + .'- RRFK: the smoothing parameter for reciprocal rank fusion. Valid values: 1 to 100.'."\n" + ."\n" + .'- Weight: the weight for the weighted strategy. This value indicates the contribution ratio of vector semantic retrieval to the final score. Valid values: 0 to 1.0.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "Strategy": "rrf",'."\n" + .' "RRFK":60,'."\n" + .' "Weight": 0.5'."\n" + .'}', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobs\\": [\\n {\\n \\"WorkspaceId\\": \\"\\",\\n \\"Accessibility\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"GmtCreateTime\\": \\"\\",\\n \\"GmtModifiedTime\\": \\"\\",\\n \\"KnowledgeBaseId\\": \\"\\",\\n \\"KnowledgeBaseJobId\\": \\"\\",\\n \\"JobAction\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"ResourceId\\": \\"\\",\\n \\"EcsSpecs\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"InstanceType\\": \\"\\",\\n \\"PodCount\\": 0,\\n \\"CPU\\": 0,\\n \\"GPU\\": 0,\\n \\"Memory\\": 0,\\n \\"SharedMemory\\": 0,\\n \\"GPUType\\": \\"\\",\\n \\"Driver\\": \\"\\"\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"\\",\\n \\"VSwitchId\\": \\"\\",\\n \\"SecurityGroupId\\": \\"\\"\\n },\\n \\"MaxRunningTimeInSeconds\\": 0,\\n \\"GmtFinishTime\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"PipelineRunInfo\\": {\\n \\"PipelineRunId\\": \\"\\"\\n },\\n \\"KnowledgeBaseJobResult\\": {\\n \\"TotalFileCount\\": 0,\\n \\"AddChunkCount\\": 0,\\n \\"DeleteChunkCount\\": 0,\\n \\"FileMetas\\": [\\n {\\n \\"FileMetaId\\": \\"\\",\\n \\"FileName\\": \\"\\",\\n \\"FileUri\\": \\"\\",\\n \\"Action\\": \\"\\"\\n }\\n ]\\n },\\n \\"EmbeddingConfig\\": {\\n \\"BatchSize\\": 0,\\n \\"Concurrency\\": 0\\n }\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"20\\",\\n \\"TotalCount\\": 32,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', - 'title' => 'ListKnowledgeBaseJobs', - ], - 'UpdateKnowledgeBaseChunk' => [ - 'summary' => '更新知识库切片', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks/{KnowledgeBaseChunkId}', - 'methods' => [ - 'put', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseFileChunks' => [ + 'description' => 'The list of knowledge base chunks.', + 'type' => 'array', + 'items' => ['description' => 'The details of a knowledge base chunk.', '$ref' => '#/components/schemas/KnowledgeBaseFileChunk', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseFileChunks\\": [\\n {\\n \\"Score\\": 0.9832,\\n \\"ChunkId\\": \\"7fjs******90fs\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 30000,\\n \\"ChunkSequence\\": 0,\\n \\"ChunkContent\\": \\"content of chunk\\",\\n \\"ChunkSize\\": 3452,\\n \\"ChunkStatus\\": \\"Enable\\",\\n \\"DownloadUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******\\",\\n \\"ThumbnailUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"IMAGE_PLACEHOLDER_0\\",\\n \\"Type\\": \\"image\\",\\n \\"Uri\\": \\"oss://mybucket/file1/img1.jpg\\",\\n \\"DownloadUrl\\": \\"https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"abc.txt\\",\\n \\"FileUri\\": \\"oss://mybucket/path/abc.txt\\",\\n \\"FileMetaId\\": \\"sd8c******67ux\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve knowledge base', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pailangstudio:RetrieveKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDeployment' => [ + 'summary' => 'Update a deployment job.', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'KnowledgeBaseId', + 'name' => 'DeploymentId', 'in' => 'path', + 'schema' => ['description' => 'Deployment job ID. ', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '知识库ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ab****89', + 'description' => 'Request body. ', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Deployment description. ', 'type' => 'string', 'required' => false, 'example' => 'This is a description of deployment', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~). ', 'type' => 'string', 'required' => false, 'example' => '174***', 'title' => ''], + 'DeploymentConfig' => ['description' => 'Service Configuration for deployment. For more information, see the [deployment configuration](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services) of PAI-EAS. ', 'type' => 'string', 'required' => false, 'example' => '{\\"metadata\\":{\\"name\\":\\"langstudio_2026******3848_jro7\\",\\"instance\\":1,\\"workspace_id\\":\\"285***\\",\\"enable_webservice\\":false},\\"cloud\\":{\\"computing\\":{\\"instances\\":[{\\"type\\":\\"ecs.g7.xlarge\\"}]},\\"networking\\":{\\"vpc_id\\":\\"vpc-bp1obprt******4bzo00d\\",\\"vswitch_id\\":\\"vsw-bp1p6i36k******pmfhw8\\",\\"security_group_id\\":\\"sg-bp1djud4******zecl5a\\"}}}', 'title' => ''], + 'StageAction' => ['description' => 'Deployment stage operation information. The JSON format is as follows: '."\n" + .'{"Stage":3,"Action":"Confirm"}. Valid values for Action are: '."\n" + .'* Confirm: confirm. '."\n" + .'* Cancel: cancel. ', 'type' => 'string', 'required' => false, 'example' => '{\\"Stage\\":3,\\"Action\\":\\"Confirm\\"}', 'title' => ''], + 'AutoApproval' => ['description' => 'Indicates whether to automatically skip the deployment confirmation step. ', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'KnowledgeBaseChunkId', - 'in' => 'path', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '切片ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'description' => 'Return Result. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Request ID ', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Update Deployment Job ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'UpdateKnowledgeBase' => [ + 'summary' => 'Update Knowledge Base.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '请求体', - 'description' => '', + 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ - 'ChunkStatus' => [ - 'title' => '切片状态', - 'description' => '', - 'type' => 'string', + 'WorkspaceId' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => '285773', 'title' => ''], + 'Description' => ['description' => 'Knowledge base description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.', 'title' => ''], + 'RuntimeId' => ['description' => 'Runtime ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rtime-231x****tmo4', 'title' => ''], + 'BindRuntime' => ['description' => 'Whether to bind at runtime.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MetaDataConfig' => [ + 'description' => 'Metadata Configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomMetaData' => [ + 'title' => '', + 'description' => 'Custom metadata.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'Metadata Field Name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'author'], + 'ValueType' => ['title' => '', 'description' => 'Metadata Field Type Currently, only the String class type is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'String'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'Enable', + 'title' => '', + 'example' => '', ], - 'ChunkContent' => [ - 'title' => '切片内容', - 'description' => '', - 'type' => 'string', + 'AutoUpdateConfig' => [ + 'description' => 'Knowledge Base Automatic Update Configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '', 'description' => 'Knowledge Base Automatic Update Switch Status'."\n" + ."\n" + .'* Enable: Turn on automatic updates.'."\n" + .'* Disable: Turn off automatic updates.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Enable', 'default' => 'Disable'], + 'ResourceId' => ['title' => '', 'description' => 'Resource Group ID. Empty or public-cluster indicates public resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'quota89**76'], + 'MaxRunningTimeInSeconds' => ['title' => '', 'description' => 'Maximum task running time, in seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'], + 'EmbeddingConfig' => [ + 'title' => '', + 'description' => 'Vector Index Configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'BatchSize' => ['title' => '', 'description' => 'Index batch size. Documentation and structured data type Knowledge Base are effective.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], + 'Concurrency' => ['title' => '', 'description' => 'Index concurrency. Image and Video Type Knowledge Base is valid.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'], + ], + 'required' => false, + 'example' => '', + ], + 'UserVpc' => ['title' => '', 'description' => 'User VPC Configuration.'."\n", 'required' => false, '$ref' => '#/components/schemas/UserVpc', 'example' => ''], + 'EcsSpecs' => [ + 'title' => '', + 'description' => 'Run Resource Configuration List Documentation and structured knowledge base contain only one element and the **Type** is Worker. images and videos knowledge base contain two elements and the **Types** are Head and Worker.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Run Resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Node type. Possible values are Head and Worker.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '', 'description' => 'Model name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '', 'description' => 'The number of replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'GPUType' => ['title' => '', 'description' => 'The GPU Class.'."\n", 'type' => 'string', 'required' => false, 'example' => 'V100'], + 'CPU' => ['title' => '', 'description' => 'The number of CPU cores.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'GPU' => ['title' => '', 'description' => 'The number of GPU cards.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Memory' => ['title' => '', 'description' => 'Memory size, in GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'SharedMemory' => ['title' => '', 'description' => 'Shared memory capacity, in units of GB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'Driver' => ['title' => '', 'description' => 'Driver Version.'."\n", 'type' => 'string', 'required' => false, 'example' => '550.127.08'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => 'content', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response body.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', - ], - 'ListKnowledgeBaseChunks' => [ - 'summary' => '获取知识库切片列表', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks', - 'methods' => [ - 'get', + 'title' => 'UpdateKnowledgeBase', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + ], + 'UpdateKnowledgeBaseChunk' => [ + 'summary' => 'Update Knowledge Base Chunk', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks/{KnowledgeBaseChunkId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'KnowledgeBaseId', 'in' => 'path', + 'schema' => ['title' => '知识库ID', 'description' => 'Knowledge Base ID.', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'], + ], + [ + 'name' => 'KnowledgeBaseChunkId', + 'in' => 'path', + 'schema' => ['title' => '切片ID', 'description' => 'Knowledge Base Chunk ID.', 'type' => 'string', 'required' => true, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '知识库ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ab****89', + 'title' => '请求体', + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'ChunkStatus' => ['title' => '切片状态', 'description' => 'Chunk status.'."\n" + ."\n" + .'- Enable: Enabled.'."\n" + .'- Disable: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'Enable'], + 'ChunkContent' => ['title' => '切片内容', 'description' => 'Chunk content.', 'type' => 'string', 'required' => false, 'example' => 'content'], + ], + 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'VersionName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '知识库版本', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Update Knowledge Base Chunk', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateKnowledgeBaseJob' => [ + 'summary' => 'Update Knowledge Base Task.', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MetaData', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => 'Knowledge Base ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2', 'title' => ''], + ], + [ + 'name' => 'KnowledgeBaseJobId', + 'in' => 'path', + 'schema' => ['description' => 'Knowledge Base Task ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '原始文件信息', - 'description' => '', + 'description' => 'Request body.'."\n", 'type' => 'object', 'properties' => [ - 'FileUri' => [ - 'title' => '文件地址', - 'description' => '文件地址', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://mybucketpath/file1.txt', - 'readOnly' => true, - ], - 'FileMetaId' => [ - 'title' => '文件元数据ID', - 'description' => '文件元数据ID', - 'type' => 'string', - 'required' => false, - 'example' => 'xd8e****79du', - 'readOnly' => true, - ], + 'WorkspaceId' => ['description' => 'Workspace ID where the knowledge course is located.'."\n", 'type' => 'string', 'required' => true, 'example' => '285***', 'title' => ''], + 'Description' => ['description' => 'Knowledge base task description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.', 'title' => ''], ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ChunkStatus', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '切片状态', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'UpdateKnowledgeBaseJob', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]', + ], + 'UpdateRuntime' => [ + 'summary' => 'Updates a runtime.', + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '当前页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => 'The workspace ID. To obtain the workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], + 'RunTimeout' => ['description' => 'The timeout, in seconds, for a single test run on the runtime.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180', 'title' => ''], + 'Version' => ['description' => 'The runtime image version.', 'type' => 'string', 'required' => false, 'example' => '2.0.0', 'title' => ''], + 'Action' => ['description' => 'The runtime action. Valid values:'."\n" + ."\n" + .'- Start: Starts the runtime.'."\n" + ."\n" + .'- Stop: Stops the runtime.', 'type' => 'string', 'required' => false, 'example' => 'Start', 'title' => ''], + 'AutoUpdateImage' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'RuntimeId', + 'in' => 'path', + 'schema' => ['description' => 'The runtime ID.', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '每页查询数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'UpdateRuntime', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'UpdateSnapshot' => [ + 'summary' => 'Update a snapshot.', + 'path' => '/api/v1/langstudio/snapshots/{SnapshotId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], + ], + 'parameters' => [ + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The snapshot description.', 'type' => 'string', 'required' => false, 'example' => 'This is description', 'title' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID. For information about how to obtain a workspace ID, see [ListWorkspaces](~~449124~~).', 'type' => 'string', 'required' => false, 'example' => '478**', 'title' => ''], + 'SnapshotName' => ['description' => 'The snapshot name. The format requirements are as follows:'."\n" + .'* It can contain only letters, digits, and underscores (_).'."\n" + .'* It must start with a letter.'."\n" + .'* It must be 1 to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'snapshot02', 'title' => ''], + ], 'required' => false, - 'example' => '20', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Return Result.', 'type' => 'object', 'properties' => [ - 'KnowledgeBaseChunks' => [ - 'title' => '切片列表', - 'description' => '切片列表', - 'type' => 'array', - 'items' => [ - 'title' => '切片', - 'description' => '切片', - 'type' => 'object', - 'properties' => [ - 'KnowledgeBaseChunkId' => [ - 'title' => '切片ID', - 'description' => '切片ID', - 'type' => 'string', - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - 'KnowledgeBaseId' => [ - 'title' => '知识库ID', - 'description' => '知识库ID', - 'type' => 'string', - 'example' => 'd-ix****o9', - ], - 'VersionName' => [ - 'title' => '知识库版本', - 'description' => '知识库版本', - 'type' => 'string', - 'example' => 'v1', - ], - 'ChunkStart' => [ - 'title' => '切片起始位置', - 'description' => '切片起始位置', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ChunkEnd' => [ - 'title' => '切片结束位置', - 'description' => '切片结束位置', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - ], - 'ChunkSequence' => [ - 'title' => '切片顺序', - 'description' => '切片顺序', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ChunkContent' => [ - 'title' => '切片内容', - 'description' => '切片内容', - 'type' => 'string', - 'example' => 'content', - ], - 'ChunkSize' => [ - 'title' => '切片大小', - 'description' => '切片大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1873', - ], - 'ChunkStatus' => [ - 'title' => '切片状态', - 'description' => '切片状态', - 'type' => 'string', - 'example' => 'Enable', - ], - 'DownloadUrl' => [ - 'title' => '切片下载地址', - 'description' => '切片下载地址', - 'type' => 'string', - 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...', - ], - 'ThumbnailUrl' => [ - 'title' => '切片缩略图', - 'description' => '切片缩略图', - 'type' => 'string', - 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...', - ], - 'ChunkAttachment' => [ - 'title' => '切片附属信息', - 'description' => '切片附属信息', - 'type' => 'array', - 'items' => [ - 'title' => '切片附件', - 'description' => '切片附件', - 'type' => 'object', - 'properties' => [ - 'PlaceholderId' => [ - 'title' => '占位符ID', - 'description' => '占位符ID', - 'type' => 'string', - 'example' => 'IMAGE_PLACEHOLDER_0', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => '类型', - 'description' => '类型', - 'type' => 'string', - 'example' => 'image', - 'readOnly' => true, - ], - 'Uri' => [ - 'title' => '路径', - 'description' => '路径', - 'type' => 'string', - 'example' => 'oss://mybucket/path/file.txt', - 'readOnly' => true, - ], - 'DownloadUrl' => [ - 'title' => '下载地址', - 'description' => '下载地址', - 'type' => 'string', - 'example' => 'https://mybucket.oss-cn-shanghai.aliyuncs.com/...', - 'readOnly' => true, - ], - ], - 'example' => '', - ], - 'example' => '', - ], - 'MetaData' => [ - 'title' => '原始文件信息', - 'description' => '原始文件信息', - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'title' => '文件名', - 'description' => '文件名', - 'type' => 'string', - 'example' => 'file1.txt', - 'readOnly' => true, - ], - 'FileUri' => [ - 'title' => '文件地址', - 'description' => '文件地址', - 'type' => 'string', - 'example' => 'oss://mybucketpath/file1.txt', - 'readOnly' => true, - ], - 'FileMetaId' => [ - 'title' => '文件元数据ID', - 'description' => '文件元数据ID', - 'type' => 'string', - 'example' => 'xd8e****79du', - 'readOnly' => true, - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'example' => '', - ], - 'MaxResults' => [ - 'title' => '请求最大返回结果数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '总量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], + 'RequestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseChunks\\": [\\n {\\n \\"KnowledgeBaseChunkId\\": \\"123e4567-e89b-12d3-a456-426655440000\\",\\n \\"KnowledgeBaseId\\": \\"d-ix****o9\\",\\n \\"VersionName\\": \\"v1\\",\\n \\"ChunkStart\\": 0,\\n \\"ChunkEnd\\": 30000,\\n \\"ChunkSequence\\": 1,\\n \\"ChunkContent\\": \\"content\\",\\n \\"ChunkSize\\": 1873,\\n \\"ChunkStatus\\": \\"Enable\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ThumbnailUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\",\\n \\"ChunkAttachment\\": [\\n {\\n \\"PlaceholderId\\": \\"IMAGE_PLACEHOLDER_0\\",\\n \\"Type\\": \\"image\\",\\n \\"Uri\\": \\"oss://mybucket/path/file.txt\\",\\n \\"DownloadUrl\\": \\"https://mybucket.oss-cn-shanghai.aliyuncs.com/...\\"\\n }\\n ],\\n \\"MetaData\\": {\\n \\"FileName\\": \\"file1.txt\\",\\n \\"FileUri\\": \\"oss://mybucketpath/file1.txt\\",\\n \\"FileMetaId\\": \\"xd8e****79du\\"\\n }\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => 'Update Snapshot', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-northeast-1.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-northeast-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-southeast-1.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-southeast-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.ap-southeast-5.aliyuncs.com', 'endpoint' => 'pailangstudio.ap-southeast-5.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-beijing.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-beijing.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pailangstudio.us-east-1.aliyuncs.com', 'endpoint' => 'pailangstudio.us-east-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'pailangstudio.eu-central-1.aliyuncs.com', 'endpoint' => 'pailangstudio.eu-central-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'pailangstudio.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'pailangstudio.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'pailangstudio.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'pailangstudio.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'pailangstudio.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'pailangstudio.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'pailangstudio.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'pailangstudio.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'pailangstudio.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateKnowledgeBase'], + ['description' => 'Response parameters changed', 'api' => 'CreateKnowledgeBaseJob'], + ['description' => 'Response parameters changed', 'api' => 'DeleteKnowledgeBase'], + ['description' => 'Response parameters changed', 'api' => 'DeleteKnowledgeBaseJob'], + ['description' => 'Response parameters changed', 'api' => 'GetKnowledgeBase'], + ['description' => 'Response parameters changed', 'api' => 'GetKnowledgeBaseJob'], + ['description' => 'Response parameters changed', 'api' => 'ListKnowledgeBaseJobs'], + ['description' => 'Response parameters changed', 'api' => 'ListKnowledgeBases'], + ['description' => 'Response parameters changed', 'api' => 'UpdateKnowledgeBase'], + ['description' => 'Response parameters changed', 'api' => 'UpdateKnowledgeBaseJob'], + ], + 'createdAt' => '2026-01-08T03:49:48.000Z', + 'description' => '', ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pailangstudio.us-east-1.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'PAILangStudio', + 'productName' => 'Platform for AI', + 'ramCodes' => ['pailangstudio'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetKnowledgeBaseJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListKnowledgeBases', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSnapshot', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetKnowledgeBase', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeployment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRuntime', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateKnowledgeBaseJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDeployments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSnapshot', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRuntimes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListRuntimes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateKnowledgeBase', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteKnowledgeBaseJob', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteKnowledgeBase', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListKnowledgeBaseJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDeployment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRuntime', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDeployment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateKnowledgeBaseJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRuntime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RetrieveKnowledgeBase', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pailangstudio:RetrieveKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSnapshots', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateKnowledgeBase', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRuntime', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDeployment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListKnowledgeBaseChunks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseChunks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |