SubmitAuditNote - 提交自定义规则库

妙笔为您提供了与公有云“智能审校”模块中相同的上传自定义规则库的功能。由于鉴权限制,用户需要使用自定义规则库文件的 fileKey 作为入参才能顺利调用本接口。该接口在被调用后,会对用户的自定义规则库进行结构化处理,并生成一个 xlsx 格式的结构化解析结果。您可以调用 GetAuditNoteProcessingStatus 接口查询结构化处理状态,也可以调用 DownloadAuditNote 接口获取结构化之后的规则库。接口功能正在迭代中,预计会在未来使用可访问的文件 URL 作为入参。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
WorkspaceIdstring

阿里云百炼业务空间唯一标识:获取业务空间 ID(Workspace ID)

llm-xx
FileKeystring

阿里云 OSS 存储中,用户上传的规则库文件对应的 FileKey(注意:FileKey 生成方式见 通用接口-文件上传下载 GenerateUploadConfig - 生成上传配置)。规则库文件只允许使用 docx, xlsx, pdf 格式,其中 xlsx 格式限制两列,且表头必须为“审校依据”和“依据出处”。上传 xlsx 格式能有更好的解析效果,但 docx 和 pdf 也会由系统自动解析。

oss://default/your/file/key

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

F2F366D6-E9FE-1006-BB70-2C650896AAB5
Successboolean

此次请求是否成功

true
Codestring

状态码

DataNotExists
Messagestring

错误说明

success
HttpStatusCodeinteger

http 状态码

200
Datastring

本次提交规则库的任务 ID(taskId / TaskId),供之后的接口调用使用。

xxx_Default_89123748917

示例

正常返回示例

JSON格式

{
  "RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
  "Success": true,
  "Code": "DataNotExists",
  "Message": "success",
  "HttpStatusCode": 200,
  "Data": "xxx_Default_89123748917"
}

错误码

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