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
| Operation | Module | Description |
|---|---|---|
| Create | create | Create a new knowledge base |
| List | list | List knowledge bases |
| Retrieve | retrieve | Get knowledge-base details / search |
| Update | update | Update metadata |
| Delete | delete | Delete a knowledge base |
| Capacity | capacity | Check usage / quota |
§Document Operations
| Operation | Module | Description |
|---|---|---|
| Upload (file) | document_upload_file | Upload a local file |
| Upload (URL) | document_upload_url | Upload from a URL |
| List | document_list | List documents in a KB |
| Retrieve | document_retrieve | Get document details |
| Delete | document_delete | Delete documents |
| Re-embed | document_reembedding | Re-run vectorisation |
| Images | document_image_list | List 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 search::KnowledgeSearchBody;pub use search::KnowledgeSearchRequest;pub use search::KnowledgeSearchResponse;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
- Knowledge-base capacity / quota query.
- create
- Create a new knowledge base.
- delete
- Delete a knowledge base.
- document_
delete - Delete documents from a knowledge base.
- document_
image_ list - List images extracted from a document.
- document_
list - List documents in a knowledge base.
- document_
reembedding - Re-run vectorisation (embedding) for documents.
- document_
retrieve - Retrieve document details.
- document_
upload_ file - Upload a local file as a document.
- document_
upload_ url - Upload a document from a URL.
- list
- List knowledge bases.
- retrieve
- Retrieve knowledge-base details / semantic search.
- search
- Search knowledge-base (POST /knowledge/retrieve, P06). Knowledge search (POST /llm-application/open/knowledge/retrieve) — plan P06.
- types
- Shared knowledge-base data types.
- update
- Update knowledge-base metadata.