Batch Mode

‫Gemini API תומך במצב אצווה, שמאפשר לעבד כמה בקשות בקריאה אחת. פרטים נוספים זמינים במדריך למצב אצווה.

מועמד

תשובה פוטנציאלית שנוצרה מהמודל.

שדות
content object (Content)

פלט בלבד. תוכן שנוצר ומוחזר מהמודל.

finishReason enum (FinishReason)

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

אם השדה ריק, המודל לא הפסיק ליצור טוקנים.

safetyRatings[] object (SafetyRating)

רשימה של דירוגים לרמת הבטיחות של תשובה אפשרית.

לכל קטגוריה יש סיווג אחד לכל היותר.

citationMetadata object (CitationMetadata)

פלט בלבד. פרטי ציטוט של מועמד שנוצר על ידי מודל.

יכול להיות שהשדה הזה יאוכלס במידע על הקראה של כל טקסט שכלול ב-content. מדובר בקטעים ש'מוכתבים' מתוך תוכן שמוגן בזכויות יוצרים בנתוני האימון של מודל ה-LLM הבסיסי.

tokenCount integer

פלט בלבד. מספר הטוקנים של המועמד הזה.

groundingAttributions[] object (GroundingAttribution)

פלט בלבד. פרטי השיוך של מקורות שתרמו לתשובה מבוססת.

השדה הזה מאוכלס עבור קריאות ל-GenerateAnswer.

groundingMetadata object (GroundingMetadata)

פלט בלבד. מטא-נתונים של ביסוס למועמד.

השדה הזה מאוכלס עבור קריאות ל-GenerateContent.

avgLogprobs number

פלט בלבד. הציון הממוצע של הסתברות הלוג של המועמד.

logprobsResult object (LogprobsResult)

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

urlContextMetadata object (UrlContextMetadata)

פלט בלבד. מטא-נתונים שקשורים לכלי לאחזור הקשר של כתובת URL.

index integer

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

ייצוג ב-JSON 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "groundingAttributions": [
    {
      object (GroundingAttribution)
    }
  ],
  "groundingMetadata": {
    object (GroundingMetadata)
  },
  "avgLogprobs": number,
  "logprobsResult": {
    object (LogprobsResult)
  },
  "urlContextMetadata": {
    object (UrlContextMetadata)
  },
  "index": integer
}

FinishReason

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

טיפוסים בני מנייה (enum)
FINISH_REASON_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
STOP נקודת עצירה טבעית של המודל או רצף עצירה שסופק.
MAX_TOKENS הגעתם למספר המקסימלי של טוקנים שצוין בבקשה.
SAFETY התוכן של התשובה האפשרית סומן מטעמי בטיחות.
RECITATION התוכן של התשובה האפשרית סומן בגלל סיבות שקשורות לציטוט.
LANGUAGE התוכן של התשובה האפשרית סומן כי נעשה בו שימוש בשפה לא נתמכת.
OTHER סיבה לא ידועה.
BLOCKLIST יצירת האסימון הופסקה כי התוכן מכיל מונחים אסורים.
PROHIBITED_CONTENT יצירת הטוקן הופסקה כי יכול להיות שהוא מכיל תוכן אסור.
SPII יצירת האסימון הופסקה כי התוכן עשוי להכיל פרטים אישיים מזהים בעלי רגישות גבוהה (SPII).
MALFORMED_FUNCTION_CALL הפעלת הפונקציה שנוצרה על ידי המודל לא תקינה.
IMAGE_SAFETY יצירת הטוקנים הופסקה כי התמונות שנוצרו מכילות הפרות של כללי הבטיחות.
UNEXPECTED_TOOL_CALL המודל יצר קריאה לכלי, אבל לא הופעלו כלים בבקשה.

GroundingAttribution

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

שדות
sourceId object (AttributionSourceId)

פלט בלבד. מזהה המקור שתורם לשיוך הזה.

content object (Content)

הארקה של תוכן המקור שמרכיב את הקרדיט הזה.

ייצוג ב-JSON 
{
  "sourceId": {
    object (AttributionSourceId)
  },
  "content": {
    object (Content)
  }
}

AttributionSourceId

מזהה המקור שתורם לשיוך הזה.

שדות
source Union type
הערך source יכול להיות רק אחד מהערכים הבאים:
groundingPassage object (GroundingPassageId)

מזהה של קטע מוטמע.

semanticRetrieverChunk object (SemanticRetrieverChunk)

מזהה של Chunk שאוחזר באמצעות Semantic Retriever.

