调用ImportFpShotJob提交文本导库任务。

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ImportFpShotJob

系统规定参数。取值:ImportFpShotJob

Input String "PrimaryKey":"3e34ac649945b53a1b0f863ce030****",“Bucket”:”example-bucket-****”,“Location”:”example-location”,“Object”:”example-****.txt”

导库⽂件的OSS地址,JSON对象。例如:{"PrimaryKey":"3e34ac649945b53a1b0f863ce030****",“Bucket”:”example-bucket-****”,“Location”:”example-location”,“Object”:”example-****.txt”}。

PipelineId String ae687c02fe944327ba9631e50da2****

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

FpImportConfig String {["SearchFlag":"false"]}

导库配置,JSON对象。取值:

  • true:检索导库流程。
  • false:不检索导库流程。
UserData String ["Chapter":"平凡的****/平凡的****第⼆部/第⼆部第47章.txt"]

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

FpDBId String 88c6ca184c0e47098a5b665e2a12****

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

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

名称

类型

是否必选

描述

PrimaryKey

String

唯⼀的⽂本主键,唯⼀性由⽤户保证。

Bucket

String

⽂本⽂件所在OSSBucket,遵守OSS Bucket定义,详情请参见术语表Bucket

Location

String

⽂本⽂件OSS Bucket所在数据中⼼(OSSLocation),遵守OSS Location定义。详情请参见术语表Location。目前仅支持oss-cn-shanghai。

Object

String

⽂本⽂件(OSSObject)须进⾏UrlEncode,使⽤UTF-8编码,遵守OSSObject定义,详情请参见术语表Object

UserData

String

⽤户⾃定义数据,JSON格式,可以设置底库书名+章节名,如:{"Chapter":"平凡的**/平凡的**第⼆部/第⼆部第47章.txt"};最⼤⻓度128个字节。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A13-BEF6-D7393642CA58

请求ID。

JobId String c074b118ace44395a02063a5ab94****

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

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com?Action=ImportFpShotJob
&Input="PrimaryKey":"3e34ac649945b53a1b0f863ce030****",“Bucket”:”example-bucket-****”,“Location”:”example-location”,“Object”:”example-****.txt”
&PipelineId=ae687c02fe944327ba9631e50da2****
&FpImportConfig={["SearchFlag":"false"]}
&UserData=["Chapter":"平凡的****/平凡的****第⼆部/第⼆部第47章.txt"]
&FpDBId=88c6ca184c0e47098a5b665e2a12****
&<公共请求参数>

请求示例补充说明

单个JSON示例:
`{"PrimaryKey":"3e34ac649945b53a1b0f863ce030d395","Bucket":"mts-video-daily-bucket","Location":"oss-test","Object":"test.txt","UserData":"{"Chapter":"平凡
的世界/平凡的世界第⼆部/第⼆部第47章.txt"}"}
`

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ImportFpShotJobResponse>
    <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
    <JobId>c074b118ace44395a02063a5ab94****</JobId>
</ImportFpShotJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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