程序包 com.baidubce.appbuilder.console.knowledgebase

类 Knowledgebase

java.lang.Object

com.baidubce.appbuilder.base.component.Component

com.baidubce.appbuilder.console.knowledgebase.Knowledgebase

public class Knowledgebase
extends Component

字段概要

从类继承的字段 com.baidubce.appbuilder.base.component.Component

httpClient

构造器概要

构造器

构造器	说明
Knowledgebase()
Knowledgebase(String SecretKey)
Knowledgebase(String knowledgeBaseId, String SecretKey)

方法概要

修饰符和类型	方法	说明
String[]	addDocument(DocumentAddRequest req)	已过时。
String[]	addDocument(DocumentAddRequest req, String clientToken)	已过时。
String	createChunk(String documentId, String content)	根据给定的文档ID和内容创建一个块
String	createChunk(String documentId, String content, String clientToken)	创建文档块
DocumentsCreateResponse	createDocuments(DocumentsCreateRequest request)	创建文档
DocumentsCreateResponse	createDocuments(DocumentsCreateRequest request, String clientToken)	创建文档
KnowledgeBaseDetail	createKnowledgeBase(KnowledgeBaseDetail request)	创建知识库详情
KnowledgeBaseDetail	createKnowledgeBase(KnowledgeBaseDetail request, String clientToken)	创建知识库详情
void	deleteChunk(String chunkId)	删除指定的文件块。
void	deleteChunk(String chunkId, String clientToken)	删除指定的块。
void	deleteDocument(DocumentDeleteRequest request)	删除文档
void	deleteDocument(DocumentDeleteRequest request, String clientToken)	删除文档
void	deleteKnowledgeBase(String knowledgeBaseId)	删除知识库
void	deleteKnowledgeBase(String knowledgeBaseId, String clientToken)	删除知识库
ChunkDescribeResponse	describeChunk(String chunkId)	根据块ID描述块
ChunksDescribeResponse	describeChunks(String documentId, String marker, Integer maxKeys, String type)	描述文档的分块信息
Document[]	getDocumentList(DocumentListRequest request)	获取文档列表
KnowledgeBaseDetail	getKnowledgeBaseDetail(String knowledgeBaseId)	根据知识库ID获取知识库详情
KnowledgeBaseListResponse	getKnowledgeBaseList(KnowledgeBaseListRequest request)	获取知识库列表
void	modifyChunk(String chunkId, String content, boolean enable)	修改指定块的内容
void	modifyChunk(String chunkId, String content, boolean enable, String clientToken)	修改指定区块的内容及其启用状态
void	modifyKnowledgeBase(KnowledgeBaseModifyRequest request)	修改知识库。
void	modifyKnowledgeBase(KnowledgeBaseModifyRequest request, String clientToken)	修改知识库
QueryKnowledgeBaseResponse	queryKnowledgeBase(QueryKnowledgeBaseRequest request)
QueryKnowledgeBaseResponse	queryKnowledgeBase(String query, String type, Float rank_score_threshold, Integer top, Integer skip, String[] knowledgebaseIDs, QueryKnowledgeBaseRequest.MetadataFilters filters, QueryKnowledgeBaseRequest.QueryPipelineConfig pipelineConfig)
QueryKnowledgeBaseResponse	queryKnowledgeBase(String query, String type, Integer top, Integer skip, String[] knowledgebaseIDs, QueryKnowledgeBaseRequest.MetadataFilters filters, QueryKnowledgeBaseRequest.QueryPipelineConfig pipelineConfig)
DocumentsUploadResponse	uploadDocuments(String filePath, DocumentsCreateRequest request)	上传文档
DocumentsUploadResponse	uploadDocuments(String filePath, DocumentsCreateRequest request, String clientToken)	上传文档
String	uploadFile(String filePath)	已过时。
String	uploadFile(String filePath, String clientToken)	已过时。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Knowledgebase

public Knowledgebase()

Knowledgebase

public Knowledgebase(String SecretKey)

Knowledgebase

public Knowledgebase(String knowledgeBaseId,
                     String SecretKey)

方法详细资料

uploadFile

