From 6913fbea50f55059563abc08ead2b4a938d38cfb Mon Sep 17 00:00:00 2001 From: Vinchan Date: Tue, 18 Feb 2025 11:20:09 +0800 Subject: [PATCH] feat(*):Add Chinese README --- README-CN.md | 205 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 README-CN.md diff --git a/README-CN.md b/README-CN.md new file mode 100644 index 0000000..26dd190 --- /dev/null +++ b/README-CN.md @@ -0,0 +1,205 @@ +

+

DeepSeek PHP Client

+

🚀 社区驱动的 PHP SDK，用于 DeepSeek AI 接口集成

+ +

+ + Latest Version + + + PHP Version + + + License + + + Tests Status + +

+

+ +## 目录 +- [✨ 特性](#-特性) +- [📦 安装](#-安装) +- [🚀 快速入门](#-快速入门) + - [基本用法](#基本用法) + - [高级配置](#高级配置) + - [获取模型列表](#获取模型列表) + - [框架集成](#-框架集成) +- [🆕 迁移指南](#-迁移指南) +- [📝 更新日志](#-更新日志) +- [🧪 测试](#-测试) +- [🔒 安全](#-安全) +- [🤝 贡献者](#-贡献者) +- [📄 许可](#-许可) + +--- + +## ✨ 特性 + +- **无缝 API 集成**: DeepSeek AI 功能的 PHP 优先接口 +- **构建器模式**: 直观的链接请求构建方法 +- **企业级别**: 符合 PSR-18 规范 +- **模型灵活性**: 支持多种 DeepSeek 模型（Coder、Chat 等） +- **流式传输**: 内置对实时响应处理的支持 +- **框架友好**: 提供 Laravel 和 Symfony 包 + +--- + +## 📦 安装 + +通过 Composer 安装: + +```bash +composer require deepseek-php/deepseek-php-client +``` + +**要求**: +- PHP 8.1+ + +--- + +## 🚀 快速入门 + +### 基本用法 + +只需两行代码即可开始: + +```php +use DeepSeek\DeepSeekClient; + +$response = DeepSeekClient::build('your-api-key') + ->query('Explain quantum computing in simple terms') + ->run(); + +echo $response; +``` + +📌 默认配置: +- Model: `deepseek-chat` +- Temperature: 0.8 + +### 高级配置 + +```php +use DeepSeek\DeepSeekClient; +use DeepSeek\Enums\Models; + +$response = DeepSeekClient::build('your-api-key') + ->withBaseUrl('https://api.deepseek.com/v2') + ->withModel(Models::CODER->value) + ->withTemperature(1.2) + ->run(); + +echo 'API Response:'.$response; +``` + +### 获取模型列表 + +```php +use DeepSeek\DeepSeekClient; + +$response = DeepSeekClient::build('your-api-key') + ->getModelsList() + ->run(); + +echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"model","owned_by":"deepseek"},{"id":"deepseek-reasoner","object":"model","owned_by":"deepseek"}]} +``` + +### 🛠 框架集成 + +### [Laravel Deepseek Package](https://github.com/deepseek-php/deepseek-laravel) + +### [Symfony Deepseek Package](https://github.com/deepseek-php/deepseek-symfony) + +--- + +## 🚧 迁移指南 + +从 v1.x 升级？请查看我们全面的 [迁移指南](MIGRATION.md) 了解重大变更和升级说明。 + +--- + +## 📝 更新日志 + +详细的发布说明可在 [CHANGELOG.md](CHANGELOG.md) 查看。 + +--- + +## 🧪 测试 + +```bash +./vendor/bin/pest +``` + +测试覆盖范围涵盖 v2.1。 + +--- + +## 🔒 安全 + +**报告漏洞**: [omaralwi2010@gmail.com](mailto:omaralwi2010@gmail.com) + +--- + +## 🤝 贡献者 + +非常感谢为这个项目做出贡献的人！ 🎉💖 + + + + + + + + + +
+ + Omar AlAlwi +
+ Omar AlAlwi + +
+ 🏆 Creator + 		+ + Ayman Alhattami +
+ Ayman Alhattami + +
+ ⭐ Contributor + 		+ + Mohammad Asaad +
+ Mohammad Asaad + +
+ ⭐ Contributor + 		+ + Opada Alzaiede +
+ Opada Alzaiede + +
+ ⭐ Contributor + 		+ + Hisham Bin Ateya +
+ Hisham Bin Ateya + +
+ ⭐ Contributor +
+ +**想要贡献？** 查看 [contributing guidelines](./CONTRIBUTING.md) 并提交拉取请求！ 🚀 + +--- + +## 📄 许可 + +基于 [MIT License](LICENSE.md) 开源协议。