FLEXUS云服务_FLEXUS企业搜索服务-华为云

FLEXUS云服务_FLEXUS企业搜索服务-返回结果:响应消息体

响应消息体响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxx", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

FLEXUS云服务_FLEXUS企业搜索服务

FLEXUS云服务_FLEXUS企业搜索服务-生成答案:请求示例

请求示例上述是一个多轮对话的请求体示例。注意： 1）、当"chat_id"为空时，"chat_create_flag"应为"1"，表示需要开启新的对话；当"chat_id"有值时，"chat_create_flag"可以为"0"，表示不需要开启新的对话。 2）、"messages"中的元素始终为奇数，单轮对话时为1，多轮对话时为3、5、7、... 如上述示例，message[0]["content"]是第一轮的query，message[1]["content"]是第一轮的answer，message[2]["content"]是第二轮的query /v1/123/applications/1233453/uni-search/experience/chat { "repo_id" : "9d261b1c-e9b6-464f-881a-687251504edd", "chat_create_flag" : "0", "chat_id" : "cc84be57-3fc1-4365-a54d-417f098e8a19", "messages" : [ { "role" : "user", "content" : "2023款本田雅阁的维修保养周期建议？" }, { "role" : "user", "content" : "对于2023款本田雅阁,我建议您可以注意以下几个方面的定期维护:定期更换机油和机油滤芯。根据厂家建议,大约每5,000-10,000公里更换一次。" }, { "role" : "user", "content" : "还有什么需要注意的？" } ], "refresh_flag" : "0" }

FLEXUS云服务_FLEXUS企业搜索服务搜索与问答

FLEXUS云服务_FLEXUS企业搜索服务-生成答案:响应示例

响应示例状态码： 200 模型生成结果响应体 { "chat_id" : "cc84be57-3fc1-4365-a54d-417f098e8a19", "chat_result" : { "index" : 0, "message" : "在进行维修保养时，需要注意：检查轮胎状况,包括胎压、胎纹深度等。及时更换磨损严重的轮胎。检查制动系统,包括刹车片、制动液等。如有磨损需要及时维修更换。定期检查发动机冷却系统,更换冷却液和防冻液。检查蓄电池状态,确保电瓶能够正常工作。保持定期保养,比如四轮定位、空调保养等,延长车辆使用寿命。", "question_id" : "12453567446" }, "references" : [ { "file_id" : "123", "title" : "汽车保养注意事项.pdf", "content" : "检查轮胎状况,包括胎压、胎纹深度等。及时更换磨损严重的轮胎。检查制动系统,包括刹车片、制动液等。", "update_date_time" : "1234554456", "doc_type" : "doc", "file_path" : "uni-search/v2/文档名称.doc" }, { "file_id" : "123", "title" : "汽车包养注意事项.pdf", "content" : "如有磨损需要及时维修更换。定期检查发动机冷却系统,更换冷却液和防冻液。", "update_date_time" : "1234554456", "doc_type" : "doc", "file_path" : "uni-search/v2/文档名称.doc" }, { "file_id" : "123", "title" : "汽车包养注意事项.pdf", "content" : "检查蓄电池状态,确保电瓶能够正常工作。保持定期保养,比如四轮定位、空调保养等,延长车辆使用寿命。", "update_date_time" : "1234554456", "doc_type" : "doc", "file_path" : "uni-search/v2/文档名称.doc" } ], "reference_total" : "3" }

FLEXUS云服务_FLEXUS企业搜索服务搜索与问答

FLEXUS云服务_FLEXUS企业搜索服务-生成答案:请求参数

