检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 欢迎使用Koosearch服务。Koosearch服务为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题: 使用前必读
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。
是否必选 参数类型 描述 iam_enabled 否 Boolean 是否启用iam鉴权 agency_enabled 否 Boolean 是否使用委托账号进行鉴权 project_id 否 String iam用户的project_id信息,iam_enable=true是为必填字段
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
管理Flexus企业搜索服务 查看Flexus企业搜索服务详情 配置Flexus企业搜索服务集群路由 删除Flexus企业搜索服务
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
删除对话历史 功能介绍 根据指定ID,删除对应的对话历史。 URI DELETE /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id 是 String 对话历史ID
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 file_id 是 String 文件ID,1~64个字符,只能包含数字、字母、中划线和下划线
获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
是否必选 参数类型 描述 iam_enabled 否 Boolean 是否启用iam鉴权 agency_enabled 否 Boolean 是否使用委托账号进行鉴权 project_id 否 String iam用户的project_id信息,iam_enable=true是为必填字段
调用说明 KooSearch服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
/层级解析模型 LENGTH-长度拆分,即为字数拆分 CATALOG-层级分段下的自动解析 RULE- 层级分段下的规则解析 AUTO- 自动拆分,自动识别文档格式匹配适合的拆分解析方式 缺省值:AUTO 枚举值: LENGTH CATALOG RULE AUTO separator_ids
获取对话历史 功能介绍 根据chat_id获取对话历史,返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“API