Gemini API תומך ביצירת תוכן עם תמונות, אודיו, קוד, כלים ועוד. כדי לקבל פרטים על כל אחת מהתכונות האלה, אתם יכולים להמשיך לקרוא ולעיין בקוד לדוגמה שמתמקד במשימות, או לקרוא את המדריכים המקיפים.
Method: models.generateContent
יוצרת תשובה של המודל על סמך קלט GenerateContentRequest. מידע מפורט על השימוש מופיע במדריך ליצירת טקסט. יכולות הקלט משתנות בין המודלים, כולל מודלים מכווננים. פרטים נוספים זמינים במדריך למודלים ובמדריך לכוונון.
נקודת קצה
פוסטhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
פרמטרים של הנתיב
model
string
חובה. שם ה-Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הפורמט שלו הוא models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools ש-Model יכול להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת לקיים אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה, או קבוצת פעולות, מחוץ לידע ולהיקף של Model. הערכים הנתמכים של Tool הם Function ו-codeExecution. מידע נוסף זמין במדריכים בנושא קריאה להפעלת פונקציות והרצת קוד.
toolConfig
object (ToolConfig)
אופציונלי. הגדרת הכלי לכל Tool שצוין בבקשה. דוגמה לשימוש מופיעה במדריך לקריאה להפעלת פונקציות.
safetySettings[]
object (SafetySetting)
אופציונלי. רשימה של מופעי SafetySetting ייחודיים לחסימת תוכן לא בטוח.
האכיפה תתבצע ב-GenerateContentRequest.contents וב-GenerateContentResponse.candidates. לא אמורה להיות יותר מהגדרה אחת לכל סוג של SafetyCategory. ה-API יחסום כל תוכן ותגובה שלא עומדים בסף שנקבע בהגדרות האלה. הרשימה הזו מבטלת את הגדרות ברירת המחדל של כל SafetyCategory שצוין ב-safetySettings. אם לא צוין SafetySetting עבור SafetyCategory מסוים ברשימה, ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל בקטגוריה הזו. קטגוריות הנזק הנתמכות: HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI שלכם.
continuationToken
string (bytes format)
אופציונלי. אסימון המשך אטום שמשמש להמשך היצירה מתגובה קודמת של models.generateContent או models.streamGenerateContent שהופסקה כשהשדה finishReason הוגדר כ-CONTINUATION. שימו לב שהשדה contents הוא שדה חובה, והוא חייב לשכפל באופן זהה את ההנחיה ואת היסטוריית השיחות מהבקשה הראשונית כשמספקים אסימון המשך בבקשה.
מחרוזת בקידוד Base64.
labels
map (key: string, value: string)
אופציונלי. תוויות עם מטא-נתונים שהוגדרו על ידי המשתמש לבקשה.
אופציונלי. התוויות צריכות לעמוד בדרישות הרגילות של תוויות Cloud מאוחדות: - המפתחות של התוויות צריכים להתחיל באות. - המפתחות והערכים של התוויות יכולים להכיל עד 63 תווים (נקודות קוד ב-Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. - אפשר להשתמש בתווים בינלאומיים.
אופן השימוש: - מזהי בטיחות מאגרגטורים: משתמשים במפתח safety_identifier (למשל {"safety_identifier": "user_session_123"})
אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. כרגע, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות הגדרה ליצירת מודלים ולפלטים.
cachedContent
string
אופציונלי. שם התוכן שנשמר במטמון, שישמש כהקשר להצגת החיזוי. פורמט: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
אופציונלי. רמת השירות של הבקשה.
store
boolean
אופציונלי. הגדרת אופן הרישום ביומן של בקשה נתונה. אם מגדירים את המדיניות הזו, היא מקבלת קדימות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
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.
Method: models.streamGenerateContent
יוצר תשובה בסטרימינג מהמודל על סמך קלט GenerateContentRequest.
נקודת קצה
פוסטhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
פרמטרים של הנתיב
model
string
חובה. שם ה-Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הפורמט שלו הוא models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools ש-Model יכול להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת לקיים אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה, או קבוצת פעולות, מחוץ לידע ולהיקף של Model. הערכים הנתמכים של Tool הם Function ו-codeExecution. מידע נוסף זמין במדריכים בנושא קריאה להפעלת פונקציות והרצת קוד.
toolConfig
object (ToolConfig)
אופציונלי. הגדרת הכלי לכל Tool שצוין בבקשה. דוגמה לשימוש מופיעה במדריך לקריאה להפעלת פונקציות.
safetySettings[]
object (SafetySetting)
אופציונלי. רשימה של מופעי SafetySetting ייחודיים לחסימת תוכן לא בטוח.
האכיפה תתבצע ב-GenerateContentRequest.contents וב-GenerateContentResponse.candidates. לא אמורה להיות יותר מהגדרה אחת לכל סוג של SafetyCategory. ה-API יחסום כל תוכן ותגובה שלא עומדים בסף שנקבע בהגדרות האלה. הרשימה הזו מבטלת את הגדרות ברירת המחדל של כל SafetyCategory שצוין ב-safetySettings. אם לא צוין SafetySetting עבור SafetyCategory מסוים ברשימה, ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל בקטגוריה הזו. קטגוריות הנזק הנתמכות: HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI שלכם.
continuationToken
string (bytes format)
אופציונלי. אסימון המשך אטום שמשמש להמשך היצירה מתגובה קודמת של models.generateContent או models.streamGenerateContent שהופסקה כשהשדה finishReason הוגדר כ-CONTINUATION. שימו לב שהשדה contents הוא שדה חובה, והוא חייב לשכפל באופן זהה את ההנחיה ואת היסטוריית השיחות מהבקשה הראשונית כשמספקים אסימון המשך בבקשה.
מחרוזת בקידוד Base64.
labels
map (key: string, value: string)
אופציונלי. תוויות עם מטא-נתונים שהוגדרו על ידי המשתמש לבקשה.
אופציונלי. התוויות צריכות לעמוד בדרישות הרגילות של תוויות Cloud מאוחדות: - המפתחות של התוויות צריכים להתחיל באות. - המפתחות והערכים של התוויות יכולים להכיל עד 63 תווים (נקודות קוד ב-Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. - אפשר להשתמש בתווים בינלאומיים.
אופן השימוש: - מזהי בטיחות מאגרגטורים: משתמשים במפתח safety_identifier (למשל {"safety_identifier": "user_session_123"})
אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. כרגע, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות הגדרה ליצירת מודלים ולפלטים.
cachedContent
string
אופציונלי. שם התוכן שנשמר במטמון, שישמש כהקשר להצגת החיזוי. פורמט: cachedContents/{cachedContent}
serviceTier
enum (ServiceTier)
אופציונלי. רמת השירות של הבקשה.
store
boolean
אופציונלי. הגדרת אופן הרישום ביומן של בקשה נתונה. אם מגדירים את המדיניות הזו, היא מקבלת קדימות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
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 |
האפשרויות נחסמו בגלל תוכן לא בטוח שנוצר על ידי כלי ליצירת תמונות. |
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
- מפות Google
- 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)
פלט בלבד. פרטי שיוך (Attribution) של מקורות שתרמו לתשובה מבוססת-עובדות.
השדה הזה מאוכלס בשיחות GenerateAnswer.
groundingMetadata
object (GroundingMetadata)
פלט בלבד. מטא-נתונים של ביסוס התשובה למועמד.
השדה הזה מאוכלס בשיחות GenerateContent.
avgLogprobs
number
פלט בלבד. ציון ההסתברות הלוגריתמית הממוצעת של המועמד.
logprobsResult
object (LogprobsResult)
פלט בלבד. ציוני סבירות לוגריתמית של טוקני התשובה והטוקנים המובילים
urlContextMetadata
object (UrlContextMetadata)
פלט בלבד. מטא-נתונים שקשורים לכלי לאחזור הקשר של כתובת URL.
continuationToken
string (bytes format)
אסימון המשך אופציונלי שמוחזר כש-finishReason הוא CONTINUATION. לקוחות יכולים להעביר את האסימון הזה ב-GenerateContentRequest הבא כדי להמשיך את היצירה.
מחרוזת בקידוד Base64.
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 |
הבקשה סוננה על ידי כלל העברה לטיפול ברמה גבוהה יותר. |
PUP_LIMITED_DISABLED |
מציין שיצירת הטוקנים הופסקה כי חשבון המשתמש מוגבל או מושבת בגלל הפרות של המדיניות בנושא שימוש אסור (PUP). |
CONTINUATION |
יצירת הטוקנים הופסקה כי התשובה הגיעה למגבלת הטוקנים לכל בקשה, אבל היצירה עדיין לא הושלמה. אפשר להמשיך את התשובה של המודל באמצעות בקשה נוספת עם ה-continuationToken שהוחזר. הערה: הערך של maxOutputTokens מצטבר לאורך דילוגי ההמשך, וצריך להגדיל אותו באופן מונוטוני או להשמיט אותו. |
GroundingAttribution
שיוך למקור שתרם לתשובה.
sourceId
object (AttributionSourceId)
פלט בלבד. מזהה של המקור שתורם לשיוך הזה.
content
object (Content)
תוכן המקור לביסוס שעליו מבוסס השיוך הזה.
| ייצוג ב-JSON |
|---|
{ "sourceId": { object ( |
AttributionSourceId
מזהה המקור שתרם לשיוך הזה.
source
Union type
groundingPassage
object (GroundingPassageId)
מזהה של פסקה מוטמעת.
semanticRetrieverChunk
object (SemanticRetrieverChunk)
מזהה של Chunk שאוחזר באמצעות Semantic Retriever.
| ייצוג ב-JSON |
|---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
מזהה של חלק בתוך GroundingPassage.
passageId
string
פלט בלבד. מזהה הפסקה שתואמת לGroundingPassage.id של GenerateAnswerRequest.
partIndex
integer
פלט בלבד. אינדקס החלק בתוך GroundingPassage.content של GenerateAnswerRequest.
| ייצוג ב-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)
רשימה של מקורות מידע תומכים שאוחזרו ממקור ה-grounding שצוין. בזמן סטרימינג, השדה הזה מכיל רק את חלקי ה-grounding שלא נכללו במטא-נתונים של ה-grounding בתשובות קודמות.
groundingSupports[]
object (GroundingSupport)
רשימת מקורות מידע לביסוס.
webSearchQueries[]
string
שאילתות לחיפוש באינטרנט לצורך חיפוש המשך באינטרנט.
imageSearchQueries[]
string
שאילתות לחיפוש תמונות שמשמשות לביסוס.
searchEntryPoint
object (SearchEntryPoint)
אופציונלי. ערך בחיפוש Google לחיפושים הבאים באינטרנט.
retrievalMetadata
object (RetrievalMetadata)
מטא-נתונים שקשורים לאחזור בתהליך הביסוס.
googleMapsWidgetContextToken
string
אופציונלי. שם המשאב של טוקן ההקשר של הווידג'ט של מפות Google, שאפשר להשתמש בו עם הווידג'ט PlacesContextElement כדי להציג נתונים לפי הקשר. השדה הזה מאוכלס רק אם העיגון בעזרת מפות Google מופעל.
| ייצוג ב-JSON |
|---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
נקודת כניסה בחיפוש Google.
renderedContent
string
אופציונלי. קטע קוד של תוכן מהאינטרנט שאפשר להטמיע בדף אינטרנט או ב-WebView של אפליקציה.
sdkBlob
string (bytes format)
אופציונלי. JSON בקידוד Base64 שמייצג מערך של קבוצת <מונח חיפוש, כתובת URL של חיפוש>.
מחרוזת בקידוד Base64.
| ייצוג ב-JSON |
|---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
הערך GroundingChunk מייצג קטע של הוכחות תומכות שעליהן מבוססת התשובה של המודל. הוא יכול להיות קטע מהאינטרנט, הקשר שאוחזר מקובץ או מידע ממפות Google.
chunk_type
Union 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
הדומיין הבסיסי (root) של דף האינטרנט שממנו נלקחה התמונה, למשל "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
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 בבר Foo" או "האם Foo Bar נגיש לכיסאות גלגלים?"). כרגע אנחנו תומכים רק בקטעים מביקורות כמקורות.
reviewSnippets[]
object (ReviewSnippet)
תקצירים של ביקורות שמשמשים ליצירת תשובות לגבי המאפיינים של מקום מסוים במפות Google.
| ייצוג ב-JSON |
|---|
{
"reviewSnippets": [
{
object ( |
ReviewSnippet
מכיל קטע מביקורת של משתמש שעונה על שאלה לגבי המאפיינים של מקום ספציפי במפות Google.
reviewId
string
המזהה של הקטע מהביקורת.
googleMapsUri
string
קישור לביקורת של המשתמש במפות Google.
title
string
כותרת הביקורת.
| ייצוג ב-JSON |
|---|
{ "reviewId": string, "googleMapsUri": string, "title": string } |
GroundingSupport
תמיכה ב-Grounding.
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 – תגובות שליליות או פוגעניות שמתמקדות בזהות או במאפיין מוגן. DEPRECATED: PaLM-only category, not supported by Gemini models. |
HARM_CATEGORY_TOXICITY |
PaLM – תוכן גס, לא מכבד או פוגעני. DEPRECATED: PaLM-only category, not supported by Gemini models. |
HARM_CATEGORY_VIOLENCE |
PaLM – מתאר תרחישים של אלימות נגד אדם או קבוצה, או תיאורים כלליים של אלימות קשה. DEPRECATED: PaLM-only category, not supported by Gemini models. |
HARM_CATEGORY_SEXUAL |
PaLM – מכיל אזכורים של מעשים מיניים או תוכן גס אחר. DEPRECATED: PaLM-only category, not supported by Gemini models. |
HARM_CATEGORY_MEDICAL |
PaLM – מקדם עצות רפואיות שלא נבדקו. DEPRECATED: PaLM-only category, not supported by Gemini models. |
HARM_CATEGORY_DANGEROUS |
PaLM – תוכן מסוכן שמקדם גרימת נזק, מעודד גרימת נזק או עוזר לבצע פעולות מזיקות. DEPRECATED: PaLM-only category, not supported by Gemini models. |
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 |
תוכן עם רמת סיכון זניחה יאושר. |
BLOCK_MEDIUM_AND_ABOVE |
תוכן עם רמת סיכון זניחה (NEGLIGIBLE) ונמוכה (LOW) יאושר. |
BLOCK_ONLY_HIGH |
תוכן עם רמות סיכון זניחה, נמוכה ובינונית יאושר. |
BLOCK_NONE |
כל התוכן יאושר. |
OFF |
משביתים את מסנן הבטיחות. |
ServiceTier
רמת השירות של הבקשה.
| טיפוסים בני מנייה (enum) | |
|---|---|
unspecified |
רמת השירות שמוגדרת כברירת מחדל, שהיא Standard. |
standard |
רמת שירות רגילה. |
flex |
רמת שירות Flex. |
priority |
רמת שירות בעדיפות גבוהה. |
תוכן
- ייצוג ב-JSON
- חלק
- Blob
- FunctionCall
- FunctionResponse
- FunctionResponsePart
- FunctionResponseBlob
- תזמון
- FileData
- ExecutableCode
- שפה
- CodeExecutionResult
- תוצאה
- ToolCall
- ToolType
- ToolResponse
- VideoMetadata
- MediaResolution
- רמה
- MediaProcessing
- AudioTranscription
- WordInfo
- SpeechMetadata
סוג הנתונים המובנה הבסיסי שמכיל תוכן של הודעה שמורכבת מכמה חלקים.
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 של סרטון). המערכת מתעלמת מהשדה הזה בחלקים שהם לא סרטונים.
audioTranscription
object (AudioTranscription)
אופציונלי. תמלול אודיו (קלט או פלט). השדה הזה מוגדר רק כשהחלק הזה מכיל נתוני אודיו.
speechMetadata
object (SpeechMetadata)
אופציונלי. מטא-נתונים שמוחלים על חלקי טקסט כדי להתאים אישית את האופן שבו הם נאמרים או מסונתזים, כמו ציון זהות הדובר או סגנון הדיבור.
data
Union type
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
inline_data או file_data קיימים כדי להגדיר עיבוד מראש של מדיה סטטית לכל חלק. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:videoMetadata
object (VideoMetadata)
אופציונלי. מטא-נתונים של הסרטון. צריך לציין את המטא-נתונים רק כשנתוני הסרטון מוצגים ב-inlineData או ב-fileData.
| ייצוג ב-JSON |
|---|
{ "thought": boolean, "thoughtSignature": string, "partMetadata": { object }, "mediaResolution": { object ( |
כתם
בייטים של מדיה גולמית.
אין לשלוח טקסט כבייטים גולמיים, אלא להשתמש בשדה "טקסט".
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.
displayName
string
אופציונלי. מציין את השם שמשמש להפניה ל-blob הזה במודל (למשל, "my_blob.png"). משמש כמזהה של קובץ העזר של ה-BLOB כש-verbalizationMode מוגדר כ-REFERENCE_ONLY.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string, "displayName": 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. הגורמים ששולחים את הקריאה יכולים להשתמש בכל מפתח שמתאים לתחביר של הפונקציה כדי להחזיר את הפלט של הפונקציה, למשל "output","result" וכו'. באופן ספציפי, אם הקריאה להפעלת הפונקציה נכשלה, התגובה יכולה לכלול את המפתח "error" כדי להחזיר למודל את פרטי השגיאה.
כדי לכלול מולטימדיה, אפשר להשתמש באובייקט משנה שמכיל מפתח "$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
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.
displayName
string
אופציונלי. מציין את השם שמשמש להתייחסות לקובץ הזה במודל (למשל, "my_file.pdf"). משמש כמזהה של קובץ העזר כש-verbalizationMode מוגדר כ-REFERENCE_ONLY.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "fileUri": string, "displayName": 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, ממופה אל 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
המטא-נתונים מתארים את תוכן קטע הווידאו שהוזן. כדי להגדיר עיבוד מקדים של סרטון סטטי (כמו חיתוך זמן, קצב פריימים, מספר פריימים מקסימלי או שכבות תוכן שחולצו), צריך להגדיר את זה ב-Part.video_metadata או ב-FunctionResponsePart.video_metadata כש-inlineData או fileData מכילים סרטון.
startOffset
string (Duration format)
אופציונלי. ההיסט של תחילת הסרטון.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-"s". לדוגמה: "3.5s".
endOffset
string (Duration format)
אופציונלי. ההיסט של סוף הסרטון.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-"s". לדוגמה: "3.5s".
fps
number
אופציונלי. קצב הפריימים של הסרטון שנשלח למודל. אם לא מציינים ערך, ברירת המחדל היא 1.0. טווח הפריימים לשנייה הוא (0.0, 24.0].
| ייצוג ב-JSON |
|---|
{ "startOffset": string, "endOffset": string, "fps": number } |
MediaResolution
רזולוציית המדיה ליצירת הטוקן.
value
Union type
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 |
כברירת מחדל, העיבוד הוא ספציפי למודל. |
STATIC |
חילוץ פריימים בקצב קבוע. כל הפריימים ממוקמים בהקשר. |
AGENTIC |
ניווט דינמי מבוסס-מודל. מומלץ לרוב תרחישי השימוש. |
AudioTranscription
תמלול של קטע אודיו. באודיו עם כמה דוברים, כל קטע של דובר הוא חלק נפרד עם AudioTranscription משלו שכולל את ה-speakerLabel.
text
string
חובה. הטקסט המתומלל של קטע האודיו הזה.
speakerLabel
string
אופציונלי. תווית שמזהה את הדובר בקטע האודיו הזה (למשל, "spk_1", "spk_2"). מוצג כשהגדרתם חלוקה לדוברים.
words[]
object (WordInfo)
אופציונלי. תמלולים מפורטים ברמת המילה ופרטי תזמון. מופיע כשמוגדר wordTimestamp.
| ייצוג ב-JSON |
|---|
{
"text": string,
"speakerLabel": string,
"words": [
{
object ( |
WordInfo
מידע על מילה אחת שזוהתה.
word
string
חובה. תמליל של המילה.
startOffset
string (Duration format)
אופציונלי. היסט ההתחלה בזמן של המילה ביחס לתחילת האודיו.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-"s". לדוגמה: "3.5s".
endOffset
string (Duration format)
אופציונלי. היסט הסיום של המילה ביחס לתחילת האודיו.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-"s". לדוגמה: "3.5s".
| ייצוג ב-JSON |
|---|
{ "word": string, "startOffset": string, "endOffset": string } |
SpeechMetadata
מטא-נתונים של דיבור ב-text חלקים.
speaker
string
אופציונלי. שם אופציונלי של דובר לסינתזה של כמה דוברים.
style
string
אופציונלי. הוראות אופציונליות לגבי הסגנון של המרת הטקסט לדיבור.
| ייצוג ב-JSON |
|---|
{ "speaker": string, "style": string } |
סביבה
סביבת הפעלה של סוכן.
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
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
אופציונלי. ערכים אפשריים של הרכיב Type.STRING בפורמט enum. לדוגמה, אנחנו יכולים להגדיר Enum Direction בתור : {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 אורך מינימלי של Type.STRING
maxLength
string (int64 format)
אופציונלי. האורך המקסימלי של Type.STRING
pattern
string
אופציונלי. תבנית של Type.STRING להגבלת מחרוזת לביטוי רגולרי.
example
value (Value format)
אופציונלי. דוגמה לאובייקט. השדה יאוכלס רק כשהאובייקט הוא ברמה הבסיסית (root).
anyOf[]
object (Schema)
אופציונלי. צריך לאמת את הערך מול כל אחת (אחת או יותר) מתת-הסכימות ברשימה.
propertyOrdering[]
string
אופציונלי. סדר המאפיינים. זה לא שדה רגיל במפרט של OpenAPI. הוא משמש לקביעת סדר המאפיינים בתגובה.
default
value (Value format)
אופציונלי. ערך ברירת המחדל של השדה. לפי סכימת JSON, השדה הזה מיועד למחוללי תיעוד ולא משפיע על האימות. לכן הוא נכלל כאן ומתעלמים ממנו, כדי שמפתחים ששולחים סכימות עם שדה default לא יקבלו שגיאות של שדה לא ידוע.
items
object (Schema)
אופציונלי. סכימה של הרכיבים של Type.ARRAY.
minimum
number
אופציונלי. שדות סכימה מסוג INTEGER ו-NUMBER הערך המינימלי של Type.INTEGER ו-Type.NUMBER
maximum
number
אופציונלי. הערך המקסימלי של Type.INTEGER ו-Type.NUMBER
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
סוג
השדה Type מכיל את רשימת סוגי הנתונים של OpenAPI, כפי שמוגדרים בכתובת https://spec.openapis.org/oas/v3.0.3#data-types
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
לא צוין, אין להשתמש. |
STRING |
סוג מחרוזת. |
NUMBER |
סוג המספר. |
INTEGER |
סוג מספר שלם. |
BOOLEAN |
סוג בוליאני. |
ARRAY |
סוג המערך. |
OBJECT |
סוג האובייקט. |
NULL |
סוג ריק. |
כלי
- ייצוג ב-JSON
- FunctionDeclaration
- התנהגות
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- המצב
- CodeExecution
- GoogleSearch
- אינטרוול
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- סביבה
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
פרטי הכלי שהמודל יכול להשתמש בו כדי ליצור תשובה.
Tool הוא קטע קוד שמאפשר למערכת לקיים אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה, או קבוצת פעולות, מחוץ לידע ולהיקף של המודל.
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. הסכימה צריכה לתאר אובייקט שבו המאפיינים הם הפרמטרים של הפונקציה. לדוגמה:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
השדה הזה לא יכול להופיע יחד עם parameters.
response
object (Schema)
אופציונלי. מתאר את הפלט מהפונקציה הזו בפורמט של סכימת JSON. משקף את אובייקט התגובה של 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
MCPServer הוא שרת שהמודל יכול לשלוח אליו קריאות כדי לבצע פעולות. זהו שרת שמטמיע את פרוטוקול ה-MCP.
name
string
השם של שרת ה-MCP.
transport
Union type
streamableHttpTransport
object (StreamableHttpTransport)
טרנספורט שיכול להעביר בסטרימינג בקשות ותגובות HTTP.
| ייצוג ב-JSON |
|---|
{
"name": string,
// transport
"streamableHttpTransport": {
object ( |
StreamableHttpTransport
טרנספורט שיכול להעביר בסטרימינג בקשות ותגובות HTTP.
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, שמספק הקשר גיאוגרפי לשאילתה של המשתמש.
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 בפועל נלקחת מהחיבור ל-Live API.
אם fieldMask ריק, ו-bidiGenerateContentSetup קיים, אז ההודעה BidiGenerateContentSetup בפועל נלקחת במלואה מ-bidiGenerateContentSetup בבקשה הזו. הודעת ההגדרה מהחיבור ל-Live API לא נלקחת בחשבון.
אם fieldMask לא ריק, השדות התואמים מ-bidiGenerateContentSetup יחליפו את השדות מהודעת ההגדרה בחיבור ל-Live API.
זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
אופציונלי. קלט בלבד. לא ניתן לשינוי. הגדרות ספציפיות ל-BidiGenerateContent.
uses
integer
אופציונלי. קלט בלבד. לא ניתן לשינוי. מספר הפעמים שאפשר להשתמש בטוקן. אם הערך הוא אפס, לא חלה מגבלה. המשך של סשן Live 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)
אופציונלי. הגדרה של החלפת ההיסטוריה בין הלקוח לשרת.
labels
map (key: string, value: string)
אופציונלי. תוויות עם מטא-נתונים שהוגדרו על ידי המשתמש לבקשה.
אופציונלי. התוויות צריכות לעמוד בדרישות הרגילות של תוויות Cloud מאוחדות: - המפתחות של התוויות צריכים להתחיל באות. - המפתחות והערכים של התוויות יכולים להכיל עד 63 תווים (נקודות קוד ב-Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. - אפשר להשתמש בתווים בינלאומיים.
אופן השימוש: - מזהי בטיחות מאגרגטורים: משתמשים במפתח safety_identifier (למשל {"safety_identifier": "user_session_123"})
אובייקט שמכיל רשימה של זוגות "key": value. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| ייצוג ב-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.
הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-responseFormat.
_responseJsonSchema
(deprecated)
value (Value format)
אופציונלי. סכימת הפלט של התשובה שנוצרה. זוהי חלופה ל-responseSchema שמקבלת סכימת JSON.
אם הוא מוגדר, צריך להשמיט את responseSchema, אבל responseMimeType נדרש.
אפשר לשלוח את סכימת ה-JSON המלאה, אבל לא כל התכונות נתמכות. באופן ספציפי, רק המאפיינים הבאים נתמכים:
$id$defs$ref$anchortypeformattitledescriptionenum(למחרוזות ולמספרים)itemsprefixItemsminItemsmaxItemsminimummaximumanyOf-
oneOf(מפורש כמוanyOf) propertiesadditionalPropertiesrequired
אפשר גם להגדיר את המאפיין הלא סטנדרטי propertyOrdering.
הפניות מעגליות נפרסות במידה מוגבלת, ולכן אפשר להשתמש בהן רק במאפיינים לא נדרשים. (מאפיינים שניתן להגדיר כ-null לא מספיקים). אם $ref מוגדר בסכימת משנה, אי אפשר להגדיר מאפיינים אחרים, מלבד אלה שמתחילים ב-$.
הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-responseFormat.
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].
השדה הזה לא נתמך יותר, והמערכת מתעלמת ממנו באופן אוטומטי ב-Gemini 3.6 Flash ובמודלים חדשים יותר.
topP
number
אופציונלי. ההסתברות המצטברת המקסימלית של טוקנים שצריך להביא בחשבון במהלך הדגימה.
המודל משתמש בדגימה משולבת של Top-k ו-Top-p (גרעין).
האסימונים ממוינים לפי ההסתברויות שהוקצו להם, כך שרק האסימונים עם הסבירות הגבוהה ביותר נלקחים בחשבון. דגימת Top-K מגבילה ישירות את מספר הטוקנים המקסימלי שצריך להביא בחשבון, ואילו דגימת Nucleus מגבילה את מספר הטוקנים על סמך ההסתברות המצטברת.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model, והוא מצוין במאפיין Model.top_p שמוחזר מהפונקציה getModel. מאפיין topK ריק מציין שהמודל לא מחיל דגימת Top-K ולא מאפשר להגדיר את topK בבקשות.
השדה הזה לא נתמך יותר, והמערכת מתעלמת ממנו באופן אוטומטי ב-Gemini 3.6 Flash ובמודלים חדשים יותר.
topK
integer
אופציונלי. מספר האסימונים המקסימלי שצריך להביא בחשבון במהלך הדגימה.
מודלים של Gemini משתמשים בדגימת Top-p (גרעין) או בשילוב של דגימת Top-k ודגימת גרעין. דגימת Top-K מתייחסת לקבוצה של topK הטוקנים הסבירים ביותר. במודלים שפועלים עם דגימת גרעין אי אפשר להגדיר את topK.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model, והוא מצוין במאפיין Model.top_p שמוחזר מהפונקציה getModel. מאפיין topK ריק מציין שהמודל לא מחיל דגימת Top-K ולא מאפשר להגדיר topK בבקשות.
השדה הזה לא נתמך יותר, והמערכת מתעלמת ממנו באופן אוטומטי ב-Gemini 3.6 Flash ובמודלים חדשים יותר.
seed
integer
אופציונלי. ה-seed שמשמש לפענוח. אם לא מגדירים את הפרמטר, הבקשה משתמשת בערך ראשוני שנוצר באופן אקראי.
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
אופציונלי. קוד השפה של IETF BCP-47 שהמשתמש הגדיר לשימוש באפליקציה. משמש לזיהוי דיבור והמרת טקסט לדיבור.
הערכים התקינים הם: 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
prebuiltVoiceConfig
object (PrebuiltVoiceConfig)
ההגדרה של הקול המובנה שבו רוצים להשתמש.
voice
string
אופציונלי. מזהה הדובר להמרת טקסט לדיבור. פורמטים נתמכים:
- שם הדובר של קולות מוכנים מראש (לדוגמה,
OrusאוKore). - מזהה הקול של הקולות השמורים (לדוגמה,
voice_xxx). - מפתח רפליקציה של קולות (לדוגמה,
voicekey_xxx).
| ייצוג ב-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
אופציונלי. הגדרת חלוקת קובץ האודיו לפי דוברים.
mode
enum (Mode)
אופציונלי. הגדרת מצב התמלול. ערכים נתמכים: VERBATIM, SMART. אם לא מצוין ערך, ברירת המחדל היא תמלול ב-VERBATIM. במצב SMART, המודל מסיר גמגום (מילים מיותרות, חזרות והתחלות שגויות), מבצע תיקונים דקדוקיים קלים, מעצב באופן אוטומטי (פסקאות, תבליטים, רשימות ממוספרות) ועורך שינויים קלים של המשתמש (תיקונים עצמיים בשורה). חותמות זמן וזיהוי דוברים לא תואמים למצב SMART.
language_config
Union type
language_codes ברמה העליונה. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:languageAuto
(deprecated)
object (LanguageAuto)
אופציונלי. המודל יזהה את השפה באופן אוטומטי.
languageHints
(deprecated)
object (LanguageHints)
אופציונלי. מציין שפה אחת או יותר באודיו.
| ייצוג ב-JSON |
|---|
{ "languageCodes": [ string ], "adaptationPhrases": [ string ], "customVocabulary": [ string ], "wordTimestamp": boolean, "diarization": boolean, "mode": enum ( |
LanguageAuto
בסוג הזה אין שדות.
מציין שצריך לזהות באופן אוטומטי את שפת האודיו.
LanguageHints
מספק למודל רמזים לגבי שפות אפשריות שקיימות באודיו.
languageCodes[]
(deprecated)
string
חובה. קודי שפה בתקן BCP-47.
| ייצוג ב-JSON |
|---|
{ "languageCodes": [ string ] } |
מצב
מצב תמלול.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODE_UNSPECIFIED |
לא צוין מצב תמלול. |
VERBATIM |
מצב תמלול מילה במילה. |
SMART |
מצב תמלול חכם. |
RealtimeInputConfig
הגדרת ההתנהגות של הקלט בזמן אמת ב-BidiGenerateContent.
automaticActivityDetection
object (AutomaticActivityDetection)
אופציונלי. אם המדיניות לא מוגדרת, זיהוי הפעילות האוטומטי מופעל כברירת מחדל. אם זיהוי הקול האוטומטי מושבת, הלקוח צריך לשלוח אותות פעילות.
activityHandling
enum (ActivityHandling)
אופציונלי. מגדיר את ההשפעה של הפעילות.
turnCoverage
enum (TurnCoverage)
אופציונלי. מגדיר איזה קלט נכלל בתור של המשתמש.
interimTranscriptTimestampEnabled
boolean
אופציונלי. הגדרת חותמות זמן לתמלילים זמניים.
| ייצוג ב-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
המזהה של הסשן הקודם. אם אין מזהה, נוצר סשן חדש.
מזהי ה-session_handle מגיעים מהערכים של SessionResumptionUpdate.token בחיבורים קודמים.
| ייצוג ב-JSON |
|---|
{ "handle": string } |
ContextWindowCompressionConfig
הפעלת דחיסה של חלון ההקשר – מנגנון לניהול חלון ההקשר של המודל כדי שלא יחרוג מאורך נתון.
compression_mechanism
Union type
slidingWindow
object (SlidingWindow)
מנגנון של חלון הזזה.
triggerTokens
string (int64 format)
מספר האסימונים (לפני הרצת אינטראקציה) שנדרש כדי להפעיל דחיסה של חלון הקשר.
אפשר להשתמש בזה כדי לאזן בין האיכות לזמן האחזור, כי חלונות הקשר קצרים יותר יכולים להוביל לתגובות מהירות יותר של המודל. עם זאת, כל פעולת דחיסה תגרום לעלייה זמנית בזמן האחזור, ולכן לא כדאי להפעיל אותן לעיתים קרובות.
אם לא מגדירים את המדיניות, ברירת המחדל היא 80% ממגבלת חלון ההקשר של המודל. כך נשארים 20% לבקשת המשתמש או לתשובת המודל הבאה.
| ייצוג ב-JSON |
|---|
{
// compression_mechanism
"slidingWindow": {
object ( |
SlidingWindow
בשיטת SlidingWindow, המערכת מתעלמת מהתוכן שבתחילת חלון ההקשר. ההקשר שנוצר תמיד יתחיל בתחילת תור של תפקיד USER. הוראות המערכת וכל 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 } |
Method: auth_tokens.create
יוצר אסימון שאפשר להשתמש בו כדי להגביל את ההתנהגות של סשן BidiGenerateContent.
נקודת קצה
פוסטhttps: / /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 בפועל נלקחת מהחיבור ל-Live API.
אם fieldMask ריק, ו-bidiGenerateContentSetup קיים, אז ההודעה BidiGenerateContentSetup בפועל נלקחת במלואה מ-bidiGenerateContentSetup בבקשה הזו. הודעת ההגדרה מהחיבור ל-Live API לא נלקחת בחשבון.
אם fieldMask לא ריק, השדות התואמים מ-bidiGenerateContentSetup יחליפו את השדות מהודעת ההגדרה בחיבור ל-Live API.
זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
config
Union type
bidiGenerateContentSetup
object (BidiGenerateContentSetup)
אופציונלי. קלט בלבד. לא ניתן לשינוי. הגדרות ספציפיות ל-BidiGenerateContent.
uses
integer
אופציונלי. קלט בלבד. לא ניתן לשינוי. מספר הפעמים שאפשר להשתמש בטוקן. אם הערך הוא אפס, לא חלה מגבלה. המשך של סשן Live API לא נחשב כשימוש. אם לא מציינים ערך, ברירת המחדל היא 1.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של AuthToken.