请求参数表1 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取 IAM 用户Token 最小长度：1 最大长度：1000000 表2 请求Body参数参数是否必选参数类型描述 repo_id 是 String 知识库ID 获取方式：账号登录 KooSearch 体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64 chat_id 否 String 对话ID 最小长度：1 最大长度：64 messages 是 Array of ChatMessage objects 对话内容数组长度：1 - 19 chat_create_flag 是 String 对话开始标志（ 0-否，1-是）最小长度：1 最大长度：1 refresh_flag 是 String 问答刷新标志（0-否，1-是）最小长度：1 最大长度：1 max_tokens 否 Integer 生成文本的最大token数量。输入的文本加上生成的文本总量不能超过模型所能处理的最大长度。最小值：1 最小值：1 最大值：131072 缺省值：2048 stream 否 Boolean 流式输出标志缺省值：false filter_string 否 String RAG搜索环节过滤。带语法的查询字符串，使用具有严格语法的解析器，根据提供的查询字符串返回文档。例如：tags:(魔都 OR 首都) AND category:"城市(city)" 注意事项： 1.支持布尔运算符 AND、OR 和 NOT（也写为 &&、|| 和 !），但请注意它们不遵守通常的优先级规则，因此只要一起使用多个运算符，就应使用括号。 2.详细语法参考query_string语法最小长度：4 最大长度：1024 top_p 否 Float 一种替代温度采样的方法，称为nucleus sampling，其中模型考虑具有top_p 概率质量的标记的结果。通常建议更改此值或温度，但不要同时更改两者。通常建议更改top_p或temperature来调整生成文本的倾向性，但不要同时更改这两个参数。取值范围：(0, 1] 最小值：0.1 最大值：1 缺省值：0.1 presence_penalty 否 Float 用于调整模型对新Token的处理方式。即如果一个Token已经在之前的文本中出现过，那么模型在生成这个Token时会受到一定的惩罚。当presence_penalty的值为正数时，模型会更倾向于生成新的、未出现过的Token，即模型会更倾向于谈论新的话题。最小值：-2 最大值：2 最小值：-2 最大值：2 缺省值：0 search_temperature 否 Float 搜索增强场景用于控制生成文本的多样性和创造力。取值接近0表示最低的随机性，1表示最高的随机性。一般来说，temperature越低，适合完成确定性的任务。temperature越高，例如0.9，适合完成创造性的任务。最小值：0 最大值：1 缺省值：0.3 chat_temperature 否 Float 非搜索增强场景用于控制生成文本的多样性和创造力。取值接近0表示最低的随机性，1表示最高的随机性。一般来说，temperature越低，适合完成确定性的任务。temperature越高，例如0.9，适合完成创造性的任务。最小值：0 最大值：1 缺省值：0.8 extra_repo_ids 否 Array of strings 多知识库问答最小长度：1 最大长度：64 数组长度：1 - 10 表3 ChatMessage 参数是否必选参数类型描述 role 否 String 对话的角色，取值为system、user 最小长度：1 最大长度：100 content 是 String 对话内容最小长度：1 最大长度：4096

FLEXUS云服务_FLEXUS企业搜索服务搜索与问答

FLEXUS云服务_FLEXUS企业搜索服务-生成答案:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 chat_id String 对话ID 最小长度：1 最大长度：64 chat_result ChatResult object 对话结果 references Array of ChatReferenceInfo objects 参考结果数组长度：1 - 100 reference_total Integer 参考来源总数最小值：1 最大值：65535 sub_queries Array of strings 搜索使用的query，包括：原始query和改写后的query 最小长度：1 最大长度：65535 数组长度：1 - 65535 category String 搜索规划返回的query类别最小长度：1 最大长度：65535 表5 ChatResult 参数参数类型描述 index Integer 序号最小值：1 最大值：65535 message String 文本内容最小长度：1 最大长度：65535 question_id String 问答ID 最小长度：1 最大长度：64 表6 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

FLEXUS云服务_FLEXUS企业搜索服务搜索与问答

FLEXUS云服务_FLEXUS企业搜索服务-生成答案:功能介绍

功能介绍将content输入给模型，使用模型能力生成答案。注意：当"chat_id"为空时，"chat_create_flag"应为"1"，表示需要开启新的对话；当"chat_id"有值时，"chat_create_flag"可以为"0"，表示不需要开启新的对话。 "messages"中的元素必须为奇数个，单轮对话时为1，多轮对话时为3、5、7、...，如 [question1, answer1, question2] 多轮对话中：对话排列顺序从旧到新

FLEXUS云服务_FLEXUS企业搜索服务搜索与问答

FLEXUS云服务_FLEXUS企业搜索服务-查询FAQ列表:响应示例

