知识库-对外API
版本变更
文档版本 | 描述 | SDK版本 | 时间 |
v2.11.0 | 新增知识库列表、文档上传、文档查询api |
一、接口定义
1. 查询知识库列表
ListKnowledgeBase
入参
字段名 | 字段说明 | 默认值 | |
pageNumber | 分页页码 | 1 | |
pageSize | 分页大小 | 10 | |
knowledgeBaseId | 筛选的知识库id,非必填 |
出参
字段名 | 字段说明 | |
requestId | 请求id | |
total | 知识库总数 | |
knowledgeBases[] | 知识库信息 | |
name | student 学员 coach 智能体模拟的客户 | |
description | 消息内容 | |
industry | 知识库行业 Car: 汽车 CulturalTour: 文旅 Garment: 运动户外 Internet: 互联网工具 Education: 教育 Medical:医药 Retail:零售 Restaurant:餐饮 Common:通用 | |
id | 知识库id | |
knowledgeBaseType | 知识库类型 Panxi:磐曦智创 Bailian:百炼 |
2. 批量添加文档
2.1. BatchAddDocument
入参
字段名 | 字段说明 | |
knowledgeBaseId | 知识库ID | |
addDocumentInfos[] | 待添加文档信息 | |
name | 文档名称,最大长度64 | |
documentType | 文档类型,枚举:pdf,txt,md,doc,docx,ppt,pptx,xls,xlsx | |
url | 可公网访问的文档下载地址 |
出参
字段名 | 字段说明 | |
requestId | 请求ID | |
addDocumentResults[] | 文档添加结果列表 | |
docName | 文档名称 | |
success | 文档是否上传成功 | |
errorMessage | 文档上传失败原因 | |
documentInfo | 文档信息 | |
docName | 文档名称 | |
id | 文档id | |
processStatus | 文档解析状态 Processing: 解析中 Success:解析完成 Failed:解析失败 | |
documentType | 文档类型 txt/md/pdf/doc/docx/ppt/pptx/xls/xlsx |
3. 查询文档状态
3.1. DescribeDocument
入参
字段名 | 字段说明 | |
knowledgeBaseId | 知识库id | |
documentId | 文档id |
出参
字段名 | 字段说明 | |
requestId | 请求id | |
documentInfo | 文档信息 | |
docName | 文档名称 | |
id | 文档id | |
processStatus | 文档解析状态 Processing: 解析中 Success:解析完成 Failed:解析失败 | |
documentType | 文档类型 txt/md/pdf/doc/docx/ppt/pptx/xls/xlsx |
二、SDK
JAVA
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>intelligentcreation20240313</artifactId>
<version>SDK版本</version>
</dependency>
三、开发参考
JavaSDK接口调用
package org.example;
import com.alibaba.fastjson.JSON;
import com.aliyun.intelligentcreation20240313.Client;
import com.aliyun.intelligentcreation20240313.models.ListAICoachTaskPageRequest;
import com.aliyun.intelligentcreation20240313.models.ListAICoachTaskPageResponse;
import com.aliyun.intelligentcreation20240313.models.ListAICoachTaskPageResponseBody;
import com.aliyun.tea.TeaException;
import com.aliyun.teaopenapi.models.Config;
import java.util.List;
public class Test {
static String endpoint = "intelligentcreation.cn-zhangjiakou.aliyuncs.com";
/**
* 创建客户端
*/
static Client client;
static {
//初始化配置
try {
Config config = new Config()
//替换AccessKeyId和AccessKeySecret
.setAccessKeyId("阿里云AccessKeyId")
.setAccessKeySecret("阿里云AccessKeySecret")
.setEndpoint(endpoint);
client = new Client(config);
} catch (Exception e) {
e.printStackTrace();
}
}
public static void main(String[] args) {
String studentId = "学员id";
//请求request,类名为<API名称>Request
ListAICoachTaskPageRequest request = new ListAICoachTaskPageRequest();
request.setStudentId(studentId);
try {
//响应response,类名为<API名称>Response
//client方法,方法名为<API名称>
ListAICoachTaskPageResponse response = client.listAICoachTaskPage(request);
List<ListAICoachTaskPageResponseBody.ListAICoachTaskPageResponseBodyTaskList> taskList
= response.getBody().getTaskList();
System.out.println("taskList:" + JSON.toJSONString(taskList));
} catch (TeaException teaException) {
//API调用失败,通过message和data获取错误信息
System.out.println("TeaException," + teaException.getMessage() + ",data:" + JSON.toJSONString(teaException.getData()));
teaException.printStackTrace();
} catch (Exception e) {
//API调用异常
e.printStackTrace();
}
}
}