From 26653268b462d827705aa9c71cd31d1e7b6b2278 Mon Sep 17 00:00:00 2001 From: omaralalwi Date: Sat, 22 Feb 2025 06:32:09 +0300 Subject: [PATCH] Add Arabic documentation --- README-AR.md | 252 +++++++++++++++++++++++++++++++++++++++++++++++++++ README-CN.md | 36 +++++++- README.md | 9 ++ 3 files changed, 292 insertions(+), 5 deletions(-) create mode 100644 README-AR.md diff --git a/README-AR.md b/README-AR.md new file mode 100644 index 0000000..c8918c7 --- /dev/null +++ b/README-AR.md @@ -0,0 +1,252 @@ + +

+

عميل DeepSeek PHP

+

🚀 حزمة SDK لـ PHP مدعومة من المجتمع لتكامل واجهة برمجة التطبيقات الذكية DeepSeek

+ +

+ + أحدث إصدار + + + نسخة PHP + + + الرخصة + + + حالة الاختبارات + +

+

+ +## فهرس المحتويات +- [✨ المميزات](#-المميزات) +- [📦 التثبيت](#-التثبيت) +- [🚀 البداية السريعة](#-البداية-السريعة) + - [الاستخدام الأساسي](#الاستخدام-الأساسي) + - [التكوين المتقدم](#التكوين-المتقدم) + - [الاستخدام مع عميل HTTP من Symfony](#الاستخدام-مع-عميل-http-من-symfony) + - [الحصول على قائمة النماذج](#الحصول-على-قائمة-النماذج) + - [تكامل مع الأطر](#-تكامل-مع-الأطر) +- [🆕 دليل الترحيل](#-دليل-الترحيل) +- [📝 سجل التغييرات](#-سجل-التغييرات) +- [🧪 الاختبارات](#-الاختبارات) +- [🔒 الأمان](#-الأمان) +- [🤝 المساهمين](#-المساهمين) +- [📄 الرخصة](#-الرخصة) + +--- + +## ✨ المميزات + +- **تكامل API سلس**: واجهة تعتمد على PHP لميزات الذكاء الاصطناعي في DeepSeek. +- **نمط الباني السلس**: أساليب قابلة للسلسلة لبناء الطلبات بطريقة بديهية. +- **جاهز للمؤسسات**: تكامل مع عميل HTTP متوافق مع PSR-18. +- **مرونة النماذج**: دعم لعدة نماذج من DeepSeek (Coder, Chat, وغيرها). +- **جاهز للبث**: دعم مدمج للتعامل مع الردود في الوقت الفعلي. +- **العديد من عملاء HTTP**: يمكنك استخدام عميل `Guzzle http client` (افتراضي) أو `symfony http client` بسهولة. +- **متوافق مع الأطر**: حزم 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; +``` + +📌 الإعدادات الافتراضية المستخدمة: +- النموذج: `deepseek-chat` +- الحرارة: 0.8 + +### التكوين المتقدم + +```php +use DeepSeek\DeepSeekClient; +use DeepSeek\Enums\Models; + +$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, clientType:'guzzle'); + +$response = $client + ->withModel(Models::CODER->value) + ->withStream() + ->withTemperature(1.2) + ->run(); + +echo 'API Response:'.$response; +``` + +### الاستخدام مع عميل HTTP من Symfony +الحزمة مبنية مسبقاً مع `symfony Http client`، فإذا كنت بحاجة إلى استخدامها مع عميل HTTP الخاص بـ Symfony، فيمكن تحقيق ذلك بسهولة عن طريق تمرير `clientType:'symfony'` إلى دالة `build`. + +مثال باستخدام Symfony: + +```php +// مع القيم الافتراضية للـ baseUrl و timeout +$client = DeepSeekClient::build('your-api-key', clientType:'symfony') +// مع التخصيص +$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, 'symfony'); + +$client->query('Explain quantum computing in simple terms') + ->run(); +``` + +### الحصول على قائمة النماذج + +```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"}]} +``` + +### 🛠 تكامل مع الأطر + +### [حزمة Deepseek لـ Laravel](https://github.com/deepseek-php/deepseek-laravel) + +--- + +## 🚧 دليل الترحيل + +هل تقوم بالترقية من الإصدار v1.x؟ اطلع على دليل الترحيل الشامل الخاص بنا للتغييرات الجذرية وتعليمات الترقية. + +--- + +## 📝 سجل التغييرات + +ملاحظات الإصدار التفصيلية متوفرة في [CHANGELOG.md](CHANGELOG.md) + +--- + +## 🧪 الاختبارات + +```bash +./vendor/bin/pest +``` + +تغطية الاختبارات ستتوفر في الإصدار v2.1. + +--- +
+ +# 🐘✨ **مجتمع DeepSeek PHP** ✨🐘 + +انقر على الزر أدناه أو [انضم هنا](https://t.me/deepseek_php_community) لتكون جزءًا من مجتمعنا المتنامي! + +[![Join Telegram](https://img.shields.io/badge/Join-Telegram-blue?style=for-the-badge&logo=telegram)](https://t.me/deepseek_php_community) + + +### **هيكل القناة** 🏗️ +- 🗨️ **عام** - دردشة يومية +- 💡 **الأفكار والاقتراحات** - تشكيل مستقبل المجتمع +- 📢 **الإعلانات والأخبار** - التحديثات والأخبار الرسمية +- 🚀 **الإصدارات والتحديثات** - تتبع الإصدارات ودعم الترحيل +- 🐞 **المشاكل وتقارير الأخطاء** - حل مشكلات جماعي +- 🤝 **طلبات السحب** - التعاون والمراجعة البرمجية + +
+ +--- + +## 🔒 الأمان + +**الإبلاغ عن الثغرات**: إلى [omaralwi2010@gmail.com](mailto:omaralwi2010@gmail.com) + +--- + +## 🤝 المساهمين + +شكراً جزيلاً لهؤلاء الأشخاص المذهلين الذين ساهموا في هذا المشروع! 🎉💖 + + + + + + + + + + +
+ + Omar AlAlwi +
+ Omar AlAlwi + +
+ 🏆 المُنشئ + 		+ + Ayman Alhattami +
+ Ayman Alhattami + +
+ ⭐ مساهم + 		+ + Mohammad Asaad +
+ Mohammad Asaad + +
+ ⭐ مساهم + 		+ + Opada Alzaiede +
+ Opada Alzaiede + +
+ ⭐ مساهم + 		+ + Hisham Bin Ateya +
+ Hisham Bin Ateya + +
+ ⭐ مساهم + 		+ + Vinchan +
+ Vinchan + +
+ ⭐ مساهم +
+ +**هل ترغب في المساهمة؟** اطلع على [إرشادات المساهمة](./CONTRIBUTING.md) وقدم طلب سحب! 🚀 + +--- + +## 📄 الرخصة + +هذه الحزمة هي برنامج مفتوح المصدر مرخص بموجب [رخصة MIT](LICENSE.md). diff --git a/README-CN.md b/README-CN.md index 26dd190..530833e 100644 --- a/README-CN.md +++ b/README-CN.md @@ -23,7 +23,8 @@ - [📦 安装](#-安装) - [🚀 快速入门](#-快速入门) - [基本用法](#基本用法) - - [高级配置](#高级配置) + - [高级配置](#advanced-configuration) + - [Use with Symfony HttpClient](#use-with-symfony-httpclient) - [获取模型列表](#获取模型列表) - [框架集成](#-框架集成) - [🆕 迁移指南](#-迁移指南) @@ -79,21 +80,38 @@ echo $response; - Model: `deepseek-chat` - Temperature: 0.8 -### 高级配置 +### Advanced Configuration ```php use DeepSeek\DeepSeekClient; use DeepSeek\Enums\Models; -$response = DeepSeekClient::build('your-api-key') - ->withBaseUrl('https://api.deepseek.com/v2') +$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, clientType:'guzzle'); + +$response = $client ->withModel(Models::CODER->value) + ->withStream() ->withTemperature(1.2) ->run(); echo 'API Response:'.$response; ``` +### Use with Symfony HttpClient +the package already built with `symfony Http client`, if you need to use package with `symfony` Http Client , it is easy to achieve that, just pass `clientType:'symfony'` with `build` function. + +ex with symfony: + +```php +// with defaults baseUrl and timeout +$client = DeepSeekClient::build('your-api-key', clientType:'symfony') +// with customization +$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, 'symfony'); + +$client->query('Explain quantum computing in simple terms') + ->run(); +``` + ### 获取模型列表 ```php @@ -110,7 +128,6 @@ echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"mode ### [Laravel Deepseek Package](https://github.com/deepseek-php/deepseek-laravel) -### [Symfony Deepseek Package](https://github.com/deepseek-php/deepseek-symfony) --- @@ -193,6 +210,15 @@ echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"mode
⭐ Contributor + + + 陈文锋 +
+ 陈文锋 + +
+ ⭐ Contributor + diff --git a/README.md b/README.md index a2ddb9e..9be3a07 100644 --- a/README.md +++ b/README.md @@ -230,6 +230,15 @@ A huge thank you to these amazing people who have contributed to this project!
⭐ Contributor + + + Vinchan +
+ Vinchan + +
+ ⭐ Contributor +