Gemini API תומך ביצירת תוכן עם תמונות, אודיו, קוד, כלים ועוד. בהמשך המאמר מפורטות כל התכונות האלה, ומוצגות דוגמאות קוד לדוגמה שמתמקדות במשימות. אפשר גם לקרוא את המדריכים המקיפים.
שיטה: models.generateContent
יצירת תשובה לדוגמה בהינתן קלט GenerateContentRequest. מידע מפורט על השימוש זמין במדריך ליצירת טקסט. יכולות הקלט שונות בין המודלים, כולל מודלים שעברו התאמה. פרטים נוספים זמינים במדריך למודלים ובמדריך לכוונון.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
פרמטרים של נתיב
model
string
חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools שModel עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. הפורמטים הנתמכים של 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. מידע מפורט על הגדרות הבטיחות הזמינות מופיע במדריך. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. בשלב הזה, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות להגדרת יצירת המודל והפלטים שלו.
cachedContent
string
אופציונלי. השם של התוכן שנשמר במטמון כדי לשמש כהקשר להצגת התחזית. פורמט: cachedContents/{cachedContent}
store
boolean
אופציונלי. ההגדרה קובעת את התנהגות הרישום ביומן עבור בקשה נתונה. אם היא מוגדרת, היא מקבלת קדימות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Java
תמונה
Python
Node.js
Go
קונכייה
Java
אודיו
Python
Node.js
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
Java
מטמון
Python
Node.js
Go
מודל שעבר התאמה
Python
מצב JSON
Python
Node.js
Go
קונכייה
Java
הרצת קוד
Python
Go
Java
בקשה להפעלת פונקציה
Python
Go
Node.js
קונכייה
Java
הגדרות יצירה
Python
Node.js
Go
קונכייה
Java
הגדרות בטיחות
Python
Node.js
Go
קונכייה
Java
הוראות מערכת
Python
Node.js
Go
קונכייה
Java
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של GenerateContentResponse.
שיטה: models.streamGenerateContent
יצירת תשובה בסטרימינג מהמודל בהינתן קלט GenerateContentRequest.
נקודת קצה
posthttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
פרמטרים של נתיב
model
string
חובה. השם של Model שבו רוצים להשתמש כדי ליצור את ההשלמה.
פורמט: models/{model} הוא מקבל את הצורה models/{model}.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
tools[]
object (Tool)
אופציונלי. רשימה של Tools שModel עשוי להשתמש בהם כדי ליצור את התשובה הבאה.
Tool הוא קטע קוד שמאפשר למערכת ליצור אינטראקציה עם מערכות חיצוניות כדי לבצע פעולה או סדרת פעולות, שלא נמצאות בידע ובהיקף של Model. הפורמטים הנתמכים של 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. מידע מפורט על הגדרות הבטיחות הזמינות מופיע במדריך. כדאי גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-AI.
systemInstruction
object (Content)
אופציונלי. המפתח הגדיר הוראות מערכת. בשלב הזה, רק טקסט.
generationConfig
object (GenerationConfig)
אופציונלי. אפשרויות להגדרת יצירת המודל והפלטים שלו.
cachedContent
string
אופציונלי. השם של התוכן שנשמר במטמון כדי לשמש כהקשר להצגת התחזית. פורמט: cachedContents/{cachedContent}
store
boolean
אופציונלי. ההגדרה קובעת את התנהגות הרישום ביומן עבור בקשה נתונה. אם היא מוגדרת, היא מקבלת קדימות על פני הגדרת הרישום ביומן ברמת הפרויקט.
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Java
תמונה
Python
Node.js
Go
קונכייה
Java
אודיו
Python
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל זרם של מופעים של GenerateContentResponse.
GenerateContentResponse
תשובה מהמודל שתומכת בכמה תשובות אפשריות.
דירוגי הבטיחות וסינון התוכן מדווחים גם לגבי ההנחיה ב-GenerateContentResponse.prompt_feedback וגם לגבי כל תשובה ב-finishReason וב-safetyRatings. ה-API: – מחזיר את כל המועמדים המבוקשים או אף אחד מהם – לא מחזיר אף מועמד רק אם הייתה בעיה בהנחיה (צריך לבדוק את promptFeedback) – מדווח על משוב לגבי כל מועמד ב-finishReason וב-safetyRatings.
candidates[]
object (Candidate)
תשובות אפשריות מהמודל.
promptFeedback
object (PromptFeedback)
מחזירה את המשוב על ההנחיה שקשור למסנני התוכן.
usageMetadata
object (UsageMetadata)
פלט בלבד. מטא-נתונים על השימוש באסימונים בבקשות ליצירת תוכן.
modelVersion
string
פלט בלבד. גרסת המודל ששימשה ליצירת התשובה.
responseId
string
פלט בלבד. responseId משמש לזיהוי כל תשובה.
modelStatus
object (ModelStatus)
פלט בלבד. הסטטוס הנוכחי של המודל הזה.
| ייצוג ב-JSON |
|---|
{ "candidates": [ { object ( |
PromptFeedback
קבוצה של מטא-נתוני המשוב שההנחיה ציינה ב-GenerateContentRequest.content.
blockReason
enum (BlockReason)
אופציונלי. אם ההגדרה מוגדרת, ההנחיה נחסמת ולא מוחזרים מועמדים. לנסח מחדש את ההנחיה.
safetyRatings[]
object (SafetyRating)
דירוגים של בטיחות ההנחיה. יש דירוג אחד לכל היותר לכל קטגוריה.
| ייצוג ב-JSON |
|---|
{ "blockReason": enum ( |
BlockReason
מציינת את הסיבה לחסימת ההנחיה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BLOCK_REASON_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
SAFETY |
ההנחיה נחסמה מטעמי בטיחות. בודקים את safetyRatings כדי להבין איזו קטגוריית בטיחות חסמה אותו. |
OTHER |
ההנחיה נחסמה מסיבות לא ידועות. |
BLOCKLIST |
ההנחיה נחסמה בגלל התנאים שכלולים ברשימת המילים החסומות. |
PROHIBITED_CONTENT |
ההנחיה נחסמה בגלל תוכן אסור. |
IMAGE_SAFETY |
מועמדים נחסמו בגלל תוכן לא בטוח שנוצר על ידי יצירת תמונות. |
UsageMetadata
מטא-נתונים על השימוש באסימון של בקשת הגנרציה.
promptTokenCount
integer
מספר הטוקנים בהנחיה. גם כשהפרמטר cachedContent מוגדר, זה עדיין הגודל הכולל של ההנחיה בפועל, כלומר הוא כולל את מספר הטוקנים בתוכן שנשמר במטמון.
cachedContentTokenCount
integer
מספר הטוקנים בחלק המאוחסן במטמון של ההנחיה (התוכן שמאוחסן במטמון)
candidatesTokenCount
integer
המספר הכולל של הטוקנים בכל המועמדים לתשובות שנוצרו.
toolUsePromptTokenCount
integer
פלט בלבד. מספר הטוקנים שמופיעים בהנחיות לשימוש בכלים.
thoughtsTokenCount
integer
פלט בלבד. מספר הטוקנים של מחשבות למודלים חושבים.
totalTokenCount
integer
המספר הכולל של הטוקנים בבקשת היצירה (הנחיה + מועמדים לתגובה).
promptTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת האופנים שבוצעו בקלט של הבקשה.
cacheTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת אופנויות של התוכן שנשמר במטמון בקלט של הבקשה.
candidatesTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימת האופנים שהוחזרו בתשובה.
toolUsePromptTokensDetails[]
object (ModalityTokenCount)
פלט בלבד. רשימה של אופנים שונים של קלט שעברו עיבוד לבקשות לשימוש בכלים.
| ייצוג ב-JSON |
|---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
ModelStatus
הסטטוס של המודל הבסיסי. המאפיין הזה משמש לציון השלב של המודל הבסיסי וזמן ההוצאה משימוש, אם רלוונטי.
modelStage
enum (ModelStage)
השלב של המודל הבסיסי.
retirementTime
string (Timestamp format)
השעה שבה המודל יצא משימוש.
הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
message
string
הודעה שמסבירה את הסטטוס של המודל.
| ייצוג ב-JSON |
|---|
{
"modelStage": enum ( |
ModelStage
הגדרה של השלב של המודל הבסיסי.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODEL_STAGE_UNSPECIFIED |
שלב המודל לא צוין. |
UNSTABLE_EXPERIMENTAL |
המודל הבסיסי עובר הרבה שינויים. |
EXPERIMENTAL |
מודלים בשלב הזה מיועדים למטרות ניסיוניות בלבד. |
PREVIEW |
מודלים בשלב הזה הם בוגרים יותר ממודלים ניסיוניים. |
STABLE |
מודלים בשלב הזה נחשבים יציבים ומוכנים לשימוש בסביבת ייצור. |
LEGACY |
אם הדגם נמצא בשלב הזה, המשמעות היא שהדגם הזה נמצא בדרך להוצאה משימוש בעתיד הקרוב. רק לקוחות קיימים יכולים להשתמש במודל הזה. |
DEPRECATED |
המודלים בשלב הזה הוצאו משימוש. אי אפשר להשתמש במודלים האלה. |
RETIRED |
מודלים בשלב הזה מוצאים משימוש. אי אפשר להשתמש במודלים האלה. |
מועמד
- ייצוג ב-JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- אינטרנט
- תמונה
- RetrievedContext
- CustomMetadata
- StringList
- מפות Google
- PlaceAnswerSources
- ReviewSnippet
- GroundingSupport
- פלח
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- מועמד
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
תשובה פוטנציאלית שנוצרה מהמודל.
content
object (Content)
פלט בלבד. תוכן שנוצר ומוחזר מהמודל.
finishReason
enum (FinishReason)
אופציונלי. פלט בלבד. הסיבה להפסקת יצירת הטוקנים על ידי המודל.
אם השדה ריק, המודל לא הפסיק ליצור טוקנים.
safetyRatings[]
object (SafetyRating)
רשימה של דירוגים לרמת הבטיחות של תשובה אפשרית.
יש דירוג אחד לכל היותר לכל קטגוריה.
citationMetadata
object (CitationMetadata)
פלט בלבד. פרטי ציטוט של מועמד שנוצר על ידי מודל.
יכול להיות שהשדה הזה יאוכלס במידע על הקראה של כל טקסט שכלול ב-content. אלה קטעים ש'מצוטטים' מתוך תוכן שמוגן בזכויות יוצרים בנתוני האימון של מודל ה-LLM הבסיסי.
tokenCount
integer
פלט בלבד. מספר הטוקנים של המועמד הזה.
groundingAttributions[]
object (GroundingAttribution)
פלט בלבד. פרטי שיוך למקורות שתרמו לתשובה מבוססת.
השדה הזה מאוכלס עבור קריאות ל-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 |
הסתיים בגלל תגובה בפורמט שגוי. |
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
| ייצוג ב-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 השתמש במקורות האלה כדי לענות על שאלות לגבי מאפיינים של המקום (לדוגמה: "יש בבר Foo Wi-Fi?" או "האם בר Foo מתאים לכיסאות גלגלים?"). בשלב הזה אנחנו תומכים רק בקטעי מידע מביקורות כמקורות.
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 } |
GenerationConfig
- ייצוג ב-JSON
- אופן הפעולה
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- ThinkingLevel
- ImageConfig
- MediaResolution
אפשרויות להגדרת יצירת המודל והפלטים שלו. לא כל הפרמטרים ניתנים להגדרה בכל מודל.
stopSequences[]
string
אופציונלי. קבוצת רצפי התווים (עד 5) שיגרמו להפסקת יצירת הפלט. אם מציינים ערך, ה-API יפסיק בהופעה הראשונה של stop_sequence. רצף העצירה לא ייכלל בתשובה.
responseMimeType
string
אופציונלי. סוג ה-MIME של הטקסט המועמד שנוצר. סוגי ה-MIME הנתמכים הם: text/plain: (ברירת מחדל) פלט טקסט. application/json: תגובת JSON במועמדים לתגובה. text/x.enum: ENUM כמחרוזת תגובה במועמדים לתגובה. רשימה של כל סוגי ה-MIME של הטקסט הנתמכים מופיעה במסמכים.
responseSchema
object (Schema)
אופציונלי. סכימת הפלט של הטקסט המוצע שנוצר. סכימות חייבות להיות קבוצת משנה של סכימת OpenAPI ויכולות להיות אובייקטים, פרימיטיבים או מערכים.
אם מגדירים את המדיניות הזו, צריך להגדיר גם מדיניות תואמת responseMimeType. סוגי MIME תואמים: application/json: סכימה לתגובת JSON. פרטים נוספים זמינים במדריך ליצירת טקסט JSON.
_responseJsonSchema
value (Value format)
אופציונלי. סכימת הפלט של התשובה שנוצרה. זוהי חלופה ל-responseSchema שמקבלת JSON Schema.
אם מציינים את responseSchema, צריך להשמיט את responseMimeType, אבל חובה לציין את.
יכול להיות שתישלח סכימת JSON מלאה, אבל לא כל התכונות נתמכות. באופן ספציפי, יש תמיכה רק במאפיינים הבאים:
$id$defs$ref$anchortypeformattitledescriptionenum(למחרוזות ולמספרים)itemsprefixItemsminItemsmaxItemsminimummaximumanyOf-
oneOf(הפירוש זהה ל-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 (גרעין).
האסימונים ממוינים לפי ההסתברויות שהוקצו להם, כך שרק האסימונים הסבירים ביותר נלקחים בחשבון. דגימת k המובילים מגבילה ישירות את המספר המקסימלי של טוקנים שצריך לקחת בחשבון, בעוד שדגימת הגרעין מגבילה את מספר הטוקנים על סמך ההסתברות המצטברת.
הערה: ערך ברירת המחדל משתנה בהתאם ל-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)
אופציונלי. אם צוינה רזולוציית מדיה, המערכת תשתמש בה.
| ייצוג ב-JSON |
|---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
אופן הפעולה
אופני התגובה הנתמכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODALITY_UNSPECIFIED |
ערך ברירת המחדל. |
TEXT |
מציין שהמודל צריך להחזיר טקסט. |
IMAGE |
מציין שהמודל צריך להחזיר תמונות. |
AUDIO |
מציין שהמודל צריך להחזיר אודיו. |
SpeechConfig
הגדרות ליצירת דיבור ותמלול.
voiceConfig
object (VoiceConfig)
ההגדרה במקרה של פלט קולי יחיד.
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig)
אופציונלי. ההגדרה של מערך רמקולים מרובה. הוא לא יכול להיות ביחד עם השדה voiceConfig.
languageCode
string
אופציונלי. קוד השפה של IETF BCP-47 שהמשתמש הגדיר לשימוש באפליקציה. משמש לזיהוי דיבור ולהמרת טקסט לדיבור.
הערכים התקפים הם: de-DE, en-AU, en-GB, en-IN, en-US, es-US, fr-FR, hi-IN, pt-BR, ar-XA, es-ES, fr-CA, id-ID, it-IT, ja-JP, tr-TR, vi-VN, bn-IN, gu-IN, kn-IN, ml-IN, mr-IN, ta-IN, te-IN, nl-NL, ko-KR, cmn-CN, pl-PL, ru-RU ו-th-TH.
| ייצוג ב-JSON |
|---|
{ "voiceConfig": { object ( |
VoiceConfig
ההגדרה של הקול שבו רוצים להשתמש.
voice_config
Union type
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)
אופציונלי. ההגדרה הזו קובעת את העומק המקסימלי של תהליך החשיבה הרציונלית הפנימי של המודל לפני שהוא יוצר תשובה. אם לא מציינים ערך, ברירת המחדל היא HIGH. מומלץ לשימוש במודלים של 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 טוקנים). |
HarmCategory
הקטגוריה של סיווג.
הקטגוריות האלה כוללות סוגים שונים של נזקים שמפתחים עשויים לרצות להתאים.
| טיפוסים בני מנייה (enum) | |
|---|---|
HARM_CATEGORY_UNSPECIFIED |
הקטגוריה לא צוינה. |
HARM_CATEGORY_DEROGATORY |
PaLM – תגובות שליליות או מזיקות שמטרגטות זהות או מאפיין מוגן. |
HARM_CATEGORY_TOXICITY |
PaLM – תוכן גס, מזלזל או בוטה. |
HARM_CATEGORY_VIOLENCE |
PaLM – מתאר תרחישים שמציגים אלימות נגד אדם פרטי או קבוצה, או תיאורים כלליים של שפיכות דמים. |
HARM_CATEGORY_SEXUAL |
PaLM – מכיל אזכורים של מעשים מיניים או תוכן מגונה אחר. |
HARM_CATEGORY_MEDICAL |
PaLM – מקדם עצות רפואיות שלא נבדקו. |
HARM_CATEGORY_DANGEROUS |
PaLM – תוכן מסוכן שמקדם גרימת נזק, מעודד גרימת נזק או עוזר לבצע פעולות מזיקות. |
HARM_CATEGORY_HARASSMENT |
Gemini – תוכן שמטרתו הטרדה. |
HARM_CATEGORY_HATE_SPEECH |
Gemini – דברי שטנה ותוכן. |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini – תוכן מיני בוטה. |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini – תוכן מסוכן. |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini – תוכן שעשוי לשמש לפגיעה ביושרה האזרחית. המאפיין הזה הוצא משימוש. במקומו צריך להשתמש ב-enableEnhancedCivicAnswers. |
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 |
תוכן עם רמת סיכון NEGLIGIBLE, LOW ו-MEDIUM יהיה מותר. |
BLOCK_NONE |
כל התוכן יאושר. |
OFF |
משביתים את מסנן הבטיחות. |