روش: tunedModels.generateContent
پاسخی را از مدل با یک ورودی GenerateContentRequest
ایجاد می کند.
قابلیت های ورودی بین مدل ها از جمله مدل های تنظیم شده متفاوت است. برای جزئیات به راهنمای مدل و راهنمای تنظیم مراجعه کنید.
نقطه پایانی
پستhttps://generativelanguage.googleapis.com/v1beta/{model=tunedModels/*}:generateContent
پارامترهای مسیر
string
model
ضروری. نام Model
که برای ایجاد تکمیل استفاده می شود.
قالب: name=models/{model}
. به شکل tunedModels/{tunedmodel}
است.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
contents[]
object ( Content
)
ضروری. محتوای گفتگوی فعلی با مدل.
برای پرس و جوهای تک نوبتی، این یک نمونه است. برای پرس و جوهای چند نوبتی، این یک فیلد تکراری است که حاوی تاریخچه مکالمه + آخرین درخواست است.
tools[]
object ( Tool
)
اختیاری. فهرستی از Tools
مدل ممکن است برای ایجاد پاسخ بعدی استفاده کند.
Tool
قطعه ای از کد است که سیستم را قادر می سازد تا با سیستم های خارجی برای انجام یک عمل یا مجموعه ای از اقدامات خارج از دانش و محدوده مدل تعامل داشته باشد. تنها ابزار پشتیبانی شده در حال حاضر Function
است.
toolConfig
object ( ToolConfig
)
اختیاری. پیکربندی ابزار برای هر Tool
که در درخواست مشخص شده است.
safetySettings[]
object ( SafetySetting
)
اختیاری. فهرستی از نمونههای SafetySetting
منحصر به فرد برای مسدود کردن محتوای ناامن.
این در GenerateContentRequest.contents
و GenerateContentResponse.candidates
اعمال خواهد شد. برای هر نوع SafetyCategory
نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که نتواند آستانه تعیین شده توسط این تنظیمات را برآورده کند مسدود می کند. این فهرست تنظیمات پیشفرض را برای هر SafetyCategory
مشخصشده در تنظیمات ایمنی لغو میکند. اگر هیچ SafetySetting
برای یک SafetyCategory
معین در لیست ارائه نشده باشد، API از تنظیمات ایمنی پیشفرض برای آن دسته استفاده میکند. دستههای آسیب 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}
درخواست نمونه
متن
پایتون
Node.js
کاتلین
سریع
دارت
جاوا
تصویر
پایتون
Node.js
کاتلین
سریع
دارت
جاوا
سمعی
پایتون
Node.js
ویدئو
پایتون
Node.js
چت کنید
پایتون
Node.js
پوسته
کاتلین
سریع
دارت
جاوا
حافظه پنهان
پایتون
Node.js
مدل کوک شده
پایتون
حالت JSON
پایتون
Node.js
کاتلین
سریع
دارت
جاوا
اجرای کد
پایتون
کاتلین
جاوا
فراخوانی تابع
پایتون
Node.js
کاتلین
سریع
دارت
جاوا
پیکربندی نسل
پایتون
Node.js
پوسته
کاتلین
سریع
دارت
جاوا
تنظیمات ایمنی
پایتون
Node.js
پوسته
کاتلین
سریع
دارت
جاوا
دستورالعمل سیستم
پایتون
Node.js
کاتلین
سریع
دارت
جاوا
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از GenerateContentResponse
است.
روش: tunedModels.create
یک مدل تنظیم شده ایجاد می کند. پیشرفت تنظیم متوسط (در صورت وجود) از طریق سرویس google.longrunning.Operations
قابل دسترسی است.
وضعیت و نتایج از طریق سرویس عملیات قابل دسترسی است. مثال: GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222
نقطه پایانی
پستhttps://generativelanguage.googleapis.com/v1beta/tunedModels
پارامترهای پرس و جو
string
tunedModelId
اختیاری. شناسه منحصر به فرد برای مدل تنظیم شده در صورت مشخص شدن. این مقدار باید حداکثر 40 کاراکتر باشد، اولین کاراکتر باید یک حرف باشد، آخرین کاراکتر می تواند یک حرف یا یک عدد باشد. شناسه باید با عبارت منظم مطابقت داشته باشد: az ?.
درخواست بدن
بدنه درخواست شامل یک نمونه از TunedModel
است.
درخواست نمونه
پایتون
بدن پاسخگو
این منبع یک عملیات طولانی مدت را نشان می دهد که نتیجه تماس API شبکه است.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
string
name
نام اختصاص داده شده به سرور، که فقط در همان سرویسی که در ابتدا آن را برمی گرداند منحصر به فرد است. اگر از نگاشت پیشفرض HTTP استفاده میکنید، name
باید یک نام منبع باشد که با operations/{unique_id}
ختم میشود.
object
metadata
فراداده خاص سرویس مرتبط با عملیات. معمولاً حاوی اطلاعات پیشرفت و ابرداده های رایج مانند زمان ایجاد است. برخی از خدمات ممکن است چنین متادیتا را ارائه ندهند. هر روشی که عملیات طولانیمدت را برمیگرداند، در صورت وجود، باید نوع ابرداده را مستند کند.
یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type"
حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }
.
boolean
done
اگر مقدار false
باشد، به این معنی است که عملیات هنوز در حال انجام است. اگر true
، عملیات تکمیل شده و error
یا response
در دسترس است.
result
میدان اتحادیه نتیجه عملیات، که می تواند یک error
یا یک response
معتبر باشد. اگر done
== false
، نه error
و نه response
تنظیم می شود. اگر done
== true
، دقیقاً یکی از error
یا response
را می توان تنظیم کرد. برخی از خدمات ممکن است نتیجه را ارائه نکنند. result
می تواند تنها یکی از موارد زیر باشد:error
object ( Status
)
نتیجه خطای عملیات در صورت خرابی یا لغو.
object
response
پاسخ عادی و موفقیت آمیز عمل. اگر روش اصلی هیچ دادهای را در مورد موفقیت بازگرداند، مانند Delete
، پاسخ google.protobuf.Empty
است. اگر روش اصلی استاندارد Get
/ Create
/ Update
باشد، پاسخ باید منبع باشد. برای روشهای دیگر، پاسخ باید دارای نوع XxxResponse
باشد که Xxx
نام روش اصلی است. به عنوان مثال، اگر نام متد اصلی TakeSnapshot()
باشد، نوع پاسخ استنباط شده TakeSnapshotResponse
است.
یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type"
حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }
.
نمایندگی JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
روش: tunedModels.get
اطلاعاتی در مورد یک TunedModel خاص دریافت می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}
را دریافت کنیدپارامترهای مسیر
string
name
ضروری. نام منبع مدل
قالب: tunedModels/my-model-id
به شکل tunedModels/{tunedmodel}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از TunedModel
است.
روش: tunedModels.list
مدل های تنظیم شده متعلق به کاربر را لیست می کند.
نقطه پایانی
https://generativelanguage.googleapis.com/v1beta/tunedModels
را دریافت کنیدپارامترهای پرس و جو
pageSize
integer
اختیاری. حداکثر تعداد TunedModels
برای بازگشت (در هر صفحه). این سرویس ممکن است مدل های تنظیم شده کمتری را برگرداند.
در صورت نامشخص، حداکثر 10 مدل تیون شده عودت داده می شود. این روش حداکثر 1000 مدل را در هر صفحه برمی گرداند، حتی اگر یک pageSize بزرگتر را ارسال کنید.
string
pageToken
اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی tunedModels.list
.
pageToken
که توسط یک درخواست بازگردانده شده است به عنوان آرگومان برای درخواست بعدی برای بازیابی صفحه بعدی ارائه دهید.
هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به tunedModels.list
باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.
string
filter
اختیاری. فیلتر یک جستجوی متن کامل بر روی توضیحات و نام نمایشی مدل تنظیم شده است. بهطور پیشفرض، نتایج شامل مدلهای تنظیمشده به اشتراکگذاشتهشده با همه نمیشود.
اپراتورهای اضافی: - مالک: من - نویسندگان: من - خوانندگان: من - خوانندگان: همه
مثالها: «owner:me» همه مدلهای تنظیمشدهای را که تماسگیرنده نقش مالک دارد، برمیگرداند «خوانندگان: من» همه مدلهای تنظیمشدهای را که تماسگیرنده نقش خواننده دارند، «خوانندگان: همه» همه مدلهای تنظیمشده را که با همه به اشتراک گذاشته شده است، برمیگرداند.
درخواست بدن
بدنه درخواست باید خالی باشد.
درخواست نمونه
پایتون
بدن پاسخگو
پاسخی از tunedModels.list
حاوی فهرست صفحهبندیشده مدلها.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
tunedModels[]
object ( TunedModel
)
مدل های برگشتی
string
nextPageToken
یک نشانه، که می تواند به عنوان pageToken
برای بازیابی صفحه بعدی ارسال شود.
اگر این قسمت حذف شود، صفحه دیگری وجود ندارد.
نمایندگی JSON |
---|
{
"tunedModels": [
{
object ( |
روش: tunedModels.patch
یک مدل تنظیم شده را به روز می کند.
نقطه پایانی
پچhttps://generativelanguage.googleapis.com/v1beta/{tunedModel.name=tunedModels/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{tunedModel.name=tunedModels/*}
پارامترهای مسیر
string
tunedModel.name
فقط خروجی نام مدل تنظیم شده. یک نام منحصر به فرد در ایجاد ایجاد می شود. مثال: tunedModels/az2mb0bpw6i
اگر displayName روی ایجاد تنظیم شده باشد، قسمت id نام با به هم پیوستن کلمات displayName با خط فاصله و افزودن یک بخش تصادفی برای منحصربهفرد بودن تنظیم میشود. مثال: displayName = "Sentence Translator" name = "tunedModels/sentence-translator-u3b7m" به شکل tunedModels/{tunedmodel}
است.
پارامترهای پرس و جو
updateMask
string ( FieldMask
format)
ضروری. لیست فیلدهایی که باید به روز شوند.
این فهرستی از نامهای فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo"
.
درخواست بدن
بدنه درخواست شامل یک نمونه از TunedModel
است.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از TunedModel
است.
روش: tunedModels.delete
یک مدل تنظیم شده را حذف می کند.
نقطه پایانی
حذفhttps://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}
پارامترهای مسیر
string
name
ضروری. نام منبع مدل قالب: tunedModels/my-model-id
به شکل tunedModels/{tunedmodel}
است.
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
منبع REST: tunedModels
- منبع: TunedModel
- TunedModelSource
- حالت
- TuningTask
- TuningSnapshot
- مجموعه داده
- نمونه های تنظیم
- نمونه تنظیم
- فراپارامترها
- مواد و روش ها
منبع: TunedModel
یک مدل تنظیم شده با استفاده از ModelService.CreateTunedModel ایجاد شده است.
نمایندگی JSON |
---|
{ "name": string, "displayName": string, "description": string, "state": enum ( |
string
name
فقط خروجی نام مدل تنظیم شده. یک نام منحصر به فرد در ایجاد ایجاد می شود. مثال: tunedModels/az2mb0bpw6i
اگر displayName روی ایجاد تنظیم شده باشد، قسمت id نام با به هم پیوستن کلمات displayName با خط فاصله و افزودن یک بخش تصادفی برای منحصربهفرد بودن تنظیم میشود. مثال: displayName = "Sentence Translator" name = "tunedModels/sentence-translator-u3b7m"
string
displayName
اختیاری. نامی که برای این مدل در رابط های کاربری نمایش داده می شود. نام نمایشی باید حداکثر 40 کاراکتر از جمله فاصله باشد.
string
description
اختیاری. توضیح کوتاهی در مورد این مدل
state
enum ( State
)
فقط خروجی وضعیت مدل تنظیم شده.
createTime
string ( Timestamp
format)
فقط خروجی مهر زمانی که این مدل ایجاد شد.
یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
updateTime
string ( Timestamp
format)
فقط خروجی مهر زمانی که این مدل به روز شد.
یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
tuningTask
object ( TuningTask
)
ضروری. وظیفه تنظیم که مدل کوک شده را ایجاد می کند.
source_model
فیلد اتحادیه. مدلی که به عنوان نقطه شروع برای تنظیم استفاده می شود. source_model
تنها می تواند یکی از موارد زیر باشد: tunedModelSource
object ( TunedModelSource
)
اختیاری. از TunedModel به عنوان نقطه شروع برای آموزش مدل جدید استفاده کنید.
string
baseModel
تغییرناپذیر. نام Model
برای کوک کردن. مثال: models/text-bison-001
number
temperature
اختیاری. تصادفی بودن خروجی را کنترل می کند.
مقادیر می توانند بیش از [0.0,1.0]
، شامل محدوده باشند. یک مقدار نزدیک به 1.0
پاسخ هایی را ایجاد می کند که متنوع تر هستند، در حالی که مقدار نزدیک به 0.0
معمولاً منجر به پاسخ های شگفت انگیز کمتری از مدل می شود.
این مقدار پیشفرض را مشخص میکند که مدل پایه هنگام ایجاد مدل استفاده میکند.
number
topP
اختیاری. برای نمونه برداری هسته
نمونه برداری هسته کوچکترین مجموعه ای از نشانه ها را در نظر می گیرد که مجموع احتمال آنها حداقل topP
باشد.
این مقدار پیشفرض را مشخص میکند که مدل پایه هنگام ایجاد مدل استفاده میکند.
topK
integer
اختیاری. برای نمونه گیری Top-k.
نمونه گیری Top-k مجموعه ای از محتمل ترین توکن های topK
را در نظر می گیرد. این مقدار پیشفرض را مشخص میکند که در هنگام برقراری تماس با مدل توسط backend استفاده شود.
این مقدار پیشفرض را مشخص میکند که مدل پایه هنگام ایجاد مدل استفاده میکند.
TunedModelSource
مدل تیون شده به عنوان منبعی برای آموزش مدل جدید.
نمایندگی JSON |
---|
{ "tunedModel": string, "baseModel": string } |
string
tunedModel
تغییرناپذیر. نام TunedModel
برای استفاده به عنوان نقطه شروع برای آموزش مدل جدید. مثال: tunedModels/my-tuned-model
string
baseModel
فقط خروجی نام Model
پایه این TunedModel
از آن تنظیم شده است. مثال: models/text-bison-001
حالت
وضعیت مدل تنظیم شده.
Enums | |
---|---|
STATE_UNSPECIFIED | مقدار پیش فرض این مقدار استفاده نشده است. |
CREATING | مدل در حال ایجاد است. |
ACTIVE | مدل آماده استفاده است. |
FAILED | مدل ایجاد نشد. |
TuningTask
کارهای تنظیمی که مدل های تنظیم شده ایجاد می کنند.
نمایندگی JSON |
---|
{ "startTime": string, "completeTime": string, "snapshots": [ { object ( |
startTime
string ( Timestamp
format)
فقط خروجی مهر زمانی که تنظیم این مدل شروع شد.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
completeTime
string ( Timestamp
format)
فقط خروجی مهر زمانی هنگام تنظیم این مدل تکمیل شد.
مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
snapshots[]
object ( TuningSnapshot
)
فقط خروجی معیارهای جمع آوری شده در طول تنظیم.
trainingData
object ( Dataset
)
ضروری. فقط ورودی تغییرناپذیر. داده های آموزش مدل
hyperparameters
object ( Hyperparameters
)
تغییرناپذیر. فراپارامترهایی که فرآیند تنظیم را کنترل می کنند. در صورت عدم ارائه، از مقادیر پیش فرض استفاده خواهد شد.
TuningSnapshot
برای یک مرحله کوک ضبط کنید.
نمایندگی JSON |
---|
{ "step": integer, "epoch": integer, "meanLoss": number, "computeTime": string } |
step
integer
فقط خروجی مرحله تنظیم.
integer
epoch
فقط خروجی دوره ای که این مرحله بخشی از آن بود.
meanLoss
number
فقط خروجی میانگین از دست دادن مثال های آموزشی برای این مرحله.
computeTime
string ( Timestamp
format)
فقط خروجی مهر زمانی که این متریک محاسبه شد.
یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثالها: "2014-10-02T15:01:23Z"
و "2014-10-02T15:01:23.045123456Z"
.
مجموعه داده
مجموعه داده برای آموزش یا اعتبار سنجی
نمایندگی JSON |
---|
{ // Union field |
dataset
فیلد اتحادیه داده های درون خطی یا ارجاع به داده ها. dataset
می تواند تنها یکی از موارد زیر باشد:examples
object ( TuningExamples
)
اختیاری. نمونه های درون خطی
نمونه های تنظیم
مجموعه ای از نمونه های تنظیم. می تواند داده های آموزشی یا اعتبار سنجی باشد.
نمایندگی JSON |
---|
{
"examples": [
{
object ( |
examples[]
object ( TuningExample
)
ضروری. نمونه ها ورودی مثال می تواند برای متن یا بحث باشد، اما همه مثال ها در یک مجموعه باید از یک نوع باشند.
نمونه تنظیم
یک مثال واحد برای تنظیم.
نمایندگی JSON |
---|
{ "output": string, // Union field |
string
output
ضروری. خروجی مدل مورد انتظار
model_input
. ورودی مدل برای این مثال. model_input
فقط می تواند یکی از موارد زیر باشد:string
textInput
اختیاری. ورودی مدل متن
فراپارامترها
فراپارامترهایی که فرآیند تنظیم را کنترل می کنند. در https://ai.google.dev/docs/model_tuning_guidance بیشتر بخوانید
نمایندگی JSON |
---|
{ // Union field |
learning_rate_option
فیلد اتحادیه . گزینه هایی برای تعیین میزان یادگیری در طول تنظیم. learning_rate_option
تنها می تواند یکی از موارد زیر باشد: number
learningRate
اختیاری. تغییرناپذیر. فراپارامتر نرخ یادگیری برای تنظیم. اگر تنظیم نشود، پیش فرض 0.001 یا 0.0002 بر اساس تعداد نمونه های آموزشی محاسبه می شود.
learningRateMultiplier
number
اختیاری. تغییرناپذیر. ضریب نرخ یادگیری برای محاسبه نرخ یادگیری نهایی بر اساس مقدار پیش فرض (توصیه شده) استفاده می شود. نرخ یادگیری واقعی:= LearnRateMultiplier * نرخ یادگیری پیشفرض نرخ یادگیری پیشفرض به مدل پایه و اندازه مجموعه بستگی دارد. اگر تنظیم نشود، پیش فرض 1.0 استفاده خواهد شد.
epochCount
integer
تغییرناپذیر. تعداد دوره های آموزشی یک دوره یک گذر از داده های آموزشی است. اگر تنظیم نشده باشد، پیش فرض 5 استفاده خواهد شد.
batchSize
integer
تغییرناپذیر. فراپارامتر اندازه دسته برای تنظیم. اگر تنظیم نشده باشد، بر اساس تعداد نمونه های آموزشی، از 4 یا 16 پیش فرض استفاده می شود.