Skip to content

Commit 42bb82b

Browse files
omaralalwiomaralalwi
authored
Merge pull request #39 from deepseek-php/add-arabic-doc
Add Arabic documentation
2 parents dfc28dc + 2665326 commit 42bb82b

File tree

3 files changed

+292
-5
lines changed

3 files changed

+292
-5
lines changed

‎README-AR.md

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
2+
<p align="center">
3+
<h1 align="center">عميل DeepSeek PHP</h1>
4+
<p align="center">🚀 حزمة SDK لـ PHP مدعومة من المجتمع لتكامل واجهة برمجة التطبيقات الذكية DeepSeek</p>
5+
6+
<p align="center">
7+
<a href="https://packagist.org/packages/deepseek-php/deepseek-php-client">
8+
<img src="https://img.shields.io/packagist/v/deepseek-php/deepseek-php-client" alt="أحدث إصدار">
9+
</a>
10+
<a href="https://php.net">
11+
<img src="https://img.shields.io/badge/PHP-8.1%2B-blue" alt="نسخة PHP">
12+
</a>
13+
<a href="LICENSE.md">
14+
<img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="الرخصة">
15+
</a>
16+
<a href="https://github.com/deepseek-php/deepseek-php-client/actions">
17+
<img src="https://img.shields.io/github/actions/workflow/status/deepseek-php/deepseek-php-client/tests.yml" alt="حالة الاختبارات">
18+
</a>
19+
</p>
20+
</p>
21+
22+
## فهرس المحتويات
23+
- [✨ المميزات](#-المميزات)
24+
- [📦 التثبيت](#-التثبيت)
25+
- [🚀 البداية السريعة](#-البداية-السريعة)
26+
- [الاستخدام الأساسي](#الاستخدام-الأساسي)
27+
- [التكوين المتقدم](#التكوين-المتقدم)
28+
- [الاستخدام مع عميل HTTP من Symfony](#الاستخدام-مع-عميل-http-من-symfony)
29+
- [الحصول على قائمة النماذج](#الحصول-على-قائمة-النماذج)
30+
- [تكامل مع الأطر](#-تكامل-مع-الأطر)
31+
- [🆕 دليل الترحيل](#-دليل-الترحيل)
32+
- [📝 سجل التغييرات](#-سجل-التغييرات)
33+
- [🧪 الاختبارات](#-الاختبارات)
34+
- [🔒 الأمان](#-الأمان)
35+
- [🤝 المساهمين](#-المساهمين)
36+
- [📄 الرخصة](#-الرخصة)
37+
38+
---
39+
40+
## ✨ المميزات
41+
42+
- **تكامل API سلس**: واجهة تعتمد على PHP لميزات الذكاء الاصطناعي في DeepSeek.
43+
- **نمط الباني السلس**: أساليب قابلة للسلسلة لبناء الطلبات بطريقة بديهية.
44+
- **جاهز للمؤسسات**: تكامل مع عميل HTTP متوافق مع PSR-18.
45+
- **مرونة النماذج**: دعم لعدة نماذج من DeepSeek (Coder, Chat, وغيرها).
46+
- **جاهز للبث**: دعم مدمج للتعامل مع الردود في الوقت الفعلي.
47+
- **العديد من عملاء HTTP**: يمكنك استخدام عميل `Guzzle http client` (افتراضي) أو `symfony http client` بسهولة.
48+
- **متوافق مع الأطر**: حزم Laravel و Symfony متاحة.
49+
50+
---
51+
52+
## 📦 التثبيت
53+
54+
قم بتثبيت الحزمة عبر Composer:
55+
56+
```bash
57+
composer require deepseek-php/deepseek-php-client
58+
```
59+
60+
**المتطلبات**:
61+
- PHP 8.1+
62+
63+
---
64+
65+
## 🚀 البداية السريعة
66+
67+
### الاستخدام الأساسي
68+
69+
ابدأ مع سطرين من الكود فقط:
70+
71+
```php
72+
use DeepSeek\DeepSeekClient;
73+
74+
$response = DeepSeekClient::build('your-api-key')
75+
->query('Explain quantum computing in simple terms')
76+
->run();
77+
78+
echo $response;
79+
```
80+
81+
📌 الإعدادات الافتراضية المستخدمة:
82+
- النموذج: `deepseek-chat`
83+
- الحرارة: 0.8
84+
85+
### التكوين المتقدم
86+
87+
```php
88+
use DeepSeek\DeepSeekClient;
89+
use DeepSeek\Enums\Models;
90+
91+
$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, clientType:'guzzle');
92+
93+
$response = $client
94+
->withModel(Models::CODER->value)
95+
->withStream()
96+
->withTemperature(1.2)
97+
->run();
98+
99+
echo 'API Response:'.$response;
100+
```
101+
102+
### الاستخدام مع عميل HTTP من Symfony
103+
الحزمة مبنية مسبقاً مع `symfony Http client`، فإذا كنت بحاجة إلى استخدامها مع عميل HTTP الخاص بـ Symfony، فيمكن تحقيق ذلك بسهولة عن طريق تمرير `clientType:'symfony'` إلى دالة `build`.
104+
105+
مثال باستخدام Symfony:
106+
107+
```php
108+
// مع القيم الافتراضية للـ baseUrl و timeout
109+
$client = DeepSeekClient::build('your-api-key', clientType:'symfony')
110+
// مع التخصيص
111+
$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, 'symfony');
112+
113+
$client->query('Explain quantum computing in simple terms')
114+
->run();
115+
```
116+
117+
### الحصول على قائمة النماذج
118+
119+
```php
120+
use DeepSeek\DeepSeekClient;
121+
122+
$response = DeepSeekClient::build('your-api-key')
123+
->getModelsList()
124+
->run();
125+
126+
echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"model","owned_by":"deepseek"},{"id":"deepseek-reasoner","object":"model","owned_by":"deepseek"}]}
127+
```
128+
129+
### 🛠 تكامل مع الأطر
130+
131+
### [حزمة Deepseek لـ Laravel](https://github.com/deepseek-php/deepseek-laravel)
132+
133+
---
134+
135+
## 🚧 دليل الترحيل
136+
137+
هل تقوم بالترقية من الإصدار v1.x؟ اطلع على دليل الترحيل الشامل الخاص بنا للتغييرات الجذرية وتعليمات الترقية.
138+
139+
---
140+
141+
## 📝 سجل التغييرات
142+
143+
ملاحظات الإصدار التفصيلية متوفرة في [CHANGELOG.md](CHANGELOG.md)
144+
145+
---
146+
147+
## 🧪 الاختبارات
148+
149+
```bash
150+
./vendor/bin/pest
151+
```
152+
153+
تغطية الاختبارات ستتوفر في الإصدار v2.1.
154+
155+
---
156+
<div>
157+
158+
# 🐘✨ **مجتمع DeepSeek PHP** ✨🐘
159+
160+
انقر على الزر أدناه أو [انضم هنا](https://t.me/deepseek_php_community) لتكون جزءًا من مجتمعنا المتنامي!
161+
162+
[![Join Telegram](https://img.shields.io/badge/Join-Telegram-blue?style=for-the-badge&logo=telegram)](https://t.me/deepseek_php_community)
163+
164+
165+
### **هيكل القناة** 🏗️
166+
- 🗨️ **عام** - دردشة يومية
167+
- 💡 **الأفكار والاقتراحات** - تشكيل مستقبل المجتمع
168+
- 📢 **الإعلانات والأخبار** - التحديثات والأخبار الرسمية
169+
- 🚀 **الإصدارات والتحديثات** - تتبع الإصدارات ودعم الترحيل
170+
- 🐞 **المشاكل وتقارير الأخطاء** - حل مشكلات جماعي
171+
- 🤝 **طلبات السحب** - التعاون والمراجعة البرمجية
172+
173+
</div>
174+
175+
---
176+
177+
## 🔒 الأمان
178+
179+
**الإبلاغ عن الثغرات**: إلى [omaralwi2010@gmail.com](mailto:omaralwi2010@gmail.com)
180+
181+
---
182+
183+
## 🤝 المساهمين
184+
185+
شكراً جزيلاً لهؤلاء الأشخاص المذهلين الذين ساهموا في هذا المشروع! 🎉💖
186+
187+
<table>
188+
<tr>
189+
<td align="center">
190+
<a href="https://github.com/omaralalwi">
191+
<img src="https://avatars.githubusercontent.com/u/25439498?v=4" width="60px;" style="border-radius:50%;" alt="Omar AlAlwi"/>
192+
<br />
193+
<b>Omar AlAlwi</b>
194+
</a>
195+
<br />
196+
🏆 المُنشئ
197+
</td>
198+
<td align="center">
199+
<a href="https://github.com/aymanalhattami">
200+
<img src="https://avatars.githubusercontent.com/u/34315778?v=4" width="60px;" style="border-radius:50%;" alt="Ayman Alhattami"/>
201+
<br />
202+
<b>Ayman Alhattami</b>
203+
</a>
204+
<br />
205+
⭐ مساهم
206+
</td>
207+
<td align="center">
208+
<a href="https://github.com/moassaad">
209+
<img src="https://avatars.githubusercontent.com/u/155223476?v=4" width="60px;" style="border-radius:50%;" alt="Mohammad Asaad"/>
210+
<br />
211+
<b>Mohammad Asaad</b>
212+
</a>
213+
<br />
214+
⭐ مساهم
215+
</td>
216+
<td align="center">
217+
<a href="https://github.com/OpadaAlzaiede">
218+
<img src="https://avatars.githubusercontent.com/u/48367429?v=4" width="60px;" style="border-radius:50%;" alt="Opada Alzaiede"/>
219+
<br />
220+
<b>Opada Alzaiede</b>
221+
</a>
222+
<br />
223+
⭐ مساهم
224+
</td>
225+
<td align="center">
226+
<a href="https://github.com/hishamco">
227+
<img src="https://avatars.githubusercontent.com/u/3237266?v=4" width="60px;" style="border-radius:50%;" alt="Hisham Bin Ateya"/>
228+
<br />
229+
<b>Hisham Bin Ateya</b>
230+
</a>
231+
<br />
232+
⭐ مساهم
233+
</td>
234+
<td align="center">
235+
<a href="https://github.com/VinchanGit">
236+
<img src="https://avatars.githubusercontent.com/u/38177046?v=4" width="60px;" style="border-radius:50%;" alt="Vinchan"/>
237+
<br />
238+
<b>Vinchan</b>
239+
</a>
240+
<br />
241+
⭐ مساهم
242+
</td>
243+
</tr>
244+
</table>
245+
246+
**هل ترغب في المساهمة؟** اطلع على [إرشادات المساهمة](./CONTRIBUTING.md) وقدم طلب سحب! 🚀
247+
248+
---
249+
250+
## 📄 الرخصة
251+
252+
هذه الحزمة هي برنامج مفتوح المصدر مرخص بموجب [رخصة MIT](LICENSE.md).

‎README-CN.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
- [📦 安装](#-安装)
2424
- [🚀 快速入门](#-快速入门)
2525
- [基本用法](#基本用法)
26-
- [高级配置](#高级配置)
26+
- [高级配置](#advanced-configuration)
27+
- [Use with Symfony HttpClient](#use-with-symfony-httpclient)
2728
- [获取模型列表](#获取模型列表)
2829
- [框架集成](#-框架集成)
2930
- [🆕 迁移指南](#-迁移指南)
@@ -79,21 +80,38 @@ echo $response;
7980
- Model: `deepseek-chat`
8081
- Temperature: 0.8
8182

82-
### 高级配置
83+
### Advanced Configuration
8384

8485
```php
8586
use DeepSeek\DeepSeekClient;
8687
use DeepSeek\Enums\Models;
8788

88-
$response = DeepSeekClient::build('your-api-key')
89-
->withBaseUrl('https://api.deepseek.com/v2')
89+
$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, clientType:'guzzle');
90+
91+
$response = $client
9092
->withModel(Models::CODER->value)
93+
->withStream()
9194
->withTemperature(1.2)
9295
->run();
9396

9497
echo 'API Response:'.$response;
9598
```
9699

100+
### Use with Symfony HttpClient
101+
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.
102+
103+
ex with symfony:
104+
105+
```php
106+
// with defaults baseUrl and timeout
107+
$client = DeepSeekClient::build('your-api-key', clientType:'symfony')
108+
// with customization
109+
$client = DeepSeekClient::build(apiKey:'your-api-key', baseUrl:'https://api.deepseek.com/v3', timeout:30, 'symfony');
110+
111+
$client->query('Explain quantum computing in simple terms')
112+
->run();
113+
```
114+
97115
### 获取模型列表
98116

99117
```php
@@ -110,7 +128,6 @@ echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"mode
110128

111129
### [Laravel Deepseek Package](https://github.com/deepseek-php/deepseek-laravel)
112130

113-
### [Symfony Deepseek Package](https://github.com/deepseek-php/deepseek-symfony)
114131

115132
---
116133

@@ -193,6 +210,15 @@ echo $response; // {"object":"list","data":[{"id":"deepseek-chat","object":"mode
193210
<br />
194211
⭐ Contributor
195212
</td>
213+
<td align="center">
214+
<a href="https://github.com/VinchanGit">
215+
<img src="https://avatars.githubusercontent.com/u/38177046?v=4" width="60px;" style="border-radius:50%;" alt="陈文锋"/>
216+
<br />
217+
<b>陈文锋</b>
218+
</a>
219+
<br />
220+
⭐ Contributor
221+
</td>
196222
</tr>
197223
</table>
198224

‎README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,15 @@ A huge thank you to these amazing people who have contributed to this project!
230230
<br />
231231
⭐ Contributor
232232
</td>
233+
<td align="center">
234+
<a href="https://github.com/VinchanGit">
235+
<img src="https://avatars.githubusercontent.com/u/38177046?v=4" width="60px;" style="border-radius:50%;" alt="Vinchan"/>
236+
<br />
237+
<b>Vinchan</b>
238+
</a>
239+
<br />
240+
⭐ Contributor
241+
</td>
233242
</tr>
234243
</table>
235244

0 commit comments

Comments
 (0)