检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
查询FAQ列表 功能介绍 获取FAQ列表,包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是
API请求参数配置 APP认证 表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。关于使用APP认证的方法,具体请参考《开发指南》。 当选择“APP认证”时,需要配置“APP凭据”。 “APP凭据”:使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密
获取用户Token响应消息头所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Conten
详细的公共请求消息头字段请参见表 公共请求消息头。 表2 公共请求消息头 参数 是否必选 描述 Content-Type 是 消息体的类型(格式)。推荐用户使用默认值application/json。 X-Auth-Token 否(使用Token认证时必选) 用户Token。 调用“获取用户Tok
机制,帮助企业客户快速构建RAG以及搜索服务。 仅“西南-贵阳一”区域支持开通和使用KooSearch服务。 KooSearch服务使用流程,如下图所示: 图1 koosearch使用流程 表1 使用流程 步骤 操作 说明 1 开通服务 首先需要开通服务,开通服务时会选择版本规格
FileExtractConf 参数 参数类型 描述 parse_conf ParseConf object 文档解析配置,包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级
单击“API管理”,即可看到支持的所有API列表。 单击展开箭头,即可查看每个API详情,包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
在控制台使用KooSearch实现搜索问答 创建和管理KooSearch模型服务(可选) 创建KooSearch知识库 将本地文件上传至KooSearch知识库 体验KooSearch问答 体验KooSearch搜索 管理KooSearch知识库
账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。
查询对话历史列表 功能介绍 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 URI GET /v1/koosearch/chat-history 表1 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名 最小长度:1 最大长度:64
选择目标服务,单击服务名称,进入服务详情页。 单击“日志管理”,进入日志管理页签。 在日志管理页面进行日志查询。 选择需要查询的节点后,单击,显示查询结果。 查询日志时,是从最近时刻的1万条日志中进行匹配,查询结果最多显示100条。 可在搜索框中通过搜索关键词定位日志。
体验。 在输入框中输入问题,单击,查看搜索结果。 图1 体验搜索 选中搜索结果,可查看更详细的内容。单击“阅读全文”,可查看文档原文。 当前针对上传的多栏排版docx文档,查看文档原文时存在内容显示错位及显示不全的问题。 父主题: 在控制台使用KooSearch实现搜索问答
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 父主题: 如何调用API
最大长度:32 表4 FileExtract 参数 是否必选 参数类型 描述 parse_conf 否 ParseConf object 文档解析配置,包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf
通用自定义prompt 使用场景:主要用于非RAG场景下的模型生成阶段。(非RAG场景:对话生成任务中,不使用检索步骤进行信息检索,直接使用生成模型生成回复。) 组成要素:用户问题、任务指令以及其他要求。 使用方式:支持自定义prompt,如果未配置自定义prompt,则使用默认promp
创建好的知识库可以进行查看、关闭、开启、引用、删除等操作。 查看知识库详情 进入KooSearch控制台。 左侧导航栏选择“知识库管理”,进入“知识库管理”页面。 单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息
全面的响应。 部署ID 模型的部署id信息。 认证类型 IAM认证:支持华为iam认证,系统将默认使用css资源租户进行认证。开启使用委托账号后可以通过配置委托名和委托账号的方式使用委托账号的权限进行认证。 自定义认证:支持在调用时添加自定义请求头。 URL 向量模型的调用url
通用自定义prompt 使用场景:主要用于非RAG场景下的模型生成阶段。(非RAG场景:对话生成任务中,不使用检索步骤进行信息检索,直接使用生成模型生成回复。) 组成要素:用户问题、任务指令以及其他要求。 使用方式:支持自定义prompt,如果未配置自定义prompt,则使用默认promp
文档。重复的文档不允许上传。 图2 上传文档 单击“确认”。文档上传后,可在文档管理页签查看已上传的文档,当“文档状态”为“正常”,说明文档已上传成功。 文档上传成功后,可以单击文档名称,查看切片效果。 图3 单击文档名称 图4 切片效果 管理文档数据。 单击操作列的“下载”,可下载文档至本地。