Batch API

تتيح واجهة Gemini API استخدام واجهات برمجة التطبيقات المجمّعة التي تتيح لك معالجة طلبات متعددة في طلب واحد. لمزيد من التفاصيل، يُرجى الاطّلاع على دليل Batch API.

الطريقة: models.batchGenerateContent

تضيف هذه الطريقة مجموعة من طلبات models.generateContent إلى قائمة الانتظار لمعالجتها على دفعات.

نقطة نهاية

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

مَعلمات المسار

batch.model string

الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.

التنسيق: models/{model} ويكون بالتنسيق التالي: models/{model}.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

الحقول
batch.name string

النتائج فقط. المعرّف. اسم المورد الخاص بالدفعة

التنسيق: batches/{batchId}

batch.displayName string

الحقل مطلوب. اسم هذه المجموعة الذي يحدّده المستخدم

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.

batch.webhookConfig.uris[] string

اختيارية: في حال ضبطها، سيتم استخدام معرّفات الموارد الموحّدة الخاصة بخطافات الويب هذه لأحداث خطافات الويب بدلاً من خطافات الويب المسجّلة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation.

الطريقة: models.asyncBatchEmbedContent

تضيف هذه الطريقة مجموعة من طلبات models.embedContent إلى قائمة الانتظار لمعالجتها على دفعات. لدينا معالج models.batchEmbedContents في GenerativeService، ولكن تمت مزامنته. لذلك، سنسمّي هذا الحقل Async لتجنُّب حدوث أي التباس.

نقطة نهاية

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

مَعلمات المسار

batch.model string

الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.

التنسيق: models/{model} ويكون بالتنسيق التالي: models/{model}.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

الحقول
batch.name string

النتائج فقط. المعرّف. اسم المورد الخاص بالدفعة

التنسيق: batches/{batchId}

batch.displayName string

الحقل مطلوب. اسم هذه المجموعة الذي يحدّده المستخدم

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.

batch.webhookConfig.uris[] string

اختيارية: في حال ضبطها، سيتم استخدام معرّفات الموارد الموحّدة الخاصة بخطافات الويب هذه لأحداث خطافات الويب بدلاً من خطافات الويب المسجّلة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation.

الطريقة: batches.get

تتيح هذه الطريقة الاطّلاع على أحدث حالة لعملية طويلة، ويمكن للعملاء استخدامها للتحقّق من نتيجة العملية على فترات زمنية منتظمة تنصح بها خدمة واجهة برمجة التطبيقات.

نقطة نهاية

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

مَعلمات المسار

name string

يمثّل اسم مورد العملية. ويكون بالتنسيق التالي: batches/{batches}.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation.

الطريقة: batches.list

تدرِج هذه الطريقة العمليات التي تتطابق مع الفلتر المحدّد في الطلب. إذا كان الخادم لا يتيح هذه الطريقة، سيعرض UNIMPLEMENTED.

نقطة نهاية

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

مَعلمات المسار

name string

اسم المورد الرئيسي للعملية ويكون بالتنسيق التالي: batches.

مَعلمات طلب البحث

filter string

فلتر القائمة العادي

pageSize integer

حجم صفحة القائمة العادي

pageToken string

الرمز المميز لصفحة القائمة العادية

returnPartialSuccess boolean

عند ضبط القيمة على 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.

نقطة نهاية

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

مَعلمات المسار

name string

اسم مورد العملية المطلوب إلغاؤها. ويكون بالتنسيق التالي: batches/{batches}.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيكون نص الاستجابة عبارة عن كائن JSON فارغ.

الطريقة: batches.delete

تحذف هذه الطريقة عملية طويلة الأمد. تشير هذه الطريقة إلى أنّ العميل لم يعُد مهتمًا بنتيجة العملية. ولا يؤدي ذلك إلى إلغاء العملية. إذا كان الخادم لا يتيح هذه الطريقة، سيعرض google.rpc.Code.UNIMPLEMENTED.

نقطة نهاية

delete https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

