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-normalized وسيستخدم 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-normalized وسيستخدم 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-normalized وسيستخدم 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.

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. راجِع الدليل للحصول على معلومات تفصيلية حول إعدادات الأمان المتاحة. يمكنك أيضًا الرجوع إلى إرشادات الأمان للتعرّف على كيفية تضمين اعتبارات الأمان في تطبيقات الذكاء الاصطناعي.

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 إلى قائمة الانتظار لمعالجتها بشكل مجمّع. لدينا معالج 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-normalized وسيستخدم 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-normalized وسيستخدم 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-normalized وسيستخدم 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 للنموذج المراد تضمينه

الحقول
model string

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

يجب أن يتطابق هذا الاسم مع اسم نموذج يعرضه الأسلوب models.list.

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

content object (Content)

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

taskType enum (TaskType)

اختياريّ. نوع المهمة الاختياري الذي سيتم استخدام التضمينات فيه لا تتوفّر هذه الميزة على الطُرز القديمة (models/embedding-001).

title string

اختياريّ. عنوان اختياري للنص لا يمكن استخدامها إلا عندما تكون قيمة 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

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

نقطة نهاية

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

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

نص الطلب

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال 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 فارغ.

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-normalized وسيستخدم 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-normalized وسيستخدم 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-normalized وسيستخدم 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 إحدى القيم التالية فقط:
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
ناتج طلب الدفعة يمكن أن تكون 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)

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

output Union type
ناتج الطلب يمكن أن تكون 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)

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

failedRequestCount string (int64 format)

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

pendingRequestCount string (int64 format)

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

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

EmbedContentBatch

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

الحقول
model string

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

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

name string

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

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

displayName string

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

inputConfig object (InputEmbedContentConfig)

مطلوب. إدخال إعدادات المثيلات التي يتم إجراء المعالجة المجمّعة عليها

output object (EmbedContentBatchOutput)

النتائج فقط. ناتج طلب الدفعة

createTime string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء الدفعة

يستخدم RFC 3339، حيث سيكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized وسيستخدم 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-normalized وسيستخدم 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-normalized وسيستخدم 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 إحدى القيم التالية فقط:
fileName string

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

الحقول
output Union type
ناتج طلب الدفعة يمكن أن تكون 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)

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

output Union type
ناتج الطلب يمكن أن تكون 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)

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

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 انتهت صلاحية الدفعة.

مورد 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 صالحًا. إذا كان done == false، لم يتم ضبط error ولا response. إذا كان done == true، يمكن ضبط أحد الحقلين error أو response فقط. قد لا تقدّم بعض الخدمات النتيجة. يمكن أن تكون result إحدى القيم التالية فقط:
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
}