自定义文本库接口
更新时间：2022-10-27
创建自定义文本库
创建自定义文本库
请求语法
POST /v<version>/text/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义文本库名称，最长40个字符 | 是 |
| description | String | 描述，最大支持256字符 | 否 |
请求示例
POST /v1/text/lib HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"name": "test",
"description": "text lib description"
}响应参数
无
响应示例
HTTP/1.1 200 OK删除自定义文本库
删除自定义文本库
请求语法
DELETE /v<version>/text/lib/{name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义文本库名称 | 是 |
请求示例
DELETE /v1/text/lib/name HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应示例
HTTP/1.1 200 OK列出所有文本库
列出所有自定义文本库
请求语法
GET /v<version>/text/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
无
请求示例
GET /v1/text/lib HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| textLibList | Array | 自定义库集合 | 是 |
| +name | String | 自定义文本库名称 | 是 |
| +description | String | 描述，最大支持256字符 | 否 |
| +matchType | String | 匹配类型，默认切词包含 | 是 |
| +itemCount | Integer | 文本个数 | 是 |
| +createTime | Date | 创建时间 | 是 |
响应示例
HTTP/1.1 200 OK
{
"libs": [
{
"name": "test",
"matchType": "contain",
"itemCount": 20,
"description": "test text lib",
"createTime": "2019-11-22 17:00:00"
}
]
}添加自定义文本
往指定的自定义文本库中添加文本。
请求语法
PUT /v<version>/text/lib/{name}?add HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义人脸库名称 | 是 |
| items | Array | 文本库集合 | 是 |
请求示例
PUT /v1/text/lib/test?add HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"items": [
"测试", "test"
]
}响应参数
无
响应示例
HTTP/1.1 200 OK删除自定义文本
删除指定的自定义文本库中的文本。
请求语法
PUT /v<version>/text/lib/{name}?delete HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义人脸库名称 | 是 |
| items | Array | 文本库集合 | 是 |
请求示例
PUT /v1/text/lib/test?delete HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"items": [
"测试", "test"
]
}响应参数
无
响应示例
HTTP/1.1 200 OK查看文本库文本内容
查看自定义文本库中文本内容
请求语法
GET /v<version>/text/lib/{name}?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| name | String | 自定义文本库名称 | 是 |
| pageNo | Integer | 分页页数，默认为1 | 否 |
| pageSize | Integer | 分页显示条数，默认为20 | 否 |
请求示例
GET /v1/text/lib/test?pageNo=1&pageSize=20 HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| pageNo | Integer | 分页页数 | 是 |
| pageSize | Integer | 分页显示条数 | 是 |
| items | Array | 文本库内容集合 | 是 |
响应示例
HTTP/1.1 200 OK
{
"pageNo": 1,
"pageSize": 20,
"items": [
"测试", "test"
]
}