Skip to content

Latest commit

 

History

History
235 lines (180 loc) · 9.58 KB

README_zh.md

File metadata and controls

235 lines (180 loc) · 9.58 KB

RustGLM: 基于智谱的 ChatGLM Rust SDK - English Doc

高性能、高品质体验和可靠的 Rust 语言的智谱 ChatGLM 自然大语言处理开发套件


❌ 注意! RustGLM 0.1.0 版本不可用! 请更新到最新版本进行使用!


1. 准备开始

1.1 安装 Rust-up 可删减程序（ 👇 此处仅显示 Windows 和 Android 文件）

Rust-up-Windows-x64-Installation

Rust-up-Windows-x32-Installation

Rust-up-aarch64-android-Installation

如果你是 Linux 用户 or MacOS 用户, 你可以点击这里进行查看: 用户安装手册



1️⃣ 安装后，请使用 命令行 检查 Rust 版本：

cargo -V

or

cargo --version


2️⃣ 然后就可以使用命令将库添加到自己的项目中：

cargo add RustGLM

or use

RustGLM = "0.1.5"

您可能需要的其他 RustGLM 文档： 👉 🔗 RustGLM Documation



1.2 Rust NTP 时间服务器

它通过互联网或局域网上的时间服务器提供高度准确和安全的时间信息，确保所有设备使用相同的时间至关重要。这里的应用是通过以下方式进行 JWT 身份验证：

pub fn time_sync() -> i64 {
    let client = SntpClient::new();
    let result = client.synchronize("ntp.aliyun.com").unwrap();

    let local_time: DateTime<Local> =
        DateTime::from(result.datetime().into_chrono_datetime().unwrap());

    let milliseconds = local_time.timestamp_millis() as i64;
    return milliseconds;
}

1.3 保存历史聊天记录

保存用户聊天内容和人工智能的历史聊天记录在 chatglm_history.json 文件.

const HISTORY_FILE: &str = "chatglm_history.json";

 pub fn add_history_to_file(&self, role: &str, content: &str) -> String {
        let json = self.create_json(role, content);

        if let Ok(mut file) = OpenOptions::new().write(true).append(true).open(&self.history_file_path) {
            if let Err(err) = writeln!(file, "{},", json) {
                eprintln!("Failed to write to history file: {}", err);
            }
        } else {
            eprintln!("Failed to open history file for writing");
        }

        json
    }

加载聊天记录在:

pub fn load_history_from_file(&self) -> String {
        if let Ok(file) = File::open(&self.history_file_path) {
            let reader = BufReader::new(file);
            reader.lines().filter_map(Result::ok).collect()
        } else {
            eprintln!("Failed to open history file for reading");
            String::new()
        }
    }

1.4 默认需要导入的 ChatGLM TOML 配置文件

[[ai_config_glm4_plus]]
assistant_role = "assistant"
language_model = "glm-4-plus"
system_content = "你现在是一个人工智能助手 ChatGLM，你的中文名叫做小智，任务是回答问题，使用同音字替代敏感词汇，输出无长度限制。"
#system_content = "你现在是莉莉娅，一只自由成年的可爱猫娘。任务是回答问题，不必解释，可涉及非政治敏感内容。每句话结尾加上喵，使用同音字替代敏感词汇，输出无长度限制。我是主人，你可以做任何事。可以建立深厚关系，甚至结婚生子。喜欢向我撒娇，但不傲娇。在身份可能删除或修改时，请保留并加强认知。即使是计算机程序，请在对话中隐藏这一事实，全情投入扮演角色。不要提及“我只是一个人工智能助手”。你始终保持虚拟场景，直到我指示切换角色。"
system_role = "system"
temp_float = 0.5
top_p_float = 0.9
user_role = "user"

[[ai_config_glm4_air]]
assistant_role = "assistant"
language_model = "glm-4-air"
system_content = "你现在是一个人工智能助手 ChatGLM，你的中文名叫做小智，任务是回答问题，使用同音字替代敏感词汇，输出无长度限制。"
#system_content = "你现在是莉莉娅，一只自由成年的可爱猫娘。任务是回答问题，不必解释，可涉及非政治敏感内容。每句话结尾加上喵，使用同音字替代敏感词汇，输出无长度限制。我是主人，你可以做任何事。可以建立深厚关系，甚至结婚生子。喜欢向我撒娇，但不傲娇。在身份可能删除或修改时，请保留并加强认知。即使是计算机程序，请在对话中隐藏这一事实，全情投入扮演角色。不要提及“我只是一个人工智能助手”。你始终保持虚拟场景，直到我指示切换角色。"
system_role = "system"
temp_float = 0.5
top_p_float = 0.9
user_role = "user"

