Method: models.countTokens

تشغيل أداة إنشاء رمز مميّز لنموذج على محتوى الإدخال وعرض عدد الرموز المميّزة

طلب HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:countTokens

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
model

string

مطلوبة. اسم مورد النموذج. ويعمل هذا كرقم تعريف لكي يستخدمه النموذج.

ويجب أن يتطابق هذا الاسم مع اسم النموذج الذي تعرضه الطريقة models.list.

تنسيق الملف: models/{model}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "generateContentRequest": {
    object (GenerateContentRequest)
  }
}
الحقول
contents[]

object (Content)

اختياريّ. الإدخال المقدم للنموذج كطلب. يتم تجاهل هذا الحقل عند ضبط generateContentRequest.
generateContentRequest

object (GenerateContentRequest)

اختياريّ. الإدخال العام المقدم للنموذج. model.countTokens سيحسب الطلب، واستدعاء الدوال، وما إلى ذلك.

نص الاستجابة

رد من models.countTokens.

وهي تعرض tokenCount للنموذج لـ prompt.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "totalTokens": integer
}
الحقول
totalTokens

integer

عدد الرموز المميّزة التي تستخدمها model لتحويل prompt إلى رموز مميّزة.

تكون غير سلبية دائمًا. عند ضبط cacheContent، يبقى هذا هو إجمالي حجم الطلب الفعال. بمعنى أن يشمل ذلك عدد الرموز المميّزة في المحتوى المخزّن مؤقتًا.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.

GenerateContentRequest

يمكنك طلب إكمال إكمال من النموذج.

تمثيل JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}
الحقول
model

string

مطلوبة. اسم Model المطلوب استخدامه لإنشاء الإكمال.

التنسيق: name=models/{model}
contents[]

object (Content)

مطلوبة. محتوى المحادثة الحالية مع النموذج.

بالنسبة إلى طلبات البحث الأحادية الاتجاه، هذا مجرد مثيل واحد. بالنسبة إلى طلبات البحث المتعددة الأدوار، هذا حقل متكرّر يحتوي على سجلّ المحادثات وآخر طلب.
tools[]

object (Tool)

اختياريّ. قائمة بـ Tools التي قد يستخدمها النموذج لإنشاء الرد التالي.

Tool هو جزء من الرمز البرمجي يتيح للنظام التفاعل مع الأنظمة الخارجية لتنفيذ إجراء أو مجموعة إجراءات خارج نطاق المعرفة ونطاق النموذج. الأداة الوحيدة المتوافقة هي حاليًا Function.
toolConfig

object (ToolConfig)

اختياريّ. إعداد الأداة لأي Tool محدد في الطلب.
safetySettings[]

object (SafetySetting)

اختياريّ. قائمة بمثيلات SafetySetting الفريدة لحظر المحتوى غير الآمن.

وسيتم فرض ذلك على GenerateContentRequest.contents وGenerateContentResponse.candidates. يجب ألا يكون هناك أكثر من إعداد واحد لكل نوع SafetyCategory. ستحظر واجهة برمجة التطبيقات أي محتوى واستجابات لا تستوفي الحدود الدنيا التي حدّدتها هذه الإعدادات. تلغي هذه القائمة الإعدادات التلقائية لكل SafetyCategory محدّدة في "إعدادات الأمان". في حال عدم توفّر SafetySetting لعنصر SafetyCategory معيّن في القائمة، ستستخدم واجهة برمجة التطبيقات إعداد الأمان التلقائي لهذه الفئة. فئات الضرر HARM_CATEGORY_HATE_SPEECH وHARM_CATEGORY_SEXUALLY_EXPLICIT وHARM_CATEGORY_DANGEROUS_CONTENT وHARM_CATEGORY_HARASSMENT متاحة.
systemInstruction

object (Content)

اختياريّ. تعليمات بشأن ضبط النظام من قِبل المطوّر وهي متاحة حاليًا عبر الرسائل النصية فقط.
generationConfig

object (GenerationConfig)

اختياريّ. خيارات الضبط لإنشاء النماذج والنتائج
cachedContent

string

اختياريّ. اسم المحتوى المخزَّن مؤقتًا كسياق لعرض التوقّع. ملاحظة: لا تُستخدم هذه الواجهة إلّا في التخزين المؤقت الصريح، حيث يمكن للمستخدمين التحكّم في التخزين المؤقت (مثل المحتوى المطلوب تخزينه مؤقتًا) والاستفادة من توفير مضمون من التكاليف. تنسيق الملف: cachedContents/{cachedContent}