الرئيسية التوثيق البدء السريع

البدء السريع

تعلّم أساسيات LLM Resayil في دقائق معدودة. سيرشدك هذا الدليل خلال التسجيل، والحصول على مفتاح API، وإرسال أول طلب API.

ما هو LLM Resayil؟

LLM Resayil هي واجهة برمجة تطبيقات متوافقة مع OpenAI توفر وصولاً إلى أكثر من 45 نموذجاً لغوياً كبيراً. سواء كنت بحاجة إلى استدلال سريع مع Mistral، أو تفكير قوي مع Llama 2، أو نماذج متخصصة لمهام محددة، يتيح لك LLM Resayil الوصول إليها جميعاً بواجهة برمجة تطبيقات موحّدة. يعني نظام الدفع لكل رمز أنك تدفع فقط مقابل ما تستخدمه — بلا اشتراكات شهرية، بلا رسوم خفية. ابدأ بـ 1,000 رصيد مجاني وتوسّع حسب احتياجاتك.

عناوين URL الأساسية

تدعم واجهة البرمجة ثلاثة عناوين أساسية. يمكنك استخدام أي منها — جميعها تؤدي نفس الوظيفة وتدعم نفس نقاط النهاية:

العنوان الاستخدام
https://llmapi.resayil.io/v1/ Preferred متوافق مع OpenAI — الأنسب مع مكتبات openai الرسمية
https://llmapi.resayil.io/v1/ New نطاق API مخصص — بديل نظيف للتكاملات التي تفضل نطاقاً منفصلاً
https://llmapi.resayil.io/v1/ Standard العنوان القياسي — متاح للتوافق مع التكاملات القائمة

نصيحة: إذا كنت تستخدم مكتبة openai الرسمية للـ Python أو JavaScript، فقط عيّن base_url='https://llmapi.resayil.io/v1' وستعمل جميع الاستدعاءات تلقائياً. يمكنك أيضاً استخدام https://llmapi.resayil.io/v1 كبديل على النطاق المخصص.

الحصول على مفتاح API

لاستخدام واجهة برمجة تطبيقات LLM Resayil، ستحتاج إلى مفتاح API. إليك كيفية الحصول عليه في ثلاث خطوات بسيطة:

1

التسجيل أو تسجيل الدخول

قم بزيارة https://llm.resayil.io/register لإنشاء حساب مجاني. إذا كان لديك حساب بالفعل، فقط سجّل دخولك. يستغرق التسجيل أقل من دقيقتين ويأتي مع 1,000 رصيد مجاني للبدء.

2

الانتقال إلى مفاتيح API

بعد تسجيل الدخول، انتقل إلى لوحة التحكم وانقر على "API Keys" في الشريط الجانبي الأيسر. تعرض هذه الصفحة جميع مفاتيح API النشطة لديك وتتيح لك إدارتها.

3

نسخ مفتاح API

انقر على زر "Generate New Key" لإنشاء مفتاح API جديد. سيُعرض مفتاحك مرة واحدة — انسخه فوراً واحفظه في مكان آمن. ستستخدم هذا المفتاح لمصادقة جميع طلبات API. لا تشارك مفتاح API علناً أو تضعه في نظام التحكم بالإصدار.

نصيحة أمنية: عامل مفتاح API كلمة مرور. خزّنه في متغيرات البيئة، وليس في الكود. إذا كشفت مفتاحك عن طريق الخطأ، ألغِه فوراً من صفحة API Keys وأنشئ مفتاحاً جديداً.

أول طلب لك

الآن بعد أن أصبح لديك مفتاح API، لنُرسل أول طلب API. تستخدم واجهة برمجة LLM Resayil نفس تنسيق نقطة نهاية Chat Completions من OpenAI، لذا إذا سبق لك استخدام OpenAI، ستجد كل شيء مألوفاً.

فهم ترويسة التفويض

يجب أن يتضمن كل طلب API ترويسة Authorization تحتوي على مفتاح API بالتنسيق التالي:

Authorization Header Format
Authorization: Bearer YOUR_API_KEY

استبدل YOUR_API_KEY بمفتاح API الفعلي الذي أنشأته في الخطوة السابقة. كلمة "Bearer" مطلوبة وحساسة لحالة الأحرف.

إرسال طلب Chat Completion

إليك مثال كامل لإرسال طلب chat completion باستخدام cURL. انسخه واستبدل YOUR_API_KEY بمفتاحك الفعلي:

bash — Preferred (/v1/ shorthand)
curl -X POST https://llmapi.resayil.io/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "mistral",
    "messages": [
      {
        "role": "user",
        "content": "Hello! What is your name?"
      }
    ],
    "max_tokens": 100
  }'

يمكنك أيضاً استخدام النطاق المخصص أو العنوان القياسي البديل:

bash — Dedicated API hostname
curl -X POST https://llmapi.resayil.io/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "mistral", "messages": [{"role": "user", "content": "Hello! What is your name?"}], "max_tokens": 100}'
bash — Standard path (alternative)
curl -X POST https://llmapi.resayil.io/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "mistral", "messages": [{"role": "user", "content": "Hello! What is your name?"}], "max_tokens": 100}'

