zai-rs 0.6.0

Type-safe async Rust SDK for Zhipu AI (BigModel) APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! # 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 | [`KnowledgeCreateRequest`] | Create a new knowledge base |
//! | List | [`KnowledgeListRequest`] | List knowledge bases |
//! | Retrieve | [`KnowledgeGetRequest`] | Get knowledge-base details |
//! | Search | [`KnowledgeSearchRequest`] | Run semantic retrieval against a knowledge base |
//! | Update | [`KnowledgeUpdateRequest`] | Update metadata |
//! | Delete | [`KnowledgeDeleteRequest`] | Delete a knowledge base |
//! | Capacity | [`KnowledgeCapacityRequest`] | Check usage / quota |
//!
//! # Document Operations
//!
//! | Operation | Module | Description |
//! |-----------|--------|-------------|
//! | Upload (file) | [`DocumentUploadRequest`] | Upload a local file |
//! | Upload (URL) | [`DocumentUrlUploadRequest`] | Upload from a URL |
//! | List | [`DocumentListRequest`] | List documents in a KB |
//! | Retrieve | [`DocumentGetRequest`] | Get document details |
//! | Delete | [`DocumentDeleteRequest`] | Delete documents |
//! | Re-embed | [`DocumentReembedRequest`] | Re-run vectorisation |
//! | Images | [`DocumentImageListRequest`] | List extracted images |
//!
//! # Supported Document Types
//!
//! PDF, plain text, Markdown, Word, HTML, and more.
//!
//! # Usage
//!
//! ```rust,no_run
//! use zai_rs::{ZaiResult, client::ZaiClient, knowledge::*};
//!
//! # async fn example(client: &ZaiClient) -> ZaiResult<()> {
//! let created = KnowledgeCreateRequest::new(EmbeddingId::Embedding3New, "Product docs")
//!     .send_via(client)
//!     .await?;
//! let uploaded = DocumentUploadRequest::new("knowledge-base-id")
//!     .add_file_path("guide.pdf")
//!     .send_via(client)
//!     .await?;
//! let matches = KnowledgeSearchRequest::new("knowledge-base-id", "How do I authenticate?")
//!     .with_top_k(5)
//!     .send_via(client)
//!     .await?;
//! # let _ = (created, uploaded, matches);
//! # Ok(())
//! # }
//! ```

/// Knowledge-base capacity / quota query.
mod capacity;
/// Create a new knowledge base.
mod create;
/// Delete a knowledge base.
mod delete;
/// Delete documents from a knowledge base.
mod document_delete;
/// List images extracted from a document.
mod document_image_list;
/// List documents in a knowledge base.
mod document_list;
/// Re-run vectorisation (embedding) for documents.
mod document_reembedding;
/// Retrieve document details.
mod document_retrieve;
/// Upload a local file as a document.
mod document_upload_file;
/// Upload a document from a URL.
mod document_upload_url;
/// List knowledge bases.
mod list;
/// Retrieve knowledge-base details / semantic search.
mod retrieve;
/// Search a knowledge base (`POST …/knowledge/retrieve`).
mod search;
/// Shared knowledge-base data types.
mod types;
/// Update knowledge-base metadata.
mod update;

pub use capacity::KnowledgeCapacityRequest;
pub use create::{
    BackgroundColor, EmbeddingId, KnowledgeCreateBody, KnowledgeCreateData, KnowledgeCreateRequest,
    KnowledgeCreateResponse, KnowledgeIcon,
};
pub use delete::{KnowledgeDeleteRequest, KnowledgeDeleteResponse};
pub use document_delete::{DocumentDeleteRequest, DocumentDeleteResponse};
pub use document_image_list::DocumentImageListRequest;
pub use document_list::{DocumentListQuery, DocumentListRequest};
pub use document_reembedding::{
    DocumentReembedBody, DocumentReembedRequest, DocumentReembedResponse,
};
pub use document_retrieve::DocumentGetRequest;
pub use document_upload_file::{DocumentSliceType, DocumentUploadOptions, DocumentUploadRequest};
pub use document_upload_url::{
    DocumentUrlUploadBody, DocumentUrlUploadDetail, DocumentUrlUploadRequest,
};
pub use list::{KnowledgeListQuery, KnowledgeListRequest};
pub use retrieve::KnowledgeGetRequest;
pub use search::{
    KnowledgeRecallMethod, KnowledgeRerankModel, KnowledgeSearchBody, KnowledgeSearchMetadata,
    KnowledgeSearchRequest, KnowledgeSearchResponse, KnowledgeSearchResult,
};
pub use types::{
    DocumentFailInfo, DocumentGetResponse, DocumentImageItem, DocumentImageListData,
    DocumentImageListResponse, DocumentItem, DocumentListData, DocumentListResponse,
    DocumentUploadData, DocumentUploadFailedInfo, DocumentUploadResponse,
    DocumentUploadSuccessInfo, DocumentUrlUploadData, DocumentUrlUploadFailedInfo,
    DocumentUrlUploadResponse, DocumentUrlUploadSuccessInfo, KnowledgeCapacityData,
    KnowledgeCapacityResponse, KnowledgeGetResponse, KnowledgeItem, KnowledgeListData,
    KnowledgeListResponse, KnowledgeOperationResponse, KnowledgeResponse, KnowledgeUsageCounts,
};
pub use update::{KnowledgeUpdateBody, KnowledgeUpdateRequest, KnowledgeUpdateResponse};