@Deprecated
public String uploadFile(String filePath)
                  throws IOException,
                         AppBuilderServerException

已过时。

上传文档

参数:

filePath - 文件路径

返回:

上传成功后的文档ID

抛出:

IOException - 当文件上传失败时抛出IOException

AppBuilderServerException - 当服务器返回错误码时抛出AppBuilderServerException

uploadFile

@Deprecated
public String uploadFile(String filePath,
                         String clientToken)
                  throws IOException,
                         AppBuilderServerException

已过时。

上传文件

参数:

filePath - 文件路径

clientToken - 客户端令牌

返回:

上传文件的结果

抛出:

IOException - 如果发生I/O错误

AppBuilderServerException - 如果应用构建服务器发生错误

addDocument

@Deprecated
public String[] addDocument(DocumentAddRequest req)
                     throws IOException,
                            AppBuilderServerException

已过时。

新增知识库文档

参数:

req - 请求参数

返回:

documentIds 文档ID

抛出:

IOException - 当文件上传失败时抛出IOException

AppBuilderServerException - 当服务器返回错误码时抛出AppBuilderServerException

addDocument

@Deprecated
public String[] addDocument(DocumentAddRequest req,
                            String clientToken)
                     throws IOException,
                            AppBuilderServerException

已过时。

向应用程序中添加文档

参数:

req - 文档添加请求对象，包含需要添加的文档信息

clientToken - 客户端令牌，用于验证请求来源

返回:

返回一个字符串数组，包含操作结果

抛出:

IOException - 如果发生输入/输出异常，抛出此异常

AppBuilderServerException - 如果应用程序构建服务器发生异常，抛出此异常

getDocumentList

public Document[] getDocumentList(DocumentListRequest request)
                           throws IOException,
                                  AppBuilderServerException

获取文档列表

参数:

request - 文档列表请求对象，包含请求参数

返回:

文档数组

抛出:

IOException - 当发生输入输出异常时抛出

AppBuilderServerException - 当应用构建服务器发生异常时抛出

deleteDocument

public void deleteDocument(DocumentDeleteRequest request)
                    throws IOException,
                           AppBuilderServerException

删除文档

参数:

request - 文档删除请求对象

抛出:

IOException - 如果在删除文档过程中发生I/O异常

AppBuilderServerException - 如果在删除文档过程中发生AppBuilder服务器异常

deleteDocument

public void deleteDocument(DocumentDeleteRequest request,
                           String clientToken)
                    throws IOException,
                           AppBuilderServerException

删除文档

参数:

request - 删除文档的请求对象，包含要删除的文档ID等信息

clientToken - 客户端令牌，用于验证请求合法性

抛出:

IOException - 如果发生输入输出异常

AppBuilderServerException - 如果发生应用构建服务器异常

createKnowledgeBase

public KnowledgeBaseDetail createKnowledgeBase(KnowledgeBaseDetail request)
                                        throws IOException,
                                               AppBuilderServerException

创建知识库详情

参数:

request - 请求体，包含创建知识库所需的信息

返回:

创建成功后的知识库详情

抛出:

IOException - 当输入输出操作发生错误时抛出

AppBuilderServerException - 当应用构建服务器发生错误时抛出

createKnowledgeBase

public KnowledgeBaseDetail createKnowledgeBase(KnowledgeBaseDetail request,
                                               String clientToken)
                                        throws IOException,
                                               AppBuilderServerException

创建知识库详情

参数:

request - 包含创建知识库详情所需的参数

clientToken - 客户端令牌，用于身份验证

返回:

创建成功后的知识库详情对象

抛出:

IOException - 如果发生I/O错误

AppBuilderServerException - 如果发生应用程序构建服务器异常

getKnowledgeBaseDetail

public KnowledgeBaseDetail getKnowledgeBaseDetail(String knowledgeBaseId)
                                           throws IOException,
                                                  AppBuilderServerException

根据知识库ID获取知识库详情

参数:

knowledgeBaseId - 知识库ID

返回:

KnowledgeBaseDetail 知识库详情对象

抛出:

IOException - 如果在发送HTTP请求或解析响应时发生IO异常

AppBuilderServerException - 如果发生AppBuilder服务器异常

