synaptic-lark 0.4.0

Feishu/Lark integration for Synaptic: document loader, Bitable tool, message tool
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

//! Feishu/Lark integration for the Synaptic framework.
//!
//! This crate provides first-class integration with the Feishu (Lark) Open Platform:
//!
//! - [`LarkDocLoader`] — load documents and Wiki pages into Synaptic [`Document`]s
//! - [`LarkMessageTool`] — send messages to chats and users as an Agent tool
//! - [`LarkBitableTool`] — search, create, and update rows in Bitable (multi-dim tables)
//!
//! # Quick start
//!
//! ```toml
//! [dependencies]
//! synaptic = { version = "0.2", features = ["lark"] }
//! ```
//!
//! ```rust,no_run
//! use synaptic_lark::{LarkConfig, LarkDocLoader};
//! use synaptic_core::Loader;
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let config = LarkConfig::new("cli_xxx", "app_secret_xxx");
//! let loader = LarkDocLoader::new(config)
//!     .with_doc_tokens(vec!["doxcnAbcXxx".to_string()]);
//! let docs = loader.load().await?;
//! # Ok(())
//! # }
//! ```

mod api;
mod auth;
#[cfg(feature = "bot")]
pub mod bot;
pub mod events;
pub mod loaders;
pub mod store;
pub mod tools;
pub mod vector_store;

pub use events::listener::LarkEventListener;
pub use loaders::bitable::LarkBitableLoader;
pub use loaders::doc::LarkDocLoader;
pub use loaders::drive::LarkDriveLoader;
pub use loaders::spreadsheet::LarkSpreadsheetLoader;
pub use loaders::wiki::LarkWikiLoader;
pub use store::cache::LarkBitableLlmCache;
pub use store::checkpointer::LarkBitableCheckpointer;
pub use store::memory::LarkBitableMemoryStore;
pub use tools::asr::LarkAsrTool;
pub use tools::bitable::LarkBitableTool;
pub use tools::calendar::LarkCalendarTool;
pub use tools::chat::LarkChatTool;
pub use tools::contact::LarkContactTool;
pub use tools::doc_process::LarkDocProcessTool;
pub use tools::message::LarkMessageTool;
pub use tools::ocr::LarkOcrTool;
pub use tools::spreadsheet::LarkSpreadsheetTool;
pub use tools::task::LarkTaskTool;
pub use tools::translate::LarkTranslateTool;
pub use vector_store::LarkVectorStore;

#[cfg(feature = "bot")]
pub use bot::{
    LarkBotClient, LarkLongConnListener, LarkMessageEvent, StreamingCardOptions,
    StreamingCardWriter,
};

// Re-export core traits for convenience
pub use synaptic_core::{Loader, Tool};

use std::sync::Arc;

/// Configuration for the Lark Open Platform.
///
/// Obtain `app_id` and `app_secret` from the [Lark Developer Console](https://open.feishu.cn/app).
#[derive(Debug, Clone)]
pub struct LarkConfig {
    /// Application ID (`cli_xxx`).
    pub app_id: String,
    /// Application secret.
    pub app_secret: String,
    /// Base URL — defaults to `"https://open.feishu.cn/open-apis"` (Feishu public cloud).
    /// Override with [`LarkConfig::with_base_url`] for private deployments.
    pub base_url: String,
}

impl LarkConfig {
    /// Create a new config targeting the Feishu public cloud.
    pub fn new(app_id: impl Into<String>, app_secret: impl Into<String>) -> Self {
        Self {
            app_id: app_id.into(),
            app_secret: app_secret.into(),
            base_url: "https://open.feishu.cn/open-apis".to_string(),
        }
    }

    /// Override the base URL (e.g. for private deployments or testing).
    pub fn with_base_url(mut self, url: impl Into<String>) -> Self {
        self.base_url = url.into();
        self
    }

    /// Create a [`TokenCache`] backed by this config.
    pub(crate) fn token_cache(self) -> auth::TokenCache {
        auth::TokenCache::new(Arc::new(self))
    }
}