检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式： 账号登录CSS控制台。 左侧导航栏选择：“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”，单击进入已购买的服务。 单击“API管理”，即可看到支持的所有API列表。 单击展
么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
选择目标服务，单击服务名称，进入服务详情页。 查看KooSearch服务基本信息和配置信息。 表1 基本信息 参数 描述 名称 服务名称。 ID 服务的唯一标识，是系统自动生成的。 集群状态 服务当前的状态。 内网访问文档解析地址 服务的内网访问文档解析地址。 产品规格 服务的产品规格。 计费模式 服务的计费模式。
配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址，取前16位或者24位，例如源IP为“192.168.1.1”，可以填“192.168.0.0”。 子网掩码 填写IP地址的子网掩码。 当IP地址取的是16位，则子网掩码填“255.255.0.0”。 当IP地址取的是24位，则子网掩码填“255
如何调用API 构造请求 认证鉴权 接口获取 返回结果
返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求
是否扩展长上下文。提供更广泛的上下文，以生成完整回答。 缺省值：false effective_input_length Integer 效果最好的上下文长度，与模型相关，确保输入令牌的有效长度以保证最佳输出 考虑到多轮对话，建议控制在模型上下文长度的60%（向上取整）。 最小值：2
Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 T
终端节点 终端节点（Endpoint）即调用API的请求地址，KooSearch局点在贵阳一，终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
选择“使用已有”，选择和KooSearch同一个VPC。 公网IP类型 选择“弹性公网IP”，勾选满足要求的IP。 如果没有可选的弹性公网IP，可以单击“查看弹性公网IP”跳转到弹性公网IP列表页，申请弹性公网IP。 建议弹性公网IP的“计费模式”为“按需计费”，“公网带宽”为“按流量计费
下载失败的条目 功能介绍 下载一个JSON文件，该文件包含给定上传Field的失败条目。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
选择“使用已有”，选择和KooSearch同一个VPC。 公网IP类型 选择“弹性公网IP”，勾选满足要求的IP。 如果没有可选的弹性公网IP，可以单击“查看弹性公网IP”跳转到弹性公网IP列表页，申请弹性公网IP。 建议弹性公网IP的“计费模式”为“按需计费”，“公网带宽”为“按流量计费
管理KooSearch知识库 创建好的知识库可以进行查看、关闭、开启、引用、删除等操作。 查看知识库详情 进入KooSearch控制台。 左侧导航栏选择“知识库管理”，进入“知识库管理”页面。 单击需要查看的知识库的操作列的“文档管理”，进入知识库详情页面。 图1 查看知识库详情 进入详情页面
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中，上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
查询FAQ列表 功能介绍 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
KooSearch服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。 父主题： 使用前必读
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
