文档

SearchFaq - FAQ搜索

更新时间:

搜索知识。

调试

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

授权信息

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

请求参数

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

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public
Keywordstring

关键字

搜索标题
CategoryIdsarray

类目唯一标识

long

类目 ID

30000065594
Statusinteger

知识状态:-1-已删除未发布,1-未发布,2-已发布,3-已更新未发布

1
SearchScopeinteger

搜索范围:1-搜索标题相似问,2-搜索答案,3-搜索全部

枚举值:
  • 1搜索标题和相似问
  • 2搜索答案
  • 3搜索全部
1
CreateUserNamestring

创建人

test01
ModifyUserNamestring

修改人

test01
CreateTimeBeginstring

创建开始时间

2022-04-02T03:09:30Z
CreateTimeEndstring

创建结束时间

2022-05-02T03:09:30Z
ModifyTimeBeginstring

修改开始时间

2023-04-02T03:09:30Z
ModifyTimeEndstring

修改结束时间

2023-05-02T03:09:30Z
StartTimeBeginstring

生效开始时间

2022-04-02T03:09:30Z
StartTimeEndstring

生效结束时间

2022-04-03T03:09:30Z
EndTimeBeginstring

失效开始时间

2023-04-02T03:09:30Z
EndTimeEndstring

失效结束时间

2023-05-02T03:09:30Z
PageNumberinteger

页码默认 1

1
PageSizeinteger

每页数量,默认 10,最大 100

10

返回参数

名称类型描述示例值
object

返回值

FaqHitsobject []

知识搜索结果

KnowledgeIdlong

知识 ID

30002145804
ModifyTimestring

修改时间(UTC 时间)

2022-04-02T03:09:30Z
ModifyUserNamestring

修改人

test01
CreateTimestring

创建时间(UTC 时间)

2022-04-02T03:09:30Z
CreateUserNamestring

创建人

test01
CreateUserIdlong

创建人 ID

18453
ModifyUserIdlong

修改人 ID

18453
CategoryIdlong

类目 ID

30000055639
Statusinteger

知识状态:-1-已删除未发布,1-未发布,2-已发布,3-已更新未发布

3
EffectStatusinteger

知识生效状态,根据 StartDate,EndDate 计算出来:20-生效中,21-已失效,22-待生效

20
Titlestring

标题

测试标题
HitSimilarTitlesarray

命中的相似问题列表

string

相似问题

测试命中的标题
HitSolutionsarray

命中的答案列表

string

命中的答案

测试命中的答案
PageNumberinteger

页码

1
PageSizeinteger

每页数量

10
TotalCountinteger

总条数

1075
RequestIdstring

请求 ID

E45491D5-7E0A-42C6-9B21-91D1066B1475

示例

正常返回示例

JSON格式

{
  "FaqHits": [
    {
      "KnowledgeId": 30002145804,
      "ModifyTime": "2022-04-02T03:09:30Z",
      "ModifyUserName": "test01",
      "CreateTime": "2022-04-02T03:09:30Z",
      "CreateUserName": "test01",
      "CreateUserId": 18453,
      "ModifyUserId": 18453,
      "CategoryId": 30000055639,
      "Status": 3,
      "EffectStatus": 20,
      "Title": "测试标题",
      "HitSimilarTitles": [
        "测试命中的标题"
      ],
      "HitSolutions": [
        "测试命中的答案"
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1075,
  "RequestId": "E45491D5-7E0A-42C6-9B21-91D1066B1475"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-29API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)