# 企业搜索服务 KooSearch ## 产品介绍 - [什么是企业搜索服务KooSearch](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0003.md): 华为云企业搜索服务KooSearch提供开箱即用的企业级RAG服务,导入非结构化或者结构化业务数据,内置业界效果突出的搜索模型、高性能CSS向量数据库,多种LLM灵活对接,帮助企业客户快速构建AI搜索和文档问答服务。搜索增强大模型,数据来源于搜索,解决大模型幻觉问题,问答结果更可靠、安全。CSS向量数据库是基于云搜索服务(Cloud Se - [产品优势](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0004.md): KooSearch主要有以下特点与显著优势。上传文档后即可基于文档进行问答,支持页面模型管理灵活切换LLM模型。内置高精度的文本Embedding模型,中文Embedding评测在C_MTEB榜单排名突出。同时内置重排、搜索规划服务,支持关键词检索、向量检索、混合检索等多种检索方式,基于深度文档理解,能够从各类复杂格式的非结构化数据中自动 - [应用场景](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0005.md): KooSearch可以帮助企业搭建企业级RAG,提升用户获取企业私有知识的效率,同时提供联网增强功能,提供互联网公域知识问答能力。主要用于智能客服应用、数字人、数字员工、AI助手、AI搜索等知识问答场景。海量的行业数据、复杂的专业知识、各个业务系统的数据以及多种类型的文档(例如:word、pdf、Excel、ppt、图片等格式),容易导致 - [产品功能](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0023.md): 本页面介绍了KooSearch服务支持的主要功能。将本地数据上传到知识库后,就可以在KooSearch体验平台进行问答&搜索。KooSearch服务提供AI搜索功能。使用AI搜索时,您可以使用“深度思考”和“联网搜索”功能,突破预训练数据的时间边界,提供深度思考、时效精准的智能搜索服务,让您的搜索体验更佳。KooSearch服务推出了AI - [身份认证与访问控制](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0009.md): KooSearch在CSS服务的控制台入口提供服务,身份认证和访问控制同CSS服务,CSS服务的身份认证和访问控制主要包括两个大的方面:一方面是通过统一身份认证服务(Identity and Access Management,简称IAM)实现服务资源层面的身份认证和访问控制;另一方面是由KooSearch服务复用CSS的安全集群内的身份 - [数据保护技术](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0010.md): KooSearch主要从以下几个方面保障数据和业务运行安全:网络隔离整个网络划分为2个平面,即业务平面和管理平面。两个平面采用物理隔离的方式进行部署,保证业务、管理各自网络的安全性。业务平面:主要是集群的网络平面,支持为用户提供业务通道,对外提供知识问答能力。管理平面:主要是管理控制台,用于管理云搜索服务。整个网络划分为2个平面,即业务平 - [审计与日志](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0011.md): CSS向量数据库基于Elasticsearch构建,提供向量检索功能。为KooSearch的企业级RAG服务提供向量检索的能力。其中,CSS的向量数据库复用云搜索服务的审计与日志的能力,详细介绍请参见审计与日志。KooSearch暂不支持审计。 - [认证证书](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0016.md): 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。合规证书下载华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。资源中心华为云安全服务提供了网络安全专用产品安全检测证书、软件著作权等证书,供用户下载和参考。具体请查看合规资质证书。网络安全专用产品安全检测证书 - [约束与限制](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0019.md): 本节介绍KooSearch在使用过程中的约束和限制。您输入的内容(包括但不限于构建知识库的数据)需要合法合规,不含有任何违反法律法规之内容。配置第三方LLM服务时,请确认模型已对接Guard审核模型,确保模型输出内容安全合规。KooSearch的体验平台内容由人工智能模型合成,不代表平台立场或观点。请您确保输入内容和使用行为等符合适用的法 - [与其他服务的关系](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0020.md): KooSearch与其他服务的关系如下所示。 - [基本概念](https://support.huaweicloud.com/productdesc-koosearch/koosearch_03_0021.md): RAG(检索增强生成)是一种通过检索外部知识库来扩展模型知识范围的技术,利用非训练数据(如实时信息或内部文档)增强生成内容的准确性和时效性。其核心是通过向量检索获取相关知识片段输入大模型,从而减少生成幻觉并提供更可靠的响应。Embedding模型的核心功能是将文本(如单词、短语或句子)转化为稠密的向量(即N维数组),从而在向量空间中建立可 ## 用户指南 - [KooSearch文档问答服务使用流程](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0002.md): 华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案,帮助企业聚焦业务场景和应用开发,场景服务化、技术简单化、低门槛化,满足开发者基于业务场景的二次开发。在RAG(Retrieval-Augmented Generation)及搜索场景提供效果和性能突出的组件化服务,架构理想、灵活编排的机制,帮助企业客户快 - [开通KooSearch文档问答服务](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0004.md): 在使用KooSearch文档问答服务前需要开通服务。仅“西南-贵阳一”区域支持开通和使用KooSearch服务。KooSearch是受限使用阶段,如果有试用需求,请提工单申请权限。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。单击服务开通,进入创建KooSea - [创建及管理KooSearch模型服务](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8001.md): KooSearch文档问答服务不仅内置了高性能文本向量模型、精排模型、搜索规划模型,还支持用户从华为云的其他服务中增加新的外部模型。用户可以根据自身的业务需求,灵活选择和集成最合适的大语言模型,从而提高系统的多样性和适应性。本文介绍如何新增和管理模型服务。您可以在模型管理页面创建不同的模型服务。创建好模型服务后,您可以在创建知识库时选择已 - [创建及修改KooSearch知识库](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8002.md): 在使用KooSearch体验平台时,首先需要新建知识库,才能进行后续的上传数据、搜索和问答体验等操作。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。选择已创建好的文档问答服务,单击操作列的问答,前往KooSearch控制台。在KooSearch控制台,左侧导航 - [将本地数据上传至KooSearch知识库](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8003.md): 创建完知识库,需要在知识库中上传知识数据。KooSearch知识库支持上传以下几种类型的知识。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。选择已创建好的文档问答服务,单击操作列的问答,前往KooSearch控制台。提前在本地准备好待上传的文档。支持格式为 . - [体验KooSearch问答](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8004.md): 当知识库有了数据以后,就可以在KooSearch体验平台进行问答体验。已开通了KooSearch服务。已准备好数据库,且已上传数据。待进行问答体验的知识库状态为开启状态。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。选择已创建好的文档问答服务,单击操作列的问答 - [体验KooSearch搜索](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8005.md): 当知识库有了数据以后,就可以在KooSearch体验平台支持进行搜索体验。已开通了KooSearch服务。已准备好数据库,且已上传数据。待进行问答体验的知识库状态为开启状态。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。选择已创建好的文档问答服务,单击操作列的 - [管理KooSearch知识库](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8006.md): 创建好的知识库可以进行查看、修改、关闭、开启、引用、删除等操作。进入KooSearch控制台。左侧导航栏选择知识库管理,进入知识库管理页面。单击需要查看的知识库的操作列的“文档管理”或知识库名称,进入知识库详情页面。查看知识库详情进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、 - [管理KooSearch提示词](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8007.md): 提示词是指导大模型生成答案的关键词。拥有好的数据并在好的提示词指导下,模型就能给出更准确的回应,从而产生更好的结果。精心设计的提示词可以让人们快速获得所需信息,更好地理解所寻找的内容,并减少结果中的错误。KooSearch服务提供创建、管理提示词的功能,您可以使用系统自带的提示词,也可以自己创建提示词。进入KooSearch控制台。左侧导 - [管理KooSearch对话](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8008.md): KooSearch服务提供管理对话和管理反馈结果的功能,您通过体验平台生成的对话以及对结果的反馈,可以在此管理。进入KooSearch控制台。左侧导航栏选择对话管理>对话历史,进入对话历史页面。可以在此页面查看历史对话。单击操作列的“查看”可以查看具体的对话详情。也可以根据标签、知识库、对话ID来筛选你想查找的对话。单击操作列的“删除”按 - [AI搜索](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8009.md): KooSearch服务提供AI搜索功能。使用AI搜索时,您可以使用“深度思考”和“联网搜索”功能,突破预训练数据的时间边界,提供深度思考、时效精准的智能搜索服务,让您的搜索体验更佳。深度思考:深度思考是通过配置“深度思考”模型,来模拟人类的深度思考过程,以便更智能地解决问题或做出决策。联网搜索:联网搜索是通过配置“联网搜索”模型,通过外部 - [AI文档解析](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8014.md): AI文档解析是指使用人工智能技术对文档进行分析、提取和理解的过程。这一过程可以应用于多种类型的文档,包括文本、图像、表格等,广泛用于信息提取、内容理解、数据处理等场景。在文档管理和解析的场景中,用户经常需要处理多种格式的文件,如PPT、图片等,这些文件中不仅包含文字信息,还可能包含重要的图片内容。然而,传统的文档解析工具往往只能提取文字信 - [深度研究](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8015.md): 在进行复杂问题研究时,用户往往需要一个能够支持多步推理和层层拆解任务的智能系统。为此,KooSearch引入了深度研究功能,旨在通过多轮对话交互和任务规划,帮助用户完成需要多步推理的复杂任务。用户可以在前端页面上配置模型,进行任务规划的多轮交互式修改,并选择“研究报告”模式。系统后端将根据用户配置,执行任务规划与深度研究的逻辑,最终生成详 - [管理系统权限](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_8010.md): 在使用本服务的过程中,如果需要给企业中的员工设置不同的访问权限,以达到不同员工之间的权限隔离,就要创建不同的角色,给角色赋予不同的权限,来达到此目的。其中包括四个重要核心概念:用户、权限、角色、用户组。用户:用户指的是使用系统或应用的个人或实体。每个用户在一个系统中都有一个唯一的身份标识,比如用户名或ID。每个用户可以被分配一个或多个角色 - [通过API使用KooSearch实现搜索问答](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0007.md): KooSearch服务提供的API支持发布到不同的环境,发布成功后支持被调用。KooSearch服务开通成功后,会自动创建KooSearch API。在KooSearch服务详情页的API管理页签,可以看到知识管理和文档解析两类API。知识管理:该类API主要用于知识库管理,例如上传文件、查询文件等。文档解析:该类API主要用于对文档数据 - [升级KooSearch服务](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0008.md): KooSearch服务的升级功能升级的是集群的内核补丁。升级原理升级过程采用的是one-by-one的方式。升级时,先下线一个节点,然后对该节点执行切换OS镜像的动作,再将已下线节点的网卡port挂载回来,以此保留节点IP地址,再进行初始化节点启动进程,待节点信息更新后,再依次将其余节点镜像进行替换。升级过程中存在节点下线再上线的动作,可 - [查看KooSearch文档问答服务详情](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0010.md): 在服务的基本信息页面,可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外,还能进行管理服务、API管理和日志管理。管理服务:KooSearch文档问答服务针对已创建的服务所配置的集群,可前往云搜索服务控制台对集群进行管理。API管理:KooSearch服务开通成功后,会自动创建KooSearch API,将 - [配置KooSearch文档问答服务集群路由](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0011.md): 当KooSearch服务需要访问客户端或其他服务(如MaaS)时,如果KooSearch与目标服务位于不同VPC,默认无法直接通信。此时需要配置KooSearch路由打通网络。建立VPC对等连接:打通两个VPC之间的网络。配置KooSearch集群路由:在KooSearch服务添加客户端的路由信息,允许KooSearch访问客户端。验证网 - [删除KooSearch文档问答服务](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0013.md): 当无需使用KooSearch文档问答服务时,可删除服务释放资源。删除服务时,会清理业务数据也会删除依赖集群,请谨慎操作。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch服务列表。在对应服务的操作列中单击删除。在弹出的确认提示框中,输入DELETE,单击确定完成服务删除。包年包 - [配置KooSearch文档问答服务参数](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0016.md): 为了便于维护您的常用配置,KooSearch提供单独的配置参数功能,使您配置参数更加方便。进入KooSearch服务详情页面。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch服务列表。选择目标服务,单击服务名称,进入服务详情页。登录云搜索服务管理控制台。在左侧导航栏选择Koo - [重启KooSearch文档问答服务](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0017.md): 当KooSearch集群停止工作时,可通过重启恢复运行,有快速重启与滚动重启两种方式,建议在业务空闲时进行重启操作。快速重启:快速重启是所有节点同时重启。滚动重启:滚动重启仅适用于节点数大于或等于2的集群。滚动重启会一个一个重启节点,耗时较长。避免在业务高峰期重启,以防影响数据完整性或服务可用性。快速重启过程时,集群全程不可用。集群的任务 - [查看KooSearch文档问答服务日志](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0014.md): 为了方便用户使用日志定位问题,KooSearch服务提供了日志查询功能。用户可以通过日志查询进行问题分析定位。进入KooSearch服务详情页面。登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch服务列表。选择目标服务,单击服务名称,进入服务详情页。登录云搜索服务管理控制台。在 - [CES中KooSearch集群支持的监控指标](https://support.huaweicloud.com/usermanual-koosearch/koosearch_06_0018.md): 云监控服务CES支持实时监控云搜索服务集群的核心指标,方便用户掌握集群的指标信息,以便及时处理集群的异常状况。本文定义了KooSearch服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义。用户可以通过云监控服务管理控制台或API接口来检索KooSearch服务产生的监控指标和告警信息。云监控服务最大支持4个层级维度,维度编号 ## 最佳实践 - [基于KooSearch和DeepSeek构建知识问答](https://support.huaweicloud.com/bestpractice-koosearch/koosearch_07_0001.md): 本文结合KooSearch和DeepSeek模型搭建一个基于RAG( Retrieval Augmented Generation)的知识问答系统。针对NLP大模型存在的知识幻觉、知识更新不及时以及缺乏企业专业知识等问题,大模型+知识库是当前普遍采用的解决方案。KooSearch基于RAG架构,支持导入非结构化或结构化的业务数据到知识库, - [基于Dify集成KooSearch与DeepSeek构建智能问答助手](https://support.huaweicloud.com/bestpractice-koosearch/koosearch_07_0002.md): 通过开源Dify平台集成企业搜索服务KooSearch的企业级知识库以及MaaS服务的DeepSeek模型,可构建具备以下能力的智能问答助手:直接问答:调用DeepSeek模型生成回答。知识增强问答:结合企业级知识库内容与DeepSeek模型输出精准答案。基于开源框架Dify构建,打造具备双重能力的智能对话助手。系统支持用户自由选择直接调 ## API参考 - [使用前必读](https://support.huaweicloud.com/api-koosearch/koosearch_06_0001.md): 仅“西南-贵阳一”区域支持开通和使用KooSearch服务。KooSearch是受限使用阶段,如果有试用需求,请提工单申请权限。欢迎使用KooSearch服务。KooSearch服务基于业界效果突出的搜索模型、云搜索服务的高性能GaussDB向量数据库以及LLM模型组成行业RAG解决方案,导入非结构化或者结构化业务数据,帮助企业客户快速一 - [API概览](https://support.huaweicloud.com/api-koosearch/koosearch_06_0006.md): Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 - [构造请求](https://support.huaweicloud.com/api-koosearch/koosearch_06_0008.md): 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 - [认证鉴权](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.md): 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。IAM认证:通过Token认证通用请求。APP认证:API提供者在API网关开放自己的API后,可以使用APP认证的方式认证鉴权。根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体的认证方式请查看使用APP认证调用API,这里,我们推荐使用通过AppCode进行简 - [接口获取](https://support.huaweicloud.com/api-koosearch/koosearch_08_0006.md): KooSearch服务分为外网访问和内网访问,接口组成为以下方式:外网访问:https://{apig公网地址}/{apig请求地址}需要先发布KooSearch API才能外网访问。外网请求地址获取方式:登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch服务列表。选择目标服务 - [返回结果](https://support.huaweicloud.com/api-koosearch/koosearch_06_0011.md): 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。对于获取用户Token接口,如果调用后返回状态码为201,则表示请求成功。对应请求消息头,响应同样也有消息头,如Content-type。对于获取用户Token接口,返回如图1所示的 - [创建知识库 - CreateKnowledgeRepos](https://support.huaweicloud.com/api-koosearch/CreateKnowledgeRepos.md): 创建知识库。POST /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo状态码:200状态码:400状态码:500创建知识库。状态码:200创建知识库响应体。请参见错误码。 - [获取文件问答知识库id - ShowFileBaseRepo](https://support.huaweicloud.com/api-koosearch/ShowFileBaseRepo.md): 获取文件问答知识库id。GET /v1/koosearch/file-answer-knowledge状态码:200状态码:400状态码:500获取文件问答知识库id。状态码:200获取文件问答知识库id。请参见错误码。 - [修改知识库配置 - ModifyKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/ModifyKnowledgeRepo.md): 修改知识库配置。包括:解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则)文档拆分设置:自动分段、长度分段(按文本长 - [开启知识库 - StartKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/StartKnowledgeRepo.md): 根据ID开启知识库,知识库开启后为可检索状态。PUT /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/start状态码:200开启知识库成功。状态码:400状态码:500根据ID开启知识库,知识库开启后为可检索状态。无请参 - [关闭知识库 - StopKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/StopKnowledgeRepo.md): 根据ID关闭知识库,知识库关闭后为不可检索状态。PUT /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/stop状态码:200关闭知识库成功。状态码:400状态码:500根据ID关闭知识库,知识库关闭后为不可检索状态。状态 - [获取知识库列表 - ListKnowledgeRepos](https://support.huaweicloud.com/api-koosearch/ListKnowledgeRepos.md): 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。GET /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo状态码:200状态码:400状态码:500获取当前账号下所有关闭状态下的知识库列表。/v - [查看知识库详情 - ShowKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/ShowKnowledgeRepo.md): 查看知识库详情,包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。GET /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}状态码:200状态码:400状态码:500查看知识库详情。状态码:200知识库详情 - [删除知识库 - DeleteKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/DeleteKnowledgeRepo.md): 根据ID删除知识库。DELETE /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}状态码:200状态码:400状态码:500根据ID删除知识库。状态码:200删除信息响应体。请参见错误码。 - [批量删除知识库 - DeleteKnowledgeRepos](https://support.huaweicloud.com/api-koosearch/DeleteKnowledgeRepos.md): 根据ID批量删除知识库。DELETE /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo状态码:200状态码:400状态码:500根据ID批量删除知识库。状态码:200批量删除信息响应体。请参见错误码。 - [删除知识库缓存 - DeleteKnowledgeRepoCache](https://support.huaweicloud.com/api-koosearch/DeleteKnowledgeRepoCache.md): 根据ID删除知识库缓存。DELETE /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/cache状态码:200状态码:400状态码:500状态码:200删除知识库缓存。请参见错误码。 - [查询知识库版本列表 - ListKnowledgeVersions](https://support.huaweicloud.com/api-koosearch/ListKnowledgeVersions.md): 查询知识库版本列表。GET /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/versions无状态码:200查询知识库版本列表。状态码:200响应体。请参见错误码。 - [知识库版本操作 - ModifyKnowledgeVersion](https://support.huaweicloud.com/api-koosearch/ModifyKnowledgeVersion.md): 参数解释:知识库版本管理,版本状态和操作表:版本状态为使用中:支持重建和更新;版本状态为可以:支持重建、关闭、删除、激活和更新;版本状态为关闭:支持启用、删除和更新。取值范围:不涉及POST /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{ - [查询知识库下的所有标签 - ListLabel](https://support.huaweicloud.com/api-koosearch/ListLabel.md): 查询知识库下的所有标签。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/labels状态码:200状态码:500状态码:200查询知识库下的所有标签响应成功。请参见错误码。 - [创建标签 - CreateLabel](https://support.huaweicloud.com/api-koosearch/CreateLabel.md): 创建知识库的文档标签。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/labels状态码:200状态码:400状态码:500创建知识库的文档标签。状态码:200创建知识库的文档标签成功。请参见错误码。 - [删除标签 - DeleteLabel](https://support.huaweicloud.com/api-koosearch/DeleteLabel.md): 删除知识库下的标签。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/labels/{label_id}状态码:200删除知识库下的标签。状态码:200删除知识库下的标签成功。请参见错误码。 - [创建文档目录 - CreateDirectory](https://support.huaweicloud.com/api-koosearch/CreateDirectory.md): 创建知识库文档目录。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory状态码:200状态码:400状态码:500创建知识库文档目录,子目录。/v1/{project_id}/applications/{application_ - [获取文档目录 - ListDirectory](https://support.huaweicloud.com/api-koosearch/ListDirectory.md): 获取知识库下的文档目录信息。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory状态码:200状态码:400状态码:500状态码:200获取知识库下的文档目录信息响应成功。请参见错误码。 - [删除文档目录 - DeleteDirectory](https://support.huaweicloud.com/api-koosearch/DeleteDirectory.md): 删除知识库目录。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/{directory_id}状态码:200删除知识库目录。状态码:200删除目录响应体。请参见错误码。 - [修改文档目录 - UpdateDirectory](https://support.huaweicloud.com/api-koosearch/UpdateDirectory.md): 修改知识库文档目录信息。PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/{directory_id}状态码:200状态码:400状态码:500修改知识库文档目录信息。状态码:200更新目录响应成功。请参见错误码。 - [批量修改文档目录 - UpdateDirectoryOfFile](https://support.huaweicloud.com/api-koosearch/UpdateDirectoryOfFile.md): 批量移动知识库文档到指定目录。PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/files状态码:200批量移动知识库文档到指定目录。状态码:200更新文档目录响应。请参见错误码。 - [上传结构化数据 - UploadStructuredDataFile](https://support.huaweicloud.com/api-koosearch/UploadStructuredDataFile.md): 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/structured-data状态码:200状态码:400状态码:500将结构化数据文件上传到对象存储服务OBS中进行结构化数 - [搜索结构化数据文件 - SearchStructuredDataFile](https://support.huaweicloud.com/api-koosearch/SearchStructuredDataFile.md): 根据文件名搜索目标文件。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/structured-data/search状态码:200状态码:400状态码:500根据文件名搜索目标文件。状态码:200文档列表响应体。请参见错误码。 - [上传文档接口 - UploadFiles](https://support.huaweicloud.com/api-koosearch/UploadFiles.md): 上传文件至某个知识库。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files状态码:201状态码:400状态码:500上传文件至知识库。状态码:201上传文档接口响应体。请参见错误码。 - [更新文档元数据信息 - UpdateFileMeta](https://support.huaweicloud.com/api-koosearch/UpdateFileMeta.md): 更新文档元数据信息。PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/{file_id}状态码:200状态码:400状态码:500表单格式状态码:200更新后文档元数据。请参见错误码。 - [查询文档接口 - SearchFiles](https://support.huaweicloud.com/api-koosearch/SearchFiles.md): 在当前知识库查询名称为xx的文件。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/search状态码:200状态码:400状态码:500在当前知识库查询名称为xx的文件。状态码:200文档列表响应体。请参见错误码。 - [下载文件接口 - DownloadFiles](https://support.huaweicloud.com/api-koosearch/DownloadFiles.md): 下载指定ID的文件。GET /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}状态码:200状态码:400状态码:500下载指定ID的文件。无请参见错误码。 - [下载指定ID的HTML - PreviewFileHtml](https://support.huaweicloud.com/api-koosearch/PreviewFileHtml.md): 下载指定ID的文件的html。GET /v1/{project_id}/applications/{application_id}/uni-search/files/preview/{file_id}状态码:200状态码:400状态码:500下载指定ID的文件的html。无请参见错误码。 - [文档批量重入库接口 - BatchRetryFiles](https://support.huaweicloud.com/api-koosearch/BatchRetryFiles.md): 文档批量重新入库功能,支持批量重新上传多个文档。PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/retry状态码:200状态码:400状态码:500重入库指定ID的文件状态码:200批量重入库响应体。请参见错误码。 - [创建文件解析的分片内容 - CreateFileDocs](https://support.huaweicloud.com/api-koosearch/CreateFileDocs.md): 创建指定文件的解析分片内容。POST /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}/docs状态码:200创建指定文件的解析分片内容。状态码:200创建文件响应成功。请参见错误码。 - [更新文件解析的分片内容 - UpdateFileDocs](https://support.huaweicloud.com/api-koosearch/UpdateFileDocs.md): 根据文档ID和分片ID,更新指定文件的某个分片的内容。PUT /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}/docs/{doc_id}状态码:200更新成功。无更新文件解析的分片内容。无请参见错误码。 - [查看文件解析后的分片内容列表 - ListFileDocs](https://support.huaweicloud.com/api-koosearch/ListFileDocs.md): 查看当前文件,经过文档解析后的分片列表,包含每个分片的详情。GET /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}/docs状态码:200状态码:404查看文件解析后的分片内容列表。状态码:200查询响应体。请参见错误码。 - [批量删除分片 - BatchDeleteFileDocs](https://support.huaweicloud.com/api-koosearch/BatchDeleteFileDocs.md): 根据文档ID和分片ID,批量分片。DELETE /v1/{project_id}/applications/{application_id}/uni-search/files/{file_id}/docs状态码:200根据文档ID和分片ID,批量分片。状态码:200删除成功。请参见错误码。 - [删除文档接口 - DeleteFiles](https://support.huaweicloud.com/api-koosearch/DeleteFiles.md): 删除指定ID的文件。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/{file_id}状态码:200状态码:400状态码:500删除指定ID的文件。状态码:200删除成功。请参见错误码。 - [批量删除文档接口 - BatchDeleteFiles](https://support.huaweicloud.com/api-koosearch/BatchDeleteFiles.md): 根据多个文档ID,进行文档批量删除。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files/batch状态码:200状态码:400状态码:500批量删除文档接口。状态码:200删除成功。请参见错误码。 - [创建FAQ - CreateFaq](https://support.huaweicloud.com/api-koosearch/CreateFaq.md): 输入问题、相似问题、答案,创建单条FAQ。POST /v1/{project_id}/applications/{application_id}/uni-search/faq状态码:200创建FAQ实例。状态码:200响应成功。请参见错误码。 - [更新FAQ - UpdateFaq](https://support.huaweicloud.com/api-koosearch/UpdateFaq.md): 更新指定ID的FAQ的问题、答案、相似问题。PUT /v1/{project_id}/applications/{application_id}/uni-search/faq状态码:200响应成功。无更新FAQ实例。无请参见错误码。 - [获取FAQ - ShowFaq](https://support.huaweicloud.com/api-koosearch/ShowFaq.md): 根据ID获取FAQ详情,包括问题、答案。GET /v1/{project_id}/applications/{application_id}/uni-search/faq/{faq_id}状态码:200根据ID获取FAQ详情。状态码:200根据ID获取FAQ详情响应成功。请参见错误码。 - [查询FAQ列表 - ListFaqs](https://support.huaweicloud.com/api-koosearch/ListFaqs.md): 获取FAQ列表,包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq状态码:200查询FAQ列表实例。状态码:200查询成功。请参见错误码。 - [删除FAQ - DeleteFaq](https://support.huaweicloud.com/api-koosearch/DeleteFaq.md): 根据知识库ID和FAQ的ID,删除FAQ。DELETE /v1/{project_id}/applications/{application_id}/uni-search/faq/{repo_id}/{faq_id}状态码:200删除FAQ响应成功。无单条FAQ文件删除。无请参见错误码。 - [批量删除FAQ - BatchDeleteFaq](https://support.huaweicloud.com/api-koosearch/BatchDeleteFaq.md): 选择多个需要删除的FAQ,根据ID批量删除。DELETE /v1/{project_id}/applications/{application_id}/uni-search/faq/batch状态码:200批量删除FAQ实例。状态码:200成功。请参见错误码。 - [批量FAQ上传 - UploadBatchFaqFile](https://support.huaweicloud.com/api-koosearch/UploadBatchFaqFile.md): 上传xlsx/xls文件,用于FAQ的批量导入。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq/batch/upload状态码:200状态码:400状态码:500批量FAQ上传实例。状态码:200上传文档接口响应体。请参见错误码。 - [列举批量上传FAQ文件 - SearchBatchFaqFile](https://support.huaweicloud.com/api-koosearch/SearchBatchFaqFile.md): 列举批量上传FAQ文件信息。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq/batch/search状态码:200状态码:400状态码:500列举批量上传FAQ文件。状态码:200文档列表响应体。请参见错误码。 - [下载上传失败的FAQ - DownloadFailRecordsBatchFaqFile](https://support.huaweicloud.com/api-koosearch/DownloadFailRecordsBatchFaqFile.md): 下载给定上传的批量FAQ文件中,上传失败的条目。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq/batch/fail-records/{file_id}状态码:200下载上传失败的FAQ。无请参见错误码。 - [下载批量导入FAQ原文件 - DownloadOriginalBatchFaqFile](https://support.huaweicloud.com/api-koosearch/DownloadOriginalBatchFaqFile.md): 下载批量导入FAQ的原始文件。GET /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}状态码:200下载批量导入FAQ原文件。无请参见错误码。 - [FAQ文件导入重试 - RetryFaqFile](https://support.huaweicloud.com/api-koosearch/RetryFaqFile.md): FAQ文件导入重试。PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq/batch/retry/{file_id}状态码:200更新成功。无FAQ文件导入重试。无请参见错误码。 - [删除批量导入FAQ文件 - DeleteBatchFaqFile](https://support.huaweicloud.com/api-koosearch/DeleteBatchFaqFile.md): 删除指定的FAQ文件。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/faq/batch/{file_id}状态码:200删除成功。状态码:400状态码:500删除批量导入FAQ文件。无请参见错误码。 - [创建FAQ切片信息 - CreateFAQFileDocs](https://support.huaweicloud.com/api-koosearch/CreateFAQFileDocs.md): 创建FAQ切片信息并保存数据库。POST /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs状态码:200创建成功。无创建FAQ切片信息。无请参见错误码。 - [更新FAQ切片信息 - UpdateFAQFileDocs](https://support.huaweicloud.com/api-koosearch/UpdateFAQFileDocs.md): 更新FAQ切片信息。PUT /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs/{doc_id}状态码:200更新成功。无更新FAQ切片信息。无请参见错误码。 - [获取FAQ文件切片信息 - SearchFAQFileDocs](https://support.huaweicloud.com/api-koosearch/SearchFAQFileDocs.md): 获取FAQ文件切片信息。GET /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs无状态码:200获取FAQ文件切片信息。状态码:200获取FAQ文件切片信息响应体。请参见错误码。 - [删除FAQ文档切片 - BatchDeleteFAQFileDocs](https://support.huaweicloud.com/api-koosearch/BatchDeleteFAQFileDocs.md): 删除FAQ文档切片,同时删除FAQ数据库记录。DELETE /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs状态码:200删除FAQ文档切片。状态码:200批量删除结果。请参见错误码。 - [搜索知识库 - SearchInKnowledgeRepo](https://support.huaweicloud.com/api-koosearch/SearchInKnowledgeRepo.md): 根据query,在指定知识库中搜索得到topN相关的文档分片内容。POST /v1/{project_id}/applications/{application_id}/uni-search/experience/searchtext状态码:200根据query,在指定知识库中搜索得到topN相关的文档分片内容。状态码:200搜索结果返回 - [生成答案 - GenerateAnswer](https://support.huaweicloud.com/api-koosearch/GenerateAnswer.md): 将content输入给模型,使用模型能力生成答案。注意:当"chat_id"为空时,"chat_create_flag"应为"1",表示需要开启新的对话;当"chat_id"有值时,"chat_create_flag"可以为"0",表示不需要开启新的对话,接口做多轮问答。当"chat_id"为空时,"chat_create_flag"应为 - [停止生成答案 - StopGenerateAnswer](https://support.huaweicloud.com/api-koosearch/StopGenerateAnswer.md): 停止生成答案POST /v1/{project_id}/applications/{application_id}/uni-search/experience/stop/chat/{chat_id}状态码:200成功响应无状态码:200成功响应请参见错误码。 - [查询对话历史列表 - ListChatHistorys](https://support.huaweicloud.com/api-koosearch/ListChatHistorys.md): 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。GET /v1/{project_id}/applications/{application_id}/uni-search/chat-history状态码:200查询对话历史列表实例。状态码:200查看成功。请参见错误码。 - [对话历史导出 - DownloadChatHistorys](https://support.huaweicloud.com/api-koosearch/DownloadChatHistorys.md): 对话历史导出,包括对话ID、问题ID、对话问题、对话答案、对话开始时间和搜索结果。GET /v1/{project_id}/applications/{application_id}/uni-search/chat-history/download状态码:200对话历史导出实例。无请参见错误码。 - [获取对话历史 - ShowChatHistory](https://support.huaweicloud.com/api-koosearch/ShowChatHistory.md): 根据chat_id获取对话历史,返回历史的question和answer数据。GET /v1/{project_id}/applications/{application_id}/uni-search/chat-history/{chat_history_id}状态码:200获取对话历史。状态码:200对话历史查看结果。请参见错误码。 - [删除对话历史 - DeleteChatHistory](https://support.huaweicloud.com/api-koosearch/DeleteChatHistory.md): 根据指定ID,删除对应的对话历史。DELETE /v1/{project_id}/applications/{application_id}/uni-search/chat-history/{chat_history_id}状态码:200删除对话历史响应。无删除单条对话历史。无请参见错误码。 - [批量删除对话历史 - BatchDeleteChatHistory](https://support.huaweicloud.com/api-koosearch/BatchDeleteChatHistory.md): 根据对话ID,批量删除对话历史信息。DELETE /v1/{project_id}/applications/{application_id}/uni-search/chat-history/batch状态码:200批量删除对话历史。状态码:200批量删除对话历史响应。请参见错误码。 - [上传图片 - UploadImage](https://support.huaweicloud.com/api-koosearch/UploadImage.md): 上传图片入库。POST /v1/{project_id}/applications/{application_id}/uni-search/img/{img_id}状态码:200上传成功。状态码:400状态码:500上传图片。/v1/b25446daeb1a41a7953c5deba2b2677a/applications/5071b12 - [获取图片内容 - ShowImageContent](https://support.huaweicloud.com/api-koosearch/ShowImageContent.md): 根据ID获取图片内容。GET /v1/{project_id}/applications/{application_id}/uni-search/img/{img_id}状态码:200查收图片内容响应结果。状态码:400状态码:404状态码:500获取图片内容。/v1/b25446daeb1a41a7953c5deba2b2677a/ap - [新增模型 - CreateModels](https://support.huaweicloud.com/api-koosearch/CreateModels.md): 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。注意:配置第三方LLM服务时,请确保模型输出内容安全合规。embedding模型与缓存生成模型之间存在强关联关系。在创建embedding模型时,系统会配套生成对应的缓存生成模型,若模型配置信息因意外删除,需根据相同的配置参数进行重建。例如,若embedding模型的名 - [修改模型配置 - UpdateModels](https://support.huaweicloud.com/api-koosearch/UpdateModels.md): 修改模型配置。PUT /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}状态码:200新增成功。状态码:400状态码:500修改模型配置。无请参见错误码。 - [列举模型 - ListModels](https://support.huaweicloud.com/api-koosearch/ListModels.md): 列举模型。GET /v1/{project_id}/applications/{application_id}/uni-search/models/search状态码:200状态码:400状态码:500列举模型。状态码:200模型列表。请参见错误码。 - [获取搜索规划模型结果 - ListSearchPlanModelIntents](https://support.huaweicloud.com/api-koosearch/ListSearchPlanModelIntents.md): 获取搜索规划模型结果。GET /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}/intents状态码:200状态码:400状态码:500获取搜索规划模型结果状态码:200模型列表。请参见错误码。 - [删除模型 - DeleteModels](https://support.huaweicloud.com/api-koosearch/DeleteModels.md): 删除模型。DELETE /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}状态码:200删除成功。状态码:400状态码:500删除模型。无请参见错误码。 - [获取模型版本信息 - ShowModelVersions](https://support.huaweicloud.com/api-koosearch/ShowModelVersions.md): 获取模型版本信息,当前仅支持搜索规划、embedding/rerank模型。注意: 25.2.T1之后的版本支持GET /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}/version无状态码:200获取模型版本信息。状态码:200模 - [创建用户解析规则 - CreateRuleRegex](https://support.huaweicloud.com/api-koosearch/CreateRuleRegex.md): 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。POST /v1/{project_id}/applications/{application_id}/uni-search/rule-regex状态码:200状态码:400状态码:500创建用户解析规则。状态码:200创建成功。请参见错误 - [修改用户解析规则 - ModifyRuleRegex](https://support.huaweicloud.com/api-koosearch/ModifyRuleRegex.md): 用于修改已配置的解析规则。PUT /v1/{project_id}/applications/{application_id}/uni-search/rule-regex/{id}状态码:200状态码:400状态码:500修改用户解析规则实例。状态码:200修改规则响应体。请参见错误码。 - [列举用户规则列表 - ListRuleRegexs](https://support.huaweicloud.com/api-koosearch/ListRuleRegexs.md): 列举用户配置的所有解析规则列表。GET /v1/{project_id}/applications/{application_id}/uni-search/rule-regex状态码:200状态码:400状态码:500列举用户规则列表实例。状态码:200用户定义规则列表。请参见错误码。 - [删除用户定义规则解析接口 - DeleteRuleRegex](https://support.huaweicloud.com/api-koosearch/DeleteRuleRegex.md): 用于删除用户自定义解析规则。DELETE /v1/{project_id}/applications/{application_id}/uni-search/rule-regex/{id}状态码:200状态码:400状态码:500状态码:200删除成功。请参见错误码。 - [批量创建任务接口 - BatchCreateTasks](https://support.huaweicloud.com/api-koosearch/BatchCreateTasks.md): 批量创建任务。POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks状态码:200状态码:400状态码:500批量QA生成/v1/{project_id}/applications/{application_id}/uni-search/ - [查询任务接口 - SearchTasks](https://support.huaweicloud.com/api-koosearch/SearchTasks.md): 查询当前知识库的任务详情。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks状态码:200状态码:400状态码:500查询当前知识库的任务详情。状态码:200任务列表响应体。请参见错误码。 - [批量删除任务接口 - BatchDeleteTasks](https://support.huaweicloud.com/api-koosearch/BatchDeleteTasks.md): 批量删除任务。DELETE /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks/batch状态码:200状态码:400状态码:500批量删除任务接口实例。状态码:200批量删除返回体。请参见错误码。 - [下载任务输出 - DownloadFile](https://support.huaweicloud.com/api-koosearch/DownloadFile.md): 下载任务输出的结果。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/tasks/{task_id}状态码:200状态码:400状态码:500无请参见错误码。 - [查看具体重试内容 - ListTaskDetail](https://support.huaweicloud.com/api-koosearch/ListTaskDetail.md): 查看任务详情。GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/task-detail/{task_id}无状态码:200状态码:404task_detail展示批量重试文档详情。 包含文档名称和文档id状态码:200任务详情响应内容, 包含多个 - [反馈问答 - CreateFeedback](https://support.huaweicloud.com/api-koosearch/CreateFeedback.md): 创建问答反馈,反馈信息包含:问题、反馈标签、反馈详情。POST /v1/{project_id}/applications/{application_id}/uni-search/experience/feedback状态码:200状态码:400状态码:500反馈问答。状态码:200成功响应。请参见错误码。 - [反馈问答 - DeleteFeedback](https://support.huaweicloud.com/api-koosearch/DeleteFeedback.md): 删除问答反馈DELETE /v1/{project_id}/applications/{application_id}/uni-search/experience/feedback状态码:200状态码:400状态码:500删除反馈问答。状态码:200成功响应。请参见错误码。 - [编辑反馈 - UpdateFeedback](https://support.huaweicloud.com/api-koosearch/UpdateFeedback.md): 编辑反馈信息,包含更新修订内容、反馈内容。PUT /v1/{project_id}/applications/{application_id}/uni-search/feedback-manage状态码:200成功响应。状态码:400状态码:500编辑反馈。无请参见错误码。 - [查询反馈信息列表 - ListFeedbacks](https://support.huaweicloud.com/api-koosearch/ListFeedbacks.md): 查询反馈信息列表,包含用户ID、问题、反馈信息、修订信息等。GET /v1/{project_id}/applications/{application_id}/uni-search/feedback-manage状态码:200查询反馈信息列表。状态码:200反馈查询结果。请参见错误码。 - [下载反馈信息列表 - DownloadFeedbacks](https://support.huaweicloud.com/api-koosearch/DownloadFeedbacks.md): 下载反馈信息列表,包含用户ID、问题、反馈信息、修订信息等。GET /v1/{project_id}/applications/{application_id}/uni-search/feedback-manage/download状态码:200下载反馈信息列表。无请参见错误码。 - [获取问题反馈 - ShowFeedback](https://support.huaweicloud.com/api-koosearch/ShowFeedback.md): 根据问题,查询该问题的反馈信息。GET /v1/{project_id}/applications/{application_id}/uni-search/feedback-manage/{question_id}状态码:200状态码:200反馈信息详情。请参见错误码。 - [Web检索 - ListSearchWeb](https://support.huaweicloud.com/api-koosearch/ListSearchWeb.md): Web检索POST /v1/{project_id}/applications/{application_id}/uni-search/web/search状态码:200状态码:400状态码:500无无请参见错误码。 - [Web AI搜索问答 - SearchWebAI](https://support.huaweicloud.com/api-koosearch/SearchWebAI.md): Web AI搜索问答POST /v1/{project_id}/applications/{application_id}/uni-search/web/chat状态码:200状态码:400状态码:500Web AI搜索问答。状态码:200AI搜索响应。请参见错误码。 - [创建提示词 - CreatePrompt](https://support.huaweicloud.com/api-koosearch/CreatePrompt.md): 创建提示词。当前创建的提示词如果需要用到FreeMarker语法,需要先进行提示词检测,避免变量不存在。FreeMarker手册:https://freemarker.apache.org/docs/ref.htmlPOST /v1/{project_id}/applications/{application_id}/uni-search - [获取提示词列表 - ListPrompt](https://support.huaweicloud.com/api-koosearch/ListPrompt.md): 获取提示词列表。GET /v1/{project_id}/applications/{application_id}/uni-search/prompt状态码:200状态码:400状态码:500获取提示词列表状态码:200获取提示词列表。请参见错误码。 - [批量删除提示词 - DeletePrompts](https://support.huaweicloud.com/api-koosearch/DeletePrompts.md): 根据id批量删除提示词。DELETE /v1/{project_id}/applications/{application_id}/uni-search/prompt状态码:200状态码:400状态码:500批量删除提示词。状态码:200删除提示词返回体。请参见错误码。 - [修改提示词 - ModifyPrompt](https://support.huaweicloud.com/api-koosearch/ModifyPrompt.md): 修改提示词。当前修改后的提示词如果需要用到FreeMarker语法,需要先进行提示词检测,避免变量不存在。FreeMarker手册:https://freemarker.apache.org/docs/ref.htmlPUT /v1/{project_id}/applications/{application_id}/uni-search - [获取提示词 - ShowPrompt](https://support.huaweicloud.com/api-koosearch/ShowPrompt.md): 获取提示词。GET /v1/{project_id}/applications/{application_id}/uni-search/prompt/{prompt_id}状态码:200状态码:400状态码:500通过prompt_id获取提示词状态码:200修改提示词返回体。请参见错误码。 - [获取支持的语言列表 - ListLanguage](https://support.huaweicloud.com/api-koosearch/ListLanguage.md): 获取支持的语言列表。GET /v1/applications/uni-search/languages状态码:200状态码:400状态码:500通过prompt_id获取提示词状态码:200修改提示词返回体。请参见错误码。 - [知识溯源 - AddCite](https://support.huaweicloud.com/api-koosearch/AddCite.md): 知识溯源接口POST /v1/{project_id}/applications/{application_id}/uni-search/multimodal/rac状态码:200状态码:400状态码:500请求体状态码:200引用响应请参见错误码。 - [创建知识库](https://support.huaweicloud.com/api-koosearch/CreateKnowledgeRepo.md): 创建知识库。POST /v1/koosearch/repos状态码:200状态码:400状态码:500状态码:200知识库ID。请参见错误码。 - [修改知识库配置](https://support.huaweicloud.com/api-koosearch/ModifyKnowledgeRepo_0.md): 修改知识库配置。包括:解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则)。文档拆分设置:自动分段、长度分段(按 - [设置知识库搜索问答prompt](https://support.huaweicloud.com/api-koosearch/SetKnowledgeRepoPrompt.md): 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。POST /v1/koosearch/repos/{repo_id}/search-prompt状态码:200状态码:400状态 - [设置通用问答prompt](https://support.huaweicloud.com/api-koosearch/SetKnowledgeRepoCommonPrompt.md): 设置通用问答prompt。该prompt包含问题占位符{0},和对回答的要求。POST /v1/koosearch/repos/{repo_id}/common-prompt状态码:200状态码:400状态码:500配置示例状态码:200设置通用prompt的知识库ID。请参见错误码。 - [开启知识库](https://support.huaweicloud.com/api-koosearch/StartKnowledgeRepo_0.md): 根据ID开启知识库,知识库开启后为可检索状态。PUT /v1/koosearch/repos/{repo_id}/enable状态码:200开启知识库成功。状态码:400状态码:500无无请参见错误码。 - [关闭知识库](https://support.huaweicloud.com/api-koosearch/StopKnowledgeRepo_0.md): 根据ID关闭知识库,知识库关闭后为不可检索状态。PUT /v1/koosearch/repos/{repo_id}/disable状态码:200关闭知识库成功。状态码:400状态码:500无状态码:400请求体参数错误请参见错误码。 - [获取知识库列表](https://support.huaweicloud.com/api-koosearch/ListKnowledgeRepos_0.md): 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。GET /v1/koosearch/repos状态码:200状态码:400状态码:500状态码:200知识库列表响应体。请参见错误码。 - [查询知识库详情](https://support.huaweicloud.com/api-koosearch/ShowKnowledgeRepo_0.md): 查询知识库详情,包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。GET /v1/koosearch/repos/{repo_id}状态码:200状态码:400状态码:500状态码:200知识库详情响应体。请参见错误码。 - [删除知识库](https://support.huaweicloud.com/api-koosearch/DeleteKnowledgeRepo_0.md): 根据ID删除知识库。DELETE /v1/koosearch/repos状态码:200状态码:400状态码:500状态码:200删除信息响应体。请参见错误码。 - [上传结构化数据](https://support.huaweicloud.com/api-koosearch/UploadStructuredDataFile_0.md): 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。POST /v1/koosearch/repos/{repo_id}/structured-data状态码:200状态码:400状态码:500状态码:200上传文档接口响应体。请参见错误码。 - [搜索结构化数据文件](https://support.huaweicloud.com/api-koosearch/SearchStructuredDataFile_0.md): 根据文件名搜索目标文件。GET /v1/koosearch/repos/{repo_id}/structured-data/search状态码:200状态码:400状态码:500无请参见错误码。 - [上传文件](https://support.huaweicloud.com/api-koosearch/UploadFiles_0.md): 上传文件至某个知识库。POST /v1/koosearch/repos/{repo_id}/files状态码:201状态码:400状态码:500状态码:201上传文档接口响应体。请参见错误码。 - [查询文件](https://support.huaweicloud.com/api-koosearch/SearchFiles_0.md): 在当前知识库查询名称为xx的文件。GET /v1/koosearch/repos/{repo_id}/files状态码:200状态码:400状态码:500无无请参见错误码。 - [下载文件](https://support.huaweicloud.com/api-koosearch/DownloadFiles_0.md): 下载指定ID的文件。GET /v1/koosearch/repos/files/{file_id}状态码:200下载成功。状态码:400状态码:500无请参见错误码。 - [删除文件](https://support.huaweicloud.com/api-koosearch/DeleteFiles_0.md): 删除指定ID的文件。DELETE /v1/koosearch/repos/{repo_id}/files/{file_id}状态码:200删除成功。状态码:400状态码:500删除指定ID的文件。无请参见错误码。 - [创建FAQ](https://support.huaweicloud.com/api-koosearch/CreateFaq_0.md): 输入问题、相似问题、答案,创建单条FAQ。POST /v1/koosearch/repos/{repo_id}/faqs状态码:200无状态码:200创建成功。请参见错误码。 - [更新FAQ](https://support.huaweicloud.com/api-koosearch/UpdateFaq_0.md): 更新指定ID的FAQ的问题、答案、相似问题。PUT /v1/koosearch/repos/{repo_id}/faqs状态码:200无状态码:200更新成功。请参见错误码。 - [获取FAQ](https://support.huaweicloud.com/api-koosearch/ShowFaq_0.md): 根据ID获取FAQ详情,包括问题、答案。GET /v1/koosearch/repos/{repo_id}/faqs/{faq_id}状态码:200无状态码:200返回成功。请参见错误码。 - [查询FAQ列表](https://support.huaweicloud.com/api-koosearch/ListFaqs_0.md): 获取FAQ列表,包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。GET /v1/koosearch/repos/{repo_id}/faqs状态码:200无状态码:200返回成功。请参见错误码。 - [删除FAQ](https://support.huaweicloud.com/api-koosearch/DeleteFaq_0.md): 根据知识库ID和FAQ的ID,删除FAQ。DELETE /v1/koosearch/repos/{repo_id}/faqs/{faq_id}状态码:200删除成功。无无无请参见错误码。 - [批量删除FAQ](https://support.huaweicloud.com/api-koosearch/BatchDeleteFaq_0.md): 选择多个需要删除的FAQ,根据ID批量删除。DELETE /v1/koosearch/repos/{repo_id}/faqs状态码:200无状态码:200删除成功。请参见错误码。 - [批量FAQ上传](https://support.huaweicloud.com/api-koosearch/UploadBatchFaqFile_0.md): 上传xlsx/xls文件,用于FAQ的批量导入。POST /v1/koosearch/repos/{repo_id}/faqs/files状态码:200状态码:400状态码:500状态码:200上传文档接口响应体。请参见错误码。 - [列举批量上传FAQ文件](https://support.huaweicloud.com/api-koosearch/SearchBatchFaqFile_0.md): 列举批量上传FAQ文件信息。GET /v1/koosearch/repos/{repo_id}/faqs/files状态码:200状态码:400状态码:500状态码:200文档列表响应体。请参见错误码。 - [下载上传失败的FAQ](https://support.huaweicloud.com/api-koosearch/DownloadFailRecordsBatchFaqFile_0.md): 下载给定上传的批量FAQ文件中,上传失败的条目。GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails状态码:200下载成功。无无请参见错误码。 - [下载批量导入FAQ原文件](https://support.huaweicloud.com/api-koosearch/DownloadOriginalBatchFaqFile_0.md): 下载批量导入FAQ的原始文件。GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}状态码:200下载成功。无无请参见错误码。 - [删除批量导入FAQ文件](https://support.huaweicloud.com/api-koosearch/DeleteBatchFaqFile_0.md): 删除指定的FAQ文件。DELETE /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}状态码:200删除成功。状态码:400状态码:500无请参见错误码。 - [搜索知识库](https://support.huaweicloud.com/api-koosearch/SearchText.md): 根据query,在指定知识库中搜索得到topN相关的分片文档。POST /v1/koosearch/experience/search状态码:200状态码:200搜索结果返回体请参见错误码。 - [生成答案](https://support.huaweicloud.com/api-koosearch/GenerateAnswer_0.md): 将content输入给模型,使用模型能力生成答案。注意:当"chat_id"为空时,"chat_create_flag"应为"1",表示需要开启新的对话;当"chat_id"有值时,"chat_create_flag"可以为"0",表示不需要开启新的对话。当"chat_id"为空时,"chat_create_flag"应为"1",表示需要 - [查询对话历史列表](https://support.huaweicloud.com/api-koosearch/ListChatHistorys_0.md): 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。GET /v1/koosearch/chat-history状态码:200无状态码:200返回成功。请参见错误码。 - [获取对话历史](https://support.huaweicloud.com/api-koosearch/ShowChatHistory_0.md): 根据chat_id获取对话历史,返回历史的question和answer数据。GET /v1/koosearch/chat-history/{chat_history_id}状态码:200无状态码:200返回成功。请参见错误码。 - [删除对话历史](https://support.huaweicloud.com/api-koosearch/DeleteChatHistory_0.md): 根据指定ID,删除对应的对话历史。DELETE /v1/koosearch/chat-history/{chat_history_id}状态码:200删除成功。无无无请参见错误码。 - [批量删除对话历史](https://support.huaweicloud.com/api-koosearch/BatchDeleteChatHistory_0.md): 根据对话ID,批量删除对话历史信息。DELETE /v1/koosearch/chat-history/batch状态码:200状态码:200删除成功。请参见错误码。 - [上传图片](https://support.huaweicloud.com/api-koosearch/UploadImage_0.md): 上传图片入库。POST /v1/koosearch/image/{img_id}状态码:200上传成功。状态码:400状态码:500无无请参见错误码。 - [获取图片内容](https://support.huaweicloud.com/api-koosearch/ShowImageContent_0.md): 根据ID获取图片内容。GET /v1/koosearch/image/{img_id}状态码:200返回成功。状态码:400状态码:404状态码:500无无请参见错误码。 - [新增模型](https://support.huaweicloud.com/api-koosearch/CreateModels_0.md): 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。POST /v1/koosearch/models状态码:200新增成功。状态码:400状态码:500无请参见错误码。 - [更新模型](https://support.huaweicloud.com/api-koosearch/UpdateModels_0.md): 更新模型配置PUT /v1/koosearch/models/{model_name}状态码:200更新成功。状态码:400状态码:500无请参见错误码。 - [列举模型](https://support.huaweicloud.com/api-koosearch/ListModels_0.md): 列举模型。GET /v1/koosearch/models/search状态码:200状态码:400状态码:500无状态码:200模型列表。请参见错误码。 - [删除模型](https://support.huaweicloud.com/api-koosearch/DeleteModels_0.md): 删除模型DELETE /v1/koosearch/models/{model_name}状态码:200删除成功。状态码:400状态码:500无无请参见错误码。 - [创建用户自定义解析规则](https://support.huaweicloud.com/api-koosearch/CreateRuleRegex_0.md): 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。POST /v1/koosearch/rule-regex状态码:200状态码:400状态码:500状态码:200创建成功。请参见错误码。 - [修改用户自定义解析规则](https://support.huaweicloud.com/api-koosearch/ModifyRuleRegex_0.md): 用于修改已配置的用户自定义解析规则。PUT /v1/koosearch/rule-regex/{id}状态码:200状态码:400状态码:500样例状态码:200修改成功。请参见错误码。 - [列举用户自定义规则列表](https://support.huaweicloud.com/api-koosearch/ListRuleRegexs_0.md): 列举用户配置的所有自定义解析规则列表。GET /v1/koosearch/rule-regex状态码:200状态码:400状态码:500无状态码:200用户定义规则列表。请参见错误码。 - [删除用户自定义解析规则](https://support.huaweicloud.com/api-koosearch/DeleteRuleRegex_0.md): 用于删除用户自定义解析规则。DELETE /v1/koosearch/rule-regex/{id}状态码:200状态码:400状态码:500无状态码:200删除成功。请参见错误码。 - [查询ocr解析结果](https://support.huaweicloud.com/api-koosearch/ShowOcrResult.md): 查询ocr解析结果GET /v1/koosearch/doc-search/ocr-results状态码:200状态码:400状态码:401状态码:500无无请参见错误码。 - [查询文档解析结果](https://support.huaweicloud.com/api-koosearch/ShowParseResult.md): 查询文档解析结果GET /v1/koosearch/doc-search/parse-result状态码:200状态码:400状态码:401状态码:500无无请参见错误码。 - [批量删除任务](https://support.huaweicloud.com/api-koosearch/BatchDeleteTasks_0.md): 文档解析接口,批量删除任务DELETE /v1/koosearch/doc-search/tasks状态码:200状态码:400状态码:401状态码:500无状态码:200删除任务结果请参见错误码。 - [文件内容解析](https://support.huaweicloud.com/api-koosearch/UploadDocSplit.md): 拿解析结果,进行拆分合并处理POST /v1/koosearch/doc-search/parse-result/split状态码:200状态码:400状态码:401状态码:500无状态码:200doc拆分合并结果请参见错误码。 - [查询文档转html结果](https://support.huaweicloud.com/api-koosearch/ShowHtmlResult.md): 查询文档转html结果GET /v1/koosearch/doc-search/html-result无状态码:200状态码:400状态码:401状态码:500无无请参见错误码。 - [查询文档转html结果](https://support.huaweicloud.com/api-koosearch/ShowTasksResult.md): 查询解析任务GET /v1/koosearch/doc-search/tasks无状态码:200状态码:400状态码:401状态码:500无状态码:200任务查询返回体请参见错误码。 - [查询解析任务状态](https://support.huaweicloud.com/api-koosearch/BatchListTaskStatus.md): 查询解析任务GET /v1/koosearch/doc-search/tasks/status状态码:200状态码:400状态码:401状态码:500无状态码:200任务查询返回体请参见错误码。 - [取消解析任务](https://support.huaweicloud.com/api-koosearch/BatchCancelTasks.md): 取消解析任务PUT /v1/koosearch/doc-search/tasks/cancel状态码:200状态码:400状态码:401状态码:500task id的列表状态码:200任务查询返回体请参见错误码。 - [从obs获取文档](https://support.huaweicloud.com/api-koosearch/CreateDocumentTask.md): 文档解析接口,从obs获取文档POST /v1/koosearch/doc-search/documents状态码:200状态码:400状态码:401状态码:500无状态码:200文件内容解析任务创建结果请参见错误码。 - [从本地上传文档](https://support.huaweicloud.com/api-koosearch/UploadDocumentTask.md): 文档解析接口,本地上传文档POST /v1/koosearch/doc-search/files状态码:200状态码:400状态码:401状态码:500无状态码:200文件内容解析任务创建结果请参见错误码。 - [文档内容解析异步任务结果查询](https://support.huaweicloud.com/api-koosearch/ShowDocumentTask.md): 文档内容解析异步任务查询GET /v1/koosearch/doc-search/tasks/{task_id}状态码:200状态码:400状态码:401状态码:500无无请参见错误码。 - [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.md): 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 - [状态码](https://support.huaweicloud.com/api-koosearch/koosearch_06_0014.md): 状态码如表1所示。 - [如何获取应用ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0021.md): 在调用接口的时候,部分URL中需要填入应用ID(application_id),所以需要获取到应用ID。获取方法如下所示:登录云搜索服务管理控制台。在左侧导航栏选择KooSearch>KooSearch文档问答,进入KooSearch文档问答页面。选择文档问答服务,然后单击服务名称,进入服务详情页面。在“基本信息”模块查看应用ID。查看应 - [获取项目ID和名称](https://support.huaweicloud.com/api-koosearch/koosearch_06_0022.md): 在调用接口的时候,部分请求中需要填入项目ID(project_id)或项目名称(project name),所以需要获取到项目ID和名称。登录云搜索服务管理控制台。在页面右上角单击用户名,在下拉列表中单击我的凭证,进入“API凭证”页面。在项目列表中查看项目ID和项目(项目即项目名称)。查看项目ID和名称项目ID还可通过调用查询指定条件下