调用CreateKnowledgeBaseJob API创建知识库任务-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

创建知识库任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pailangstudio:CreateKnowledgeBaseJob

create

*全部资源

*

无

请求语法

POST /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	否	知识库 ID。	d-ksicx823d

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体。
WorkspaceId	string	是	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	478**
Accessibility	string	否	工作空间可见性，可能值为： PRIVATE：在此工作空间中，仅对您和管理员可见。 PUBLIC：在此工作空间中，对所有人可见。枚举值： PUBLIC : 对当前工作空间中的所有人可见 PRIVATE : 仅对当前工作空间中的本人和管理员可见	PUBLIC
Description	string	否	知识库任务描述。	This is a description of the knowledge base job.
JobAction	string	否	任务操作类型。 SyncIndex：更新知识库索引	SyncIndex
MaxRunningTimeInSeconds	integer	否	任务最大运行时间，单位秒。	86400
ResourceId	string	否	资源组 ID。为空或 public-cluster 表示公共资源。	quota89**76
EcsSpecs	array<object>	否	任务运行资源配置列表。文档和结构化知识库仅包含 1 个元素且 Type 为 Worker，图片和视频知识库含 2 个元素且 Type 分别为 Head 和 Worker。
	object	否
Type	string	否	节点类型。可能的取值为 Head 和 Worker。	Worker
InstanceType	string	否	机型名称。使用公共资源须填写。	ecs.c6.large
PodCount	integer	否	副本数量。	1
CPU	integer	否	CPU 核数。使用资源配额须填写。	2
GPU	integer	否	GPU 卡数。使用资源配额须填写。	1
Memory	integer	否	内存大小，单位 GB。使用资源配额须填写。	8
SharedMemory	integer	否	共享内存容量，单位 GB。使用资源配额须填写。	16
GPUType	string	否	GPU 类型	16
Driver	string	否	GPU 驱动版本。	535.161.08
UserVpc	object	否	任务运行 VPC 信息。
VpcId	string	否	VPC ID。	vpc-wz90****5v23
VSwitchId	string	否	交换机 ID。	vsw-wz9r****ng10
SecurityGroupId	string	否	安全组 ID。	sg-wz9i****1129
EmbeddingConfig	object	否	索引配置。
BatchSize	integer	否	索引分批大小。文档和结构化数据类型知识库有效。	8
Concurrency	integer	否	索引并发数。图片和视频类型知识库有效。	1

返回参数

名称	类型	描述	示例值
	object
KnowledgeBaseJobId	string	知识库任务 ID。	kbjob-9mn******1z54
RequestId	string	请求 ID。	963BD7F9-0C02-5594-9550-BCC6DD43E3C0

示例

正常返回示例

JSON格式

{
  "KnowledgeBaseJobId": "kbjob-9mn******1z54",
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。