Batch API

‫Gemini API תומך בממשקי 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}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

Fields
batch.name string

פלט בלבד. מזהה. שם המשאב של הקבוצה.

פורמט: batches/{batchId}

batch.displayName string

חובה. השם שהמשתמש נתן לקבוצה הזו.

batch.inputConfig object (InputConfig)

חובה. הגדרת הקלט של המכונות שבהן מתבצע עיבוד באצ'ים.

batch.output object (GenerateContentBatchOutput)

פלט בלבד. הפלט של בקשת Batch.

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)

פלט בלבד. השעה שבה הסתיים עיבוד ברצף (batch processing).

הפונקציה משתמשת ב-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

אופציונלי. אם מגדירים כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

שיטה: models.asyncBatchEmbedContent

הפונקציה מוסיפה לאצווה קבוצה של models.embedContent בקשות לעיבוד באצווה. יש לנו handler של models.batchEmbedContents ב-GenerativeService, אבל הוא סונכרן. לכן אנחנו נותנים לו את השם Async כדי למנוע בלבול.

נקודת קצה

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

פרמטרים של נתיב

batch.model string

חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.

פורמט: models/{model} הוא מקבל את הצורה models/{model}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

Fields
batch.name string

פלט בלבד. מזהה. שם המשאב של הקבוצה.

פורמט: batches/{batchId}

batch.displayName string

חובה. השם שהמשתמש נתן לקבוצה הזו.

batch.inputConfig object (InputEmbedContentConfig)

חובה. הגדרת הקלט של המכונות שבהן מתבצע עיבוד באצ'ים.

batch.output object (EmbedContentBatchOutput)

פלט בלבד. הפלט של בקשת Batch.

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)

פלט בלבד. השעה שבה הסתיים עיבוד ברצף (batch processing).

הפונקציה משתמשת ב-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

אופציונלי. אם מגדירים כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

שיטה: batches.get

מקבל את המצב העדכני של פעולה ממושכת. לקוחות יכולים להשתמש בשיטה הזו כדי לדגום את תוצאת הפעולה במרווחי זמן לפי ההמלצות של שירות ה-API.

נקודת קצה

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 רק כשקוראים נתונים מכמה אוספים. לדוגמה, כשמגדירים את הערך "projects/example/locations/-" בשדה parent.

השדה הזה לא נתמך כברירת מחדל, ואם הוא מוגדר, תופיע שגיאה 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.

Fields
model string

חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.

פורמט: models/{model}

displayName string

חובה. השם שהמשתמש הגדיר לקבוצה הזו.

inputConfig object (InputConfig)

חובה. הגדרת הקלט של המכונות שבהן מתבצע עיבוד באצ'ים.

priority string (int64 format)

אופציונלי. העדיפות של הקבוצה. המערכת תעבד קבוצות עם ערך עדיפות גבוה יותר לפני קבוצות עם ערך עדיפות נמוך יותר. מותר להשתמש בערכים שליליים. ברירת המחדל היא 0.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של GenerateContentBatch.

GenerateContentRequest

שליחת בקשה למודל ליצור השלמה.

Fields
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. ה-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, ‏ HARM_CATEGORY_JAILBREAK. מידע מפורט על הגדרות הבטיחות הזמינות מופיע במדריך. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI שלכם.

labels map (key: string, value: string)

אופציונלי. תוויות עם מטא-נתונים שהוגדרו על ידי המשתמש לבקשה.

אופציונלי. התוויות צריכות לעמוד בדרישות התוויות המאוחדות הרגילות של Cloud: - המפתחות של התוויות צריכים להתחיל באות. – המפתחות והערכים של התוויות יכולים להכיל עד 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.

Fields
model string

חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.

פורמט: models/{model}

displayName string

חובה. השם שהמשתמש הגדיר לקבוצה הזו.

inputConfig object (InputEmbedContentConfig)

חובה. הגדרת הקלט של המכונות שבהן מתבצע עיבוד באצ'ים.

priority string (int64 format)

אופציונלי. העדיפות של הקבוצה. המערכת תעבד קבוצות עם ערך עדיפות גבוה יותר לפני קבוצות עם ערך עדיפות נמוך יותר. מותר להשתמש בערכים שליליים. ברירת המחדל היא 0.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של EmbedContentBatch.

