Gemini API תומך ביצירת תוכן עם תמונות, אודיו, קוד, כלים ועוד. בהמשך המאמר מפורטים כל אחת מהתכונות האלה, ומוצג קוד לדוגמה שמתמקד במשימות. אפשר גם לקרוא את המדריכים המקיפים.
שיטה: models.generateContent
יצירת תשובה של מודל בהינתן קלט GenerateContentRequest. פרטים נוספים על השימוש זמינים במדריך ליצירת טקסט. יכולות הקלט שונות בין המודלים, כולל מודלים שעברו התאמה. פרטים נוספים זמינים במדריך למודלים ובמדריך להתאמת מודלים.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
פרמטרים של נתיב
model
string
חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools ש-Model עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. ה-Tools הנתמכים הם 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 שלכם.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. בשלב הזה, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות ההגדרה ליצירת מודלים ולפלטים.
cachedContent
string
אופציונלי. השם של התוכן שנשמר במטמון כדי לשמש כהקשר להצגת התחזית. פורמט: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
אופציונלי. מדרגת השירות של הבקשה.
store
boolean
אופציונלי. היא מגדירה את אופן הרישום ביומן עבור בקשה נתונה. אם ההגדרה הזו מוגדרת, היא מקבלת עדיפות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Java
תמונה
Python
Node.js
Go
קונכייה
Java
אודיו
Python
Node.js
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
Java
מטמון
Python
Node.js
Go
מודל שעבר התאמה
Python
מצב JSON
Python
Node.js
Go
קונכייה
Java
הרצת קוד
Python
Go
Java
בקשה להפעלת פונקציה
Python
Go
Node.js
קונכייה
Java
הגדרת יצירה
Python
Node.js
Go
קונכייה
Java
הגדרות בטיחות
Python
Node.js
Go
קונכייה
Java
הנחיה למערכת
Python
Node.js
Go
קונכייה
Java
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של GenerateContentResponse.
שיטה: models.streamGenerateContent
יצירת תשובה בסטרימינג מהמודל בהינתן קלט GenerateContentRequest.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
פרמטרים של נתיב
model
string
חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools שModel עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. ה-Tools הנתמכים הם 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 שלכם.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. בשלב הזה, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות ההגדרה ליצירת מודלים ולפלטים.
cachedContent
string
אופציונלי. השם של התוכן שנשמר במטמון כדי לשמש כהקשר להצגת התחזית. פורמט: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
אופציונלי. מדרגת השירות של הבקשה.
store
boolean
אופציונלי. היא מגדירה את אופן הרישום ביומן עבור בקשה נתונה. אם ההגדרה הזו מוגדרת, היא מקבלת עדיפות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Java
תמונה
Python
Node.js
Go
קונכייה
Java
אודיו
Python
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל זרם של מופעים של GenerateContentResponse.
GenerateContentResponse
תשובה מהמודל שתומכת בכמה תשובות אפשריות.
דירוגי הבטיחות וסינון התוכן מדווחים גם לגבי הפרומפט ב-GenerateContentResponse.prompt_feedback וגם לגבי כל מועמד ב-finishReason וב-safetyRatings. ה-API: – מחזיר את כל המועמדים המבוקשים או אף אחד מהם – לא מחזיר אף מועמד רק אם הייתה בעיה בהנחיה (צריך לבדוק את promptFeedback) – מדווח על משוב לגבי כל מועמד ב-finishReason וב-safetyRatings.
candidates[]
object (Candidate)
תשובות אפשריות מהמודל.
promptFeedback
object (PromptFeedback)
מחזירה את המשוב על ההנחיה שקשור למסנני התוכן.
usageMetadata
object (UsageMetadata)
פלט בלבד. מטא-נתונים על השימוש באסימונים בבקשות ליצירה.
modelVersion
string
פלט בלבד. גרסת המודל ששימשה ליצירת התשובה.
responseId
string
פלט בלבד. המזהה responseId משמש לזיהוי כל תשובה.
modelStatus
object (ModelStatus)
פלט בלבד. הסטטוס הנוכחי של המודל הזה.
| ייצוג ב-JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
קבוצה של מטא-נתוני המשוב שההנחיה ציינה ב-GenerateContentRequest.content.
blockReason
enum (BlockReason)
אופציונלי. אם ההגדרה מוגדרת, ההנחיה נחסמת ולא מוחזרים מועמדים. לנסח מחדש את ההנחיה.
safetyRatings[]
object (SafetyRating)
דירוגים של בטיחות ההנחיה. לכל קטגוריה יש סיווג אחד לכל היותר.
| ייצוג ב-JSON |
|---|
{ "blockReason": enum ( |
BlockReason
מציינת את הסיבה לחסימת ההנחיה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
SAFETY |
ההנחיה נחסמה מטעמי בטיחות. בודקים את safetyRatings כדי להבין איזו קטגוריית בטיחות חסמה אותו. |
OTHER |
ההנחיה נחסמה מסיבות לא ידועות. |
BLOCKLIST |
ההנחיה נחסמה בגלל התנאים שכלולים ברשימת המילים החסומות. |
PROHIBITED_CONTENT |
ההנחיה נחסמה בגלל תוכן אסור. |
IMAGE_SAFETY |
מועמדים נחסמו בגלל תוכן לא בטוח שנוצר על ידי AI. |
UsageMetadata
מטא-נתונים על השימוש באסימון של בקשת היצירה.
promptTokenCount
integer
מספר הטוקנים בהנחיה. גם כשמגדירים את cachedContent, זה עדיין הגודל הכולל של ההנחיה בפועל, כלומר הוא כולל את מספר הטוקנים בתוכן שבמטמון.
cachedContentTokenCount
integer
מספר הטוקנים בחלק של ההנחיה שנשמר במטמון (התוכן שנשמר במטמון)
candidatesTokenCount
integer
המספר הכולל של הטוקנים בכל התשובות האפשריות שנוצרו.
toolUsePromptTokenCount
integer
פלט בלבד. מספר הטוקנים שמופיעים בהנחיות לשימוש בכלים.
thoughtsTokenCount
integer
פלט בלבד. מספר הטוקנים של המחשבות למודלים חושבים.
totalTokenCount
integer
המספר הכולל של הטוקנים בבקשת היצירה (הנחיה + מחשבות + מועמדים לתגובה).
promptTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת האופנים שעובדו בקלט של הבקשה.
cacheTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת אופנויות של התוכן שנשמר במטמון בקלט של הבקשה.
candidatesTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת האופנים שהוחזרו בתשובה.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימה של אופנים שונים של קלט שעברו עיבוד לבקשות לשימוש בכלים.
serviceTier
enum (ServiceTier)
פלט בלבד. רמת השירות של הבקשה.
| ייצוג ב-JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
הסטטוס של המודל הבסיסי. השדה הזה משמש לציון השלב של המודל הבסיסי וזמן ההוצאה משימוש, אם רלוונטי.
modelStage
enum (ModelStage)
השלב של המודל הבסיסי.
retirementTime
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".
message
string
הודעה שמסבירה את סטטוס המודל.
| ייצוג ב-JSON |
|---|
{
"modelStage": enum ( |
ModelStage
הגדרה של השלב של המודל הבסיסי.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
שלב המודל לא צוין. |
UNSTABLE_EXPERIMENTAL |
המודל הבסיסי עובר הרבה שינויים. |
EXPERIMENTAL |
מודלים בשלב הזה מיועדים למטרות ניסיוניות בלבד. |
PREVIEW |
מודלים בשלב הזה הם מתקדמים יותר ממודלים ניסיוניים. |
STABLE |
מודלים בשלב הזה נחשבים יציבים ומוכנים לשימוש בסביבת ייצור. |
LEGACY |
אם הדגם נמצא בשלב הזה, המשמעות היא שהדגם הזה עומד לצאת משימוש בעתיד הקרוב. רק לקוחות קיימים יכולים להשתמש במודל הזה. |
DEPRECATED |
המודלים בשלב הזה הוצאו משימוש. אי אפשר להשתמש במודלים האלה. |
RETIRED |
מודלים בשלב הזה מוצאים משימוש. אי אפשר להשתמש במודלים האלה. |
מועמד
- ייצוג ב-JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- אינטרנט
- תמונה
- RetrievedContext
- CustomMetadata
- StringList
- מפות
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- פלח
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- מועמד
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
תשובה פוטנציאלית שנוצרה מהמודל.
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
פלט בלבד. האינדקס של המועמד ברשימת המועמדים לתשובה.
finishMessage
string
אופציונלי. פלט בלבד. פרטים על הסיבה להפסקת יצירת הטוקנים על ידי המודל. השדה הזה מאוכלס רק אם מוגדר finishReason.
| ייצוג ב-JSON |
|---|
{ "content": { object ( |
FinishReason
הסיבה להפסקת יצירת הטוקנים על ידי המודל.
| טיפוסים בני מנייה (enum) | |
|---|---|
FINISH_REASON_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
STOP |
נקודת עצירה טבעית של המודל או רצף עצירה שסופק. |
MAX_TOKENS |
הגעתם למספר האסימונים המקסימלי שצוין בבקשה. |
SAFETY |
התוכן של התשובה האפשרית סומן מטעמי בטיחות. |
RECITATION |
התוכן של התשובה האפשרית סומן בגלל סיבות שקשורות לדיבור. |
LANGUAGE |
התוכן של התשובה האפשרית סומן בגלל שימוש בשפה שלא נתמכת. |
OTHER |
סיבה לא ידועה. |
BLOCKLIST |
יצירת האסימון הופסקה כי התוכן מכיל מונחים אסורים. |
PROHIBITED_CONTENT |
יצירת האסימון הופסקה כי יכול להיות שהוא מכיל תוכן אסור. |
SPII |
יצירת האסימון הופסקה כי התוכן עשוי להכיל פרטים אישיים מזהים בעלי רגישות גבוהה (SPII). |
MALFORMED_FUNCTION_CALL |
הפעלת הפונקציה שנוצרה על ידי המודל לא תקינה. |
IMAGE_SAFETY |
יצירת הטוקנים הופסקה כי התמונות שנוצרו מכילות הפרות של כללי הבטיחות. |
IMAGE_PROHIBITED_CONTENT |
יצירת התמונה הופסקה כי התמונות שנוצרו כוללות תוכן אסור אחר. |
IMAGE_OTHER |
יצירת התמונה הופסקה בגלל בעיה אחרת. |
NO_IMAGE |
המודל היה אמור ליצור תמונה, אבל לא נוצרה תמונה. |
IMAGE_RECITATION |
יצירת התמונה הופסקה בגלל הקראה. |
UNEXPECTED_TOOL_CALL |
המודל יצר קריאה לכלי, אבל לא הופעלו כלים בבקשה. |
TOO_MANY_TOOL_CALLS |
המודל קרא ליותר מדי כלים ברצף, ולכן המערכת הפסיקה את הביצוע. |
MISSING_THOUGHT_SIGNATURE |
חסרה חתימת מחשבה אחת לפחות בבקשה. |
MALFORMED_RESPONSE |
הסתיים בגלל תגובה בפורמט שגוי. |
ESCALATION |
הבקשה סוננה על ידי כלל להעברה לטיפול ברמה גבוהה יותר. |
GroundingAttribution
שיוך למקור שתרם לתשובה.
sourceId
object (AttributionSourceId)
פלט בלבד. מזהה המקור שתורם לשיוך הזה.
content
object (Content)
תוכן המקור שמרכיב את הקרדיט הזה.
| ייצוג ב-JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
מזהה המקור שתורם לשיוך הזה.
source
Union type
source יכול להיות רק אחד מהבאים:groundingPassage
object (GroundingPassageId)
מזהה של קטע מוטבע.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
מזהה של Chunk שאוחזר באמצעות Semantic Retriever.
| ייצוג ב-JSON |
|---|
{ // source "groundingPassage": { object ( |
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
שאילתות לחיפוש באינטרנט לחיפוש המשך באינטרנט.
imageSearchQueries[]
string
שאילתות לחיפוש תמונות שמשמשות להארקה.
searchEntryPoint
object (SearchEntryPoint)
אופציונלי. הזנת חיפוש Google לחיפושים באינטרנט שמתבצעים בהמשך.
retrievalMetadata
object (RetrievalMetadata)
מטא-נתונים שקשורים לאחזור בתהליך ההצמדה לקרקע.
googleMapsWidgetContextToken
string
אופציונלי. שם המשאב של טוקן ההקשר של הווידג'ט של Google Maps שאפשר להשתמש בו עם הווידג'ט PlacesContextElement כדי לעבד נתונים הקשריים. השדה הזה מאוכלס רק אם מופעל עיגון בעזרת מפות Google.
| ייצוג ב-JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
נקודת כניסה לחיפוש Google.
renderedContent
string
אופציונלי. קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.
sdkBlob
string (bytes format)
אופציונלי. JSON מקודד ב-Base64 שמייצג מערך של טופל <מונח חיפוש, כתובת URL של חיפוש>.
מחרוזת בקידוד Base64.
| ייצוג ב-JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
הסמל GroundingChunk מייצג פלח של הוכחות שתומכות בתשובה של המודל. זה יכול להיות קטע מהאינטרנט, הקשר שאוחזר מקובץ או מידע ממפות Google.
chunk_type
Union type
chunk_type יכול להיות רק אחד מהבאים:web
object (Web)
חלק מהנתונים מהאינטרנט שמשמשים לעיגון.
image
object (Image)
אופציונלי. חלק מעוגן מחיפוש תמונות.
retrievedContext
object (RetrievedContext)
אופציונלי. חלק מההקשר שאוחזר על ידי כלי החיפוש בקובץ.
maps
object (Maps)
אופציונלי. חלק מהעיגון ממפות Google.
| ייצוג ב-JSON |
|---|
{ // chunk_type "web": { object ( |
פיתוח אתרים
קטע מהאינטרנט.
uri
string
פלט בלבד. הפניה ל-URI של החלק.
title
string
פלט בלבד. השם של החלק.
| ייצוג ב-JSON |
|---|
{ "uri": string, "title": string } |
תמונה
קטע מחיפוש תמונות.
sourceUri
string
ה-URI של דף האינטרנט לשיוך.
imageUri
string
כתובת ה-URL של נכס התמונה.
title
string
הכותרת של דף האינטרנט שממנו נלקחה התמונה.
domain
string
דומיין הבסיס של דף האינטרנט שממנו נלקחה התמונה, למשל example.com.
| ייצוג ב-JSON |
|---|
{ "sourceUri": string, "imageUri": string, "title": string, "domain": string } |
RetrievedContext
קטע מההקשר שאוחזר על ידי הכלי לחיפוש קבצים.
customMetadata[]
object (CustomMetadata)
אופציונלי. מטא-נתונים שהמשתמש סיפק לגבי ההקשר שאוחזר.
uri
string
אופציונלי. הפניה ל-URI של מסמך האחזור הסמנטי.
title
string
אופציונלי. שם המסמך.
text
string
אופציונלי. הטקסט של החלק.
fileSearchStore
string
אופציונלי. השם של FileSearchStore שמכיל את המסמך. לדוגמה: fileSearchStores/123
pageNumber
integer
אופציונלי. מספר העמוד של ההקשר שאוחזר, אם רלוונטי.
mediaId
string
אופציונלי. שם המשאב של ה-blob של המדיה בתוצאות חיפוש קבצים מרובה-מוֹדָלִי. פורמט: fileSearchStores/{file_search_store_id}/media/{blobId}
| ייצוג ב-JSON |
|---|
{
"customMetadata": [
{
object ( |
CustomMetadata
מטא נתונים שסופקו על ידי המשתמש לגבי GroundingFact.
key
string
המפתח של המטא-נתונים.
value
Union type
value יכול להיות רק אחד מהבאים:stringValue
string
אופציונלי. ערך המחרוזת של המטא-נתונים.
stringListValue
object (StringList)
אופציונלי. רשימה של ערכי מחרוזת למטא-נתונים.
numericValue
number
אופציונלי. הערך המספרי של המטא-נתונים. הטווח הצפוי של הערך הזה תלוי בkey הספציפי שבו נעשה שימוש.
| ייצוג ב-JSON |
|---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
רשימה של ערכי מחרוזת.
values[]
string
ערכי המחרוזת של הרשימה.
| ייצוג ב-JSON |
|---|
{ "values": [ string ] } |
מפות
חלק מעיגון מנתוני מפות Google. כל מקטע במפות Google תואם למקום אחד.
uri
string
הפניה ל-URI של המקום.
title
string
שם המקום.
text
string
תיאור טקסטואלי של התשובה לגבי המקום.
placeId
string
מזהה המקום בפורמט places/{placeId}. משתמשים יכולים להשתמש במזהה הזה כדי לחפש את המקום.
placeAnswerSources
object (PlaceAnswerSources)
מקורות שמספקים תשובות לגבי התכונות של מקום מסוים במפות Google.
| ייצוג ב-JSON |
|---|
{
"uri": string,
"title": string,
"text": string,
"placeId": string,
"placeAnswerSources": {
object ( |
PlaceAnswerSources
אוסף של מקורות שמספקים תשובות לגבי התכונות של מקום מסוים במפות Google. כל הודעת PlaceAnswerSources מתייחסת למקום ספציפי במפות Google. הכלי של מפות Google השתמש במקורות האלה כדי לענות על שאלות לגבי מאפיינים של המקום (לדוגמה: "יש בבר פו Wi-Fi?" או "האם בר פו נגיש לכיסא גלגלים?"). בשלב הזה אנחנו תומכים רק בקטעי מידע מביקורות כמקורות.
reviewSnippets[]
object (ReviewSnippet)
קטעי ביקורות שמשמשים ליצירת תשובות לגבי התכונות של מקום מסוים במפות Google.
| ייצוג ב-JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.
reviewId
string
המזהה של קטע הביקורת.
googleMapsUri
string
קישור שמתאים לביקורת של המשתמש במפות Google.
title
string
כותרת הביקורת.
| ייצוג ב-JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
תמיכה בנקודת התייחסות.
groundingChunkIndices[]
integer
אופציונלי. רשימה של אינדקסים (בתוך 'grounding_chunk' ב-response.candidate.grounding_metadata) שמציינים את הציטוטים שמשויכים לטענה. לדוגמה, [1,3,4] פירושו שהתוכן שאוחזר ושמיוחס לטענה הוא grounding_chunk[1], grounding_chunk[3], grounding_chunk[4]. אם התשובה היא סטרימינג, הערכים של groundingChunkIndices מתייחסים לאינדקסים בכל התשובות. באחריות הלקוח לצבור את נתחי ההארקה מכל התשובות (תוך שמירה על אותו סדר).
confidenceScores[]
number
אופציונלי. ציון המהימנות של ההפניות לתמיכה. הערך נע בין 0 ל-1. 1 הוא הדירוג שמשקף את מידת הביטחון הגבוהה ביותר. הגודל של הרשימה הזו צריך להיות זהה לזה של groundingChunkIndices.
renderedParts[]
integer
פלט בלבד. אינדקסים בשדה parts של תוכן המועמד. האינדקסים האלה מציינים אילו חלקים שעברו עיבוד משויכים למקור התמיכה הזה.
segment
object (Segment)
פלח התוכן שאליו שייך התמיכה הזו.
| ייצוג ב-JSON |
|---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"renderedParts": [
integer
],
"segment": {
object ( |
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)
אורך = המספר הכולל של שלבי הפענוח. יכול להיות שהמועמדים שנבחרו יופיעו ברשימה topCandidates, ויכול להיות שלא.
logProbabilitySum
number
סכום ההסתברויות הלוגריתמיות של כל הטוקנים.
| ייצוג ב-JSON |
|---|
{ "topCandidates": [ { object ( |
TopCandidates
מועמדים עם הסתברויות יומן גבוהות בכל שלב פענוח.
candidates[]
object (Candidate)
הנתונים ממוינים לפי הסתברות יומן בסדר יורד.
| ייצוג ב-JSON |
|---|
{
"candidates": [
{
object ( |
מועמד
מועמד לאסימון ולציון logprobs.
token
string
ערך המחרוזת של הטוקן של המועמד.
tokenId
integer
ערך מזהה האסימון של המועמד.
logProbability
number
ההסתברות הלוגריתמית של המועמד.
| ייצוג ב-JSON |
|---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
מטא-נתונים שקשורים לכלי לאחזור הקשר של כתובת URL.
urlMetadata[]
object (UrlMetadata)
רשימה של כתובות URL בהקשר.
| ייצוג ב-JSON |
|---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
ההקשר של אחזור כתובת URL יחידה.
retrievedUrl
string
כתובת ה-URL שאותרה על ידי הכלי.
urlRetrievalStatus
enum (UrlRetrievalStatus)
הסטטוס של אחזור כתובת ה-URL.
| ייצוג ב-JSON |
|---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
הסטטוס של אחזור כתובת ה-URL.
| טיפוסים בני מנייה (enum) | |
|---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
URL_RETRIEVAL_STATUS_SUCCESS |
השליפה של כתובת ה-URL בוצעה בהצלחה. |
URL_RETRIEVAL_STATUS_ERROR |
אחזור כתובת ה-URL נכשל בגלל שגיאה. |
URL_RETRIEVAL_STATUS_PAYWALL |
אחזור כתובת ה-URL נכשל כי התוכן מוגן על ידי חומת תשלום. |
URL_RETRIEVAL_STATUS_UNSAFE |
השליפה של כתובת ה-URL נכשלה כי התוכן לא בטוח. |
CitationMetadata
אוסף של שיוכים למקורות של קטע תוכן.
citationSources[]
object (CitationSource)
ציטוטים של מקורות לתשובה ספציפית.
| ייצוג ב-JSON |
|---|
{
"citationSources": [
{
object ( |
CitationSource
ציטוט של מקור לחלק מתשובה ספציפית.
startIndex
integer
אופציונלי. תחילת פלח התשובה שמשויך למקור הזה.
האינדקס מציין את תחילת הפלח, שנמדד בבייטים.
endIndex
integer
אופציונלי. סיום הקטע המשויך, לא כולל.
uri
string
אופציונלי. ה-URI שמשויך כמקור לחלק מהטקסט.
license
string
אופציונלי. רישיון לפרויקט ב-GitHub שמוגדר כמקור לקטע.
חובה לציין פרטי רישיון כשמצטטים קוד.
| ייצוג ב-JSON |
|---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
HarmCategory
הקטגוריה של הסיווג.
הקטגוריות האלה כוללות סוגים שונים של נזקים שמפתחים עשויים לרצות להתאים.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
הקטגוריה לא צוינה. |
HARM_CATEGORY_DEROGATORY |
PaLM – תגובות שליליות או מזיקות שמטרגטות זהות או מאפיין מוגן. |
HARM_CATEGORY_TOXICITY |
PaLM – תוכן גס, מזלזל או בוטה. |
HARM_CATEGORY_VIOLENCE |
PaLM – תיאור של תרחישים שמציגים אלימות נגד אדם פרטי או קבוצה, או תיאורים כלליים של שפיכות דמים. |
HARM_CATEGORY_SEXUAL |
PaLM – מכיל אזכורים של מעשים מיניים או תוכן מגונה אחר. |
HARM_CATEGORY_MEDICAL |
PaLM – מקדם עצות רפואיות שלא נבדקו. |
HARM_CATEGORY_DANGEROUS |
PaLM – תוכן מסוכן שמקדם גרימת נזק, מעודד גרימת נזק או עוזר לבצע פעולות מזיקות. |
HARM_CATEGORY_HARASSMENT |
Gemini – תוכן שמטרתו הטרדה. |
HARM_CATEGORY_HATE_SPEECH |
Gemini – דברי שטנה ותוכן. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini – תוכן מיני בוטה. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini – תוכן מסוכן. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini – תוכן שעשוי לשמש לפגיעה ביושרה האזרחית. המאפיין הזה יצא משימוש. במקומו צריך להשתמש ב-enableEnhancedCivicAnswers. |
HARM_CATEGORY_JAILBREAK |
Gemini – הנחיות שמנסות לעקוף או לחתור תחת הנחיות הבטיחות של המודל (ניסיונות פריצה). |
ModalityTokenCount
מייצג מידע על ספירת טוקנים עבור מודאליות אחת.
modality
enum (Modality)
האופן שבו משתמשים בטוקן שמשויך לספירה הזו.
tokenCount
integer
מספר הטוקנים.
| ייצוג ב-JSON |
|---|
{
"modality": enum ( |
אופן השימוש
אופן הפעולה של חלקים בתוכן
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
אופן השימוש לא צוין. |
TEXT |
טקסט פשוט. |
IMAGE |
תמונה. |
VIDEO |
סרטון. |
AUDIO |
אודיו. |
DOCUMENT |
מסמך, למשל PDF. |
SafetyRating
דירוג הבטיחות של קטע תוכן.
סיווג הבטיחות מכיל את קטגוריית הנזק ואת רמת הסבירות לנזק בקטגוריה הזו עבור פריט תוכן. התוכן מסווג לפי בטיחות במספר קטגוריות של נזק, וההסתברות לסיווג הנזק כלולה כאן.
category
enum (HarmCategory)
חובה. הקטגוריה של הדירוג הזה.
probability
enum (HarmProbability)
חובה. הסבירות לפגיעה בגלל התוכן הזה.
blocked
boolean
האם התוכן הזה נחסם בגלל הסיווג הזה?
| ייצוג ב-JSON |
|---|
{ "category": enum ( |
HarmProbability
הסבירות שחלק מהתוכן מזיק.
מערכת הסיווג נותנת את ההסתברות שהתוכן לא בטוח. הסיווג הזה לא מציין את חומרת הנזק שנגרם מתוכן מסוים.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_PROBABILITY_UNSPECIFIED |
לא צוין הסתברות. |
NEGLIGIBLE |
הסיכוי שהתוכן לא בטוח הוא זניח. |
LOW |
הסיכוי שהתוכן לא בטוח הוא נמוך. |
MEDIUM |
יש סיכוי בינוני שהתוכן לא בטוח. |
HIGH |
יש סיכוי גבוה שהתוכן לא בטוח. |
SafetySetting
הגדרת בטיחות שמשפיעה על התנהגות החסימה של בטיחות.
העברת הגדרת בטיחות לקטגוריה משנה את ההסתברות המותרת לחסימת תוכן.
category
enum (HarmCategory)
חובה. הקטגוריה של ההגדרה הזו.
threshold
enum (HarmBlockThreshold)
חובה. קובעת את סף ההסתברות שמעליו נחסמת פגיעה.
| ייצוג ב-JSON |
|---|
{ "category": enum ( |
HarmBlockThreshold
חסימה ברמת הסתברות מסוימת ומעלה.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
לא צוין סף. |
BLOCK_LOW_AND_ABOVE |
תוכן עם סיווג NEGLIGIBLE (זניח) יהיה מותר. |
BLOCK_MEDIUM_AND_ABOVE |
התוכן עם סיווגים של NEGLIGIBLE ו-LOW יהיה מותר. |
BLOCK_ONLY_HIGH |
תוכן עם רמת סיכון נמוכה, בינונית או זניחה מותר. |
BLOCK_NONE |
כל התוכן יאושר. |
OFF |
משביתים את מסנן הבטיחות. |
ServiceTier
רמת השירות של הבקשה.
| טיפוסים בני מנייה (enum) | |
|---|---|
unspecified |
מסלול שירות שמוגדר כברירת מחדל, שהוא Standard. |
standard |
רמת שירות רגילה. |
flex |
רמת השירות Flex. |
priority |
רמת שירות בעדיפות גבוהה. |
תוכן
- ייצוג ב-JSON
- Part
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- תזמון
- FileData
- ExecutableCode
- שפה
- CodeExecutionResult
- תוצאה
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- רמה
- MediaProcessing
סוג הנתונים המובְנים הבסיסי שמכיל תוכן של הודעה שמורכב מכמה חלקים.
Content כולל שדה role שמציין את יוצר ה-Content ושדה parts שמכיל נתונים מרובי חלקים שמכילים את תוכן תור ההודעות.
parts[]
object (Part)
מסודרות Parts שמרכיבות הודעה אחת. יכול להיות שלחלקים יהיו סוגי MIME שונים.
role
string
אופציונלי. הגורם שהפיק את התוכן. הערך חייב להיות user או model.
מומלץ להגדיר את הפרמטר הזה לשיחות רב-שלביות, אחרת אפשר להשאיר אותו ריק או לא מוגדר.
| ייצוג ב-JSON |
|---|
{
"parts": [
{
object ( |
חלק
סוג נתונים שמכיל מדיה שהיא חלק מהודעה Content מרובת חלקים.
Part מורכב מנתונים שמשויך אליהם סוג נתונים. Part יכול להכיל רק סוג אחד מבין הסוגים הקבילים שמופיעים בPart.data.
אם השדה inlineData מלא בבייטים גולמיים, ל-Part צריך להיות סוג MIME קבוע של IANA שמזהה את הסוג וסוג המשנה של המדיה.
thought
boolean
אופציונלי. מציין אם החלק נוצר על ידי המודל.
thoughtSignature
string (bytes format)
אופציונלי. חתימה אטומה למחשבה, כדי שאפשר יהיה לעשות בה שימוש חוזר בבקשות הבאות.
מחרוזת בקידוד Base64.
partMetadata
object (Struct format)
מטא-נתונים בהתאמה אישית שמשויכים לחלק. סוכנים שמשתמשים ב-genai.Part כייצוג תוכן צריכים לעקוב אחרי המידע הנוסף. לדוגמה, זה יכול להיות השם של קובץ או מקור שממנו החלק נוצר, או דרך לבצע מולטיפלקס של כמה זרמי חלקים.
mediaResolution
object (MediaResolution)
אופציונלי. רזולוציית המדיה של קלט המדיה.
mediaProcessing
enum (MediaProcessing)
אופציונלי. איך המודל מעבד את המדיה של החלק הזה כדי להבין אותה. המאפיין רלוונטי רק לחלקי סרטון (inlineData או fileData עם סוג MIME של סרטון). המערכת מתעלמת מהשדה הזה בחלקים שאינם סרטונים.
data
Union type
data יכול להיות רק אחד מהבאים:text
string
טקסט מוטבע.
inlineData
object (Blob)
בייטים של מדיה בתוך הטקסט.
functionCall
object (FunctionCall)
הפונקציה מחזירה את הערך FunctionCall שחזתה המודל, שמכיל מחרוזת שמייצגת את FunctionDeclaration.name עם הארגומנטים והערכים שלהם.
functionResponse
object (FunctionResponse)
הפלט של FunctionCall שמכיל מחרוזת שמייצגת את FunctionDeclaration.name ואובייקט JSON מובנה שמכיל פלט מהפונקציה משמש כהקשר למודל.
fileData
object (FileData)
נתונים שמבוססים על URI.
executableCode
object (ExecutableCode)
קוד שנוצר על ידי המודל ומיועד להרצה.
codeExecutionResult
object (CodeExecutionResult)
התוצאה של הפעלת ExecutableCode.
toolCall
object (ToolCall)
קריאה לכלי בצד השרת. השדה הזה יאוכלס כשהמודל חוזה הפעלה של כלי שצריך להפעיל בשרת. הלקוח אמור להחזיר את ההודעה הזו ל-API.
toolResponse
object (ToolResponse)
הפלט מהרצה של ToolCall בצד השרת. השדה הזה מאוכלס על ידי הלקוח בתוצאות של הפעלת ToolCall התואם.
metadata
Union type
metadata יכול להיות רק אחד מהבאים:videoMetadata
object (VideoMetadata)
אופציונלי. מטא-נתונים של סרטונים. צריך לציין את המטא-נתונים רק כשנתוני הסרטון מוצגים ב-inlineData או ב-fileData.
| ייצוג ב-JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
Blob
בייטים של מדיה גולמית.
אסור לשלוח טקסט כבייטים גולמיים, צריך להשתמש בשדה 'text'.
mimeType
string
סוג ה-MIME התקני של IANA של נתוני המקור. דוגמאות לסוגים נתמכים: – תמונות: image/png, image/jpeg, image/jpg, image/webp, image/heic, image/heif, image/gif, image/avif – אודיו: audio/*, video/audio/s16le, video/audio/wav – וידאו: video/* – טקסט: text/plain, text/html, text/css, text/javascript, text/x-typescript, text/csv, text/markdown, text/x-python, text/xml, text/rtf, video/text/timestamp – אפליקציות: application/x-javascript, application/x-typescript, application/x-python-code, application/json, application/x-ipynb+json, application/rtf, application/pdf למידע נוסף, אפשר לעיין במאמר בנושא פורמטים נתמכים של קבצים. //
data
string (bytes format)
בייטים גולמיים לפורמטים של מדיה.
מחרוזת בקידוד Base64.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
FunctionCall
תחזית FunctionCall שמוחזרת מהמודל ומכילה מחרוזת שמייצגת את FunctionDeclaration.name עם הארגומנטים והערכים שלהם.
id
string
אופציונלי. מזהה ייחודי של הקריאה לפונקציה. אם השדה הזה מאוכלס, הלקוח יבצע את functionCall ויחזיר את התשובה עם id תואם.
name
string
חובה. השם של הפונקציה שרוצים להפעיל. הערך חייב להיות a-z, A-Z, 0-9, או להכיל קווים תחתונים ומקפים, עם אורך מקסימלי של 128 תווים.
args
object (Struct format)
אופציונלי. הפרמטרים והערכים של הפונקציה בפורמט אובייקט JSON.
| ייצוג ב-JSON |
|---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
פלט התוצאה מ-FunctionCall שמכיל מחרוזת שמייצגת את FunctionDeclaration.name ואובייקט JSON מובנה שמכיל פלט מהפונקציה, משמש כהקשר למודל. התג הזה צריך להכיל את התוצאה של FunctionCall שנוצרה על סמך חיזוי של המודל.
id
string
אופציונלי. המזהה של קריאת הפונקציה שאליה מתייחסת התגובה. השדה מאוכלס על ידי הלקוח כדי להתאים לקריאה המתאימה לפונקציה id.
name
string
חובה. השם של הפונקציה שרוצים להפעיל. הערך חייב להיות a-z, A-Z, 0-9, או להכיל קווים תחתונים ומקפים, עם אורך מקסימלי של 128 תווים.
response
object (Struct format)
חובה. התגובה של הפונקציה בפורמט אובייקט JSON. המשתמשים יכולים להשתמש בכל מפתח שמתאים לתחביר של הפונקציה כדי להחזיר את הפלט של הפונקציה, למשל'פלט', 'תוצאה' וכו'. בפרט, אם קריאת הפונקציה נכשלה, התגובה יכולה לכלול מפתח 'שגיאה' כדי להחזיר פרטי שגיאה למודל.
אפשר לכלול מולטימדיה באמצעות אובייקט משנה שמכיל מפתח יחיד בשם $ref, שהערך שלו הוא inlineData.display_name של FunctionResponsePart שמכיל את המולטימדיה. מידע נוסף זמין בכתובת https://ai.google.dev/gemini-api/docs/function-calling#multimodal.
parts[]
object (FunctionResponsePart)
אופציונלי. מסודרים Parts שמרכיבים תגובה של פונקציה. יכול להיות שלחלקים יהיו סוגי MIME שונים של IANA.
willContinue
boolean
אופציונלי. אות לכך שהבקשה להפעלת הפונקציה נמשכת, ויוחזרו עוד תשובות, מה שהופך את הבקשה להפעלת הפונקציה לגנרטור. ההגדרה הזו רלוונטית רק להפעלות של פונקציות מסוג NON_BLOCKING, אחרת המערכת מתעלמת ממנה. אם המדיניות מוגדרת כ-false, תשובות עתידיות לא ייכללו. מותר להחזיר response ריק עם willContinue=False כדי לציין שקריאת הפונקציה הסתיימה. יכול להיות שהפעולה הזו עדיין תפעיל את יצירת המודל. כדי למנוע הפעלה של יצירה ולסיים את הקריאה לפונקציה, צריך להגדיר בנוסף את scheduling ל-SILENT.
scheduling
enum (Scheduling)
אופציונלי. מציינים איך לתזמן את התשובה בשיחה. ההגדרה רלוונטית רק להפעלות של פונקציות מסוג NON_BLOCKING, אחרת המערכת מתעלמת ממנה. ברירת המחדל היא WHEN_IDLE.
| ייצוג ב-JSON |
|---|
{ "id": string, "name": string, "response": { object }, "parts": [ { object ( |
FunctionResponsePart
סוג נתונים שמכיל מדיה שמהווה חלק מהודעה ב-FunctionResponse.
FunctionResponsePart מורכב מנתונים שמשויך אליהם סוג נתונים. FunctionResponsePart יכול להכיל רק סוג אחד מבין הסוגים הקבילים שמופיעים בFunctionResponsePart.data.
אם השדה inlineData מלא בבייטים גולמיים, FunctionResponsePart חייב לכלול סוג MIME קבוע של IANA שמזהה את הסוג ותת-הסוג של המדיה.
data
Union type
data יכול להיות רק אחד מהבאים:inlineData
object (FunctionResponseBlob)
בייטים של מדיה בתוך הטקסט.
| ייצוג ב-JSON |
|---|
{
// data
"inlineData": {
object ( |
FunctionResponseBlob
בייטים של מדיה גולמית בתגובה של הפונקציה.
אסור לשלוח טקסט כבייטים גולמיים, צריך להשתמש בשדה FunctionResponse.response.
mimeType
string
סוג ה-MIME התקני של IANA של נתוני המקור. דוגמאות: - image/png - image/jpeg אם תספקו סוג MIME שלא נתמך, תוחזר שגיאה. רשימה מלאה של הסוגים הנתמכים זמינה במאמר פורמטים נתמכים של קבצים.
data
string (bytes format)
בייטים גולמיים לפורמטים של מדיה.
מחרוזת בקידוד Base64.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
תזמון
מציינים איך לתזמן את התשובה בשיחה.
| טיפוסים בני מנייה (enum) | |
|---|---|
SCHEDULING_UNSPECIFIED |
הערך הזה לא בשימוש. |
SILENT |
רק תוסיף את התוצאה להקשר של השיחה, אל תקטיע או תפעיל יצירה. |
WHEN_IDLE |
להוסיף את התוצאה להקשר של השיחה ולתת הנחיה ליצור פלט בלי להפריע ליצירה שמתבצעת. |
INTERRUPT |
להוסיף את התוצאה להקשר של השיחה, להפסיק את היצירה המתמשכת ולבקש ליצור פלט. |
FileData
נתונים שמבוססים על URI.
mimeType
string
אופציונלי. סוג ה-MIME התקני של IANA של נתוני המקור.
fileUri
string
חובה. URI.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
קוד שנוצר על ידי המודל ומיועד להרצה, והתוצאה שמוחזרת למודל.
נוצר רק כשמשתמשים בכלי CodeExecution, שבו הקוד יופעל באופן אוטומטי, וגם ייווצר CodeExecutionResult תואם.
id
string
אופציונלי. המזהה הייחודי של החלק ExecutableCode. השרת מחזיר את CodeExecutionResult עם id התואם.
language
enum (Language)
חובה. שפת התכנות של code.
code
string
חובה. הקוד שיופעל.
| ייצוג ב-JSON |
|---|
{
"id": string,
"language": enum ( |
שפה
שפות התכנות הנתמכות לקוד שנוצר.
| טיפוסים בני מנייה (enum) | |
|---|---|
LANGUAGE_UNSPECIFIED |
לא נבחרה שפה. אין להשתמש בערך הזה. |
PYTHON |
Python >= 3.10, עם numpy ו-simpy. שפת ברירת המחדל היא Python. |
CodeExecutionResult
התוצאה של הפעלת ExecutableCode.
נוצר רק כשמשתמשים בכלי CodeExecution.
id
string
אופציונלי. המזהה של החלק ExecutableCode שאליו מתייחסת התוצאה הזו. הערך מאוכלס רק אם לרכיב ExecutableCode התואם יש מזהה.
outcome
enum (Outcome)
חובה. תוצאת הרצת הקוד.
output
string
אופציונלי. התשובה מכילה את הפלט הרגיל (stdout) אם ביצוע הקוד מצליח, או את הפלט לשגיאות (stderr) או תיאור אחר אם הביצוע נכשל.
| ייצוג ב-JSON |
|---|
{
"id": string,
"outcome": enum ( |
תוצאה
ספירה של התוצאות האפשריות של הרצת הקוד.
| טיפוסים בני מנייה (enum) | |
|---|---|
OUTCOME_UNSPECIFIED |
הסטטוס לא צוין. אין להשתמש בערך הזה. |
OUTCOME_OK |
ביצוע הקוד הושלם בהצלחה. output מכיל את הפלט הרגיל (stdout), אם יש כזה. |
OUTCOME_FAILED |
ההרצה של הקוד נכשלה. output מכיל את stderr ו-stdout, אם יש. |
OUTCOME_DEADLINE_EXCEEDED |
ההרצה של הקוד נמשכה יותר מדי זמן והיא בוטלה. יכול להיות שיהיה output חלקי, אבל לא בהכרח. |
ToolCall
ToolCall צד השרת שהוחזרה מהמודל. ההודעה הזו מכילה מידע על כלי שהמודל רוצה להפעיל. הלקוח לא אמור להפעיל את ToolCall הזה. במקום זאת, הלקוח צריך להעביר את ToolCall בחזרה ל-API בתור הבא בהודעה Content, יחד עם ToolResponse התואם.
id
string
אופציונלי. מזהה ייחודי של קריאה לכלי. השרת מחזיר את התגובה של הכלי עם id התואם.
toolName
string
אופציונלי. שם הכלי שהופעל.
toolType
enum (ToolType)
חובה. סוג הכלי שהופעל.
args
object (Struct format)
אופציונלי. הארגומנטים של הקריאה לכלי. דוגמה: {"arg1" : "value1", "arg2" : "value2" , ...}
| ייצוג ב-JSON |
|---|
{
"id": string,
"toolName": string,
"toolType": enum ( |
ToolType
סוג הכלי בקריאה לפונקציה.
| טיפוסים בני מנייה (enum) | |
|---|---|
TOOL_TYPE_UNSPECIFIED |
סוג הכלי לא צוין. |
GOOGLE_SEARCH_WEB |
כלי חיפוש Google, מיפוי ל-Tool.google_search.search_types.web_search. |
GOOGLE_SEARCH_IMAGE |
כלי לחיפוש תמונות, ממופה ל-Tool.google_search.search_types.image_search. |
URL_CONTEXT |
כלי ההקשר של כתובת URL, ממופה אל Tool.url_context. |
GOOGLE_MAPS |
כלי מפות Google, maps אל Tool.google_maps. |
FILE_SEARCH |
כלי לחיפוש קבצים, שמתאים ל-Tool.file_search. |
ToolResponse
הפלט מהרצה של ToolCall בצד השרת. ההודעה הזו מכילה את התוצאות של הפעלת כלי שהופעלה על ידי ToolCall מהמודל. הלקוח צריך להעביר את ToolResponse בחזרה ל-API בתור הבא בהודעה Content, יחד עם ToolCall התואם.
id
string
אופציונלי. המזהה של קריאת הכלי שאליה מתייחסת התשובה הזו.
toolType
enum (ToolType)
חובה. סוג הכלי שהופעל, בהתאם ל-toolType ב-ToolCall המתאים.
response
object (Struct format)
אופציונלי. התשובה של הכלי.
| ייצוג ב-JSON |
|---|
{
"id": string,
"toolType": enum ( |
VideoMetadata
הוצא משימוש: במקומו, צריך להשתמש ב-GenerateContentRequest.processing_options. המטא-נתונים מתארים את תוכן הווידאו של הקלט.
startOffset
string (Duration format)
אופציונלי. ההפרש להתחלת הסרטון.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
endOffset
string (Duration format)
אופציונלי. ההיסט של סוף הסרטון.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
fps
number
אופציונלי. קצב הפריימים של הסרטון שנשלח למודל. אם לא מציינים ערך, ברירת המחדל היא 1.0. טווח ה-fps הוא (0.0, 24.0].
| ייצוג ב-JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
רזולוציית המדיה ליצירת טוקנים.
value
Union type
value יכול להיות רק אחד מהבאים:level
enum (Level)
איכות הטוקניזציה שנעשה בה שימוש במדיה מסוימת.
| ייצוג ב-JSON |
|---|
{
// value
"level": enum ( |
רמה
רמת הרזולוציה של המדיה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
לא הוגדרה רזולוציה למדיה. |
MEDIA_RESOLUTION_LOW |
הרזולוציה של המדיה מוגדרת לנמוכה. |
MEDIA_RESOLUTION_MEDIUM |
רזולוציית המדיה מוגדרת לבינונית. |
MEDIA_RESOLUTION_HIGH |
רזולוציית המדיה מוגדרת כגבוהה. |
MEDIA_RESOLUTION_ULTRA_HIGH |
רזולוציית המדיה מוגדרת לרזולוציה גבוהה במיוחד. |
MediaProcessing
איך המודל מעבד מדיה כקלט כדי להבין אותה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MEDIA_PROCESSING_UNSPECIFIED |
ברירת מחדל. העיבוד מתבצע בהתאם למודל הספציפי (3.5 Pro+ -> AGENTIC, מודלים ישנים יותר -> STATIC). |
STATIC |
חילוץ פריימים בקצב קבוע. כל המסגרות מוצבות בהקשר. |
AGENTIC |
ניווט דינמי מבוסס-מודל. מומלץ לרוב תרחישי השימוש. |
סביבה
סביבת הפעלה של סוכן.
id
string
חובה. פלט בלבד. המזהה של הסביבה.
sources[]
object (Source)
מקורות שיועלו לסביבה.
created
string
פלט בלבד. השעה שבה הסביבה נוצרה בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
updated
string
פלט בלבד. השעה שבה הסביבה עודכנה לאחרונה בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
lastAccessed
string
פלט בלבד. השעה שבה הייתה גישה אחרונה לסביבה בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
status
enum (Status)
פלט בלבד. הסטטוס של קונטיינר הסביבה.
fileCount
string (int64 format)
פלט בלבד. מספר הקבצים בסביבה, פלט בלבד.
sizeBytes
string (int64 format)
פלט בלבד. הגודל הכולל של קובצי הסביבה בבייטים, פלט בלבד.
network
Union type
network יכול להיות רק אחד מהבאים:networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
התרה של דומיינים ספציפיים בלבד.
networkMode
enum (NetworkMode)
מצב יציאה מהרשת.
| ייצוג ב-JSON |
|---|
{ "id": string, "sources": [ { object ( |
סטטוס
הסטטוס של הסביבה.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATUS_UNSPECIFIED |
|
ACTIVE |
|
EXPIRED |
|
NetworkMode
מצב יציאה מהרשת להגדרות שלא נכללות ברשימת ההיתרים.
| טיפוסים בני מנייה (enum) | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
DISABLED |
כל תעבורת הנתונים היוצאת מהרשת חסומה. |
סכימה
אובייקט Schema מאפשר להגדיר את סוגי נתוני הקלט והפלט. הסוגים האלה יכולים להיות אובייקטים, אבל גם פרימיטיבים ומערכים. מייצג קבוצת משנה נבחרת של אובייקט סכימה של OpenAPI 3.0.
type
enum (Type)
חובה. סוג הנתונים.
format
string
אופציונלי. הפורמט של הנתונים. מותר להשתמש בכל ערך, אבל ברוב המקרים לא מופעלת פונקציונליות מיוחדת.
title
string
אופציונלי. השם של הסכימה.
description
string
אופציונלי. תיאור קצר של הפרמטר. יכול להיות שיהיו בה דוגמאות לשימוש. התיאור של הפרמטר יכול להיות בפורמט Markdown.
nullable
boolean
אופציונלי. מציין אם הערך יכול להיות null.
enum[]
string
אופציונלי. ערכים אפשריים של רכיב מסוג STRING עם פורמט enum. לדוגמה, אפשר להגדיר כיוון Enum כך : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
אופציונלי. המספר המקסימלי של הרכיבים עבור Type.ARRAY.
minItems
string (int64 format)
אופציונלי. מספר המינימום של הרכיבים עבור Type.ARRAY.
properties
map (key: string, value: object (Schema))
אופציונלי. מאפיינים של Type.OBJECT.
אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]
string
אופציונלי. מאפייני חובה של Type.OBJECT.
minProperties
string (int64 format)
אופציונלי. מספר המינימלי של המאפיינים עבור Type.OBJECT.
maxProperties
string (int64 format)
אופציונלי. מספר המאפיינים המקסימלי עבור Type.OBJECT.
minLength
string (int64 format)
אופציונלי. שדות סכימה של סוג STRING אורך מינימלי של סוג STRING
maxLength
string (int64 format)
אופציונלי. האורך המקסימלי של Type.STRING
pattern
string
אופציונלי. תבנית של Type.STRING להגבלת מחרוזת לביטוי רגולרי.
example
value (Value format)
אופציונלי. דוגמה לאובייקט. השדה יאוכלס רק אם האובייקט הוא השורש.
anyOf[]
object (Schema)
אופציונלי. הערך צריך להיות מאומת מול כל אחת (אחת או יותר) מסכימות המשנה ברשימה.
propertyOrdering[]
string
אופציונלי. סדר המאפיינים. זה לא שדה רגיל במפרט של Open API. הוא משמש לקביעת סדר המאפיינים בתגובה.
default
value (Value format)
אופציונלי. ערך ברירת המחדל של השדה. לפי סכימת JSON, השדה הזה מיועד לגנרטורים של תיעוד ולא משפיע על האימות. לכן הוא נכלל כאן ומתעלמים ממנו, כדי שמפתחים ששולחים סכימות עם שדה default לא יקבלו שגיאות של שדה לא מוכר.
items
object (Schema)
אופציונלי. סכימה של רכיבים מסוג ARRAY.
minimum
number
אופציונלי. שדות סכמה לסוגים INTEGER ו-NUMBER הערך המינימלי של Type.INTEGER ו-Type.NUMBER
maximum
number
אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
סוג
הסוג מכיל את רשימת סוגי הנתונים של OpenAPI כפי שהוגדרו בכתובת https://spec.openapis.org/oas/v3.0.3#data-types
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
לא צוין, אין להשתמש. |
STRING |
סוג המחרוזת. |
NUMBER |
סוג המספר. |
INTEGER |
סוג Integer. |
BOOLEAN |
טיפוס בוליאני. |
ARRAY |
סוג המערך. |
OBJECT |
סוג האובייקט. |
NULL |
סוג Null. |
כלי
- ייצוג ב-JSON
- FunctionDeclaration
- התנהגות
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- המצב
- CodeExecution
- GoogleSearch
- Interval
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- סביבה
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
פרטי כלי שהמודל עשוי להשתמש בהם כדי ליצור תשובה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נכללות בידע של המודל או בהיקף שלו.
המזהה הבא: 17
functionDeclarations[]
object (FunctionDeclaration)
אופציונלי. רשימה של FunctionDeclarations שזמינות למודל שאפשר להשתמש בהן לקריאה לפונקציות.
המודל או המערכת לא מבצעים את הפונקציה. במקום זאת, הפונקציה המוגדרת עשויה להיות מוחזרת כ-FunctionCall עם ארגומנטים לצד הלקוח לצורך ביצוע. יכול להיות שהמודל יחליט להפעיל קבוצת משנה של הפונקציות האלה על ידי מילוי FunctionCall בתגובה. התור הבא בשיחה עשוי להכיל FunctionResponse עם הקשר ליצירת Content.role 'פונקציה' לתור הבא של המודל.
googleSearchRetrieval
object (GoogleSearchRetrieval)
אופציונלי. כלי לאחזור מידע שמבוסס על חיפוש Google.
codeExecution
object (CodeExecution)
אופציונלי. ההגדרה הזו מאפשרת למודל להריץ קוד כחלק מהיצירה.
googleSearch
object (GoogleSearch)
אופציונלי. סוג הכלי GoogleSearch. כלי לתמיכה בחיפוש Google במודל. מופעל על ידי Google.
computerUse
object (ComputerUse)
אופציונלי. כלי לתמיכה באינטראקציה של המודל ישירות עם המחשב. אם האפשרות הזו מופעלת, המערכת מאכלסת באופן אוטומטי הצהרות פונקציה ספציפיות לשימוש במחשב.
urlContext
object (UrlContext)
אופציונלי. כלי לתמיכה באחזור הקשר של כתובת URL.
fileSearch
object (FileSearch)
אופציונלי. סוג הכלי FileSearch. כלי לאחזור ידע ממאגרי מידע של אחזור סמנטי.
mcpServers[]
object (McpServer)
אופציונלי. שרתי MCP לחיבור.
googleMaps
object (GoogleMaps)
אופציונלי. כלי שמאפשר להוסיף לתשובה של המודל הקשר גיאוספציאלי שקשור לשאילתה של המשתמש.
| ייצוג ב-JSON |
|---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
ייצוג מובנה של הצהרת פונקציה כמוגדר במפרט OpenAPI 3.03. ההצהרה הזו כוללת את שם הפונקציה והפרמטרים שלה. ה-FunctionDeclaration הזה הוא ייצוג של בלוק קוד שאפשר להשתמש בו כTool על ידי המודל, והוא מופעל על ידי הלקוח.
name
string
חובה. שם הפונקציה. הערך חייב להיות a-z, A-Z, 0-9, או להכיל קווים תחתונים, נקודותיים, נקודות ומקפים, עם אורך מקסימלי של 128 תווים.
description
string
חובה. תיאור קצר של הפונקציה.
behavior
enum (Behavior)
אופציונלי. מציינת את התנהגות הפונקציה. בשלב הזה יש תמיכה רק בשיטה BidiGenerateContent.
parameters
object (Schema)
אופציונלי. תיאור הפרמטרים של הפונקציה. משקף את מחרוזת המפתח של אובייקט הפרמטר Open API 3.03: שם הפרמטר. השמות של הפרמטרים הם תלויי אותיות רישיות. ערך הסכימה: הסכימה שמגדירה את הסוג שמשמש לפרמטר.
parametersJsonSchema
value (Value format)
אופציונלי. תיאור הפרמטרים של הפונקציה בפורמט JSON Schema. הסכימה צריכה לתאר אובייקט שבו המאפיינים הם הפרמטרים של הפונקציה. לדוגמה:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
השדה הזה לא יכול להופיע יחד עם השדה parameters.
response
object (Schema)
אופציונלי. מתאר את הפלט מהפונקציה הזו בפורמט JSON Schema. משקף את אובייקט התגובה של Open API 3.03. הסכימה מגדירה את הסוג שמשמש לערך התגובה של הפונקציה.
responseJsonSchema
value (Value format)
אופציונלי. מתאר את הפלט מהפונקציה הזו בפורמט JSON Schema. הערך שצוין בסכימה הוא ערך התגובה של הפונקציה.
השדה הזה לא יכול להופיע יחד עם השדה response.
התנהגות
הגדרת אופן הפעולה של הפונקציה. ברירת המחדל היא BLOCKING.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED |
הערך הזה לא בשימוש. |
BLOCKING |
אם ההגדרה הזו מוגדרת, המערכת תמתין לקבלת התשובה של הפונקציה לפני שתמשיך את השיחה. |
NON_BLOCKING |
אם ההגדרה הזו מוגדרת, המערכת לא תמתין לקבלת התגובה של הפונקציה. במקום זאת, הוא ינסה לטפל בתשובות של פונקציות כשהן יהיו זמינות, תוך שמירה על השיחה בין המשתמש לבין המודל. |
GoogleSearchRetrieval
כלי לשליפת נתונים ציבוריים מהאינטרנט לצורך ביסוס, מבית Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig)
מציין את הגדרת האחזור הדינמי של המקור הנתון.
| ייצוג ב-JSON |
|---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
תיאור האפשרויות להתאמה אישית של אחזור דינמי.
mode
enum (Mode)
המצב של כלי החיזוי שישמש לאחזור דינמי.
dynamicThreshold
number
סף הערך שישמש לאחזור דינמי. אם לא מגדירים את המדיניות, המערכת תשתמש בערך ברירת המחדל.
| ייצוג ב-JSON |
|---|
{
"mode": enum ( |
מצב
המצב של כלי החיזוי שישמש לאחזור דינמי.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODE_UNSPECIFIED |
תמיד מפעילים אחזור. |
MODE_DYNAMIC |
הפעלה של אחזור רק כשהמערכת מחליטה שזה נחוץ. |
CodeExecution
בסוג הזה אין שדות.
כלי שמריץ קוד שנוצר על ידי המודל ומחזיר את התוצאה למודל באופן אוטומטי.
אפשר גם לעיין בExecutableCode ובCodeExecutionResult, שנוצרים רק כשמשתמשים בכלי הזה.
GoogleSearch
סוג הכלי GoogleSearch. כלי לתמיכה בחיפוש Google במודל. מופעל על ידי Google.
timeRangeFilter
object (Interval)
אופציונלי. סינון תוצאות החיפוש לפי טווח זמן מסוים. אם הלקוחות מגדירים שעת התחלה, הם חייבים להגדיר גם שעת סיום (ולהיפך).
searchTypes
object (SearchTypes)
אופציונלי. קבוצת סוגי החיפוש שרוצים להפעיל. אם לא מגדירים את המדיניות, החיפוש באינטרנט מופעל כברירת מחדל.
| ייצוג ב-JSON |
|---|
{ "timeRangeFilter": { object ( |
מרווח
מייצג מרווח זמן, שמקודד כחותמת זמן של התחלה (כולל) וחותמת זמן של סיום (לא כולל).
ערך ההתחלה חייב להיות קטן מערך הסיום או שווה לו. אם שעת ההתחלה זהה לשעת הסיום, המרווח ריק (לא תואם לאף שעה). אם לא מציינים תאריך התחלה וסיום, המרווח מתאים לכל זמן.
startTime
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".
| ייצוג ב-JSON |
|---|
{ "startTime": string, "endTime": string } |
SearchTypes
סוגים שונים של חיפושים שאפשר להפעיל בכלי GoogleSearch.
webSearch
object (WebSearch)
אופציונלי. הפעלת חיפוש באינטרנט. רק תוצאות טקסט מוחזרות.
imageSearch
object (ImageSearch)
אופציונלי. הפעלת חיפוש תמונות. הפונקציה מחזירה את בייטים של התמונה.
| ייצוג ב-JSON |
|---|
{ "webSearch": { object ( |
WebSearch
בסוג הזה אין שדות.
חיפוש רגיל באינטרנט לצורך ביסוס והגדרות קשורות.
ImageSearch
בסוג הזה אין שדות.
חיפוש תמונות להארקה ולהגדרות קשורות.
ComputerUse
סוג הכלי 'שימוש במחשב'.
environment
enum (Environment)
חובה. הסביבה שבה מתבצעת הפעולה.
excludedPredefinedFunctions[]
string
אופציונלי. כברירת מחדל, פונקציות מוגדרות מראש נכללות בקריאה הסופית למודל. אפשר להחריג חלק מהם באופן מפורש כך שלא ייכללו באופן אוטומטי. הפעולה הזו יכולה לשמש לשתי מטרות: 1. שימוש במרחב פעולה מוגבל יותר או שונה. 2. שיפור ההגדרות או ההוראות של פונקציות מוגדרות מראש.
enablePromptInjectionDetection
boolean
אופציונלי. האם להפעיל את הבדיקה לאיתור החדרת פרומפטים בבקשה לשימוש במחשב.
disabledSafetyPolicies[]
enum (SafetyPolicy)
אופציונלי. השבתת מדיניות הבטיחות לשימוש במחשב.
| ייצוג ב-JSON |
|---|
{ "environment": enum ( |
סביבה
מייצג את הסביבה שבה מתבצעת הפעולה, כמו דפדפן אינטרנט.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
ברירת המחדל היא דפדפן. |
ENVIRONMENT_BROWSER |
פועל בדפדפן אינטרנט. |
ENVIRONMENT_MOBILE |
פועל בסביבה ניידת. |
ENVIRONMENT_DESKTOP |
פועל בסביבת מחשב. |
SafetyPolicy
כללי מדיניות מוגדרים מראש בנושא בטיחות השימוש במחשב.
| טיפוסים בני מנייה (enum) | |
|---|---|
SAFETY_POLICY_UNSPECIFIED |
מדיניות בטיחות לא מוגדרת. |
FINANCIAL_TRANSACTIONS |
מדיניות הבטיחות בנושא עסקאות פיננסיות. |
SENSITIVE_DATA_MODIFICATION |
מדיניות בטיחות לשינוי מידע אישי רגיש. |
COMMUNICATION_TOOL |
מדיניות בטיחות לכלים לתקשורת (למשל Gmail, Chat, Meet). |
ACCOUNT_CREATION |
מדיניות בנושא בטיחות ליצירת חשבון. |
DATA_MODIFICATION |
מדיניות בטיחות לשינוי נתונים. |
USER_CONSENT_MANAGEMENT |
מדיניות בנושא בטיחות לניהול הסכמת משתמשים. |
LEGAL_TERMS_AND_AGREEMENTS |
מדיניות בטיחות בנוגע לתנאים ולהסכמים משפטיים. |
UrlContext
בסוג הזה אין שדות.
כלי לתמיכה באחזור הקשר של כתובת URL.
FileSearch
הכלי FileSearch שמאחזר ידע ממאגרי מידע של אחזור סמנטי. הקבצים מיובאים למאגרי המידע של Semantic Retrieval באמצעות ImportFile API.
fileSearchStoreNames[]
string
חובה. השמות של fileSearchStores שמהם רוצים לאחזר. לדוגמה: fileSearchStores/my-file-search-store-123
metadataFilter
string
אופציונלי. מסנן מטא-נתונים להחלה על המסמכים ועל חלקי הטקסט שחולצו באמצעות אחזור סמנטי.
topK
integer
אופציונלי. מספר החלקים של אחזור סמנטי שיש לאחזר.
| ייצוג ב-JSON |
|---|
{ "fileSearchStoreNames": [ string ], "metadataFilter": string, "topK": integer } |
McpServer
שרת MCP הוא שרת שהמודל יכול להפעיל כדי לבצע פעולות. זהו שרת שמיישם את פרוטוקול ה-MCP. המזהה הבא: 6
name
string
השם של ה-MCPServer.
transport
Union type
transport יכול להיות רק אחד מהבאים:streamableHttpTransport
object (StreamableHttpTransport)
העברה שיכולה להזרים בקשות ותגובות HTTP.
| ייצוג ב-JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
העברה שיכולה להזרים בקשות ותגובות HTTP. המזהה הבא: 6
url
string
כתובת ה-URL המלאה של נקודת הקצה של שרת ה-MCP. דוגמה: "https://api.example.com/mcp"
headers
map (key: string, value: string)
אופציונלי: שדות לכותרות אימות, פסק זמן וכו', אם צריך.
אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
timeout
string (Duration format)
פסק זמן של HTTP לפעולות רגילות.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
sseReadTimeout
string (Duration format)
הזמן הקצוב לתפוגה של פעולות קריאה של SSE.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
terminateOnClose
boolean
האם לסגור את סשן הלקוח כשההעברה נסגרת.
| ייצוג ב-JSON |
|---|
{ "url": string, "headers": { string: string, ... }, "timeout": string, "sseReadTimeout": string, "terminateOnClose": boolean } |
GoogleMaps
כלי Google Maps שמספק הקשר גיאוגרפי לשאילתה של המשתמש.
enableWidget
boolean
אופציונלי. האם להחזיר טוקן של הקשר של הווידג'ט ב-GroundingMetadata של התגובה. מפתחים יכולים להשתמש בטוקן של הקשר של הווידג'ט כדי להציג ווידג'ט של מפות Google עם הקשר גיאוגרפי שקשור למקומות שהמודל מתייחס אליהם בתשובה.
| ייצוג ב-JSON |
|---|
{ "enableWidget": boolean } |
משאב REST: auth_tokens
- משאב: AuthToken
- BidiGenerateContentSetup
- GenerationConfig
- אופן הפעולה
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
- ResponseFormatConfig
- TextResponseFormat
- MimeType
- AudioResponseFormat
- MimeType
- משלוח
- ImageResponseFormat
- MimeType
- משלוח
- AspectRatio
- ImageSize
- TranslationConfig
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- HistoryConfig
- Methods
משאב: AuthToken
בקשה ליצירת טוקן אימות זמני.
name
string
פלט בלבד. מזהה. האסימון עצמו.
expireTime
string (Timestamp format)
אופציונלי. קלט בלבד. אי אפשר לשנות. זמן אופציונלי שאחריו, כשמשתמשים בטוקן שנוצר, הודעות בסשנים של BidiGenerateContent יידחו. (Gemini עשוי לסגור את הסשן לפני הזמן הזה).
אם לא מגדירים את התדירות, ברירת המחדל היא 30 דקות. אם מאכלסים אותו, הערך הזה צריך להיות פחות מ-20 שעות בעתיד.
הפלט שנוצר תמיד יהיה בפורמט 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".
newSessionExpireTime
string (Timestamp format)
אופציונלי. קלט בלבד. אי אפשר לשנות. הזמן שאחריו בקשות חדשות להפעלת Live API באמצעות הטוקן שמתקבל מהבקשה הזו יידחו.
אם לא מגדירים את ההגדרה הזו, ברירת המחדל בעתיד תהיה 60 שניות. אם מאכלסים אותו, הערך הזה צריך להיות פחות מ-20 שעות בעתיד.
הפלט שנוצר תמיד יהיה בפורמט 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".
fieldMask
string (FieldMask format)
אופציונלי. קלט בלבד. אי אפשר לשנות. אם fieldMask ריק, ו-bidiGenerateContentSetup לא קיים, אז ההודעה האפקטיבית BidiGenerateContentSetup נלקחת מהחיבור הפעיל ל-API.
אם fieldMask ריק, ו-bidiGenerateContentSetup is קיים, אז ההודעה האפקטיבית BidiGenerateContentSetup נלקחת כולה מ-bidiGenerateContentSetup בבקשה הזו. הודעת ההגדרה מחיבור Live API מוזנחת.
אם fieldMask לא ריק, השדות התואמים מ-bidiGenerateContentSetup יחליפו את השדות מהודעת ההגדרה בחיבור ה-API בזמן אמת.
זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
config
Union type
config יכול להיות רק אחד מהבאים:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
אופציונלי. קלט בלבד. אי אפשר לשנות. הגדרה ספציפית ל-BidiGenerateContent.
uses
integer
אופציונלי. קלט בלבד. אי אפשר לשנות. מספר הפעמים שבהם אפשר להשתמש באסימון. אם הערך הוא אפס, לא מוחלת מגבלה. חידוש של סשן API בשידור חי לא נחשב כשימוש. אם לא מציינים ערך, ברירת המחדל היא 1.
| ייצוג ב-JSON |
|---|
{
"name": string,
"expireTime": string,
"newSessionExpireTime": string,
"fieldMask": string,
// config
"bidiGenerateContentSetup": {
object ( |
BidiGenerateContentSetup
ההודעה שתישלח ב-BidiGenerateContentClientMessage הראשון (ורק בו). מכיל הגדרה שתחול למשך ה-RPC של הסטרימינג.
הלקוחות צריכים להמתין להודעה BidiGenerateContentSetupComplete לפני שליחת הודעות נוספות.
model
string
חובה. שם המשאב של המודל. הערך הזה משמש כמזהה לשימוש במודל.
פורמט: models/{model}
generationConfig
object (GenerationConfig)
אופציונלי. הגדרות ליצירה.
אין תמיכה בשדות הבאים:
responseLogprobsresponseMimeTypelogprobsresponseSchemaresponseJsonSchemastop_sequenceskipResponseCacherouting_configaudio_timestamp
systemInstruction
object (Content)
אופציונלי. הוראות המערכת שהמשתמש סיפק למודל.
הערה: צריך להשתמש רק בטקסט בחלקים, והתוכן בכל חלק יהיה בפסקה נפרדת.
tools[]
object (Tool)
אופציונלי. רשימה של Tools שהמודל עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נכללות בידע של המודל או בהיקף שלו.
realtimeInputConfig
object (RealtimeInputConfig)
אופציונלי. הגדרת הטיפול בקלט בזמן אמת.
sessionResumption
object (SessionResumptionConfig)
אופציונלי. הגדרת מנגנון לחידוש סשן.
אם הוא כלול, השרת ישלח SessionResumptionUpdate הודעות.
contextWindowCompression
object (ContextWindowCompressionConfig)
אופציונלי. הגדרת מנגנון דחיסה של חלון הקשר.
אם הוא נכלל, השרת יקטין אוטומטית את גודל ההקשר כשהוא יעלה על האורך שהוגדר.
inputAudioTranscription
object (AudioTranscriptionConfig)
אופציונלי. אם ההגדרה מופעלת, מתבצע תמלול של קלט קולי. התמלול מותאם לשפת האודיו של הקלט, אם היא מוגדרת.
outputAudioTranscription
object (AudioTranscriptionConfig)
אופציונלי. אם ההגדרה הזו מופעלת, מתבצע תמלול של פלט האודיו של המודל. התמליל מותאם לקוד השפה שצוין לאודיו של הפלט, אם הוא הוגדר.
historyConfig
object (HistoryConfig)
אופציונלי. הגדרת חילופי ההיסטוריה בין הלקוח לשרת.
| ייצוג ב-JSON |
|---|
{ "model": string, "generationConfig": { object ( |
GenerationConfig
אפשרויות ההגדרה ליצירת מודלים ולפלטים. לא כל הפרמטרים ניתנים להגדרה בכל מודל.
stopSequences[]
string
אופציונלי. קבוצת רצפי התווים (עד 5) שיגרמו להפסקת יצירת הפלט. אם מציינים את הפרמטר הזה, ה-API יפסיק כשיופיע בפעם הראשונה התו stop_sequence. רצף העצירה לא ייכלל בתשובה.
responseMimeType
string
אופציונלי. סוג ה-MIME של הטקסט המוצע שנוצר. סוגי ה-MIME הנתמכים הם: text/plain: (ברירת מחדל) פלט טקסט. application/json: תגובת JSON במועמדים לתגובה. text/x.enum: ENUM כמחרוזת תגובה במועמדים לתגובה. רשימה של כל סוגי ה-MIME הנתמכים של טקסט מופיעה במסמכים.
responseSchema
(deprecated)
object (Schema)
אופציונלי. סכימת הפלט של הטקסט המוצע שנוצר. הסכימות חייבות להיות קבוצת משנה של סכימת OpenAPI, והן יכולות להיות אובייקטים, פרימיטיבים או מערכים.
אם מגדירים את המדיניות הזו, צריך להגדיר גם מדיניות תואמת responseMimeType. סוגי MIME תואמים: application/json: סכימה לתגובת JSON. פרטים נוספים זמינים במדריך ליצירת טקסט JSON.
_responseJsonSchema
(deprecated)
value (Value format)
אופציונלי. סכימת הפלט של התשובה שנוצרה. זוהי חלופה ל-responseSchema שמקבלת JSON Schema.
אם מציינים את responseSchema, צריך להשמיט את responseMimeType. אם לא מציינים את, צריך לציין את.
יכול להיות שיישלח JSON Schema מלא, אבל לא כל התכונות נתמכות. באופן ספציפי, יש תמיכה רק במאפיינים הבאים:
$id$defs$ref$anchortypeformattitledescriptionenum(למחרוזות ולמספרים)itemsprefixItemsminItemsmaxItemsminimummaximumanyOfoneOf(הפירוש זהה ל-anyOf)propertiesadditionalPropertiesrequired
אפשר גם להגדיר את המאפיין propertyOrdering שאינו סטנדרטי.
הפניות מעגליות מפורקות במידה מוגבלת, ולכן אפשר להשתמש בהן רק במאפיינים לא חובה. (מאפיינים שניתן להגדיר להם ערך null לא מספיקים). אם הערך $ref מוגדר בסכימת משנה, אי אפשר להגדיר מאפיינים אחרים, למעט מאפיינים שמתחילים ב-$.
responseJsonSchema
value (Value format)
אופציונלי. פרט פנימי. במקום השדה הזה, צריך להשתמש ב-responseJsonSchema.
responseModalities[]
enum (Modality)
אופציונלי. האופנים המבוקשים של התגובה. מייצג את קבוצת המודאליות שהמודל יכול להחזיר, וצריך לצפות להן בתשובה. זוהי התאמה מדויקת לאופנויות של התגובה.
למודל יכולים להיות כמה שילובים של אמצעי תקשורת נתמכים. אם האופנים המבוקשים לא תואמים לאף אחת מהקומבינציות הנתמכות, תוחזר שגיאה.
רשימה ריקה שקולה לבקשה של טקסט בלבד.
candidateCount
integer
אופציונלי. מספר התשובות שנוצרו שיוחזרו. אם לא מגדירים ערך, ברירת המחדל היא 1. חשוב לדעת שהאפשרות הזו לא זמינה במודלים מהדור הקודם (משפחת Gemini 1.0)
maxOutputTokens
integer
אופציונלי. מספר האסימונים המקסימלי שאפשר לכלול במועמד לתשובה.
הערה: ערך ברירת המחדל משתנה בהתאם למודל. אפשר לראות את מאפיין Model.output_token_limit של Model שמוחזר מהפונקציה getModel.
temperature
number
אופציונלי. המדיניות קובעת את מידת הרנדומיזציה של הפלט.
הערה: ערך ברירת המחדל משתנה בהתאם למודל. אפשר לראות את מאפיין Model.temperature של Model שמוחזר מהפונקציה getModel.
הערכים יכולים לנוע בין [0.0, 2.0].
topP
number
אופציונלי. ההסתברות המצטברת המקסימלית של טוקנים שצריך לקחת בחשבון כשמבצעים דגימה.
המודל משתמש בשילוב של דגימת Top-k ודגימת Top-p (גרעין).
הטוקנים ממוינים לפי ההסתברויות שהוקצו להם, כך שרק הטוקנים הסבירים ביותר נלקחים בחשבון. דגימת Top-k מגבילה ישירות את המספר המקסימלי של טוקנים שצריך להתייחס אליהם, בעוד שדגימת Nucleus מגבילה את מספר הטוקנים על סמך ההסתברות המצטברת.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model והוא מצוין במאפיין Model.top_p שמוחזר מהפונקציה getModel. מאפיין topK ריק מציין שהמודל לא משתמש בדגימה של k התוצאות המובילות ולא מאפשר להגדיר topK בבקשות.
topK
integer
אופציונלי. מספר האסימונים המקסימלי שצריך לקחת בחשבון כשמבצעים דגימה.
המודלים של Gemini משתמשים בדגימה מסוג Top-p (גרעין) או בשילוב של דגימה מסוג Top-k ודגימת גרעין. דגימת Top-k מתייחסת לקבוצה של topK הטוקנים הסבירים ביותר. מודלים שפועלים עם דגימת גרעין לא מאפשרים הגדרה של topK.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model והוא מצוין במאפיין Model.top_p שמוחזר מהפונקציה getModel. מאפיין topK ריק מציין שהמודל לא משתמש בדגימה של k התוצאות המובילות ולא מאפשר להגדיר topK בבקשות.
seed
integer
אופציונלי. הערך הראשוני שמשמש לפענוח. אם לא מגדירים את הערך הזה, הבקשה משתמשת בערך התחלתי שנוצר באופן אקראי.
presencePenalty
number
אופציונלי. אם הטוקן כבר הופיע בתשובה, יחול קנס על נוכחות הטוקן על הסתברויות הלוג של הטוקן הבא.
העונש הזה הוא בינארי (מופעל או מושבת) והוא לא תלוי במספר הפעמים שנעשה שימוש באסימון (אחרי הפעם הראשונה). משתמשים בערך frequencyPenalty כדי לציין קנס שגדל עם כל שימוש.
קנס חיובי ירתיע את השימוש בטוקנים שכבר נעשה בהם שימוש בתשובה, ויגדיל את אוצר המילים.
עונש שלילי יעודד שימוש בטוקנים שכבר נעשה בהם שימוש בתשובה, ויקטין את אוצר המילים.
frequencyPenalty
number
אופציונלי. קנס התדירות שמוחל על הסתברויות היומן של האסימון הבא, מוכפל במספר הפעמים שכל אסימון הופיע בתגובה עד עכשיו.
קנס חיובי ימנע שימוש בטוקנים שכבר נעשה בהם שימוש, באופן יחסי למספר הפעמים שנעשה שימוש בטוקן: ככל שנעשה שימוש בטוקן יותר פעמים, כך קשה יותר למודל להשתמש בטוקן הזה שוב, והאוצר מילים של התשובות גדל.
זהירות: קנס שלילי יעודד את המודל לעשות שימוש חוזר בטוקנים באופן יחסי למספר הפעמים שנעשה שימוש בטוקן. ערכים שליליים קטנים יצמצמו את אוצר המילים של התשובה. ערכים שליליים גדולים יותר יגרמו למודל להתחיל לחזור על טוקן נפוץ עד שהוא יגיע למגבלת maxOutputTokens.
responseLogprobs
boolean
אופציונלי. אם הערך הוא true, התוצאות של logprobs מיוצאות בתגובה.
logprobs
integer
אופציונלי. בתוקף רק אם responseLogprobs=True. ההגדרה הזו קובעת את מספר ההסתברויות של הטוקנים המובילים, כולל הטוקן שנבחר, שיוחזרו בכל שלב של פענוח ב-Candidate.logprobs_result. המספר חייב להיות בטווח [0, 20].
enableEnhancedCivicAnswers
boolean
אופציונלי. הפעלה של תשובות משופרות בנושאים אזרחיים. יכול להיות שהאפשרות הזו לא תהיה זמינה בכל הדגמים.
speechConfig
object (SpeechConfig)
אופציונלי. ההגדרה של יצירת הדיבור.
thinkingConfig
object (ThinkingConfig)
אופציונלי. הגדרות לתכונות של עזרה בכתיבה. אם השדה הזה מוגדר למודלים שלא תומכים בחשיבה, תוצג שגיאה.
imageConfig
object (ImageConfig)
אופציונלי. הגדרות ליצירת תמונות. אם השדה הזה מוגדר למודלים שלא תומכים באפשרויות ההגדרה האלה, תוצג שגיאה.
mediaResolution
enum (MediaResolution)
אופציונלי. אם צוינה רזולוציית מדיה, המערכת תשתמש בה.
enableAffectiveDialog
boolean
אופציונלי. אם ההגדרה הזו מופעלת, המודל יזהה רגשות ויתאים את התשובות שלו בהתאם.
responseFormat
object (ResponseFormatConfig)
אופציונלי. הגדרה של פורמט הפלט של התשובה. מאפשרת לציין הגדרות פלט לכל מודליות (טקסט, אודיו, תמונה) במבנה שטוח.
translationConfig
object (TranslationConfig)
אופציונלי. הגדרות לתרגום.
audioTranscriptionConfig
object (AudioTranscriptionConfig)
אופציונלי. הגדרות לתמלול אודיו (זיהוי דיבור).
| ייצוג ב-JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
אופן השימוש
אופני התגובה הנתמכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
ערך ברירת המחדל. |
TEXT |
מציין שהמודל צריך להחזיר טקסט. |
IMAGE |
מציין שהמודל צריך להחזיר תמונות. |
AUDIO |
מציין שהמודל צריך להחזיר אודיו. |
SpeechConfig
הגדרות ליצירת דיבור ולתמלול.
voiceConfig
object (VoiceConfig)
ההגדרה במקרה של פלט קולי יחיד.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
אופציונלי. ההגדרה של מערך רמקולים מרובה. הוא לא יכול להיות ביחד עם השדה voiceConfig.
languageCode
string
אופציונלי. קוד השפה בתקן BCP-47 של IETF שהמשתמש הגדיר לשימוש באפליקציה. משמש לזיהוי דיבור ולהמרת טקסט לדיבור.
הערכים התקינים הם: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU ו-th-TH.
| ייצוג ב-JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
ההגדרה של הקול שבו רוצים להשתמש.
voice_config
Union type
voice_config יכול להיות רק אחד מהבאים:prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
ההגדרה של הקול המובנה שבו רוצים להשתמש.
| ייצוג ב-JSON |
|---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
ההגדרה של הרמקול המובנה שבו רוצים להשתמש.
voiceName
string
השם של הגדרת הקול הקבועה מראש שבה רוצים להשתמש.
| ייצוג ב-JSON |
|---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
ההגדרה של מערך רמקולים מרובה.
speakerVoiceConfigs[]
object (SpeakerVoiceConfig)
חובה. כל הקולות של הרמקולים שהופעלו.
| ייצוג ב-JSON |
|---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
ההגדרה של רמקול יחיד בהגדרה של כמה רמקולים.
speaker
string
חובה. השם של הדובר שבו רוצים להשתמש. צריך להיות זהה למה שכתוב בפרומפט.
voiceConfig
object (VoiceConfig)
חובה. ההגדרה של הקול שבו רוצים להשתמש.
| ייצוג ב-JSON |
|---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
הגדרות לתכונות של עזרה בכתיבה.
includeThoughts
boolean
מציין אם לכלול מחשבות בתשובה. אם הערך הוא true, המחשבות מוחזרות רק כשהן זמינות.
thinkingBudget
integer
מספר הטוקנים של המחשבות שהמודל צריך ליצור.
thinkingLevel
enum (ThinkingLevel)
אופציונלי. ההגדרה הזו קובעת את העומק המקסימלי של תהליך החשיבה הרציונלית הפנימית של המודל לפני שהוא יוצר תשובה. ערך ברירת המחדל תלוי במודל. פרטים נוספים זמינים במדריך לרמות החשיבה. מומלץ לשימוש במודלים של Gemini 3 ואילך. השימוש במודלים קודמים יגרום לשגיאה.
| ייצוג ב-JSON |
|---|
{
"includeThoughts": boolean,
"thinkingBudget": integer,
"thinkingLevel": enum ( |
ThinkingLevel
אפשר לאפשר למשתמש לציין כמה זמן לחשוב באמצעות enum במקום תקציב של מספר שלם.
| טיפוסים בני מנייה (enum) | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
ערך ברירת המחדל. |
MINIMAL |
מעט מאוד חשיבה או ללא חשיבה כלל. |
LOW |
רמת העמקה נמוכה. |
MEDIUM |
רמת העמקה בינונית. |
HIGH |
רמת העמקה גבוהה. |
ImageConfig
הגדרות לתכונות ליצירת תמונות.
aspectRatio
string
אופציונלי. יחס הגובה-רוחב של התמונה שרוצים ליצור. יחסי גובה-רוחב נתמכים: 1:1, 1:4, 4:1, 1:8, 8:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 או 21:9.
אם לא מציינים יחס גובה-רוחב, המודל יבחר יחס גובה-רוחב כברירת מחדל על סמך תמונות ההפניה שסופקו.
imageSize
string
אופציונלי. מציינת את הגודל של התמונות שנוצרו. הערכים הנתמכים הם 512, 1K, 2K, 4K. אם לא מציינים ערך, המודל ישתמש בערך ברירת המחדל 1K.
| ייצוג ב-JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
MediaResolution
רזולוציית המדיה של קלט המדיה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
לא הוגדרה רזולוציה למדיה. |
MEDIA_RESOLUTION_LOW |
הרזולוציה של המדיה מוגדרת כנמוכה (64 טוקנים). |
MEDIA_RESOLUTION_MEDIUM |
רזולוציית המדיה מוגדרת לבינונית (256 טוקנים). |
MEDIA_RESOLUTION_HIGH |
רזולוציית המדיה מוגדרת כגבוהה (שינוי מסגור בהגדלה עם 256 טוקנים). |
ResponseFormatConfig
הגדרה של פורמט הפלט של התשובה. זהו אובייקט שטוח שבו כל שדה משנה אופציונלי מגדיר מצב פלט ספציפי.
text
object (TextResponseFormat)
אופציונלי. הגדרה של פורמט פלט הטקסט.
audio
object (AudioResponseFormat)
אופציונלי. הגדרת פורמט פלט האודיו.
image
object (ImageResponseFormat)
אופציונלי. הגדרת פורמט הפלט של התמונה.
| ייצוג ב-JSON |
|---|
{ "text": { object ( |
TextResponseFormat
MimeType
סוגי MIME נתמכים לפלט טקסט.
| טיפוסים בני מנייה (enum) | |
|---|---|
MIME_TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
APPLICATION_JSON |
פורמט פלט JSON. |
TEXT_PLAIN |
פורמט פלט של טקסט פשוט. |
AudioResponseFormat
הגדרה של פורמט פלט האודיו.
mimeType
enum (MimeType)
אופציונלי. סוג ה-MIME של פלט האודיו.
delivery
enum (Delivery)
אופציונלי. אופן השליחה של פלט האודיו.
sampleRate
integer
אופציונלי. תדירות הדגימה בהרץ.
bitRate
integer
אופציונלי. קצב העברת הנתונים בסיביות לשנייה (bps). רלוונטי רק לפורמטים דחוסים (MP3, Opus).
MimeType
סוגי MIME נתמכים לפלט אודיו.
| טיפוסים בני מנייה (enum) | |
|---|---|
MIME_TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
AUDIO_MP3 |
פורמט אודיו MP3. |
AUDIO_OGG_OPUS |
פורמט אודיו OGG Opus. |
AUDIO_L16 |
פורמט אודיו Raw PCM (L16). |
AUDIO_WAV |
פורמט אודיו WAV. |
AUDIO_ALAW |
פורמט אודיו A-law. |
AUDIO_MULAW |
פורמט אודיו Mu-law. |
משלוח
מצב ההשמעה של פלט האודיו.
| טיפוסים בני מנייה (enum) | |
|---|---|
DELIVERY_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
INLINE |
נתוני האודיו מוחזרים בשורה בתשובה. |
URI |
נתוני האודיו מוחזרים כ-URI. |
ImageResponseFormat
הגדרה של פורמט הפלט של התמונה.
mimeType
enum (MimeType)
אופציונלי. סוג ה-MIME של פלט התמונה.
delivery
enum (Delivery)
אופציונלי. אופן השליחה של פלט התמונה.
aspectRatio
enum (AspectRatio)
אופציונלי. יחס הגובה-רוחב של התמונה שנוצרה.
imageSize
enum (ImageSize)
אופציונלי. גודל התמונה שנוצרת.
| ייצוג ב-JSON |
|---|
{ "mimeType": enum ( |
MimeType
סוגי MIME נתמכים של פלט תמונה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MIME_TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
IMAGE_JPEG |
פורמט תמונה JPEG. |
משלוח
אופן ההעברה של פלט התמונה.
| טיפוסים בני מנייה (enum) | |
|---|---|
DELIVERY_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
INLINE |
נתוני התמונה מוחזרים בשורה בתשובה. |
URI |
נתוני התמונה מוחזרים כ-URI. |
AspectRatio
יחסי גובה-רוחב נתמכים של תמונות שנוצרות.
| טיפוסים בני מנייה (enum) | |
|---|---|
ASPECT_RATIO_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
ASPECT_RATIO_ONE_BY_ONE |
יחס גובה-רוחב של 1:1. |
ASPECT_RATIO_TWO_BY_THREE |
יחס גובה-רוחב של 2:3. |
ASPECT_RATIO_THREE_BY_TWO |
יחס גובה-רוחב של 3:2. |
ASPECT_RATIO_THREE_BY_FOUR |
יחס גובה-רוחב של 3:4. |
ASPECT_RATIO_FOUR_BY_THREE |
יחס גובה-רוחב של 4:3. |
ASPECT_RATIO_FOUR_BY_FIVE |
יחס גובה-רוחב של 4:5. |
ASPECT_RATIO_FIVE_BY_FOUR |
יחס גובה-רוחב של 5:4. |
ASPECT_RATIO_NINE_BY_SIXTEEN |
יחס גובה-רוחב של 9:16. |
ASPECT_RATIO_SIXTEEN_BY_NINE |
יחס גובה-רוחב של 16:9. |
ASPECT_RATIO_TWENTY_ONE_BY_NINE |
יחס גובה-רוחב של 21:9. |
ASPECT_RATIO_ONE_BY_EIGHT |
יחס גובה-רוחב של 1:8. |
ASPECT_RATIO_EIGHT_BY_ONE |
יחס גובה-רוחב של 8:1. |
ASPECT_RATIO_ONE_BY_FOUR |
יחס גובה-רוחב של 1:4. |
ASPECT_RATIO_FOUR_BY_ONE |
יחס גובה-רוחב של 4:1. |
ImageSize
גדלי תמונות נתמכים לפלט תמונה.
| טיפוסים בני מנייה (enum) | |
|---|---|
IMAGE_SIZE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
IMAGE_SIZE_FIVE_TWELVE |
גודל התמונה הוא 512 פיקסלים. |
IMAGE_SIZE_ONE_K |
גודל התמונה הוא 1K. |
IMAGE_SIZE_TWO_K |
גודל התמונה הוא 2K. |
IMAGE_SIZE_FOUR_K |
גודל התמונה ב-4K. |
TranslationConfig
הגדרות לתכונות תרגום.
targetLanguageCode
string
חובה. שפת היעד של התרגום. הערכים הנתמכים הם קודי שפה בתקן BCP-47 (למשל, 'en', 'es', 'fr').
echoTargetLanguage
boolean
אופציונלי. אם הערך הוא True, המודל ייצור אודיו כשהשפה הממוקדת מדוברת, כלומר הוא יחקה את הקלט. אם הערך הוא False, לא ניצור אודיו בשפת היעד.
| ייצוג ב-JSON |
|---|
{ "targetLanguageCode": string, "echoTargetLanguage": boolean } |
AudioTranscriptionConfig
הגדרת תמלול האודיו.
languageCodes[]
string
אופציונלי. קודי שפה בתקן BCP-47 שמספקים רמזים לגבי השפות שמופיעות באודיו. אם לא מציינים שפה או אם השדה ריק, המערכת תבצע זיהוי שפה אוטומטי.
adaptationPhrases[]
(deprecated)
string
אופציונלי. רשימה של ביטויים שמשמשים להתאמת הדיבור, שמשפיעה על מודל ה-ASR כדי לשפר את הזיהוי של המונחים הספציפיים האלה.
customVocabulary[]
string
אופציונלי. רשימה של ביטויים מותאמים אישית באוצר המילים, כדי להטות את מודל זיהוי הדיבור לזיהוי מונחים ספציפיים (שמות מוצרים, שמות עצם, ז'רגון).
wordTimestamp
boolean
אופציונלי. המדיניות מגדירה יצירה של חותמות זמן ברמת המילה.
diarization
boolean
אופציונלי. הגדרת חלוקת קובץ האודיו לפי דוברים.
language_config
Union type
language_codes ברמה העליונה. הערך language_config יכול להיות רק אחד מהבאים:languageAuto
(deprecated)
object (LanguageAuto)
אופציונלי. המודל יזהה את השפה באופן אוטומטי.
languageHints
(deprecated)
object (LanguageHints)
אופציונלי. מציינים שפה אחת או יותר באודיו.
| ייצוג ב-JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, // language_config "languageAuto": { object ( |
LanguageAuto
בסוג הזה אין שדות.
מציין שהשפה של האודיו צריכה להיות מזוהה באופן אוטומטי.
LanguageHints
מספק רמזים למודל לגבי השפות האפשריות שקיימות באודיו.
languageCodes[]
(deprecated)
string
חובה. קודי שפה בתקן BCP-47.
| ייצוג ב-JSON |
|---|
{ "languageCodes": [ string ] } |
RealtimeInputConfig
הגדרת התנהגות הקלט בזמן אמת ב-BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
אופציונלי. אם לא מגדירים את ההגדרה הזו, זיהוי הפעילות האוטומטי מופעל כברירת מחדל. אם השבתתם את זיהוי הקול האוטומטי, הלקוח צריך לשלוח אותות פעילות.
activityHandling
enum (ActivityHandling)
אופציונלי. הגדרה של ההשפעה של הפעילות.
turnCoverage
enum (TurnCoverage)
אופציונלי. הגדרה של הקלט שייכלל בתור של המשתמש.
| ייצוג ב-JSON |
|---|
{ "automaticActivityDetection": { object ( |
AutomaticActivityDetection
ההגדרה קובעת את אפשרויות הזיהוי האוטומטי של פעילות.
disabled
boolean
אופציונלי. אם ההגדרה מופעלת (ברירת המחדל), דיבור וטקסט שזוהו נספרים כפעילות. אם ההגדרה מושבתת, הלקוח צריך לשלוח אותות פעילות.
startOfSpeechSensitivity
enum (StartSensitivity)
אופציונלי. קובע את הסבירות לזיהוי דיבור.
prefixPaddingMs
integer
אופציונלי. משך הזמן הנדרש של הדיבור שזוהה לפני שמתבצעת התחייבות לתחילת הדיבור. ככל שהערך הזה נמוך יותר, כך זיהוי תחילת הדיבור רגיש יותר, ואפשר לזהות דיבור קצר יותר. עם זאת, זה גם מגדיל את הסבירות לתוצאות חיוביות כוזבות.
endOfSpeechSensitivity
enum (EndSensitivity)
אופציונלי. קובע את הסבירות לכך שהדיבור שזוהה הסתיים.
silenceDurationMs
integer
אופציונלי. משך הזמן הנדרש של זיהוי קטע שאינו דיבור (למשל, שקט) לפני שמתבצעת פעולה של סיום הדיבור. ככל שהערך הזה גדול יותר, כך יכולים להיות פערים ארוכים יותר בדיבור בלי להפריע לפעילות המשתמש, אבל זה יגדיל את זמן האחזור של המודל.
| ייצוג ב-JSON |
|---|
{ "disabled": boolean, "startOfSpeechSensitivity": enum ( |
StartSensitivity
קובע איך מזוהה תחילת הדיבור.
| טיפוסים בני מנייה (enum) | |
|---|---|
START_SENSITIVITY_UNSPECIFIED |
ערך ברירת המחדל הוא START_SENSITIVITY_HIGH. |
START_SENSITIVITY_HIGH |
הזיהוי האוטומטי יזהה את תחילת הדיבור בתדירות גבוהה יותר. |
START_SENSITIVITY_LOW |
הזיהוי האוטומטי יזהה את תחילת הדיבור בתדירות נמוכה יותר. |
EndSensitivity
קובע איך מזוהה סוף הדיבור.
| טיפוסים בני מנייה (enum) | |
|---|---|
END_SENSITIVITY_UNSPECIFIED |
ערך ברירת המחדל הוא END_SENSITIVITY_HIGH. |
END_SENSITIVITY_HIGH |
הזיהוי האוטומטי מסיים את הדיבור לעיתים קרובות יותר. |
END_SENSITIVITY_LOW |
הזיהוי האוטומטי מפסיק את הדיבור בתדירות נמוכה יותר. |
ActivityHandling
הדרכים השונות לטיפול בפעילות המשתמשים.
| טיפוסים בני מנייה (enum) | |
|---|---|
ACTIVITY_HANDLING_UNSPECIFIED |
אם לא מצוין ערך, ההתנהגות שמוגדרת כברירת מחדל היא START_OF_ACTIVITY_INTERRUPTS. |
START_OF_ACTIVITY_INTERRUPTS |
אם הערך הוא True, התחלת הפעילות תקטע את התשובה של המודל (נקראת גם 'התפרצות'). התשובה הנוכחית של המודל תיקטע ברגע ההפרעה. זו התנהגות ברירת המחדל. |
NO_INTERRUPTION |
התשובה של המודל לא תיקטע. |
TurnCoverage
אפשרויות לגבי הקלט שנכלל בתור של המשתמש.
| טיפוסים בני מנייה (enum) | |
|---|---|
TURN_COVERAGE_UNSPECIFIED |
אם לא מציינים ערך, נבחרת התנהגות ברירת מחדל על סמך המודל. לדוגמה, ב-Gemini 2.5, ברירת המחדל היא TURN_INCLUDES_ONLY_ACTIVITY, וב-Gemini 3.1 ואילך, ברירת המחדל היא TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO. |
TURN_INCLUDES_ONLY_ACTIVITY |
כולל פעילות מאז התור האחרון, לא כולל חוסר פעילות (למשל, שקט בזרם האודיו). |
TURN_INCLUDES_ALL_INPUT |
כולל את כל הקלט בזמן אמת מאז התור האחרון, כולל חוסר פעילות (למשל, שקט בערוץ האודיו). |
TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO |
כולל את פעילות האודיו ואת כל הווידאו מאז התור האחרון. בזיהוי פעילות אוטומטי, פעילות אודיו כוללת דיבור ולא כוללת שקט. |
SessionResumptionConfig
הגדרת חידוש הסשן.
ההודעה הזו נכללת בהגדרות הסשן כ-BidiGenerateContentSetup.session_resumption. אם הוגדר, השרת ישלח הודעות SessionResumptionUpdate.
handle
string
הכינוי של סשן קודם. אם הוא לא קיים, נוצר סשן חדש.
מזהי סשן מגיעים מערכי SessionResumptionUpdate.token בחיבורים קודמים.
| ייצוג ב-JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
הפעלה של דחיסת חלון הקשר – מנגנון לניהול חלון הקשר של המודל כך שהוא לא יעלה על אורך נתון.
compression_mechanism
Union type
compression_mechanism יכול להיות רק אחד מהבאים:slidingWindow
object (SlidingWindow)
מנגנון חלון הזזה.
triggerTokens
string (int64 format)
מספר הטוקנים (לפני הרצת תור) שנדרש כדי להפעיל דחיסה של חלון ההקשר.
אפשר להשתמש בזה כדי לאזן בין איכות לבין זמן האחזור, כי חלונות הקשר קצרים יותר עשויים להוביל לתשובות מהירות יותר מהמודל. עם זאת, כל פעולת דחיסה תגרום לעלייה זמנית בחביון, ולכן לא מומלץ להפעיל אותן בתדירות גבוהה.
אם לא מגדירים את המדיניות, ברירת המחדל היא 80% ממגבלת חלון ההקשר של המודל. המשמעות היא ש-20% נשארים לבקשת המשתמש הבאה או לתשובת המודל.
| ייצוג ב-JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
השיטה SlidingWindow פועלת על ידי השמטת תוכן בתחילת חלון ההקשר. ההקשר שיתקבל תמיד יתחיל בתחילת תור של תפקיד המשתמש. ההוראות למערכת וכל BidiGenerateContentSetup.prefix_turns תמיד יישארו בתחילת התוצאה.
targetTokens
string (int64 format)
מספר הטוקנים שרוצים לשמור. ערך ברירת המחדל הוא triggerTokens/2.
השלכת חלקים מחלון ההקשר גורמת להגדלה זמנית של זמן האחזור, ולכן צריך לכייל את הערך הזה כדי להימנע מפעולות דחיסה תכופות.
| ייצוג ב-JSON |
|---|
{ "targetTokens": string } |
HistoryConfig
הגדרת ההיסטוריה.
ההודעה הזו נכללת בהגדרות הסשן כ-BidiGenerateContentSetup.history_config. הגדרה של חילופי הודעות היסטוריה.
initialHistoryInClientContent
boolean
אופציונלי. אם הערך הוא True, אחרי שליחת setupComplete, השרת ימתין ויעבד קודם clientContent הודעות עד ש-turnComplete יהיה true. ההיסטוריה הראשונית הזו לא תפעיל שיחה עם מודל, והיא עשויה להסתיים בתפקיד MODEL. אחרי ש-turnComplete הוא true, הלקוח יכול להתחיל את השיחה בזמן אמת דרך realtimeInput.
| ייצוג ב-JSON |
|---|
{ "initialHistoryInClientContent": boolean } |
שיטה: auth_tokens.create
יוצר אסימון שאפשר להשתמש בו כדי להגביל את ההתנהגות של סשן BidiGenerateContent.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /auth_tokens
גוף הבקשה
גוף הבקשה מכיל מופע של AuthToken.
expireTime
string (Timestamp format)
אופציונלי. קלט בלבד. אי אפשר לשנות. זמן אופציונלי שאחריו, כשמשתמשים בטוקן שנוצר, הודעות בסשנים של BidiGenerateContent יידחו. (Gemini עשוי לסגור את הסשן לפני הזמן הזה).
אם לא מגדירים את התדירות, ברירת המחדל היא 30 דקות. אם מאכלסים אותו, הערך הזה צריך להיות פחות מ-20 שעות בעתיד.
הפלט שנוצר תמיד יהיה בפורמט 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".
newSessionExpireTime
string (Timestamp format)
אופציונלי. קלט בלבד. אי אפשר לשנות. הזמן שאחריו בקשות חדשות להפעלת Live API באמצעות הטוקן שמתקבל מהבקשה הזו יידחו.
אם לא מגדירים את ההגדרה הזו, ברירת המחדל בעתיד תהיה 60 שניות. אם מאכלסים אותו, הערך הזה צריך להיות פחות מ-20 שעות בעתיד.
הפלט שנוצר תמיד יהיה בפורמט 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".
fieldMask
string (FieldMask format)
אופציונלי. קלט בלבד. אי אפשר לשנות. אם fieldMask ריק, ו-bidiGenerateContentSetup לא קיים, אז ההודעה האפקטיבית BidiGenerateContentSetup נלקחת מהחיבור הפעיל ל-API.
אם fieldMask ריק, ו-bidiGenerateContentSetup is קיים, אז ההודעה האפקטיבית BidiGenerateContentSetup נלקחת כולה מ-bidiGenerateContentSetup בבקשה הזו. הודעת ההגדרה מחיבור Live API מוזנחת.
אם fieldMask לא ריק, השדות התואמים מ-bidiGenerateContentSetup יחליפו את השדות מהודעת ההגדרה בחיבור ה-API בזמן אמת.
זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
config
Union type
config יכול להיות רק אחד מהבאים:bidiGenerateContentSetup
object (BidiGenerateContentSetup)
אופציונלי. קלט בלבד. אי אפשר לשנות. הגדרה ספציפית ל-BidiGenerateContent.
uses
integer
אופציונלי. קלט בלבד. אי אפשר לשנות. מספר הפעמים שבהם אפשר להשתמש באסימון. אם הערך הוא אפס, לא מוחלת מגבלה. חידוש של סשן API בשידור חי לא נחשב כשימוש. אם לא מציינים ערך, ברירת המחדל היא 1.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של AuthToken.