Method: models.generateText

تنشئ ردًا من النموذج المعطى لرسالة إدخال.

طلب HTTP

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

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

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

المَعلمات
model

string

مطلوبة. اسم السمة Model أو TunedModel المطلوب استخدامها لإنشاء الإكمال. أمثلة: نماذج/text-bison-001}{001}{rejects/sentence-translator-u3b7m

نص الطلب

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

تمثيل JSON
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
الحقول
prompt

object (TextPrompt)

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

عند تقديم مطالبة، سينشئ النموذج استجابة إكمال النص الذي يتوقّع إكماله للنص المُدخل.

safetySettings[]

object (SafetySetting)

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

والتي سيتم فرضها على GenerateTextRequest.prompt وGenerateTextResponse.candidates يجب ألا يكون هناك أكثر من إعداد واحد لكل نوع SafetyCategory. ستحظر واجهة برمجة التطبيقات أي طلبات وردود لا تستوفي الحدود التي تحدّدها هذه الإعدادات. تلغي هذه القائمة الإعدادات التلقائية لكل SafetyCategory تم تحديدها في إعدادات الأمان. وإذا لم يتوفّر SafetySetting لعنصر SafetyCategory في القائمة، ستستخدِم واجهة برمجة التطبيقات إعداد الأمان التلقائي لهذه الفئة. يُسمح في الخدمة النصية بفئات الضرر HARM_CATEGORY_DEROGATORY وHARM_CATEGORY_TOXICITY وHARM_CATEGORY_VIOLENCE وHARM_CATEGORY_SEXUAL وHARM_CATEGORY_MEDical وHARM_CATEGORY_DANGEROUS.

stopSequences[]

string

مجموعة تسلسلات الأحرف (ما يصل إلى 5) التي ستعمل على إيقاف إنشاء الإخراج وفي حال تحديد ذلك، ستتوقف واجهة برمجة التطبيقات عند أول ظهور لتسلسل الإيقاف. لن يتم تضمين تسلسل الإيقاف كجزء من الاستجابة.

temperature

number

اختياريّ. تتحكّم هذه السياسة في التوزيع العشوائي للمخرجات. ملاحظة: تختلف القيمة التلقائية حسب الطراز. اطّلِع على السمة Model.temperature للدالة Model التي تم عرض الدالة getModel عليها.

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

candidateCount

integer

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

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

maxOutputTokens

integer

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

وفي حال ترك هذه السياسة بدون ضبط، سيتم ضبط الإدخال التلقائي على القيمة exitTokenLimit في مواصفات Model.

topP

number

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

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

يتم تصنيف الرموز المميزة بناءً على الاحتمالات المخصصة لها، بحيث يتم أخذ الرموز المميزة الأكثر احتمالاً في الاعتبار فقط. يؤدي أخذ العينات من الدرجة الأولى إلى الحد مباشرةً من الحد الأقصى لعدد الرموز المميزة التي يجب أخذها في الاعتبار، بينما يحدد أخذ العينات Nucleus عدد الرموز المميزة بناءً على الاحتمال التراكمي.

ملاحظة: تختلف القيمة التلقائية حسب الطراز. اطّلِع على السمة Model.top_p للدالة Model التي تم عرض الدالة getModel عليها.

topK

integer

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

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

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

ملاحظة: تختلف القيمة التلقائية حسب الطراز. اطّلِع على السمة Model.top_k للدالة Model التي تم عرض الدالة getModel عليها.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال GenerateTextResponse.

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

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

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