EmbedContentRequest

בקשה שמכילה את Content של המודל להטמעה.

Fields
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

משאב: פעולה

המשאב הזה מייצג פעולה ממושכת שמוחזרת מקריאות ל-API ברשת.

Fields
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. יכול להיות שחלק מהשירותים לא יספקו את התוצאה. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
error object (Status)

תוצאת השגיאה של הפעולה במקרה של כשל או ביטול.

response object

התגובה הרגילה והמוצלחת של הפעולה. אם השיטה המקורית לא מחזירה נתונים במקרה של הצלחה, כמו Delete, התגובה היא google.protobuf.Empty. אם ה-method המקורית היא סטנדרטית 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.

Fields
model string

חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.

פורמט: models/{model}

name string

פלט בלבד. מזהה. שם המשאב של הקבוצה.

פורמט: batches/{batchId}

displayName string

חובה. השם שהמשתמש נתן לקבוצה הזו.

inputConfig object (InputConfig)

חובה. הגדרת הקלט של המכונות שבהן מתבצע עיבוד באצ'ים.

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".

endTime string (Timestamp format)

פלט בלבד. השעה שבה הסתיים עיבוד ברצף (batch processing).

הפונקציה משתמשת ב-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

הגדרת הקלט לבקשת Batch.

שדות
source Union type
חובה. המקור של הקלט. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
fileName string

שם הקטגוריה File שמכילה את בקשות הקלט.

requests object (InlinedRequests)

הבקשות שיעובדו באצווה.

סוף השדות הבלעדיים.
ייצוג JSON 
{

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

InlinedRequests

הבקשות שיעובדו באצווה, אם הן סופקו כחלק מבקשת יצירת האצווה.

Fields
requests[] object (InlinedRequest)

חובה. הבקשות שיעובדו באצווה.

ייצוג JSON 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

הבקשה לעיבוד באצווה.

Fields
request object (GenerateContentRequest)

חובה. הבקשה לעיבוד באצווה.

metadata object (Struct format)

אופציונלי. המטא-נתונים שרוצים לשייך לבקשה.

ייצוג JSON 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

הפלט של בקשת Batch. הערך הזה מוחזר בשדה BatchGenerateContentResponse או בשדה GenerateContentBatch.output.

שדות
output Union type
הפלט של בקשת Batch. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות הבאים:
responsesFile string

פלט בלבד. מזהה הקובץ שמכיל את התשובות. הקובץ יהיה קובץ JSONL עם תגובה אחת בכל שורה. התשובות יהיו הודעות GenerateContentResponse בפורמט JSON. התשובות ייכתבו באותו סדר של בקשות הקלט.

inlinedResponses object (InlinedResponses)

פלט בלבד. התשובות לבקשות באצווה. התשובה הזו מוחזרת כשהאצווה נוצרה באמצעות בקשות מוטבעות. התשובות יהיו באותו סדר כמו הבקשות שהוזנו.

סוף השדות הבלעדיים.
ייצוג JSON 
{

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

InlinedResponses

התשובות לבקשות באצווה.

Fields
inlinedResponses[] object (InlinedResponse)

פלט בלבד. התשובות לבקשות באצווה.

ייצוג JSON 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

התשובה לבקשה יחידה באצווה.

Fields
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

נתונים סטטיסטיים על האצווה.

Fields
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

המצב של הקבוצה.

טיפוסים בני מנייה (enum)
BATCH_STATE_UNSPECIFIED הסטטוס של החבילה לא צוין.
BATCH_STATE_PENDING השירות מתכונן להפעלת האצווה.
BATCH_STATE_RUNNING הקבוצה נמצאת בתהליך.
BATCH_STATE_SUCCEEDED הקבוצה הושלמה בהצלחה.
BATCH_STATE_FAILED הקבוצה נכשלה.
BATCH_STATE_CANCELLED הקבוצה בוטלה.
BATCH_STATE_EXPIRED פג התוקף של החבילה.

ServiceTier

רמת השירות של הבקשה.

טיפוסים בני מנייה (enum)
unspecified רמת השירות שמוגדרת כברירת מחדל, שהיא רמה רגילה.
standard רמת שירות רגילה.
flex מסלול Flex.
priority רמת שירות עם עדיפות.