1. 增加黑名单
接口描述
向黑名单中添加URL,用于检测和拦截访问,防止用户访问恶意或受限制的网站,该配置仅对智能搜索生成接口生效。
注意事项
- 按照用户ID(鉴权Token对应的用户ID)来区分过滤规则,某个用户ID下配置的规则,仅对该用户生效。
- 调用网页黑名单接口的用户ID要和调用问答接口的用户ID保持一致。
- 网页过滤发生在百度搜索之后,被过滤的网页,不参与模型问答总结。
接口定义
URL |
qianfan.baidubce.com/v2/ai_search/url_black_list |
Method |
POST |
Content-Type |
application/json |
Authorization |
请求签名(Bearer <AppBuilder API Key>) |
请求结构
POST /v2/ai_search/url_black_list HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <AppBuilder API Key>
Content-Type: application/json
{
"black_item": {
"url": "https://z***o.baidu.com/question/150***8519979.html"
}
}
Body参数
参数名称 |
类型 |
是否必选 |
描述 |
config_id |
string |
否 |
策略配置ID,需要提前调用配置接口创建ID。 |
black_item |
object |
是 |
黑名单url内容。 |
+ url |
string |
是 |
按照url进行前缀匹配过滤,对应以下两种情况: 1. 如果url设置为https://unsafe.com/ ,则该站点下的所有网页均会被过滤。 2. 如果url设置为https://zhidao.baidu.com/question/1.html , 则仅会过滤该具体网址。 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 |
类型 |
描述 |
request_id |
string |
请求ID。 |
code |
string |
错误码,当发生异常时返回。 |
message |
string |
错误消息,当发生异常时返回。 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/ai_search/url_black_list' \
--header 'Authorization: Bearer authorization string' \
--header 'X-Appbuilder-Authorization: <token>' \
--data '{
"black_item": {
"url": "https://zhidao.baidu.com/question/1***79.html"
}
}'
响应示例
2. 删除黑名单
接口描述
删除黑名单中的URL。
接口定义
URL |
qianfan.baidubce.com/v2/ai_search/url_black_list |
Method |
DELETE |
Content-Type |
application/json |
Authorization |
请求签名(Bearer <AppBuilder API Key>) |
请求参数
参数名称 |
类型 |
是否必选 |
描述 |
url |
string |
是 |
待删除的url。 |
config_id |
string |
否 |
策略配置ID,需要提前调用配置接口创建ID。 |
响应参数
字段 |
类型 |
必填 |
说明 |
request_id |
string |
是 |
请求ID。 |
code |
string |
否 |
错误码,当发生异常时返回。 |
message |
string |
否 |
错误消息,当发生异常时返回。 |
调用示例
curl -X DELETE \
-H "Authorization: Bearer authorization string" \
'https://qianfan.baidubce.com/v2/ai_search/url_black_list?url=https%3A%2F%2Fzhidao.baidu.com%2Fquestion%2F10**79.html'
响应示例
3. 查询网页黑名单
接口定义
URL |
qianfan.baidubce.com/v2/ai_search/url_black_list |
Method |
GET |
Content-Type |
application/json |
请求结构
GET /v2/ai_search/url_black_list HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <AppBuilder API Key>
参数名称 |
描述 |
Authorization |
AppBuilder API Key请前往控制台获取。 |
Query参数
参数名称 |
类型 |
是否必选 |
描述 |
offset |
string |
否 |
偏移量 |
limit |
string |
否 |
条数限制,最大不超过50。 |
config_id |
string |
否 |
策略配置ID,需要提前调用配置接口创建ID。 |
调用示例
curl --location 'https://qianfan.baidubce.com/v2/ai_search/domain_knowledge?offset=0&limit=50&config_id=xxx' \
--header 'X-Appbuilder-Authorization: Bearer <AppBuilder API Key>' \
响应参数
参数名称 |
类型 |
是否必选 |
描述 |
request_id |
string |
是 |
请求ID。 |
count |
int |
是 |
黑名单列表总长度。 |
items |
array<Object> |
是 |
黑名单列表。 |
+ url |
string |
是 |
网页地址。 |
message |
string |
否 |
错误消息,当发生异常时返回。 |
输出示例
{
"count": 4,
"items": [
{
"url": "http://abc.com"
},
{
"url": "http://efg.com"
}
],
"request_id": "94c0df15-993b-4ab4-8e92-2d6272255dfb"
}