Batch API

رابط برنامه‌نویسی Gemini از APIهای دسته‌ای پشتیبانی می‌کند که به شما امکان می‌دهد چندین درخواست را در یک فراخوانی واحد پردازش کنید. برای جزئیات بیشتر، به راهنمای API دسته‌ای مراجعه کنید.

روش: models.batchGenerateContent

دسته‌ای از درخواست‌های models.generateContent را برای پردازش دسته‌ای در صف قرار می‌دهد.

نقطه پایانی

پست https: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:batchGenerateContent

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

string batch.model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} . این قالب به صورت models/{model} است.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

فیلدها
string batch.name

فقط خروجی. شناسه. نام منبع دسته.

قالب: batches/{batchId} .

string batch.displayName

الزامی. نام تعریف‌شده توسط کاربر برای این دسته.

شیء batch.inputConfig object ( InputConfig )

الزامی. پیکربندی ورودی نمونه‌هایی که پردازش دسته‌ای روی آنها انجام می‌شود.

شیء batch.output object ( GenerateContentBatchOutput )

فقط خروجی. خروجی درخواست دسته‌ای.

رشته batch.createTime string ( Timestamp format)

فقط خروجی. زمانی که دسته ایجاد شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته batch.endTime string ( Timestamp format)

فقط خروجی. زمانی که پردازش دسته‌ای تکمیل شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته batch.updateTime string ( Timestamp format)

فقط خروجی. زمانی که دسته آخرین بار به‌روزرسانی شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

شیء batch.batchStats object ( BatchStats )

فقط خروجی. آمار مربوط به دسته.

شمارشی batch.state enum ( BatchState )

فقط خروجی. وضعیت دسته.

رشته batch.priority string ( int64 format)

اختیاری. اولویت دسته. دسته‌هایی با مقدار اولویت بالاتر قبل از دسته‌هایی با مقدار اولویت پایین‌تر پردازش می‌شوند. مقادیر منفی مجاز هستند. پیش‌فرض ۰ است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Operation است.

روش: models.asyncBatchEmbedContent

دسته‌ای از درخواست‌های models.embedContent را برای پردازش دسته‌ای در صف قرار می‌دهد. ما یک هندلر models.batchEmbedContents در GenerativeService داریم، اما همگام‌سازی شده است. بنابراین برای جلوگیری از سردرگمی، نام آن را Async می‌گذاریم.

نقطه پایانی

پست https: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContent

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

string batch.model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} . این قالب به صورت models/{model} است.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

فیلدها
string batch.name

فقط خروجی. شناسه. نام منبع دسته.

قالب: batches/{batchId} .

string batch.displayName

الزامی. نام تعریف‌شده توسط کاربر برای این دسته.

شیء batch.inputConfig object ( InputEmbedContentConfig )

الزامی. پیکربندی ورودی نمونه‌هایی که پردازش دسته‌ای روی آنها انجام می‌شود.

شیء batch.output object ( EmbedContentBatchOutput )

فقط خروجی. خروجی درخواست دسته‌ای.

رشته batch.createTime string ( Timestamp format)

فقط خروجی. زمانی که دسته ایجاد شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته batch.endTime string ( Timestamp format)

فقط خروجی. زمانی که پردازش دسته‌ای تکمیل شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته batch.updateTime string ( Timestamp format)

فقط خروجی. زمانی که دسته آخرین بار به‌روزرسانی شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

شیء batch.batchStats object ( EmbedContentBatchStats )

فقط خروجی. آمار مربوط به دسته.

شمارشی batch.state enum ( BatchState )

فقط خروجی. وضعیت دسته.

رشته batch.priority string ( int64 format)

اختیاری. اولویت دسته. دسته‌هایی با مقدار اولویت بالاتر قبل از دسته‌هایی با مقدار اولویت پایین‌تر پردازش می‌شوند. مقادیر منفی مجاز هستند. پیش‌فرض ۰ است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Operation است.

روش: batches.get

آخرین وضعیت یک عملیات طولانی مدت را دریافت می‌کند. کلاینت‌ها می‌توانند از این متد برای نظرسنجی از نتیجه عملیات در فواصل زمانی توصیه شده توسط سرویس API استفاده کنند.

نقطه پایانی

دریافت https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

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

string name

نام منبع عملیات. به شکل batches/{batches} است.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Operation است.

روش: batches.list

عملیاتی را که با فیلتر مشخص شده در درخواست مطابقت دارند، فهرست می‌کند. اگر سرور از این روش پشتیبانی نکند، مقدار UNIMPLEMENTED برمی‌گرداند.

