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/zh_cn/pailangstudio/2024-07-10 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/pailangstudio/2024-07-10')
| -rw-r--r-- | data/zh_cn/pailangstudio/2024-07-10/api-docs.php | 8034 |
1 files changed, 3445 insertions, 4589 deletions
diff --git a/data/zh_cn/pailangstudio/2024-07-10/api-docs.php b/data/zh_cn/pailangstudio/2024-07-10/api-docs.php index f97b208..81e4787 100644 --- a/data/zh_cn/pailangstudio/2024-07-10/api-docs.php +++ b/data/zh_cn/pailangstudio/2024-07-10/api-docs.php @@ -1,194 +1,65 @@ <?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' => '运行时', + 'id' => 428917, + ], + [ + 'children' => ['UpdateDeployment', 'DeleteDeployment'], + 'type' => 'directory', + 'title' => '部署任务', + 'id' => 428923, + ], + [ + 'children' => ['GetSnapshot', 'UpdateSnapshot', 'ListSnapshots'], + 'type' => 'directory', + 'title' => '快照管理', + 'id' => 428929, + ], + [ + 'children' => ['RetrieveKnowledgeBase', 'CreateKnowledgeBaseJob', 'GetKnowledgeBaseJob', 'UpdateKnowledgeBaseJob', 'DeleteKnowledgeBaseJob', 'ListKnowledgeBaseJobs', 'UpdateKnowledgeBaseChunk', 'ListKnowledgeBaseChunks'], + 'type' => 'directory', + 'title' => '知识库', + 'id' => 428903, + ], + [ + 'children' => ['CreateDeployment', 'CreateKnowledgeBase', 'CreateSnapshot', 'DeleteKnowledgeBase', 'DeleteSnapshot', 'GetDeployment', 'GetKnowledgeBase', 'ListDeployments', 'ListKnowledgeBases', 'UpdateKnowledgeBase'], + 'title' => '其他', + 'type' => 'directory', + ], ], 'components' => [ 'schemas' => [ - 'AutoUpdateConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '知识库自动更新状态', - 'description' => '知识库自动更新状态', - 'type' => 'string', - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID', - 'type' => 'string', - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间', - 'type' => 'integer', - 'format' => 'int32', - ], - 'EmbeddingConfig' => [ - 'title' => 'Embedding配置', - 'description' => 'Embedding配置', - 'type' => 'object', - 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => 'Embedding分批大小', - 'type' => 'integer', - 'format' => 'int32', - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => 'Embedding并发数', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - ], - ], - ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置', - '$ref' => '#/components/schemas/UserVpc', - ], - 'EcsSpecs' => [ - 'title' => '运行资源配置', - 'description' => '运行资源配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - ], - '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', - ], - ], - ], - ], - ], - ], 'Connection' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'ConnectionId' => [ - 'type' => 'string', - ], - 'ConnectionType' => [ - 'type' => 'string', - ], - 'ConnectionName' => [ - 'type' => 'string', - ], - 'CustomType' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], + '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', - ], + 'additionalProperties' => ['type' => 'string'], ], 'Secrets' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', + 'additionalProperties' => ['type' => 'string'], ], + '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', - ], + 'InstanceName' => ['title' => '资源实例名称', 'description' => '资源实例名称', 'type' => 'string'], + 'InstanceId' => ['title' => '资源实例ID', 'description' => '资源实例ID', 'type' => 'string'], ], ], 'Models' => [ @@ -196,845 +67,194 @@ 'items' => [ 'type' => 'object', 'properties' => [ - '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', - ], + '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'], ], ], ], ], ], 'Deployment' => [ + 'description' => '部署任务详情。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'DeploymentId' => [ - 'type' => 'string', - ], - 'DeploymentStatus' => [ - 'type' => 'string', - ], - 'OperationType' => [ - 'type' => 'string', - ], - 'ResourceType' => [ - 'type' => 'string', - ], - 'ResourceId' => [ - 'type' => 'string', - ], - 'ResourceSnapshotId' => [ - 'type' => 'string', - ], - 'ServiceName' => [ - 'type' => 'string', - ], - 'ServiceGroup' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'WorkDir' => [ - 'type' => 'string', - ], - 'EcsSpec' => [ - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'ResourceBurstable' => [ - 'title' => '是否启用弹性资源池', - 'description' => '是否启用弹性资源池', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - '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, - ], - 'PodCount' => [ - 'title' => 'Pod数量', - 'description' => 'Pod数量', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUMemory' => [ - 'title' => 'GPU显存', - 'description' => 'GPU显存', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUCorePercentage' => [ - 'title' => 'GPU算力占比', - 'description' => 'GPU算力占比', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'ExtraEphemeralStorage' => [ - 'title' => '额外系统盘', - 'description' => '额外系统盘', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'QuotaId' => [ - 'title' => '资源配额ID', - 'description' => '资源配额ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'QuotaType' => [ - 'title' => '资源配额类型', - 'description' => '资源配额类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'ComputingInstanceConfig' => [ - 'title' => '竞价资源配置', - 'description' => '竞价资源配置', - 'type' => 'object', - 'properties' => [ - 'DisableSpotProtectionPeriod' => [ - 'title' => '是否启用竞价保留时长', - 'description' => '是否启用竞价保留时长', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'ComputingInstances' => [ - 'title' => '机器资源配置', - 'description' => '机器资源配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '机型', - 'description' => '机型', - 'type' => 'string', - 'readOnly' => true, - ], - 'SpotPriceLimit' => [ - 'title' => '竞价出价', - 'description' => '竞价出价', - 'type' => 'number', - 'format' => 'float', - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - ], - ], - 'UserVpc' => [ - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'readOnly' => true, - ], - ], - ], - 'Envs' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '环境键', - 'description' => '环境键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '环境值', - 'description' => '环境值', - 'type' => 'string', - 'readOnly' => true, - ], - ], - ], - ], - 'Labels' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'readOnly' => true, - ], - ], - ], - ], - 'DataSources' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DatasetId' => [ - 'title' => '数据集ID', - 'description' => '数据集ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '统一资源识别码', - 'type' => 'string', - 'readOnly' => true, - ], - 'MountPath' => [ - 'title' => '挂载路径', - 'description' => '挂载路径', - 'type' => 'string', - 'readOnly' => true, - ], - ], - ], - ], - 'CredentialConfig' => [ - 'type' => 'object', - 'properties' => [ - 'EnableCredentialInject' => [ - 'title' => '是否启用Credential注入', - 'description' => '是否启用Credential注入', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'AliyunEnvRoleKey' => [ - 'title' => 'AliyunEnvRoleKey', - 'description' => 'AliyunEnvRoleKey', - 'type' => 'string', - 'readOnly' => true, - ], - 'CredentialConfigItems' => [ - 'title' => 'Credential配置项列表', - 'description' => 'Credential配置项列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => 'Key', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => 'Type', - 'description' => 'Type', - 'type' => 'string', - 'readOnly' => true, - ], - 'Roles' => [ - 'title' => '角色列表', - 'description' => '角色列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AssumeRoleFor' => [ - 'title' => 'AssumeRoleFor', - 'description' => 'AssumeRoleFor', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleType' => [ - 'title' => '角色类型', - 'description' => '角色类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleArn' => [ - 'title' => '角色名称', - 'description' => '角色名称', - 'type' => 'string', - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - 'readOnly' => true, - ], - ], - 'readOnly' => true, - ], - 'readOnly' => true, - ], - ], - ], - 'EnableTrace' => [ - 'type' => 'boolean', - ], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'example' => '478***'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2680******4103'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z'], + 'DeploymentId' => ['description' => '部署任务ID。', 'type' => 'string', 'example' => 'dploy-asdf******1234'], + 'DeploymentStatus' => ['description' => '部署任务状态。取值：'."\n" + .'* Creating：创建中。'."\n" + .'* Failed：部署失败。'."\n" + .'* Stopping：停止中。'."\n" + .'* Waiting：等待中。'."\n" + .'* Starting：启动中。'."\n" + .'* Running：运行中。'."\n" + .'* Pending：等待中。'."\n" + .'* WaitForConfirm: 等待确认。'."\n" + .'* Canceled：取消。'."\n" + .'* Succeed：成功。', 'type' => 'string', 'example' => 'Running'], + 'OperationType' => ['description' => '操作类型。取值：'."\n" + .'* Create： 新建服务。'."\n" + .'* Update： 更新已有服务。', 'type' => 'string', 'example' => 'Create'], + 'ResourceType' => ['description' => '待部署的资源类型。取值：'."\n" + .'* Flow: 工作流的项目'."\n" + .'* Code: 代码模式的项目', 'type' => 'string', 'example' => 'Flow'], + 'ResourceId' => ['description' => '待部署的资源ID。', 'type' => 'string', 'example' => 'flow-asdf******123'], + 'ResourceSnapshotId' => ['description' => '待部署资源的快照 ID。若提供该参数，系统将直接基于该快照进行部署；若未提供，系统会先为资源创建新快照，再执行部署。', 'type' => 'string', 'example' => 'snap-asfg******123'], + 'ServiceName' => ['description' => '服务名称。', 'type' => 'string', 'example' => 'myservice01'], + 'Description' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'This is description'], + 'WorkDir' => ['description' => '服务的OSS工作目录。用于存储服务的运行日志、对话历史等。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'EnableTrace' => ['description' => '是否启用链路追踪。', 'type' => 'boolean', 'example' => 'true'], 'ChatHistoryConfig' => [ + 'description' => '对话历史配置。', 'type' => 'object', 'properties' => [ 'StorageType' => [ 'title' => '存储类型', - 'description' => '存储类型', - 'type' => 'string', - 'readOnly' => true, - 'enum' => [ - 'LOCAL', - 'CLOUD', - ], - ], - 'ConnectionName' => [ - 'title' => '连接名称', - 'description' => '连接名称', + 'description' => '存储方式。取值：'."\n" + .'* LOCAL: 对话历史保存在本地 SQLite 文件，不支持多实例的部署方式。'."\n" + .'* OSS：对话历史保存在服务 OSS 工作路径下特定的路径下。'."\n" + .'* RDS：对话历史保存在 RDS 的表中，需要指定一个 RDS 连接。', 'type' => 'string', + 'example' => 'RDS', 'readOnly' => true, + 'enum' => ['LOCAL', 'RDS', 'OSS'], ], + 'ConnectionName' => ['title' => '连接名称', 'description' => '连接名称。对话历史存储方式为 RDS 的时候需要指定该参数。', 'type' => 'string', 'example' => 'myconnection', 'readOnly' => true], ], ], 'ContentModerationConfig' => [ + 'description' => '内容审核配置。', 'type' => 'object', 'properties' => [ - 'EnableInputModeration' => [ - 'title' => '启用输入内容审查', - 'description' => '启用输入内容审查', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'EnableOutputModeration' => [ - 'title' => '启用输出内容审查', - 'description' => '启用输出内容审查', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'StreamingModerationThreshold' => [ - 'title' => '流式输出内容送审缓存大小', - 'description' => '流式输出内容送审缓存大小', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], + 'EnableInputModeration' => ['title' => '启用输入内容审查', 'description' => '是否启用对输入的安全审查。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => '启用输出内容审查', 'description' => '是否启用对输出的内容审查。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => '流式输出内容送审缓存大小', 'description' => '流式输出内容送审缓存大小，默认为 5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], ], ], - 'DeploymentConfig' => [ - 'type' => 'string', - ], + 'DeploymentConfig' => ['description' => '部署配置。具体参考 PAI-EAS 的[部署配置](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services)。', '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\\"}}}'], 'DeploymentStages' => [ + 'description' => '部署的阶段信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Stage' => [ - 'title' => '阶段', - 'description' => '阶段', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'StageName' => [ - 'title' => '阶段名称', - 'description' => '阶段名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'Description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtStartTime' => [ - 'title' => '开始时间', - 'description' => '开始时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtEndTime' => [ - 'title' => '结束时间', - 'description' => '结束时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'StageStatus' => [ - 'title' => '阶段状态', - 'description' => '阶段状态', - 'type' => 'string', - 'readOnly' => true, - ], - 'ErrorMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'readOnly' => true, - ], - 'StageInfo' => [ - 'title' => '阶段信息', - 'description' => '阶段信息', - 'type' => 'string', - 'readOnly' => true, - ], - ], + 'Stage' => ['title' => '阶段', 'description' => '部署阶段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'StageName' => ['title' => '阶段名称', 'description' => '部署阶段名称。', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true], + 'Description' => ['title' => '描述', 'description' => '部署阶段描述。', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true], + 'GmtStartTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'string', 'example' => '2025-09-23T10:25:38Z', 'readOnly' => true], + 'GmtEndTime' => ['title' => '结束时间', 'description' => '结束时间。', 'type' => 'string', 'example' => '2025-09-19T10:34:01Z', 'readOnly' => true], + 'StageStatus' => ['title' => '阶段状态', 'description' => '部署阶段状态。取值：'."\n" + .'* NotStarted： 未开始。'."\n" + .'* WaitForConfirm：等待确认。'."\n" + .'* Waiting： 等待中。'."\n" + .'* Creating： 创建中。'."\n" + .'* Running： 运行中。', 'type' => 'string', 'example' => 'Running', 'readOnly' => true], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true], + 'StageInfo' => ['title' => '阶段信息', 'description' => '部署阶段信息。', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29k******b0hotn\\"}', 'readOnly' => true], + ], + 'description' => '', ], ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'AutoApproval' => [ - 'type' => 'boolean', - ], - ], - ], - 'EcsSpec' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型', - 'type' => 'string', - 'readOnly' => true, - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - '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', - 'readOnly' => true, - ], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'This is error message'], + 'AutoApproval' => ['description' => '是否自动跳过部署确认环节。', 'type' => 'boolean', 'example' => 'true'], ], ], 'Flow' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'FlowId' => [ - 'type' => 'string', - ], - 'FlowName' => [ - 'type' => 'string', - ], - 'FlowStoragePath' => [ - 'type' => 'string', - ], - 'FlowType' => [ - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'WorkDir' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'CreateFrom' => [ - 'type' => 'string', - ], - 'FlowTemplateId' => [ - 'type' => 'string', - ], + 'WorkspaceId' => ['type' => 'string'], + 'Accessibility' => ['type' => 'string'], + 'Description' => ['type' => 'string'], + 'FlowId' => ['type' => 'string'], + 'FlowName' => ['type' => 'string'], + 'FlowStoragePath' => ['type' => 'string'], + 'FlowType' => ['type' => 'string'], + 'GmtCreateTime' => ['type' => 'string'], + 'GmtModifiedTime' => ['type' => 'string'], + 'WorkDir' => ['type' => 'string'], + 'Creator' => ['type' => 'string'], + 'CreateFrom' => ['type' => 'string'], + 'FlowTemplateId' => ['type' => 'string'], 'Runtime' => [ 'type' => 'object', 'properties' => [ - 'RuntimeId' => [ - 'title' => '运行时ID', - 'description' => '运行时ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'RuntimeName' => [ - 'title' => '运行时名称', - 'description' => '运行时名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'RuntimeType' => [ - 'title' => '运行时类型', - 'description' => '运行时类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'RuntimeStatus' => [ - 'title' => '运行时状态', - 'description' => '运行时状态', - 'type' => 'string', - 'readOnly' => true, - ], - 'SupportSSEStream' => [ - 'title' => '是否支持SSE', - 'description' => '是否支持SSE', - 'type' => 'boolean', - 'readOnly' => true, - ], + 'RuntimeId' => ['title' => '运行时ID', 'description' => '运行时ID', 'type' => 'string', 'readOnly' => true], + 'RuntimeName' => ['title' => '运行时名称', 'description' => '运行时名称', 'type' => 'string', 'readOnly' => true], + 'RuntimeType' => ['title' => '运行时类型', 'description' => '运行时类型', 'type' => 'string', 'readOnly' => true], + 'RuntimeStatus' => ['title' => '运行时状态', 'description' => '运行时状态', 'type' => 'string', 'readOnly' => true], + 'SupportSSEStream' => ['title' => '是否支持SSE', 'description' => '是否支持SSE', 'type' => 'boolean', 'readOnly' => true], ], ], - 'Version' => [ - 'type' => 'string', - ], - 'RuntimeId' => [ - 'type' => 'string', - ], - 'SourceUri' => [ - 'type' => 'string', - ], - 'CodeModeRunInfo' => [ - 'type' => 'string', - ], + 'Version' => ['type' => 'string'], + 'RuntimeId' => ['type' => 'string'], + 'SourceUri' => ['type' => 'string'], + 'CodeModeRunInfo' => ['type' => 'string'], ], ], 'FlowRun' => [ 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'FlowId' => [ - 'type' => 'string', - ], - 'FlowName' => [ - 'type' => 'string', - ], - 'FlowRunId' => [ - 'type' => 'string', - ], - 'RunStatus' => [ - 'type' => 'string', - ], - 'RunMode' => [ - 'type' => 'string', - ], - 'NodeName' => [ - 'type' => 'string', - ], - 'Variant' => [ - 'type' => 'string', - ], - 'Exception' => [ - 'type' => 'string', - ], - 'RunResult' => [ - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'GmtStartTime' => [ - 'type' => 'string', - ], - 'GmtFinishTime' => [ - 'type' => 'string', - ], - 'Duration' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'RunName' => [ - 'type' => 'string', - ], + 'WorkspaceId' => ['type' => 'string'], + 'Accessibility' => ['type' => 'string'], + 'FlowId' => ['type' => 'string'], + 'FlowName' => ['type' => 'string'], + 'FlowRunId' => ['type' => 'string'], + 'RunStatus' => ['type' => 'string'], + 'RunMode' => ['type' => 'string'], + 'NodeName' => ['type' => 'string'], + 'Variant' => ['type' => 'string'], + 'Exception' => ['type' => 'string'], + 'RunResult' => ['type' => 'string'], + 'GmtCreateTime' => ['type' => 'string'], + 'GmtModifiedTime' => ['type' => 'string'], + 'GmtStartTime' => ['type' => 'string'], + 'GmtFinishTime' => ['type' => 'string'], + 'Duration' => ['type' => 'integer', 'format' => 'int32'], + 'Creator' => ['type' => 'string'], + 'RunName' => ['type' => 'string'], 'EcsSpec' => [ 'type' => 'object', 'properties' => [ - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - '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, - ], - 'PodCount' => [ - 'title' => 'Pod数量', - 'description' => 'Pod数量', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUMemory' => [ - 'title' => 'GPU显存', - 'description' => 'GPU显存', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUCorePercentage' => [ - 'title' => 'GPU算力占比', - 'description' => 'GPU算力占比', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'ExtraEphemeralStorage' => [ - 'title' => '额外系统盘', - 'description' => '额外系统盘', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'QuotaId' => [ - 'title' => '资源配额ID', - 'description' => '资源配额ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'QuotaType' => [ - 'title' => '资源配额类型', - 'description' => '资源配额类型', - 'type' => 'string', - 'readOnly' => true, - ], + 'InstanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型', 'type' => 'string', '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], + 'PodCount' => ['title' => 'Pod数量', 'description' => 'Pod数量', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true], + 'GPUMemory' => ['title' => 'GPU显存', 'description' => 'GPU显存', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true], + 'GPUCorePercentage' => ['title' => 'GPU算力占比', 'description' => 'GPU算力占比', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true], + 'ExtraEphemeralStorage' => ['title' => '额外系统盘', 'description' => '额外系统盘', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true], + 'QuotaId' => ['title' => '资源配额ID', 'description' => '资源配额ID', 'type' => 'string', 'readOnly' => true], + 'QuotaType' => ['title' => '资源配额类型', 'description' => '资源配额类型', 'type' => 'string', 'readOnly' => true], ], ], - 'ResourceId' => [ - 'type' => 'string', - ], + 'ResourceId' => ['type' => 'string'], 'DataSources' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'title' => '数据集ID', - 'description' => '数据集ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '统一资源识别码', - 'type' => 'string', - 'readOnly' => true, - ], - 'MountPath' => [ - 'title' => '挂载路径', - 'description' => '挂载路径', - 'type' => 'string', - 'readOnly' => true, - ], + 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'string', 'readOnly' => true], + 'Uri' => ['title' => '统一资源识别码', 'description' => '统一资源识别码', 'type' => 'string', 'readOnly' => true], + 'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径', 'type' => 'string', 'readOnly' => true], ], ], ], 'DataColumnMapping' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string'], ], 'EvaluationConfigs' => [ 'type' => 'array', @@ -1046,24 +266,9 @@ 'description' => '应用流来源', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => '类型', - 'description' => '类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'Name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'readOnly' => true, - ], + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true], + 'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true], ], 'readOnly' => true, ], @@ -1071,59 +276,22 @@ 'title' => '映射配置', 'description' => '映射配置', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - 'readOnly' => true, - ], - 'InputsOverrideConfig' => [ - 'title' => '输入配置', - 'description' => '输入配置', - 'type' => 'string', - 'readOnly' => true, - ], - 'Name' => [ - 'title' => '评测名称', - 'description' => '评测名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => '评测类型', - 'description' => '评测类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'Inputs' => [ - 'title' => '评测输入', - 'description' => '评测输入', - 'type' => 'string', + 'additionalProperties' => ['type' => 'string'], 'readOnly' => true, ], + 'InputsOverrideConfig' => ['title' => '输入配置', 'description' => '输入配置', 'type' => 'string', 'readOnly' => true], + 'Name' => ['title' => '评测名称', 'description' => '评测名称', 'type' => 'string', 'readOnly' => true], + 'Type' => ['title' => '评测类型', 'description' => '评测类型', 'type' => 'string', 'readOnly' => true], + 'Inputs' => ['title' => '评测输入', 'description' => '评测输入', 'type' => 'string', 'readOnly' => true], ], ], ], 'UserVpc' => [ 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'readOnly' => true, - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID', 'type' => 'string', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID', 'type' => 'string', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID', 'type' => 'string', 'readOnly' => true], ], ], 'Envs' => [ @@ -1131,18 +299,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '环境键', - 'description' => '环境键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '环境值', - 'description' => '环境值', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => '环境键', 'description' => '环境键', 'type' => 'string', 'readOnly' => true], + 'Value' => ['title' => '环境值', 'description' => '环境值', 'type' => 'string', 'readOnly' => true], ], ], ], @@ -1151,36 +309,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'readOnly' => true], + 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'readOnly' => true], ], ], ], 'CredentialConfig' => [ 'type' => 'object', 'properties' => [ - 'EnableCredentialInject' => [ - 'title' => '是否启用Credential注入', - 'description' => '是否启用Credential注入', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'AliyunEnvRoleKey' => [ - 'title' => 'AliyunEnvRoleKey', - 'description' => 'AliyunEnvRoleKey', - 'type' => 'string', - 'readOnly' => true, - ], + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否启用Credential注入', 'type' => 'boolean', 'readOnly' => true], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => 'AliyunEnvRoleKey', 'type' => 'string', 'readOnly' => true], 'CredentialConfigItems' => [ 'title' => 'Credential配置项列表', 'description' => 'Credential配置项列表', @@ -1188,18 +326,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => 'Key', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => 'Type', - 'description' => 'Type', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => 'Key', 'description' => 'Key', 'type' => 'string', 'readOnly' => true], + 'Type' => ['title' => 'Type', 'description' => 'Type', 'type' => 'string', 'readOnly' => true], 'Roles' => [ 'title' => '角色列表', 'description' => '角色列表', @@ -1207,24 +335,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'AssumeRoleFor' => [ - 'title' => 'AssumeRoleFor', - 'description' => 'AssumeRoleFor', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleType' => [ - 'title' => '角色类型', - 'description' => '角色类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleArn' => [ - 'title' => '角色名称', - 'description' => '角色名称', - 'type' => 'string', - 'readOnly' => true, - ], + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => 'AssumeRoleFor', 'type' => 'string', 'readOnly' => true], + 'RoleType' => ['title' => '角色类型', 'description' => '角色类型', 'type' => 'string', 'readOnly' => true], + 'RoleArn' => ['title' => '角色名称', 'description' => '角色名称', 'type' => 'string', 'readOnly' => true], ], 'readOnly' => true, ], @@ -1237,93 +350,29 @@ ], ], ], - 'RunTimeout' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'RunTimeout' => ['type' => 'integer', 'format' => 'int32'], 'ChildRuns' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'FlowRunId' => [ - 'title' => '应用流运行ID', - 'description' => '应用流运行ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'RunName' => [ - 'title' => '运行名称', - 'description' => '运行名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'RunMode' => [ - 'title' => '运行模式', - 'description' => '运行模式', - 'type' => 'string', - 'readOnly' => true, - ], - 'RunStatus' => [ - 'title' => '运行状态', - 'description' => '运行状态', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtCreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtModifiedTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtStartTime' => [ - 'title' => '开始时间', - 'description' => '开始时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'GmtFinishTime' => [ - 'title' => '结束时间', - 'description' => '结束时间', - 'type' => 'string', - 'readOnly' => true, - ], - 'Duration' => [ - 'title' => '运行时长', - 'description' => '运行时长', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], + 'FlowRunId' => ['title' => '应用流运行ID', 'description' => '应用流运行ID', 'type' => 'string', 'readOnly' => true], + 'RunName' => ['title' => '运行名称', 'description' => '运行名称', 'type' => 'string', 'readOnly' => true], + 'RunMode' => ['title' => '运行模式', 'description' => '运行模式', 'type' => 'string', 'readOnly' => true], + 'RunStatus' => ['title' => '运行状态', 'description' => '运行状态', 'type' => 'string', 'readOnly' => true], + 'GmtCreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'readOnly' => true], + 'GmtModifiedTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'readOnly' => true], + 'GmtStartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'readOnly' => true], + 'GmtFinishTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'readOnly' => true], + 'Duration' => ['title' => '运行时长', 'description' => '运行时长', 'type' => 'integer', 'format' => 'int32', 'readOnly' => true], 'FlowSource' => [ 'title' => '应用流来源', 'description' => '应用流来源', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => '类型', - 'description' => '类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'Name' => [ - 'title' => '名称', - 'description' => '名称', - 'type' => 'string', - 'readOnly' => true, - ], + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'readOnly' => true], + 'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'readOnly' => true], + 'Name' => ['title' => '名称', 'description' => '名称', 'type' => 'string', 'readOnly' => true], ], 'readOnly' => true, ], @@ -1332,21 +381,11 @@ 'description' => '任务信息', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'string', - 'readOnly' => true, - ], + 'JobId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'readOnly' => true], ], 'readOnly' => true, ], - 'RunResult' => [ - 'title' => '运行结果', - 'description' => '运行结果', - 'type' => 'string', - 'readOnly' => true, - ], + 'RunResult' => ['title' => '运行结果', 'description' => '运行结果', 'type' => 'string', 'readOnly' => true], ], ], ], @@ -1355,133 +394,52 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'NodeName' => [ - 'title' => '节点名称', - 'description' => '节点名称', - 'type' => 'string', - 'readOnly' => true, - ], - 'Status' => [ - 'title' => '节点状态', - 'description' => '节点状态', - 'type' => 'string', - 'readOnly' => true, - ], - 'Inputs' => [ - 'title' => '输入', - 'description' => '输入', - 'type' => 'string', - 'readOnly' => true, - ], - 'Output' => [ - 'title' => '输出', - 'description' => '输出', - 'type' => 'string', - 'readOnly' => true, - ], - 'ErrorMessage' => [ - 'title' => '错误信息', - 'description' => '错误信息', - 'type' => 'string', - 'readOnly' => true, - ], - 'Duration' => [ - 'title' => '耗时', - 'description' => '耗时', - 'type' => 'string', - 'readOnly' => true, - ], - 'Stdout' => [ - 'title' => '日志信息', - 'description' => '日志信息', - 'type' => 'string', - 'readOnly' => true, - ], + 'NodeName' => ['title' => '节点名称', 'description' => '节点名称', 'type' => 'string', 'readOnly' => true], + 'Status' => ['title' => '节点状态', 'description' => '节点状态', 'type' => 'string', 'readOnly' => true], + 'Inputs' => ['title' => '输入', 'description' => '输入', 'type' => 'string', 'readOnly' => true], + 'Output' => ['title' => '输出', 'description' => '输出', 'type' => 'string', 'readOnly' => true], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'readOnly' => true], + 'Duration' => ['title' => '耗时', 'description' => '耗时', 'type' => 'string', 'readOnly' => true], + 'Stdout' => ['title' => '日志信息', 'description' => '日志信息', 'type' => 'string', 'readOnly' => true], ], ], ], - 'EvaluationWorkerCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'EvaluationWorkerCount' => ['type' => 'integer', 'format' => 'int32'], ], ], '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', - ], + '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', - ], + 'additionalProperties' => ['type' => 'string'], ], 'DescriptionI18N' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - 'Version' => [ - 'type' => 'string', - ], - 'Locale' => [ - 'type' => 'string', - ], - 'ReferenceCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AliyunDocumentId' => [ - 'type' => 'string', + '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', - ], + 'Key' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string'], + 'Value' => ['title' => '标签Value', 'description' => '标签Value', 'type' => 'string'], ], ], ], @@ -1491,57 +449,21 @@ 'description' => '知识库。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'example' => '478***', - ], - 'Accessibility' => [ - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'GmtCreateTime' => [ - 'description' => '知识库创建时间（UTC）。', - 'type' => 'string', - 'example' => '2024-12-15T14:46:23Z', - ], - 'GmtModifiedTime' => [ - 'description' => '知识库修改时间（UTC）。', - 'type' => 'string', - 'example' => '2025-12-18T19:32:58Z', - ], - 'Name' => [ - 'description' => '知识库名称。', - 'type' => 'string', - 'example' => 'myName', - ], - 'KnowledgeBaseId' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'example' => 'd-nacr******sxd2', - ], - 'Description' => [ - 'description' => '知识库描述。', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base.', - ], - 'KnowledgeBaseType' => [ - 'description' => '知识库类型。'."\n" - .'- TEXT：文档。'."\n" - .'- STRUCTURED：结构化数据。'."\n" - .'- IMAGE：图片。'."\n" - .'- VIDEO：视频。', - 'type' => 'string', - 'example' => 'TEXT', - ], - 'DatasetId' => [ - 'description' => '知识库对应的数据集ID。', - 'type' => 'string', - 'example' => 'd-lvb6****865w', - ], + 'WorkspaceId' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'example' => '478***'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'GmtCreateTime' => ['description' => '知识库创建时间（UTC）。', 'type' => 'string', 'example' => '2024-12-15T14:46:23Z'], + 'GmtModifiedTime' => ['description' => '知识库修改时间（UTC）。', 'type' => 'string', 'example' => '2025-12-18T19:32:58Z'], + 'Name' => ['description' => '知识库名称。', 'type' => 'string', 'example' => 'myName'], + 'KnowledgeBaseId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'd-nacr******sxd2'], + 'Description' => ['description' => '知识库描述。', 'type' => 'string', 'example' => 'This is a description of the knowledge base.'], + 'KnowledgeBaseType' => ['description' => '知识库类型。'."\n" + .'- TEXT：文档。'."\n" + .'- STRUCTURED：结构化数据。'."\n" + .'- IMAGE：图片。'."\n" + .'- VIDEO：视频。', 'type' => 'string', 'example' => 'TEXT'], + 'DatasetId' => ['description' => '知识库对应的数据集ID。', 'type' => 'string', 'example' => 'd-lvb6****865w'], 'DataSources' => [ 'description' => '数据源。', 'type' => 'array', @@ -1549,128 +471,47 @@ 'description' => '数据源。', 'type' => 'object', 'properties' => [ - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '源文件存储路径。', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', - 'readOnly' => true, - ], + 'Uri' => ['title' => '统一资源识别码', 'description' => '源文件存储路径。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], ], ], ], - 'OutputDir' => [ - 'description' => '输出数据的存储路径。', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - ], + 'OutputDir' => ['description' => '输出数据的存储路径。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/'], 'ChunkConfig' => [ 'description' => '文件切片配置。', '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' => '20', - 'readOnly' => true, - ], - 'ChunkStrategy' => [ - 'title' => '分块策略', - 'description' => '分块策略。策略类型如下：'."\n" - .'- Default。系统默认切片策略。'."\n" - .'- Asr。按音频内容切分。', - 'type' => 'string', - 'example' => 'Default', - 'readOnly' => true, - 'default' => 'Default', - ], + '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' => '20', 'readOnly' => true], + 'ChunkStrategy' => ['title' => '分块策略', 'description' => '分块策略。策略类型如下：'."\n" + .'- Default。系统默认切片策略。'."\n" + .'- Asr。按音频内容切分。', 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], ], ], 'EmbeddingConfig' => [ 'description' => '向量索引配置。', 'type' => 'object', 'properties' => [ - 'ConnectionName' => [ - 'title' => 'Embedding连接名称', - 'description' => '索引服务连接名称。', - 'type' => 'string', - 'example' => 'myEmbeddingConn', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => '索引服务连接ID。', - 'type' => 'string', - 'example' => 'conn-r3o7******38bh', - ], - 'Model' => [ - 'title' => '模型', - 'description' => '模型名称。', - 'type' => 'string', - 'example' => 'text-embedding-v4', - ], + 'ConnectionName' => ['title' => 'Embedding连接名称', 'description' => '索引服务连接名称。', 'type' => 'string', 'example' => 'myEmbeddingConn'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '索引服务连接ID。', 'type' => 'string', 'example' => 'conn-r3o7******38bh'], + 'Model' => ['title' => '模型', 'description' => '模型名称。', 'type' => 'string', 'example' => 'text-embedding-v4'], ], ], 'VectorDBConfig' => [ 'description' => '向量库配置。', 'type' => 'object', 'properties' => [ - 'VectorDBType' => [ - 'title' => 'VectorDB类型', - 'description' => '向量数据库类型。支持以下取值：'."\n" - .'- Elasticsearch'."\n" - .'- Milvus'."\n" - .'- Faiss', - 'type' => 'string', - 'example' => 'Milvus', - ], - 'ConnectionName' => [ - 'title' => 'VectorDB连接名称', - 'description' => '向量数据库连接名称。', - 'type' => 'string', - 'example' => 'myConnName', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => '向量数据库连接ID。', - 'type' => 'string', - 'example' => 'conn-v2wq****z7rg', - ], - 'CollectionName' => [ - 'title' => 'Collection名称', - 'description' => '向量数据库表或集合名称。', - 'type' => 'string', - 'example' => 'my_collection', - ], + 'VectorDBType' => ['title' => 'VectorDB类型', 'description' => '向量数据库类型。支持以下取值：'."\n" + .'- Elasticsearch'."\n" + .'- Milvus'."\n" + .'- Faiss', 'type' => 'string', 'example' => 'Milvus'], + 'ConnectionName' => ['title' => 'VectorDB连接名称', 'description' => '向量数据库连接名称。', 'type' => 'string', 'example' => 'myConnName'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '向量数据库连接ID。', 'type' => 'string', 'example' => 'conn-v2wq****z7rg'], + 'CollectionName' => ['title' => 'Collection名称', 'description' => '向量数据库表或集合名称。', 'type' => 'string', 'example' => 'my_collection'], ], ], - 'Creator' => [ - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '1247****1467', - ], - 'RuntimeId' => [ - 'description' => '运行时ID。', - 'type' => 'string', - 'example' => 'rtime-78****d6', - ], + 'Creator' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '1247****1467'], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'example' => 'rtime-78****d6'], 'MetaDataConfig' => [ 'description' => '元数据配置。', 'type' => 'object', @@ -1683,34 +524,10 @@ 'description' => '自定义元数据。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据字段名称。', - 'type' => 'string', - 'example' => 'column1', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据字段类型。', - 'type' => 'string', - 'example' => 'String', - ], - 'ReferenceCount' => [ - 'title' => '引用次数', - 'description' => '引用次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'readOnly' => true, - ], - 'ValueCount' => [ - 'title' => '值的个数', - 'description' => '值的个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'readOnly' => true, - ], + 'Key' => ['title' => '元数据Key', 'description' => '元数据字段名称。', 'type' => 'string', 'example' => 'column1'], + 'ValueType' => ['title' => '元数据Value类型', 'description' => '元数据字段类型。', 'type' => 'string', 'example' => 'String'], + 'ReferenceCount' => ['title' => '引用次数', 'description' => '引用次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true], + 'ValueCount' => ['title' => '值的个数', 'description' => '值的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], ], ], ], @@ -1720,56 +537,21 @@ 'description' => '知识库自动更新配置。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '知识库自动更新状态', - 'description' => '知识库自动更新开关状态。'."\n" - .'- Enable: 开启自动更新。'."\n" - .'- Disable: 关闭自动更新。', - 'type' => 'string', - 'example' => 'Enable', - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。为空或public-cluster表示公共资源。', - 'type' => 'string', - 'example' => 'quota87**45', - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], + 'Status' => ['title' => '知识库自动更新状态', 'description' => '知识库自动更新开关状态。'."\n" + .'- Enable: 开启自动更新。'."\n" + .'- Disable: 关闭自动更新。', 'type' => 'string', 'example' => 'Enable', 'default' => 'Disable'], + 'ResourceId' => ['title' => '资源组ID', 'description' => '资源组ID。为空或public-cluster表示公共资源。', 'type' => 'string', 'example' => 'quota87**45'], + 'MaxRunningTimeInSeconds' => ['title' => '任务最大运行时间', 'description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], 'EmbeddingConfig' => [ 'title' => 'Embedding配置', 'description' => '向量索引配置。', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'], ], ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置。', - '$ref' => '#/components/schemas/UserVpc', - ], + 'UserVpc' => ['title' => '用户VPC配置', 'description' => '用户VPC配置。', '$ref' => '#/components/schemas/UserVpc'], 'EcsSpecs' => [ 'title' => '运行资源配置', 'description' => '运行资源配置列表。', @@ -1778,76 +560,21 @@ 'description' => '运行资源。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的值为Head和Worker。', - 'type' => 'string', - 'example' => 'Worker', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称。', - 'type' => 'string', - 'example' => 'ecs.c6.large', - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型。', - 'type' => 'string', - 'example' => 'V100', - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本。', - 'type' => 'string', - 'example' => '550.127.08', - ], + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的值为Head和Worker。', 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '机型名称', 'description' => '机型名称。', 'type' => 'string', 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '副本数量', 'description' => '副本数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'example' => 'V100'], + 'CPU' => ['title' => 'CPU核数', 'description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Memory' => ['title' => '内存大小', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'Driver' => ['title' => '驱动版本', 'description' => '驱动版本。', 'type' => 'string', 'example' => '550.127.08'], ], ], ], ], ], - 'VersionName' => [ - 'description' => '知识库版本。默认为v1。', - 'type' => 'string', - 'example' => 'v1', - ], + 'VersionName' => ['description' => '知识库版本。默认为v1。', 'type' => 'string', 'example' => 'v1'], 'IndexColumnConfig' => [ 'description' => '列字段配置。结构化数据类型知识库有效。', 'type' => 'object', @@ -1860,13 +587,7 @@ 'description' => '向量索引列。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, ], @@ -1880,13 +601,7 @@ 'description' => '内容过滤列。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, ], @@ -1899,15 +614,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, + 'description' => '', ], 'readOnly' => true, ], @@ -1919,64 +629,19 @@ 'description' => '知识库切片。', 'type' => 'object', 'properties' => [ - 'Score' => [ - 'description' => '结果与查询内容的相关性。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9832', - ], - 'ChunkId' => [ - 'description' => '切片ID。', - 'type' => 'string', - 'example' => '7fjs******90fs', - ], - 'ChunkStart' => [ - 'description' => '切片起始位置。返回从文件播放开始的毫秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ChunkEnd' => [ - 'description' => '切片结束位置。返回从文件播放开始的毫秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30000', - ], - 'ChunkSequence' => [ - 'description' => '切片在文件中的序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ChunkContent' => [ - 'description' => '切片内容。', - 'type' => 'string', - 'example' => 'content of chunk', - ], - 'ChunkSize' => [ - 'description' => '切片大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3452', - ], - 'ChunkStatus' => [ - 'description' => '切片状态。'."\n" - ."\n" - .'- Enable: 启用。'."\n" - .'- Disable: 禁用。', - 'type' => 'string', - 'example' => 'Enable', - ], - 'DownloadUrl' => [ - 'description' => '切片下载地址。图片和视频文件返回。', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', - ], - 'ThumbnailUrl' => [ - 'description' => '切片缩略图。图片和视频文件返回。', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******', - ], + 'Score' => ['description' => '结果与查询内容的相关性。', 'type' => 'number', 'format' => 'float', 'example' => '0.9832'], + 'ChunkId' => ['description' => '切片ID。', 'type' => 'string', 'example' => '7fjs******90fs'], + 'ChunkStart' => ['description' => '切片起始位置。返回从文件播放开始的毫秒数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ChunkEnd' => ['description' => '切片结束位置。返回从文件播放开始的毫秒数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30000'], + 'ChunkSequence' => ['description' => '切片在文件中的序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ChunkContent' => ['description' => '切片内容。', 'type' => 'string', 'example' => 'content of chunk'], + 'ChunkSize' => ['description' => '切片大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '3452'], + 'ChunkStatus' => ['description' => '切片状态。'."\n" + ."\n" + .'- Enable: 启用。'."\n" + .'- Disable: 禁用。', 'type' => 'string', 'example' => 'Enable'], + 'DownloadUrl' => ['description' => '切片下载地址。图片和视频文件返回。', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******'], + 'ThumbnailUrl' => ['description' => '切片缩略图。图片和视频文件返回。', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/5743962650c522fd54620fb9868d8c4c?Expires=1735092238&OSSAccessKeyId=LTAIgoNm******'], 'ChunkAttachment' => [ 'description' => '切片附件。', 'type' => 'array', @@ -1984,26 +649,10 @@ 'description' => '附件信息。', 'type' => 'object', 'properties' => [ - 'PlaceholderId' => [ - 'description' => '占位符ID。', - 'type' => 'string', - 'example' => 'IMAGE_PLACEHOLDER_0', - ], - 'Type' => [ - 'description' => '附件类型。', - 'type' => 'string', - 'example' => 'image', - ], - 'Uri' => [ - 'description' => '附件Uri。', - 'type' => 'string', - 'example' => 'oss://mybucket/file1/img1.jpg', - ], - 'DownloadUrl' => [ - 'description' => '附件下载地址。', - 'type' => 'string', - 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******', - ], + 'PlaceholderId' => ['description' => '占位符ID。', 'type' => 'string', 'example' => 'IMAGE_PLACEHOLDER_0'], + 'Type' => ['description' => '附件类型。', 'type' => 'string', 'example' => 'image'], + 'Uri' => ['description' => '附件Uri。', 'type' => 'string', 'example' => 'oss://mybucket/file1/img1.jpg'], + 'DownloadUrl' => ['description' => '附件下载地址。', 'type' => 'string', 'example' => 'https://cas-documents-service.oss-cn-shanghai.aliyuncs.com/Batch_Upload_Monitor_Domain.xlsx?Expires=1737338736&OSSAccessKeyId=LTAIgoNm******'], ], ], ], @@ -2011,21 +660,9 @@ 'description' => '原始文件信息。', 'type' => 'object', 'properties' => [ - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'abc.txt', - ], - 'FileUri' => [ - 'description' => '文件路径。', - 'type' => 'string', - 'example' => 'oss://mybucket/path/abc.txt', - ], - 'FileMetaId' => [ - 'description' => '文件元数据ID。', - 'type' => 'string', - 'example' => 'sd8c******67ux', - ], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'abc.txt'], + 'FileUri' => ['description' => '文件路径。', 'type' => 'string', 'example' => 'oss://mybucket/path/abc.txt'], + 'FileMetaId' => ['description' => '文件元数据ID。', 'type' => 'string', 'example' => 'sd8c******67ux'], ], ], ], @@ -2034,838 +671,292 @@ 'description' => '知识库任务。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'example' => '478**', - ], - 'Accessibility' => [ - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'Creator' => [ - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '2003******4844', - ], - 'GmtCreateTime' => [ - 'description' => '任务创建时间（UTC）。', - 'type' => 'string', - 'example' => '2024-05-13T01:43:15Z', - ], - 'GmtModifiedTime' => [ - 'description' => '任务更新时间（UTC）。', - 'type' => 'string', - 'example' => '2024-05-13T03:05:22Z', - ], - 'KnowledgeBaseId' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'example' => 'd-ksicx823d', - ], - 'KnowledgeBaseJobId' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'example' => 'kbjob-9m******54', - ], - 'JobAction' => [ - 'description' => '任务操作类型。'."\n" - .'- SyncIndex：更新知识库索引', - 'type' => 'string', - 'example' => 'SyncIndex', - ], - 'Description' => [ - 'description' => '知识库任务描述。', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base job.', - ], - 'Status' => [ - 'description' => '知识库任务状态。'."\n" - ."\n" - .'- Running: 运行中。'."\n" - .'- Success: 运行成功。'."\n" - .'- Failed: 运行失败。', - 'type' => 'string', - 'example' => 'Running', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'quota89**76', - ], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '478**'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'Creator' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '2003******4844'], + 'GmtCreateTime' => ['description' => '任务创建时间（UTC）。', 'type' => 'string', 'example' => '2024-05-13T01:43:15Z'], + 'GmtModifiedTime' => ['description' => '任务更新时间（UTC）。', 'type' => 'string', 'example' => '2024-05-13T03:05:22Z'], + 'KnowledgeBaseId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'd-ksicx823d'], + 'KnowledgeBaseJobId' => ['description' => '知识库任务ID。', 'type' => 'string', 'example' => 'kbjob-9m******54'], + 'JobAction' => ['description' => '任务操作类型。'."\n" + .'- SyncIndex：更新知识库索引', 'type' => 'string', 'example' => 'SyncIndex'], + 'Description' => ['description' => '知识库任务描述。', 'type' => 'string', 'example' => 'This is a description of the knowledge base job.'], + 'Status' => ['description' => '知识库任务状态。'."\n" + ."\n" + .'- Running: 运行中。'."\n" + .'- Success: 运行成功。'."\n" + .'- Failed: 运行失败。', 'type' => 'string', 'example' => 'Running'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'quota89**76'], 'EcsSpecs' => [ 'description' => '任务运行机器资源。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的值为Head和Worker。', - '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', - 'example' => '4', - 'readOnly' => true, - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型。', - 'type' => 'string', - 'example' => 'V100', - 'readOnly' => true, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本。', - 'type' => 'string', - 'example' => '550.127.08', - 'readOnly' => true, - ], - ], + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的值为Head和Worker。', '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', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'Memory' => ['title' => '内存大小', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存容量大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => '驱动版本。', 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true], + ], + 'description' => '', ], ], 'UserVpc' => [ 'description' => '资源运行VPC信息。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-wz90****5v23', - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-wz9r****ng10', - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-wz91****e10e', - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-wz91****e10e'], ], ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'GmtFinishTime' => [ - 'description' => '任务结束时间（UTC）。', - 'type' => 'string', - 'example' => '2024-05-13T04:03:27Z', - ], - 'ErrorMessage' => [ - 'description' => '任务异常信息。', - 'type' => 'string', - 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', - ], + 'MaxRunningTimeInSeconds' => ['description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], + 'GmtFinishTime' => ['description' => '任务结束时间（UTC）。', 'type' => 'string', 'example' => '2024-05-13T04:03:27Z'], + 'ErrorMessage' => ['description' => '任务异常信息。', 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z'], 'PipelineRunInfo' => [ 'description' => '工作流运行信息。', 'type' => 'object', 'properties' => [ - 'PipelineRunId' => [ - 'title' => 'PaiFlow工作流运行ID', - 'description' => 'PaiFlow工作流运行ID', - 'type' => 'string', - 'example' => 'flow-fi8z******g4gy', - 'readOnly' => true, - ], + 'PipelineRunId' => ['title' => 'PaiFlow工作流运行ID', 'description' => 'PaiFlow工作流运行ID', 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true], ], ], 'KnowledgeBaseJobResult' => [ 'description' => '任务结果。', 'type' => 'object', 'properties' => [ - 'TotalFileCount' => [ - 'title' => '总处理文件数', - 'description' => '总处理文件数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AddChunkCount' => [ - 'title' => '增加Chunk数量', - 'description' => '增加分片总量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DeleteChunkCount' => [ - 'title' => '删除Chunk数量', - 'description' => '删除分片总量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'TotalFileCount' => ['title' => '总处理文件数', 'description' => '总处理文件数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AddChunkCount' => ['title' => '增加Chunk数量', 'description' => '增加分片总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DeleteChunkCount' => ['title' => '删除Chunk数量', 'description' => '删除分片总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], ], 'EmbeddingConfig' => [ 'description' => '索引配置。', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'readOnly' => true, - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'readOnly' => true, - ], - ], - ], - ], - ], - 'KnowledgeBaseMeta' => [ - 'type' => 'object', - 'properties' => [ - 'FileMetaId' => [ - 'type' => 'string', - ], - 'FileName' => [ - 'type' => 'string', - ], - 'FileUri' => [ - 'type' => 'string', - ], - 'FileCreateTime' => [ - 'type' => 'string', - ], - 'FileUpdateTime' => [ - 'type' => 'string', - ], - 'FileSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'FileType' => [ - 'type' => 'string', - ], - 'FileContentType' => [ - 'type' => 'string', - ], - 'FileStatus' => [ - 'type' => 'string', - ], - 'FileMetaData' => [ - 'type' => 'string', - ], - 'ChunkId' => [ - 'type' => 'string', - ], - 'ChunkStart' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ChunkEnd' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ChunkSequence' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ChunkContent' => [ - 'type' => 'string', - ], - 'ChunkSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ChunkStatus' => [ - 'type' => 'string', - ], - 'DownloadUrl' => [ - 'type' => 'string', - ], - 'ThumbnailUrl' => [ - 'type' => 'string', - ], - 'ChunkAttachment' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PlaceholderId' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'string', - ], - 'Uri' => [ - 'type' => 'string', - ], - 'DownloadUrl' => [ - 'type' => 'string', - ], - ], - ], - ], - 'MetaData' => [ - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'type' => 'string', - ], - 'FileUri' => [ - 'type' => 'string', - ], - 'FileMetaId' => [ - 'type' => 'string', - ], + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true], ], ], ], ], 'Runtime' => [ + 'description' => '运行时详情。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'RuntimeId' => [ - 'type' => 'string', - ], - 'RuntimeName' => [ - 'type' => 'string', - ], - 'RuntimeType' => [ - 'type' => 'string', - ], - 'RuntimeStatus' => [ - 'type' => 'string', - ], - 'IdleTimeout' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'FlowId' => [ - 'type' => 'string', - ], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'example' => '478***'], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'example' => 'rtime-apje******beaz'], + 'RuntimeName' => ['description' => '运行时的名称。', 'type' => 'string', 'example' => 'dev01'], + 'RuntimeType' => ['description' => '运行时类型。', 'type' => 'string', 'example' => 'DSW'], + 'RuntimeStatus' => ['description' => '运行时状态。取值：'."\n" + .'* Creating: 创建中'."\n" + .'* SaveFailed: 镜像保存失败'."\n" + .'* Stopped: 已停止'."\n" + .'* Failed: 失败'."\n" + .'* ResourceAllocating:资源分配中'."\n" + .'* Stopping: 停止中'."\n" + .'* Updating: 更新中'."\n" + .'* Saving: 镜像保存中'."\n" + .'* Queuing: 排队中'."\n" + .'* Recovering: 实例恢复中'."\n" + .'* Starting: 创建中'."\n" + .'* Running: 运行中'."\n" + .'* Saved: 镜像保存成功'."\n" + .'* Deleting: 删除中'."\n" + .'* EnvPreparing: 环境准备中', 'type' => 'string', 'example' => 'Running'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2680******4103'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], 'EcsSpec' => [ + 'description' => 'ECS资源配置', 'type' => 'object', 'properties' => [ - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => '实例类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - '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, - ], - 'PodCount' => [ - 'title' => 'Pod数量', - 'description' => 'Pod数量', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUMemory' => [ - 'title' => 'GPU显存', - 'description' => 'GPU显存', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'GPUCorePercentage' => [ - 'title' => 'GPU算力占比', - 'description' => 'GPU算力占比', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'ExtraEphemeralStorage' => [ - 'title' => '额外系统盘', - 'description' => '额外系统盘', - 'type' => 'integer', - 'format' => 'int32', - 'readOnly' => true, - ], - 'QuotaId' => [ - 'title' => '资源配额ID', - 'description' => '资源配额ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'QuotaType' => [ - 'title' => '资源配额类型', - 'description' => '资源配额类型', - 'type' => 'string', - 'readOnly' => true, - ], + 'InstanceType' => ['title' => '实例类型', 'description' => '实例类型。', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。取值如下：'."\n" + .'* V100'."\n" + .'* A100'."\n" + .'* T4'."\n" + .'* A10'."\n" + .'* P100', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'CPU' => ['title' => 'CPU数量', 'description' => 'CPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU数量', 'description' => 'GPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'readOnly' => true], + 'Memory' => ['title' => '内存信息', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存', 'description' => '共享内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '535.161.08', 'readOnly' => true], ], ], - 'ResourceId' => [ - 'type' => 'string', - ], + 'ResourceId' => ['description' => '资源配额ID。', 'type' => 'string', 'example' => 'quota18******zv9'], 'UserVpc' => [ + 'description' => '用户VPC配置。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'DefaultRoute' => [ - 'title' => '默认路由', - 'description' => '默认路由', - 'type' => 'string', - 'readOnly' => true, - ], + 'VpcId' => ['title' => 'VPC ID', 'description' => '专有网络 ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-wz9i****1129', 'readOnly' => true], + 'DefaultRoute' => ['title' => '默认路由', 'description' => '默认路由', 'type' => 'string', 'example' => 'eth0', 'readOnly' => true], 'ExtendedCIDRs' => [ 'title' => '扩展网段', 'description' => '扩展网段', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'readOnly' => true, - ], + 'items' => ['description' => '扩展网段。', 'type' => 'string', 'example' => '172.16.1.0/24', 'readOnly' => true], 'readOnly' => true, ], ], ], 'Envs' => [ + 'description' => '环境变量。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '环境键', - 'description' => '环境键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '环境值', - 'description' => '环境值', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => '环境键', 'description' => '环境键。', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true], + 'Value' => ['title' => '环境值', 'description' => '环境值。', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true], ], + 'description' => '', ], ], 'Labels' => [ + 'description' => '标签。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键', - 'type' => 'string', - 'readOnly' => true, - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'testKey01', 'readOnly' => true], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'testValue01', 'readOnly' => true], ], + 'description' => '', ], ], 'DataSources' => [ + 'description' => '挂载数据源。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DatasetId' => [ - 'title' => '数据集ID', - 'description' => '数据集ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'Uri' => [ - 'title' => '统一资源识别码', - 'description' => '统一资源识别码', - 'type' => 'string', - 'readOnly' => true, - ], - 'MountPath' => [ - 'title' => '挂载路径', - 'description' => '挂载路径', - 'type' => 'string', - 'readOnly' => true, - ], + 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集 ID。与 Uri 二选一。', 'type' => 'string', 'example' => 'd-umns******zij4szhc', 'readOnly' => true], + 'Uri' => ['title' => '统一资源识别码', 'description' => '数据源 OSS 的路径。与 DatasetId 二选一。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], + 'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径。', 'type' => 'string', 'example' => '/mnt/data', 'readOnly' => true], ], + 'description' => '', ], ], - 'RunTimeout' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'RunTimeout' => ['description' => '在运行时上执行的单次测试运行的超时，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '180'], 'CredentialConfig' => [ + 'description' => '凭据配置。', 'type' => 'object', 'properties' => [ - 'EnableCredentialInject' => [ - 'title' => '是否启用Credential注入', - 'description' => '是否启用Credential注入', - 'type' => 'boolean', - 'readOnly' => true, - ], - 'AliyunEnvRoleKey' => [ - 'title' => 'AliyunEnvRoleKey', - 'description' => 'AliyunEnvRoleKey', - 'type' => 'string', - 'readOnly' => true, - ], + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否开启 Credential 注入。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => '环境变量角色 Key。', 'type' => 'string', 'example' => '0', 'readOnly' => true], 'CredentialConfigItems' => [ 'title' => 'Credential配置项列表', - 'description' => 'Credential配置项列表', + 'description' => 'Credential 配置列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => 'Key', - 'description' => 'Key', - 'type' => 'string', - 'readOnly' => true, - ], - 'Type' => [ - 'title' => 'Type', - 'description' => 'Type', - 'type' => 'string', - 'readOnly' => true, - ], + 'Key' => ['title' => 'Key', 'description' => '标识配置的 Key。', 'type' => 'string', 'example' => '0', 'readOnly' => true], + 'Type' => ['title' => 'Type', 'description' => '配置类型。可选值包括：'."\n" + .'* Role：角色扮演'."\n" + .'* RoleChain：角色链扮演', 'type' => 'string', 'example' => 'Role', 'readOnly' => true], 'Roles' => [ 'title' => '角色列表', - 'description' => '角色列表', + 'description' => '配置的角色列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AssumeRoleFor' => [ - 'title' => 'AssumeRoleFor', - 'description' => 'AssumeRoleFor', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleType' => [ - 'title' => '角色类型', - 'description' => '角色类型', - 'type' => 'string', - 'readOnly' => true, - ], - 'RoleArn' => [ - 'title' => '角色名称', - 'description' => '角色名称', - 'type' => 'string', - 'readOnly' => true, - ], + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => '扮演角色的所属主体。', 'type' => 'string', 'example' => '1095******785714', 'readOnly' => true], + 'RoleType' => ['title' => '角色类型', 'description' => '扮演的角色类型。可选值包括：'."\n" + .'* service：由服务扮演'."\n" + .'* user：由普通用户账号扮演', 'type' => 'string', 'example' => 'service', 'readOnly' => true], + 'RoleArn' => ['title' => '角色名称', 'description' => '角色 ARN。', 'type' => 'string', 'example' => 'acs:ram::1095******785714:role/testrole', 'readOnly' => true], ], 'readOnly' => true, + 'description' => '', ], 'readOnly' => true, ], ], 'readOnly' => true, + 'description' => '', ], 'readOnly' => true, ], ], ], - 'SupportSSEStream' => [ - 'type' => 'boolean', - ], - 'WorkDir' => [ - 'type' => 'string', - ], - 'Flows' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FlowId' => [ - 'title' => '应用流ID', - 'description' => '应用流ID', - 'type' => 'string', - 'readOnly' => true, - ], - 'FlowName' => [ - 'title' => '应用流名称', - 'description' => '应用流名称', - 'type' => 'string', - 'readOnly' => true, - ], - ], - ], - ], - 'Version' => [ - 'type' => 'string', - ], - 'LatestVersion' => [ - 'type' => 'string', - ], - 'MCPConfig' => [ - 'type' => 'string', - ], - 'RuntimeLog' => [ - 'type' => 'string', - ], + 'WorkDir' => ['description' => '工作目录的OSS路径。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'Version' => ['description' => '运行时镜像版本。', 'type' => 'string', 'example' => '2.0.0'], + 'RuntimeLog' => ['description' => '运行时的日志。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/runtime/1.log'], + 'AutoUpdateImage' => ['description' => '是否自动更新镜像。当有新的镜像版本可用时，系统在业务低谷时自动更新运行时的镜像。', 'type' => 'boolean', 'example' => 'True'], ], ], 'Snapshot' => [ + 'description' => '快照详情。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'SnapshotId' => [ - 'type' => 'string', - ], - 'SnapshotName' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'SnapshotResourceType' => [ - 'type' => 'string', - ], - 'SnapshotResourceId' => [ - 'type' => 'string', - ], - 'CreationType' => [ - 'type' => 'string', - ], - 'SnapshotStoragePath' => [ - 'type' => 'string', - ], - 'WorkDir' => [ - 'type' => 'string', - ], - 'SnapshotUrl' => [ - 'type' => 'string', - ], - ], - ], - 'Toolset' => [ - 'type' => 'object', - 'properties' => [ - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'Accessibility' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'GmtCreateTime' => [ - 'type' => 'string', - ], - 'GmtModifiedTime' => [ - 'type' => 'string', - ], - 'ToolsetId' => [ - 'type' => 'string', - ], - 'ToolsetName' => [ - 'type' => 'string', - ], - 'ToolsetType' => [ - 'type' => 'string', - ], - 'ToolsetConfig' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'Tools' => [ - 'type' => 'string', - ], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'example' => '478**'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2680******4103'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z'], + 'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 'snap-qhn3******b369c0vo'], + 'SnapshotName' => ['description' => '快照名称。', 'type' => 'string', 'example' => 'name01'], + 'Description' => ['description' => '快照描述。', 'type' => 'string', 'example' => 'This is description'], + 'SnapshotResourceType' => ['description' => '快照资源类型。取值：'."\n" + .'* Flow：工作流', 'type' => 'string', 'example' => 'Flow'], + 'SnapshotResourceId' => ['description' => '快照资源ID。', 'type' => 'string', 'example' => 'flow-6rymo******m7j0z4p'], + 'CreationType' => ['description' => '快照的创建类型。取值：'."\n" + .'* ManualCreated：手动创建'."\n" + .'* DeploymentAutoCreated: 部署服务自动创建'."\n" + .'* EvaluationAutoCreated: 评测任务自动创建', 'type' => 'string', 'example' => 'ManualCreated'], + 'SnapshotStoragePath' => ['description' => '存储快照源文件的 OSS 路径。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src'], + 'WorkDir' => ['description' => '存储快照的 OSS 工作目录。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'SnapshotUrl' => ['description' => '快照下载地址。', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile'], + 'SnapshotStatus' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], ], ], 'UserVpc' => [ 'description' => '用户VPC信息。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => '用户VPC的ID', - 'description' => '用户VPC的ID', - 'type' => 'string', - 'example' => 'vpc-m5ec******44cn', - ], - 'VSwitchId' => [ - 'title' => '用户交换机的ID', - 'description' => '用户交换机的ID', - 'type' => 'string', - 'example' => 'vsw-hp32******z9qo', - ], - 'SecurityGroupId' => [ - 'title' => '用户安全组的ID', - 'description' => '用户安全组的ID', - 'type' => 'string', - 'example' => 'sg-bp1f******iy9h', - ], + 'VpcId' => ['title' => '用户VPC的ID', 'description' => '用户VPC的ID', 'type' => 'string', 'example' => 'vpc-m5ec******44cn'], + 'VSwitchId' => ['title' => '用户交换机的ID', 'description' => '用户交换机的ID', 'type' => 'string', 'example' => 'vsw-hp32******z9qo'], + 'SecurityGroupId' => ['title' => '用户安全组的ID', 'description' => '用户安全组的ID', 'type' => 'string', 'example' => 'sg-bp1f******iy9h'], ], ], ], ], 'apis' => [ - 'CreateKnowledgeBase' => [ - 'summary' => '创建一个知识库。', - 'path' => '/api/v1/langstudio/knowledgebases', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDeployment' => [ + 'summary' => '创建部署任务。', + 'path' => '/api/v1/langstudio/deployments', + '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' => [ [ @@ -2876,40 +967,140 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], 'Accessibility' => [ 'description' => '工作空间可见性，可能值为：'."\n" .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'required' => false, - 'example' => 'PUBLIC', + 'example' => 'PRIVATE', 'default' => 'PUBLIC', - 'enum' => [ - 'PUBLIC', - 'PRIVATE', + 'enum' => ['PUBLIC', 'PRIVATE'], + ], + 'ResourceType' => ['description' => '待部署的资源类型。取值：'."\n" + .'* Flow: 工作流的项目'."\n" + .'* Code: 代码模式的项目', 'type' => 'string', 'required' => false, 'example' => 'Flow'], + 'ResourceId' => ['description' => '待部署的资源ID。', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123'], + 'ResourceSnapshotId' => ['description' => '待部署资源的快照 ID。若提供该参数，系统将直接基于该快照进行部署；若未提供，系统会先为资源创建新快照，再执行部署。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], + 'ServiceName' => ['description' => '服务名字。格式要求：'."\n" + .'* 支持小写字母、数字和下划线'."\n" + .'* 必须以字母开头'."\n" + .'* 长度1-45个字符', 'type' => 'string', 'required' => false, 'example' => 'myservice01'], + 'Description' => ['description' => '服务描述。', 'type' => 'string', 'required' => false, 'example' => 'This is description'], + 'EnableTrace' => ['description' => '是否启用链路追踪。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'ChatHistoryConfig' => [ + 'description' => '对话历史配置。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类型', + 'description' => '存储方式。取值：'."\n" + .'* LOCAL: 对话历史保存在本地SQLite文件，不支持多实例的部署方式。'."\n" + .'* OSS：对话历史保存在服务OSS工作路径下特定的路径下。'."\n" + .'* RDS：对话历史保存在RDS的表中，需要指定一个RDS连接。', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + 'readOnly' => true, + 'enum' => ['LOCAL', 'RDS', 'OSS'], + ], + 'ConnectionName' => ['title' => '连接名称', 'description' => '连接名称。对话历史存储方式为RDS的时候需要指定该参数。', 'type' => 'string', 'required' => false, 'example' => 'rdsconnection', 'readOnly' => true], ], + 'required' => false, ], - 'Name' => [ - 'description' => '知识库的名称。命名规则如下：'."\n" - .'- 可以包含字母、数字或下划线（_）。'."\n" - .'- 以字母开头。'."\n" - .'- 长度为1~127个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'myName', + 'WorkDir' => ['description' => '服务的OSS工作目录。用于存储服务的运行日志、对话历史等。', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'ContentModerationConfig' => [ + 'description' => '内容审核配置。', + 'type' => 'object', + 'properties' => [ + 'EnableInputModeration' => ['title' => '启用输入内容审查', 'description' => '是否启用对输入的安全审查。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => '启用输出内容审查', 'description' => '是否启用对输出的内容审查。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => '流式输出内容送审缓存大小', 'description' => '流式输出内容送审缓存大小，默认为5。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'readOnly' => true], + ], + 'required' => false, ], - 'Description' => [ - 'description' => '对知识库进行自定义描述。', + 'DeploymentConfig' => ['description' => '部署配置。具体参考PAI-EAS的[部署配置](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services)。', '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\\"}}}'], + 'AutoApproval' => ['description' => '是否自动跳过部署确认环节。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DeploymentId' => ['description' => '部署记录ID。'."\n", 'type' => 'string', 'example' => 'dploy-asdf******1234'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeploymentId\\": \\"dploy-asdf******1234\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '创建部署任务', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateKnowledgeBase' => [ + 'summary' => '创建一个知识库。', + 'path' => '/api/v1/langstudio/knowledgebases', + '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' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '478**'], + 'Accessibility' => [ + 'description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'required' => false, - 'example' => 'This is a description of the knowledge base.', + 'example' => 'PUBLIC', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], ], + 'Name' => ['description' => '知识库的名称。命名规则如下：'."\n" + .'- 可以包含字母、数字或下划线（_）。'."\n" + .'- 以字母开头。'."\n" + .'- 长度为1~127个字符。', 'type' => 'string', 'required' => true, 'example' => 'myName'], + 'Description' => ['description' => '对知识库进行自定义描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.'], 'KnowledgeBaseType' => [ 'description' => '知识库类型。支持以下取值：'."\n" .'- TEXT：文档。'."\n" @@ -2918,36 +1109,20 @@ .'- VIDEO：视频。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'STRUCTURED' => 'STRUCTURED', - 'IMAGE' => 'IMAGE', - 'VIDEO' => 'VIDEO', - 'TEXT' => 'TEXT', - ], + 'enumValueTitles' => ['STRUCTURED' => 'STRUCTURED', 'IMAGE' => 'IMAGE', 'VIDEO' => 'VIDEO', 'TEXT' => 'TEXT'], 'example' => 'TEXT', ], - 'OutputDir' => [ - 'description' => '输出数据的存储路径。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - ], + 'OutputDir' => ['description' => '输出数据的存储路径。', 'type' => 'string', 'required' => true, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/'], 'DataSources' => [ 'description' => '数据源。', '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' => '源文件存储路径。', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], ], 'required' => false, + 'description' => '', ], 'required' => true, ], @@ -2955,44 +1130,12 @@ 'description' => '文件切片配置。', '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' => '分块策略。支持的策略如下：'."\n" - .'- Default。系统默认切片策略。'."\n" - .'- Asr。按音频内容切分，视频知识库有效。', - 'type' => 'string', - 'required' => false, - 'example' => 'Default', - 'readOnly' => true, - 'default' => 'Default', - ], + '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' => '分块策略。支持的策略如下：'."\n" + .'- Default。系统默认切片策略。'."\n" + .'- Asr。按音频内容切分，视频知识库有效。', 'type' => 'string', 'required' => false, 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], ], 'required' => true, ], @@ -3000,31 +1143,17 @@ 'description' => '向量索引配置。', 'type' => 'object', 'properties' => [ - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => '索引服务连接ID。如何获取连接ID请参见[ListConnections](~~2922801~~)。'."\n" - .'各类型知识库支持的连接类型如下：'."\n" - .'- 文档：百炼大模型服务、通用Embedding模型服务、AI搜索开放平台模型服务。'."\n" - .'- 结构化数据：百炼大模型服务、通用Embedding模型服务、AI搜索开放平台模型服务。'."\n" - .'- 图片：百炼大模型服务、通用多模态Embedding模型服务。'."\n" - .'- 视频：百炼大模型服务。', - 'type' => 'string', - 'required' => true, - 'example' => 'conn-r3o7******38bh', - 'readOnly' => true, - ], - 'Model' => [ - 'title' => '模型', - 'description' => '模型名称。特别的，当选择百炼大模型服务时，各类型知识库支持的模型如下：'."\n" - .'- 文档：text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4'."\n" - .'- 结构化数据：text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4'."\n" - .'- 图片：multimodal-embedding-v1'."\n" - .'- 视频：qwen2.5-vl-embedding', - 'type' => 'string', - 'required' => true, - 'example' => 'text-embedding-v4', - 'readOnly' => true, - ], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '索引服务连接ID。如何获取连接ID请参见[ListConnections](~~2922801~~)。'."\n" + .'各类型知识库支持的连接类型如下：'."\n" + .'- 文档：百炼大模型服务、通用Embedding模型服务、AI搜索开放平台模型服务。'."\n" + .'- 结构化数据：百炼大模型服务、通用Embedding模型服务、AI搜索开放平台模型服务。'."\n" + .'- 图片：百炼大模型服务、通用多模态Embedding模型服务。'."\n" + .'- 视频：百炼大模型服务。', 'type' => 'string', 'required' => true, 'example' => 'conn-r3o7******38bh', 'readOnly' => true], + 'Model' => ['title' => '模型', 'description' => '模型名称。特别的，当选择百炼大模型服务时，各类型知识库支持的模型如下：'."\n" + .'- 文档：text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4'."\n" + .'- 结构化数据：text-embedding-v1、text-embedding-v2、text-embedding-v3、text-embedding-v4'."\n" + .'- 图片：multimodal-embedding-v1'."\n" + .'- 视频：qwen2.5-vl-embedding', 'type' => 'string', 'required' => true, 'example' => 'text-embedding-v4', 'readOnly' => true], ], 'required' => true, ], @@ -3040,39 +1169,16 @@ .'- Faiss（仅文档和结构化数据知识库支持）', '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' => '向量数据库连接ID。如何获取连接ID请参见[ListConnections](~~2922801~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'conn-7y5y******jja7', - 'readOnly' => true, - ], - 'CollectionName' => [ - 'title' => 'Collection名称', - 'description' => '向量库的表或集合名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'my_collection', - 'readOnly' => true, - ], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '向量数据库连接ID。如何获取连接ID请参见[ListConnections](~~2922801~~)。', 'type' => 'string', 'required' => false, 'example' => 'conn-7y5y******jja7', 'readOnly' => true], + 'CollectionName' => ['title' => 'Collection名称', 'description' => '向量库的表或集合名称。', 'type' => 'string', 'required' => false, 'example' => 'my_collection', 'readOnly' => true], ], 'required' => true, ], - 'RuntimeId' => [ - 'description' => '运行时ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rtime-apje******beaz', - ], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz'], 'MetaDataConfig' => [ 'description' => '元数据配置。', 'type' => 'object', @@ -3084,22 +1190,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据字段名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'author', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据字段类型。目前只支持String类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'String', - ], + 'Key' => ['title' => '元数据Key', 'description' => '元数据字段名称。', 'type' => 'string', 'required' => false, 'example' => 'author'], + 'ValueType' => ['title' => '元数据Value类型', 'description' => '元数据字段类型。目前只支持String类型。', 'type' => 'string', 'required' => false, 'example' => 'String'], ], 'required' => false, + 'description' => '', ], 'required' => false, ], @@ -3117,17 +1212,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], ], 'required' => false, 'readOnly' => true, + 'description' => '', ], 'required' => false, 'readOnly' => true, @@ -3139,17 +1228,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'required' => false, - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], ], 'required' => false, 'readOnly' => true, + 'description' => '', ], 'required' => false, 'readOnly' => true, @@ -3161,17 +1244,355 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'required' => false, 'example' => 'column1', 'readOnly' => true], + ], + 'required' => false, + 'readOnly' => true, + 'description' => '', + ], + 'required' => false, + 'readOnly' => true, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '知识库所属的工作空间 ID。', 'type' => 'string', 'example' => '478**'], + 'KnowledgeBaseId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'd-ksicx823d'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + 'title' => '创建知识库', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateKnowledgeBaseJob' => [ + 'summary' => '创建知识库任务。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', + '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' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '478**'], + 'Accessibility' => [ + 'description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', + 'type' => 'string', + 'required' => false, + 'example' => 'PUBLIC', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], + ], + 'Description' => ['description' => '知识库任务描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.'], + 'JobAction' => ['description' => '任务操作类型。'."\n" + .'- SyncIndex：更新知识库索引', 'type' => 'string', 'required' => false, 'example' => 'SyncIndex'], + 'MaxRunningTimeInSeconds' => ['description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'], + 'ResourceId' => ['description' => '资源组ID。为空或public-cluster表示公共资源。', 'type' => 'string', 'required' => false, 'example' => 'quota89**76'], + 'EcsSpecs' => [ + 'description' => '任务运行资源配置列表。文档和结构化知识库仅包含1个元素且**Type**为Worker，图片和视频知识库含2个元素且**Type**分别为Head和Worker。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的取值为Head和Worker。', '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' => '内存大小，单位GB。使用资源配额须填写。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存容量，单位GB。使用资源配额须填写。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型', 'type' => 'string', 'required' => false, 'example' => '16', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU驱动版本。', 'type' => 'string', 'required' => false, 'example' => '535.161.08', 'readOnly' => true], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'UserVpc' => [ + 'description' => '任务运行VPC信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'required' => false, 'example' => 'sg-wz9i****1129', 'readOnly' => true], + ], + 'required' => false, + ], + 'EmbeddingConfig' => [ + 'description' => '索引配置。', + 'type' => 'object', + 'properties' => [ + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'readOnly' => true], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseJobId' => ['description' => '知识库任务ID。', 'type' => 'string', 'example' => 'kbjob-9mn******1z54'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9mn******1z54\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '创建知识库任务', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateRuntime' => [ + 'summary' => '创建一个运行时', + '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' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'description' => '工作空间可见性，可能值为：'."\n" + .'* PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'* PUBLIC：在此工作空间中，对所有人可见。', + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], + ], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '174***'], + 'RuntimeName' => ['description' => '运行时的名称。格式要求：'."\n" + .'* 只能包含英文字母、数字和下划线（_）。'."\n" + .'* 以字母开头。'."\n" + .'* 长度为 1~256 个字符。', 'type' => 'string', 'required' => false, 'example' => 'dev01'], + 'RuntimeType' => [ + 'description' => '运行时类型。取值：'."\n" + .'* DSW：PAI-DSW实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'DSW', + 'default' => 'DSW', + 'enum' => ['DSW'], + ], + 'EcsSpec' => [ + 'description' => 'ECS资源配置。', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => ['title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。取值如下：'."\n" + .'* V100'."\n" + .'* A100'."\n" + .'* T4'."\n" + .'* A10'."\n" + .'* P100', 'type' => 'string', 'required' => false, 'example' => 'V100', 'readOnly' => true], + 'CPU' => ['title' => 'CPU数量', 'description' => 'CPU数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU数量', 'description' => 'GPU数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'readOnly' => true], + 'Memory' => ['title' => '内存信息', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存', 'description' => '共享内存，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU驱动版本。', 'type' => 'string', 'required' => false, 'example' => '535.161.08', 'readOnly' => true], + ], + 'required' => false, + ], + 'ResourceId' => ['description' => '资源配额ID。', 'type' => 'string', 'required' => false, 'example' => 'quota18******zv9'], + 'UserVpc' => [ + 'description' => '用户VPC配置。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'VPC ID', 'description' => '专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'required' => false, 'example' => 'sg-wz9i****1129', 'readOnly' => true], + 'DefaultRoute' => ['title' => '默认路由', 'description' => '默认路由。', 'type' => 'string', 'required' => false, 'example' => 'eth0', 'readOnly' => true], + 'ExtendedCIDRs' => [ + 'title' => '扩展网段', + 'description' => '扩展网段。', + 'type' => 'array', + 'items' => ['description' => '扩展网段。', 'type' => 'string', 'required' => false, 'example' => '172.16.1.0/24', 'readOnly' => true], + 'required' => false, + 'readOnly' => true, + ], + ], + 'required' => false, + ], + 'Envs' => [ + 'description' => '环境变量。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '环境键', 'description' => '环境键。', 'type' => 'string', 'required' => false, 'example' => 'testKey1', 'readOnly' => true], + 'Value' => ['title' => '环境值', 'description' => '环境值。', 'type' => 'string', 'required' => false, 'example' => 'testValue1', 'readOnly' => true], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'Labels' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'testKey1', 'readOnly' => true], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'testValue1', 'readOnly' => true], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'DataSources' => [ + 'description' => '挂载数据源。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID。与Uri二选一。', 'type' => 'string', 'required' => false, 'example' => 'd-umns******zij4szhc', 'readOnly' => true], + 'Uri' => ['title' => '统一资源识别码', 'description' => '数据源OSS的路径。与DatasetId二选一。', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], + 'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径。', 'type' => 'string', 'required' => false, 'example' => '/mnt/data', 'readOnly' => true], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + 'CredentialConfig' => [ + 'description' => '凭据配置。', + 'type' => 'object', + 'properties' => [ + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否开启 Credential 注入。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'readOnly' => true], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => '环境变量角色 Key。', 'type' => 'string', 'required' => false, 'example' => '0', 'readOnly' => true], + 'CredentialConfigItems' => [ + 'title' => 'Credential配置项列表', + 'description' => 'Credential配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'Key', 'description' => '标识配置的 Key。', 'type' => 'string', 'required' => false, 'example' => '0', 'readOnly' => true], + 'Type' => ['title' => 'Type', 'description' => '配置类型。可选值包括：'."\n" + .'* Role：角色扮演'."\n" + .'* RoleChain：角色链扮演', 'type' => 'string', 'required' => false, 'example' => 'Role', 'readOnly' => true], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '配置的角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '角色信息。', + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => '扮演角色的所属主体。', 'type' => 'string', 'required' => false, 'example' => '1095******785714', 'readOnly' => true], + 'RoleType' => ['title' => '角色类型', 'description' => '扮演的角色类型。可选值包括：'."\n" + .'* service：由服务扮演；'."\n" + .'* user：由普通用户账号扮演', 'type' => 'string', 'required' => false, 'example' => 'service', 'readOnly' => true], + 'RoleArn' => ['title' => '角色名称', 'description' => '角色ARN。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1095******785714:role/testrole', 'readOnly' => true], + ], + 'required' => false, + 'readOnly' => true, + ], 'required' => false, - 'example' => 'column1', 'readOnly' => true, ], ], 'required' => false, 'readOnly' => true, + 'description' => '', ], 'required' => false, 'readOnly' => true, @@ -3179,6 +1600,9 @@ ], 'required' => false, ], + 'RunTimeout' => ['description' => '在运行时上执行的单次测试的超时，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180'], + 'WorkDir' => ['description' => '工作目录的OSS路径。', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'AutoUpdateImage' => ['type' => 'boolean'], ], 'required' => false, ], @@ -3187,282 +1611,690 @@ 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '知识库所属的工作空间 ID。', + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'example' => 'rtime-apje******beaz'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RuntimeId\\": \\"rtime-apje******beaz\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '创建运行时', + 'description' => '请确保在使用该接口前，已充分了解PAI-DSW产品的收费方式和[价格](https://help.aliyun.com/zh/pai/dsw-billing-description?spm=a2c4g.11186623.help-menu-30347.d_1_1_3.fb4453d9l200bE)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateSnapshot' => [ + 'summary' => '创建一个快照。', + 'path' => '/api/v1/langstudio/snapshots', + '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' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Accessibility' => [ + 'description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', - 'example' => '478**', + 'required' => false, + 'example' => 'PRIVATE', + 'default' => 'PUBLIC', + 'enum' => ['PUBLIC', 'PRIVATE'], ], - 'KnowledgeBaseId' => [ - 'description' => '知识库ID。', + 'CreationType' => [ + 'description' => '快照的创建类型。取值：'."\n" + .'* ManualCreated：手动创建'."\n" + .'* DeploymentAutoCreated: 部署服务自动创建'."\n" + .'* EvaluationAutoCreated: 评测任务自动创建', 'type' => 'string', - 'example' => 'd-ksicx823d', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', + 'required' => false, + 'example' => 'ManualCreated', + 'enum' => ['ManualCreated', 'DeploymentAutoCreated', 'EvaluationAutoCreated'], + ], + 'SnapshotName' => ['description' => '快照名称。格式要求：'."\n" + .'* 只能包含英文字母、数字和下划线（_）'."\n" + .'* 必须以字母开头'."\n" + .'* 长度为 1~256 个字符', 'type' => 'string', 'required' => false, 'example' => 'snapshot01'], + 'Description' => ['description' => '快照的描述。', 'type' => 'string', 'required' => false, 'example' => 'This is description'], + 'WorkDir' => ['description' => '存储快照的OSS工作目录。', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '174***'], + 'SnapshotResourceType' => [ + 'description' => '快照资源类型。取值：'."\n" + .'* Flow：工作流', 'type' => 'string', - 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6', + 'required' => false, + 'example' => 'Flow', + 'enum' => ['Flow'], ], + 'SnapshotResourceId' => ['description' => '快照资源ID。', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******123'], + 'SourceStoragePath' => ['description' => '从指定的OSS目录下的源文件创建快照。', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/path/to/snapshot/source'], ], + 'required' => false, ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', - 'title' => '创建知识库', - ], - 'GetKnowledgeBase' => [ - 'summary' => '获取知识库。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 'snap-asfg******123'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SnapshotId\\": \\"snap-asfg******123\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '创建快照', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDeployment' => [ + 'summary' => '删除部署任务。', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'path', + 'schema' => ['description' => '部署任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234'], + ], ], - 'operationType' => 'read', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '删除部署任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteKnowledgeBase' => [ + 'summary' => '删除知识库。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '478***'], + ], + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '478**', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\"\\n}","type":"json"}]', + 'title' => '删除知识库', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteKnowledgeBaseJob' => [ + 'summary' => '删除知识库任务。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', + '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' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '478***'], + ], [ 'name' => 'KnowledgeBaseId', 'in' => 'path', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2'], + ], + [ + 'name' => 'KnowledgeBaseJobId', + 'in' => 'path', + 'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ksicx823d', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + 'title' => '删除知识库任务', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ [ - 'name' => 'VersionName', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteRuntime' => [ + 'summary' => '删除运行时。', + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + ], + [ + 'name' => 'RuntimeId', + 'in' => 'path', + 'schema' => ['description' => '运行时ID。', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '知识库版本。默认为v1。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '删除运行时', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteSnapshot' => [ + 'summary' => '删除快照。', + 'path' => '/api/v1/langstudio/snapshots/{SnapshotId}', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], - 'WorkspaceId' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'example' => '478**', - ], - 'Accessibility' => [ - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'example' => 'PRIVATE', - ], - 'GmtCreateTime' => [ - 'description' => '知识库创建时间（UTC）。', - 'type' => 'string', - 'example' => '2024-12-15T14:46:23Z', - ], - 'GmtModifiedTime' => [ - 'description' => '知识库修改时间（UTC）。', - 'type' => 'string', - 'example' => '2025-12-18T19:32:58Z', - ], - 'Name' => [ - 'description' => '知识库名称。', - 'type' => 'string', - 'example' => 'myName', - ], - 'KnowledgeBaseId' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'example' => 'd-ksicx823d', - ], - 'Description' => [ - 'description' => '知识库描述。', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base.', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '删除快照', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetDeployment' => [ + 'summary' => '获取部署任务详情。', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'path', + 'schema' => ['description' => '部署任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '478***'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2003******4844'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z'], + 'DeploymentId' => ['description' => '部署任务ID。', 'type' => 'string', 'example' => 'dploy-asdf******1234'], + 'DeploymentStatus' => ['description' => '部署任务状态。取值：'."\n" + .'* Creating：创建中。'."\n" + .'* Failed：部署失败。'."\n" + .'* Stopping：停止中。'."\n" + .'* Waiting：等待中。'."\n" + .'* Starting：启动中。'."\n" + .'* Running：运行中。'."\n" + .'* Pending：等待中。'."\n" + .'* WaitForConfirm: 等待确认。'."\n" + .'* Canceled：取消。'."\n" + .'* Succeed：成功。', 'type' => 'string', 'example' => 'Succeed'], + 'OperationType' => ['description' => '操作类型。取值：'."\n" + .'* Create： 新建服务。'."\n" + .'* Update： 更新已有服务。', 'type' => 'string', 'example' => 'Create'], + 'ResourceType' => ['description' => '待部署的资源类型。取值：'."\n" + .'* Flow: 工作流的项目'."\n" + .'* Code: 代码模式的项目', 'type' => 'string', 'example' => 'Flow'], + 'ResourceId' => ['description' => '待部署的资源ID。', 'type' => 'string', 'example' => 'flow-asdf******123'], + 'ResourceSnapshotId' => ['description' => '待部署资源的快照 ID。若提供该参数，系统将直接基于该快照进行部署；若未提供，系统会先为资源创建新快照，再执行部署。', 'type' => 'string', 'example' => 'snap-asfg******123'], + 'ServiceName' => ['description' => '服务名字。格式要求：'."\n" + .'* 支持小写字母、数字和下划线'."\n" + .'* 必须以字母开头'."\n" + .'* 长度1-45个字符', 'type' => 'string', 'example' => 'myservice01'], + 'Description' => ['description' => '服务描述。', 'type' => 'string', 'example' => 'This is description'], + 'WorkDir' => ['description' => '服务的OSS工作目录。用于存储服务的运行日志、对话历史等。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'EnableTrace' => ['description' => '是否启用链路追踪。', 'type' => 'boolean', 'example' => 'true'], + 'ChatHistoryConfig' => [ + 'description' => '对话历史配置。', + 'type' => 'object', + 'properties' => [ + 'StorageType' => [ + 'title' => '存储类型', + 'description' => '存储方式。取值：'."\n" + .'* LOCAL: 对话历史保存在本地 SQLite 文件，不支持多实例的部署方式。'."\n" + .'* OSS：对话历史保存在服务 OSS 工作路径下特定的路径下。'."\n" + .'* RDS：对话历史保存在 RDS 的表中，需要指定一个 RDS 连接。', + 'type' => 'string', + 'example' => 'RDS', + 'readOnly' => true, + 'enum' => ['LOCAL', 'RDS', 'OSS'], + ], + 'ConnectionName' => ['title' => '连接名称', 'description' => '连接名称。对话历史存储方式为 RDS 的时候需要指定该参数。', 'type' => 'string', 'example' => 'rdsconnection', 'readOnly' => true], + ], ], - 'KnowledgeBaseType' => [ - 'description' => '知识库类型。'."\n" - .'- TEXT：文档。'."\n" - .'- STRUCTURED：结构化数据。'."\n" - .'- IMAGE：图片。'."\n" - .'- VIDEO：视频。', - 'type' => 'string', - 'example' => 'TEXT', + 'ContentModerationConfig' => [ + 'description' => '内容审核配置。', + 'type' => 'object', + 'properties' => [ + 'EnableInputModeration' => ['title' => '启用输入内容审查', 'description' => '是否启用对输入的安全审查。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'EnableOutputModeration' => ['title' => '启用输出内容审查', 'description' => '是否启用对输出的内容审查。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'StreamingModerationThreshold' => ['title' => '流式输出内容送审缓存大小', 'description' => '流式输出内容送审缓存大小，默认为 5。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], + ], ], - 'DatasetId' => [ - 'description' => '知识库对应的数据集ID。', - 'type' => 'string', - 'example' => 'd-cupbwkk5us9xpjz870', + 'DeploymentConfig' => ['description' => '部署配置。具体参考 PAI-EAS 的[部署配置](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services)。', '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\\"}}}'], + 'DeploymentStages' => [ + 'description' => '部署的阶段信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Stage' => ['title' => '阶段', 'description' => '部署阶段。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'StageName' => ['title' => '阶段名称', 'description' => '部署阶段名称。', 'type' => 'string', 'example' => 'PrepareSnapshot', 'readOnly' => true], + 'Description' => ['title' => '描述', 'description' => '部署阶段描述。', 'type' => 'string', 'example' => 'Create snapshot for deployment', 'readOnly' => true], + 'GmtStartTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'string', 'example' => '2025-09-23T10:25:38+08:00', 'readOnly' => true], + 'GmtEndTime' => ['title' => '结束时间', 'description' => '结束时间。', 'type' => 'string', 'example' => '2025-09-23T10:35:38+08:00', 'readOnly' => true], + 'StageStatus' => ['title' => '阶段状态', 'description' => '部署阶段状态。取值：'."\n" + .'* NotStarted： 未开始。'."\n" + .'* WaitForConfirm：等待确认。'."\n" + .'* Waiting： 等待中。'."\n" + .'* Creating： 创建中。'."\n" + .'* Running： 运行中。'."\n" + .'* Succeed： 成功。'."\n" + .'* Failed： 失败。'."\n" + .'* Canceled：取消。', 'type' => 'string', 'example' => 'Running', 'readOnly' => true], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'This is error', 'readOnly' => true], + 'StageInfo' => ['title' => '阶段信息', 'description' => '部署阶段信息。', 'type' => 'string', 'example' => '{\\"SnapshotId\\":\\"snap-i8j29kw8nubqb0hotn\\"}', 'readOnly' => true], + ], + 'description' => '', + ], ], + 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'This is error message'], + 'AutoApproval' => ['description' => '是否自动跳过部署确认环节。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + '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"}]', + 'title' => '获取部署任务详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetKnowledgeBase' => [ + 'summary' => '获取知识库。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', + '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' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '478**'], + ], + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-ksicx823d'], + ], + [ + 'name' => 'VersionName', + 'in' => 'query', + 'schema' => ['description' => '知识库版本。默认为v1。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'example' => '478**'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'GmtCreateTime' => ['description' => '知识库创建时间（UTC）。', 'type' => 'string', 'example' => '2024-12-15T14:46:23Z'], + 'GmtModifiedTime' => ['description' => '知识库修改时间（UTC）。', 'type' => 'string', 'example' => '2025-12-18T19:32:58Z'], + 'Name' => ['description' => '知识库名称。', 'type' => 'string', 'example' => 'myName'], + 'KnowledgeBaseId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'd-ksicx823d'], + 'Description' => ['description' => '知识库描述。', 'type' => 'string', 'example' => 'This is a description of the knowledge base.'], + 'KnowledgeBaseType' => ['description' => '知识库类型。'."\n" + .'- TEXT：文档。'."\n" + .'- STRUCTURED：结构化数据。'."\n" + .'- IMAGE：图片。'."\n" + .'- VIDEO：视频。', 'type' => 'string', 'example' => 'TEXT'], + 'DatasetId' => ['description' => '知识库对应的数据集ID。', 'type' => 'string', 'example' => 'd-cupbwkk5us9xpjz870'], 'DataSources' => [ 'description' => '数据源。', '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, - ], + 'Uri' => ['title' => '统一资源识别码', 'description' => '源文件存储路径。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], ], + 'description' => '', ], ], - 'OutputDir' => [ - 'description' => '输出数据的存储路径。', - 'type' => 'string', - 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/', - ], + 'OutputDir' => ['description' => '输出数据的存储路径。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/'], 'ChunkConfig' => [ 'description' => '文件切片配置。', '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' => '分块策略。策略类型如下：'."\n" - .'- Default。系统默认切片策略。'."\n" - .'- Asr。按音频内容切分，视频知识库有效。', - 'type' => 'string', - 'example' => 'Default', - 'readOnly' => true, - 'default' => 'Default', - ], + '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' => '分块策略。策略类型如下：'."\n" + .'- Default。系统默认切片策略。'."\n" + .'- Asr。按音频内容切分，视频知识库有效。', 'type' => 'string', 'example' => 'Default', 'readOnly' => true, 'default' => 'Default'], ], ], 'EmbeddingConfig' => [ 'description' => '向量索引配置。', 'type' => 'object', 'properties' => [ - 'ConnectionName' => [ - 'title' => 'Embedding连接名称', - 'description' => '索引服务连接名称。', - 'type' => 'string', - 'example' => 'myEmbeddingConn', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => '索引服务连接ID。', - 'type' => 'string', - 'example' => 'conn-r3o7******38bh', - ], - 'Model' => [ - 'title' => '模型', - 'description' => '模型名称。', - 'type' => 'string', - 'example' => 'text-embedding-v4', - ], + 'ConnectionName' => ['title' => 'Embedding连接名称', 'description' => '索引服务连接名称。', 'type' => 'string', 'example' => 'myEmbeddingConn'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '索引服务连接ID。', 'type' => 'string', 'example' => 'conn-r3o7******38bh'], + 'Model' => ['title' => '模型', 'description' => '模型名称。', 'type' => 'string', 'example' => 'text-embedding-v4'], ], ], 'VectorDBConfig' => [ 'description' => '向量库配置。', 'type' => 'object', 'properties' => [ - 'VectorDBType' => [ - 'title' => 'VectorDB类型', - 'description' => '向量数据库类型。支持以下取值：'."\n" - .'- Elasticsearch'."\n" - .'- Milvus'."\n" - .'- Faiss', - 'type' => 'string', - 'example' => 'Milvus', - ], - 'ConnectionName' => [ - 'title' => 'VectorDB连接名称', - 'description' => '向量数据库连接名称。', - 'type' => 'string', - 'example' => 'myVectorConn', - ], - 'ConnectionId' => [ - 'title' => 'Embedding连接ID', - 'description' => '向量数据库连接ID。', - 'type' => 'string', - 'example' => 'conn-7y5y******jja7', - ], - 'CollectionName' => [ - 'title' => 'Collection名称', - 'description' => '向量数据库表或集合名称。', - 'type' => 'string', - 'example' => 'my_collection', - ], + 'VectorDBType' => ['title' => 'VectorDB类型', 'description' => '向量数据库类型。支持以下取值：'."\n" + .'- Elasticsearch'."\n" + .'- Milvus'."\n" + .'- Faiss', 'type' => 'string', 'example' => 'Milvus'], + 'ConnectionName' => ['title' => 'VectorDB连接名称', 'description' => '向量数据库连接名称。', 'type' => 'string', 'example' => 'myVectorConn'], + 'ConnectionId' => ['title' => 'Embedding连接ID', 'description' => '向量数据库连接ID。', 'type' => 'string', 'example' => 'conn-7y5y******jja7'], + 'CollectionName' => ['title' => 'Collection名称', 'description' => '向量数据库表或集合名称。', 'type' => 'string', 'example' => 'my_collection'], ], ], - 'Creator' => [ - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '2485765****023475', - ], - 'RuntimeId' => [ - 'description' => '运行时ID。', - 'type' => 'string', - 'example' => 'rtime-apje******beaz', - ], + 'Creator' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '2485765****023475'], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'example' => 'rtime-apje******beaz'], 'MetaDataConfig' => [ 'description' => '元数据配置。', 'type' => 'object', @@ -3475,34 +2307,10 @@ 'description' => '自定义元数据。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据字段名称。', - 'type' => 'string', - 'example' => 'author', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据字段类型。', - 'type' => 'string', - 'example' => 'String', - ], - 'ReferenceCount' => [ - 'title' => '引用次数', - 'description' => '引用次数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'readOnly' => true, - ], - 'ValueCount' => [ - 'title' => '值的个数', - 'description' => '值的个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'readOnly' => true, - ], + 'Key' => ['title' => '元数据Key', 'description' => '元数据字段名称。', 'type' => 'string', 'example' => 'author'], + 'ValueType' => ['title' => '元数据Value类型', 'description' => '元数据字段类型。', 'type' => 'string', 'example' => 'String'], + 'ReferenceCount' => ['title' => '引用次数', 'description' => '引用次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'readOnly' => true], + 'ValueCount' => ['title' => '值的个数', 'description' => '值的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'readOnly' => true], ], ], ], @@ -3518,54 +2326,22 @@ .'- Enable: 开启自动更新。'."\n" .'- Disable: 关闭自动更新。', 'type' => 'string', - 'enumValueTitles' => [ - 'Enable' => 'Enable', - 'Disable' => 'Disable', - ], + 'enumValueTitles' => ['Enable' => 'Enable', 'Disable' => 'Disable'], 'example' => 'Enable', 'default' => 'Disable', ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。为空或public-cluster表示公共资源。', - 'type' => 'string', - 'example' => 'quota89**76', - ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], + 'ResourceId' => ['title' => '资源组ID', 'description' => '资源组ID。为空或public-cluster表示公共资源。', 'type' => 'string', 'example' => 'quota89**76'], + 'MaxRunningTimeInSeconds' => ['title' => '任务最大运行时间', 'description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], 'EmbeddingConfig' => [ 'title' => 'Embedding配置', 'description' => '向量索引配置。', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '1'], ], ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置。', - '$ref' => '#/components/schemas/UserVpc', - ], + 'UserVpc' => ['title' => '用户VPC配置', 'description' => '用户VPC配置。', '$ref' => '#/components/schemas/UserVpc'], 'EcsSpecs' => [ 'title' => '运行资源配置', 'description' => '运行资源配置列表。', @@ -3574,76 +2350,21 @@ 'description' => '运行资源。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的取值为Head和Worker。', - 'type' => 'string', - 'example' => 'Worker', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称。', - 'type' => 'string', - 'example' => 'ecs.c6.large', - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型。', - 'type' => 'string', - 'example' => 'V100', - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => 'GPU驱动版本。', - 'type' => 'string', - 'example' => '550.127.08', - ], + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的取值为Head和Worker。', 'type' => 'string', 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '机型名称', 'description' => '机型名称。', 'type' => 'string', 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '副本数量', 'description' => '副本数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'example' => 'V100'], + 'CPU' => ['title' => 'CPU核数', 'description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Memory' => ['title' => '内存大小', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '550.127.08'], ], ], ], ], ], - 'VersionName' => [ - 'description' => '知识库版本。默认为v1。', - 'type' => 'string', - 'example' => 'v1', - ], + 'VersionName' => ['description' => '知识库版本。默认为v1。', 'type' => 'string', 'example' => 'v1'], 'IndexColumnConfig' => [ 'description' => '列字段配置。结构化数据类型知识库有效。', 'type' => 'object', @@ -3656,13 +2377,7 @@ 'description' => '向量检索列。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, ], @@ -3676,13 +2391,7 @@ 'description' => '内容过滤列。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, ], @@ -3695,459 +2404,1083 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '列Key', - 'description' => '列名。', - 'type' => 'string', - 'example' => 'column1', - 'readOnly' => true, - ], + 'Key' => ['title' => '列Key', 'description' => '列名。', 'type' => 'string', 'example' => 'column1', 'readOnly' => true], ], 'readOnly' => true, + 'description' => '', ], 'readOnly' => true, ], ], ], ], + 'description' => '', ], ], ], - '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"}]', + '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"}]', 'title' => '获取知识库', - ], - 'UpdateKnowledgeBase' => [ - 'summary' => '更新知识库。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetKnowledgeBaseJob' => [ + 'summary' => '获取知识库任务。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', + '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' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '478***'], + ], + [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'KnowledgeBaseJobId', + 'in' => 'path', + 'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '285773', + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26'], + 'WorkspaceId' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'example' => '478***'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PUBLIC'], + 'Creator' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '2003******4844'], + 'GmtCreateTime' => ['description' => '任务创建时间（UTC）。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '任务更新时间（UTC）。', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z'], + 'KnowledgeBaseId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => 'd-nacr******sxd2'], + 'KnowledgeBaseJobId' => ['description' => '知识库任务ID。', 'type' => 'string', 'example' => 'kbjob-9m******54'], + 'JobAction' => ['description' => '任务操作类型。'."\n" + .'- SyncIndex：更新知识库索引', 'type' => 'string', 'example' => 'UpdateScheduleConfig'], + 'Description' => ['description' => '知识库任务描述。', 'type' => 'string', 'example' => 'This is a description of the knowledge base job.'], + 'Status' => ['description' => '知识库任务状态。'."\n" + .'- Running: 运行中。'."\n" + .'- Success: 运行成功。'."\n" + .'- Failed: 运行失败。', 'type' => 'string', 'example' => 'discovering'], + 'ResourceId' => ['description' => '资源组ID。为空或public-cluster表示公共资源。', 'type' => 'string', 'example' => 'quota89**76'], + 'EcsSpecs' => [ + 'description' => '运行资源配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运行资源配置列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的值为Head和Worker。', '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', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'readOnly' => true], + 'Memory' => ['title' => '内存大小', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => '驱动版本。', 'type' => 'string', 'example' => '550.127.08', 'readOnly' => true], + ], + ], ], - 'Description' => [ - 'description' => '知识库描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base.', + 'UserVpc' => [ + 'description' => '任务运行VPC信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'VPC ID', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23'], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-wz9r****ng10'], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-wz91****e10e'], + ], ], - 'RuntimeId' => [ - 'description' => '运行时ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rtime-231x****tmo4', + 'MaxRunningTimeInSeconds' => ['description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400'], + 'GmtFinishTime' => ['description' => '任务结束时间（UTC）。', 'type' => 'string', 'example' => '2025-02-08T15:45:12Z'], + 'ErrorMessage' => ['description' => '任务出错信息。', 'type' => 'string', 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z'], + 'PipelineRunInfo' => [ + 'description' => '工作流运行信息。', + 'type' => 'object', + 'properties' => [ + 'PipelineRunId' => ['title' => 'PaiFlow工作流运行ID', 'description' => 'PaiFlow工作流运行ID', 'type' => 'string', 'example' => 'flow-fi8z******g4gy', 'readOnly' => true], + ], ], - 'BindRuntime' => [ - 'description' => '是否绑定运行时。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'KnowledgeBaseJobResult' => [ + 'description' => '任务结果。', + 'type' => 'object', + 'properties' => [ + 'TotalFileCount' => ['title' => '总处理文件数', 'description' => '总处理文件数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AddChunkCount' => ['title' => '增加Chunk数量', 'description' => '增加Chunk数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'DeleteChunkCount' => ['title' => '删除Chunk数量', 'description' => '删除Chunk数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + ], ], - 'MetaDataConfig' => [ - 'description' => '元数据配置。', + 'EmbeddingConfig' => [ + 'description' => '索引配置。', 'type' => 'object', 'properties' => [ - 'CustomMetaData' => [ - 'title' => '自定义元数据', - 'description' => '自定义元数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '元数据Key', - 'description' => '元数据字段名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'author', - ], - 'ValueType' => [ - 'title' => '元数据Value类型', - 'description' => '元数据字段类型。目前只支持String类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'String', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'readOnly' => true], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'example' => '2', 'readOnly' => true], ], - 'required' => false, ], - 'AutoUpdateConfig' => [ - 'description' => '知识库自动更新配置。', + ], + 'description' => '', + ], + ], + ], + '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"}]', + 'title' => '获取知识库任务', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetRuntime' => [ + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'RuntimeId', + 'in' => 'path', + 'schema' => ['description' => '运行时ID。', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '478***'], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'example' => 'rtime-apje******beaz'], + 'RuntimeName' => ['description' => '运行时的名称。', 'type' => 'string', 'example' => 'dev01'], + 'RuntimeType' => ['description' => '运行时类型。', 'type' => 'string', 'example' => 'DSW'], + 'RuntimeStatus' => ['description' => '运行时状态。取值：'."\n" + .'* Creating: 创建中'."\n" + .'* SaveFailed: 镜像保存失败'."\n" + .'* Stopped: 已停止'."\n" + .'* Failed: 失败'."\n" + .'* ResourceAllocating:资源分配中'."\n" + .'* Stopping: 停止中'."\n" + .'* Updating: 更新中'."\n" + .'* Saving: 镜像保存中'."\n" + .'* Queuing: 排队中'."\n" + .'* Recovering: 实例恢复中'."\n" + .'* Starting: 创建中'."\n" + .'* Running: 运行中'."\n" + .'* Saved: 镜像保存成功'."\n" + .'* Deleting: 删除中'."\n" + .'* EnvPreparing: 环境准备中', 'type' => 'string', 'example' => 'Running'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:24:36Z'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2680******4103'], + 'Accessibility' => ['description' => '工作空间可见性。', 'type' => 'string', 'example' => 'PRIVATE'], + 'EcsSpec' => [ + 'description' => 'ECS资源配置', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '知识库自动更新状态', - 'description' => '知识库自动更新开关状态。'."\n" - .'- Enable: 开启自动更新。'."\n" - .'- Disable: 关闭自动更新。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - 'default' => 'Disable', - ], - 'ResourceId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID。为空或public-cluster表示公共资源。', - 'type' => 'string', - 'required' => false, - 'example' => 'quota89**76', + 'InstanceType' => ['title' => '实例类型', 'description' => '实例类型。', 'type' => 'string', 'example' => 'ecs.c6.large', 'readOnly' => true], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'example' => 'V100', 'readOnly' => true], + 'CPU' => ['title' => 'CPU数量', 'description' => 'CPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'readOnly' => true], + 'GPU' => ['title' => 'GPU数量', 'description' => 'GPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'readOnly' => true], + 'Memory' => ['title' => '内存信息', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'SharedMemory' => ['title' => '共享内存', 'description' => '共享内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'readOnly' => true], + 'Driver' => ['title' => '驱动版本', 'description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '535.161.08', 'readOnly' => true], + ], + ], + 'ResourceId' => ['description' => '资源配额ID。', 'type' => 'string', 'example' => 'quota18******zv9'], + 'UserVpc' => [ + 'description' => '用户VPC配置。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => ['title' => 'VPC ID', 'description' => '专有网络 ID。', 'type' => 'string', 'example' => 'vpc-wz90****5v23', 'readOnly' => true], + 'VSwitchId' => ['title' => '交换机ID', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-wz9r****ng10', 'readOnly' => true], + 'SecurityGroupId' => ['title' => '安全组ID', 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-wz9i****1129', 'readOnly' => true], + 'DefaultRoute' => ['title' => '默认路由', 'description' => '默认路由。', 'type' => 'string', 'example' => 'eth0', 'readOnly' => true], + 'ExtendedCIDRs' => [ + 'title' => '扩展网段', + 'description' => '扩展网段。', + 'type' => 'array', + 'items' => ['description' => '扩展网段。', 'type' => 'string', 'example' => '172.16.1.0/24', 'readOnly' => true], + 'readOnly' => true, ], - 'MaxRunningTimeInSeconds' => [ - 'title' => '任务最大运行时间', - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', + ], + ], + 'Envs' => [ + 'description' => '环境变量。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '环境键', 'description' => '环境键。', 'type' => 'string', 'example' => 'testKey1', 'readOnly' => true], + 'Value' => ['title' => '环境值', 'description' => '环境值。', 'type' => 'string', 'example' => 'testValue1', 'readOnly' => true], ], - 'EmbeddingConfig' => [ - 'title' => 'Embedding配置', - 'description' => '向量索引配置。', - 'type' => 'object', - 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], - ], - 'required' => false, + 'description' => '', + ], + ], + 'Labels' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'testKey1', 'readOnly' => true], + 'Value' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'testValue1', 'readOnly' => true], ], - 'UserVpc' => [ - 'title' => '用户VPC配置', - 'description' => '用户VPC配置。', - 'required' => false, - '$ref' => '#/components/schemas/UserVpc', + 'description' => '', + ], + ], + 'DataSources' => [ + 'description' => '挂载数据源。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集 ID。与 Uri 二选一。', 'type' => 'string', 'example' => 'd-umns******zij4szhc', 'readOnly' => true], + 'Uri' => ['title' => '统一资源识别码', 'description' => '数据源 OSS 的路径。与 DatasetId 二选一。', 'type' => 'string', 'example' => 'oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/', 'readOnly' => true], + 'MountPath' => ['title' => '挂载路径', 'description' => '挂载路径。', 'type' => 'string', 'example' => '/mnt/data', 'readOnly' => true], ], - 'EcsSpecs' => [ - 'title' => '运行资源配置', - 'description' => '运行资源配置列表。文档和结构化知识库仅包含1个元素且**Type**为Worker，图片和视频知识库含2个元素且**Type**分别为 Head 和 Worker。', + 'description' => '', + ], + ], + 'RunTimeout' => ['description' => '在运行时上执行的单次测试运行的超时，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '180'], + 'CredentialConfig' => [ + 'description' => '凭据配置。', + 'type' => 'object', + 'properties' => [ + 'EnableCredentialInject' => ['title' => '是否启用Credential注入', 'description' => '是否开启 Credential 注入。', 'type' => 'boolean', 'example' => 'true', 'readOnly' => true], + 'AliyunEnvRoleKey' => ['title' => 'AliyunEnvRoleKey', 'description' => '环境变量角色 Key。', 'type' => 'string', 'example' => '0', 'readOnly' => true], + 'CredentialConfigItems' => [ + 'title' => 'Credential配置项列表', + 'description' => 'Credential 配置列表。', 'type' => 'array', 'items' => [ - 'description' => '运行资源。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的取值为Head和Worker。', - 'type' => 'string', - 'required' => false, - 'example' => 'Worker', - 'default' => 'Worker', - ], - 'InstanceType' => [ - 'title' => '机型名称', - 'description' => '机型名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c6.large', - ], - 'PodCount' => [ - 'title' => '副本数量', - 'description' => '副本数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'V100', - ], - 'CPU' => [ - 'title' => 'CPU核数', - 'description' => 'CPU核数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本。', - 'type' => 'string', - 'required' => false, - 'example' => '550.127.08', + 'Key' => ['title' => 'Key', 'description' => '标识配置的 Key。', 'type' => 'string', 'example' => '0', 'readOnly' => true], + 'Type' => ['title' => 'Type', 'description' => '配置类型。可选值包括：'."\n" + .'* Role：角色扮演 '."\n" + .'* RoleChain：角色链扮演', 'type' => 'string', 'example' => 'Role', 'readOnly' => true], + 'Roles' => [ + 'title' => '角色列表', + 'description' => '配置的角色列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AssumeRoleFor' => ['title' => 'AssumeRoleFor', 'description' => '扮演角色的所属主体。', 'type' => 'string', 'example' => '1095******785714', 'readOnly' => true], + 'RoleType' => ['title' => '角色类型', 'description' => '扮演的角色类型。可选值包括：'."\n" + .'* service：由服务扮演'."\n" + .'* user：由普通用户账号扮演', 'type' => 'string', 'example' => 'service', 'readOnly' => true], + 'RoleArn' => ['title' => '角色名称', 'description' => '角色 ARN。', 'type' => 'string', 'example' => 'acs:ram::1095******785714:role/testrole', 'readOnly' => true], + ], + 'readOnly' => true, + 'description' => '', + ], + 'readOnly' => true, ], ], - 'required' => false, + 'readOnly' => true, + 'description' => '', ], - 'required' => false, + 'readOnly' => true, ], ], - 'required' => false, ], + 'WorkDir' => ['description' => '工作目录的OSS路径。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'Version' => ['description' => '运行时镜像版本。', 'type' => 'string', 'example' => '2.0.0'], + 'RuntimeLog' => ['description' => '运行时的日志。', 'type' => 'string', 'example' => 'oss://path/to/log/file'], + 'AutoUpdateImage' => ['type' => 'boolean'], + ], + ], + ], + ], + 'title' => '获取运行时详情', + 'summary' => '获取运行时的详情。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', '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\\": true\\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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~) 。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '响应体。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'example' => '478**'], + 'Accessibility' => ['description' => '工作空间可见性，可能值为：'."\n" + .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" + .'- PUBLIC：在此工作空间中，对所有人可见。', 'type' => 'string', 'example' => 'PRIVATE'], + 'Creator' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '2680******4103'], + 'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-09-24T07:33:53Z'], + 'GmtModifiedTime' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-09-24T08:58:35Z'], + 'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 'snap-asfg******123'], + 'SnapshotName' => ['description' => '快照名称。', 'type' => 'string', 'example' => 'snapshot01'], + 'Description' => ['description' => '快照描述。', 'type' => 'string', 'example' => 'This is description'], + 'SnapshotResourceType' => ['description' => '快照资源类型。取值：'."\n" + .'* Flow：工作流', 'type' => 'string', 'example' => 'Flow'], + 'SnapshotResourceId' => ['description' => '快照资源ID。', 'type' => 'string', 'example' => 'flow-asfg******1234'], + 'CreationType' => ['description' => '快照的创建类型。取值：'."\n" + .'* ManualCreated：手动创建'."\n" + .'* DeploymentAutoCreated: 部署服务自动创建'."\n" + .'* EvaluationAutoCreated: 评测任务自动创建', 'type' => 'string', 'example' => 'ManualCreated'], + 'SnapshotStoragePath' => ['description' => '存储快照源文件的OSS路径。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src'], + 'WorkDir' => ['description' => '存储快照的 OSS 工作目录。', 'type' => 'string', 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + 'SnapshotUrl' => ['description' => '快照下载地址。', 'type' => 'string', 'example' => 'https://path/to/snapshot/zipfile'], + 'SnapshotStatus' => ['type' => 'string'], + 'ErrorMessage' => ['type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', - 'title' => '更新知识库', - ], - 'DeleteKnowledgeBase' => [ - 'summary' => '删除知识库。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'title' => '获取快照详情', + 'summary' => '获取快照详情。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', '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' => [ + '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' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页游标。用于请求下一页检索的结果。'."\n" + .'* 首次请求时置空。'."\n" + .'* 后续请求时传入上一次响应返回的 NextToken 值。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的排序字段，默认使用 GmtCreateTime。取值如下。'."\n" + .'* GmtCreateTime（默认值）：按创建时间。'."\n" + .'* GmtModifiedTime：按修改时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'query', + 'schema' => ['description' => '部署任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '待部署的资源类型。取值：'."\n" + .'* Flow: 工作流的项目'."\n" + .'* Code: 代码模式的项目', 'type' => 'string', 'required' => false, 'example' => 'Flow'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['description' => '待部署的资源ID。', 'type' => 'string', 'required' => false, 'example' => 'flow-asdf******123'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，当前页面的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页所显示的项数，默认为10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者ID。', 'type' => 'string', 'required' => false, 'example' => '2680******4103'], + ], + [ + 'name' => 'ResourceSnapshotId', + 'in' => 'query', + 'schema' => ['description' => '待部署资源的快照 ID。若提供该参数，系统将直接基于该快照进行部署；若未提供，系统会先为资源创建新快照，再执行部署。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => '服务名称。支持按服务名称模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'myservice01'], + ], + [ + 'name' => 'DeploymentStatus', + 'in' => 'query', + 'schema' => ['description' => '部署任务状态。同时查询多个状态以逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'Creating,Running'], + ], + [ + 'name' => 'OperationType', + 'in' => 'query', + 'schema' => ['description' => '操作类型。取值：'."\n" + .'* Create： 新建服务。'."\n" + .'* Update： 更新已有服务。', 'type' => 'string', 'required' => false, 'example' => 'Create'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'PRIVATE'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '478***', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Deployments' => [ + 'description' => '部署任务列表。', + 'type' => 'array', + 'items' => ['description' => '部署任务详情。', '$ref' => '#/components/schemas/Deployment'], + ], + 'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => '下次请求令牌', 'description' => '下次请求分页游标。', 'type' => 'string', 'example' => '10'], + 'TotalCount' => ['title' => '总量', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求 ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], ], ], + ], + 'title' => '获取部署任务列表', + 'summary' => '获取部署任务列表。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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"}]', + ], + 'ListKnowledgeBaseChunks' => [ + 'summary' => '获取知识库切片列表。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks', + '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' => 'KnowledgeBaseId', 'in' => 'path', + 'schema' => ['title' => '知识库ID', 'description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'], + ], + [ + 'name' => 'VersionName', + 'in' => 'query', + 'schema' => ['title' => '知识库版本', 'description' => '知识库版本。默认为v1。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'MetaData', + 'in' => 'query', 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', + 'title' => '原始文件信息', + 'description' => '原始文件信息。为空表示遍历整个知识库版本。', + 'type' => 'object', + 'properties' => [ + 'FileUri' => ['title' => '文件地址', 'description' => '文件地址。若同时传入FileMetaId则忽略此参数值。', '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], + ], + 'required' => false, + 'example' => '1', ], ], + [ + 'name' => 'ChunkStatus', + 'in' => 'query', + 'schema' => ['title' => '切片状态', 'description' => '切片状态。'."\n" + .'- Enable: 有效。'."\n" + .'- Disable: 无效。', 'type' => 'string', 'required' => false, 'example' => 'Enable'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '每页查询数量', 'description' => '每页查询数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26', + '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' => '切片状态。'."\n" + .'- Enable: 启用。'."\n" + .'- Disable: 禁用。', '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' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C25324E3-18E6-50D8-9026-16D74AAEEB26\\"\\n}","type":"json"}]', - 'title' => '删除知识库', + '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' => '获取知识库切片列表', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ListKnowledgeBaseJobs' => [ + 'summary' => '获取知识库任务列表。', + 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', + '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' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '478**'], + ], + [ + 'name' => 'KnowledgeBaseId', + 'in' => 'path', + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d'], + ], + [ + 'name' => 'KnowledgeBaseJobId', + 'in' => 'query', + 'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => false, 'example' => 'kbjob-9m******54'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '知识库任务状态。'."\n" + .'- Running: 运行中。'."\n" + .'- Success: 运行成功。'."\n" + .'- Failed: 运行失败。', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'JobAction', + 'in' => 'query', + 'schema' => ['description' => '任务操作类型。'."\n" + .'- SyncIndex：更新知识库索引', 'type' => 'string', 'required' => false, 'example' => 'SyncIndex'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '使用 NextToken 方式查询时，每次最多返回的结果数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序字段。目前只支持GmtCreateTime。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['title' => '可见性', 'type' => 'string', 'example' => 'PRIVATE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeBaseJobs' => [ + 'description' => '知识库任务列表。', + 'type' => 'array', + 'items' => ['description' => '知识库任务详情。', '$ref' => '#/components/schemas/KnowledgeBaseJob'], + ], + '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' => '', + ], + ], + ], + 'title' => '获取知识库任务列表', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobs\\": [\\n {\\n \\"WorkspaceId\\": \\"478**\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"Creator\\": \\"2003******4844\\",\\n \\"GmtCreateTime\\": \\"2024-05-13T01:43:15Z\\",\\n \\"GmtModifiedTime\\": \\"2024-05-13T03:05:22Z\\",\\n \\"KnowledgeBaseId\\": \\"d-ksicx823d\\",\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9m******54\\",\\n \\"JobAction\\": \\"SyncIndex\\",\\n \\"Description\\": \\"This is a description of the knowledge base job.\\",\\n \\"Status\\": \\"Running\\",\\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\\": \\"2024-05-13T04:03:27Z\\",\\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\\": 8,\\n \\"Concurrency\\": 1\\n }\\n }\\n ],\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"20\\",\\n \\"TotalCount\\": 32,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', ], 'ListKnowledgeBases' => [ 'summary' => '获取知识库列表。', 'path' => '/api/v1/langstudio/knowledgebases', - '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '478***', - ], + 'schema' => ['description' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478***'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '知识库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'myName', - ], + 'schema' => ['description' => '知识库名称。', 'type' => 'string', 'required' => false, 'example' => 'myName'], ], [ 'name' => 'KnowledgeBaseId', 'in' => 'query', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-nacr******sxd2'], ], [ 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => '用来标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '使用 NextToken 方式查询时，每次最多返回的结果数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '排序字段。目前只支持GmtCreateTime。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者用户ID。', 'type' => 'string', 'required' => false, 'example' => '2680******4103'], + ], + [ + 'name' => 'KnowledgeBaseType', + 'in' => 'query', + 'schema' => ['description' => '知识库类型。'."\n" + .'- TEXT：文档。'."\n" + .'- STRUCTURED：结构化数据。'."\n" + .'- IMAGE：图片。'."\n" + .'- VIDEO：视频。', 'type' => 'string', 'required' => false, 'example' => 'TEXT'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['title' => '可见性', 'type' => 'string', 'example' => 'PRIVATE'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'KnowledgeBases' => [ + 'description' => '知识库列表。', + 'type' => 'array', + 'items' => ['description' => '知识库详情。', '$ref' => '#/components/schemas/KnowledgeBase'], + ], + 'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'NextToken' => ['title' => '下次请求令牌', 'description' => '返回下一次查询开始的位置。为空表示已经获取了全部数据。', 'type' => 'string', 'example' => '20'], + 'TotalCount' => ['title' => '总量', 'description' => '总记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '51'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'], + ], + 'description' => '', ], ], + ], + 'title' => '获取知识库列表', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:33.000Z', 'description' => '响应参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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"}]', + ], + 'ListRuntimes' => [ + 'summary' => '获取运行时列表。', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页游标。用于请求下一页检索的结果。'."\n" + .'* 首次请求时置空。'."\n" + .'* 后续请求时传入上一次响应返回的`NextToken`值。', 'type' => 'string', 'required' => false, 'example' => '""'], + ], [ 'name' => 'MaxResults', 'in' => 'query', + 'schema' => ['description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，当前页面的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页所显示的项数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'RuntimeName', + 'in' => 'query', + 'schema' => ['description' => '运行时的名称。支持按名称模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'dev01'], + ], + [ + 'name' => 'RuntimeId', + 'in' => 'query', + 'schema' => ['description' => '运行时ID。支持按运行时ID精确搜索。', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz'], + ], + [ + 'name' => 'WorkDir', + 'in' => 'query', + 'schema' => ['description' => '工作目录的OSS路径。', 'type' => 'string', 'required' => false, 'example' => 'oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/'], + ], + [ + 'name' => 'RuntimeStatus', + 'in' => 'query', 'schema' => [ - 'description' => '使用 NextToken 方式查询时，每次最多返回的结果数。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '运行时状态。', + 'type' => 'string', 'required' => false, - 'example' => '20', + 'enumValueTitles' => [ + 'Creating' => '创建中', 'SaveFailed' => '镜像保存失败', 'Stopped' => '已停止', 'Failed' => '失败', 'ResourceAllocating' => '资源分配中', 'Stopping' => '停止中', 'Updating' => '更新中', 'Saving' => '镜像保存中', 'Queuing' => '排队中', 'Recovering' => '实例恢复中', + 'Starting' => '创建中', 'Running' => '运行中', 'Saved' => '镜像保存成功', 'Deleting' => '删除中', 'EnvPreparing' => '环境准备中', + ], + 'example' => 'Running', ], ], [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者ID。', 'type' => 'string', 'required' => false, 'example' => '2485765****023475'], + ], + [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => '排序字段。目前只支持GmtCreateTime。', + 'description' => '分页查询时的排序字段，默认使用GmtCreateTime。', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['Status' => '运行时状态', 'RuntimeName' => '运行时名称', 'Creator' => '创建者 ID', 'WorkDir' => '工作路径', 'GmtCreateTime' => '按创建时间', 'GmtModifiedTime' => '按修改时间'], 'example' => 'GmtCreateTime', ], ], @@ -4155,136 +3488,226 @@ 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => '排序方式。'."\n" - ."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', + 'description' => '排序方式。', 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'], 'example' => 'DESC', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Version', + 'in' => 'query', + 'schema' => ['description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1.0'], + ], + [ + 'name' => 'Accessibility', 'in' => 'query', 'schema' => [ - 'description' => '当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '可见性', + 'description' => '可见性。', + 'type' => 'string', 'required' => false, - 'example' => '1', + 'enumValueTitles' => ['PUBLIC' => '工作空间内可见', 'PRIVATE' => '创建者可见'], + 'example' => 'PRIVATE', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Runtimes' => [ + 'description' => '运行时列表。', + 'type' => 'array', + 'items' => ['description' => '运行时详情。', '$ref' => '#/components/schemas/Runtime'], + ], + 'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '请求最大返回结果数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => '下次请求令牌', 'description' => '下次请求令牌。', 'type' => 'string', 'example' => '11'], + 'TotalCount' => ['title' => '总量', 'description' => '运行时总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + '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\\": true\\n }\\n ],\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"11\\",\\n \\"TotalCount\\": 25,\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '获取运行时列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListRuntimes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListSnapshots' => [ + 'summary' => '获取快照列表。', + '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' => '工作空间ID。如何获取工作空间ID，请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '分页游标。用于请求下一页检索的结果。'."\n" + .'* 首次请求时置空。'."\n" + .'* 后续请求时传入上一次响应返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => '分页查询时的排序字段，默认使用GmtCreateTime。取值如下。'."\n" + .'- GmtCreateTime（默认值）：按创建时间。'."\n" + .'- GmtModifiedTime：按修改时间。', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => '排序方式。'."\n" + ."\n" + .'- ASC：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => ['description' => '快照 ID。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，当前页面的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '每页所显示的项数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Creator', + 'name' => 'SnapshotResourceType', 'in' => 'query', 'schema' => [ - 'description' => '创建者用户ID。', + 'description' => '快照资源类型。取值：'."\n" + .'* Flow：工作流', 'type' => 'string', 'required' => false, - 'example' => '2680******4103', + 'example' => 'Flow', + 'enum' => ['Flow'], ], ], [ - 'name' => 'KnowledgeBaseType', + 'name' => 'SnapshotResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '知识库类型。'."\n" - .'- TEXT：文档。'."\n" - .'- STRUCTURED：结构化数据。'."\n" - .'- IMAGE：图片。'."\n" - .'- VIDEO：视频。', - 'type' => 'string', - 'required' => false, - 'example' => 'TEXT', - ], + 'schema' => ['description' => '快照资源ID。', 'type' => 'string', 'required' => false, 'example' => 'flow-asfg******1234'], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者ID。', 'type' => 'string', 'required' => false, 'example' => '2003******4844'], + ], + [ + 'name' => 'CreationType', + 'in' => 'query', + 'schema' => ['description' => '快照的创建类型。同时查询多个类型以逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'ManualCreated,DeploymentAutoCreated'], + ], + [ + 'name' => 'SnapshotStatus', + 'in' => 'query', + 'schema' => ['type' => 'string'], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => ['title' => '可见性', 'type' => 'string', 'example' => 'PRIVATE'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'KnowledgeBases' => [ - 'description' => '知识库列表。', + 'Snapshots' => [ + 'description' => '快照列表。', 'type' => 'array', - 'items' => [ - 'description' => '知识库详情。', - '$ref' => '#/components/schemas/KnowledgeBase', - ], - ], - 'MaxResults' => [ - 'title' => '请求最大返回结果数', - 'description' => '本次请求允许返回的最大记录条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'NextToken' => [ - 'title' => '下次请求令牌', - 'description' => '返回下一次查询开始的位置。为空表示已经获取了全部数据。', - 'type' => 'string', - 'example' => '20', - ], - 'TotalCount' => [ - 'title' => '总量', - 'description' => '总记录条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '51', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '35686626-8D83-5ADE-B400-08A6613A6057', + 'items' => ['description' => '快照详情。', '$ref' => '#/components/schemas/Snapshot'], ], + 'MaxResults' => ['title' => '请求最大返回结果数', 'description' => '本次请求允许返回的最大记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'NextToken' => ['title' => '下次请求令牌', 'description' => '下次请求分页游标。', 'type' => 'string', 'example' => '11'], + 'TotalCount' => ['title' => '总量', 'description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], ], ], ], - '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' => '获取知识库列表', + 'title' => '获取快照列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', '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' => '检索知识库。', 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -4292,12 +3715,7 @@ [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-ksicx823d', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => false, 'example' => 'd-ksicx823d'], ], [ 'name' => 'body', @@ -4307,60 +3725,33 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '174***', - ], - 'Query' => [ - 'description' => '检索内容。', - 'type' => 'string', - 'required' => true, - 'example' => 'red car', - ], - 'TopK' => [ - 'description' => '返回排名最高的结果数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'ScoreThreshold' => [ - 'description' => '相似度分数阈值。浮点型，取值范围[0, 1]。', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], - 'MetaDataFilterConditions' => [ - 'description' => '选填。元数据过滤检索条件。格式为JSON格式字符串，JSON字段定义如下：'."\n" - ."\n" - .'- FilterCondition: 逻辑关系，取值：and、or。'."\n" - .'- MetaDataFilters：过滤条件。多个条件之间按FilterCondition的逻辑关系处理。其中Key表示元数据Key；Value表示元数据值；Operator表示运算符，取值：==、!=、contains，contains仅支持file_name字段。', - '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" - .'}', - ], + 'WorkspaceId' => ['description' => '知识库所在工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '174***'], + 'Query' => ['description' => '检索内容。', 'type' => 'string', 'required' => true, 'example' => 'red car'], + 'TopK' => ['description' => '返回排名最高的结果数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + 'ScoreThreshold' => ['description' => '相似度分数阈值。浮点型，取值范围[0, 1]。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5'], + 'MetaDataFilterConditions' => ['description' => '选填。元数据过滤检索条件。格式为JSON格式字符串，JSON字段定义如下：'."\n" + ."\n" + .'- FilterCondition: 逻辑关系，取值：and、or。'."\n" + .'- MetaDataFilters：过滤条件。多个条件之间按FilterCondition的逻辑关系处理。其中Key表示元数据Key；Value表示元数据值；Operator表示运算符，取值：==、!=、contains，contains仅支持file_name字段。', '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' => '检索模式。'."\n" ."\n" @@ -4368,87 +3759,64 @@ .'- hybrid: 混合检索。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'hybrid' => 'hybrid', - 'dense' => 'dense', - ], + 'enumValueTitles' => ['hybrid' => 'hybrid', 'dense' => 'dense'], 'example' => 'dense', ], - 'VersionName' => [ - 'description' => '知识库版本。默认v1。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'RerankConfig' => [ - 'description' => 'Rerank配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" - ."\n" - .'- ConnectionId：模型服务连接ID'."\n" - ."\n" - .'- Model：模型名称。若为百炼类型连接，支持的模型为 gte-rerank-v2'."\n" - ."\n" - .'- TopK：返回排名最高的结果数', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "ConnectionId":"conn-xxx",'."\n" - .' "Model": "qwen-max",'."\n" - .' "TopK": 5'."\n" - .'}', - ], - 'RewriteConfig' => [ - 'description' => 'Rewrite配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" - ."\n" - .'- ConnectionId：模型服务连接ID'."\n" - ."\n" - .'- Model：模型名称。百炼连接支持的模型为qwen3-max、qwen-plus、qwen-flash'."\n" - ."\n" - .'- Temprature：用于控制大模型生成内容的随机性，值越高结果越随机。取值范围 [0, 2.0]。'."\n" - ."\n" - .'- TopP：生成过程中的核采样方法概率阈值，取值范围 [0, 1.0]'."\n" - ."\n" - .'- PresensePenalty：存在惩罚，取值范围 [-2.0, 2.0]'."\n" - ."\n" - .'- FrequencyPenalty：频率惩罚，取值范围 [-2.0~2.0]'."\n" - ."\n" - .'- Seed：随机数种子，取值范围 [0, 2147483647]'."\n" - ."\n" - .'- MaxTokens：控制模型生成结果的长度'."\n" - ."\n" - .'- Stop：停止序列列表。遇到列表中的任何一个序列，模型停止输出。最多支持4个序列。'."\n" - ."\n" - .'- EnableThingking：是否启用推理', - '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' => '混合检索策略配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" - ."\n" - .'- Strategy：混合检索策略。取值为rrf（RRF融合）和weighted（加权融合）'."\n" - ."\n" - .'- RRFK：RRF融合平滑参数，取值范围 [1, 100]'."\n" - ."\n" - .'- Weight：weighted策略的权重，该值表示向量语义检索对最终得分的贡献比例。取值范围 [0, 1.0]', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "Strategy": "rrf",'."\n" - .' "RRFK":60,'."\n" - .' "Weight": 0.5'."\n" - .'}', - ], + 'VersionName' => ['description' => '知识库版本。默认v1。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'RerankConfig' => ['description' => 'Rerank配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" + ."\n" + .'- ConnectionId：模型服务连接ID'."\n" + ."\n" + .'- Model：模型名称。若为百炼类型连接，支持的模型为 gte-rerank-v2'."\n" + ."\n" + .'- TopK：返回排名最高的结果数', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "ConnectionId":"conn-xxx",'."\n" + .' "Model": "qwen-max",'."\n" + .' "TopK": 5'."\n" + .'}'], + 'RewriteConfig' => ['description' => 'Rewrite配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" + ."\n" + .'- ConnectionId：模型服务连接ID'."\n" + ."\n" + .'- Model：模型名称。百炼连接支持的模型为qwen3-max、qwen-plus、qwen-flash'."\n" + ."\n" + .'- Temprature：用于控制大模型生成内容的随机性，值越高结果越随机。取值范围 [0, 2.0]。'."\n" + ."\n" + .'- TopP：生成过程中的核采样方法概率阈值，取值范围 [0, 1.0]'."\n" + ."\n" + .'- PresensePenalty：存在惩罚，取值范围 [-2.0, 2.0]'."\n" + ."\n" + .'- FrequencyPenalty：频率惩罚，取值范围 [-2.0~2.0]'."\n" + ."\n" + .'- Seed：随机数种子，取值范围 [0, 2147483647]'."\n" + ."\n" + .'- MaxTokens：控制模型生成结果的长度'."\n" + ."\n" + .'- Stop：停止序列列表。遇到列表中的任何一个序列，模型停止输出。最多支持4个序列。'."\n" + ."\n" + .'- EnableThingking：是否启用推理', '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' => '混合检索策略配置，选填。JSON格式字符串，JSON字段定义如下：'."\n" + ."\n" + .'- Strategy：混合检索策略。取值为rrf（RRF融合）和weighted（加权融合）'."\n" + ."\n" + .'- RRFK：RRF融合平滑参数，取值范围 [1, 100]'."\n" + ."\n" + .'- Weight：weighted策略的权重，该值表示向量语义检索对最终得分的贡献比例。取值范围 [0, 1.0]', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "Strategy": "rrf",'."\n" + .' "RRFK":60,'."\n" + .' "Weight": 0.5'."\n" + .'}'], ], 'required' => false, ], @@ -4462,58 +3830,129 @@ 'KnowledgeBaseFileChunks' => [ 'description' => '知识库切片列表。', 'type' => 'array', - 'items' => [ - 'description' => '知识库切片详情。', - '$ref' => '#/components/schemas/KnowledgeBaseFileChunk', - ], + 'items' => ['description' => '知识库切片详情。', '$ref' => '#/components/schemas/KnowledgeBaseFileChunk'], ], ], + 'description' => '', ], ], ], - '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"}]', + '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' => '检索知识库', - ], - 'CreateKnowledgeBaseJob' => [ - 'summary' => '创建知识库任务。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pailangstudio:RetrieveKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDeployment' => [ + 'summary' => '更新部署任务。', + 'path' => '/api/v1/langstudio/deployments/{DeploymentId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'KnowledgeBaseId', + 'name' => 'DeploymentId', 'in' => 'path', + 'schema' => ['description' => '部署任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dploy-asdf******1234'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '部署描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of deployment'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '174***'], + 'DeploymentConfig' => ['description' => '部署服务配置。具体参考PAI-EAS的[部署配置](https://help.aliyun.com/zh/pai/user-guide/parameters-of-model-services)。', '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\\"}}}'], + 'StageAction' => ['description' => '部署阶段操作信息。JSON格式如下：'."\n" + .'{"Stage":3,"Action":"Confirm"}，Action取值：'."\n" + .'* Confirm： 确认。'."\n" + .'* Cancel： 取消。', 'type' => 'string', 'required' => false, 'example' => '{\\"Stage\\":3,\\"Action\\":\\"Confirm\\"}'], + 'AutoApproval' => ['description' => '是否自动跳过部署确认环节。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], 'required' => false, - 'example' => 'd-ksicx823d', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '更新部署任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateKnowledgeBase' => [ + 'summary' => '更新知识库。', + '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' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2'], + ], [ 'name' => 'body', 'in' => 'body', @@ -4522,194 +3961,73 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '478**', - ], - 'Accessibility' => [ - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - 'default' => 'PUBLIC', - 'enum' => [ - 'PUBLIC', - 'PRIVATE', - ], - ], - 'Description' => [ - 'description' => '知识库任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base job.', - ], - 'JobAction' => [ - 'description' => '任务操作类型。'."\n" - .'- SyncIndex：更新知识库索引', - 'type' => 'string', - 'required' => false, - 'example' => 'SyncIndex', - ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '86400', - ], - 'ResourceId' => [ - 'description' => '资源组ID。为空或public-cluster表示公共资源。', - 'type' => 'string', - 'required' => false, - 'example' => 'quota89**76', - ], - 'EcsSpecs' => [ - 'description' => '任务运行资源配置列表。文档和结构化知识库仅包含1个元素且**Type**为Worker，图片和视频知识库含2个元素且**Type**分别为Head和Worker。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的取值为Head和Worker。', - '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' => '内存大小，单位GB。使用资源配额须填写。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '8', - 'readOnly' => true, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量，单位GB。使用资源配额须填写。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '16', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型', - 'type' => 'string', - 'required' => false, - 'example' => '16', - 'readOnly' => true, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => 'GPU驱动版本。', - 'type' => 'string', - 'required' => false, - 'example' => '535.161.08', - 'readOnly' => true, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'UserVpc' => [ - 'description' => '任务运行VPC信息。', + 'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '285773'], + 'Description' => ['description' => '知识库描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base.'], + 'RuntimeId' => ['description' => '运行时ID。', 'type' => 'string', 'required' => false, 'example' => 'rtime-231x****tmo4'], + 'BindRuntime' => ['description' => '是否绑定运行时。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'MetaDataConfig' => [ + 'description' => '元数据配置。', 'type' => 'object', 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-wz90****5v23', - 'readOnly' => true, - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-wz9r****ng10', - 'readOnly' => true, - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID。', - 'type' => 'string', + 'CustomMetaData' => [ + 'title' => '自定义元数据', + 'description' => '自定义元数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '元数据Key', 'description' => '元数据字段名称。', 'type' => 'string', 'required' => false, 'example' => 'author'], + 'ValueType' => ['title' => '元数据Value类型', 'description' => '元数据字段类型。目前只支持String类型。', 'type' => 'string', 'required' => false, 'example' => 'String'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'sg-wz9i****1129', - 'readOnly' => true, ], ], 'required' => false, ], - 'EmbeddingConfig' => [ - 'description' => '索引配置。', + 'AutoUpdateConfig' => [ + 'description' => '知识库自动更新配置。', 'type' => 'object', 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', + 'Status' => ['title' => '知识库自动更新状态', 'description' => '知识库自动更新开关状态。'."\n" + .'- Enable: 开启自动更新。'."\n" + .'- Disable: 关闭自动更新。', 'type' => 'string', 'required' => false, 'example' => 'Enable', 'default' => 'Disable'], + 'ResourceId' => ['title' => '资源组ID', 'description' => '资源组ID。为空或public-cluster表示公共资源。', 'type' => 'string', 'required' => false, 'example' => 'quota89**76'], + 'MaxRunningTimeInSeconds' => ['title' => '任务最大运行时间', 'description' => '任务最大运行时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '86400'], + 'EmbeddingConfig' => [ + 'title' => 'Embedding配置', + 'description' => '向量索引配置。', + 'type' => 'object', + 'properties' => [ + 'BatchSize' => ['title' => 'Embedding分批大小', 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'], + 'Concurrency' => ['title' => 'Embedding并发数', 'description' => '索引并发数。图片和视频类型知识库有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'], + ], 'required' => false, - 'example' => '8', - 'readOnly' => true, ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', + 'UserVpc' => ['title' => '用户VPC配置', 'description' => '用户VPC配置。', 'required' => false, '$ref' => '#/components/schemas/UserVpc'], + 'EcsSpecs' => [ + 'title' => '运行资源配置', + 'description' => '运行资源配置列表。文档和结构化知识库仅包含1个元素且**Type**为Worker，图片和视频知识库含2个元素且**Type**分别为 Head 和 Worker。', + 'type' => 'array', + 'items' => [ + 'description' => '运行资源。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '节点类型', 'description' => '节点类型。可能的取值为Head和Worker。', 'type' => 'string', 'required' => false, 'example' => 'Worker', 'default' => 'Worker'], + 'InstanceType' => ['title' => '机型名称', 'description' => '机型名称。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.large'], + 'PodCount' => ['title' => '副本数量', 'description' => '副本数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'GPUType' => ['title' => 'GPU类型', 'description' => 'GPU类型。', 'type' => 'string', 'required' => false, 'example' => 'V100'], + 'CPU' => ['title' => 'CPU核数', 'description' => 'CPU核数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'GPU' => ['title' => 'GPU卡数', 'description' => 'GPU卡数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'Memory' => ['title' => '内存大小', 'description' => '内存大小，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'SharedMemory' => ['title' => '共享内存容量', 'description' => '共享内存容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '16'], + 'Driver' => ['title' => '驱动版本', 'description' => '驱动版本。', 'type' => 'string', 'required' => false, 'example' => '550.127.08'], + ], + 'required' => false, + ], 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'readOnly' => true, ], ], 'required' => false, @@ -4722,84 +4040,79 @@ 'responses' => [ 200 => [ 'schema' => [ + 'description' => '响应体。', 'type' => 'object', 'properties' => [ - 'KnowledgeBaseJobId' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'example' => 'kbjob-9mn******1z54', - ], - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KnowledgeBaseJobId\\": \\"kbjob-9mn******1z54\\",\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', - 'title' => '创建知识库任务', - ], - 'GetKnowledgeBaseJob' => [ - 'summary' => '获取知识库任务。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', + 'title' => '更新知识库', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateKnowledgeBaseChunk' => [ + 'summary' => '更新知识库切片。', + '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' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '478***', - ], - ], - [ 'name' => 'KnowledgeBaseId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['title' => '知识库ID', 'description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-ab****89'], ], [ - 'name' => 'KnowledgeBaseJobId', + 'name' => 'KnowledgeBaseChunkId', 'in' => 'path', + 'schema' => ['title' => '切片ID', 'description' => '知识库切片ID。', 'type' => 'string', 'required' => true, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', + 'title' => '请求体', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'ChunkStatus' => ['title' => '切片状态', 'description' => '切片状态。'."\n" + ."\n" + .'- Enable: 启用。'."\n" + .'- Disable: 禁用。', 'type' => 'string', 'required' => false, 'example' => 'Enable'], + 'ChunkContent' => ['title' => '切片内容', 'description' => '切片内容。', 'type' => 'string', 'required' => false, 'example' => 'content'], + ], + 'required' => false, ], ], ], @@ -4808,312 +4121,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C25324E3-18E6-50D8-9026-16D74AAEEB26', - ], - 'WorkspaceId' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'example' => '478***', - ], - 'Accessibility' => [ - 'description' => '工作空间可见性，可能值为：'."\n" - .'- PRIVATE：在此工作空间中，仅对您和管理员可见。'."\n" - .'- PUBLIC：在此工作空间中，对所有人可见。', - 'type' => 'string', - 'example' => 'PUBLIC', - ], - 'Creator' => [ - 'description' => '创建者用户ID。', - 'type' => 'string', - 'example' => '2003******4844', - ], - 'GmtCreateTime' => [ - 'description' => '任务创建时间（UTC）。', - 'type' => 'string', - 'example' => '2025-09-24T07:33:53Z', - ], - 'GmtModifiedTime' => [ - 'description' => '任务更新时间（UTC）。', - 'type' => 'string', - 'example' => '2025-09-24T08:58:35Z', - ], - 'KnowledgeBaseId' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'example' => 'd-nacr******sxd2', - ], - 'KnowledgeBaseJobId' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'example' => 'kbjob-9m******54', - ], - 'JobAction' => [ - 'description' => '任务操作类型。'."\n" - .'- SyncIndex：更新知识库索引', - 'type' => 'string', - 'example' => 'UpdateScheduleConfig', - ], - 'Description' => [ - 'description' => '知识库任务描述。', - 'type' => 'string', - 'example' => 'This is a description of the knowledge base job.', - ], - 'Status' => [ - 'description' => '知识库任务状态。'."\n" - .'- Running: 运行中。'."\n" - .'- Success: 运行成功。'."\n" - .'- Failed: 运行失败。', - 'type' => 'string', - 'example' => 'discovering', - ], - 'ResourceId' => [ - 'description' => '资源组ID。为空或public-cluster表示公共资源。', - 'type' => 'string', - 'example' => 'quota89**76', - ], - 'EcsSpecs' => [ - 'description' => '运行资源配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '运行资源配置列表。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '节点类型', - 'description' => '节点类型。可能的值为Head和Worker。', - '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', - 'example' => '4', - 'readOnly' => true, - ], - 'GPU' => [ - 'title' => 'GPU卡数', - 'description' => 'GPU卡数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'readOnly' => true, - ], - 'Memory' => [ - 'title' => '内存大小', - 'description' => '内存大小，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - ], - 'SharedMemory' => [ - 'title' => '共享内存容量', - 'description' => '共享内存容量，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'readOnly' => true, - ], - 'GPUType' => [ - 'title' => 'GPU类型', - 'description' => 'GPU类型。', - 'type' => 'string', - 'example' => 'V100', - 'readOnly' => true, - ], - 'Driver' => [ - 'title' => '驱动版本', - 'description' => '驱动版本。', - 'type' => 'string', - 'example' => '550.127.08', - 'readOnly' => true, - ], - ], - ], - ], - 'UserVpc' => [ - 'description' => '任务运行VPC信息。', - 'type' => 'object', - 'properties' => [ - 'VpcId' => [ - 'title' => 'VPC ID', - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-wz90****5v23', - ], - 'VSwitchId' => [ - 'title' => '交换机ID', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-wz9r****ng10', - ], - 'SecurityGroupId' => [ - 'title' => '安全组ID', - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-wz91****e10e', - ], - ], - ], - 'MaxRunningTimeInSeconds' => [ - 'description' => '任务最大运行时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86400', - ], - 'GmtFinishTime' => [ - 'description' => '任务结束时间（UTC）。', - 'type' => 'string', - 'example' => '2025-02-08T15:45:12Z', - ], - 'ErrorMessage' => [ - 'description' => '任务出错信息。', - 'type' => 'string', - 'example' => 'Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z', - ], - 'PipelineRunInfo' => [ - 'description' => '工作流运行信息。', - 'type' => 'object', - 'properties' => [ - 'PipelineRunId' => [ - 'title' => 'PaiFlow工作流运行ID', - 'description' => 'PaiFlow工作流运行ID', - 'type' => 'string', - 'example' => 'flow-fi8z******g4gy', - 'readOnly' => true, - ], - ], - ], - 'KnowledgeBaseJobResult' => [ - 'description' => '任务结果。', - 'type' => 'object', - 'properties' => [ - 'TotalFileCount' => [ - 'title' => '总处理文件数', - 'description' => '总处理文件数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AddChunkCount' => [ - 'title' => '增加Chunk数量', - 'description' => '增加Chunk数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DeleteChunkCount' => [ - 'title' => '删除Chunk数量', - 'description' => '删除Chunk数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'EmbeddingConfig' => [ - 'description' => '索引配置。', - 'type' => 'object', - 'properties' => [ - 'BatchSize' => [ - 'title' => 'Embedding分批大小', - 'description' => '索引分批大小。文档和结构化数据类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'readOnly' => true, - ], - 'Concurrency' => [ - 'title' => 'Embedding并发数', - 'description' => '索引并发数。图片和视频类型知识库有效。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'example' => '2', - 'readOnly' => true, - ], - ], - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], + 'description' => '', ], ], ], - '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"}]', - 'title' => '获取知识库任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '更新知识库切片', + 'changeSet' => [], + 'ramActions' => [], ], 'UpdateKnowledgeBaseJob' => [ 'summary' => '更新知识库任务。', 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + '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', 'in' => 'path', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', - ], + 'schema' => ['description' => '知识库ID。', 'type' => 'string', 'required' => true, 'example' => 'd-nacr******sxd2'], ], [ 'name' => 'KnowledgeBaseJobId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', - ], + 'schema' => ['description' => '知识库任务ID。', 'type' => 'string', 'required' => true, 'example' => 'kbjob-9m******54'], ], [ 'name' => 'body', @@ -5123,18 +4170,8 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'WorkspaceId' => [ - 'description' => '知识课所在工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '285***', - ], - 'Description' => [ - 'description' => '知识库任务描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description of the knowledge base job.', - ], + 'WorkspaceId' => ['description' => '知识课所在工作空间ID。', 'type' => 'string', 'required' => true, 'example' => '285***'], + 'Description' => ['description' => '知识库任务描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description of the knowledge base job.'], ], 'required' => false, ], @@ -5145,749 +4182,568 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '35686626-8D83-5ADE-B400-08A6613A6057', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '35686626-8D83-5ADE-B400-08A6613A6057'], ], + 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35686626-8D83-5ADE-B400-08A6613A6057\\"\\n}","type":"json"}]', 'title' => '更新知识库任务', - ], - 'DeleteKnowledgeBaseJob' => [ - 'summary' => '删除知识库任务。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2026-01-08T03:49:32.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateRuntime' => [ + 'summary' => '更新运行时。', + 'path' => '/api/v1/langstudio/runtimes/{RuntimeId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', - ], + 'abilityTreeNodes' => ['FEATURElearnBVWJJN'], ], 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'required' => true, - 'example' => '478***', - ], - ], - [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-nacr******sxd2', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + 'RunTimeout' => ['description' => '在运行时上执行的单次测试运行的超时，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '180'], + 'Version' => ['description' => '运行时镜像版本。', 'type' => 'string', 'required' => false, 'example' => '2.0.0'], + 'Action' => ['description' => '运行时操作。取值：'."\n" + .'* Start: 启动运行时'."\n" + .'* Stop: 停止运行时', 'type' => 'string', 'required' => false, 'example' => 'Start'], + 'AutoUpdateImage' => ['type' => 'boolean'], + ], + 'required' => false, ], ], [ - 'name' => 'KnowledgeBaseJobId', + 'name' => 'RuntimeId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'kbjob-9m******54', - ], + 'schema' => ['description' => '运行时ID。', 'type' => 'string', 'required' => false, 'example' => 'rtime-apje******beaz'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '48E6392E-C3C9-5212-9FAD-13256ABD9AF6', - ], + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48E6392E-C3C9-5212-9FAD-13256ABD9AF6\\"\\n}","type":"json"}]', - 'title' => '删除知识库任务', - ], - 'ListKnowledgeBaseJobs' => [ - 'summary' => '获取知识库任务列表。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '更新运行时', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + ], + 'UpdateSnapshot' => [ + 'summary' => '更新快照。', + 'path' => '/api/v1/langstudio/snapshots/{SnapshotId}', + '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' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '知识库所在工作空间ID。', - 'type' => 'string', - 'required' => false, - 'example' => '478**', - ], - ], - [ - 'name' => 'KnowledgeBaseId', + 'name' => 'SnapshotId', 'in' => 'path', - 'schema' => [ - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd-ksicx823d', - ], + 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 'snap-asfg******123'], ], [ - 'name' => 'KnowledgeBaseJobId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '知识库任务ID。', - 'type' => 'string', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => '快照描述。', 'type' => 'string', 'required' => false, 'example' => 'This is description'], + 'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID，请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '478**'], + 'SnapshotName' => ['description' => '快照名称。格式要求：'."\n" + .'* 只能包含英文字母、数字和下划线（_）'."\n" + .'* 必须以字母开头'."\n" + .'* 长度为 1~256 个字符', 'type' => 'string', 'required' => false, 'example' => 'snapshot02'], + ], 'required' => false, - 'example' => 'kbjob-9m******54', ], ], - [ - 'name' => 'Status', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '知识库任务状态。'."\n" - .'- Running: 运行中。'."\n" - .'- Success: 运行成功。'."\n" - .'- Failed: 运行失败。', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', + 'title' => '更新快照', + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'JobAction', - 'in' => 'query', - 'schema' => [ - 'description' => '任务操作类型。'."\n" - .'- SyncIndex：更新知识库索引', - 'type' => 'string', - 'required' => false, - 'example' => 'SyncIndex', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '用来标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => '10', + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-beijing.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-beijing.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-hongkong.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shanghai.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-shenzhen.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'pailangstudio.cn-wulanchabu.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pailangstudio.eu-central-1.aliyuncs.com', 'endpoint' => 'pailangstudio.eu-central-1.aliyuncs.com', 'vpc' => 'pailangstudio-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CreateKnowledgeBase'], + ['description' => '响应参数发生变更', 'api' => 'CreateKnowledgeBaseJob'], + ['description' => '响应参数发生变更', 'api' => 'DeleteKnowledgeBase'], + ['description' => '响应参数发生变更', 'api' => 'DeleteKnowledgeBaseJob'], + ['description' => '响应参数发生变更', 'api' => 'GetKnowledgeBase'], + ['description' => '响应参数发生变更', 'api' => 'GetKnowledgeBaseJob'], + ['description' => '响应参数发生变更', 'api' => 'ListKnowledgeBaseJobs'], + ['description' => '响应参数发生变更', 'api' => 'ListKnowledgeBases'], + ['description' => '响应参数发生变更', 'api' => 'UpdateKnowledgeBase'], + ['description' => '响应参数发生变更', 'api' => 'UpdateKnowledgeBaseJob'], + ], + 'createdAt' => '2026-01-08T03:49:48.000Z', + 'description' => '', + ], + ], + 'ram' => [ + 'productCode' => 'PAILangStudio', + 'productName' => '人工智能平台 PAI', + 'ramCodes' => ['pailangstudio'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetKnowledgeBaseJob', + 'description' => '获取知识库任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '使用 NextToken 方式查询时，每次最多返回的结果数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ListKnowledgeBases', + 'description' => '获取知识库列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '排序字段。目前只支持GmtCreateTime。', - 'type' => 'string', - 'required' => false, - 'example' => 'GmtCreateTime', + ], + [ + 'apiName' => 'UpdateSnapshot', + 'description' => '更新快照', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => '排序方式。'."\n" - ."\n" - .'- ASC：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', + ], + [ + 'apiName' => 'GetKnowledgeBase', + 'description' => '获取知识库', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'GetDeployment', + 'description' => '获取部署任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'DeleteRuntime', + 'description' => '删除运行时', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'KnowledgeBaseJobs' => [ - 'description' => '知识库任务列表。', - 'type' => 'array', - 'items' => [ - 'description' => '知识库任务详情。', - '$ref' => '#/components/schemas/KnowledgeBaseJob', - ], - ], - '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', - ], - ], + [ + 'apiName' => 'CreateKnowledgeBaseJob', + 'description' => '创建知识库任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => '获取知识库任务列表', - ], - 'UpdateKnowledgeBaseChunk' => [ - 'summary' => '更新知识库切片。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks/{KnowledgeBaseChunkId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDeployments', + 'description' => '获取部署任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetSnapshot', + 'description' => '获取快照详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', + [ + 'apiName' => 'CreateSnapshot', + 'description' => '创建快照', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'title' => '知识库ID', - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ab****89', + [ + 'apiName' => 'ListRuntimes', + 'description' => '获取运行时列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListRuntimes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'KnowledgeBaseChunkId', - 'in' => 'path', - 'schema' => [ - 'title' => '切片ID', - 'description' => '知识库切片ID。', - 'type' => 'string', - 'required' => true, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + [ + 'apiName' => 'CreateKnowledgeBase', + 'description' => '创建知识库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '请求体', - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'ChunkStatus' => [ - 'title' => '切片状态', - 'description' => '切片状态。'."\n" - ."\n" - .'- Enable: 启用。'."\n" - .'- Disable: 禁用。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', - ], - 'ChunkContent' => [ - 'title' => '切片内容', - 'description' => '切片内容。', - 'type' => 'string', - 'required' => false, - 'example' => 'content', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '删除快照', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], - ], + [ + 'apiName' => 'DeleteKnowledgeBaseJob', + 'description' => '删除知识库任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"963BD7F9-0C02-5594-9550-BCC6DD43E3C0\\"\\n}","type":"json"}]', - 'title' => '更新知识库切片', - ], - 'ListKnowledgeBaseChunks' => [ - 'summary' => '获取知识库切片列表。', - 'path' => '/api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks', - 'methods' => [ - 'get', + [ + 'apiName' => 'DeleteKnowledgeBase', + 'description' => '删除知识库', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListKnowledgeBaseJobs', + 'description' => '获取知识库任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDeployment', + 'description' => '删除部署任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'pailangstudio:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'CreateRuntime', + 'description' => '创建运行时', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'CreateDeployment', + 'description' => '创建部署任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'pailangstudio:CreateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATURElearnBVWJJN', + [ + 'apiName' => 'UpdateKnowledgeBaseJob', + 'description' => '更新知识库任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBaseJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'KnowledgeBaseId', - 'in' => 'path', - 'schema' => [ - 'title' => '知识库ID', - 'description' => '知识库ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd-ab****89', + [ + 'apiName' => 'UpdateRuntime', + 'description' => '更新运行时', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'VersionName', - 'in' => 'query', - 'schema' => [ - 'title' => '知识库版本', - 'description' => '知识库版本。默认为v1。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', + ], + [ + 'apiName' => 'RetrieveKnowledgeBase', + 'description' => '检索知识库', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'pailangstudio:RetrieveKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'MetaData', - 'in' => 'query', - 'schema' => [ - 'title' => '原始文件信息', - 'description' => '原始文件信息。为空表示遍历整个知识库版本。', - 'type' => 'object', - 'properties' => [ - 'FileUri' => [ - 'title' => '文件地址', - 'description' => '文件地址。若同时传入FileMetaId则忽略此参数值。', - '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, - ], - ], - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListSnapshots', + 'description' => '获取快照列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ChunkStatus', - 'in' => 'query', - 'schema' => [ - 'title' => '切片状态', - 'description' => '切片状态。'."\n" - .'- Enable: 有效。'."\n" - .'- Disable: 无效。', - 'type' => 'string', - 'required' => false, - 'example' => 'Enable', + ], + [ + 'apiName' => 'UpdateKnowledgeBase', + 'description' => '更新知识库', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateKnowledgeBase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页数', - 'description' => '当前页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'GetRuntime', + 'description' => '获取运行时详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'pailangstudio:GetRuntime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页查询数量', - 'description' => '每页查询数量。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'UpdateDeployment', + 'description' => '更新部署任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'pailangstudio:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - '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' => '切片状态。'."\n" - .'- Enable: 启用。'."\n" - .'- Disable: 禁用。', - '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' => '请求ID。', - 'type' => 'string', - 'example' => '963BD7F9-0C02-5594-9550-BCC6DD43E3C0', - ], - ], + [ + 'apiName' => 'ListKnowledgeBaseChunks', + 'description' => '获取知识库切片列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'pailangstudio:ListKnowledgeBaseChunks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'PAILangStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => '获取知识库切片列表', - ], - ], - 'endpoints' => [ - [ - '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', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'pailangstudio.us-east-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |