更新时间:2025-08-11 GMT+08:00

更新FAQ

功能介绍

更新指定ID的FAQ的问题、答案、相似问题。

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/faq

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

参数解释:

FAQ ID。

约束限制:

不涉及

取值范围:

长度不能超过64个字符。

默认取值:

不涉及

question

String

参数解释:

问题。

约束限制:

不涉及

取值范围:

长度不能超过1000个字符。

默认取值:

不涉及

answer

String

参数解释:

答案。

约束限制:

不涉及

取值范围:

长度不能超过10000个字符。

默认取值:

不涉及

repo_id

String

参数解释:

知识库ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

question1

String

参数解释:

相似问题。

约束限制:

不涉及

取值范围:

长度不能超过1000个字符。

默认取值:

不涉及

question2

String

参数解释:

相似问题。

约束限制:

不涉及

取值范围:

长度不能超过1000个字符。

默认取值:

不涉及

question3

String

参数解释:

相似问题。

约束限制:

不涉及

取值范围:

长度不能超过1000个字符。

默认取值:

不涉及

question4

String

参数解释:

相似问题。

约束限制:

不涉及

取值范围:

长度不能超过1000个字符。

默认取值:

不涉及

file_id

String

参数解释:

文档ID。

约束限制:

不涉及

取值范围:

长度不能超过36个字符。

默认取值:

不涉及

category

String

参数解释:

目录,单值,对应目录树中的叶子节点。

约束限制:

只能包含非控制字符、非私有使用字符和非代理字符, 字段的长度最大为255。

取值范围:

不涉及

默认取值:

不涉及

tags

String

参数解释:

标签列表,多个标签以逗号分隔。

约束限制:

  • 文档可以有一个或多个标签

  • 建议标签值不区分大小写

  • 不要使用保留字符,否则查询时需要转义:+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /

  • 完整替换,不支持部分更新。

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

响应成功。

请求示例

更新FAQ实例。

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/cefb2a59-2f9e-4268-b56b-eab15dc0b9d6/uni-search/faq

{
  "answer" : "测试用例答案",
  "repo_id" : "a8f1385b-feca-4ac6-9fe3-6929d0885e3a",
  "id" : "a0d6c0d0-ca60-4684-a835-8309c2062bed",
  "question" : "测试用例1",
  "question1" : "测试用例2",
  "question2" : "测试用例3",
  "question3" : "测试用例4",
  "question4" : "测试用例5"
}

响应示例

状态码

状态码

描述

200

响应成功。

错误码

请参见错误码