توثيق واجهة برمجة تطبيقات Hermes: البدء السريع

الإعداد والتثبيت

تعمل واجهة برمجة التطبيقات Hermes مع أي عميل يتكلم بتنسيق OpenAI. تحتاج إلى عنوان URL أساسي ومفتاح API. أنشئ حسابًا عبر Google أو البريد الإلكتروني على صفحة احصل على مفتاح API. يعرض النظام مفتاحك على الفور. لا يلزم رقم هاتف. تتلقى رصيد تجريب بقيمة 0.50 دولار لمدة سبعة أيام. قم بإضافة رصيد لاحقًا باستخدام العملات المشفرة فقط.

• عنوان URL الأساسي: HTTPS://api.apihermes.cc/v1
• رأس المصادقة: Authorization: Bearer YOUR_API_KEY
• معرف النموذج: uncensored

ثبّت الحزمة البرمجية (SDK) المفضلة لديك واضبط عنوان URL الأساسي. تتوقع نقطة النهاية معلمات إكمال الدردشة القياسية. احتفظ بمفتاحك بأمان. يستبدل مفتاح واحد المفتاح السابق إذا قمت بإنشاء مفتاح جديد.

طلب إكمال الدردشة الأساسي

يرسل الطلب الأساسي رسائل ويتلقى استجابة نصية. معرف النموذج غير خاضع للرقابة. يتعامل مع المحتوى القانوني للبالغين دون رفض. تدفع مقابل كل رمز مستخدم. الأخطاء والرفض لا تكلف شيئًا. نافذة السياق تحتوي على 100,000 رمز إجماليًا.

هيكل طلبك مع رسالة نظام ورسالة مستخدم. تعيد واجهة برمجة التطبيقات إكمالًا. يمكنك تعيين max_tokens للتحكم في طول المخرجات. حد الإخراج الافتراضي هو 2,048 رمزًا. يمكنك رفع هذا إلى 16,000 رمز لكل طلب. يعمل التدفق عبر SSE. استدعاء الوظائف متاح. وضع JSON مدعوم.

Copycurl https://api.apihermes.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a GET request for the user endpoint"}]
  }'

يقتصر جسم الطلب على 8 ميجابايت. حدود معدل الطلب هي 300 طلب في الدقيقة. التزامن هو ثمانية طلبات في آن واحد. تتعامل منطق إعادة المحاولة مع تحميل الخادم الزائد بسلاسة.

استجابات البث مع SSE

يقدم التدفق الرموز بمجرد إنشائها. يرسل الخادم أحداث الإرسال من الخادم (SSE). تحتوي كل شريحة على نص جزئي. تتضمن الشريحة الأخيرة إحصائيات استخدام الرمز. يقلل هذا النهج من زمن الاستجابة المُدرَك للاستجابات الطويلة. إنه مثالي لواجهات الدردشة. يجب أن تتعامل مع التدفق بشكل صحيح. قد تحدث انقطاعات. لا تضمن واجهة برمجة التطبيقات ترتيب التسليم بما يتجاوز التدفق نفسه.

عيّن معلمة stream إلى true. قم بتحليل أسطر البيانات. ادمج المحتوى. تحقق من finish_reason للانتهاء. يعمل النموذج uncensored مع أي مكتبة SDK متوافقة مع OpenAI. قم بتكوين العميل للتعامل مع SSE. راقب عدد الرموز. يظل عنوان URL الأساسي كما هو. المصادقة متطابقة. لا حاجة لإعداد إضافي.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

تظهر الأخطاء في التدفق. تعامل معها بإغلاق الاتصال. يُخصم الرصيد المدفوع مسبقًا فقط مقابل الرموز المكتملة. يوفر المال أثناء الانقطاعات. لا تدفع أبدًا مقابل إخراج جزئي غير مفيد. النظام شفاف.

باستخدام استدعاء الوظائف والأدوات

