文档 AIGC 元数据标识

最近更新时间:2025-11-05 16:02:22

我的收藏

简介

本文档提供关于数据万象文档 AIGC 元数据标识信息的相关 API 概览以及 SDK 示例代码。
注意:
该功能需要 COS Java SDK v5.6.257及以上版本。旧版本 SDK 该接口可能未覆盖或缺少更新参数,使用时建议升级到 最新版本
API
操作描述
通过本接口为文档添加 AIGC 元数据标识
通过本接口获取文档中的 AIGC 元数据标识信息

添加 AIGC 文档元数据标识

方法原型

public DocAIGCMetadataJobResponse createDocAIGCMetadataJob(DocAIGCMetadataJobRequest request)

使用示例

public static void createDocAIGCMetadataJob(COSClient client) {
//1.创建任务请求对象
DocAIGCMetadataJobRequest request = new DocAIGCMetadataJobRequest();
//2.添加请求参数 参数详情请见 api 接口文档
request.setBucketName("demo-1251704708");
// 设置输入文件
DocAIGCMetadataInput input = request.getInput();
input.setObject("test.pdf");
// 设置操作参数
DocAIGCMetadataOperation operation = request.getOperation();
// 设置文档 AIGC 元数据配置
DocAIGCMetadataConfig docAIGCConfig = operation.getDocAIGCMetadata();
DocAIGCMetadata aigcMetadata = docAIGCConfig.getAigcMetadata();
// 设置 AIGC 元数据参数
aigcMetadata.setLabel("1");
aigcMetadata.setContentProducer("testProducer");
aigcMetadata.setProduceId("${JobId}_${InputName}");
// Base64编码的预留字段
String reservedCode1 = Base64.getUrlEncoder().withoutPadding()
.encodeToString("security_info_1".getBytes(StandardCharsets.UTF_8));
aigcMetadata.setReservedCode1(reservedCode1);
aigcMetadata.setContentPropagator("testPropagator");
aigcMetadata.setPropagateId("${JobId}_propagate");
String reservedCode2 = Base64.getUrlEncoder().withoutPadding()
.encodeToString("security_info_2".getBytes(StandardCharsets.UTF_8));
aigcMetadata.setReservedCode2(reservedCode2);
// 设置输出参数
DocAIGCMetadataOutput output = operation.getOutput();
output.setRegion("ap-chongqing");
output.setBucket("demo-1251704708");
output.setObject("/SDK/doc/output/${SheetID}/excel_aigc_${Number}.xlsx");
//设置回调参数
request.setCallBackFormat("JSON");
request.setCallBack("https://your-callback-url.com/callback");
//3.调用接口,获取任务响应对象
DocAIGCMetadataJobResponse response = client.createDocAIGCMetadataJob(request);
System.out.println(CIJackson.toJsonString(response));
}

参数说明

节点名称(关键字)
父节点
描述
类型
是否必选
Request
保存请求的容器
Container
Container 类型 Request 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Tag
Request
创建任务的 Tag,目前仅支持:DocAIGCMetadata
String
Input
Request
待操作的文件对象
Container
Operation
Request
操作规则
Container
Container 类型 Input 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Object
Request.Input
输入文件所在存储桶中的文件路径
String
Container 类型 Operation 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
DocAIGCMetadata
Request.Operation
当 Tag 为 DocAIGCMetadata 时有效,用于指定文档 AIGC 标识内容的参数
Container
Output
Request.Operation
结果输出地址
Container
Container 类型 DocAIGCMetadata 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
AIGCMetadata
Request.Operation.DocAIGCMetadata
包含文档 AIGC 标识内容的具体参数
Container
Container 类型 AIGCMetadata 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Label
Request.Operation.DocAIGCMetadata.AIGCMetadata
生成合成标签要素,用于表示文档属于、可能、疑似为人工智能生成合成的属性信息
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
ContentProducer
Request.Operation.DocAIGCMetadata.AIGCMetadata
生成合成服务提供者要素,内容为文档生成合成服务提供者的名称或编码
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
ProduceID
Request.Operation.DocAIGCMetadata.AIGCMetadata
内容制作编号要素,内容为文档生成合成服务提供者对该内容的唯一编号
支持通配符:
${InputName}: COS 源文件名,不带后缀,不带路径
${InputNameAndExt}: COS 源文件名,带后缀,不带路径
${JobId}: 添加 AIGC 元数据信息的执行任务 id
${InputPath}: COS源文件路径,不包含文件名
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
ReservedCode1
Request.Operation.DocAIGCMetadata.AIGCMetadata
预留字段1,内容为用户自主开展安全防护,保护内容、标识完整性的信息。需经过 base64编码后传入
长度限制(base64编码前):2048个 UTF-8字符数
字符限制(base64编码前):GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
ContentPropagator
Request.Operation.DocAIGCMetadata.AIGCMetadata
内容传播服务提供者要素,内容为文档传播服务提供者的名称或编码
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
PropagateID
Request.Operation.DocAIGCMetadata.AIGCMetadata
内容传播编号要素,内容为文档传播服务提供者对该文档的唯一编号
支持通配符:
${InputName}: COS 源文件名,不带后缀,不带路径
${InputNameAndExt}: COS 源文件名,带后缀,不带路径
${JobId}: 添加 AIGC 元数据信息的执行任务 id
${InputPath}: COS 源文件路径,不包含文件名
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
ReservedCode2
Request.Operation.DocAIGCMetadata.AIGCMetadata
预留字段2,内容为用户自主开展安全防护,保护内容、标识完整性的信息。需经过 base64编码后传入
长度限制(base64编码前):2048个 UTF-8字符数
字符限制(base64编码前):GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
String
Container 类型 Output 的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Region
Request.Operation.Output
存储桶的地域
String
Bucket
Request.Operation.Output
存储结果的存储桶
String
Object
Request.Operation.Output
输出文件路径。
非表格文件输出文件名需包含 ${Number} 或 ${Page} 参数。多个输出文件,${Number} 表示序号从1开始,${Page} 表示序号与预览页码一致。
${Number} 表示多个输出文件,序号从1开始,例如输入 abc_${Number}.jpg,预览某文件5 - 6页,则输出文件名为 abc_1.jpg,abc_2.jpg
${Page} 表示多个输出文件,序号与预览页码一致,例如输入 abc_${Page}.jpg,预览某文件5-6页,则输出文件名为 abc_5.jpg,abc_6.jpg
表格文件输出路径需包含 ${SheetID} 占位符,输出文件名必须包含 ${Number} 参数。
例如 /${SheetID}/abc_${Number}.jpg,先根据 Excel 转换的表格数,生成对应数量的文件夹,再在对应的文件夹下,生成对应数量的图片文件
String

返回结果说明

查询 AIGC 文档元数据标识

功能说明

通过本接口获取文档中的 AIGC 元数据标识信息。

方法原型

public AIGCMetadataResponse getDocumentAIGCMetadata(String bucketName, String key)

使用示例

public static void getDocumentAIGCMetadata(COSClient client) {
String bucketName = "demo-1234567890";
String key = "test.pdf";
AIGCMetadataResponse response = client.getDocumentAIGCMetadata(bucketName, key);
System.out.println(Jackson.toJsonString(response));
}

参数说明

参数名称
描述
类型
是否必选
BucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
ObjectKey
对象文件名,例如 folder/demo.pdf
String

返回结果说明