# zai-rs 文档
这里是 zai-rs（Zhipu AI Rust SDK）的使用与维护文档。
## 入门指南
- **[快速入门指南](GETTING_STARTED.md)** - 新用户的完整入门教程
- 安装和配置
- 基础用法示例
- 错误处理入门
- 高级配置
## 使用指南
- **[架构说明](ARCHITECTURE.md)** - 项目分层、端点配置、错误/重试策略和测试边界
- API 家族和默认 endpoint
- 请求 builder / 传输层分工
- 错误码映射和 retry 策略
- 测试与文档维护规则
- **[错误处理指南](ERROR_HANDLING.md)** - 详细的错误处理机制和最佳实践
- 错误类型说明
- 基础和高级错误处理
- 重试机制详解
- 日志安全实践
- **[最佳实践](BEST_PRACTICES.md)** - 使用 zai-rs 的推荐做法
- API 密钥管理
- 错误处理
- 请求优化
- 日志和监控
- 并发和性能
- 安全性建议
- **[高级主题](ADVANCED_TOPICS.md)** - 进阶功能和高级用法
- 重试机制详解
- 流式处理
- 工具调用
- 异步聊天
- 文件和知识库管理
- 批量处理
- 性能优化技巧
- **[常见问题 (FAQ)](FAQ.md)** - 常见问题和解决方案
- 安装和配置问题
- 使用问题
- 错误处理
- 性能优化
- 故障排除
## API 参考
- **Rustdoc** - 在仓库根目录运行 `cargo doc --all-features --open`
## 示例代码
- **[示例目录](../examples/)** - 实际使用示例
- 聊天补全
- typed SSE 流式响应
- 图像和视频生成
- 语音处理
- 工具调用
- 文件管理
书中的 Rust 代码块依赖本 crate 及 Tokio 等 Cargo 依赖。`mdbook test` 无法为
独立章节注入这些依赖，因此标记为 `rust,ignore`；同一 API 的可执行版本位于
`examples/`，并由工作区的 examples 构建检查验证。crate 内的 rustdoc 示例则
使用可编译的 `rust` 或 `rust,no_run`。
## 外部资源
- [智谱AI API 文档](https://docs.bigmodel.cn/) - 官方 API 文档
- [智谱AI开放平台](https://open.bigmodel.cn/) - API 密钥申请和管理
- [GitHub Issues](https://github.com/AnlangA/zai-rs/issues) - 问题反馈和讨论
## 版本说明
本文档与仓库中的 `0.6.0` API 同步。版本升级前请阅读
[0.6 迁移指南](MIGRATING-0.6.md)。