FLEXUSSEARCHSERVICE-华为云

FLEXUSSEARCHSERVICE-修改模型配置:请求示例

请求示例 /v1/111/applications/222/uni-search/models{ "detail" : "pangu_38b", "endpoint" : "http://10.0.0.169:31010", "extend_config" : { "deployment_id" : "123", "iam_info" : { "iam_enabled" : false, "agency_enabled" : false } }}

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-修改模型配置:响应参数

响应参数状态码： 400 表8 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512 状态码： 500 表9 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-上传结构化数据:URI

URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数参数是否必选参数类型描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。获取方式：账号登录 KooSearch 体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-上传结构化数据:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 file_id String 文件ID 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-更新FAQ:URI

URI PUT /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数参数是否必选参数类型描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。获取方式：账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-状态码

状态码状态码如表1所示。表1 状态码说明状态码编码状态码说明 100 Continue 继续请求。这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。例如，切换到HTTPS的高版本协议。 200 OK 请求已成功。 201 Created 创建类的请求已成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求已成功，同时HTTPS响应不包含响应体。在响应OPTIONS方法的HTTPS请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTPS状态码。 400 BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等待请求时发生超时。客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。返回该状态码，表明请求的资源已被删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。父主题：公共参数

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-关闭知识库:URI

URI PUT /v1/koosearch/repos/{repo_id}/disable 表1 路径参数参数是否必选参数类型描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。获取方式：账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-获取图片内容:响应参数

响应参数状态码： 400 表3 响应Body参数参数参数类型描述 [数组元素] Array of ErrorRsp objects 请求错误表4 ErrorRsp 参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512 状态码： 404 表5 响应Body参数参数参数类型描述 [数组元素] Array of ErrorRsp objects 图片不存在表6 ErrorRsp 参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数参数参数类型描述 [数组元素] Array of ErrorRsp objects 内部异常表8 ErrorRsp 参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

FLEXUSSEARCHSERVICE 图片管理

FLEXUSSEARCHSERVICE-关闭知识库:响应参数

响应参数状态码： 400 表3 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-API概览

API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。表1 接口说明类型说明知识库管理接口知识库管理等相关接口。结构化数据接口将结构化数据文件纳入系统进行管理接口。文件管理接口用户纳入系统的文档管理接口。 FAQ管理接口用户自定义的FAQ相关管理接口。 FAQ批量管理接口用户自定义的批量FAQ相关管理接口。搜索与问答接口 Koosearch的搜索与模型问答接口。对话历史接口用户对话历史接口。图片管理接口图片管理相关接口。模型管理接口模型管理的相关接口。用户的文档解析规则定义接口用户文档解析自定义规则配置接口。表2 知识库管理接口 API 说明创建知识库创建名称为xxx的知识库。修改知识库配置修改知识库配置。包括：解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。文档拆分设置：自动分段长度分段（按文本长度分段）层级分段（按小标题分段，可自定义小标题解析规则搜索模型设置：rerank模型配置。 NLP模型设置。其他设置：召回数量、参考文档数量、精排开关、Query改写开关、意图分类。设置知识库搜索问答prompt 设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。设置通用问答prompt 设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。开启知识库根据ID开启知识库，知识库开启后为可检索状态。关闭知识库根据ID关闭知识库，知识库关闭后为不可检索状态。获取知识库列表获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。查询知识库详情根据知识库ID获取当前知识库下的所有文件list，包括文档名称、文档类型、文档大小、文档状态、创建人、创建时间等。删除知识库根据ID删除知识库。表3 结构化数据接口 API 说明结构化数据上传将结构化数据文件上传到对象存储服务 OBS中进行结构化数据批处理功能。结构化数据文件搜索根据文件名搜索目标文件。表4 文件管理接口 API 说明上传文件上传文件至某个知识库。查询文件在当前知识库查询名称为xx的文件。下载文件下载指定ID的文件。删除文件删除指定ID的文件。表5 FAQ管理接口 API 说明创建FAQ 输入问题、相似问题、答案，创建单条FAQ。更新FAQ 更新指定ID的FAQ的问题、答案、相似问题。获取FAQ 根据ID获取FAQ详情，包括问题、答案。查询FAQ列表获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。删除FAQ 根据知识库ID和FAQ的ID，删除FAQ。批量删除FAQ 选择多个需要删除的FAQ，根据ID批量删除。表6 FAQ批量管理接口 API 说明批量FAQ上传上传xlsx/xls文件，用于FAQ的批量导入。下载上传失败的FAQ 下载给定上传的批量FAQ文件中，上传失败的条目。列举批量上传faq文件列举批量上传faq文件。下载批量导入FAQ原文件下载批量导入FAQ的原始文件。删除批量导入FAQ文件删除指定的FAQ文件。表7 搜索与问答接口 API 说明搜索知识库根据query，在指定知识库中搜索得到topN相关的结果。生成答案将content输入给模型，使用模型能力生成答案。表8 对话历史接口 API 说明查询对话历史列表查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。获取对话历史根据chat_id获取对话历史，返回历史的question和answer数据。删除对话历史根据指定ID，删除对应的对话历史。批量删除对话历史根据多个ID，批量删除对话历史信息。表9 图片管理接口 API 说明上传图片上传图片入库。获取图片内容根据ID获取图片内容。表10 模型管理接口 API 说明新增模型新增配置模型，包括模型名称、模型描述、模型endpoint、模型配置。修改模型配置修改模型。列举模型列举模型。删除模型删除模型。表11 用户的文档解析规则定义接口 API 说明创建用户解析规则列用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。修改用户解析规则用于修改已配置的解析规则。列举用户规则列表列举用户配置的所有解析规则列表。删除用户定义规则解析接口用于删除用户定义的某种规则。

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-搜索知识库:响应示例

