Skip to main content

Module knowledge

Module knowledge 

Source
Expand description

§Knowledge Base Module

Provides knowledge-base management for the Zhipu AI API: create, update, delete knowledge bases; upload, list, and retrieve documents; perform semantic search.

§Knowledge-Base Operations

OperationModuleDescription
CreatecreateCreate a new knowledge base
ListlistList knowledge bases
RetrieveretrieveGet knowledge-base details / search
UpdateupdateUpdate metadata
DeletedeleteDelete a knowledge base
CapacitycapacityCheck usage / quota

§Document Operations

OperationModuleDescription
Upload (file)document_upload_fileUpload a local file
Upload (URL)document_upload_urlUpload from a URL
Listdocument_listList documents in a KB
Retrievedocument_retrieveGet document details
Deletedocument_deleteDelete documents
Re-embeddocument_reembeddingRe-run vectorisation
Imagesdocument_image_listList extracted images

§Supported Document Types

PDF, plain text, Markdown, Word, HTML, and more.

§Usage

use zai_rs::knowledge::*;

// Create a knowledge base
let kb = client.create_knowledge(&CreateKnowledgeRequest::new(body)).await?;

// Upload a document
let doc = client.upload_document(&DocumentUploadFileRequest::new(kb_id, file, opts)).await?;

// Semantic search
let results = client.retrieve_knowledge(&KnowledgeRetrieveRequest::new(kb_id, query)).await?;

Re-exports§

pub use capacity::KnowledgeCapacityRequest;
pub use create::BackgroundColor;
pub use create::CreateKnowledgeBody;
pub use create::CreateKnowledgeRequest;
pub use create::CreateKnowledgeResponse;
pub use create::EmbeddingId;
pub use create::KnowledgeIcon;
pub use delete::KnowledgeDeleteRequest;
pub use delete::KnowledgeDeleteResponse;
pub use document_delete::DocumentDeleteRequest;
pub use document_delete::DocumentDeleteResponse;
pub use document_image_list::DocumentImageListRequest;
pub use document_list::DocumentListQuery;
pub use document_list::DocumentListRequest;
pub use document_reembedding::DocumentReembeddingBody;
pub use document_reembedding::DocumentReembeddingRequest;
pub use document_reembedding::DocumentReembeddingResponse;
pub use document_retrieve::DocumentRetrieveRequest;
pub use document_upload_file::DocumentSliceType;
pub use document_upload_file::DocumentUploadFileRequest;
pub use document_upload_file::UploadFileOptions;
pub use document_upload_url::DocumentUploadUrlRequest;
pub use document_upload_url::UploadUrlBody;
pub use document_upload_url::UploadUrlDetail;
pub use list::KnowledgeListQuery;
pub use list::KnowledgeListRequest;
pub use retrieve::KnowledgeRetrieveRequest;
pub use retrieve::KnowledgeRetrieveResponse;
pub use types::DocumentDetailResponse;
pub use types::DocumentFailInfo;
pub use types::DocumentImageItem;
pub use types::DocumentImageListData;
pub use types::DocumentImageListResponse;
pub use types::DocumentItem;
pub use types::DocumentListData;
pub use types::DocumentListResponse;
pub use types::KnowledgeCapacityData;
pub use types::KnowledgeCapacityResponse;
pub use types::KnowledgeDetailResponse;
pub use types::KnowledgeItem;
pub use types::KnowledgeListData;
pub use types::KnowledgeListResponse;
pub use types::KnowledgeUsageCounts;
pub use types::UploadFileData;
pub use types::UploadFileFailedInfo;
pub use types::UploadFileResponse;
pub use types::UploadFileSuccessInfo;
pub use types::UploadUrlData;
pub use types::UploadUrlFailedInfo;
pub use types::UploadUrlResponse;
pub use types::UploadUrlSuccessInfo;
pub use update::KnowledgeUpdateRequest;
pub use update::KnowledgeUpdateResponse;
pub use update::UpdateKnowledgeBody;

Modules§

capacity
create
delete
document_delete
document_image_list
document_list
document_reembedding
document_retrieve
document_upload_file
document_upload_url
list
retrieve
types
update