问答查询接口
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/api/faq/query
请求说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
tenantId |
String |
body |
True |
租户ID |
faqGroupId |
int |
body |
True |
问答组id |
name |
String |
body |
False |
名称:一条问答记录的问题,不填则返回全部问答。 |
pageNum |
int |
body |
True |
页码 分页查询,查询第几页,首页为1 |
pageSize |
int |
body |
True |
每页多少条 |
authToken |
String |
body |
True |
认证token。 请参见C3 智能助手平台接口鉴权方式。 |
响应说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
data |
FaqElementModel[] |
body |
True |
问答数据 |
totalSize |
int |
body |
True |
总条数 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
id |
int |
body |
True |
内部序号 |
faqGroupId |
int |
body |
True |
问答组id |
question |
String |
body |
True |
问,最大8192个字符 |
simQuestions |
SimStatementUnit[] |
body |
False |
相似问,最多100个 |
answer |
String |
body |
True |
答,最大8192个字符 |
simAnswers |
SimStatementUnit[] |
body |
False |
相似答,最多100个 |
keywords |
KeywordUnit[] |
body |
False |
关键字,最多20个 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
id |
int |
body |
True |
内部序号 |
elementId |
int |
body |
True |
问答id |
statement |
String |
body |
True |
问或答的内容,最大8192个字符 |
type |
String |
body |
True |
Q:问 A:答 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
w |
String |
body |
True |
关键字,最大64个字符 |
报文样例
- 请求消息样例
{ "tenantId": "00030010", "faqGroupId":10000, "name":"", "pageNum":1, "pageSize":10, "authToken": "e**************************" }
- 响应消息样例
{ "data": [ { "id": 10007, "faqId": 10000, "question": "什么是问答机器人?", "simQuestions": [], "answer": " 根据用户的具体问题自动给出具体答案的应答机器人。", "simAnswers": [], "keywords": [] }, { "id": 10008, "faqId": 10000, "question": "什么是任务型对话机器人?", "simQuestions": [], "answer": " 一系列以完成某项有明确目标的一系列任务(例如预订机票、订餐、开通彩铃等)为导向的对话机器人。", "simAnswers": [], "keywords": [] } ], "totalSize": 2 }