ייצוג ב-JSON 
{

  // source
  "groundingPassage": {
    object (GroundingPassageId)
  },
  "semanticRetrieverChunk": {
    object (SemanticRetrieverChunk)
  }
  // Union type
}

GroundingPassageId

מזהה של חלק בתוך GroundingPassage.

שדות
passageId string

פלט בלבד. המזהה של הקטע שתואם ל-GenerateAnswerRequest של GroundingPassage.id.

partIndex integer

פלט בלבד. האינדקס של החלק בתוך GenerateAnswerRequest של GroundingPassage.content.

ייצוג ב-JSON 
{
  "passageId": string,
  "partIndex": integer
}

SemanticRetrieverChunk

מזהה של Chunk שאוחזר באמצעות Semantic Retriever שצוין ב-GenerateAnswerRequest באמצעות SemanticRetrieverConfig.

שדות
source string

פלט בלבד. שם המקור שתואם לערך SemanticRetrieverConfig.source בבקשה. לדוגמה: corpora/123 או corpora/123/documents/abc

chunk string

פלט בלבד. שם ה-Chunk שמכיל את הטקסט שמשויך לרישיון. לדוגמה: corpora/123/documents/abc/chunks/xyz

ייצוג ב-JSON 
{
  "source": string,
  "chunk": string
}

GroundingMetadata

מטא-נתונים שמוחזרים ללקוח כשההארקה מופעלת.

שדות
groundingChunks[] object (GroundingChunk)

רשימה של הפניות תומכות שאוחזרו ממקור ההארקה שצוין.

groundingSupports[] object (GroundingSupport)

רשימה של תמיכה בהארקה.

webSearchQueries[] string

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

searchEntryPoint object (SearchEntryPoint)

אופציונלי. הזנת חיפוש Google לחיפושים הבאים באינטרנט.

retrievalMetadata object (RetrievalMetadata)

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

ייצוג ב-JSON 
{
  "groundingChunks": [
    {
      object (GroundingChunk)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "webSearchQueries": [
    string
  ],
  "searchEntryPoint": {
    object (SearchEntryPoint)
  },
  "retrievalMetadata": {
    object (RetrievalMetadata)
  }
}

SearchEntryPoint

נקודת כניסה לחיפוש Google.

שדות
renderedContent string

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

sdkBlob string (bytes format)

אופציונלי. ‫JSON מקודד ב-Base64 שמייצג מערך של טופל <מונח חיפוש, כתובת URL של חיפוש>.

מחרוזת בקידוד Base64.

ייצוג ב-JSON 
{
  "renderedContent": string,
  "sdkBlob": string
}

GroundingChunk

קטע מידע שמשמש כנקודת התייחסות.

שדות
chunk_type Union type
סוג הנתח. הערך chunk_type יכול להיות רק אחד מהערכים הבאים:
web object (Web)

חלק מהנתונים מהאינטרנט שמשמשים לעיגון.

ייצוג ב-JSON 
{

  // chunk_type
  "web": {
    object (Web)
  }
  // Union type
}

פיתוח אתרים

קטע מהאינטרנט.

שדות
uri string

הפניה ל-URI של החלק.

title string

השם של החלק.

ייצוג ב-JSON 
{
  "uri": string,
  "title": string
}

GroundingSupport

תמיכה בנקודת התייחסות.

שדות
groundingChunkIndices[] integer

רשימה של אינדקסים (בתוך 'grounding_chunk') שמציינים את הציטוטים שמשויכים לתלונה. לדוגמה, [1,3,4] פירושו שהתוכן שאוחזר ושמשויך לטענה הוא grounding_chunk[1], ‏ grounding_chunk[3] ו-grounding_chunk[4].

confidenceScores[] number

ציון המהימנות של ההפניות לתמיכה. הערך נע בין 0 ל-1. ‫1 הוא הדירוג הגבוה ביותר. הגודל של הרשימה הזו צריך להיות זהה לזה של groundingChunkIndices.

segment object (Segment)

פלח התוכן שאליו שייך התמיכה הזו.

ייצוג ב-JSON 
{
  "groundingChunkIndices": [
    integer
  ],
  "confidenceScores": [
    number
  ],
  "segment": {
    object (Segment)
  }
}

Segment

פלח של התוכן.

שדות
partIndex integer

פלט בלבד. האינדקס של אובייקט Part בתוך אובייקט Content ההורה שלו.

startIndex integer

פלט בלבד. אינדקס ההתחלה בחלק הנתון, נמדד בבייטים. ההיסט מתחילת החלק, כולל, החל מאפס.

endIndex integer

פלט בלבד. אינדקס הסיום בחלק הנתון, נמדד בבייטים. ההיסט מתחילת החלק, לא כולל, מתחיל מאפס.

text string

פלט בלבד. הטקסט שמתאים למקטע מהתשובה.

ייצוג ב-JSON 
{
  "partIndex": integer,
  "startIndex": integer,
  "endIndex": integer,
  "text": string
}

RetrievalMetadata

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

שדות
googleSearchDynamicRetrievalScore number

אופציונלי. ציון שמציין את הסבירות לכך שמידע מחיפוש Google יעזור לענות על ההנחיה. הציון הוא בטווח [0, 1], כאשר 0 הוא הסביר ביותר ו-1 הוא הכי פחות סביר. הציון הזה מאוכלס רק כשמופעלת האפשרות 'התבססות על חיפוש Google' ואחזור דינמי. הערך הזה מושווה לסף כדי לקבוע אם להפעיל את חיפוש Google.

ייצוג ב-JSON 
{
  "googleSearchDynamicRetrievalScore": number
}

LogprobsResult

תוצאה של Logprobs

שדות
topCandidates[] object (TopCandidates)

אורך = מספר השלבים הכולל של הפענוח.

chosenCandidates[] object (Candidate)

אורך = מספר השלבים הכולל של הפענוח. יכול להיות שהמועמדים שנבחרו יופיעו ברשימת המועמדים המובילים, ויכול להיות שלא.

ייצוג ב-JSON 
{
  "topCandidates": [
    {
      object (TopCandidates)
    }
  ],
  "chosenCandidates": [
    {
      object (Candidate)
    }
  ]
}

TopCandidates

מועמדים עם הסתברויות גבוהות ללוג בכל שלב של פענוח.

שדות
candidates[] object (Candidate)

הנתונים ממוינים לפי הסתברות הלוג בסדר יורד.

ייצוג ב-JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ]
}