نقطه پایانی

دریافت https: / /generativelanguage.googleapis.com /v1beta /{name=batches}

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

string name

نام منبع والد عملیات. به شکل batches است.

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

string filter

فیلتر لیست استاندارد.

integer pageSize

اندازه استاندارد صفحه فهرست

string pageToken

توکن استاندارد صفحه لیست.

boolean returnPartialSuccess

وقتی روی true تنظیم شود، عملیاتی که قابل دسترسی هستند به صورت عادی برگردانده می‌شوند و عملیاتی که قابل دسترسی نیستند در فیلد [ListOperationsResponse.unreachable] برگردانده می‌شوند.

این فقط می‌تواند هنگام خواندن بین مجموعه‌ها true باشد، مثلاً وقتی parent روی "projects/example/locations/-" تنظیم شده باشد.

این فیلد به طور پیش‌فرض پشتیبانی نمی‌شود و در صورت تنظیم، منجر به خطای UNIMPLEMENTED خواهد شد، مگر اینکه صراحتاً خلاف آن در مستندات خاص سرویس یا محصول ذکر شده باشد.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از ListOperationsResponse است.

روش: batches.cancel

لغو ناهمزمان را در یک عملیات طولانی مدت شروع می‌کند. سرور تمام تلاش خود را برای لغو عملیات انجام می‌دهد، اما موفقیت تضمین شده نیست. اگر سرور از این روش پشتیبانی نکند، google.rpc.Code.UNIMPLEMENTED را برمی‌گرداند. کلاینت‌ها می‌توانند از Operations.GetOperation یا روش‌های دیگر برای بررسی اینکه آیا لغو موفقیت‌آمیز بوده یا اینکه آیا عملیات با وجود لغو کامل شده است، استفاده کنند. در صورت لغو موفقیت‌آمیز، عملیات حذف نمی‌شود؛ در عوض، به عملیاتی با مقدار Operation.error با google.rpc.Status.code برابر با 1 ، معادل Code.CANCELLED ، تبدیل می‌شود.

نقطه پایانی

پست https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}:cancel

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

string name

نام منبع عملیاتی که باید لغو شود. به شکل batches/{batches} است.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ یک شیء JSON خالی خواهد بود.

روش: batches.delete

یک عملیات طولانی مدت را حذف می‌کند. این متد نشان می‌دهد که کلاینت دیگر علاقه‌ای به نتیجه عملیات ندارد. این متد عملیات را لغو نمی‌کند. اگر سرور از این متد پشتیبانی نکند، google.rpc.Code.UNIMPLEMENTED را برمی‌گرداند.

نقطه پایانی

حذف https: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}

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

string name

نام منبع عملیاتی که قرار است حذف شود. این نام به شکل batches/{batches} است.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ یک شیء JSON خالی خواهد بود.

تولید دسته‌ای محتوا

منبعی که نشان‌دهنده‌ی مجموعه‌ای از درخواست‌های GenerateContent است.

فیلدها
string model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} .

string name

فقط خروجی. شناسه. نام منبع دسته.

قالب: batches/{batchId} .

string displayName

الزامی. نام تعریف‌شده توسط کاربر برای این دسته.

object ( InputConfig ) inputConfig (ورودی پیکربندی)

الزامی. پیکربندی ورودی نمونه‌هایی که پردازش دسته‌ای روی آنها انجام می‌شود.

شیء output object ( GenerateContentBatchOutput )

فقط خروجی. خروجی درخواست دسته‌ای.

رشته‌ی createTime string ( Timestamp format)

فقط خروجی. زمانی که دسته ایجاد شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته endTime string ( Timestamp format)

فقط خروجی. زمانی که پردازش دسته‌ای تکمیل شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

رشته updateTime string ( Timestamp format)

فقط خروجی. زمانی که دسته آخرین بار به‌روزرسانی شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

شیء batchStats object ( BatchStats )

فقط خروجی. آمار مربوط به دسته.

شمارشگر state enum ( BatchState )

فقط خروجی. وضعیت دسته.

رشته priority string ( int64 format)

اختیاری. اولویت دسته. دسته‌هایی با مقدار اولویت بالاتر قبل از دسته‌هایی با مقدار اولویت پایین‌تر پردازش می‌شوند. مقادیر منفی مجاز هستند. پیش‌فرض ۰ است.

نمایش JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

پیکربندی ورودی

ورودی درخواست دسته‌ای را پیکربندی می‌کند.

