检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。
KooSearch服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
单击“API管理”,即可看到支持的所有API列表。 单击展开箭头,即可查看每个API详情,包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
如何调用API 构造请求 认证鉴权 接口获取 返回结果
"error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用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
选择目标服务,单击服务名称,进入服务详情页。 单击“集群路由”后面的“修改”。 在“修改集群路由”弹窗中,配置路由信息。 表1 配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址,取前16位或者24位,例如源IP为“192.168.1.1”,可以填“192.168.0.0”。 子网掩码 填写IP地址的子网掩码。
包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择 其他设置:召回数量
单击右上角的“设置”,修改解析拆分设置和更多设置。 解析拆分设置 参考表1与表2修改设置。 更多设置 修改“搜索模型设置”、“NLP模型设置”和“高级设置”,如何修改请参考新建知识库中步骤5和步骤6。 同时支持新增“其他”设置。 表6 其他设置 参数 说明 topk召回数量 设置topk召回数量。
页面。 在“新建知识库”页面设置知识库信息。 在“解析拆分设置”页签勾选“OCR增强”,使知识库可以调用OCR服务进行智能文档识别,如表格解析或扫描文件等。 其他参数可以保持默认值或基于业务场景参考新建知识库完成配置。 图2 知识库开启OCR增强 设置好后,单击“确定”完成知识库创建。
单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、版本管理的操作。 引用知识库 如果您有知识共享诉求,比如同级部门间的共享A引用B的知识库,或者各部门分权独立维
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表7 ParseConf 参数 参数类型 描述 ocr_enabled
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
修改知识库配置。包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。 文档拆分设置: 自动分段 长度分段(按文本长度分段) 层级分段(按小标题分段,可自定义小标题解析规则 搜索模型设置:rerank模型配置。 NLP模型设置。 其他设置:召回数量、参
进入新建知识库页面。 在“新建知识库”页面设置知识库信息。 在“模型设置”页签,设置“NLP模型服务”,选择上一步新建的模型服务。 其他参数可以保持默认值或基于业务场景参考新建知识库完成配置。 设置好后,单击“确定”完成知识库创建。 设置模型的Prompt。 在知识库管理页面,选
400 KOS.00020010 es批量操作异常 es批量操作异常。 建议检查es节点状态。 400 KOS.00020011 连接es失败 连接es失败。 建议检查es节点状态。 400 kos.00020013 更新es索引配置异常 更新es索引配置异常。 建议检查es节点状态。
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度:0 最大长度:64 表7