deleteKnowledgeBase

public void deleteKnowledgeBase(String knowledgeBaseId)
                         throws IOException,
                                AppBuilderServerException

删除知识库

参数:

knowledgeBaseId - 知识库ID

抛出:

IOException - 当发生输入输出异常时抛出

AppBuilderServerException - 当应用构建服务器异常时抛出

deleteKnowledgeBase

public void deleteKnowledgeBase(String knowledgeBaseId,
                                String clientToken)
                         throws IOException,
                                AppBuilderServerException

删除知识库

参数:

knowledgeBaseId - 知识库ID

clientToken - 客户端令牌

抛出:

IOException - 如果发生输入输出异常

AppBuilderServerException - 如果发生应用构建服务器异常

modifyKnowledgeBase

public void modifyKnowledgeBase(KnowledgeBaseModifyRequest request)
                         throws IOException,
                                AppBuilderServerException

修改知识库。

参数:

request - 知识库修改请求对象

抛出:

IOException - 如果在I/O操作过程中发生错误，则抛出此异常

AppBuilderServerException - 如果应用构建服务器发生错误，则抛出此异常

modifyKnowledgeBase

public void modifyKnowledgeBase(KnowledgeBaseModifyRequest request,
                                String clientToken)
                         throws IOException,
                                AppBuilderServerException

修改知识库

参数:

request - 修改请求对象，包含需要修改的内容

clientToken - 客户端令牌，用于验证请求来源的合法性

抛出:

IOException - 如果发生输入输出异常

AppBuilderServerException - 如果应用构建服务器发生异常

getKnowledgeBaseList

public KnowledgeBaseListResponse getKnowledgeBaseList(KnowledgeBaseListRequest request)
                                               throws IOException,
                                                      AppBuilderServerException

获取知识库列表

参数:

request - 包含请求参数的知识库列表请求对象

返回:

知识库列表响应对象

抛出:

IOException - 如果发生I/O异常，抛出此异常

AppBuilderServerException - 如果应用构建服务器发生异常，抛出此异常

createDocuments

public DocumentsCreateResponse createDocuments(DocumentsCreateRequest request)
                                        throws IOException,
                                               AppBuilderServerException

创建文档

参数:

request - 文档创建请求

返回:

创建文档的响应结果

抛出:

IOException - 当发生输入输出异常时抛出

AppBuilderServerException - 当应用构建服务器发生异常时抛出

createDocuments

public DocumentsCreateResponse createDocuments(DocumentsCreateRequest request,
                                               String clientToken)
                                        throws IOException,
                                               AppBuilderServerException

创建文档

参数:

request - 包含创建文档所需信息的请求对象

clientToken - 客户端令牌，用于身份验证

返回:

包含创建文档结果的响应对象

抛出:

IOException - 如果发生输入/输出错误

AppBuilderServerException - 如果应用程序构建服务器发生错误

uploadDocuments

public DocumentsUploadResponse uploadDocuments(String filePath,
                                               DocumentsCreateRequest request)
                                        throws IOException,
                                               AppBuilderServerException

上传文档

参数:

filePath - 文件路径

request - 文档创建请求

返回:

文档上传响应

抛出:

IOException - 如果发生I/O错误，则抛出此异常

AppBuilderServerException - 如果发生应用程序构建服务器错误，则抛出此异常

uploadDocuments

public DocumentsUploadResponse uploadDocuments(String filePath,
                                               DocumentsCreateRequest request,
                                               String clientToken)
                                        throws IOException,
                                               AppBuilderServerException

上传文档

参数:

filePath - 文件路径

request - 文档上传请求对象

clientToken - 客户端Token

返回:

文档上传响应对象

抛出:

IOException - 抛出IO异常

AppBuilderServerException - 抛出应用构建服务器异常

createChunk

public String createChunk(String documentId,
                          String content)
                   throws IOException,
                          AppBuilderServerException

根据给定的文档ID和内容创建一个块

参数:

documentId - 文档ID

content - 块的内容

返回:

创建的块的字符串表示

抛出:

IOException - 如果在文件操作中发生错误

AppBuilderServerException - 如果在应用程序构建服务器操作中发生错误

