Method: models.generateMessage

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

درخواست HTTP

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

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

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

مولفه های
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

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

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

نمونه برداری هسته کوچکترین مجموعه ای از نشانه ها را در نظر می گیرد که مجموع احتمال آنها حداقل topP باشد.

topK

integer

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

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

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

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