检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于“获取用户Token”接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，********为用户的登录密码，
根据“名称/ID”，单击进入已购买的服务。 单击“API管理”，即可看到支持的所有API列表。 单击展开箭头，即可查看每个API详情，包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题： 如何调用API
选择目标服务，单击服务名称，进入服务详情页。 查看KooSearch服务基本信息和配置信息。 表1 基本信息 参数 描述 名称 服务名称。 ID 服务的唯一标识，是系统自动生成的。 集群状态 服务当前的状态。 内网访问文档解析地址 服务的内网访问文档解析地址。 产品规格 服务的产品规格。 计费模式 服务的计费模式。
在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
Studio大模型即服务平台选择合适的模型，创建为“我的模型”。操作指导请参见在MaaS中创建模型。 将创建好的模型部署为模型服务，具体操作请参见使用MaaS部署模型服务。 选择使用AppCode认证方式调用部署好的模型服务，具体操作请参见调用MaaS部署的模型服务。 获取并记录模型服务的“调用模型名称
查询FAQ列表 功能介绍 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是
识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 file_name 是 String 结构化数据的文件名 最小长度：1 最大长度：1024 file_status
返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。
搜索规划 利用LLM技术的Query分类、多轮改写、复杂查询分解。 图文并茂&内容溯源 支持输出参考链接，和上下文语义相关的图片。 内容优选 通过query和片段的语义关系，精简出和query相关的web片段，达到减少下游大模型推理成本，以及提升大模型的推理效果。 缓存 利用缓存
单击“API管理”，进入API管理页签。 选择已发布的API，单击操作列的“编辑”。 在“编辑”页面修改API的安全认证方式。 “APP认证”：表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 当选择“APP认证”时，需要配置“APP凭据”。 “APP凭据”：使用APP认证的API，需要在AP
注意事项： 1.建议不区分大小写，例如， Approved and approved 是同一个标签 2.文档可以有一个或多个标签 3.建议格式为：标签名称:标签值 ，如果能够保证标签值不冲突，也可以直接使用 标签值，例如 《冰箱使用说明书》对应的产品型号：ProductModel:BCD-551WLCTDAFA5U1
记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。 APP：应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔
华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案，帮助企业聚焦业务场景和应用开发，场景服务化、技术简单化、低门槛化，满足开发者基于业务场景的二次开发。在RAG（Retrieval-Augmented Generation）及搜索场景提供效果和性能突出的组件化服务，架构理
页面大小，范围1~65535 最小值：1 最大值：65535 filter_string 否 String 带语法的查询字符串，使用具有严格语法的解析器，根据提供的查询字符串返回文档。 例如：tags:(魔都 OR 首都) AND category:"城市(city)" 例如：需要
Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 T
在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 请求限定响应结果的分页大小，例如5条/页，10条/页
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求
OCR中的智能文档解析和通用文字识别功能，也可以购买套餐包，详情请查看计费规则。 网络配置 虚拟私有云 指定集群节点使用的虚拟专用网络，实现不同业务的网络隔离。 单击“查看虚拟私有云”跳转到虚拟私有云列表，查看已创建或共享至当前账号下的VPC名称和ID。 如果没有合适的VPC，建
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