استخدام مكتبة OpenAI الرسمية (Python)

بما أن واجهة LLM Resayil متوافقة مع OpenAI، يمكنك استخدام مكتبة openai الرسمية مع تعديل base_url فقط:

python — openai library
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv('LLM_RESAYIL_API_KEY'),
    base_url='https://llmapi.resayil.io/v1'  # or https://llmapi.resayil.io/v1
)

response = client.chat.completions.create(
    model='mistral',
    messages=[{'role': 'user', 'content': 'Hello! What is your name?'}],
    max_tokens=100
)
print(response.choices[0].message.content)

شرح معاملات الطلب

إليك ما يعنيه كل معامل في الطلب:

  • model: اسم النموذج المراد استخدامه (مثلاً "mistral"، "llama2"، "neural-chat"). راجع دليل النماذج للخيارات المتاحة.
  • messages: مصفوفة من كائنات الرسائل مع "role" (user، assistant، أو system) و"content" (النص).
  • max_tokens: الحد الأقصى للرموز التي ينبغي للنموذج توليدها في استجابته.
  • temperature (اختياري): يتحكم في العشوائية. القيم المنخفضة (0.1) تجعل الاستجابات أكثر حتمية؛ القيم الأعلى (0.9) تجعلها أكثر إبداعاً.
  • top_p (اختياري): يتحكم في التنوع عبر أخذ عينات النواة. القيمة المعتادة هي 0.9.
  • stream (اختياري): اضبطه على true لتمكين استجابات البث عبر SSE — مدعوم بالكامل.

فهم الاستجابة

عند نجاح طلبك، ستتلقى استجابة JSON. إليك شكل استجابة نموذجية:

json — Example Response
{
  "id": "chatcmpl-123456",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "mistral",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "My name is Mistral. I am an AI assistant..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 25,
    "total_tokens": 35
  }
}

الحقول الرئيسية في الاستجابة:

  • choices: مصفوفة تحتوي على استجابة النموذج. الاختيار الأول (index 0) يحتوي على الرسالة الفعلية.
  • message.content: نص الاستجابة الفعلي من النموذج.
  • usage: تفصيل استهلاك الرموز. استخدمه لتقدير التكاليف.
  • finish_reason: سبب توقف النموذج (عادةً "stop" عند الاكتمال الناجح).

البث (Streaming)

تدعم واجهة البرمجة البث عبر Server-Sent Events (SSE) بشكل كامل. أضف "stream": true إلى طلبك لتلقي الرموز فور توليدها، مما يتيح تجربة مستخدم أكثر استجابة:

bash — Streaming Example
curl -X POST https://llmapi.resayil.io/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -d '{"model": "mistral", "messages": [{"role": "user", "content": "Tell me a short story."}], "stream": true}'
python — Streaming with openai library
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.getenv('LLM_RESAYIL_API_KEY'),
    base_url='https://llmapi.resayil.io/v1'
)

stream = client.chat.completions.create(
    model='mistral',
    messages=[{'role': 'user', 'content': 'Tell me a short story.'}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end='', flush=True)

ما التالي؟

تهانينا على إرسال أول طلب API! إليك بعض الخطوات التالية المقترحة للمتابعة في البناء:

  • استكشاف النماذج: اذهب إلى دليل النماذج المتاحة للتعرف على جميع النماذج الـ 45+ وإمكانياتها.
  • تعلّم المصادقة: اقرأ دليل المصادقة لأفضل الممارسات في إدارة مفاتيح API بأمان.
  • فهم الفوترة: زر صفحة الفوترة والرصيد لفهم استهلاك الرموز والتسعير.
  • معالجة الأخطاء: راجع دليل رموز الأخطاء لتعلّم كيفية التعامل مع المشكلات الشائعة.
  • حدود المعدّل: تعرّف على حدود المعدّل وكيفية تطبيق استراتيجيات التراجع في دليل حدود المعدّل.

المشكلات الشائعة

خطأ 401 Unauthorized

يعني هذا الخطأ أن مفتاح API مفقود أو غير صالح أو بتنسيق خاطئ في ترويسة Authorization. تحقق مرتين من استخدامك للمفتاح الصحيح وأنه مسبوق بـ "Bearer ".

خطأ 429 Too Many Requests

تجاوزت حد المعدّل للنافذة الزمنية الحالية. انتظر لحظة قبل المحاولة مجدداً، أو ارقِّ إلى طبقة اشتراك أعلى لحدود أكبر. راجع دليل حدود المعدّل للتفاصيل.

انتهاء مهلة الاتصال

إذا انتهت مهلة طلبك، أعد المحاولة بقيمة مهلة أطول. يمكن أن تستغرق الاتصالات الباردة بواجهة البرمجة 1-3 ثواني. بعد الاتصال، عادةً ما تكون الطلبات اللاحقة أسرع بكثير.

تحتاج مساعدة؟ إذا كنت عالقاً، تواصل مع فريق الدعم أو زر دليل رموز الأخطاء للمزيد من نصائح استكشاف الأخطاء.