مَعلمات المسار

name string

اسم مورد العملية المطلوب حذفه. ويكون بالتنسيق التالي: batches/{batches}.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيكون نص الاستجابة عبارة عن كائن JSON فارغ.

الطريقة: batches.updateGenerateContentBatch

تعدّل هذه الطريقة مجموعة من طلبات GenerateContent للمعالجة على دفعات.

نقطة نهاية

patch https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

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

مَعلمات المسار

generateContentBatch.name string

النتائج فقط. المعرّف. اسم المورد الخاص بالدفعة

التنسيق: batches/{batchId} ويكون بالتنسيق التالي: batches/{batches}.

مَعلمات طلب البحث

updateMask string (FieldMask format)

اختيارية: قائمة الحقول التي سيتم تعديلها.

هذه قائمة قيم مفصولة بفاصلة لأسماء الحقول المؤهَّلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال GenerateContentBatch.

الحقول
model string

الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.

التنسيق: models/{model}

displayName string

الحقل مطلوب. اسم هذه المجموعة الذي يحدّده المستخدم

inputConfig object (InputConfig)

الحقل مطلوب. إعدادات الإدخال للآلات الافتراضية التي يتم عليها تنفيذ المعالجة على دفعات

priority string (int64 format)

اختيارية: أولوية الدفعة ستتم معالجة الدفعات ذات قيمة الأولوية الأعلى قبل الدفعات ذات قيمة الأولوية الأقل. يُسمح بالقيم السالبة. القيمة التلقائية هي 0.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال GenerateContentBatch.

GenerateContentRequest

طلب إنشاء إكمال من النموذج

الحقول
model string

الحقل مطلوب. اسم 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. ستحظر واجهة برمجة التطبيقات أي محتوى وردود لا تستوفي الحدود التي تحدّدها هذه الإعدادات. تلغي هذه القائمة الإعدادات التلقائية لكل SafetyCategory محدّد في safetySettings. إذا لم يكن هناك SafetySetting لـ SafetyCategory معيّن تم توفيره في القائمة، ستستخدم واجهة برمجة التطبيقات إعداد الأمان التلقائي لهذه الفئة. تتوفّر فئات الضرر HARM_CATEGORY_HATE_SPEECH وHARM_CATEGORY_SEXUALLY_EXPLICIT وHARM_CATEGORY_DANGEROUS_CONTENT وHARM_CATEGORY_HARASSMENT وHARM_CATEGORY_CIVIC_INTEGRITY وHARM_CATEGORY_JAILBREAK. راجِع الدليل للحصول على معلومات مفصّلة حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.

labels map (key: string, value: string)

اختيارية: تصنيفات تتضمّن بيانات وصفية يحدّدها المستخدم للطلب

اختيارية: يجب أن تتّبع التصنيفات متطلبات التصنيفات الموحّدة في السحابة الإلكترونية: - يجب أن تبدأ مفاتيح التصنيفات بحرف. - يجب ألا يزيد طول مفاتيح التصنيفات وقيمها عن 63 حرفًا (نقاط الترميز Unicode)، ويمكن أن تحتوي فقط على أحرف صغيرة وأحرف رقمية وشرطات سفلية وشرطات عادية. - يُسمح باستخدام الأحرف الدولية.

الاستخدام: - معرّفات الأمان من جهات التجميع: استخدِم المفتاح safety_identifier (مثلاً {"safety_identifier": "user_session_123"})

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

systemInstruction object (Content)

اختيارية: وضع المطوّر تعليمات النظام في الوقت الحالي، لا يمكن معالجة سوى النصوص.

generationConfig object (GenerationConfig)

اختيارية: خيارات الإعداد لإنشاء النماذج ومخرجاتها

cachedContent string

اختيارية: اسم المحتوى المخزَّن مؤقتًا لاستخدامه كسياق لعرض التوقّع التنسيق: cachedContents/{cachedContent}

serviceTier enum (ServiceTier)

اختيارية: فئة الخدمة للطلب

