检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口
API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架API云商店进行售卖。
如何调用API 构造请求 认证鉴权 接口获取 返回结果
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“API
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
Float 搜索增强模型生成多样性 最小值:0 最大值:1 缺省值:0.3 presence_penalty Float 文本重复度 最小值:-2 最大值:2 缺省值:0 use_system_prompt Boolean 是否使用系统Prompt,与盘古RAG场景Prompt标准拼接方案保持一致
Float 搜索增强模型生成多样性 最小值:0 最大值:1 缺省值:0.3 presence_penalty Float 文本重复度 最小值:-2 最大值:2 缺省值:0 use_system_prompt Boolean 是否使用系统Prompt,与盘古RAG场景Prompt标准拼接方案保持一致
单击“创建”,在“新建问答”对话框中输入“标准问题”和“答案”,单击“添加相似问题”,可输入多个相似问题。 在对话框中单击“确认”。 FAQ创建后,可在FAQ管理页签查看已创建的问答。 管理FAQ。 单击操作列的“编辑”,可重新编辑FAQ的“标准问题”和“答案”。
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://
公共参数 状态码 错误码
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将
搜索与问答 搜索知识库 生成答案
使用前必读 概述 欢迎使用Flexus企业搜索服务。Flexus企业搜索服务基于业界效果突出的搜索模型、云搜索服务的高性能GaussDB向量数据库以及LLM模型组成行业RAG解决方案,导入非结构化或者结构化业务数据,帮助企业客户快速一站式搭建企业智能问答应用。搜索增强大模型,数据来源于搜索
Float 搜索增强模型生成多样性 最小值:0 最大值:1 缺省值:0.3 presence_penalty 否 Float 文本重复度 最小值:-2 最大值:2 缺省值:0 use_system_prompt 否 Boolean 是否使用系统Prompt,与盘古RAG场景Prompt标准拼接方案保持一致
Float 搜索增强模型生成多样性 最小值:0 最大值:1 缺省值:0.3 presence_penalty 否 Float 文本重复度 最小值:-2 最大值:2 缺省值:0 use_system_prompt 否 Boolean 是否使用系统Prompt,与盘古RAG场景Prompt标准拼接方案保持一致
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
模型管理 新增模型 修改模型配置 列举模型 删除模型