检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud
“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题： 如何调用API
"error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。 父主题： 如何调用API
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。 父主题： 如何调用API
KooSearch服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。 父主题： 使用前必读
服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found
在公网NAT网关列表页面，单击“购买公网NAT网关”，进入购买公网NAT网关页面。 在购买公网NAT网关页面，配置NAT网关。 关键参数请参见表2配置，其他参数可以保持默认值或基于业务场景参考购买公网NAT网关完成配置。 表2 购买公网NAT网关 参数 说明 计费模型 因为KooSearch是离线服务，建议选择“按需计费”。
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
单击页面右上角的“购买Flexus企业搜索服务”按钮，进入购买页面。 在购买页面，完成“区域”、“版本规格”、“实例名称”、“OCR增强”、“网络配置”、“购买时长”配置，配置参数如下表所示。 表1 购买Flexus企业搜索服务 参数 子参数 说明 区域 - 实例的所在区域。 版本规格 智能搜索版 提
修改知识库配置 功能介绍 修改知识库配置。 包括： 解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置：自动分段、长度分段（按文本长度分段）、层级分段（按小标题分段，可自定义小标题解析规则） 搜索模型设置：rerank模型配置 NLP模型设置：生成模型选择
配置Flexus企业搜索服务集群路由 当KooSearch服务需要主动访问公网，或者是需要跨网络访问KooSearch API，则需要配置KooSearch服务的集群路由，连通网络。 操作步骤 进入KooSearch服务详情页面。 登录云搜索服务管理控制台。 在左侧导航栏选择“K
新增模型 功能介绍 新增配置模型，包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
修改“搜索模型设置”、“NLP模型设置”和“高级设置”，如何修改请参考新建知识库中步骤5和步骤6。 同时支持新增“其他”设置。 表6 其他设置 参数 说明 topk召回数量 设置topk召回数量。 召回结果中topk的文档将被精排模型使用。 topk未配置时，将使用默认值50。 参考文档数量 设置RAG大模型参考的文档数量。
创建和管理KooSearch模型服务（可选） 场景描述 用户可以在模型管理页面配置不同的模型，建好的模型服务可以在体验问答和搜索的时候用来配置，也可以在配置知识库时，选择您建好的模型。 创建模型服务 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企
"repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "如何申请入学？", "answer" : "请查看我们的官方网站或联系招生办公室，了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。"
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 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
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