إضافة استدعاء الوظائف تسمح للنموذج بتنفيذ التعليمات البرمجية أو الأدوات. عرّف الأدوات في جسم الطلب. يعيد النموذج استدعاء أداة. تقوم بتنفيذ الأداة. ترسل النتيجة مرة أخرى. يولد النموذج استجابة نهائية. هذا يمكّن سير العمل المعقد. إنه ليس مجرد غلاف دردشة. تدعم واجهة برمجة التطبيقات الأدوات وtool_choice. استخدم هذا للوكلاء أو الأتمتة.

قم بهيكل مصفوفة الأدوات. قم بتضمين الاسم والوصف والمعاملات. يقرر النموذج متى يستدعي الأداة. يجب عليك تحليل الحجج. نفذ الوظيفة. مرر المخرجات إلى المحادثة. يستمر النموذج. تتكرر هذه الدورة حتى الإجابة النهائية. تتتبع نافذة السياق جميع تفاعلات الأدوات. تتبع استخدام الرموز. تتراكم التكاليف مع مخرجات الأدوات. راقب الاستخدام في الجزء الأخير.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apihermes.cc/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

يتعامل النموذج غير الخاضع للرقابة مع مخططات الأدوات المتنوعة. لا يرفض بناءً على المحتوى. استخدم هذا لألعاب الأدوار أو المهام التقنية. واجهة برمجة التطبيقات موثوقة. الأخطاء معدومة. يضمن نظام الدفع المسبق العدالة. أنت تتحكم في التدفق. عنوان URL الأساسي ثابت. المصادقة بسيطة.

وضع JSON والمعاملات

يفرض وضع JSON على النموذج إخراج JSON صالح. اضبط response_format على json_object. هذا مفيد للبيانات المهيكلة. يتجنب النموذج أغلفة Markdown. يُرجع JSON خام. استخدم هذا للتحليل. يحسن الموثوقية. لا يزال نافذة السياق سارية. تدفع مقابل الرموز. يحترم النموذج غير الخاضع للرقابة التنسيق. لا يرفض بناءً على المحتوى.

تشمل المعاملات درجة الحرارة، و top_p، و stop، و seed، و presence_penalty، و frequency_penalty. تتحكم درجة الحرارة في العشوائية. يتحكم top_p في التنوع. توقف تسلسلات التوقف عن التوليد. يضمن البذرة إمكانية إعادة الإنتاج. تعدل عقوبات الوجود والتكرار في استخدام الرموز. اضبط هذه لتحسين الإخراج. تدعم واجهة برمجة التطبيقات جميع المعاملات القياسية. استخدمها لضبط الاستجابة. يظل عنوان URL الأساسي كما هو. المصادقة متطابقة.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apihermes.cc/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

تُعالج الأخطاء عبر رموز حالة HTTP. يعني 401 مفتاحاً غير صالح. يعني 402 عدم وجود رصيد. يعني 429 تجاوز حد المعدل. تعامل مع هذه الحالات في كودك. يُخصم الرصيد المدفوع مسبقاً فقط مقابل الرموز المكتملة. يضمن ذلك العدالة. لا تدفع أبداً مقابل المخرجات الجزئية. النظام شفاف. النموذج غير الخاضع للرقابة موثوق. استخدمه لأي مهمة قانونية.

معالجة الأخطاء وحدود المعدل

تُعيد الـ API رموز حالة HTTP القياسية. يشير 401 إلى مفتاح API غير صالح. يشير 402 إلى عدم كفاية الرصيد المدفوع مسبقاً. يشير 429 إلى حد المعدل. الحد هو 300 طلب في الدقيقة. التزامن هو ثمانية طلبات في وقت واحد. حدود جسم الطلب هي 8 ميجابايت. تعامل مع هذه الأخطاء بسلاسة. أعد المحاولة مع التخلفية الأسية. النموذج غير الخاضع للرقابة لا يرفض المحتوى القانوني. الأخطاء مجانية. لا تدفع مقابل الطلبات الفاشلة. الرصيد المدفوع مسبقاً آمن. لا ينتهي صلاحيته أبداً. استخدم صفحة الدعم للشحنات المزدوجة. العملات المشفرة فقط. USDT أو USDC. تنطبق المكافآت.