store boolean

اختيارية: تضبط هذه السمة سلوك التسجيل لطلب معيّن. في حال ضبط هذا الخيار، تكون له الأولوية على إعدادات التسجيل على مستوى المشروع.

تمثيل JSON 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string,
  "serviceTier": enum (ServiceTier),
  "store": boolean
}

الطريقة: batches.updateEmbedContentBatch

تعدّل هذه الطريقة مجموعة من طلبات EmbedContent لمعالجتها على دفعات.

نقطة نهاية

patch https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

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

مَعلمات المسار

embedContentBatch.name string

النتائج فقط. المعرّف. اسم المورد الخاص بالدفعة

التنسيق: batches/{batchId} ويكون بالتنسيق التالي: batches/{batches}.

مَعلمات طلب البحث

updateMask string (FieldMask format)

اختيارية: قائمة الحقول التي سيتم تعديلها.

هذه قائمة قيم مفصولة بفاصلة لأسماء الحقول المؤهَّلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال EmbedContentBatch.

الحقول
model string

الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال.

التنسيق: models/{model}

displayName string

الحقل مطلوب. اسم هذه المجموعة الذي يحدّده المستخدم

inputConfig object (InputEmbedContentConfig)

الحقل مطلوب. إعدادات الإدخال للآلات الافتراضية التي يتم عليها تنفيذ المعالجة على دفعات

priority string (int64 format)

اختيارية: أولوية الدفعة ستتم معالجة الدفعات ذات قيمة الأولوية الأعلى قبل الدفعات ذات قيمة الأولوية الأقل. يُسمح بالقيم السالبة. القيمة التلقائية هي 0.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال EmbedContentBatch.

EmbedContentRequest

طلب يحتوي على Content لتضمين النموذج

الحقول
model string

الحقل مطلوب. اسم مورد النموذج ويُستخدَم هذا المعرّف كمعرّف للنموذج.

يجب أن يتطابق هذا الاسم مع اسم طراز تم عرضه من خلال الطريقة ListModels.

التنسيق: models/{model}

content object (Content)

الحقل مطلوب. المحتوى المطلوب تضمينه سيتم احتساب الحقول parts.text فقط.

taskType
(deprecated) enum (TaskType)

اختيارية: تم إيقاف هذه السمة نهائيًا: يُرجى استخدام EmbedContentConfig.task_type بدلاً منها. نوع المهمة الاختياري الذي سيتم استخدام التضمينات فيه لا تتوفّر على الطُرز القديمة (models/embedding-001).

title
(deprecated) string

اختيارية: تم إيقاف هذه السمة نهائيًا، يُرجى استخدام EmbedContentConfig.title بدلاً منها. عنوان اختياري للنص لا ينطبق هذا الإعداد إلا عندما تكون قيمة TaskType هي RETRIEVAL_DOCUMENT.

ملاحظة: يؤدي تحديد title لـ RETRIEVAL_DOCUMENT إلى توفير تضمينات ذات جودة أفضل لاسترجاع البيانات.

outputDimensionality
(deprecated) integer

اختيارية: تم إيقافها نهائيًا: يُرجى استخدام EmbedContentConfig.output_dimensionality بدلاً منها. سمة اختيارية مخفَّضة للترميز المتضمّن للناتج. في حال ضبط هذه السمة، يتم اقتطاع القيم الزائدة في التضمين الناتج من النهاية. تتوفّر هذه الميزة على الطُرز الأحدث منذ عام 2024 فقط. لا يمكنك ضبط هذه القيمة في حال استخدام النموذج الأقدم (models/embedding-001).

embedContentConfig object (EmbedContentConfig)

اختيارية: إعدادات طلب EmbedContent

تمثيل JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer,
  "embedContentConfig": {
    object (EmbedContentConfig)
  }
}

مورد REST: ‏ batches

المورد: العملية

يمثّل هذا المورد عملية طويلة ناتجة عن طلب بيانات من واجهة برمجة التطبيقات من الشبكة.

