检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
公共参数 状态码 错误码
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
图片管理 上传图片 获取图片内容
搜索与问答 搜索知识库 生成答案
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
None 服务介绍 云搜索服务 CSS 基本功能介绍 14:01 快速使用云搜索服务 特性讲解 Flexus企业搜索服务 KooSearch文档问答 05:22 了解什么是KooSearch文档问答 云搜索服务 CSS Elasticsearch增强能力 07:15 了解CSS的Elasticsearch增强能力
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
doc:文档知识,使用query2doc模型 faq:FAQ,常见问答集,使用query2query模型 web:网络来源,来自于web搜索引擎 缺省值:doc 最小长度:1 最大长度:16 枚举值: doc faq web 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 doc_list
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 请求示例 配置示例 /v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/common-prompt
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1/koosearch/rep
xlsx, .xls, .csv, .wps, .png, .jpg, .jpeg, .bmp, .gif, .tiff, .tif, .webp, .pcx, .ico, .psd, .dps, .et, .txt, .ofd 的多个文档,单个文档不能超过128MB(超过60MB
服务的内网访问知识管理地址。 表2 配置信息 参数 描述 虚拟私有云 服务所属的虚拟私有云。 企业项目 服务所属的企业项目。 单击项目名称可以跳转到项目管理页面查看企业项目的基本信息。 子网 服务所属的子网。 集群路由 单击右侧的“修改”,可修改集群路由信息,详情请参见配置Flexus企业搜索服务集群路由。
模型管理接口 模型管理的相关接口。 用户的文档解析规则定义接口 用户文档解析自定义规则配置接口。 表2 知识库管理接口 API 说明 创建知识库 创建名称为xxx的知识库。 修改知识库配置 修改知识库配置。包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。
页面。 单击右上角,在“资料来源”对话框勾选知识库,单击“确定”。 搜索体验将在所选择的知识库中进行搜索。 配置搜索 在“体验平台”页面单击右上角,在配置页面设置搜索配置。 “相关性阈值”:超过相关度阈值的搜索结果才能在搜索结果页展示,否则会被过滤。 单击“确定”。 体验搜索 在
问答体验将在所选择的知识库中进行答案搜索。 配置问答 在“体验平台”页面,单击右上角,在配置页面进行问答配置。 表1 问答配置 参数分类 参数 说明 搜索配置 相关性阈值 超过相关度阈值的搜索结果才能在搜索结果页展示,否则被过滤。 问答配置 NLP模型服务 选择NLP模型服务。 引用相关度阈值
object 文档解析配置,包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等
最大长度:128 vector_config VectorConfig object 向量模型的相关配置 nlp_config NlpConfig object NLP大模型相关配置 表6 IamInfo 参数 参数类型 描述 iam_enabled Boolean 是否启用iam鉴权
设置topk召回数量。 召回结果中topk的文档将被精排模型使用。 topk未配置时,将使用默认值50。 参考文档数量 设置RAG大模型参考的文档数量。 参考文档数量未配置时,将使用默认值3 精排 知识库精排开关默认为开启状态,如果未配置,则为开启状态。 注意: 关闭精排时相关性得分范围为0-20