Skip to main content
本文介绍如何通过 REST API 管理审核规则库、规则组和规则。规则库管理采用三层结构:规则库 → 规则组 → 规则。您需要先创建规则库,然后在规则库下创建规则组,最后在规则组下创建规则。
智能审核的规则库管理采用三层结构:规则库(Rule Repository)规则组(Rule Group)规则(Rule)。本文介绍如何通过 REST API 进行规则库管理。

规则库管理

规则库是审核规则的顶层容器,用于组织和管理相关的审核规则。

创建规则库

创建审核规则库:
请求参数:
  • workspace_id (必填): 工作空间ID
  • name (必填): 规则库名称,最大长度30
响应示例:

获取审核规则库列表

获取工作空间下的所有审核规则库列表,包含规则库下的规则组和规则信息:
请求参数:
  • workspace_id (必填): 工作空间ID
  • page (选填): 页码,默认为 1
  • page_size (选填): 每页条数,默认为 10
响应示例:

获取审核规则库

根据规则库ID获取单个审核规则库的详细信息:
请求参数:
  • workspace_id (必填): 工作空间ID
  • repo_id (必填): 审核规则库ID
响应示例:

更新规则库

更新审核规则库的名称:
请求参数:
  • workspace_id (必填): 工作空间ID
  • repo_id (必填): 规则库ID
  • name (必填): 新的规则库名称,最大长度30

删除规则库

删除审核规则库(可以批量删除):
请求参数:
  • workspace_id (必填): 工作空间ID
  • repo_ids (必填): 规则库ID数组
删除规则库会同时删除其下的所有规则组和规则,请谨慎操作。

规则组管理

规则组是规则库下的二级分类,用于对规则进行更细粒度的分组管理。

创建规则组

在规则库下创建规则组:
请求参数:
  • workspace_id (必填): 工作空间ID
  • repo_id (必填): 规则库ID
  • name (必填): 规则组名称,最大长度30
响应示例:

更新规则组

更新规则组的名称:
请求参数:
  • workspace_id (必填): 工作空间ID
  • group_id (必填): 规则组ID
  • name (必填): 新的规则组名称,最大长度30

删除规则组

删除规则组:
请求参数:
  • workspace_id (必填): 工作空间ID
  • group_id (必填): 规则组ID
删除规则组会同时删除其下的所有规则,请谨慎操作。

规则管理

规则是审核的最小执行单元,定义了具体的审核标准和逻辑。

创建规则

在规则组下创建审核规则:

获取分类ID和字段ID

在创建规则之前,需要先获取分类ID(category_id)和字段ID(field_id)。这些ID可以通过以下接口获取:

获取分类列表

获取工作空间下的所有分类,用于获取分类ID:
响应示例:
从响应中获取 categories[].id 即为分类ID(category_id)。

获取分类字段列表

获取指定分类下的所有字段,用于获取字段ID:
响应示例:
从响应中获取:
  • fields[].id 即为普通字段ID(field_id
  • tables[].id 即为表格ID(table_id
  • tables[].fields[].id 即为表格字段ID(field_id
请求参数:
  • workspace_id (必填): 工作空间ID
  • repo_id (必填): 规则库ID
  • group_id (必填): 规则组ID
  • name (必填): 规则名称
  • prompt (必填): 规则提示词,描述审核规则的提示词,用于指导AI进行审核判断
  • category_ids (选填): 适用分类ID数组,规则适用于哪些文档分类。通过获取分类列表接口获取
  • risk_level (选填): 风险等级,可选值:10(高风险)、20(中风险)、30(低风险)
  • referenced_fields (选填): 关联字段数组,规则需要关联的抽取字段。字段ID通过获取分类字段列表接口获取
关联字段结构说明:
响应示例:

更新规则

更新审核规则:
请求参数:
  • workspace_id (必填): 工作空间ID
  • rule_id (必填): 规则ID
  • 其他参数与创建规则相同,用于更新规则属性

删除规则

删除审核规则:
请求参数:
  • workspace_id (必填): 工作空间ID
  • rule_id (必填): 规则ID

规则创建流程示例

完整的规则创建流程(包含获取分类ID和字段ID):
Python

相关页面