{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-pailangstudio/create-deployment":{"post":{"operationId":"cloud_aliyun_pailangstudio_create_deployment","summary":"Creates a deployment task","description":"POST /api/v1/langstudio/deployments","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"Accessibility":{"type":"string","description":"The visibility of the workspace. Valid values: PRIVATE: The workspace is visible only to you and administrators. PUBLIC: The workspace is…"},"AutoApproval":{"type":"string","description":"Specifies whether to automatically skip the deployment confirmation step"},"ChatHistoryConfig":{"type":"object","description":"The chat history configuration"},"ContentModerationConfig":{"type":"object","description":"The content moderation configuration"},"DeploymentConfig":{"type":"string","description":"The deployment configuration. For more information, see Deployment configuration…"},"Description":{"type":"string","description":"The description of the service"},"EnableTrace":{"type":"string","description":"Specifies whether Tracing Analysis is enabled"},"ResourceId":{"type":"string","description":"The ID of the resource to be deployed"},"ResourceSnapshotId":{"type":"string","description":"The snapshot ID of the resource to be deployed. If this parameter is provided, the system deploys the resource directly based on the…"},"ResourceType":{"type":"string","description":"The type of the resource to be deployed. Valid values: Flow: workflow project Code: code-mode project"},"ServiceName":{"type":"string","description":"The name of the service. Format requirements: Only lowercase letters, digits, and underscores (_) are supported. Must start with a letter.…"},"WorkDir":{"type":"string","description":"The OSS working directory of the service. It is used to store runtime logs and chat history of the service"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/create-knowledge-base":{"post":{"operationId":"cloud_aliyun_pailangstudio_create_knowledge_base","summary":"Creates a knowledge base","description":"POST /api/v1/langstudio/knowledgebases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChunkConfig","DataSources","EmbeddingConfig","KnowledgeBaseType","Name","OutputDir","VectorDBConfig","WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"Accessibility":{"type":"string","description":"The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in…"},"ChunkConfig":{"type":"object","description":"The file chunking configuration"},"DataSources":{"type":"array","description":"The data sources"},"Description":{"type":"string","description":"The custom description of the knowledge base"},"EmbeddingConfig":{"type":"object","description":"The vector index configuration"},"IndexColumnConfig":{"type":"object","description":"The field column configuration of the structured knowledge base"},"KnowledgeBaseType":{"type":"string","description":"The type of the knowledge base. Valid values: TEXT: Document. STRUCTURED: Structured data. IMAGE: Image. VIDEO: Video"},"MetaDataConfig":{"type":"object","description":"The metadata configuration"},"Name":{"type":"string","description":"The name of the knowledge base. The name must meet the following naming rules: Can contain letters, digits, or underscores (_). Must start…"},"OutputDir":{"type":"string","description":"The storage path of the output data"},"RuntimeId":{"type":"string","description":"The runtime ID"},"VectorDBConfig":{"type":"object","description":"The vector database configuration"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/create-knowledge-base-job":{"post":{"operationId":"cloud_aliyun_pailangstudio_create_knowledge_base_job","summary":"Creates a knowledge base task","description":"POST /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeBaseId","WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"Accessibility":{"type":"string","description":"The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in the workspace. PUBLIC: Visible to all users in…"},"Description":{"type":"string","description":"The description of the knowledge base task"},"EcsSpecs":{"type":"array","description":"The list of resource configurations for task execution. A document or structured knowledge base contains only one element with Type set to…"},"EmbeddingConfig":{"type":"object","description":"The index configuration"},"JobAction":{"type":"string","description":"The task operation type. Valid values: SyncIndex: Updates the knowledge base index"},"MaxRunningTimeInSeconds":{"type":"integer","description":"The maximum running time of the task, in seconds"},"ResourceId":{"type":"string","description":"The resource group ID. If this parameter is left empty or set to public-cluster, public resources are used"},"UserVpc":{"type":"object","description":"The VPC information for task execution"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/create-runtime":{"post":{"operationId":"cloud_aliyun_pailangstudio_create_runtime","summary":"Creates a runtime","description":"POST /api/v1/langstudio/runtimes","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"Accessibility":{"type":"string","description":"The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in…"},"AutoUpdateImage":{"type":"string","description":"The AutoUpdateImage"},"CredentialConfig":{"type":"object","description":"The credential configuration"},"DataSources":{"type":"array","description":"The mounted data sources"},"EcsSpec":{"type":"object","description":"The ECS resource configuration"},"Envs":{"type":"array","description":"The environment variables"},"Labels":{"type":"array","description":"The labels"},"ResourceId":{"type":"string","description":"The resource quota ID"},"RunTimeout":{"type":"integer","description":"The timeout for a single test executed on the runtime. Unit: seconds"},"RuntimeName":{"type":"string","description":"The name of the runtime. Format requirements: The name can contain only letters, digits, and underscores (_). The name must start with a…"},"RuntimeType":{"type":"string","description":"The runtime type. Valid values: DSW: A PAI-DSW instance"},"UserVpc":{"type":"object","description":"The user VPC configuration"},"WorkDir":{"type":"string","description":"The OSS path of the working directory"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/create-snapshot":{"post":{"operationId":"cloud_aliyun_pailangstudio_create_snapshot","summary":"Creates a snapshot","description":"POST /api/v1/langstudio/snapshots","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"Accessibility":{"type":"string","description":"The workspace visibility. Valid values: PRIVATE: Visible only to you and administrators in this workspace. PUBLIC: Visible to all users in…"},"CreationType":{"type":"string","description":"The creation type of the snapshot. Valid values: ManualCreated: Manually created. DeploymentAutoCreated: Automatic creation by the…"},"Description":{"type":"string","description":"The description of the snapshot"},"SnapshotName":{"type":"string","description":"The name of the snapshot. Format requirements: It can contain only letters, digits, and underscores (_). It must start with a letter. It…"},"SnapshotResourceId":{"type":"string","description":"The ID of the snapshot resource"},"SnapshotResourceType":{"type":"string","description":"The resource type of the snapshot. Valid values: Flow: Workflow"},"SourceStoragePath":{"type":"string","description":"The source storage path used to create a snapshot from source files in a specified OSS directory"},"WorkDir":{"type":"string","description":"The OSS working directory where the snapshot is stored"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/delete-deployment":{"post":{"operationId":"cloud_aliyun_pailangstudio_delete_deployment","summary":"Deletes a deployment task","description":"DELETE /api/v1/langstudio/deployments/{DeploymentId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeploymentId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"DeploymentId":{"type":"string","description":"The deployment task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/delete-knowledge-base":{"post":{"operationId":"cloud_aliyun_pailangstudio_delete_knowledge_base","summary":"Deletes a knowledge base","description":"DELETE /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkspaceId","KnowledgeBaseId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The workspace ID"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/delete-knowledge-base-job":{"post":{"operationId":"cloud_aliyun_pailangstudio_delete_knowledge_base_job","summary":"Deletes a knowledge base task","description":"DELETE /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkspaceId","KnowledgeBaseId","KnowledgeBaseJobId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The ID of the workspace to which the knowledge base belongs"},"KnowledgeBaseId":{"type":"string","description":"The ID of the knowledge base"},"KnowledgeBaseJobId":{"type":"string","description":"The ID of the knowledge base task"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/delete-runtime":{"post":{"operationId":"cloud_aliyun_pailangstudio_delete_runtime","summary":"Deletes a runtime","description":"DELETE /api/v1/langstudio/runtimes/{RuntimeId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RuntimeId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"RuntimeId":{"type":"string","description":"The runtime ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/delete-snapshot":{"post":{"operationId":"cloud_aliyun_pailangstudio_delete_snapshot","summary":"Deletes a snapshot","description":"DELETE /api/v1/langstudio/snapshots/{SnapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SnapshotId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"SnapshotId":{"type":"string","description":"The snapshot ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/get-deployment":{"get":{"operationId":"cloud_aliyun_pailangstudio_get_deployment","summary":"Retrieves the details of a deployment task","description":"GET /api/v1/langstudio/deployments/{DeploymentId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478***"},{"name":"DeploymentId","in":"query","required":true,"description":"The deployment task ID","schema":{"type":"string","description":"The deployment task ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/get-knowledge-base":{"get":{"operationId":"cloud_aliyun_pailangstudio_get_knowledge_base","summary":"Retrieves a knowledge base","description":"GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":true,"description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478**"},{"name":"KnowledgeBaseId","in":"query","required":true,"description":"The knowledge base ID","schema":{"type":"string","description":"The knowledge base ID"}},{"name":"VersionName","in":"query","required":false,"description":"The knowledge base version. Default value: v1","schema":{"type":"string","description":"The knowledge base version. Default value: v1"},"example":"v1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/get-knowledge-base-job":{"get":{"operationId":"cloud_aliyun_pailangstudio_get_knowledge_base_job","summary":"Retrieves a knowledge base job","description":"GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":true,"description":"The ID of the workspace to which the knowledge base belongs","schema":{"type":"string","description":"The ID of the workspace to which the knowledge base belongs"},"example":"478***"},{"name":"KnowledgeBaseId","in":"query","required":true,"description":"The ID of the knowledge base","schema":{"type":"string","description":"The ID of the knowledge base"}},{"name":"KnowledgeBaseJobId","in":"query","required":true,"description":"The ID of the knowledge base job","schema":{"type":"string","description":"The ID of the knowledge base job"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/get-runtime":{"get":{"operationId":"cloud_aliyun_pailangstudio_get_runtime","summary":"Retrieves the details of a runtime","description":"GET /api/v1/langstudio/runtimes/{RuntimeId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478***"},{"name":"RuntimeId","in":"query","required":true,"description":"The runtime ID","schema":{"type":"string","description":"The runtime ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/get-snapshot":{"get":{"operationId":"cloud_aliyun_pailangstudio_get_snapshot","summary":"Retrieves the details of a snapshot","description":"GET /api/v1/langstudio/snapshots/{SnapshotId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478***"},{"name":"SnapshotId","in":"query","required":true,"description":"The snapshot ID","schema":{"type":"string","description":"The snapshot ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-deployments":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_deployments","summary":"Retrieves a list of deployment tasks","description":"GET /api/v1/langstudio/deployments","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478***"},{"name":"NextToken","in":"query","required":false,"description":"The pagination cursor used to retrieve the next page of results. * Leave this parameter empty for the first request. * For subsequent…","schema":{"type":"string","description":"The pagination cursor used to retrieve the next page of results. * Leave this parameter empty for the first request. * For subsequent…"},"example":"10"},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of records to return in the current request","schema":{"type":"integer","description":"The maximum number of records to return in the current request"},"example":"20"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the results in a paged query. Default value: GmtCreateTime. Valid values: * GmtCreateTime: sorts the results by…","schema":{"type":"string","description":"The field by which to sort the results in a paged query. Default value: GmtCreateTime. Valid values: * GmtCreateTime: sorts the results by…"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: - ASC: ascending order. - DESC: descending order","schema":{"type":"string","description":"The sort order. Valid values: - ASC: ascending order. - DESC: descending order"},"example":"DESC"},{"name":"DeploymentId","in":"query","required":false,"description":"The ID of the deployment task","schema":{"type":"string","description":"The ID of the deployment task"},"example":"dploy-asdf******1234"},{"name":"ResourceType","in":"query","required":false,"description":"The type of the resource to deploy. Valid values: * Flow: a workflow project. * Code: a code-mode project","schema":{"type":"string","description":"The type of the resource to deploy. Valid values: * Flow: a workflow project. * Code: a code-mode project"},"example":"Flow"},{"name":"ResourceId","in":"query","required":false,"description":"The ID of the resource to deploy","schema":{"type":"string","description":"The ID of the resource to deploy"},"example":"flow-asdf******123"},{"name":"PageNumber","in":"query","required":false,"description":"The page number of the current page in a paged query","schema":{"type":"integer","description":"The page number of the current page in a paged query"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of items to display on each page. Default value: 10","schema":{"type":"integer","description":"The number of items to display on each page. Default value: 10"},"example":"10"},{"name":"Creator","in":"query","required":false,"description":"The ID of the creator","schema":{"type":"string","description":"The ID of the creator"},"example":"2680******4103"},{"name":"ResourceSnapshotId","in":"query","required":false,"description":"The ID of the snapshot for the resource to deploy. If this parameter is specified, the system deploys the resource directly based on this…","schema":{"type":"string","description":"The ID of the snapshot for the resource to deploy. If this parameter is specified, the system deploys the resource directly based on this…"},"example":"snap-asfg******123"},{"name":"ServiceName","in":"query","required":false,"description":"The name of the service. Fuzzy match by service name is supported","schema":{"type":"string","description":"The name of the service. Fuzzy match by service name is supported"},"example":"myservice01"},{"name":"DeploymentStatus","in":"query","required":false,"description":"The status of the deployment task. To query multiple statuses at the same time, separate them with commas","schema":{"type":"string","description":"The status of the deployment task. To query multiple statuses at the same time, separate them with commas"},"example":"Creating,Running"},{"name":"OperationType","in":"query","required":false,"description":"The operation type. Valid values: * Create: creates a service. * Update: updates an existing service","schema":{"type":"string","description":"The operation type. Valid values: * Create: creates a service. * Update: updates an existing service"},"example":"Create"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility","schema":{"type":"string","description":"The visibility"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-knowledge-base-chunks":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_knowledge_base_chunks","summary":"Retrieves a list of knowledge base chunks","description":"GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"KnowledgeBaseId","in":"query","required":true,"description":"The ID of the knowledge base","schema":{"type":"string","description":"The ID of the knowledge base"}},{"name":"VersionName","in":"query","required":false,"description":"The version of the knowledge base. Default value: v1","schema":{"type":"string","description":"The version of the knowledge base. Default value: v1"},"example":"v1"},{"name":"MetaData","in":"query","required":false,"description":"The original file information. If this parameter is left empty, the entire knowledge base version is traversed (JSON-encoded)","schema":{"type":"string","description":"The original file information. If this parameter is left empty, the entire knowledge base version is traversed (JSON-encoded)"},"example":"1"},{"name":"ChunkStatus","in":"query","required":false,"description":"The chunk status. Valid values: Enable: Valid. Disable: Invalid","schema":{"type":"string","description":"The chunk status. Valid values: Enable: Valid. Disable: Invalid"},"example":"Enable"},{"name":"PageNumber","in":"query","required":false,"description":"The current page number","schema":{"type":"integer","description":"The current page number"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of entries per page","schema":{"type":"integer","description":"The number of entries per page"},"example":"20"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-knowledge-base-jobs":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_knowledge_base_jobs","summary":"Get the Knowledge Base task list","description":"GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"知识库所在工作空间ID","schema":{"type":"string","description":"知识库所在工作空间ID"},"example":"478**"},{"name":"KnowledgeBaseId","in":"query","required":true,"description":"知识库ID","schema":{"type":"string","description":"知识库ID"}},{"name":"KnowledgeBaseJobId","in":"query","required":false,"description":"知识库任务ID","schema":{"type":"string","description":"知识库任务ID"},"example":"kbjob-9m******54"},{"name":"Status","in":"query","required":false,"description":"知识库任务状态。 Running: 运行中。 Success: 运行成功。 Failed: 运行失败","schema":{"type":"string","description":"知识库任务状态。 Running: 运行中。 Success: 运行成功。 Failed: 运行失败"},"example":"Running"},{"name":"JobAction","in":"query","required":false,"description":"任务操作类型。 SyncIndex：更新知识库索引","schema":{"type":"string","description":"任务操作类型。 SyncIndex：更新知识库索引"},"example":"SyncIndex"},{"name":"NextToken","in":"query","required":false,"description":"用来标记当前开始读取的位置，置空表示从头开始","schema":{"type":"string","description":"用来标记当前开始读取的位置，置空表示从头开始"},"example":"10"},{"name":"MaxResults","in":"query","required":false,"description":"使用 NextToken 方式查询时，每次最多返回的结果数","schema":{"type":"integer","description":"使用 NextToken 方式查询时，每次最多返回的结果数"},"example":"10"},{"name":"SortBy","in":"query","required":false,"description":"排序字段。目前只支持GmtCreateTime","schema":{"type":"string","description":"排序字段。目前只支持GmtCreateTime"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"排序方式。 ASC：升序。 DESC：降序","schema":{"type":"string","description":"排序方式。 ASC：升序。 DESC：降序"},"example":"DESC"},{"name":"PageNumber","in":"query","required":false,"description":"当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值","schema":{"type":"integer","description":"当前页数。 取值范围：大于0。 默认值：1。如果同时传入MaxResults，则使用NextToken查询方式，忽略此字段值"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准","schema":{"type":"integer","description":"每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准"},"example":"10"},{"name":"Accessibility","in":"query","required":false,"description":"可见性","schema":{"type":"string","description":"可见性"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-knowledge-bases":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_knowledge_bases","summary":"Retrieves a list of knowledge bases","description":"GET /api/v1/langstudio/knowledgebases","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478***"},{"name":"Name","in":"query","required":false,"description":"The name of the knowledge base","schema":{"type":"string","description":"The name of the knowledge base"},"example":"myName"},{"name":"KnowledgeBaseId","in":"query","required":false,"description":"The ID of the knowledge base","schema":{"type":"string","description":"The ID of the knowledge base"},"example":"d-nacr******sxd2"},{"name":"NextToken","in":"query","required":false,"description":"The token that marks the position from which to start reading. If this parameter is left empty, the query starts from the beginning","schema":{"type":"string","description":"The token that marks the position from which to start reading. If this parameter is left empty, the query starts from the beginning"},"example":"10"},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return per query when the NextToken parameter is used","schema":{"type":"integer","description":"The maximum number of results to return per query when the NextToken parameter is used"},"example":"20"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the results. Only GmtCreateTime is supported","schema":{"type":"string","description":"The field by which to sort the results. Only GmtCreateTime is supported"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: ASC: ascending order DESC: descending order","schema":{"type":"string","description":"The sort order. Valid values: ASC: ascending order DESC: descending order"},"example":"DESC"},{"name":"PageNumber","in":"query","required":false,"description":"The page number. Valid values: integers greater than 0. Default value: 1. If the MaxResults parameter is also specified, the…","schema":{"type":"integer","description":"The page number. Valid values: integers greater than 0. Default value: 1. If the MaxResults parameter is also specified, the…"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of entries to return per page. If the MaxResults parameter is also specified, the value of MaxResults prevails","schema":{"type":"integer","description":"The number of entries to return per page. If the MaxResults parameter is also specified, the value of MaxResults prevails"},"example":"10"},{"name":"Creator","in":"query","required":false,"description":"The ID of the user who created the knowledge base","schema":{"type":"string","description":"The ID of the user who created the knowledge base"},"example":"2680******4103"},{"name":"KnowledgeBaseType","in":"query","required":false,"description":"The type of the knowledge base. Valid values: TEXT: document STRUCTURED: structured data IMAGE: image VIDEO: video","schema":{"type":"string","description":"The type of the knowledge base. Valid values: TEXT: document STRUCTURED: structured data IMAGE: image VIDEO: video"},"example":"TEXT"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility of the knowledge base","schema":{"type":"string","description":"The visibility of the knowledge base"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-runtimes":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_runtimes","summary":"Retrieves a list of runtimes","description":"GET /api/v1/langstudio/runtimes","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478**"},{"name":"NextToken","in":"query","required":false,"description":"The pagination token used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent requests,…","schema":{"type":"string","description":"The pagination token used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent requests,…"},"example":"\"\""},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of records to return for the current request","schema":{"type":"integer","description":"The maximum number of records to return for the current request"},"example":"20"},{"name":"PageNumber","in":"query","required":false,"description":"The page number of the current page in a paged query","schema":{"type":"integer","description":"The page number of the current page in a paged query"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of items to display on each page. Default value: 10","schema":{"type":"integer","description":"The number of items to display on each page. Default value: 10"},"example":"10"},{"name":"RuntimeName","in":"query","required":false,"description":"The name of the runtime. Fuzzy match by name is supported","schema":{"type":"string","description":"The name of the runtime. Fuzzy match by name is supported"},"example":"dev01"},{"name":"RuntimeId","in":"query","required":false,"description":"The runtime ID. Exact match by runtime ID is supported","schema":{"type":"string","description":"The runtime ID. Exact match by runtime ID is supported"},"example":"rtime-apje******beaz"},{"name":"WorkDir","in":"query","required":false,"description":"The OSS path of the working directory","schema":{"type":"string","description":"The OSS path of the working directory"},"example":"oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/"},{"name":"RuntimeStatus","in":"query","required":false,"description":"The runtime status","schema":{"type":"string","description":"The runtime status"},"example":"Running"},{"name":"Creator","in":"query","required":false,"description":"The ID of the creator","schema":{"type":"string","description":"The ID of the creator"},"example":"2485765****023475"},{"name":"SortBy","in":"query","required":false,"description":"The field used for sorting in a paged query. Default value: GmtCreateTime","schema":{"type":"string","description":"The field used for sorting in a paged query. Default value: GmtCreateTime"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order","schema":{"type":"string","description":"The sort order"},"example":"DESC"},{"name":"Version","in":"query","required":false,"description":"The version","schema":{"type":"string","description":"The version"},"example":"1.0"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility","schema":{"type":"string","description":"The visibility"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/list-snapshots":{"get":{"operationId":"cloud_aliyun_pailangstudio_list_snapshots","summary":"Retrieves a list of snapshots","description":"GET /api/v1/langstudio/snapshots","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com","schema":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html","schema":{"type":"string","description":"The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"example":"478**"},{"name":"NextToken","in":"query","required":false,"description":"The pagination cursor used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent…","schema":{"type":"string","description":"The pagination cursor used to retrieve the next page of results. Leave this parameter empty for the first request. For subsequent…"},"example":"10"},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of entries to return for the current request","schema":{"type":"integer","description":"The maximum number of entries to return for the current request"},"example":"20"},{"name":"SortBy","in":"query","required":false,"description":"The field used to sort the results of a paged query. Default value: GmtCreateTime. Valid values: GmtCreateTime: Sort by creation time.…","schema":{"type":"string","description":"The field used to sort the results of a paged query. Default value: GmtCreateTime. Valid values: GmtCreateTime: Sort by creation time.…"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: ASC: ascending order DESC: descending order","schema":{"type":"string","description":"The sort order. Valid values: ASC: ascending order DESC: descending order"},"example":"DESC"},{"name":"SnapshotId","in":"query","required":false,"description":"The snapshot ID","schema":{"type":"string","description":"The snapshot ID"},"example":"snap-asfg******123"},{"name":"PageNumber","in":"query","required":false,"description":"The page number of the current page in a paged query","schema":{"type":"integer","description":"The page number of the current page in a paged query"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of entries to return on each page. Default value: 10","schema":{"type":"integer","description":"The number of entries to return on each page. Default value: 10"},"example":"10"},{"name":"SnapshotResourceType","in":"query","required":false,"description":"The snapshot resource type. Valid values: Flow: workflow","schema":{"type":"string","enum":["Flow"],"description":"The snapshot resource type. Valid values: Flow: workflow"},"example":"Flow"},{"name":"SnapshotResourceId","in":"query","required":false,"description":"The snapshot resource ID","schema":{"type":"string","description":"The snapshot resource ID"},"example":"flow-asfg******1234"},{"name":"Creator","in":"query","required":false,"description":"The ID of the creator","schema":{"type":"string","description":"The ID of the creator"},"example":"2003******4844"},{"name":"CreationType","in":"query","required":false,"description":"The creation type of the snapshot. To query multiple types at the same time, separate them with commas","schema":{"type":"string","description":"The creation type of the snapshot. To query multiple types at the same time, separate them with commas"},"example":"ManualCreated,DeploymentAutoCreated"},{"name":"SnapshotStatus","in":"query","required":false,"description":"The snapshot status","schema":{"type":"string","description":"The snapshot status"},"example":"Success"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility","schema":{"type":"string","description":"The visibility"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/retrieve-knowledge-base":{"post":{"operationId":"cloud_aliyun_pailangstudio_retrieve_knowledge_base","summary":"Searches a knowledge base","description":"POST /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/action/retrieve","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeBaseId","Query","WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"HybridStrategyConfig":{"type":"string","description":"Optional. The hybrid search strategy configuration. The value is a JSON string. The JSON fields are defined as follows: Strategy: the…"},"MetaDataFilterConditions":{"type":"string","description":"Optional. The metadata filtering conditions for the search. The value is a JSON string. The JSON fields are defined as follows:…"},"Query":{"type":"string","description":"The search query"},"QueryMode":{"type":"string","description":"The search mode. Valid values: dense: semantic search. hybrid: hybrid search"},"RerankConfig":{"type":"string","description":"Optional. The rerank configuration. The value is a JSON string. The JSON fields are defined as follows: ConnectionId: the ID of the model…"},"RewriteConfig":{"type":"string","description":"Optional. The rewrite configuration. The value is a JSON string. The JSON fields are defined as follows: ConnectionId: the ID of the model…"},"ScoreThreshold":{"type":"number","description":"The similarity score threshold. The value is a floating-point number ranging from 0 to 1"},"TopK":{"type":"integer","description":"The number of top-ranked results to return"},"VersionName":{"type":"string","description":"The knowledge base version. Default value: v1"},"WorkspaceId":{"type":"string","description":"The ID of the workspace to which the knowledge base belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-deployment":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_deployment","summary":"Updates a deployment task","description":"PUT /api/v1/langstudio/deployments/{DeploymentId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeploymentId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"DeploymentId":{"type":"string","description":"The ID of the deployment task"},"AutoApproval":{"type":"string","description":"Specifies whether to automatically skip the deployment confirmation step"},"DeploymentConfig":{"type":"string","description":"The service configuration for the deployment. For more information, see Deployment configuration…"},"Description":{"type":"string","description":"The description of the deployment"},"StageAction":{"type":"string","description":"The operation information of the deployment stage. The JSON format is as follows: {\"Stage\":3,\"Action\":\"Confirm\"}. Valid values for Action:…"},"WorkspaceId":{"type":"string","description":"The ID of the workspace. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-knowledge-base":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_knowledge_base","summary":"Updates a knowledge base","description":"PUT /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeBaseId","WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"KnowledgeBaseId":{"type":"string","description":"The ID of the knowledge base"},"AutoUpdateConfig":{"type":"object","description":"The automatic update configuration of the knowledge base"},"BindRuntime":{"type":"string","description":"Specifies whether to bind the runtime"},"Description":{"type":"string","description":"The description of the knowledge base"},"MetaDataConfig":{"type":"object","description":"The metadata configuration"},"RuntimeId":{"type":"string","description":"The ID of the runtime"},"WorkspaceId":{"type":"string","description":"The ID of the workspace"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-knowledge-base-chunk":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_knowledge_base_chunk","summary":"Updates a knowledge base chunk","description":"PUT /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks/{KnowledgeBaseChunkId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeBaseId","KnowledgeBaseChunkId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"KnowledgeBaseChunkId":{"type":"string","description":"The knowledge base chunk ID"},"ChunkContent":{"type":"string","description":"The chunk content"},"ChunkStatus":{"type":"string","description":"The chunk status. Valid values: Enable: Enabled. Disable: Disabled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-knowledge-base-job":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_knowledge_base_job","summary":"Updates a knowledge base task","description":"PUT /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["KnowledgeBaseId","KnowledgeBaseJobId","WorkspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"KnowledgeBaseId":{"type":"string","description":"The knowledge base ID"},"KnowledgeBaseJobId":{"type":"string","description":"The knowledge base task ID"},"Description":{"type":"string","description":"The description of the knowledge base task"},"WorkspaceId":{"type":"string","description":"The ID of the workspace to which the knowledge base belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-runtime":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_runtime","summary":"Updates a runtime","description":"PUT /api/v1/langstudio/runtimes/{RuntimeId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RuntimeId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"Action":{"type":"string","description":"The runtime action. Valid values: Start: Starts the runtime. Stop: Stops the runtime"},"AutoUpdateImage":{"type":"string","description":"Specifies whether to automatically update the image. When a new image version is available, the system automatically updates the runtime…"},"RunTimeout":{"type":"integer","description":"The timeout period for a single test run executed on the runtime, in seconds"},"Version":{"type":"string","description":"The runtime image version"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"},"RuntimeId":{"type":"string","description":"The runtime ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/update-snapshot":{"post":{"operationId":"cloud_aliyun_pailangstudio_update_snapshot","summary":"Updates a snapshot","description":"PUT /api/v1/langstudio/snapshots/{SnapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SnapshotId"],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"},"SnapshotId":{"type":"string","description":"The snapshot ID"},"Description":{"type":"string","description":"The snapshot description"},"SnapshotName":{"type":"string","description":"The snapshot name. The name must meet the following format requirements: It can contain only letters, digits, and underscores (_). It must…"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pailangstudio/version":{"post":{"operationId":"cloud_aliyun_pailangstudio_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://pailangstudio.ap-northeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-1.aliyuncs.com","https://pailangstudio.ap-southeast-5.aliyuncs.com","https://pailangstudio.cn-beijing.aliyuncs.com","https://pailangstudio.cn-hangzhou.aliyuncs.com","https://pailangstudio.cn-hongkong.aliyuncs.com","https://pailangstudio.cn-shanghai.aliyuncs.com","https://pailangstudio.cn-shenzhen.aliyuncs.com","https://pailangstudio.cn-wulanchabu.aliyuncs.com","https://pailangstudio.eu-central-1.aliyuncs.com","https://pailangstudio.us-east-1.aliyuncs.com"],"default":"https://pailangstudio.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://pailangstudio.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}