یک پاسخ از مدل با یک پیام ورودی ایجاد می کند.
درخواست HTTP
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
model | ضروری. نام |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "prompt": { object ( |
زمینه های | |
---|---|
prompt | ضروری. متن ورودی با فرم آزاد که به عنوان یک اعلان به مدل داده می شود. با توجه به یک اعلان، مدل یک پاسخ TextCompletion ایجاد می کند که به عنوان تکمیل متن ورودی پیش بینی می کند. |
safetySettings[] | اختیاری. فهرستی از نمونههای که در |
stopSequences[] | مجموعه ای از دنباله های کاراکتر (تا 5) که تولید خروجی را متوقف می کند. اگر مشخص شود، API در اولین ظاهر یک توالی توقف متوقف خواهد شد. توالی توقف به عنوان بخشی از پاسخ درج نخواهد شد. |
temperature | اختیاری. تصادفی بودن خروجی را کنترل می کند. توجه: مقدار پیشفرض براساس مدل متفاوت است، به ویژگی مقادیر می توانند از [0.0،1.0]، شامل متغیر باشند. یک مقدار نزدیکتر به 1.0 پاسخهایی را تولید میکند که متنوعتر و خلاقانهتر هستند، در حالی که مقدار نزدیکتر به 0.0 معمولاً منجر به پاسخهای سادهتر از مدل میشود. |
candidateCount | اختیاری. تعداد پاسخ های تولید شده برای بازگشت. این مقدار باید بین [1، 8]، شامل باشد. اگر تنظیم نشود، به طور پیشفرض روی ۱ خواهد بود. |
maxOutputTokens | اختیاری. حداکثر تعداد نشانه هایی که باید در یک نامزد گنجانده شود. اگر تنظیم نشود، به طور پیشفرض روی outputTokenLimit مشخص شده در مشخصات |
topP | اختیاری. حداکثر احتمال تجمعی نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شوند. این مدل از نمونه برداری ترکیبی Top-k و هسته استفاده می کند. توکن ها بر اساس احتمالات اختصاص داده شده مرتب می شوند تا فقط محتمل ترین توکن ها در نظر گرفته شوند. نمونهبرداری Top-k مستقیماً حداکثر تعداد توکنهای مورد نظر را محدود میکند، در حالی که نمونهبرداری هستهای تعداد توکنها را بر اساس احتمال تجمعی محدود میکند. توجه: مقدار پیشفرض براساس مدل متفاوت است، به ویژگی |
topK | اختیاری. حداکثر تعداد نشانه هایی که باید در هنگام نمونه گیری در نظر گرفته شود. این مدل از نمونه برداری ترکیبی Top-k و هسته استفاده می کند. نمونه گیری Top-k مجموعه ای از محتمل ترین توکن های توجه: مقدار پیشفرض بر اساس مدل متفاوت است، به ویژگی |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از 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
برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.