检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
设置知识库搜索问答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
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“A
以生成更全面的响应。 部署ID 模型的部署id信息。 认证类型 IAM认证:支持华为iam认证,系统将默认使用css资源租户进行认证。开启使用委托账号后可以通过配置委托名和委托账号的方式使用委托账号的权限进行认证。 自定义认证:支持在调用时添加自定义请求头。 URL 向量模型的调
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时
进入新建知识库页面。 在“新建知识库”页面设置知识库信息。 在“模型设置”页签,设置“NLP模型服务”,选择上一步新建的模型服务。 其他参数可以保持默认值或基于业务场景参考新建知识库完成配置。 设置好后,单击“确定”完成知识库创建。 设置模型的Prompt。 在知识库管理页面,选
内网访问文档解析地址 服务的内网访问文档解析地址。 产品规格 服务的产品规格。 计费模式 服务的计费模式。 任务状态 服务当前的任务状态,如果没有进行中的任务则显示“--”。 区域 服务所在区域。 创建时间 服务创建的时间。 内网访问知识管理地址 服务的内网访问知识管理地址。 表2 配置信息
配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址,取前16位或者24位,例如源IP为“192.168.1.1”,可以填“192.168.0.0”。 子网掩码 填写IP地址的子网掩码。 当IP地址取的是16位,则子网掩码填“255.255.0.0”。 当IP地址取的是24位,则子网掩码填“255
API的请求说明请参见《API参考》。 为API请求添加认证信息。 表2 认证方式 认证方式 API请求参数配置 APP认证 表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。关于使用APP认证的方法,具体请参考《开发指南》。 当选择“APP认证”时,需要配置“APP凭据”。 “A
终端节点 终端节点(Endpoint)即调用API的请求地址,KooSearch局点在贵阳一,终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择 其他设置:召回数量
如何调用API 构造请求 认证鉴权 接口获取 返回结果
调用已发布的KooSearch API。 编辑API。 下线API。 3 管理KooSearch服务 在服务的基本信息页面,可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外,还能进行管理服务、API管理和日志管理。具体请看管理KooSearch知识库。 4 查看KooSearch服务日志
单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、版本管理的操作。 引用知识库 如果您有知识共享诉求,比如同级部门间的共享A引用B的知识库,或者各部门分权独立维
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度:0 最大长度:64 表7
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度:0 最大长度:64 表7
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度:0 最大长度:64 表7
获取用户Token响应消息头所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。