文档

ImportFpShotJob - 提交文本导库任务

更新时间:

提交文本导库任务。

接口说明

  • 本接口将文本批量导入文本 DNA 库,通过提取文本特征进行保存。
  • 文本 DNA 相关功能目前仅支持华东 2(上海)地域使用。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

导库⽂件的 OSS 地址,JSON 对象。例如:{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.txt"}

说明 OSS 的地域需要与当前 MPS 所在地域保持一致。
{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.txt"}
PipelineIdstring

管道 ID,可以通过 MPS 控制台 > 全局设置 > 管道获取。⽤于区分业务,绑定消息通知。若不传,则使⽤默认管道,不绑定消息通知。

ae687c02fe944327ba9631e50da2****
FpImportConfigstring

导库配置,JSON 对象。 例如:{"SaveType":"onlysave"}。其中SaveType表示存储类型,取值包括:

  • save:去重入库。

  • onlysave:仅入库。

{"SaveType":"onlysave"}
UserDatastring

用户自定义数据,支持中英文、数字、特殊符号。最大长度 128 字节。

{"Chapter":"平凡的****/平凡的****第⼆部/第⼆部第47章.txt"}
FpDBIdstring

DNA 库 ID,⽤于批量导⼊⽂本特征,⼀个库只能并⾏处理⼀个导库任务。可以从提交新建 DNA 库的返回参数中获取。

88c6ca184c0e47098a5b665e2a12****

其中,输入文件内容为所有待导入的文件信息,一行一条信息结构体,JSON 结构,包含如下参数:

名称类型是否必选描述
PrimaryKeyString唯⼀的⽂本主键,唯⼀性由⽤户保证。
BucketString⽂本⽂件所在 OSS Bucket,遵守 OSS Bucket 定义,详情请参见术语表 Bucket
LocationString⽂本⽂件 OSS Bucket 所在数据中⼼(OSSLocation),遵守 OSS Location 定义。详情请参见术语表 Location。目前仅支持 oss-cn-shanghai。
ObjectString⽂本⽂件(OSSObject),遵循 RFC 2396(UTF-8 编码,并进行 URLEncode。更多信息,请参见 URLEncode 说明),遵守 OSSObject 定义,更多信息请参见术语表 Object
UserDataString⽤户⾃定义数据,JSON 格式,可以设置底库书名+章节名,如:{"Chapter":"平凡的****/平凡的****第⼆部/第⼆部第 47 章.txt"};最⼤⻓度 128 个字节。

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

25818875-5F78-4A13-BEF6-D7393642CA58
JobIdstring

批量导库作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。

c074b118ace44395a02063a5ab94****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "JobId": "c074b118ace44395a02063a5ab94****"
}

错误码

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

  • 本页导读 (1)