ai.z.openapi.api.knowledge

Interface KnowledgeApi

public interface KnowledgeApi

Knowledge Base Management API for document storage and retrieval Provides comprehensive knowledge base operations including creation, modification, and querying Enables AI models to access and utilize structured knowledge for enhanced responses

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<KnowledgeId>	knowledgeCreate(KnowledgeBaseParams knowledgeBaseParams) Create a new knowledge base Establishes a new knowledge repository for storing and organizing documents
io.reactivex.Single<retrofit2.Response<Void>>	knowledgeDelete(String knowledge_id) Delete a knowledge base Permanently removes the knowledge base and all associated documents
io.reactivex.Single<retrofit2.Response<Void>>	knowledgeModify(String knowledge_id, KnowledgeBaseParams knowledgeBaseParams) Modify an existing knowledge base Updates knowledge base configuration and settings
io.reactivex.Single<KnowledgePage>	knowledgeQuery(Integer page, Integer size) Query and list knowledge bases with pagination Retrieves a paginated list of available knowledge bases
io.reactivex.Single<KnowledgeUsed>	knowledgeUsed() Get knowledge base usage statistics Retrieves information about storage capacity and usage metrics

Method Detail

knowledgeCreate

@POST(value="knowledge")
io.reactivex.Single<KnowledgeId> knowledgeCreate(@Body
                                                                          KnowledgeBaseParams knowledgeBaseParams)

Create a new knowledge base Establishes a new knowledge repository for storing and organizing documents

Parameters:

knowledgeBaseParams - Configuration parameters including name, description, and settings

Returns:

Knowledge base information with ID, status, and metadata

knowledgeModify

@PUT(value="knowledge/{knowledge_id}")
io.reactivex.Single<retrofit2.Response<Void>> knowledgeModify(@Path(value="knowledge_id")
                                                                                                     String knowledge_id,
                                                                                                     @Body
                                                                                                     KnowledgeBaseParams knowledgeBaseParams)

Modify an existing knowledge base Updates knowledge base configuration and settings

Parameters:

knowledge_id - Unique identifier of the knowledge base to modify

knowledgeBaseParams - Updated configuration parameters

Returns:

HTTP response indicating modification success or failure

knowledgeQuery

@GET(value="knowledge")
io.reactivex.Single<KnowledgePage> knowledgeQuery(@Query(value="page")
                                                                          Integer page,
                                                                          @Query(value="size")
                                                                          Integer size)

Query and list knowledge bases with pagination Retrieves a paginated list of available knowledge bases

Parameters:

page - Page number for pagination (starting from 1)

size - Number of knowledge bases to return per page

Returns:

Paginated list of knowledge bases with metadata

knowledgeDelete

@DELETE(value="knowledge/{knowledge_id}")
io.reactivex.Single<retrofit2.Response<Void>> knowledgeDelete(@Path(value="knowledge_id")
                                                                                                        String knowledge_id)

Delete a knowledge base Permanently removes the knowledge base and all associated documents

Parameters:

knowledge_id - Unique identifier of the knowledge base to delete

Returns:

HTTP response indicating deletion success or failure

knowledgeUsed

@GET(value="knowledge/capacity")
io.reactivex.Single<KnowledgeUsed> knowledgeUsed()

Get knowledge base usage statistics Retrieves information about storage capacity and usage metrics

Returns:

Knowledge base usage details including capacity and consumption