检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 KooSearch服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
iam鉴权委托信息 custom_header 否 map<string, object> 扩展请求头 deployment_id 否 String 模型的deployment_id信息 最小长度:1 最大长度:128 vector_config 否 VectorConfig object
iam鉴权委托信息 custom_header 否 map<string, object> 扩展请求头 deployment_id 否 String 模型的deployment_id信息 最小长度:1 最大长度:128 vector_config 否 VectorConfig object
object iam鉴权委托信息 custom_header map<string, object> 扩展请求头 deployment_id String 模型的deployment_id信息 最小长度:1 最大长度:128 vector_config VectorConfig object
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。
切换协议。只能切换到更高版本的协议。 例如,切换到HTTPS的高版本协议。 200 OK 请求已成功。 201 Created 创建类的请求已成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204
String 文件状态 SUCCESS 上传成功 ERROR 上传失败 PENDING 上传等待 RUNNING 上传进行中 IMPORT_EXCEPTION 导入失败 FILE_ENCODING_ERROR 文件编码错误 最小长度:0 最大长度:128 枚举值: SUCCESS ERROR
String 文件状态 SUCCESS 执行成功 ERROR 执行失败 PENDING 初始状态,未处理 RUNNING 执行中 IMPORT_EXCEPTION 导入异常 FILE_ENCODING_ERROR 编码错误 最小长度:0 最大长度:64 枚举值: SUCCESS ERROR PENDING
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs
是否必选 参数类型 描述 policy 是 String 缓存过期策略 LRU:(Least Recently Used) now - accessTime > ttl 清除 FIFO:(First In First Out) now - createTime > ttl 清除 LFU:(Least
Eviction 参数 参数类型 描述 policy String 缓存过期策略 LRU:(Least Recently Used) now - accessTime > ttl 清除 FIFO:(First In First Out) now - createTime > ttl 清除 LFU:(Least
Eviction 参数 参数类型 描述 policy String 缓存过期策略 LRU:(Least Recently Used) now - accessTime > ttl 清除 FIFO:(First In First Out) now - createTime > ttl 清除 LFU:(Least
是否必选 参数类型 描述 policy 是 String 缓存过期策略 LRU:(Least Recently Used) now - accessTime > ttl 清除 FIFO:(First In First Out) now - createTime > ttl 清除 LFU:(Least
String 文件状态 SUCCESS 执行成功 ERROR 执行失败 PENDING 初始状态,未处理 RUNNING 执行中 IMPORT_EXCEPTION 导入异常 FILE_ENCODING_ERROR 编码错误 最小长度:0 最大长度:64 枚举值: SUCCESS ERROR PENDING
搜索知识库 功能介绍 根据query,在指定知识库中搜索得到topN相关的分片文档。 URI POST /v1/koosearch/experience/search 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
生成答案 功能介绍 将content输入给模型,使用模型能力生成答案。 注意: 当"chat_id"为空时,"chat_create_flag"应为"1",表示需要开启新的对话;当"chat_id"有值时,"chat_create_flag"可以为"0",表示不需要开启新的对话。
获取对话历史 功能介绍 根据chat_id获取对话历史,返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1
Flexus企业搜索服务使用流程 华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案,帮助企业聚焦业务场景和应用开发,场景服务化、技术简单化、低门槛化,满足开发者基于业务场景的二次开发。在RAG(Retrieval-Augmented Gener