Method: models.generateMessage

تنشئ استجابة من النموذج المحدد في الإدخال MessagePrompt.

طلب HTTP

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

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

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

المَعلمات
model

string

مطلوبة. اسم النموذج المراد استخدامه.

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

نص الطلب

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

تمثيل JSON
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
الحقول
prompt

object (MessagePrompt)

مطلوبة. تمثّل هذه السمة الإدخال النصي المنظَّم الذي تم تقديمه للنموذج كطلب.

عند تقديم مطالبة، سيعرض النموذج ما يتنبأ به الرسالة التالية في المناقشة.

temperature

number

اختياريّ. تتحكّم هذه السياسة في التوزيع العشوائي للمخرجات.

يمكن أن تتراوح القيم بين أكثر من [0.0,1.0]، بما في ذلك القيم. والقيمة الأقرب إلى 1.0 ستؤدّي إلى تقديم ردود أكثر تنوعًا، في حين أنّ القيمة الأقرب من 0.0 ستؤدي عادةً إلى ظهور ردود أقل دهشة من النموذج.

candidateCount

integer

اختياريّ. عدد رسائل الرد التي تم إنشاؤها لعرضها.

يجب أن تتراوح هذه القيمة بين [1, 8] كحدّ أقصى. وفي حال ترك هذه السياسة بدون ضبط، سيتم ضبط القيمة التلقائية على 1.

topP

number

اختياريّ. الحد الأقصى للاحتمال التراكمي للرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ العيّنات.

يستخدم النموذج عينة من القيم العليا والنواة معًا.

يراعي عينة النواة أصغر مجموعة من الرموز المميزة التي يكون مجموع احتمالاتها topP على الأقل.

topK

integer

اختياريّ. الحد الأقصى لعدد الرموز المميّزة التي يجب أخذها في الاعتبار عند أخذ عينات.

يستخدم النموذج عينة من القيم العليا والنواة معًا.

يراعي أخذ العينات من الدرجة الأولى مجموعة topK من الرموز المميزة الأكثر احتمالاً.

نص الاستجابة

الرد من النموذج.

ويشمل ذلك رسائل المرشحين وسجلّ المحادثات في شكل رسائل مرتَّبة زمنيًا.

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

تمثيل JSON
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
الحقول
candidates[]

object (Message)

رسائل استجابة المرشح من النموذج.

messages[]

object (Message)

سجلّ المحادثات الذي يستخدمه النموذج.

filters[]

object (ContentFilter)

مجموعة من البيانات الوصفية لفلترة المحتوى لنص الطلب والردّ.

يشير هذا الحقل إلى SafetyCategory التي حظرت مرشحًا من هذا الرد، وأدنى HarmProbability التي أدت إلى حظر، وإعداد HarmThreshold في تلك الفئة.

نطاقات التفويض

يتطلب استخدام أحد نطاقات 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

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