开放能力介绍
更新时间:2024-07-25
整体开放架构
技术内核层是能力引擎的核心模块,包括核心组件和配套组件:
其中核心组件主要包含应用组件的开发和发布,基于APaaS应用工作台的开发套件SDK、开发框架RAG/Agent完成能力引擎应用组件的开发,工程上基于GR-PPL快速实现能力的业务逻辑封装和服务化,效果上基于一言的Turbo模型实施场景化数据SFT,最后基于API网关统一鉴权和输出。
配套组件主要包含开发者工具、数据飞轮和可观测工具。开发者工具主要面向开发者提供API文档、API在线调试和基于API的样板应用体验能力,能帮助开发者快速感知、应用开放能力。数据飞轮主要面向开发者对开放能力的效果进行调优,包括知识点运营和模型迭代,知识点运营主要是对知识本身进行增删改查的运营动作,通过对知识进行干预提升知识的满足度。模型迭代主要是基于场景化数据和场景反馈数据对能力中的大小模型进行重训迭代。可观测工具主要面向开发者及时观测系统运行指标,帮助开发者快速定位排查系统问题。
统一鉴权
调用开放API时,需要再请求头中带上鉴权相关字段,相关字段定义如下:
参数名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
userid | String | 是 | 用户id |
username | String | 是 | 展示名,需使用base64加密 |
accountid | String | 是 | 租户id |
token | String | 是 | 开放接口对应的token,不同的接口对应不同的token。具体token请联系我们获取。 |
获取方式:
登录平台,accountid对应url上的projectId,userid对应用户ID,username对应显示名
敬请期待:在后续版本迭代中,我们计划通过统一的ak/sk鉴权模式和user-access-token/app-access-token的方式来提供更标准的安全校验能力。
接口列表
数据导入/删除:
接口名称 | 接口地址 | 描述 |
---|---|---|
数据接入接口(原始文档) | /ku/openapi/files/import | 通过原始文档接入 |
数据接入接口(url) | /ku/openapi/client/files/import | 通过url地址接入 |
创建文档 | /ku/openapi/docs/create | 创建文档 |
文档删除 | /ku/openapi/docs/delete | 删除文档 |
数据生产状态接口 | /kmss/openapi/data/file/info/list | 查看数据生产状态,解析中、生产中、解析失败、生产失败等 |
创建结构化接入api接口 | /kmss/openapi/search-platform/source/add | 创建结构化接入api |
推送结构化数据接口 | /kmss/openapi/data/access/push | 通过某个Source将结构化数据推入系统 |
结构化数据关联文档接口 | /kmss/openapi/data/source/data/updateRelation | 将指定的结构化数据和非结构化数据绑定 |
创建faq库知识树节点 | /kmss/openapi/search-platform/tree/addWithSource | 在指定的faq库下创建知识树节点 |
查询faq库下的知识树节点与资源信息 | /kmss/openapi/search-platform/tree/getNodesAndSource | 查询faq库下的知识树节点与资源信息 |
知识生产:
接口名称 | 接口地址 | 描述 |
---|---|---|
faq挖掘/抽取接口 | /kmss/openapi/search-platform/datasource/doc/process/add | 根据文档类型和策略不同,提供faq抽取和挖掘能力。 |
faq列表 | /kmss/openapi/data-proofread/datamanage/faq/list | 根据文档id获取挖掘或抽取出的faq列表 |
标签挖掘接口 | /kmss/openapi/tagger/v1/mining | 基于大模型根据文档内容挖掘标签。 |
摘要生成接口 | /kmss/openapi/insight/v1/abstract_generation | 基于大模型根据文档内容生产摘要。 |
知识应用:
接口名称 | 接口地址 | 描述 |
---|---|---|
搜索接口 | /kmss/openapi/mpks/api/search | 执行搜索操作的主要接口,支持关键字或语义查询,并返回匹配的搜索结果。 |
FAQ接口 | /kmss/openapi/mpks/api/search/faq | faq问答接口 |
综合问答接口 | /kmss/openapi/chihiro/qacore/dialog/simpleQaSummary | 基于大模型针对用户的搜索,实现语义理解,提供结果综述和文档问答,并给出搜索结果的来源。 |
阅读理解问答接口 | /kmss/openapi/chihiro/qacore/dialog/simpleQa | 基于大模型和搜索,实现语义理解,提供文档问答,并给出搜索结果的来源。 |
topK 总结接口 | /kmss/openapi/chihiro/qacore/dialog/simpleSummary | 基于大模型对 topk 的检索结果(一般为 top3) 进行问答式综述 |
搜索推荐接口() | /kmss/openapi/mpks/api/try/query | 基于文档内容挖掘,个性化推荐搜索词。 |
扩展问接口 | /kmss/openapi/chihiro/qacore/dialog/extendQuestion | 基于大模型进行扩展问题推荐。 |
sug接口 | /kmss/openapi/mpks/api/sug/list | 根据用户输入的部分关键字或查询,提供搜索建议,帮助用户完成查询,提供相关的搜索词或短语。 |
知识运营:
接口名称 | 接口地址 | 描述 |
---|---|---|
热门搜索接口 | /kmss/openapi/mpks/api/hotquery/rank | 提供当前热门搜索词或热门查询的统计信息,以便在搜索界面展示热门搜索内容。 |
热门文档接口 | /kmss/openapi/mpks/api/recommend/kms/docHot | 提供当前热门搜索文档。 |
其他:
接口名称 | 接口地址 | 描述 |
---|---|---|
文档权限更新接口 | /ku/openapi/auth/addOrUpdateDocMember | 用于更新文档权限 |
获取文档下载地址 | /ku/openapi/doc/getDownloadUrl | 查询文档下载地址 |
查询文档guid下所有的子文档信息接口 | /ku/openapi/doc/queryDocsByParent | 查询文档guid下所有的子文档信息 |
查询有权限的知识库 | /ku/openapi/doc/repositories | 查询有权限的知识库 |
获取知识库下的目录列表 | /ku/openapi/doc/repository/dirDocs | 获取知识库下的目录列表 |
轻文档内容查询接口 | /ku/openapi/doc/queryContent | 用于查询轻文档正文源数据及文档标题信息 |
获取文档详情(配合问答的溯源) | /kmss/openapi/mpks/api/file/infoV2 | 用于通过docId和nid查询文档详情 |
文档上下线 | /kmss/openapi/search-platform/datamanage/fulltext/online | 用于通过docId和repoGuid操作文档上下线 |
批量导入渠道信息 | /kmss/openapi/search-platform/datamanage/channel/addBatch | 用于批量创建渠道信息接口 |
修改渠道信息 | /kmss/openapi/search-platform/datamanage/channel/update | 用于修改渠道信息 |
删除渠道信息 | /kmss/openapi/search-platform/datamanage/channel/delete | 用于批量删除渠道 |
词典配置:
接口名称 | 接口地址 | 描述 |
---|---|---|
新增推荐词 | /kmss/openapi/fulltextmgt/api/searchRecommendSug/addRecommendSug | 用于新增检索推荐词 |
更新推荐词 | /kmss/openapi/fulltextmgt/api/searchRecommendSug/changeRecommendSug | 用于更新检索推荐词 |
删除推荐词 | /kmss/openapi/fulltextmgt/api/searchRecommendSug/removeRecommendSug | 用于删除检索推荐词 |
查询推荐词 | /kmss/openapi/fulltextmgt/api/searchRecommendSug/queryRecommendSugByCondition | 用于查询推荐词列表 |
查询专有名词 | /kmss/openapi/fulltextmgt/api/qdmanagement/getProperNounList | 查询专有名词列表 |
新增专有名词 | /kmss/openapi/fulltextmgt/api/qdmanagement/addProperNoun | 新增专有名词 |
更新专有名词 | /kmss/openapi/fulltextmgt/api/qdmanagement/updateProperNoun | 根据ID更新专有名词 |
删除专有名词 | /kmss/openapi/fulltextmgt/api/qdmanagement/deleteProperNoun | 删除专有名词 |
查询同义词列表 | /kmss/openapi/fulltextmgt/api/qdmanagement/getSynonymList | 查询同义词列表 |
新增同义词 | /kmss/openapi/fulltextmgt/api/qdmanagement/addSynonym | 新增同义词 |
更新同义词 | /kmss/openapi/fulltextmgt/api/qdmanagement/updateSynonym | 更新同义词 |
删除同义词 | /kmss/openapi/fulltextmgt/api/qdmanagement/deleteSynonym | 删除同义词 |
查询纠错词列表 | /kmss/openapi/fulltextmgt/api/qdmanagement/getErrorCorrectList | 查询纠错词列表 |
新增纠错词 | /kmss/openapi/fulltextmgt/api/qdmanagement/addErrorCorrect | 新增纠错词 |
更新纠错词 | /kmss/openapi/fulltextmgt/api/qdmanagement/updateErrorCorrect | 更新纠错词 |
删除纠错词 | /kmss/openapi/fulltextmgt/api/qdmanagement/deleteErrorCorrect | 删除纠错词 |
查询敏感词列表 | /kmss/openapi/fulltextmgt/api/qdmanagement/getSensitiveWordList | 查询敏感词列表 |
新增敏感词 | /kmss/openapi/fulltextmgt/api/qdmanagement/addSensitiveWord | 新增敏感词列表 |
更新敏感词 | /kmss/openapi/fulltextmgt/api/qdmanagement/updateSensitiveWord | 更新敏感词 |
删除敏感词 | /kmss/openapi/fulltextmgt/api/qdmanagement/deleteSensitiveWord | 删除敏感词 |