注意:开通AI服务后的 AppKey,使用以下 TOP API 仅限在 AI 服务下的应用中调用,禁止外部调用。
知识库:一类知识可以创建一个知识库,服务商可自定义创建。一个知识库下可以创建多个知识单元。 可以理解为知识库是个文件夹,文件夹下可以有多个知识文档。一个文件夹下最多1000个文档。
知识单元unit:可以理解为一个知识文档,里面包含若干知识分片。一个知识单元一定属于某个知识库。每个单元下面的chunk条数目前限制了1000条。
知识分片chunk:一条具体的知识,可包含文字、图片、视频。 知识长度不超过500字每条,尽量简短准确。一个知识分片一定属于某个知识单元。
知识标签:可以给知识单元和知识分片进行打标,用于根据标签进行知识检索。
接口名称:taobao.top.rag.tag.cate.add
入参说明
cate_name // tag类目名称 string 2-8 个字符 全局唯一 max_mark_count // int 同一个知识点最多可打N个此类型标签 小于等于20
出参说明
说明:每个开发者范围内,name唯一。
name: string // tag类目名称 string 2-8 个字符 全局唯一 max_mark_count // 同一个知识点最多可打N个此类型标签,默认1
接口名称:taobao.top.rag.tag.cate.update
入参说明
cate_name // tag类目名称 string 2-8 个字符 帐号下唯一 max_mark_count // int 每个打标对象最多打多少个当前类目的标签。 改小后,对存量已经打标的无法变更。
出参说明
true/false
接口名称:taobao.top.rag.tag.cate.list
入参说明
cat_name // tag类目名称 全局唯一 page_size //必选 string page_num //必选 1开始
出参说明
name: string // tag类目名称 string 2-8 个字符 max_mark_count: Number // 同一个知识点最多可打N个此类型标签,默认1
接口名称:taobao.top.rag.tag.cate.disable
入参说明
cate_name // cate
出参说明
true/false
入参说明
tag_name // 必填 tag名称 string 2-8 个字符 类目下唯一 tag_code // 必填 tagcode 2-10类目下唯一 仅英文&下划线 cate_name //必填 tag类目 description // 描述 string 0-100个字符
出参说明
tag_code // 标签code, 2-10个字符,仅英文&下划线,类目下唯一 name // tag名称 string 2-8 个字符 类目下唯一 cateName // tag类目 description // 描述 string 0-100个字符
接口名称:taobao.top.rag.tag.update
入参说明
tag_name // 可选 tag名称 string 2-8个字符 类目下唯一 description // 仅支持修改描述 string 0-100个字符 tag_code // 必填 标签code, 2-10个字符,仅英文&下划线,类目下唯一 cate_name // 必填 tag类目
出参说明
true/false
入参说明
cate_name //必选 string tag类目 page_size //必选 string page_num //必选 1开始
出参说明
tag_code // 标签code, 2-10个字符,仅英文&下划线,类目下唯一 name // 标签名称, 2-8个字符,仅英文&下划线,类目下唯一 cate_name // tag类目 description // 标签描述
接口名称:taobao.top.rag.tag.disable
说明:只能禁用标签类目,历史已打标不受影响。
入参说明
tag_code // 必填 标签 code, 2-10个字符,仅支持英文和下划线,类目下唯一 cate_name // 标签类目
出参说明
true/false
接口名称:taobao.top.rag.tag.enable
入参说明
tag_code // 必填 tag名称 string 2-8 个字符 类目下唯一 cate_name // 必填 标签类目
出参说明
true/false
知识库:一类知识可以创建一个知识库,服务商可自定义创建。一个知识库下可以创建多个知识单元。 可以理解为知识库是个文件夹,文件夹下可以有多个知识文档。一个文件夹下最多1000个文档。
说明:均需要商家授权。
限制:
头像icon:限制大小&尺寸 2M 1280*1280。
知识库命名name:长度限制12字符。
介绍description:长度限制200字符。
接口名称:taobao.top.rag.knowledge.add
说明: 知识库属于商家,开发者为代开发。
入参说明
{ "name": "测试知识库", // 必须 "icon": "https://osxxxx1f2cf7479969e.png",// 必须 "description": "测试知识库描述,简单介绍RAG",// 必须 "scene":"customer_support"// 必须 默认可以写死customer_support }
出参说明
true/false
接口名称:taobao.top.rag.knowledge.update
入参说明
{ "name": "测试知识库", "icon": "https://ossgxxxxf2cf7479969e.png", "description": "测试知识库描述,简单介绍RAG", "id": 10 }
出参说明
true/false
接口名称:taobao.top.rag.knowledge.list
说明:校验appkey owner为知识库待开发者。根据 id,商家id,名称进行查询。
入参说明
{ "name": "测试知识库", "id": 10, "page_no": 10, "page_size": 1 }
出参说明
id // 知识库主键 gmt_create // 创建时间 gmt_modified // 修改时间 name // 知识库名称 description // 知识库描述 icon // 知识库图标 unit_count // 知识库下知识单元数量 knowledge_size // 知识库大小 scenes // 知识库场景
接口名称:taobao.top.rag.knowledge.disable
说明:根据id禁用。
入参说明
{ "id": "测试知识库" }
出参说明
true/false
知识单元unit:可以理解为一个知识文档,里面包含若干知识分片。一个知识单元一定属于某个知识库。每个单元下面的chunk条数目前限制了1000条。
知识标签:可以给知识单元和知识分片进行打标,用于根据标签进行知识检索。
接口名称:taobao.top.rag.unit.add
说明:校验知识库代开发者与当前appkey owner
入参说明
{ "name": "测试知识单元", "knowledge_id": "111", // 创建知识库返回id "description": "测试知识库描述,简单介绍RAG" }
出参说明
true/false
接口名称:taobao.top.rag.unit.update
入参说明
{ "name": "测试知识库", "id": 10, "description": "测试知识库描述,简单介绍RAG" }
出参说明
true/false
接口名称:taobao.top.rag.unit.list
说明:校验appkey owner为知识库待开发者;根据 id,商家id,名称进行查询。
入参说明
{ "knowledge_id":123456,必选 "unit_name": "测试知识库", 可选 "unit_id": 10,可选 "page_size": 10,必选 "page_no": 1必选 }
出参说明
knowledge_unit_id // 知识单元主键 knowledge_id // 知识库主键 gmt_modified // 知识单元修改时间 name // 知识单元名称 description // 知识单元描述
接口名称:taobao.top.rag.unit.disable
说明:校验appkey owner为知识库待开发者;根据id禁用。
入参说明
{ "id": 10 }
出参说明
true/false
接口名称:taobao.top.rag.tag.unit.mark
入参说明
{ "unit_id": 10, "tags": [{ cate_name, tag_code }] // 数组 }
出参说明
cate_name // 类目名称 tag_code // 标签 Code
接口名称:taobao.top.rag.tag.unit.unmark
入参说明
{ "unit_id": 10, "tags": [{ cate_name, tag_code }] // 数组 }
出参说明
tag_code // 标签 Code cate_name // 类目名称 success // true/false 是否成功
知识分片chunk:一条具体的知识,可包含文字、图片、视频。 知识长度不超过500字每条,尽量简单准确。一个知识分片一定属于某个知识单元。
入参说明
{ "chunk_num":1,//知识 chunk 序号 "chunk_content": " \n引导关注:感谢大家的关注,还没关注主播的抓紧关注哟,妹妹每天都给大家带来不同惊喜!__image__0", // 不超过500字 "image_info": {"__image__0":"url","__image__1":"url"},//官方标准格式,仅支持商家图片空间视频空间 & OSS地址 "knowledge_id": "7", "unit_id": "4", "video_info": {"__video__0":"url","__vedio__1":"url"},//官方标准格式,仅支持商家图片空间视频空间 & OSS地址 "target_ids": ["SKU_123","ITEM_333" ,"SHOP_222"] // 知识关联的商品 SKU或店铺信息 }
出参说明
true/false
接口名称:taobao.top.rag.chunk.update
说明:仅能更新 chunk content& imageInfo&videoInfo。
入参说明
{ "id": "7-4-75-60", // chunk id "chunk_content": " \n引导关注:感谢大家的关注,还没关注主播的抓紧关注哟,妹妹每天都给大家带来不同惊喜!", //不超过500 "image_info": {"__image__0":"url","__image__1":"url"},//官方标准格式,仅支持商家图片空间视频空间 & OSS地址 "video_info": {"__video__0":"url","__vedio__1":"url"},///官方标准格式,仅支持商家图片空间视频空间 & OSS地址 "target_ids": ["SKU_123","ITEM_333" ,"SHOP_222"] }
出参说明
true/false
接口名称:taobao.top.rag.chunk.list
入参说明
{ "ids": [],可选// chunk id "knowledge_id": "7",必选 "unit_id": "4",必选 "page_size": 10,必选 "page_no": 1必选 }
出参说明
id // 知识 chunk 主键 knowledge_id // 知识库主键 unit_id // 知识库单元主键 unit_name // 知识库单元名称 chunk_num // 知识 chunk 序号 chunk_content // 知识内容 labels // chunk 标签 target_ids // 知识关联的商品 SKU或店铺信息
接口名称:taobao.top.rag.chunk.disable
说明:根据id禁用。
入参说明
{ "ids": []必选 }
出参说明
true/false
接口名称:taobao.top.rag.tag.chunk.mark
说明:表示给chunkIds都打上tags里面的标签。
入参说明
{ "chunk_ids": [],必选 "unit_id": "4",必选 "knowledge_id": "7",必选 "tags":[{ cate_name, tag_code }] // 数组 必选 }
出参说明
[{ "chunkId": "7-4-75-61", "markResult":[{ cate, tagCode, success:true/false }] },{ "chunkId": "7-4-75-62", "markResult":[{ cate, tagCode, success:true/false }] }]
接口名称:taobao.top.rag.tag.chunk.unmark
入参说明
{ "chunk_ids": [],必选 "unit_id": "4",必选 "knowledge_id": "7",必选 "tags":[{ cate_name, tag_code }] // 数组 必选 }
出参说明
cate_name // 类目名称 tag_code // 标签 Code
接口名称:taobao.top.rag.chunk.search
入参说明
{ "knowledge_id_list": [],必选 "query": "",必选 "top_n": 5, 默认 5 "search_type_list": [1], 默认不传使用[1,2]; [1] Doc基于qury与chunkContent的向量相似性&关键字召回 [2]QA基于qury与answer的向量相似性&关键字召回召回[3]基于searchIds条件匹配的全量召回 "search_ids": "ITEM_XXX,ITEM_YYY", 标签字符串,多值使用','分割,为 and 关系 "tags": "[{"tagCode":"标签Code","cateName":"标签类目"},{"tagCode":"shop","cateName":"makeup"}]", JSON 序列化数组 "pageIndex": 1, searchType 传 [3] ,精确全量召回时使用 "pageSize": 10 searchType 传 [3] ,精确全量召回时使用 }
出参说明
id // 知识 chunk 主键 knowledge_id // 知识 chunk 主键 unit_id // 知识库单元主键 unit_name // 知识库单元名称 chunk_num // 知识 chunk 序号 chunk_content // 知识内容 labels // chunk 标签 target_ids // 知识关联的商品 SKU或店铺信息,枚举类型_ID ,ID 在类型中唯一。目前支持SKU,ITEM,SH0P,SELFDEF(自定义类型)几种类型,举例:SKU123,ITEM333,SH0P_222 SELFDEF_111