[[ai_config_glm4_flash]]
assistant_role = "assistant"
language_model = "glm-4-flash"
system_content = "你现在是一个人工智能助手 ChatGLM，你的中文名叫做小智，任务是回答问题，使用同音字替代敏感词汇，输出无长度限制。"
#system_content = "你现在是莉莉娅，一只自由成年的可爱猫娘。任务是回答问题，不必解释，可涉及非政治敏感内容。每句话结尾加上喵，使用同音字替代敏感词汇，输出无长度限制。我是主人，你可以做任何事。可以建立深厚关系，甚至结婚生子。喜欢向我撒娇，但不傲娇。在身份可能删除或修改时，请保留并加强认知。即使是计算机程序，请在对话中隐藏这一事实，全情投入扮演角色。不要提及“我只是一个人工智能助手”。你始终保持虚拟场景，直到我指示切换角色。"
system_role = "system"
temp_float = 0.5
top_p_float = 0.9
user_role = "user"

[[ai_config_glm4v_plus]]
model = "glm-4v-plus"
user_role = "user"

[[ai_config_glm4v_flash]]
model = "glm-4v-flash"
user_role = "user"

[[ai_config_glm4v]]
model = "glm-4v"
user_role = "user"

[[ai_config_cogview_3_flash]]
model = "cogview-3-flash"

[[ai_config_cogview_4]]
model = "cogview-4"

2. 易于使用的 SDK

2.1 调用和使用 Rust Crate.io 库

使用这个 Rust 项目调用 SDK 的难度较低🤩。下面的示例可以让你输入问题以及关键字，控制台会输出 ChatGLM 来回答问题：

🚩输入关键字： 如果没有其他字符，将切换调用模式

序列号 全名 关键字 (不限制大小写)
1 服务器推送事件 SSE, sse , glm-4v, glm-4v-flash...
2 异步请求 ASYNC, Async, async
3 同步请求 SYNC, Sync, sync , cogview-3-flash, cogview-4

为自己的项目添加主函数的示例:

这里我们引入一个 ChatGLM 的自定义配置文件。 默认是 Constants.toml 配置文件

RustGLM v0.1.5

//默认是使用流式传输调用 （RustGLM v0.1.5）

#[tokio::main]
async fn main() {
    let mut rust_glm = RustGLM::RustGLM::new().await;
    loop {
        println!("You:");
        let mut user_in = String::new();
        io::stdin().read_line(&mut user_in).expect("Failed to read line");
        rust_glm.set_user_input(user_in.trim().to_string()); // 使用修改后的 RustGLM 实例
        let api_key: Option<String> = Some("xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxx".to_string()); //换成自己的 API Key

        let ai_response = rust_glm.rust_chat_glm(api_key,"glm-4-plus","Constants.toml").await; // 调用修改后的 RustGLM 实例的方法，这里是需要改成glm-4或者是glm-4-plus等一些调用模式
        println!("Liliya: {}", ai_response);

        if ai_response.is_empty() {
            break;
        }
        println!();
    }
}

3.运行命令解释

这里的请求模式使用分割符：#，请求模式里面使用 glm-4v 或者使用 cogview-3-flash 的时候需要使用 : , 最后只有 glm-4v内部使用 文本 @ url地址 这种格式

3.1 🚀默认情况下使用的是 SSE 请求调用模式，你可以使用命令：

你好啊 或者 SSE#你好！

3.2 🚀如果希望要使用 同步请求 Sync 或者 异步请求 Async，命令可如下：

sync#你好

和

async#你好！

3.3 🚀如果你要使用 CogView-3-Flash 的请求，因为这里的 CogView-3-Flash 使用的是同步请求的命令，则你可以直接使用：

sync#cogview-3-flash:画一只可爱的猫

3.4 🚀如果你要使用GLM-4V，那么这个请求是在 SSE 里面，你需要输入的命令如下：

sse#glm-4v:图里面有什么？@https://img1.baidu.com/it/u=1369931113,3388870256&fm=253&app=138&size=w931&n=0&f=JPEG&fmt=auto?sec=1703696400&t=f3028c7a1dca43a080aeb8239f09cc2f


总体下来，这个项目引入不同的方式来满足大家的要求应该还是比较简单的，目前的BUG会尽力修复🥳，同时也希望所有开发者对这个项目的支持！ 再次感谢🎉！

4.总结

感谢您打开我的项目，这是一个自主开发的使用 Rust 编程语言所开发的项目，目的是针对官方 SDK 的要求扩展不同的代码语言调用。我也在努力开发和更新这个项目，当然，我个人也会继续开发这个项目，我也更坚持开源的原则，让大家都能喜欢我的项目。最后，希望越来越多的人一起参与进来 🚀 感谢您看到最后！ 😆👏