الانتقال إلى المحتوى الرئيسي

Quick Start

ابدأ في دقيقتين مع تتبع الرموز تلقائيًا.

API Reference - Events Ingestion

توثيق API الكامل لالتقاط أحداث الاستخدام.

API Reference - Meters

تعرف على كيفية إنشاء المقاييس وتكوينها للفوترة.

Usage-Based Billing Guide

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

بدء سريع

ابدأ مع تتبع رموز LLM التلقائي في دقيقتين فقط:
1

Install the SDK

قم بتثبيت المخططات الأساسية لالتقاط بيانات Dodo Payments:
2

Get Your API Keys

ستحتاج إلى مفتاحي واجهة برمجة تطبيقات:
احفظ مفاتيح API بأمان في متغيرات البيئة. لا تقم بإدراجها في نظام التحكم في الإصدارات.
3

Create a Meter in Dodo Payments

قبل تتبع الاستخدام، أنشئ مقياسًا في لوحة Dodo Payments:
  1. تسجيل الدخول إلى لوحة Dodo Payments
  2. انتقل إلى Products → Meters
  3. انقر على “Create Meter”
  4. قم بتكوين المقياس الخاص بك:
    • اسم المقياس: اختر اسمًا وصفيًا (مثل “LLM Token Usage”)
    • اسم الحدث: حدد معرف حدث فريد (مثل llm.chat_completion)
    • نوع التجميع: اختر sum لجمع عدد الرموز
    • خاصية التجميع: اختر ما تريد تتبعه:
      • inputTokens - تتبع رموز الإدخال/الموجه
      • outputTokens - تتبع رموز الإخراج/الإكمال (تتضمن رموز الاستدلال عند الاقتضاء)
      • totalTokens - تتبع مجموع رموز الإدخال + الإخراج
يجب أن يتطابق اسم الحدث الذي تحدده هنا تمامًا مع الاسم الذي تمرره إلى SDK (مع مراعاة حالة الأحرف).
لمزيد من التعليمات التفصيلية، راجع دليل الفوترة القائمة على الاستخدام.
4

Track Token Usage

قم بتغليف عميل LLM الخاص بك وابدأ التتبع تلقائيًا:
هذا كل شيء! الآن كل استدعاء API يتتبع تلقائيًا استخدام الرموز ويرسل الأحداث إلى Dodo Payments للفوترة.

التكوين

تكوين المتتبع

قم بإنشاء متتبع مرة واحدة عند بدء التطبيق مع هذه المعلمات المطلوبة:
apiKey
string
مطلوب
مفتاح API الخاص بـ Dodo Payments. احصل عليه من صفحة مفاتيح API.
environment
string
مطلوب
وضع البيئة لبرتوكول التتبع.
  • test_mode - استخدمه للتطوير والاختبار
  • live_mode - استخدمه للإنتاج
استخدم دائمًا test_mode أثناء التطوير لتجنب التأثير على مقاييس الإنتاج.
eventName
string
مطلوب
اسم الحدث الذي يُشغّل المقياس. يجب أن يتطابق تمامًا مع ما قمت بتكوينه في مقياس Dodo Payments الخاص بك (حساس لحالة الأحرف).
يربط اسم الحدث هذا الاستخدام المتتبع بالمقياس الصحيح لحسابات الفوترة.

تكوين الغلاف

عند لف عميل LLM الخاص بك، قدم هذه المعلمات:
client
object
مطلوب
مثيل عميل LLM الخاص بك (OpenAI، Anthropic، Groq، إلخ).
customerId
string
مطلوب
المعرف الفريد للعميل للفوترة. يجب أن يتطابق مع معرف العميل في Dodo Payments.
استخدم معرف مستخدم التطبيق أو معرف العميل لضمان فوترة دقيقة لكل عميل.
metadata
object
بيانات إضافية اختيارية لإرفاقها بحدث التتبع. مفيدة للتصفية والتحليل.

مثال كامل على التكوين

التتبع التلقائي: يقوم SDK بتتبع استخدام الرموز تلقائيًا في الخلفية دون تعديل الاستجابة. يظل الكود نظيفًا ومطابقًا لاستخدام SDK الخاص بالمزود الأصلي.

المزودون المدعومون

يعمل مخطط LLM بسلاسة مع جميع مزودي LLM الرئيسيين والمجمعين:
تتبع الاستخدام باستخدام Vercel AI SDK لدعم LLM شامل.
القياسات المتعقبة:
  • inputTokensinputTokens
  • outputTokens + reasoningTokensoutputTokens
  • totalTokenstotalTokens
  • اسم النموذج
