Method: models.generateText

یک پاسخ از مدل با یک پیام ورودی ایجاد می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
model

string

ضروری. نام Model یا TunedModel که برای ایجاد تکمیل استفاده می شود. مثال‌ها: models/text-bison-001 tunedModels/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 )

ضروری. متن ورودی با فرم آزاد که به عنوان یک اعلان به مدل داده می شود.

با توجه به یک اعلان، مدل یک پاسخ TextCompletion ایجاد می کند که به عنوان تکمیل متن ورودی پیش بینی می کند.

safetySettings[]

object ( SafetySetting )

اختیاری. فهرستی از نمونه‌های SafetySetting منحصر به فرد برای مسدود کردن محتوای ناامن.

که در GenerateTextRequest.prompt و GenerateTextResponse.candidates اجرا می شود. برای هر نوع SafetyCategory نباید بیش از یک تنظیم وجود داشته باشد. API هرگونه درخواست و پاسخی را که نتواند آستانه های تعیین شده توسط این تنظیمات را برآورده کند، مسدود می کند. این فهرست تنظیمات پیش‌فرض را برای هر SafetyCategory مشخص‌شده در تنظیمات ایمنی لغو می‌کند. اگر هیچ SafetySetting برای یک SafetyCategory معین در لیست ارائه نشده باشد، API از تنظیمات ایمنی پیش‌فرض برای آن دسته استفاده می‌کند. دسته‌های آسیب HARM_CATEGORY_DEROGATORY، HARM_CATEGORY_TOXICITY، HARM_CATEGORY_VIOLENCE، HARM_CATEGORY_SEXUAL، HARM_CATEGORY_MEDICAL، HARM_CATEGORY_DANGEROUS در سرویس متن پشتیبانی می‌شوند.

stopSequences[]

string

مجموعه ای از دنباله های کاراکتر (تا 5) که تولید خروجی را متوقف می کند. اگر مشخص شود، API در اولین ظاهر یک توالی توقف متوقف خواهد شد. توالی توقف به عنوان بخشی از پاسخ درج نخواهد شد.

temperature

number

اختیاری. تصادفی بودن خروجی را کنترل می کند. توجه: مقدار پیش‌فرض براساس مدل متفاوت است، به ویژگی Model.temperature Model که تابع getModel برگردانده است، مراجعه کنید.

مقادیر می توانند از [0.0،1.0]، شامل متغیر باشند. یک مقدار نزدیکتر به 1.0 پاسخ‌هایی را تولید می‌کند که متنوع‌تر و خلاقانه‌تر هستند، در حالی که مقدار نزدیک‌تر به 0.0 معمولاً منجر به پاسخ‌های ساده‌تر از مدل می‌شود.

candidateCount

integer

اختیاری. تعداد پاسخ های تولید شده برای بازگشت.

این مقدار باید بین [1، 8]، شامل باشد. اگر تنظیم نشود، به طور پیش‌فرض روی ۱ خواهد بود.

maxOutputTokens

integer

اختیاری. حداکثر تعداد نشانه هایی که باید در یک نامزد گنجانده شود.

اگر تنظیم نشود، به طور پیش‌فرض روی outputTokenLimit مشخص شده در مشخصات Model خواهد بود.

topP

number

اختیاری. حداکثر احتمال تجمعی نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شوند.

این مدل از نمونه برداری ترکیبی Top-k و هسته استفاده می کند.

توکن ها بر اساس احتمالات اختصاص داده شده مرتب می شوند تا فقط محتمل ترین توکن ها در نظر گرفته شوند. نمونه‌برداری Top-k مستقیماً حداکثر تعداد توکن‌های مورد نظر را محدود می‌کند، در حالی که نمونه‌برداری هسته‌ای تعداد توکن‌ها را بر اساس احتمال تجمعی محدود می‌کند.

توجه: مقدار پیش‌فرض براساس مدل متفاوت است، به ویژگی Model.top_p از Model که تابع getModel برگردانده است، نگاه کنید.

topK

integer

اختیاری. حداکثر تعداد نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شود.

این مدل از نمونه برداری ترکیبی Top-k و هسته استفاده می کند.

نمونه گیری Top-k مجموعه ای از محتمل ترین توکن های 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.