获取FAQ
功能介绍
根据ID获取FAQ详情,包括问题、答案。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/faq/{faq_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
faq_id |
是 |
String |
参数解释: FAQ ID,1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 获取方式:
取值范围: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: faq的ID。 取值范围: 不涉及 |
repo_id |
String |
参数解释: 知识库ID。 取值范围: 不涉及 |
question |
String |
参数解释: 问题。 取值范围: 不涉及 |
answer |
String |
参数解释: 答案。 取值范围: 不涉及 |
status |
String |
参数解释: 无实际意义,可忽略。 取值范围: 不涉及 |
create_user |
String |
参数解释: 创建人。 取值范围: 不涉及 |
create_time |
String |
参数解释: 创建时间。 取值范围: 不涉及 |
update_time |
String |
参数解释: 更新时间。 取值范围: 不涉及 |
question1 |
String |
参数解释: 相似问1。 取值范围: 不涉及 |
question2 |
String |
参数解释: 相似问2。 取值范围: 不涉及 |
question3 |
String |
参数解释: 相似问3 取值范围: 不涉及 |
question4 |
String |
参数解释: 相似问4。 取值范围: 不涉及 |
category |
String |
参数解释: 目录,单值,对应目录树中的叶子节点。 取值范围: 不涉及 |
tags |
Array of strings |
参数解释: 标签列表。
取值范围: 不涉及 |
file_id |
String |
参数解释: 文件ID。 取值范围: 不涉及 |
project_id |
String |
参数解释: 项目ID 取值范围: 不涉及 |
component_num |
Integer |
参数解释: 切片顺序 取值范围: 不涉及 |
page_num |
Integer |
参数解释: 页码数量。 取值范围: 不涉及 |
请求示例
根据ID获取FAQ详情。
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/0c3fae2d-428e-454c-ad80-2e5c5fa7b33a/faq?page_num=1&page_size=10&repo_id=0c3fae2d-428e-454c-ad80-2e5c5fa7b33a
响应示例
状态码:200
根据ID获取FAQ详情响应成功。
{ "id" : "5323205cfa9244b385ff5968ece0cd9a", "repo_id" : "123", "question" : "问题", "answer" : "答案", "status" : 0, "create_time" : "1716284755573", "update_time" : "1716284755573" }
状态码
状态码 |
描述 |
---|---|
200 |
根据ID获取FAQ详情响应成功。 |
错误码
请参见错误码。