检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud
"error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 父主题: 如何调用API
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1
设置知识库通用无搜索的prompt 功能介绍 设置通用问答prompt。该prompt包含问题占位符{0},和对回答的要求。 URI POST /v1/koosearch/repos/{repo_id}/common-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择 其他设置:召回数量
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
单击右上角的“设置”,修改解析拆分设置和更多设置。 解析拆分设置 参考表1与表2修改设置。 更多设置 修改“搜索模型设置”、“NLP模型设置”和“高级设置”,如何修改请参考新建知识库中步骤5和步骤6。 同时支持新增“其他”设置。 表6 其他设置 参数 说明 topk召回数量 设置topk召回数量。
页面。 在“新建知识库”页面设置知识库信息。 在“解析拆分设置”页签勾选“OCR增强”,使知识库可以调用OCR服务进行智能文档识别,如表格解析或扫描文件等。 其他参数可以保持默认值或基于业务场景参考新建知识库完成配置。 图2 知识库开启OCR增强 设置好后,单击“确定”完成知识库创建。
模型服务名称 输入模型服务名称,不能为空。 模型类型 NLP模型-云底座:通过华为云提供的盘古nlp大模型访问方式。 NLP模型-昇腾云:通过昇腾云的MAAS服务提供的nlp大模型访问方式。如果选择此模型进行问答,建议设置模型生成最大新词数不超过512。 NLP模型-裸机:通过裸机部署提供的盘古nlp大模型访问方式。
单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、版本管理的操作。 引用知识库 如果您有知识共享诉求,比如同级部门间的共享A引用B的知识库,或者各部门分权独立维
公共参数 状态码 错误码
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
图片管理 上传图片 获取图片内容
模型管理 新增模型 修改模型配置 列举模型 删除模型
结构化数据 上传结构化数据 搜索结构化数据文件
在控制台使用KooSearch实现搜索问答 创建和管理KooSearch模型服务(可选) 创建KooSearch知识库 将本地文件上传至KooSearch知识库 体验KooSearch问答 体验KooSearch搜索 管理KooSearch知识库
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