الحقول
name string

هو الاسم الذي يُعيّنه الخادم، ويكون فريدًا فقط ضمن الخدمة نفسها التي أرسلت الاسم في الاستجابة. إذا كنت تستخدم أسلوب ربط HTTP التلقائي، يجب أن يكون حقل name اسم مورد ينتهي بالشكل التالي: operations/{unique_id}.

metadata object

يشير الحقل إلى بيانات وصفية خاصة بالخدمة ومرتبطة بالعملية. يتضمّن عادةً معلومات حول مستوى تقدّم العملية وبيانات وصفية شائعة مثل وقت الإنشاء. يُرجى الِعلم أنّ بعض الخدمات قد لا توفّر هذه البيانات. إذا أدّى إجراء ما إلى بدء عملية طويلة، يجب أن يوثّق نوع البيانات الوصفية، إن وُجدِت.

هو كائن يحتوي على حقول من أي نوع، بالإضافة إلى حقل "@type" الذي يتضمّن معرف موارد منتظم (URI) يحدّد نوع الكائن، مثل { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

إذا كانت القيمة false، هذا يعني أنّ العملية ما زالت قيد التنفيذ. أما إذا كانت true، فهذا يعني أنّ العملية اكتملت، ويمكن عندها الوصول إلى error أو response.

result Union type
تمثّل نتيجة العملية، والتي يمكن أن تكون إما error أو response صالحة. إذا كان false ‏ == done، هذا يعني أنّه لم يتم ضبط أي من error أو response. إذا كان true ‏ == done، هذا يعني أنّه يمكن ضبط إما error أو response فقط. قد لا توفّر بعض الخدمات النتيجة. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
error object (Status)

يمثّل نتيجة الخطأ للعملية في حال فشلها أو إلغائها.

response object

يشير هذا الحقل إلى الاستجابة المعتادة إذا كانت العملية ناجحة. إذا كان الإجراء الأصلي لا يعرض أي بيانات عند نجاحه، مثل 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
}

GenerateContentBatch

مورد يمثّل مجموعة من طلبات GenerateContent

الحقول
model string

الحقل مطلوب. اسم Model المطلوب استخدامه لإنشاء الإكمال

التنسيق: models/{model}

name string

النتائج فقط. المعرّف. اسم المورد الخاص بالدفعة

التنسيق: batches/{batchId}

displayName string

الحقل مطلوب. اسم هذه المجموعة الذي يحدّده المستخدم

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
الحقل مطلوب. تمثّل هذه السمة مصدر الإدخال. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
fileName string

اسم 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.

الحقول
output Union type
ناتج طلب الدفعة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
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)

النتائج فقط. البيانات الوصفية المرتبطة بالطلب

output Union type
ناتج الطلب في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
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)

النتائج فقط. عدد الطلبات التي تمت معالجتها بنجاح

failedRequestCount string (int64 format)

النتائج فقط. عدد الطلبات التي تعذّر معالجتها.

pendingRequestCount string (int64 format)

النتائج فقط. عدد الطلبات التي لا تزال في انتظار المعالجة

تمثيل JSON 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

تمثّل هذه السمة حالة الدُفعة.

عمليات التعداد
BATCH_STATE_UNSPECIFIED حالة الدفعة غير محدّدة.
BATCH_STATE_PENDING تستعد الخدمة لتشغيل المجموعة.
BATCH_STATE_RUNNING الدفعة قيد التنفيذ.
BATCH_STATE_SUCCEEDED اكتملت المجموعة بنجاح.
BATCH_STATE_FAILED تعذّر تنفيذ الدفعة.
BATCH_STATE_CANCELLED تم إلغاء الدفعة.
BATCH_STATE_EXPIRED انتهت صلاحية الدفعة.

ServiceTier

فئة الخدمة للطلب

عمليات التعداد
unspecified فئة الخدمة التلقائية، وهي الفئة العادية
standard فئة الخدمة العادية
flex فئة خدمة Flex
priority فئة الخدمة ذات الأولوية