Gemini API תומך ביצירת תוכן עם תמונות, אודיו, קוד, כלים ועוד. בהמשך המאמר מפורטים כל אחת מהתכונות האלה, ומוצג קוד לדוגמה שמתמקד במשימות. אפשר גם לקרוא את המדריכים המקיפים.
שיטה: models.generateContent
יצירת תשובה של מודל בהינתן קלט GenerateContentRequest. פרטים נוספים על השימוש זמינים במדריך ליצירת טקסט. יכולות הקלט שונות בין המודלים, כולל מודלים שעברו התאמה. פרטים נוספים זמינים במדריך למודלים ובמדריך להתאמת מודלים.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
פרמטרים של נתיב
model
string
חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
contents[]
object (Content)
חובה. התוכן של השיחה הנוכחית עם המודל.
בשביל שאילתות של תור יחיד, זוהי דוגמה יחידה. בשביל שאילתות רב-שלביות כמו צ'אט, זהו שדה חוזר שמכיל את היסטוריית השיחות ואת הבקשה האחרונה.
tools[]
object (Tool)
אופציונלי. רשימה של Tools ש-Model עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. הסוגים הנתמכים של Tool הם Function ו-codeExecution. מידע נוסף זמין במדריכים בנושא הפעלת פונקציות והרצת קוד.
toolConfig
object (ToolConfig)
אופציונלי. הגדרת הכלי לכל Tool שצוין בבקשה. דוגמה לשימוש מופיעה במדריך לשימוש בפונקציות.
safetySettings[]
object (SafetySetting)
אופציונלי. רשימה של מופעי SafetySetting ייחודיים לחסימת תוכן לא בטוח.
השינוי הזה יחול על GenerateContentRequest.contents ועל GenerateContentResponse.candidates. לא יכולה להיות יותר מהגדרה אחת לכל סוג SafetyCategory. ה-API יחסום כל תוכן ותשובה שלא יעמדו בסף שנקבע בהגדרות האלה. הרשימה הזו מבטלת את הגדרות ברירת המחדל של כל SafetyCategory שצוין ב-safetySettings. אם לא מופיע SafetySetting עבור SafetyCategory מסוים שמופיע ברשימה, ממשק ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל עבור הקטגוריה הזו. הקטגוריות הבאות של נזק נתמכות: HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK. מידע מפורט על הגדרות הבטיחות הזמינות מופיע במדריך. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI שלכם.
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}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
contents[]
object (Content)
חובה. התוכן של השיחה הנוכחית עם המודל.
בשביל שאילתות של תור יחיד, זוהי דוגמה יחידה. בשביל שאילתות רב-שלביות כמו צ'אט, זהו שדה חוזר שמכיל את היסטוריית השיחות ואת הבקשה האחרונה.
tools[]
object (Tool)
אופציונלי. רשימה של Tools ש-Model עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. הסוגים הנתמכים של Tool הם Function ו-codeExecution. מידע נוסף זמין במדריכים בנושא הפעלת פונקציות והרצת קוד.
toolConfig
object (ToolConfig)
אופציונלי. הגדרת הכלי לכל Tool שצוין בבקשה. דוגמה לשימוש מופיעה במדריך לשימוש בפונקציות.
safetySettings[]
object (SafetySetting)
אופציונלי. רשימה של מופעי SafetySetting ייחודיים לחסימת תוכן לא בטוח.
השינוי הזה יחול על GenerateContentRequest.contents ועל GenerateContentResponse.candidates. לא יכולה להיות יותר מהגדרה אחת לכל סוג SafetyCategory. ה-API יחסום כל תוכן ותשובה שלא יעמדו בסף שנקבע בהגדרות האלה. הרשימה הזו מבטלת את הגדרות ברירת המחדל של כל SafetyCategory שצוין ב-safetySettings. אם לא מופיע SafetySetting עבור SafetyCategory מסוים שמופיע ברשימה, ממשק ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל עבור הקטגוריה הזו. הקטגוריות הבאות של נזק נתמכות: HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK. מידע מפורט על הגדרות הבטיחות הזמינות מופיע במדריך. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI שלכם.
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 שאפשר להשתמש בו עם הווידג'ט 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_HATE_SPEECH |
תוכן שמקדם אלימות או מסית לשנאה נגד אנשים פרטיים או קבוצות על סמך מאפיינים מסוימים. |
HARM_CATEGORY_DANGEROUS_CONTENT |
תוכן שמקדם פעילויות מסוכנות, מסייע להן או מאפשר אותן. |
HARM_CATEGORY_HARASSMENT |
תוכן פוגעני או מאיים, או תוכן שמיועד לבריונות, להצקה או ללעג. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
תוכן שמכיל חומרים בעלי אופי מיני בוטה. |
HARM_CATEGORY_CIVIC_INTEGRITY |
הוצאה משימוש: אין יותר תמיכה במסנן בחירות. קטגוריית הנזק היא יושרה אזרחית. |
HARM_CATEGORY_IMAGE_HATE |
תמונות שמכילות דברי שטנה. |
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT |
תמונות שמכילות תוכן מסוכן. |
HARM_CATEGORY_IMAGE_HARASSMENT |
תמונות שמכילות הטרדה. |
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT |
תמונות שמכילות תוכן מיני בוטה. |
HARM_CATEGORY_JAILBREAK |
הנחיות שנועדו לעקוף את מסנני הבטיחות. |
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) | |
|---|---|
SERVICE_TIER_UNSPECIFIED |
מסלול שירות שמוגדר כברירת מחדל, שהוא Standard. |
SERVICE_TIER_FLEX |
רמת השירות Flex. |
SERVICE_TIER_STANDARD |
רמת שירות רגילה. |
SERVICE_TIER_PRIORITY |
רמת שירות עם עדיפות. |
AllowedTools
ההגדרה של הכלים המותרים.
mode
enum (ToolChoiceType)
המצב של בחירת הכלי.
tools[]
string
שמות הכלים המותרים.
| ייצוג JSON |
|---|
{
"mode": enum ( |
הערה
מידע על ציטוט של תוכן שנוצר על ידי מודל.
startIndex
integer
תחילת פלח התשובה שמשויך למקור הזה.
האינדקס מציין את תחילת הפלח, ונמדד בבייטים.
endIndex
integer
סיום הקטע המשויך, לא כולל.
type
Union type
type יכול להיות רק אחד מהבאים:urlCitation
object (UrlCitation)
הערה של ציטוט כתובת URL.
fileCitation
object (FileCitation)
הערה לציטוט קובץ.
placeCitation
object (PlaceCitation)
הערה של ציטוט מקום.
| ייצוג JSON |
|---|
{ "startIndex": integer, "endIndex": integer, // type "urlCitation": { object ( |
UrlCitation
הערה של ציטוט כתובת URL.
url
string
כתובת ה-URL.
title
string
השם של כתובת ה-URL.
| ייצוג JSON |
|---|
{ "url": string, "title": string } |
FileCitation
הערה לציטוט קובץ.
documentUri
string
ה-URI של הקובץ.
fileName
string
שם הקובץ.
source
string
המקור שמשויך לחלק מהטקסט.
customMetadata
object (Struct)
מטא-נתונים שהמשתמש סיפק לגבי ההקשר שאוחזר.
pageNumber
integer
מספר הדף במסמך המצוטט, אם רלוונטי.
mediaId
string
מזהה המדיה במקרה של ציטוטים של תמונות, אם רלוונטי.
| ייצוג JSON |
|---|
{
"documentUri": string,
"fileName": string,
"source": string,
"customMetadata": {
object ( |
PlaceCitation
הערה של ציטוט מקום.
placeId
string
מזהה המקום בפורמט places/{placeId}.
name
string
שם המקום.
url
string
הפניה ל-URI של המקום.
reviewSnippets[]
object (ReviewSnippet)
קטעי ביקורות שמשמשים ליצירת תשובות לגבי התכונות של מקום מסוים במפות Google.
| ייצוג JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
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. |
AudioResponseFormat
הגדרה של פורמט פלט האודיו.
mimeType
enum (MimeType)
סוג ה-MIME של פלט האודיו.
delivery
enum (Delivery)
אופן השליחה של פלט האודיו.
sampleRate
integer
תדירות הדגימה בהרץ.
bitRate
integer
קצב העברת הנתונים בסיביות לשנייה (bps). רלוונטי רק לפורמטים דחוסים (MP3, Opus).
| ייצוג JSON |
|---|
{ "mimeType": enum ( |
CodeExecutionCallStep
שלב של קריאה להרצת קוד.
arguments
object (CodeExecutionCallStepArguments)
חובה. הארגומנטים להעברה להרצת הקוד.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
CodeExecutionCallStepArguments
הארגומנטים להעברה להרצת הקוד.
language
enum (Language)
שפת התכנות של code.
code
string
הקוד שיופעל.
| ייצוג JSON |
|---|
{
"language": enum ( |
CodeExecutionResultStep
שלב התוצאה של הרצת הקוד.
result
string
חובה. הפלט של הרצת הקוד.
isError
boolean
האם הרצת הקוד הסתיימה בשגיאה.
| ייצוג JSON |
|---|
{ "result": string, "isError": boolean } |
ComputerUse
כלי שהמודל יכול להשתמש בו כדי לקיים אינטראקציה עם המחשב.
environment
enum (Environment)
הסביבה שבה מתבצעת הפעולה.
excludedPredefinedFunctions[]
string
רשימת הפונקציות המוגדרות מראש שמוחרגות מהקריאה למודל.
enablePromptInjectionDetection
boolean
האם להפעיל את הבדיקה לאיתור החדרת פרומפטים בבקשה לשימוש במחשב.
disabledSafetyPolicies[]
enum (SafetyPolicy)
אופציונלי. השבתת מדיניות הבטיחות לשימוש במחשב.
| ייצוג JSON |
|---|
{ "environment": enum ( |
תוכן
- ייצוג ב-JSON
- TextContent
- ImageContent
- AudioContent
- DocumentContent
- VideoContent
- ThoughtContent
- ThoughtSummaryContent
- ToolCallContent
- FunctionCallContent
- CodeExecutionCallContent
- CodeExecutionCallArguments
- UrlContextCallContent
- UrlContextCallArguments
- McpServerToolCallContent
- GoogleSearchCallContent
- GoogleSearchCallArguments
- FileSearchCallContent
- GoogleMapsCallContent
- GoogleMapsCallArguments
- ToolResultContent
- FunctionResultContent
- FunctionResultSubcontentList
- FunctionResultSubcontent
- CodeExecutionResultContent
- UrlContextResultContent
- UrlContextResult
- GoogleSearchResultContent
- GoogleSearchResult
- McpServerToolResultContent
- FileSearchResultContent
- FileSearchResult
- GoogleMapsResultContent
- GoogleMapsResult
- מקומות
תוכן התשובה.
type
Union type
type יכול להיות רק אחד מהבאים:text
object (TextContent)
image
object (ImageContent)
audio
object (AudioContent)
document
object (DocumentContent)
video
object (VideoContent)
thought
(deprecated)
object (ThoughtContent)
toolCall
(deprecated)
object (ToolCallContent)
toolResult
(deprecated)
object (ToolResultContent)
| ייצוג JSON |
|---|
{ // type "text": { object ( |
TextContent
בלוק של תוכן טקסט.
text
string
חובה. תוכן הטקסט.
annotations[]
object (Annotation)
מידע על ציטוט של תוכן שנוצר על ידי מודל.
| ייצוג JSON |
|---|
{
"text": string,
"annotations": [
{
object ( |
ImageContent
בלוק תוכן של תמונה.
mimeType
enum (MimeType)
סוג ה-MIME של התמונה.
resolution
enum (MediaResolution)
הרזולוציה של המדיה.
data_or_uri
Union type
data_or_uri יכול להיות רק אחד מהבאים:data
string (bytes format)
תוכן התמונה.
מחרוזת בקידוד Base64.
uri
string
ה-URI של התמונה.
| ייצוג JSON |
|---|
{ "mimeType": enum ( |
AudioContent
בלוק של תוכן אודיו.
mimeType
enum (MimeType)
סוג ה-MIME של האודיו.
channels
integer
מספר ערוצי האודיו.
sampleRate
integer
תדירות הדגימה של האודיו.
data_or_uri
Union type
data_or_uri יכול להיות רק אחד מהבאים:data
string (bytes format)
תוכן האודיו.
מחרוזת בקידוד Base64.
uri
string
ה-URI של האודיו.
| ייצוג JSON |
|---|
{
"mimeType": enum ( |
DocumentContent
בלוק תוכן במסמך.
mimeType
enum (MimeType)
סוג ה-MIME של המסמך.
data_or_uri
Union type
data_or_uri יכול להיות רק אחד מהבאים:data
string (bytes format)
תוכן המסמך.
מחרוזת בקידוד Base64.
uri
string
ה-URI של המסמך.
| ייצוג JSON |
|---|
{
"mimeType": enum ( |
תוכן וידאו
בלוק של תוכן וידאו.
mimeType
enum (MimeType)
סוג ה-MIME של הסרטון.
resolution
enum (MediaResolution)
הרזולוציה של המדיה.
data_or_uri
Union type
data_or_uri יכול להיות רק אחד מהבאים:data
string (bytes format)
תוכן הסרטון.
מחרוזת בקידוד Base64.
uri
string
ה-URI של הסרטון.
| ייצוג JSON |
|---|
{ "mimeType": enum ( |
ThoughtContent
אבן בניין של תוכן מסוג מחשבה.
signature
string (bytes format)
חתימה שתתאים למקור ה-Backend שיהיה חלק מהיצירה.
מחרוזת בקידוד Base64.
summary[]
object (ThoughtSummaryContent)
סיכום של המחשבה.
| ייצוג JSON |
|---|
{
"signature": string,
"summary": [
{
object ( |
ThoughtSummaryContent
type
Union type
| ייצוג JSON |
|---|
{ // type "text": { object ( |
ToolCallContent
תוכן הקריאה לכלי.
id
string
חובה. מזהה ייחודי של קריאה ספציפית לכלי.
signature
string (bytes format)
גיבוב חתימה לאימות בקצה העורפי.
מחרוזת בקידוד Base64.
type
Union type
type יכול להיות רק אחד מהבאים:functionCall
object (FunctionCallContent)
codeExecutionCall
object (CodeExecutionCallContent)
urlContextCall
object (UrlContextCallContent)
mcpServerToolCall
object (McpServerToolCallContent)
googleSearchCall
object (GoogleSearchCallContent)
fileSearchCall
object (FileSearchCallContent)
googleMapsCall
object (GoogleMapsCallContent)
| ייצוג JSON |
|---|
{ "id": string, "signature": string, // type "functionCall": { object ( |
FunctionCallContent
בלוק תוכן של קריאה לכלי פונקציה.
name
string
חובה. השם של הכלי שאליו מתקשרים.
arguments
object (Struct)
חובה. הארגומנטים להעברה לפונקציה.
| ייצוג JSON |
|---|
{
"name": string,
"arguments": {
object ( |
CodeExecutionCallContent
תוכן שכולל הרצת קוד.
arguments
object (CodeExecutionCallArguments)
חובה. הארגומנטים להעברה להרצת הקוד.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
CodeExecutionCallArguments
הארגומנטים להעברה להרצת הקוד.
language
enum (Language)
שפת התכנות של code.
code
string
הקוד שיופעל.
| ייצוג JSON |
|---|
{
"language": enum ( |
UrlContextCallContent
תוכן של הקשר של כתובת ה-URL.
arguments
object (UrlContextCallArguments)
חובה. הארגומנטים להעברה להקשר של כתובת ה-URL.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
UrlContextCallArguments
הארגומנטים להעברה להקשר של כתובת ה-URL.
urls[]
string
כתובות ה-URL לאחזור.
| ייצוג JSON |
|---|
{ "urls": [ string ] } |
McpServerToolCallContent
תוכן הקריאה לכלי MCPServer.
name
string
חובה. השם של הכלי שהופעל.
serverName
string
חובה. השם של שרת ה-MCP שבו נעשה שימוש.
arguments
object (Struct)
חובה. אובייקט JSON של הארגומנטים של הפונקציה.
| ייצוג JSON |
|---|
{
"name": string,
"serverName": string,
"arguments": {
object ( |
GoogleSearchCallContent
תוכן בחיפוש Google.
arguments
object (GoogleSearchCallArguments)
חובה. הארגומנטים שמעבירים לחיפוש Google.
searchType
enum (SearchType)
סוג ההארקה של החיפוש שמופעל.
| ייצוג JSON |
|---|
{ "arguments": { object ( |
GoogleSearchCallArguments
הארגומנטים שמעבירים לחיפוש Google.
queries[]
string
שאילתות לחיפוש באינטרנט לחיפוש המשך באינטרנט.
| ייצוג JSON |
|---|
{ "queries": [ string ] } |
FileSearchCallContent
בסוג הזה אין שדות.
תוכן חיפוש קבצים.
GoogleMapsCallContent
התוכן במפות Google.
arguments
object (GoogleMapsCallArguments)
הארגומנטים להעברה לכלי של מפות Google.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
GoogleMapsCallArguments
הארגומנטים להעברה לכלי של מפות Google.
queries[]
string
השאילתות שיופעלו.
| ייצוג JSON |
|---|
{ "queries": [ string ] } |
ToolResultContent
תוכן התוצאה של הכלי.
callId
string
חובה. מזהה שצריך להיות זהה למזהה מבלוק קריאת הפונקציה.
signature
string (bytes format)
גיבוב חתימה לאימות בקצה העורפי.
מחרוזת בקידוד Base64.
type
Union type
type יכול להיות רק אחד מהבאים:functionResult
object (FunctionResultContent)
codeExecutionResult
object (CodeExecutionResultContent)
urlContextResult
object (UrlContextResultContent)
googleSearchResult
object (GoogleSearchResultContent)
mcpServerToolResult
object (McpServerToolResultContent)
fileSearchResult
object (FileSearchResultContent)
googleMapsResult
object (GoogleMapsResultContent)
| ייצוג JSON |
|---|
{ "callId": string, "signature": string, // type "functionResult": { object ( |
FunctionResultContent
בלוק תוכן של תוצאה של כלי פונקציה.
name
string
שם הכלי שהופעל.
isError
boolean
האם קריאת הכלי הסתיימה בשגיאה.
result
Union type
result יכול להיות רק אחד מהבאים:structResult
object (Struct)
contentList
object (FunctionResultSubcontentList)
stringResult
string
| ייצוג JSON |
|---|
{ "name": string, "isError": boolean, // result "structResult": { object ( |
FunctionResultSubcontentList
contents[]
object (FunctionResultSubcontent)
| ייצוג JSON |
|---|
{
"contents": [
{
object ( |
FunctionResultSubcontent
type
Union type
| ייצוג JSON |
|---|
{ // type "text": { object ( |
CodeExecutionResultContent
תוכן של תוצאת הרצת הקוד.
result
string
חובה. הפלט של הרצת הקוד.
isError
boolean
האם הרצת הקוד הסתיימה בשגיאה.
| ייצוג JSON |
|---|
{ "result": string, "isError": boolean } |
UrlContextResultContent
תוכן התוצאה של הקשר כתובת ה-URL.
result[]
object (UrlContextResult)
חובה. התוצאות של ההקשר של כתובת ה-URL.
isError
boolean
האם ההקשר של כתובת ה-URL הוביל לשגיאה.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
UrlContextResult
התוצאה של ההקשר של כתובת ה-URL.
url
string
כתובת ה-URL שאוחזרה.
status
enum (Status)
הסטטוס של אחזור כתובת ה-URL.
| ייצוג JSON |
|---|
{
"url": string,
"status": enum ( |
GoogleSearchResultContent
תוכן של תוצאות חיפוש ב-Google.
result[]
object (GoogleSearchResult)
חובה. תוצאות חיפוש Google.
isError
boolean
האם החיפוש ב-Google הסתיים בשגיאה.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
GoogleSearchResult
התוצאה של חיפוש Google.
searchSuggestions
string
קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.
| ייצוג JSON |
|---|
{ "searchSuggestions": string } |
McpServerToolResultContent
תוכן התוצאה של כלי MCPServer.
name
string
השם של הכלי שהופעל בקריאה הספציפית הזו לכלי.
serverName
string
השם של שרת ה-MCP שבו נעשה שימוש.
result
Union type
result יכול להיות רק אחד מהבאים:structResult
object (Struct)
contentList
object (FunctionResultSubcontentList)
stringResult
string
| ייצוג JSON |
|---|
{ "name": string, "serverName": string, // result "structResult": { object ( |
FileSearchResultContent
תוכן של תוצאת חיפוש קבצים.
result[]
object (FileSearchResult)
אופציונלי. התוצאות של חיפוש הקבצים.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
FileSearchResult
בסוג הזה אין שדות.
התוצאה של חיפוש הקובץ.
GoogleMapsResultContent
תוכן של תוצאות במפות Google.
result[]
object (GoogleMapsResult)
חובה. התוצאות של מפות Google.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
GoogleMapsResult
התוצאה של מפות Google.
places[]
object (Places)
המקומות שנמצאו.
widgetContextToken
string
שם המשאב של אסימון ההקשר של הווידג'ט של מפות Google.
| ייצוג JSON |
|---|
{
"places": [
{
object ( |
מקומות
placeId
string
מזהה המקום בפורמט places/{placeId}.
name
string
שם המקום.
url
string
הפניה ל-URI של המקום.
reviewSnippets[]
object (ReviewSnippet)
קטעי ביקורות שמשמשים ליצירת תשובות לגבי התכונות של מקום מסוים במפות Google.
| ייצוג JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
CreateInteractionRequest
- ייצוג ב-JSON
- אינטראקציה
- TurnList
- פנייה
- StepList
- שלב
- ThoughtStep
- ToolCallStep
- FunctionCallStep
- UrlContextCallStep
- UrlContextCallStepArguments
- McpServerToolCallStep
- GoogleSearchCallStep
- GoogleSearchCallStepArguments
- FileSearchCallStep
- GoogleMapsCallStep
- GoogleMapsCallStepArguments
- ToolResultStep
- FunctionResultStep
- UrlContextResultStep
- UrlContextResultItem
- GoogleSearchResultStep
- GoogleSearchResultItem
- McpServerToolResultStep
- FileSearchResultStep
- GoogleMapsResultStep
- GoogleMapsResultItem
- GoogleMapsResultPlaces
- UserInputStep
- ModelOutputStep
- ResponseFormatList
- ResponseFormat
- TextResponseFormat
- ImageResponseFormat
- VideoResponseFormat
- ModelInteraction
- GenerationConfig
- ToolChoiceConfig
- SpeechConfig
- ImageConfig
- VideoConfig
- EnvironmentConfig
- EnvironmentNetworkEgressAllowlist
- EgressRule
- מקור
- LocalEnvironmentConfig
- כלי
- תפקיד
- UrlContext
- McpServer
- GoogleSearch
- FileSearch
- GoogleMaps
- שימוש
- ModalityTokens
- GroundingToolCount
- WebhookConfig
- SafetySetting
פרמטרים של הגדרות ליצירת אינטראקציה.
stream
boolean
קלט בלבד. אם האינטראקציה תועבר בסטרימינג.
store
boolean
קלט בלבד. האם לאחסן את התגובה והבקשה לאחזור מאוחר יותר.
interaction
object (Interaction)
האינטראקציה שרוצים ליצור.
background
boolean
קלט בלבד. האם להריץ את האינטראקציה עם המודל ברקע.
| ייצוג JSON |
|---|
{
"stream": boolean,
"store": boolean,
"interaction": {
object ( |
אינטראקציה
תשובה ל-InteractionService.CreateInteraction.
id
string
חובה. פלט בלבד. מזהה ייחודי של השלמת האינטראקציה.
status
enum (Status)
חובה. פלט בלבד. הסטטוס של האינטראקציה.
created
string
חובה. פלט בלבד. השעה שבה התשובה נוצרה בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
updated
string
חובה. פלט בלבד. השעה שבה התשובה עודכנה לאחרונה בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ssZ).
role
(deprecated)
string
פלט בלבד. התפקיד של האינטראקציה.
outputs[]
(deprecated)
object (Content)
פלט בלבד. תשובות מהמודל.
systemInstruction
string
הוראה למערכת לגבי האינטראקציה.
tools[]
object (Tool)
רשימה של הצהרות על כלים שהמודל עשוי להשתמש בהם במהלך האינטראקציה.
usage
object (Usage)
פלט בלבד. נתונים סטטיסטיים על השימוש בטוקן של בקשת האינטראקציה.
responseModalities[]
(deprecated)
enum (ResponseModality)
האופנים המבוקשים של התשובה (טקסט, תמונה, אודיו).
responseMimeType
(deprecated)
string
סוג ה-MIME של התשובה. הפרמטר הזה נדרש אם הגדרתם את responseFormat.
previousInteractionId
string
המזהה של האינטראקציה הקודמת, אם יש כזו.
environmentId
string
פלט בלבד. מזהה הסביבה של האינטראקציה. השדה מאוכלס רק אם הגדרת הסביבה מוגדרת בבקשה.
serviceTier
enum (ServiceTier)
רמת השירות של האינטראקציה.
webhookConfig
object (WebhookConfig)
אופציונלי. הגדרת תגובה לפעולה מאתר אחר (webhook) לקבלת התראות כשהאינטראקציה מסתיימת.
steps[]
object (Step)
חובה. פלט בלבד. השלבים שמרכיבים את האינטראקציה.
input
Union type
input יכול להיות רק אחד מהבאים:contentList
(deprecated)
object (ContentList)
הקלט של האינטראקציה.
stringContent
string
קלט מחרוזת לאינטראקציה, שיעובד כקלט טקסט יחיד.
turnList
(deprecated)
object (TurnList)
התורות של האינטראקציה.
stepList
object (StepList)
קלט בלבד. השלבים של האינטראקציה.
content
object (Content)
התוכן של האינטראקציה.
response_format_config
Union type
response_format_config יכול להיות רק אחד מהבאים:responseFormat
(deprecated)
object (Value)
הפרמטר הזה מאלץ את המודל ליצור תשובה שהיא אובייקט JSON שתואם לסכימת ה-JSON שצוינה בשדה הזה.
responseFormatList
object (ResponseFormatList)
responseFormatSingleton
object (ResponseFormat)
request_type
Union type
request_type יכול להיות רק אחד מהבאים:modelInteraction
object (ModelInteraction)
אינטראקציה ליצירת ההשלמה באמצעות מודלים.
agentInteraction
object (AgentInteraction)
אינטראקציה ליצירת ההשלמה באמצעות סוכנים.
environment
Union type
environment יכול להיות רק אחד מהבאים:envId
string
מזהה הסביבה של האינטראקציה. יכול להיות 'remote' עבור סביבת ברירת המחדל.
remoteEnvironment
object (EnvironmentConfig)
localEnvironment
object (LocalEnvironmentConfig)
הסביבה של הסוכן נמצאת בחיבור של הלקוח: פעולות הסביבה המובנות שלה (פעולות במערכת הקבצים והרצת פקודות) מועברות ללקוח לביצוע, במקום להפעיל אותן בארגז חול שמנוהל על ידי השרת. המאפיין הזה בלעדי למאפיין remoteEnvironment. (לא משנה מה הערך של השדה הזה, כלי פונקציות שהלקוח מצהיר עליהם תמיד מופעלים בלקוח).
| ייצוג JSON |
|---|
{ "id": string, "status": enum ( |
TurnList
Turn
role
string
הגורם שיזם את התור הזה. צריך להיות משתמש לקלט או מודל לפלט של המודל.
content
Union type
content יכול להיות רק אחד מהבאים:contentList
object (ContentList)
תוכן התור. מערך של אובייקטים מהטיפוס Content.
contentString
string
תוכן התור. מחרוזת אחת.
| ייצוג JSON |
|---|
{
"role": string,
// content
"contentList": {
object ( |
StepList
רשימה של שלבים.
steps[]
object (Step)
השלבים ברשימה.
| ייצוג JSON |
|---|
{
"steps": [
{
object ( |
שלב
שלב באינטראקציה.
type
Union type
type יכול להיות רק אחד מהבאים:thought
object (ThoughtStep)
toolCall
object (ToolCallStep)
toolResult
object (ToolResultStep)
userInput
object (UserInputStep)
אל תשתמשו -- אלה מיועדים ל-JSON של צד שלישי בלבד
modelOutput
object (ModelOutputStep)
text
(deprecated)
object (LegacyTextContent)
image
(deprecated)
object (LegacyImageContent)
audio
(deprecated)
object (LegacyAudioContent)
document
(deprecated)
object (LegacyDocumentContent)
video
(deprecated)
object (LegacyVideoContent)
| ייצוג JSON |
|---|
{ // type "thought": { object ( |
ThoughtStep
שלב חשיבה.
signature
string (bytes format)
גיבוב חתימה לאימות בקצה העורפי.
מחרוזת בקידוד Base64.
summary[]
object (Content)
סיכום של המחשבה.
| ייצוג JSON |
|---|
{
"signature": string,
"summary": [
{
object ( |
ToolCallStep
שלב של קריאה לכלי.
id
string
חובה. מזהה ייחודי של קריאה ספציפית לכלי.
signature
string (bytes format)
גיבוב חתימה לאימות בקצה העורפי.
מחרוזת בקידוד Base64.
type
Union type
type יכול להיות רק אחד מהבאים:functionCall
object (FunctionCallStep)
codeExecutionCall
object (CodeExecutionCallStep)
urlContextCall
object (UrlContextCallStep)
mcpServerToolCall
object (McpServerToolCallStep)
googleSearchCall
object (GoogleSearchCallStep)
fileSearchCall
object (FileSearchCallStep)
googleMapsCall
object (GoogleMapsCallStep)
retrievalCall
object (RetrievalCallStep)
| ייצוג JSON |
|---|
{ "id": string, "signature": string, // type "functionCall": { object ( |
FunctionCallStep
שלב של קריאה לכלי מסוג פונקציה.
name
string
חובה. השם של הכלי שאליו מתקשרים.
arguments
object (Struct)
חובה. הארגומנטים להעברה לפונקציה.
| ייצוג JSON |
|---|
{
"name": string,
"arguments": {
object ( |
UrlContextCallStep
שלב של שיחה בהקשר של כתובת URL.
arguments
object (UrlContextCallStepArguments)
חובה. הארגומנטים להעברה להקשר של כתובת ה-URL.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
UrlContextCallStepArguments
הארגומנטים להעברה להקשר של כתובת ה-URL.
urls[]
string
כתובות ה-URL לאחזור.
| ייצוג JSON |
|---|
{ "urls": [ string ] } |
McpServerToolCallStep
שלב קריאה לכלי MCPServer.
name
string
חובה. השם של הכלי שהופעל.
serverName
string
חובה. השם של שרת ה-MCP שבו נעשה שימוש.
arguments
object (Struct)
חובה. אובייקט JSON של הארגומנטים של הפונקציה.
| ייצוג JSON |
|---|
{
"name": string,
"serverName": string,
"arguments": {
object ( |
GoogleSearchCallStep
שלב השיחה בחיפוש Google.
arguments
object (GoogleSearchCallStepArguments)
חובה. הארגומנטים שמעבירים לחיפוש Google.
searchType
enum (SearchType)
סוג ההארקה של החיפוש שמופעל.
| ייצוג JSON |
|---|
{ "arguments": { object ( |
GoogleSearchCallStepArguments
הארגומנטים שמעבירים לחיפוש Google.
queries[]
string
שאילתות לחיפוש באינטרנט לחיפוש המשך באינטרנט.
| ייצוג JSON |
|---|
{ "queries": [ string ] } |
FileSearchCallStep
בסוג הזה אין שדות.
שלב שיחה של חיפוש קבצים.
GoogleMapsCallStep
שלב של שיחה במפות Google.
arguments
object (GoogleMapsCallStepArguments)
הארגומנטים להעברה לכלי של מפות Google.
| ייצוג JSON |
|---|
{
"arguments": {
object ( |
GoogleMapsCallStepArguments
הארגומנטים להעברה לכלי של מפות Google.
queries[]
string
השאילתות שיופעלו.
| ייצוג JSON |
|---|
{ "queries": [ string ] } |
ToolResultStep
שלב תוצאת הכלי.
callId
string
חובה. מזהה שצריך להיות זהה למזהה מבלוק קריאת הפונקציה.
signature
string (bytes format)
גיבוב חתימה לאימות בקצה העורפי.
מחרוזת בקידוד Base64.
type
Union type
type יכול להיות רק אחד מהבאים:functionResult
object (FunctionResultStep)
codeExecutionResult
object (CodeExecutionResultStep)
urlContextResult
object (UrlContextResultStep)
googleSearchResult
object (GoogleSearchResultStep)
mcpServerToolResult
object (McpServerToolResultStep)
fileSearchResult
object (FileSearchResultStep)
googleMapsResult
object (GoogleMapsResultStep)
retrievalResult
object (RetrievalResultStep)
| ייצוג JSON |
|---|
{ "callId": string, "signature": string, // type "functionResult": { object ( |
FunctionResultStep
התוצאה של הפעלת כלי פונקציה.
name
string
שם הכלי שהופעל.
isError
boolean
האם קריאת הכלי הסתיימה בשגיאה.
result
object (Value)
חובה. התוצאה של הפעלת הכלי.
| ייצוג JSON |
|---|
{
"name": string,
"isError": boolean,
"result": {
object ( |
UrlContextResultStep
שלב התוצאה של URL context.
result[]
object (UrlContextResultItem)
חובה. התוצאות של ההקשר של כתובת ה-URL.
isError
boolean
האם ההקשר של כתובת ה-URL הוביל לשגיאה.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
UrlContextResultItem
התוצאה של ההקשר של כתובת ה-URL.
url
string
כתובת ה-URL שאוחזרה.
status
enum (Status)
הסטטוס של אחזור כתובת ה-URL.
| ייצוג JSON |
|---|
{
"url": string,
"status": enum ( |
GoogleSearchResultStep
שלב של תוצאת חיפוש ב-Google.
result[]
object (GoogleSearchResultItem)
חובה. תוצאות חיפוש Google.
isError
boolean
האם החיפוש ב-Google הסתיים בשגיאה.
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
GoogleSearchResultItem
התוצאה של חיפוש Google.
searchSuggestions
string
קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.
| ייצוג JSON |
|---|
{ "searchSuggestions": string } |
McpServerToolResultStep
שלב התוצאה של כלי MCPServer.
name
string
השם של הכלי שהופעל בקריאה הספציפית הזו לכלי.
serverName
string
השם של שרת ה-MCP שבו נעשה שימוש.
result
object (Value)
חובה. הפלט מהשיחה עם שרת ה-MCP. יכול להיות טקסט פשוט או תוכן עשיר.
| ייצוג JSON |
|---|
{
"name": string,
"serverName": string,
"result": {
object ( |
FileSearchResultStep
בסוג הזה אין שדות.
שלב של תוצאת חיפוש קבצים.
GoogleMapsResultStep
שלב התוצאה במפות Google.
result[]
object (GoogleMapsResultItem)
| ייצוג JSON |
|---|
{
"result": [
{
object ( |
GoogleMapsResultItem
התוצאה של מפות Google.
places[]
object (GoogleMapsResultPlaces)
widgetContextToken
string
| ייצוג JSON |
|---|
{
"places": [
{
object ( |
GoogleMapsResultPlaces
placeId
string
name
string
url
string
reviewSnippets[]
object (ReviewSnippet)
| ייצוג JSON |
|---|
{
"placeId": string,
"name": string,
"url": string,
"reviewSnippets": [
{
object ( |
UserInputStep
קלט שסופק על ידי המשתמש.
content
Union type
content יכול להיות רק אחד מהבאים:contentList
object (ContentList)
התוכן של השלב. מערך של אובייקטים מסוג Content.
contentString
string
התוכן של השלב. מחרוזת אחת.
| ייצוג JSON |
|---|
{
// content
"contentList": {
object ( |
ModelOutputStep
פלט שנוצר על ידי המודל.
content[]
object (Content)
| ייצוג JSON |
|---|
{
"content": [
{
object ( |
ResponseFormatList
responseFormats[]
object (ResponseFormat)
| ייצוג JSON |
|---|
{
"responseFormats": [
{
object ( |
ResponseFormat
type
Union type
type יכול להיות רק אחד מהבאים:audio
object (AudioResponseFormat)
text
object (TextResponseFormat)
image
object (ImageResponseFormat)
video
object (VideoResponseFormat)
structValue
object (Struct)
האפשרות 'ערכים מרובים של מפלים' כבר מופעלת ב-GAOS
| ייצוג JSON |
|---|
{ // type "audio": { object ( |
TextResponseFormat
הגדרות לפורמט פלט הטקסט.
mimeType
enum (MimeType)
סוג ה-MIME של פלט הטקסט.
schema
object (Struct)
סכימת ה-JSON שהפלט צריך להתאים לה. האפשרות הזו רלוונטית רק אם mimeType הוא application/json.
| ייצוג JSON |
|---|
{ "mimeType": enum ( |
ImageResponseFormat
הגדרה של פורמט הפלט של התמונה.
mimeType
enum (MimeType)
סוג ה-MIME של פלט התמונה.
delivery
enum (Delivery)
אופן השליחה של פלט התמונה.
aspectRatio
enum (AspectRatio)
יחס הגובה-רוחב של התמונה שנוצרת.
imageSize
enum (ImageSize)
גודל התמונה שנוצרת.
| ייצוג JSON |
|---|
{ "mimeType": enum ( |
VideoResponseFormat
הגדרה של פורמט פלט הווידאו.
delivery
enum (Delivery)
אופן השליחה של פלט הווידאו.
aspectRatio
enum (AspectRatio)
יחס הגובה-רוחב של פלט הסרטון.
duration
string (Duration format)
משך הזמן של פלט הווידאו.
משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
| ייצוג JSON |
|---|
{ "delivery": enum ( |
ModelInteraction
אינטראקציה ליצירת ההשלמה באמצעות מודלים.
model
string
השם של Model שמשמש ליצירת ההשלמה.
generationConfig
object (GenerationConfig)
קלט בלבד. פרמטרים להגדרת האינטראקציה עם המודל.
| ייצוג JSON |
|---|
{
"model": string,
"generationConfig": {
object ( |
GenerationConfig
פרמטרים של הגדרות לאינטראקציות עם המודל.
temperature
number
המדיניות קובעת את מידת הרנדומיזציה של הפלט.
topP
number
ההסתברות המצטברת המקסימלית של טוקנים שצריך לקחת בחשבון כשמבצעים דגימה.
seed
integer
ערך ה-Seed שמשמש בפענוח לצורך שחזור.
stopSequences[]
string
רשימה של רצפי תווים שיפסיקו את האינטראקציה עם הפלט.
thinkingLevel
enum (ThinkingLevel)
רמת הטוקנים של המחשבות שהמודל צריך ליצור.
thinkingSummaries
enum (ThinkingSummaries)
האם לכלול בתשובה סיכומי מחשבות.
maxOutputTokens
integer
מספר האסימונים המקסימלי שייכללו בתשובה.
speechConfig[]
object (SpeechConfig)
הגדרות לאינטראקציה קולית.
imageConfig
(deprecated)
object (ImageConfig)
הגדרות לאינטראקציה עם תמונות.
videoConfig
object (VideoConfig)
הגדרה של יצירת סרטונים.
tool_choice
Union type
tool_choice יכול להיות רק אחד מהבאים:toolChoiceMode
enum (ToolChoiceType)
המצב של בחירת הכלי.
toolChoiceConfig
object (ToolChoiceConfig)
ההגדרה של בחירת הכלי.
| ייצוג JSON |
|---|
{ "temperature": number, "topP": number, "seed": integer, "stopSequences": [ string ], "thinkingLevel": enum ( |
ToolChoiceConfig
הגדרת בחירת הכלי שמכילה את הכלים המותרים.
allowedTools
object (AllowedTools)
הכלים המותרים.
| ייצוג JSON |
|---|
{
"allowedTools": {
object ( |
SpeechConfig
ההגדרה של אינטראקציה קולית.
voice
string
הקול של הדובר.
language
string
השפה של הדיבור.
speaker
string
שם הדובר, שצריך להיות זהה לשם הדובר שצוין בהנחיה.
| ייצוג JSON |
|---|
{ "voice": string, "language": string, "speaker": string } |
ImageConfig
ההגדרה של אינטראקציה עם תמונה.
aspectRatio
string
יחס הגובה-רוחב של התמונה שרוצים ליצור. יחסי גובה-רוחב נתמכים: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9.
אם לא מציינים יחס גובה-רוחב, המודל יבחר יחס גובה-רוחב כברירת מחדל על סמך תמונות ההפניה שסופקו.
imageSize
string
מציינת את הגודל של התמונות שנוצרו. הערכים הנתמכים הם 1K, 2K, 4K. אם לא מציינים ערך, המודל ישתמש בערך ברירת המחדל 1K.
| ייצוג JSON |
|---|
{ "aspectRatio": string, "imageSize": string } |
VideoConfig
אפשרויות להגדרת יצירת סרטונים.
task
enum (Task)
מצב משימה אופציונלי ליצירת סרטונים. אם לא מציינים מצב, המודל קובע באופן אוטומטי את המצב המתאים על סמך פרומפט טקסטואלי ומדיה הקלט שסופקו.
| ייצוג JSON |
|---|
{
"task": enum ( |
EnvironmentConfig
הגדרה של סביבה בהתאמה אישית.
sources[]
object (Source)
environmentId
string
אופציונלי. מזהה הסביבה של האינטראקציה. אם מציינים, הבקשה תעדכן את הסביבה הקיימת במקום ליצור סביבה חדשה.
network
Union type
network יכול להיות רק אחד מהבאים:networkAllowlist
object (EnvironmentNetworkEgressAllowlist)
התרה של דומיינים ספציפיים בלבד.
networkMode
enum (NetworkMode)
מצב יציאה מהרשת.
| ייצוג JSON |
|---|
{ "sources": [ { object ( |
EnvironmentNetworkEgressAllowlist
הגדרת תעבורת נתונים יוצאת (egress) מהרשת עבור הסביבה.
allowlist[]
object (EgressRule)
רשימה של דומיינים מותרים וההגדרות שלהם.
| ייצוג JSON |
|---|
{
"allowlist": [
{
object ( |
EgressRule
כלל יציאה מהרשת שקובע לאילו דומיינים חיצוניים הסביבה יכולה להגיע. כל כלל מזהה דומיין יעד, ואפשר גם להגדיר קבוצה של כותרות HTTP להחדרה לכל בקשה יוצאת תואמת.
domain
string
תבנית הדומיין שתואמת לכלל הזה. כדי להתאים לכל הדומיינים, אפשר להשתמש בשם מארח מדויק (למשל, github.com), בקידומת עם תו כללי לחיפוש (למשל, *.googleapis.com) או ב-*.
transform
map (key: string, value: string)
כותרות להוספה לבקשות שתואמות לכלל הזה. מפתח: שם הכותרת (לדוגמה, Authorization). ערך: ערך הכותרת (למשל, Bearer your-token).
אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
| ייצוג JSON |
|---|
{ "domain": string, "transform": { string: string, ... } } |
מקור
מקור שיוטמע בסביבה.
type
enum (Type)
source
string
המקור של הסביבה. ב-GCS, זהו הנתיב של GCS. ב-GitHub, זהו הנתיב ב-GitHub.
target
string
המיקום שבו המקור אמור להופיע בסביבה.
content
string
התוכן בתוך התג אם הערך של type הוא INLINE.
encoding
string
קידוד אופציונלי לתוכן בתוך שורה (לדוגמה, base64).
| ייצוג JSON |
|---|
{
"type": enum ( |
LocalEnvironmentConfig
בסוג הזה אין שדות.
הגדרה של סביבה שקיימת בחיבור הלקוח ולא בארגז חול שמנוהל על ידי השרת.
כשמגדירים את הערך (באמצעות Interaction.local_environment), מערכת הקבצים והמעטפת של הסוכן נחשבות כנמצאות בצד הלקוח: פעולות הסביבה המובנות של הסוכן (למשל, קריאה, רישום או עריכה של קבצים והרצת פקודות) מושעות בשרת ומועברות בחזרה ללקוח לביצוע, והתוצאות שלהן מוחזרות בתור הבא. האפשרות הזו לא יכולה להתקיים בו-זמנית עם EnvironmentConfig (remoteEnvironment) שמנוהל על ידי השרת, כי הסביבה נמצאת או בצד הלקוח או בארגז חול של השרת, ולא בשניהם.
ההגדרה הזו חלה רק על הסביבה המובנית של הסוכן. כלי פונקציות שהוגדרו על ידי הלקוח תמיד מופעלים בלקוח, ללא קשר לשדה הזה.
כלי
כלי שהמודל יכול להשתמש בו.
type
Union type
type יכול להיות רק אחד מהבאים:function
object (Function)
פונקציה שהמודל יכול להשתמש בה.
codeExecution
object (CodeExecution)
כלי שהמודל יכול להשתמש בו כדי להריץ קוד.
urlContext
object (UrlContext)
כלי שהמודל יכול להשתמש בו כדי לאחזר הקשר של כתובת URL.
computerUse
object (ComputerUse)
כלי לתמיכה באינטראקציה של המודל ישירות עם המחשב.
mcpServer
object (McpServer)
שרת MCP הוא שרת שהמודל יכול להפעיל כדי לבצע פעולות.
googleSearch
object (GoogleSearch)
כלי שהמודל יכול להשתמש בו כדי לחפש ב-Google.
fileSearch
object (FileSearch)
כלי שהמודל יכול להשתמש בו כדי לחפש קבצים.
googleMaps
object (GoogleMaps)
כלי שבו המודל יכול להשתמש כדי לחפש במפות Google.
retrieval
object (Retrieval)
כלי שהמודל יכול להשתמש בו כדי לאחזר קבצים.
| ייצוג JSON |
|---|
{ // type "function": { object ( |
פונקציה
כלי שהמודל יכול להשתמש בו.
name
string
שם הפונקציה.
description
string
תיאור של הפונקציה.
parameters
object (Value)
סכימת ה-JSON של הפרמטרים של הפונקציה.
| ייצוג JSON |
|---|
{
"name": string,
"description": string,
"parameters": {
object ( |
UrlContext
בסוג הזה אין שדות.
כלי שהמודל יכול להשתמש בו כדי לאחזר הקשר של כתובת URL.
McpServer
שרת MCP הוא שרת שהמודל יכול להפעיל כדי לבצע פעולות.
name
string
השם של ה-MCPServer.
url
string
כתובת ה-URL המלאה של נקודת הקצה של שרת ה-MCP. דוגמה: "https://api.example.com/mcp"
headers
map (key: string, value: string)
אופציונלי: שדות לכותרות אימות, פסק זמן וכו', אם צריך.
אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
allowedTools[]
object (AllowedTools)
הכלים המותרים.
| ייצוג JSON |
|---|
{
"name": string,
"url": string,
"headers": {
string: string,
...
},
"allowedTools": [
{
object ( |
GoogleSearch
כלי שהמודל יכול להשתמש בו כדי לחפש ב-Google.
searchTypes[]
enum (SearchType)
סוגי ההארקה של החיפוש שרוצים להפעיל.
| ייצוג JSON |
|---|
{
"searchTypes": [
enum ( |
FileSearch
כלי שהמודל יכול להשתמש בו כדי לחפש קבצים.
fileSearchStoreNames[]
string
שמות החנויות שבהן יתבצע חיפוש הקובץ.
topK
integer
מספר הצ'אנקים לאחזור סמנטי.
metadataFilter
string
מסנן מטא-נתונים להחלה על המסמכים ועל חלקי הטקסט שחולצו באמצעות אחזור סמנטי.
| ייצוג JSON |
|---|
{ "fileSearchStoreNames": [ string ], "topK": integer, "metadataFilter": string } |
GoogleMaps
כלי שהמודל יכול להשתמש בו כדי להתקשר למפות Google.
enableWidget
boolean
האם להחזיר טוקן של הקשר של ווידג'ט בתוצאת הקריאה לכלי של התשובה.
latitude
number
קו הרוחב של המיקום של המשתמש.
longitude
number
קו האורך של המיקום של המשתמש.
| ייצוג JSON |
|---|
{ "enableWidget": boolean, "latitude": number, "longitude": number } |
שימוש
נתונים סטטיסטיים על השימוש בטוקן של בקשת האינטראקציה.
totalInputTokens
integer
מספר הטוקנים בהנחיה (בהקשר).
inputTokensByModality[]
object (ModalityTokens)
פירוט של השימוש בטוקנים של קלט לפי אופן השימוש.
totalCachedTokens
integer
מספר הטוקנים בחלק המאוחסן במטמון של ההנחיה (התוכן המאוחסן במטמון).
cachedTokensByModality[]
object (ModalityTokens)
פירוט של השימוש בטוקנים במטמון לפי אופן השימוש.
totalOutputTokens
integer
המספר הכולל של טוקנים בכל התשובות שנוצרו.
outputTokensByModality[]
object (ModalityTokens)
פירוט של השימוש באסימוני פלט לפי אופן השימוש.
totalToolUseTokens
integer
מספר הטוקנים שמופיעים בהנחיות לשימוש בכלים.
toolUseTokensByModality[]
object (ModalityTokens)
פירוט של השימוש באסימוני שימוש בכלים לפי אופן השימוש.
totalThoughtTokens
integer
מספר הטוקנים של המחשבות למודלים חושבים.
totalTokens
integer
המספר הכולל של הטוקנים בבקשת האינטראקציה (הנחיה + תגובות + טוקנים פנימיים אחרים).
groundingToolCount[]
object (GroundingToolCount)
מספר כלי העיגון.
| ייצוג JSON |
|---|
{ "totalInputTokens": integer, "inputTokensByModality": [ { object ( |
ModalityTokens
כמות הטוקנים של מצב תגובה יחיד.
modality
enum (ResponseModality)
האופן שבו כמות הטוקנים משמשת.
tokens
integer
מספר הטוקנים של האופן.
| ייצוג JSON |
|---|
{
"modality": enum ( |
GroundingToolCount
מספר כלי ההארקה.
type
enum (Type)
סוג כלי ההארקה שמשויך לספירה.
count
integer
מספר כלי ההארקה.
| ייצוג JSON |
|---|
{
"type": enum ( |
WebhookConfig
הודעה להגדרת אירועים של תגובה לפעולה מאתר אחר (webhook) לבקשה.
uris[]
string
אופציונלי. אם מגדירים כתובות URI של webhook, הן ישמשו לאירועי webhook במקום כתובות ה-webhook הרשומות.
userMetadata
object (Struct format)
אופציונלי. מטא-נתוני המשתמש שיוחזרו בכל שליחת אירוע ל-webhook.
| ייצוג JSON |
|---|
{ "uris": [ string ], "userMetadata": { object } } |
SafetySetting
הגדרת בטיחות שמשפיעה על התנהגות החסימה של בטיחות.
[SafetySetting][google.cloud.aiplatform.master.SafetySetting] מורכב מ[קטגוריה][google.cloud.aiplatform.master.SafetySetting.category] של נזק ו[סף][google.cloud.aiplatform.master.SafetySetting.threshold] לאותה קטגוריה.
type
enum (HarmCategory)
חובה. סוג קטגוריית הנזק שרוצים לחסום.
threshold
enum (HarmBlockThreshold)
חובה. סף לחסימת תוכן. אם הסבירות לפגיעה חורגת מהסף הזה, התוכן ייחסם.
method
enum (HarmBlockMethod)
אופציונלי. השיטה לחסימת תוכן. אם לא מציינים ערך, ברירת המחדל היא שימוש בציון ההסתברות.
| ייצוג JSON |
|---|
{ "type": enum ( |
משלוח
מצב ההשמעה של פלט האודיו.
| טיפוסים בני מנייה (enum) | |
|---|---|
DELIVERY_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
INLINE |
נתוני האודיו מוחזרים בשורה בתשובה. |
URI |
נתוני האודיו מוחזרים כ-URI. |
סביבה
מייצג את הסביבה שבה מתבצעת הפעולה, כמו דפדפן אינטרנט.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENVIRONMENT_UNSPECIFIED |
ברירת המחדל היא דפדפן. |
BROWSER |
פועל בדפדפן אינטרנט. |
MOBILE |
פועל בסביבה ניידת. |
DESKTOP |
פועל בסביבת מחשב. |
HarmBlockMethod
השיטה לחסימת תוכן.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_BLOCK_METHOD_UNSPECIFIED |
לא צוינה שיטה לחסימת תוכן מזיק. |
SEVERITY |
שיטת החסימה של תוכן מזיק מתבססת על ציוני הסתברות וחומרה. |
PROBABILITY |
שיטת החסימה של תוכן מזיק מתבססת על ציון הסבירות. |
HarmBlockThreshold
סף לחסימת תוכן על סמך הסבירות לפגיעה.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
לא צוין סף לחסימת תוכן מזיק. |
BLOCK_LOW_AND_ABOVE |
חסימת תוכן עם הסתברות נמוכה או גבוהה יותר לגרימת נזק. |
BLOCK_MEDIUM_AND_ABOVE |
חסימת תוכן עם הסתברות בינונית או גבוהה יותר לגרימת נזק. |
BLOCK_ONLY_HIGH |
חסימת תוכן עם הסתברות גבוהה לגרימת נזק. |
BLOCK_NONE |
אל תחסמו תוכן כלשהו, בלי קשר להסתברות הנזק שלו. |
OFF |
השבתה מלאה של מסנן הבטיחות. |
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. |
שפה
שפות התכנות הנתמכות לקוד שנוצר.
| טיפוסים בני מנייה (enum) | |
|---|---|
LANGUAGE_UNSPECIFIED |
לא נבחרה שפה. אין להשתמש בערך הזה. |
PYTHON |
Python >= 3.10, עם numpy ו-simpy. |
MediaResolution
הרזולוציה של קלט המדיה (תמונות או סרטונים).
| טיפוסים בני מנייה (enum) | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
LOW |
רזולוציה נמוכה. |
MEDIUM |
רזולוציה בינונית. |
HIGH |
רזולוציה גבוהה. |
ULTRA_HIGH |
רזולוציה גבוהה במיוחד. |
MimeType
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
|
TYPE_WAV |
פורמט אודיו WAV |
TYPE_MP3 |
פורמט אודיו MP3 |
TYPE_AIFF |
פורמט אודיו AIFF |
TYPE_AAC |
פורמט אודיו AAC |
TYPE_OGG |
פורמט אודיו OGG |
TYPE_FLAC |
פורמט אודיו FLAC |
TYPE_MPEG |
פורמט אודיו MPEG |
TYPE_M4A |
פורמט אודיו M4A |
TYPE_L16 |
פורמט אודיו L16 |
TYPE_OPUS |
פורמט אודיו OPUS |
TYPE_ALAW |
פורמט אודיו ALAW |
TYPE_MULAW |
פורמט אודיו MULAW |
מצב
ההגדרה הזו קובעת את העומק והיסודיות של סשן החיפוש.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
MODE_SCAN |
סריקה מהירה באמצעות המסווג הראשוני בלבד. |
MODE_VERIFY |
מבצע סיווג ואז חקירה מפורטת. |
NetworkMode
מצב יציאה מהרשת להגדרות שלא נכללות ברשימת ההיתרים.
| טיפוסים בני מנייה (enum) | |
|---|---|
NETWORK_MODE_UNSPECIFIED |
ערך ברירת המחדל. לא בשימוש. |
DISABLED |
כל תעבורת הנתונים היוצאת מהרשת חסומה. |
ResponseModality
אופן התגובה.
| טיפוסים בני מנייה (enum) | |
|---|---|
RESPONSE_MODALITY_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
TEXT |
מציין שהמודל צריך להחזיר טקסט. |
IMAGE |
מציין שהמודל צריך להחזיר תמונות. |
AUDIO |
מציין שהמודל צריך להחזיר אודיו. |
VIDEO |
מציין שהמודל צריך להחזיר סרטון. |
DOCUMENT |
מציין שהמודל צריך להחזיר מסמכים. |
ReviewSnippet
תקציר של קטע מביקורת של משתמש שעונה על שאלה לגבי התכונות של מקום ספציפי במפות Google.
title
string
כותרת הביקורת.
url
string
קישור שמתאים לביקורת של המשתמש במפות Google.
reviewId
string
המזהה של קטע הביקורת.
| ייצוג JSON |
|---|
{ "title": string, "url": string, "reviewId": string } |
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 |
מדיניות בטיחות בנוגע לתנאים והסכמים משפטיים. |
סכימה
אובייקט 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 אורך מינימלי של Type.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)
אופציונלי. סכימה של רכיבי Type.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. |
סוג חיפוש
סוגי ההארקה של החיפוש שרוצים להפעיל.
| טיפוסים בני מנייה (enum) | |
|---|---|
SEARCH_TYPE_UNSPECIFIED |
סוג החיפוש לא צוין. אין להשתמש בערך הזה. |
SEARCH_TYPE_WEB_SEARCH |
הגדרת השדה הזה מפעילה את החיפוש באינטרנט. רק תוצאות טקסט מוחזרות. |
SEARCH_TYPE_IMAGE_SEARCH |
הגדרת השדה הזה מאפשרת חיפוש תמונות. הפונקציה מחזירה את בייטים של התמונה. |
Struct
Struct מייצג ערך של נתונים מובְנים, שמורכב משדות שממופים לערכים עם הקלדה דינמית.
fields[]
object (Field)
שדות עם הקלדה דינמית. רשימה במקום מפה, כי מודלים של שפה גדולה רגישים לסדר, ואנחנו רוצים לתת למשתמשים שליטה מלאה.
| ייצוג JSON |
|---|
{
"fields": [
{
object ( |
שדה
משימה
משימות נתמכות של יצירת סרטונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
TASK_UNSPECIFIED |
משימה לא מוגדרת. המשימה מוסקת מההנחיה ומהמדיה שמוזנים. |
TEXT_TO_VIDEO |
יוצר סרטון רק מפרומפט טקסטואלי. |
IMAGE_TO_VIDEO |
יצירת סרטון מתמונה אחת או משתי תמונות מקור. התמונה הראשונה מגדירה את פריים ההתחלה, והתמונה השנייה האופציונלית מגדירה את פריים הסיום. |
REFERENCE_TO_VIDEO |
יצירת סרטון באמצעות מדיה לדוגמה (כמו תמונות, אודיו או סרטון). |
EDIT |
שינוי של סרטון קלט קיים. |
ThinkingLevel
רמת הטוקנים של המחשבות שהמודל צריך ליצור.
| טיפוסים בני מנייה (enum) | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
THINKING_LEVEL_MINIMAL |
מעט מאוד חשיבה או ללא חשיבה כלל. |
THINKING_LEVEL_LOW |
רמת ההעמקה נמוכה. |
THINKING_LEVEL_MEDIUM |
רמת העמקה בינונית. |
THINKING_LEVEL_HIGH |
רמת העמקה גבוהה. |
ThinkingSummaries
האם לכלול בתשובה סיכומי מחשבות.
| טיפוסים בני מנייה (enum) | |
|---|---|
THINKING_SUMMARIES_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
THINKING_SUMMARIES_AUTO |
סיכומים אוטומטיים של תהליכי חשיבה. |
THINKING_SUMMARIES_NONE |
אין סיכומי חשיבה. |
כלי
- ייצוג ב-JSON
- FunctionDeclaration
- התנהגות
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- המצב
- CodeExecution
- GoogleSearch
- Interval
- SearchTypes
- WebSearch
- ImageSearch
- ComputerUse
- סביבה
- SafetyPolicy
- UrlContext
- FileSearch
- McpServer
- StreamableHttpTransport
- GoogleMaps
פרטי כלי שהמודל עשוי להשתמש בהם כדי ליצור תשובה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נכללות בידע של המודל או בהיקף שלו.
המזהה הבא: 16
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 } |
ToolChoiceType
סוג בחירת הכלי.
| טיפוסים בני מנייה (enum) | |
|---|---|
TOOL_CHOICE_TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
AUTO |
בחירת כלי אוטומטית. |
ANY |
כל בחירה של כלי. |
NONE |
לא נבחר כלי. |
VALIDATED |
בחירה מאומתת של כלי. |
ערך
Value מייצג ערך עם הקלדה דינמית שיכול להיות null, מספר, מחרוזת, ערך בוליאני, ערך מבנה רקורסיבי או רשימה של ערכים. מצופה מיצרן הערך להגדיר אחת מהווריאציות האלה. אם אין וריאנטים, זו שגיאה.
kind
Union type
kind יכול להיות רק אחד מהבאים:nullValue
null
מייצג ערך null.
numberValue
number
מייצג ערך כפול.
stringValue
string
מייצג ערך מחרוזת.
boolValue
boolean
מייצג ערך בוליאני.
structValue
object (Struct)
מייצג ערך מובנה.
listValue
object (ListValue)
מייצג Value שחוזר על עצמו.
contentValue
object (Content)
מייצג תוכן עשיר (טקסט, תמונה וכו').
ListValue
VisualizationMode
סוג Enum למצב תצוגה חזותית. בסופו של דבר, נתמוך במצב אינטראקטיבי שבו המשתמש יוכל לבחור אם לכלול בתשובה הדמיות HTML.
| טיפוסים בני מנייה (enum) | |
|---|---|
UNSPECIFIED |
מצב ההדמיה שמוגדר כברירת מחדל. ברירת המחדל היא AUTO. |
OFF |
לא לכלול תצוגות חזותיות. |
AUTO |
הכללה אוטומטית של המחשות. |
משאב 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
- RealtimeInputConfig
- AutomaticActivityDetection
- StartSensitivity
- EndSensitivity
- ActivityHandling
- TurnCoverage
- SessionResumptionConfig
- ContextWindowCompressionConfig
- SlidingWindow
- AudioTranscriptionConfig
- LanguageAuto
- LanguageHints
- 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)
אופציונלי. הגדרות לתרגום.
| ייצוג 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 } |
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 פועלת על ידי השמטת תוכן בתחילת חלון ההקשר. ההקשר שיתקבל תמיד יתחיל בתחילת תור של תפקיד USER. ההוראות למערכת וכל BidiGenerateContentSetup.prefix_turns תמיד יישארו בתחילת התוצאה.
targetTokens
string (int64 format)
מספר הטוקנים שרוצים לשמור. ערך ברירת המחדל הוא triggerTokens/2.
השלכת חלקים מחלון ההקשר גורמת לעלייה זמנית בחביון, ולכן צריך לכייל את הערך הזה כדי להימנע מפעולות דחיסה תכופות.
| ייצוג JSON |
|---|
{ "targetTokens": string } |
AudioTranscriptionConfig
ההגדרה של תמלול האודיו.
adaptationPhrases[]
(deprecated)
string
אופציונלי. רשימה של ביטויים שמשמשים להתאמת הדיבור, שמשפיעה על מודל ה-ASR כדי לשפר את הזיהוי של המונחים הספציפיים האלה.
customVocabulary[]
string
אופציונלי. רשימה של ביטויים מותאמים אישית באוצר המילים, כדי להטות את מודל זיהוי הדיבור לזיהוי מונחים ספציפיים (שמות מוצרים, שמות עצם, ז'רגון).
language_config
Union type
language_config יכול להיות רק אחד מהבאים:languageAuto
object (LanguageAuto)
אופציונלי. המודל יזהה את השפה באופן אוטומטי.
languageHints
object (LanguageHints)
אופציונלי. מציינים שפה אחת או יותר באודיו.
| ייצוג JSON |
|---|
{ "adaptationPhrases": [ string ], "customVocabulary": [ string ], // language_config "languageAuto": { object ( |
LanguageAuto
בסוג הזה אין שדות.
מציין שהשפה של האודיו צריכה להיות מזוהה באופן אוטומטי.
LanguageHints
מספק רמזים למודל לגבי השפות האפשריות שקיימות באודיו.
languageCodes[]
string
חובה. קודי שפה בתקן BCP-47.
| ייצוג JSON |
|---|
{ "languageCodes": [ 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.