响应示例状态码： 200 成功 { "records" : [ { "id" : "991a482a-8330-4338-bdda-32852504bb38", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "无法登录我的账户怎么办？", "answer" : "请确保您使用的是正确的用户名和密码。如果仍然无法登录，请尝试重置密码或联系客服。", "status" : 0, "create_time" : "1700807345932", "update_time" : "1700807345932" }, { "id" : "d3477f5c-f7d7-409c-a709-b56df8a7341c", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "如何申请入学？", "answer" : "请查看我们的官方网站或联系招生办公室，了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。", "status" : 0, "create_time" : "1700807328240", "update_time" : "1700807328240" } ], "total" : 2, "size" : 10, "current" : 1, "optimize_count_sql" : true, "search_count" : true, "pages" : 1 }

FLEXUS云服务_FLEXUS企业搜索服务 FAQ管理

FLEXUS云服务_FLEXUS企业搜索服务-查询FAQ列表:URI

URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数参数是否必选参数类型描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。获取方式：账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64 表2 Query参数参数是否必选参数类型描述 question 否 String 问题关键字最小长度：0 最大长度：1000 repo_id 是 String 知识库ID 获取方式：账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性最小长度：1 最大长度：64 answer 否 String FAQ答案最小长度：0 最大长度：10000 page_num 否 Integer 请求页码最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 限定响应体每页返回的数据条数，例如5页/条，10页/条最小值：1 最大值：65535 缺省值：10 ids 否 Array faq id列表最小长度：1 最大长度：64 数组长度：0 - 65535

FLEXUS云服务_FLEXUS企业搜索服务 FAQ管理

FLEXUS云服务_FLEXUS企业搜索服务-构造请求:请求消息头

请求消息头附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。详细的公共请求消息头字段请参见表公共请求消息头。表2 公共请求消息头参数是否必选描述 Content-Type 是消息体的类型（格式）。推荐用户使用默认值application/json。 X-Auth-Token 否（使用Token认证时必选）用户Token。调用“获取用户Token”接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头（Header）中包含的“X-Subject-Token”的值即为Token值。对于“获取用户Token”接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.xxx.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

FLEXUS云服务_FLEXUS企业搜索服务如何调用API

FLEXUS云服务_FLEXUS企业搜索服务-构造请求:请求消息体

请求消息体请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（即消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。对于“获取用户Token”接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，********为用户的登录密码，domainname为用户所属的账号名称，如果是账号本身获取token，username和domainname填为一致，xxxxxxxxxxxxxxxxxx为project的ID。 scope参数定义了Token的作用范围，表示获取的Token仅能访问指定project下的资源，scope参数的详细说明请参见：获取用户Token。 POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "********", //登录密码 "domain": { "name": "domainname " //用户所属的账号名称 } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" //项目ID } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于“获取用户Token”接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

FLEXUS云服务_FLEXUS企业搜索服务如何调用API

FLEXUS云服务_FLEXUS企业搜索服务-构造请求:请求方法

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens

FLEXUS云服务_FLEXUS企业搜索服务如何调用API

FLEXUS云服务_FLEXUS企业搜索服务-构造请求:请求URI

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path} 表1 请求URL 参数说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域，Endpoint不同，可以参考终端节点获取。例如IAM服务在“西南-贵阳一”区域的Endpoint为“iam.cn-southwest-2.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。例如您需要获取“西南-贵阳一”区域的token，则需使用“西南-贵阳一”区域的Endpoint（iam.cn-southwest-2.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（v3/auth/toknes），拼接起来如下所示。 https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图为查看方便，每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

FLEXUS云服务_FLEXUS企业搜索服务如何调用API

FLEXUS云服务_FLEXUS企业搜索服务-状态码

状态码状态码如表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协议的版本，无法完成处理。父主题：公共参数

FLEXUS云服务_FLEXUS企业搜索服务公共参数

FLEXUS云服务_FLEXUS企业搜索服务-使用前必读:概述

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

FLEXUS云服务_FLEXUS企业搜索服务

FLEXUS云服务_FLEXUS企业搜索服务-使用前必读:基本概念

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

FLEXUS云服务_FLEXUS企业搜索服务

云服务器内容精选

FLEXUS云服务_FLEXUS企业搜索服务

7*24

备案

专业服务

退订

建议反馈

售前咨询热线