عند استخدام نماذج تدعم الاستدلال عبر AI SDK (مثل Gemini 2.5 Flash من Google مع وضع التفكير)، يتم تضمين رموز الاستدلال تلقائيًا في outputTokens لضمان فوترة دقيقة.
تتبع استخدام الرموز من أكثر من 200 نموذج عبر واجهة OpenRouter الموحدة.
القياسات المتعقبة:
  • prompt_tokensinputTokens
  • completion_tokensoutputTokens
  • total_tokenstotalTokens
  • اسم النموذج
يوفر OpenRouter الوصول إلى نماذج من OpenAI وAnthropic وGoogle وMeta والعديد من المزودين الآخرين عبر واجهة API واحدة.
تتبع استخدام الرموز من نماذج GPT التابعة لـ OpenAI تلقائيًا.
القياسات المتعقبة:
  • prompt_tokensinputTokens
  • completion_tokensoutputTokens
  • total_tokenstotalTokens
  • اسم النموذج
تتبع استخدام الرموز من نماذج Claude التابعة لـ Anthropic.
القياسات المتعقبة:
  • input_tokensinputTokens
  • output_tokensoutputTokens
  • totalTokens المحسوب
  • اسم النموذج
تتبع الاستدلال عالي السرعة لنماذج LLM مع Groq.
القياسات المتعقبة:
  • prompt_tokensinputTokens
  • completion_tokensoutputTokens
  • total_tokenstotalTokens
  • اسم النموذج
تتبع استخدام الرموز من نماذج Gemini التابعة لـ Google عبر Google GenAI SDK.
القياسات المتعقبة:
  • promptTokenCountinputTokens
  • candidatesTokenCount + thoughtsTokenCountoutputTokens
  • totalTokenCounttotalTokens
  • إصدار النموذج
وضع التفكير في Gemini: عند استخدام نماذج Gemini التي تدعم التفكير/الاستدلال (مثل Gemini 2.5 Pro)، يقوم SDK تلقائيًا بإضافة thoughtsTokenCount (رموز الاستدلال) إلى outputTokens لتعكس التكلفة الحسابية الكاملة بدقة.

الاستخدام المتقدم

مزودون متعددون

تتبع الاستخدام عبر مزودي LLM مختلفين مع متتبعين منفصلين:
استخدم أسماء أحداث مختلفة لمزودين مختلفين لتتبع الاستخدام بشكل منفصل في مقاييسك.

تكامل API مع Express.js

مثال كامل على دمج تتبع LLM في API Express.js:

ما الذي يتم تتبعه

كل استدعاء API لـ LLM يرسل تلقائيًا حدث استخدام إلى مدفوعات Dodo بالهيكل التالي:

حقول الحدث

event_id
string
المعرف الفريد لهذا الحدث المحدد. يتم إنشاؤه تلقائيًا بواسطة SDK.التنسيق: llm_[timestamp]_[random]
customer_id
string
معرف العميل الذي قدمته عند تغليف العميل. يُستخدم للفوترة.
event_name
string
اسم الحدث الذي يُشغّل المقياس. يتطابق مع تكوين المتتبع الخاص بك.
timestamp
string
الطابع الزمني بصيغة ISO 8601 عندما وقع الحدث.
metadata
object
استخدام الرموز وبيانات التتبع الإضافية:
  • inputTokens - عدد رموز الإدخال/الموجه المستخدمة
  • outputTokens - عدد رموز المخرجات/الإكمال المستخدمة (يشمل رموز الاستدلال عند الاقتضاء)
  • totalTokens - إجمالي الرموز (إدخال + إخراج)
  • model - نموذج LLM المستخدم (مثل “gpt-4”)
  • provider - مزود LLM (إذا كان مدرجًا في بيانات الغلاف التعريفية)
  • أي بيانات تعريف مخصصة قدمتها عند تغليف العميل
  • inputTokens - عدد رموز الإدخال/المطالبة المستخدمة
  • outputTokens - عدد رموز الإخراج/الإنجاز المستخدمة (تشمل رموز التفكير عند الاقتضاء)
  • totalTokens - إجمالي الرموز (الإدخال + الإخراج)
  • model - نموذج LLM المستخدم (مثل “gpt-4”)
  • provider - مزود LLM (إذا تم تضمينه في بيانات التعريف الخاصة بالملف)
  • أي بيانات تعريف مخصصة قدمتها عند تغليف العميل
رموز الاستدلال: بالنسبة للنماذج التي تدعم الاستدلال، يتضمن outputTokens تلقائيًا كلًا من رموز الإكمال ورموز الاستدلال.
يستخدم مقياس Dodo Payments الخاص بك الحقول metadata (خاصة inputTokens، outputTokens أو totalTokens) لحساب الاستخدام والفوترة.
آخر تعديل في ١ أبريل ٢٠٢٦