فیلدها
Union type source اتحادیه
الزامی. منبع ورودی. source می‌تواند فقط یکی از موارد زیر باشد:
string fileName

نام File که شامل درخواست‌های ورودی است.

شیء requests object ( InlinedRequests )

درخواست‌هایی که قرار است در یک دسته پردازش شوند.

نمایش JSON 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

درخواست‌های درون‌خطی

درخواست‌هایی که قرار است در دسته پردازش شوند، در صورتی که به عنوان بخشی از درخواست ایجاد دسته ارائه شده باشند.

فیلدها
شیء requests[] object ( InlinedRequest )

الزامی. درخواست‌هایی که باید در دسته پردازش شوند.

نمایش JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

درخواست درون‌خطی

درخواستی که قرار است در دسته پردازش شود.

فیلدها
شیء request object ( GenerateContentRequest )

الزامی. درخواستی که قرار است در دسته پردازش شود.

شیء metadata object ( Struct format)

اختیاری. فراداده‌ای که قرار است به درخواست مرتبط شود.

نمایش JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

خروجی دسته‌ای محتوا را تولید کنید

خروجی یک درخواست دسته‌ای. این خروجی در BatchGenerateContentResponse یا فیلد GenerateContentBatch.output برگردانده می‌شود.

فیلدها
Union type output اتحادیه
خروجی درخواست دسته‌ای. output می‌تواند فقط یکی از موارد زیر باشد:
string responsesFile

فقط خروجی. شناسه فایل حاوی پاسخ‌ها. این فایل یک فایل JSONL با یک پاسخ در هر خط خواهد بود. پاسخ‌ها پیام‌های GenerateContentResponse با فرمت JSON خواهند بود. پاسخ‌ها به همان ترتیب درخواست‌های ورودی نوشته می‌شوند.

object ( InlinedResponses ) inlinedResponses (پاسخ‌های درون‌خطی)

فقط خروجی. پاسخ‌ها به درخواست‌های موجود در دسته. هنگام ساخت دسته با استفاده از درخواست‌های درون‌خطی، بازگردانده می‌شود. پاسخ‌ها به همان ترتیب درخواست‌های ورودی خواهند بود.

نمایش JSON 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

پاسخ‌های درون‌خطی

پاسخ به درخواست‌های موجود در دسته.

فیلدها
شیء inlinedResponses[] object ( InlinedResponse )

فقط خروجی. پاسخ‌ها به درخواست‌های موجود در دسته.

نمایش JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

پاسخ درون‌خطی

پاسخ به یک درخواست واحد در دسته.

فیلدها
شیء metadata object ( Struct format)

فقط خروجی. فراداده مرتبط با درخواست.

Union type output اتحادیه
خروجی درخواست. output فقط می‌تواند یکی از موارد زیر باشد:
شیء error object ( Status )

فقط خروجی. خطایی که هنگام پردازش درخواست رخ داده است.

شیء response object ( GenerateContentResponse )

فقط خروجی. پاسخ به درخواست.

نمایش JSON 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

آمار دسته‌ای

آمار مربوط به دسته.

فیلدها
رشته requestCount string ( int64 format)

فقط خروجی. تعداد درخواست‌های موجود در دسته.

string ( int64 format) successfulRequestCount (با فرمت int64)

فقط خروجی. تعداد درخواست‌هایی که با موفقیت پردازش شده‌اند.

string ( int64 format) failedRequestCount (با فرمت int64)

فقط خروجی. تعداد درخواست‌هایی که پردازش نشده‌اند.

string ( int64 format) pendingRequestCount (با فرمت int64)

فقط خروجی. تعداد درخواست‌هایی که هنوز در انتظار پردازش هستند.

نمایش JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

روش: batches.updateEmbedContentBatch

دسته‌ای از درخواست‌های EmbedContent را برای پردازش دسته‌ای به‌روزرسانی می‌کند.

نقطه پایانی