响应示例状态码： 200 搜索结果返回体 { "doc_list" : [ { "file_id" : "123abc", "title" : "人工智能.doc", "content" : "人工智能", "update_date_time" : "134554", "doc_type" : "doc", "file_path" : "uni-search/v1/人工智能.doc", "score" : 0.9999 } ], "total" : 12}

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-搜索知识库:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 doc_list Array of ChatReferenceInfo objects 文档列表数组长度：1 - 65535 total Integer 总数最小值：1 最大值：65535 表4 ChatReferenceInfo 参数参数类型描述 file_id String 文件id（或FAQ id）最小长度：1 最大长度：64 title String 标题最小长度：1 最大长度：65535 content String 文本内容最小长度：1 最大长度：65535 big_content String 内容上下文，比如未分片的原始表格。注意：（1）搜索接口可能有值（2）问答接口会将big_content替换到content，此字段清空最小长度：0 最大长度：100000 update_date_time String 更新时间最小长度：1 最大长度：64 doc_type String 文档类型（doc-文档，faq-问答）最小长度：1 最大长度：64 file_path String 文档归档路径最小长度：1 最大长度：64 category String 文档目录，单值，对应目录树中的叶子节点最小长度：4 最大长度：255 tags Array of strings 文档标签列表最小长度：4 最大长度：255 数组长度：0 - 250 score Float ES打分最小值：0 最大值：10000 subtitle String 文档子标题最小长度：1 最大长度：65535 repo_id String 知识库标识最小长度：1 最大长度：64

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-使用前必读:基本概念

基本概念账号用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作用户由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。区域指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。可用区一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。项目区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。图1 项目隔离模型 Checkpoint：消费检查点。应用程序消费数据时，记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。 APP：应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。企业项目企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-使用前必读:概述

概述欢迎使用Flexus 企业搜索服务。Flexus企业搜索服务基于业界效果突出的搜索模型、云搜索服务的高性能 GaussDB 向量数据库以及LLM模型组成行业RAG解决方案，导入非结构化或者结构化业务数据，帮助企业客户快速一站式搭建企业智能问答应用。搜索增强大模型，数据来源于搜索，解决大模型幻觉问题，生成的问答结果更可靠、安全。为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Flexus企业搜索服务API的描述、语法、参数说明及样例等内容。

FLEXUSSEARCHSERVICE

FLEXUSSEARCHSERVICE-上传文档接口:URI

URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数参数是否必选参数类型描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。获取方式：账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64

FLEXUSSEARCHSERVICE

云服务器内容精选

FLEXUSSEARCHSERVICE

7*24

备案

专业服务

退订

建议反馈

售前咨询热线