Batch API

Gemini API از API های دسته ای پشتیبانی می کند که به شما امکان می دهد چندین درخواست را در یک تماس واحد پردازش کنید. برای جزئیات بیشتر، به راهنمای Batch 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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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)

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

بدن پاسخگو

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

Generate ContentRequest

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

فیلدها
string model

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

قالب: models/{model} .

contents[] object ( Content )

مورد نیاز. محتوای گفتگوی فعلی با مدل.

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

tools[] object ( Tool )

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

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

شی 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، HARM_CATEGORY_CIVIC_INTEGRITY پشتیبانی می‌شوند. برای اطلاعات دقیق در مورد تنظیمات ایمنی موجود به راهنما مراجعه کنید. همچنین به راهنمای ایمنی مراجعه کنید تا یاد بگیرید چگونه ملاحظات ایمنی را در برنامه های هوش مصنوعی خود لحاظ کنید.

شی systemInstruction object ( Content )

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

شی generationConfig object ( GenerationConfig )

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

cachedContent string

اختیاری. نام محتوای ذخیره شده در حافظه پنهان برای استفاده به عنوان زمینه برای ارائه پیش بینی. قالب: 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
}

روش: models.asyncBatchEmbedContent

دسته ای از models.embedContent را برای پردازش دسته ای در صف قرار می دهد. ما یک handler 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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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)

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

بدن پاسخگو

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

EmbedContentRequest

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

فیلدها
string model

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

این نام باید با نام مدلی که با روش models.list برگردانده شده است مطابقت داشته باشد.

قالب: models/{model}

شی content object ( Content )

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

taskType enum ( TaskType )

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

string title

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

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

outputDimensionality integer

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

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

روش: 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

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

pageSize integer

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

string pageToken

نشانه صفحه فهرست استاندارد.

درخواست بدن

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

بدن پاسخگو

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

روش: دسته ای.لغو

لغو ناهمزمان را در یک عملیات طولانی مدت شروع می کند. سرور تمام تلاش خود را برای لغو عملیات انجام می دهد، اما موفقیت تضمین نشده است. اگر سرور از این روش پشتیبانی نمی‌کند، 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 خالی است.

روش: دسته ای حذف کنید

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

نقطه پایانی

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

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

string name

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

درخواست بدن

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

بدن پاسخگو

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

GenerateContentBatch

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

فیلدها
string model

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

قالب: models/{model} .

string name

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

قالب: batches/{batchId} .

string displayName

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

شی inputConfig object ( InputConfig )

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

شی output object ( GenerateContentBatchOutput )

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

رشته createTime string ( Timestamp format)

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

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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)

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

نمایندگی 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
}

InputConfig

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

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

نام File حاوی درخواست های ورودی.

شی requests object ( InlinedRequests )

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

نمایندگی JSON 
{

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

InlinedRequests

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

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

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

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

InlinedRequest

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

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

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

شیء metadata object ( Struct format)

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

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

GenerateContentBatchOutput

خروجی درخواست دسته ای این در قسمت BatchGenerateContentResponse یا قسمت GenerateContentBatch.output برگردانده می شود.

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

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

شیء inlinedResponses object ( InlinedResponses )

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

نمایندگی JSON 
{

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

InlinedResponses

پاسخ به درخواست های دسته ای

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

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

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

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
}

BatchStats

آمار در مورد دسته

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

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

رشته successfulRequestCount string ( int64 format)

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

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

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

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

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

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

EmbedContentBatch

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

فیلدها
string model

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

قالب: models/{model} .

string name

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

قالب: batches/{batchId} .

string displayName

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

شیء inputConfig object ( InputEmbedContentConfig )

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

شی output object ( EmbedContentBatchOutput )

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

رشته createTime string ( Timestamp format)

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

از RFC 3339 استفاده می کند، که در آن خروجی تولید شده همیشه با Z نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "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 نرمال می شود و از 0، 3، 6 یا 9 رقم کسری استفاده می کند. افست های غیر از "Z" نیز پذیرفته می شود. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

شیء batchStats object ( EmbedContentBatchStats )

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

فهرست state enum ( BatchState )

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

رشته priority string ( int64 format)

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

نمایندگی JSON 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputEmbedContentConfig)
  },
  "output": {
    object (EmbedContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (EmbedContentBatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputEmbedContentConfig

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

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

نام File حاوی درخواست های ورودی.

شی requests object ( InlinedEmbedContentRequests )

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

نمایندگی JSON 
{

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

InlinedEmbedContentRequests

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

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

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

نمایندگی JSON 
{
  "requests": [
    {
      object (InlinedEmbedContentRequest)
    }
  ]
}

InlinedEmbedContentRequest

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

فیلدها
شی request object ( EmbedContentRequest )

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

شیء metadata object ( Struct format)

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

نمایندگی JSON 
{
  "request": {
    object (EmbedContentRequest)
  },
  "metadata": {
    object
  }
}

EmbedContentBatchOutput

خروجی درخواست دسته ای این در قسمت AsyncBatchEmbedContentResponse یا قسمت EmbedContentBatch.output برگردانده می شود.

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

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

شی inlinedResponses object ( InlinedEmbedContentResponses )

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

نمایندگی JSON 
{

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

InlinedEmbedContentResponses

پاسخ به درخواست های دسته ای

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

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

نمایندگی JSON 
{
  "inlinedResponses": [
    {
      object (InlinedEmbedContentResponse)
    }
  ]
}

InlinedEmbedContentResponse

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

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

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

Union type output
خروجی درخواست output می تواند تنها یکی از موارد زیر باشد:
موضوع error object ( Status )

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

شی response object ( EmbedContentResponse )

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

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

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

EmbedContentBatchStats

آمار در مورد دسته

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

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

رشته successfulRequestCount string ( int64 format)

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

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

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

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

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

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

BatchState

وضعیت دسته.

Enums
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 باشد، پاسخ باید منبع باشد. برای روش‌های دیگر، پاسخ باید دارای نوع 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
}