检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 URI POST /v1/koosearch/
终端节点 终端节点（Endpoint）即调用API的请求地址，KooSearch局点在贵阳一，终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
当已发布的KooSearch API不希望被调用时，可以下线API。 配置API网关 创建实例：使用API网关，需要先购买实例。 实例需要跟KooSearch服务在同一个VPC和子网。 创建API分组：API分组相当于API的集合，您在创建API前，需要先创建API分组。 创建环境：API可以同时提
在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一
结构化数据接口 API 说明 结构化数据上传 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 下载失败的条目 下载一个JSON文件，该文件包含给定上传Field的失败条目。 结构化数据文件搜索 根据文件名搜索目标文件。 表4 文件管理接口 API 说明 上传文件
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
NLP模型-云底座：通过华为云提供的盘古nlp大模型访问方式。 NLP模型-昇腾云：通过昇腾云的MAAS服务提供的nlp大模型访问方式。如果选择此模型进行问答，建议设置模型生成最大新词数不超过512。 NLP模型-裸机：通过裸机部署提供的盘古nlp大模型访问方式。 搜索Embedding模型：搜索向量化模型，支持将文本转化成向量。
在服务的基本信息页面，可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外，还能进行管理服务、API管理和日志管理。 管理服务：KooSearch文档问答服务针对已创建的服务所配置的集群，可前往云搜索服务控制台对集群进行管理。 API管理：KooSearch服务
、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度：0 最大长度：64
https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式： 账号登录CSS控制台。 左侧导航栏选择：“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”，单击进入已购买的服务。 单击“API管理”，即可看到支持的所有API列表。 单击展
HTTPS请求的API（Application programming interface）管理方式。 API方式 如果用户需要将公有云平台上的集成到第三方系统，用于二次开发，请使用API方式访问，具体操作请参见《Flexus企业搜索服务API参考》。 控制台方式 其他相关操作，
、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度：0 最大长度：64
、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度：0 最大长度：64
勾选后，解析结果中包含目录页。 拆分设置：即分段设置，选择分段方式。 表2 拆分设置 参数 说明 自动分段 系统根据文档特点自动选择合适的分段方式。 长度分段 默认按照段落进行拆分合并，如果段落过长则通过标识符进行分段。 分段标识符：分段方式为遇到所选符号即截断，符号之间没有优先级，最终分割
否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id 否 String 文档解析ID 最小长度：0 最大长度：64
Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。
否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表5 ParseConf 参数 是否必选 参数类型 描述 ocr_enabled
、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表6 ParseConf 参数 参数类型 描述 ocr_enabled
、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表7 ParseConf 参数 参数类型 描述 ocr_enabled
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