وصله https: / /generativelanguage.googleapis.com /v1beta /{embedContentBatch.name=batches /*}:updateEmbedContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

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

string embedContentBatch.name

فقط خروجی. شناسه. نام منبع دسته.

قالب: batches/{batchId} . این تابع به شکل batches/{batches} است.

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

رشته updateMask string ( FieldMask format)

اختیاری. لیست فیلدهایی که باید به‌روزرسانی شوند.

این لیستی از نام‌های کامل فیلدها است که با کاما از هم جدا شده‌اند. مثال: "user.displayName,photo" .

درخواست بدنه

بدنه درخواست شامل نمونه‌ای از EmbedContentBatch است.

فیلدها
string model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} .

string displayName

الزامی. نام تعریف‌شده توسط کاربر برای این دسته.

object ( InputEmbedContentConfig ) inputConfig (ورودی جاسازی‌شده محتوا پیکربندی)

الزامی. پیکربندی ورودی نمونه‌هایی که پردازش دسته‌ای روی آنها انجام می‌شود.

رشته priority string ( int64 format)

اختیاری. اولویت دسته. دسته‌هایی با مقدار اولویت بالاتر قبل از دسته‌هایی با مقدار اولویت پایین‌تر پردازش می‌شوند. مقادیر منفی مجاز هستند. پیش‌فرض ۰ است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از EmbedContentBatch است.

درخواست جاسازی محتوا

درخواستی حاوی Content مدل برای جاسازی.

فیلدها
string model

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

این نام باید با نام مدلی که توسط متد ListModels برگردانده می‌شود، مطابقت داشته باشد.

قالب: models/{model}

شیء content object ( Content )

الزامی. محتوایی که باید جاسازی شود. فقط فیلدهای parts.text شمارش خواهند شد.

شمارشگر taskType enum ( TaskType )

اختیاری. نوع وظیفه‌ای که جاسازی‌ها برای آن استفاده خواهند شد اختیاری است. در مدل‌های قبلی ( models/embedding-001 ) پشتیبانی نمی‌شود.

string title

اختیاری. یک عنوان اختیاری برای متن. فقط زمانی قابل اجرا است که TaskType RETRIEVAL_DOCUMENT باشد.

نکته: تعیین title برای RETRIEVAL_DOCUMENT ، جاسازی‌های با کیفیت‌تری را برای بازیابی فراهم می‌کند.

outputDimensionality integer

اختیاری. ابعاد کاهش‌یافته‌ی اختیاری برای جاسازی خروجی. در صورت تنظیم، مقادیر اضافی در جاسازی خروجی از انتها کوتاه می‌شوند. فقط از سال ۲۰۲۴ توسط مدل‌های جدیدتر پشتیبانی می‌شود. در صورت استفاده از مدل قبلی ( models/embedding-001 ) نمی‌توانید این مقدار را تنظیم کنید.

نمایش JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}

روش: batches.updateGenerateContentBatch

دسته‌ای از درخواست‌های GenerateContent را برای پردازش دسته‌ای به‌روزرسانی می‌کند.

نقطه پایانی

وصله https: / /generativelanguage.googleapis.com /v1beta /{generateContentBatch.name=batches /*}:updateGenerateContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

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

string generateContentBatch.name

فقط خروجی. شناسه. نام منبع دسته.

قالب: batches/{batchId} . این تابع به شکل batches/{batches} است.

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

رشته updateMask string ( FieldMask format)

اختیاری. لیست فیلدهایی که باید به‌روزرسانی شوند.

این لیستی از نام‌های کامل فیلدها است که با کاما از هم جدا شده‌اند. مثال: "user.displayName,photo" .

درخواست بدنه

بدنه درخواست شامل نمونه‌ای از GenerateContentBatch است.

فیلدها
string model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} .

string displayName

الزامی. نام تعریف‌شده توسط کاربر برای این دسته.

object ( InputConfig ) inputConfig (ورودی پیکربندی)

الزامی. پیکربندی ورودی نمونه‌هایی که پردازش دسته‌ای روی آنها انجام می‌شود.

رشته priority string ( int64 format)

اختیاری. اولویت دسته. دسته‌هایی با مقدار اولویت بالاتر قبل از دسته‌هایی با مقدار اولویت پایین‌تر پردازش می‌شوند. مقادیر منفی مجاز هستند. پیش‌فرض ۰ است.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از GenerateContentBatch است.

درخواست تولید محتوا

درخواست ایجاد یک تکمیل از مدل.

فیلدها
string model

الزامی. نام Model که برای تولید تکمیل استفاده می‌شود.

قالب: models/{model} .

contents[] object ( Content )

الزامی. محتوای مکالمه فعلی با مدل.

برای پرس‌وجوهای تک نوبتی، این یک نمونه واحد است. برای پرس‌وجوهای چند نوبتی مانند چت ، این یک فیلد تکراری است که شامل سابقه مکالمه و آخرین درخواست است.

tools[] object ( Tool )

اختیاری. فهرستی از Tools Model ممکن است برای تولید پاسخ بعدی استفاده کند.

یک Tool ، قطعه کدی است که سیستم را قادر می‌سازد تا با سیستم‌های خارجی تعامل داشته باشد تا یک یا مجموعه‌ای از اقدامات را خارج از دانش و محدوده Model انجام دهد. Tool پشتیبانی شده عبارتند از Function و codeExecution . برای کسب اطلاعات بیشتر به راهنماهای فراخوانی تابع ( Function calling) و اجرای کد (Code execution) مراجعه کنید.

شیء toolConfig object ( ToolConfig )

اختیاری. پیکربندی ابزار برای هر Tool که در درخواست مشخص شده است. برای مثال استفاده به راهنمای فراخوانی تابع مراجعه کنید.

شیء safetySettings[] object ( SafetySetting )

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

این مورد روی GenerateContentRequest.contents و GenerateContentResponse.candidates اعمال خواهد شد. برای هر نوع SafetyCategory نباید بیش از یک تنظیم وجود داشته باشد. API هر محتوا و پاسخی را که آستانه‌های تعیین‌شده توسط این تنظیمات را برآورده نکند، مسدود می‌کند. این لیست، تنظیمات پیش‌فرض برای هر SafetyCategory مشخص‌شده در safetySettings را لغو می‌کند. اگر هیچ SafetySetting برای یک SafetyCategory مشخص‌شده در لیست وجود نداشته باشد، API از تنظیم ایمنی پیش‌فرض برای آن دسته استفاده خواهد کرد. دسته‌های آسیب HARM_CATEGORY_HATE_SPEECH، HARM_CATEGORY_SEXUALLY_EXPLICIT، HARM_CATEGORY_DANGEROUS_CONTENT، HARM_CATEGORY_HARASSMENT، HARM_CATEGORY_CIVIC_INTEGRITY پشتیبانی می‌شوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود، به راهنما مراجعه کنید. همچنین برای یادگیری نحوه لحاظ کردن ملاحظات ایمنی در برنامه‌های هوش مصنوعی خود، به راهنمای ایمنی مراجعه کنید.

شیء systemInstruction object ( Content )

اختیاری. دستورالعمل(های) سیستم توسط توسعه‌دهنده تنظیم می‌شود. در حال حاضر، فقط متن.

شیء generationConfig object ( GenerationConfig )

اختیاری. گزینه‌های پیکربندی برای تولید مدل و خروجی‌ها.

string cachedContent

اختیاری. نام محتوای ذخیره شده برای استفاده به عنوان زمینه برای ارائه پیش‌بینی. قالب: cachedContents/{cachedContent}

نمایش JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}

حالت دسته‌ای

وضعیت دسته.

انوم‌ها
BATCH_STATE_UNSPECIFIED وضعیت دسته مشخص نشده است.
BATCH_STATE_PENDING این سرویس در حال آماده‌سازی برای اجرای این بسته است.
BATCH_STATE_RUNNING دسته در حال انجام است.
BATCH_STATE_SUCCEEDED دسته با موفقیت تکمیل شد.
BATCH_STATE_FAILED دسته شکست خورد.
BATCH_STATE_CANCELLED دسته لغو شده است.
BATCH_STATE_EXPIRED تاریخ انقضای دسته تمام شده است.

منبع REST: دسته‌ها

منبع: عملیات

این منبع نشان دهنده یک عملیات طولانی مدت است که نتیجه یک فراخوانی 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 Union type
نتیجه عملیات، که می‌تواند یک error یا یک response معتبر باشد. اگر done == false باشد، نه error و نه response تنظیم نمی‌شوند. اگر done == true ، دقیقاً یکی از error یا response می‌تواند تنظیم شود. برخی از سرویس‌ها ممکن است نتیجه را ارائه ندهند. result فقط می‌تواند یکی از موارد زیر باشد:
شیء error object ( Status )

نتیجه خطای عملیات در صورت عدم موفقیت یا لغو.

object response

پاسخ عادی و موفقیت‌آمیز عملیات. اگر متد اصلی هیچ داده‌ای مانند Delete در صورت موفقیت برنگرداند، پاسخ google.protobuf.Empty خواهد بود. اگر متد اصلی Get / Create / Update استاندارد باشد، پاسخ باید resource باشد. برای متدهای دیگر، پاسخ باید از نوع XxxResponse باشد، که در آن Xxx نام متد اصلی است. به عنوان مثال، اگر نام متد اصلی TakeSnapshot() باشد، نوع پاسخ استنباط شده TakeSnapshotResponse خواهد بود.

یک شیء حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می‌کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

نمایش JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}