מועמד

מועמד ל-logprobs של האסימון ולציון.

שדות
token string

ערך המחרוזת של האסימון של המועמד.

tokenId integer

ערך מזהה האסימון של המועמד.

logProbability number

ההסתברות הלוגריתמית של המועמד.

ייצוג ב-JSON 
{
  "token": string,
  "tokenId": integer,
  "logProbability": number
}

UrlContextMetadata

מטא-נתונים שקשורים לכלי לאחזור הקשר של כתובת URL.

שדות
urlMetadata[] object (UrlMetadata)

רשימה של הקשר של כתובת ה-URL.

ייצוג ב-JSON 
{
  "urlMetadata": [
    {
      object (UrlMetadata)
    }
  ]
}

UrlMetadata

הקשר של אחזור כתובת URL יחידה.

שדות
retrievedUrl string

כתובת ה-URL שאותרה על ידי הכלי.

urlRetrievalStatus enum (UrlRetrievalStatus)

הסטטוס של אחזור כתובת ה-URL.

ייצוג ב-JSON 
{
  "retrievedUrl": string,
  "urlRetrievalStatus": enum (UrlRetrievalStatus)
}

UrlRetrievalStatus

הסטטוס של אחזור כתובת ה-URL.

טיפוסים בני מנייה (enum)
URL_RETRIEVAL_STATUS_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
URL_RETRIEVAL_STATUS_SUCCESS אחזור כתובת ה-URL בוצע בהצלחה.
URL_RETRIEVAL_STATUS_ERROR אחזור כתובת ה-URL נכשל בגלל שגיאה.

CitationMetadata

אוסף של שיוכים למקורות של קטע תוכן.

שדות
citationSources[] object (CitationSource)

ציטוטים של מקורות לתשובה ספציפית.

ייצוג ב-JSON 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}

CitationSource

ציטוט של מקור לחלק מתשובה ספציפית.

שדות
startIndex integer

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

האינדקס מציין את תחילת הפלח, בבייטים.

endIndex integer

אופציונלי. סוף הקטע המשויך, לא כולל.

uri string

אופציונלי. ה-URI שמיוחס כמקור לחלק מהטקסט.

license string

אופציונלי. רישיון לפרויקט ב-GitHub שמוגדר כמקור לקטע.

נדרש מידע על הרישיון לציטוט קוד.

ייצוג ב-JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}

משאב REST: ‏ batches

משאב: פעולה

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

שדות
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
}

שיטה: 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

טוקן הדף של הרשימה הרגילה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של 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 ריק.