CreateDocIndexTask
CreateDocIndexTask
创建异步索引任务,调用成功之后会返回一个 JobId,可以调用 GetDocIndexTask 查询任务执行状态。(当前只支持上海 Region)
请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Action | String | 是 | CreateDocIndexTask |
Project | String | 是 | 项目名 |
Set | String | 是 | 索引的文档集合,用以组织一批要进行索引的文档 |
UniqueId | String | 否 | 文档唯一 ID,如果不设置,取 SrcUri |
SrcUri | String | 是 | 源数据的存储位置,当前只支持 OSS 路径,例如:oss://bucket1/测试.docx |
Name | String | 否 | 文档名称 |
ContentType | String | 否 | 文档类型 |
CustomKey1 | String | 否 | 支持前缀匹配的 Key1,可以存储文件系统路径,用来搜索指定范围的数据 |
CustomKey2 | String | 否 | 支持前缀匹配的 Key2 |
CustomKey3 | String | 否 | 支持精准匹配的 Key3 |
CustomKey4 | String | 否 | 支持精准匹配的 Key4 |
CustomKey5 | String | 否 | 支持全文检索的 Key5,可以存储标签等 |
CustomKey6 | String | 否 | 支持全文检索的 Key6 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户 |
TaskId | String | 任务 ID |
Status | String | 任务状态,该接口固定返回Running |
CreateTime | String | 任务创建时间 |
示例
请求示例
POST https://imm.cn-shanghai.aliyuncs.com
?Action=CreateDocIndexTask
&Project=test
&Set=set1
&SrcUri=oss://bucket1/test.pptx
...
此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API。
成功返回示例
{
"Status": "Running",
"CreateTime": "2018-11-27T06:59:17.998Z",
"RequestId": "E32F1454-9C0C-4334-A1A4-9303A19C1B32",
"TaskId": "86f452bb-4380-4c1f-bcd1-2ffcb447bc8a"
}
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论