createChunk

public String createChunk(String documentId,
                          String content,
                          String clientToken)
                   throws IOException,
                          AppBuilderServerException

创建文档块

参数:

documentId - 文档ID

content - 文档内容

clientToken - 客户端令牌

返回:

创建的文档块字符串

抛出:

IOException - 如果发生I/O错误

AppBuilderServerException - 如果应用程序构建服务器异常

modifyChunk

public void modifyChunk(String chunkId,
                        String content,
                        boolean enable)
                 throws IOException,
                        AppBuilderServerException

修改指定块的内容

参数:

chunkId - 块标识符

content - 要设置的内容

enable - 是否启用块

抛出:

IOException - 当发生输入输出异常时抛出

AppBuilderServerException - 当发生应用构建服务器异常时抛出

modifyChunk

public void modifyChunk(String chunkId,
                        String content,
                        boolean enable,
                        String clientToken)
                 throws IOException,
                        AppBuilderServerException

修改指定区块的内容及其启用状态

参数:

chunkId - 区块的ID

content - 需要设置的新内容

enable - 是否启用该区块，true表示启用，false表示禁用

clientToken - 客户端令牌，用于验证客户端身份

抛出:

IOException - 如果发生I/O错误

AppBuilderServerException - 如果发生应用构建服务器错误

deleteChunk

public void deleteChunk(String chunkId)
                 throws IOException,
                        AppBuilderServerException

删除指定的文件块。

参数:

chunkId - 要删除的文件块的ID

抛出:

IOException - 如果发生I/O错误

AppBuilderServerException - 如果发生应用构建服务器异常

deleteChunk

public void deleteChunk(String chunkId,
                        String clientToken)
                 throws IOException,
                        AppBuilderServerException

删除指定的块。

参数:

chunkId - 块标识

clientToken - 客户端令牌

抛出:

IOException - 如果发生输入输出异常

AppBuilderServerException - 如果发生应用程序构建服务器异常

describeChunk

public ChunkDescribeResponse describeChunk(String chunkId)
                                    throws IOException,
                                           AppBuilderServerException

根据块ID描述块

参数:

chunkId - 块ID

返回:

描述块的响应对象

抛出:

IOException - 如果发生输入输出异常

AppBuilderServerException - 如果发生应用构建服务器异常

describeChunks

public ChunksDescribeResponse describeChunks(String documentId,
                                             String marker,
                                             Integer maxKeys,
                                             String type)
                                      throws IOException,
                                             AppBuilderServerException

描述文档的分块信息

参数:

documentId - 文档ID

marker - 分页标记

maxKeys - 返回的最大分块数量

type - 分块类型

返回:

返回包含文档分块信息的ChunksDescribeResponse对象

抛出:

IOException - 如果发生I/O异常

AppBuilderServerException - 如果发生AppBuilder服务器异常

queryKnowledgeBase

public QueryKnowledgeBaseResponse queryKnowledgeBase(QueryKnowledgeBaseRequest request)
                                              throws IOException,
                                                     AppBuilderServerException

抛出:

IOException

AppBuilderServerException

queryKnowledgeBase

public QueryKnowledgeBaseResponse queryKnowledgeBase(String query,
                                                     String type,
                                                     Integer top,
                                                     Integer skip,
                                                     String[] knowledgebaseIDs,
                                                     QueryKnowledgeBaseRequest.MetadataFilters filters,
                                                     QueryKnowledgeBaseRequest.QueryPipelineConfig pipelineConfig)
                                              throws IOException,
                                                     AppBuilderServerException

抛出:

IOException

AppBuilderServerException

queryKnowledgeBase

public QueryKnowledgeBaseResponse queryKnowledgeBase(String query,
                                                     String type,
                                                     Float rank_score_threshold,
                                                     Integer top,
                                                     Integer skip,
                                                     String[] knowledgebaseIDs,
                                                     QueryKnowledgeBaseRequest.MetadataFilters filters,
                                                     QueryKnowledgeBaseRequest.QueryPipelineConfig pipelineConfig)
                                              throws IOException,
                                                     AppBuilderServerException

抛出:

IOException

AppBuilderServerException