com.aliyun.bailian20231229

类 Client

java.lang.Object

com.aliyun.teaopenapi.Client

com.aliyun.bailian20231229.Client

public class Client
extends com.aliyun.teaopenapi.Client

字段概要

从类继承的字段 com.aliyun.teaopenapi.Client

_ca, _cert, _connectTimeout, _credential, _disableHttp2, _endpoint, _endpointMap, _endpointRule, _endpointType, _globalParameters, _headers, _httpProxy, _httpsProxy, _key, _maxIdleConns, _method, _network, _noProxy, _openPlatformEndpoint, _productId, _protocol, _readTimeout, _regionId, _signatureAlgorithm, _signatureVersion, _socks5NetWork, _socks5Proxy, _spi, _suffix, _userAgent

构造器概要

构造器

构造器和说明
Client(com.aliyun.teaopenapi.models.Config config)

方法概要

限定符和类型	方法和说明
AddCategoryResponse	addCategory(String WorkspaceId, AddCategoryRequest request)
AddCategoryResponse	addCategoryWithOptions(String WorkspaceId, AddCategoryRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime)
AddFileResponse	addFile(String WorkspaceId, AddFileRequest request) summary : 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
AddFileResponse	addFileWithOptions(String WorkspaceId, AddFileRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。
ApplyFileUploadLeaseResponse	applyFileUploadLease(String CategoryId, String WorkspaceId, ApplyFileUploadLeaseRequest request) summary : 请求文档上传租约，进行文档上传。
ApplyFileUploadLeaseResponse	applyFileUploadLeaseWithOptions(String CategoryId, String WorkspaceId, ApplyFileUploadLeaseRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 请求文档上传租约，进行文档上传。
CreateIndexResponse	createIndex(String WorkspaceId, CreateIndexRequest request) summary : 创建并运行pipeline
CreateIndexResponse	createIndexWithOptions(String WorkspaceId, CreateIndexRequest tmpReq, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 创建并运行pipeline
DeleteCategoryResponse	deleteCategory(String CategoryId, String WorkspaceId)
DeleteCategoryResponse	deleteCategoryWithOptions(String CategoryId, String WorkspaceId, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime)
DeleteFileResponse	deleteFile(String FileId, String WorkspaceId) summary : 删除文档
DeleteFileResponse	deleteFileWithOptions(String FileId, String WorkspaceId, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 删除文档
DeleteIndexResponse	deleteIndex(String WorkspaceId, DeleteIndexRequest request) summary : 删除Index
DeleteIndexDocumentResponse	deleteIndexDocument(String WorkspaceId, DeleteIndexDocumentRequest request) summary : 删除index doc
DeleteIndexDocumentResponse	deleteIndexDocumentWithOptions(String WorkspaceId, DeleteIndexDocumentRequest tmpReq, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 删除index doc
DeleteIndexResponse	deleteIndexWithOptions(String WorkspaceId, DeleteIndexRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 删除Index
DescribeFileResponse	describeFile(String WorkspaceId, String FileId) summary : 获取文档基本信息，包括文档名称、类型、状态等。
DescribeFileResponse	describeFileWithOptions(String WorkspaceId, String FileId, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 获取文档基本信息，包括文档名称、类型、状态等。
String	getEndpoint(String productId, String regionId, String endpointRule, String network, String suffix, Map<String,String> endpointMap, String endpoint)
GetIndexJobStatusResponse	getIndexJobStatus(String WorkspaceId, GetIndexJobStatusRequest request) summary : 获取Index运行状态
GetIndexJobStatusResponse	getIndexJobStatusWithOptions(String WorkspaceId, GetIndexJobStatusRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 获取Index运行状态
ListCategoryResponse	listCategory(String WorkspaceId, ListCategoryRequest request) summary : ListCategory
ListCategoryResponse	listCategoryWithOptions(String WorkspaceId, ListCategoryRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : ListCategory
ListChunksResponse	listChunks(String WorkspaceId, ListChunksRequest request) summary : Chunk
ListChunksResponse	listChunksWithOptions(String WorkspaceId, ListChunksRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : Chunk
ListIndexDocumentsResponse	listIndexDocuments(String WorkspaceId, ListIndexDocumentsRequest request) summary : 查询Index文件
ListIndexDocumentsResponse	listIndexDocumentsWithOptions(String WorkspaceId, ListIndexDocumentsRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 查询Index文件
ListIndicesResponse	listIndices(String WorkspaceId, ListIndicesRequest request) summary : 查询pipeline
ListIndicesResponse	listIndicesWithOptions(String WorkspaceId, ListIndicesRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 查询pipeline
RetrieveResponse	retrieve(String WorkspaceId, RetrieveRequest request) summary : 召回测试
RetrieveResponse	retrieveWithOptions(String WorkspaceId, RetrieveRequest tmpReq, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 召回测试
SubmitIndexAddDocumentsJobResponse	submitIndexAddDocumentsJob(String WorkspaceId, SubmitIndexAddDocumentsJobRequest request) summary : 知识索引
SubmitIndexAddDocumentsJobResponse	submitIndexAddDocumentsJobWithOptions(String WorkspaceId, SubmitIndexAddDocumentsJobRequest tmpReq, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 知识索引
SubmitIndexJobResponse	submitIndexJob(String WorkspaceId, SubmitIndexJobRequest request) summary : 提交索引任务
SubmitIndexJobResponse	submitIndexJobWithOptions(String WorkspaceId, SubmitIndexJobRequest request, Map<String,String> headers, com.aliyun.teautil.models.RuntimeOptions runtime) summary : 提交索引任务

从类继承的方法 com.aliyun.teaopenapi.Client

addRequestInterceptor, addResponseInterceptor, addRuntimeOptionsInterceptor, callApi, checkConfig, defaultAny, doRequest, doROARequest, doROARequestWithForm, doRPCRequest, execute, getAccessKeyId, getAccessKeySecret, getBearerToken, getRpcHeaders, getSecurityToken, getType, getUserAgent, setGatewayClient, setRpcHeaders

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

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

构造器详细资料

Client

public Client(com.aliyun.teaopenapi.models.Config config)
       throws Exception

抛出:

Exception

方法详细资料

getEndpoint

public String getEndpoint(String productId,
                          String regionId,
                          String endpointRule,
                          String network,
                          String suffix,
                          Map<String,String> endpointMap,
                          String endpoint)
                   throws Exception

抛出:

Exception

addCategoryWithOptions

public AddCategoryResponse addCategoryWithOptions(String WorkspaceId,
                                                  AddCategoryRequest request,
                                                  Map<String,String> headers,
                                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                                           throws Exception

参数:

request - AddCategoryRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

AddCategoryResponse

抛出:

Exception

addCategory

public AddCategoryResponse addCategory(String WorkspaceId,
                                       AddCategoryRequest request)
                                throws Exception

参数:

request - AddCategoryRequest

返回:

AddCategoryResponse

抛出:

Exception

addFileWithOptions

public AddFileResponse addFileWithOptions(String WorkspaceId,
                                          AddFileRequest request,
                                          Map<String,String> headers,
                                          com.aliyun.teautil.models.RuntimeOptions runtime)
                                   throws Exception

summary :

将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。

参数:

request - AddFileRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

AddFileResponse

抛出:

Exception

addFile

public AddFileResponse addFile(String WorkspaceId,
                               AddFileRequest request)
                        throws Exception

summary :

将临时上传的文档导入百炼数据中心，导入成功之后会自动触发文档解析。

参数:

request - AddFileRequest

返回:

AddFileResponse

抛出:

Exception

applyFileUploadLeaseWithOptions

public ApplyFileUploadLeaseResponse applyFileUploadLeaseWithOptions(String CategoryId,
                                                                    String WorkspaceId,
                                                                    ApplyFileUploadLeaseRequest request,
                                                                    Map<String,String> headers,
                                                                    com.aliyun.teautil.models.RuntimeOptions runtime)
                                                             throws Exception

summary :

请求文档上传租约，进行文档上传。

参数:

request - ApplyFileUploadLeaseRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

ApplyFileUploadLeaseResponse

抛出:

Exception

applyFileUploadLease

public ApplyFileUploadLeaseResponse applyFileUploadLease(String CategoryId,
                                                         String WorkspaceId,
                                                         ApplyFileUploadLeaseRequest request)
                                                  throws Exception

summary :

请求文档上传租约，进行文档上传。

参数:

request - ApplyFileUploadLeaseRequest

返回:

ApplyFileUploadLeaseResponse

抛出:

Exception

createIndexWithOptions

public CreateIndexResponse createIndexWithOptions(String WorkspaceId,
                                                  CreateIndexRequest tmpReq,
                                                  Map<String,String> headers,
                                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                                           throws Exception

summary :

创建并运行pipeline

参数:

tmpReq - CreateIndexRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

CreateIndexResponse

抛出:

Exception

createIndex

public CreateIndexResponse createIndex(String WorkspaceId,
                                       CreateIndexRequest request)
                                throws Exception

summary :

创建并运行pipeline

参数:

request - CreateIndexRequest

返回:

CreateIndexResponse

抛出:

Exception

deleteCategoryWithOptions

public DeleteCategoryResponse deleteCategoryWithOptions(String CategoryId,
                                                        String WorkspaceId,
                                                        Map<String,String> headers,
                                                        com.aliyun.teautil.models.RuntimeOptions runtime)
                                                 throws Exception

参数:

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

DeleteCategoryResponse

抛出:

Exception

deleteCategory

public DeleteCategoryResponse deleteCategory(String CategoryId,
                                             String WorkspaceId)
                                      throws Exception

返回:

DeleteCategoryResponse

抛出:

Exception

deleteFileWithOptions

public DeleteFileResponse deleteFileWithOptions(String FileId,
                                                String WorkspaceId,
                                                Map<String,String> headers,
                                                com.aliyun.teautil.models.RuntimeOptions runtime)
                                         throws Exception

summary :

删除文档

参数:

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

DeleteFileResponse

抛出:

Exception

deleteFile

public DeleteFileResponse deleteFile(String FileId,
                                     String WorkspaceId)
                              throws Exception

summary :

删除文档

返回:

DeleteFileResponse

抛出:

Exception

deleteIndexWithOptions

public DeleteIndexResponse deleteIndexWithOptions(String WorkspaceId,
                                                  DeleteIndexRequest request,
                                                  Map<String,String> headers,
                                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                                           throws Exception

summary :

删除Index

参数:

request - DeleteIndexRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

DeleteIndexResponse

抛出:

Exception

deleteIndex

public DeleteIndexResponse deleteIndex(String WorkspaceId,
                                       DeleteIndexRequest request)
                                throws Exception

summary :

删除Index

参数:

request - DeleteIndexRequest

返回:

DeleteIndexResponse

抛出:

Exception

deleteIndexDocumentWithOptions

public DeleteIndexDocumentResponse deleteIndexDocumentWithOptions(String WorkspaceId,
                                                                  DeleteIndexDocumentRequest tmpReq,
                                                                  Map<String,String> headers,
                                                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                                                           throws Exception

summary :

删除index doc

参数:

tmpReq - DeleteIndexDocumentRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

DeleteIndexDocumentResponse

抛出:

Exception

deleteIndexDocument

public DeleteIndexDocumentResponse deleteIndexDocument(String WorkspaceId,
                                                       DeleteIndexDocumentRequest request)
                                                throws Exception

summary :

删除index doc

参数:

request - DeleteIndexDocumentRequest

返回:

DeleteIndexDocumentResponse

抛出:

Exception

describeFileWithOptions

public DescribeFileResponse describeFileWithOptions(String WorkspaceId,
                                                    String FileId,
                                                    Map<String,String> headers,
                                                    com.aliyun.teautil.models.RuntimeOptions runtime)
                                             throws Exception

summary :

获取文档基本信息，包括文档名称、类型、状态等。

参数:

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

DescribeFileResponse

抛出:

Exception

describeFile

public DescribeFileResponse describeFile(String WorkspaceId,
                                         String FileId)
                                  throws Exception

summary :

获取文档基本信息，包括文档名称、类型、状态等。

返回:

DescribeFileResponse

抛出:

Exception

getIndexJobStatusWithOptions

public GetIndexJobStatusResponse getIndexJobStatusWithOptions(String WorkspaceId,
                                                              GetIndexJobStatusRequest request,
                                                              Map<String,String> headers,
                                                              com.aliyun.teautil.models.RuntimeOptions runtime)
                                                       throws Exception

summary :

获取Index运行状态

参数:

request - GetIndexJobStatusRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

GetIndexJobStatusResponse

抛出:

Exception

getIndexJobStatus

public GetIndexJobStatusResponse getIndexJobStatus(String WorkspaceId,
                                                   GetIndexJobStatusRequest request)
                                            throws Exception

summary :

获取Index运行状态

参数:

request - GetIndexJobStatusRequest

返回:

GetIndexJobStatusResponse

抛出:

Exception

listCategoryWithOptions

public ListCategoryResponse listCategoryWithOptions(String WorkspaceId,
                                                    ListCategoryRequest request,
                                                    Map<String,String> headers,
                                                    com.aliyun.teautil.models.RuntimeOptions runtime)
                                             throws Exception

summary :

ListCategory

参数:

request - ListCategoryRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

ListCategoryResponse

抛出:

Exception

listCategory

public ListCategoryResponse listCategory(String WorkspaceId,
                                         ListCategoryRequest request)
                                  throws Exception

summary :

ListCategory

参数:

request - ListCategoryRequest

返回:

ListCategoryResponse

抛出:

Exception

listChunksWithOptions

public ListChunksResponse listChunksWithOptions(String WorkspaceId,
                                                ListChunksRequest request,
                                                Map<String,String> headers,
                                                com.aliyun.teautil.models.RuntimeOptions runtime)
                                         throws Exception

summary :

Chunk

参数:

request - ListChunksRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

ListChunksResponse

抛出:

Exception

listChunks

public ListChunksResponse listChunks(String WorkspaceId,
                                     ListChunksRequest request)
                              throws Exception

summary :

Chunk

参数:

request - ListChunksRequest

返回:

ListChunksResponse

抛出:

Exception

listIndexDocumentsWithOptions

public ListIndexDocumentsResponse listIndexDocumentsWithOptions(String WorkspaceId,
                                                                ListIndexDocumentsRequest request,
                                                                Map<String,String> headers,
                                                                com.aliyun.teautil.models.RuntimeOptions runtime)
                                                         throws Exception

summary :

查询Index文件

参数:

request - ListIndexDocumentsRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

ListIndexDocumentsResponse

抛出:

Exception

listIndexDocuments

public ListIndexDocumentsResponse listIndexDocuments(String WorkspaceId,
                                                     ListIndexDocumentsRequest request)
                                              throws Exception

summary :

查询Index文件

参数:

request - ListIndexDocumentsRequest

返回:

ListIndexDocumentsResponse

抛出:

Exception

listIndicesWithOptions

public ListIndicesResponse listIndicesWithOptions(String WorkspaceId,
                                                  ListIndicesRequest request,
                                                  Map<String,String> headers,
                                                  com.aliyun.teautil.models.RuntimeOptions runtime)
                                           throws Exception

summary :

查询pipeline

参数:

request - ListIndicesRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

ListIndicesResponse

抛出:

Exception

listIndices

public ListIndicesResponse listIndices(String WorkspaceId,
                                       ListIndicesRequest request)
                                throws Exception

summary :

查询pipeline

参数:

request - ListIndicesRequest

返回:

ListIndicesResponse

抛出:

Exception

retrieveWithOptions

public RetrieveResponse retrieveWithOptions(String WorkspaceId,
                                            RetrieveRequest tmpReq,
                                            Map<String,String> headers,
                                            com.aliyun.teautil.models.RuntimeOptions runtime)
                                     throws Exception

summary :

召回测试

参数:

tmpReq - RetrieveRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

RetrieveResponse

抛出:

Exception

retrieve

public RetrieveResponse retrieve(String WorkspaceId,
                                 RetrieveRequest request)
                          throws Exception

summary :

召回测试

参数:

request - RetrieveRequest

返回:

RetrieveResponse

抛出:

Exception

submitIndexAddDocumentsJobWithOptions

public SubmitIndexAddDocumentsJobResponse submitIndexAddDocumentsJobWithOptions(String WorkspaceId,
                                                                                SubmitIndexAddDocumentsJobRequest tmpReq,
                                                                                Map<String,String> headers,
                                                                                com.aliyun.teautil.models.RuntimeOptions runtime)
                                                                         throws Exception

summary :

知识索引

参数:

tmpReq - SubmitIndexAddDocumentsJobRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

SubmitIndexAddDocumentsJobResponse

抛出:

Exception

submitIndexAddDocumentsJob

public SubmitIndexAddDocumentsJobResponse submitIndexAddDocumentsJob(String WorkspaceId,
                                                                     SubmitIndexAddDocumentsJobRequest request)
                                                              throws Exception

summary :

知识索引

参数:

request - SubmitIndexAddDocumentsJobRequest

返回:

SubmitIndexAddDocumentsJobResponse

抛出:

Exception

submitIndexJobWithOptions

public SubmitIndexJobResponse submitIndexJobWithOptions(String WorkspaceId,
                                                        SubmitIndexJobRequest request,
                                                        Map<String,String> headers,
                                                        com.aliyun.teautil.models.RuntimeOptions runtime)
                                                 throws Exception

summary :

提交索引任务

参数:

request - SubmitIndexJobRequest

headers - map

runtime - runtime options for this request RuntimeOptions

返回:

SubmitIndexJobResponse

抛出:

Exception

submitIndexJob

public SubmitIndexJobResponse submitIndexJob(String WorkspaceId,
                                             SubmitIndexJobRequest request)
                                      throws Exception

summary :

提交索引任务

参数:

request - SubmitIndexJobRequest

返回:

SubmitIndexJobResponse

抛出:

Exception