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}
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
תמונה
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
אודיו
Python
Node.js
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
מטמון
Python
Node.js
Go
מודל שעבר התאמה
Python
מצב JSON
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
ביצוע קוד
Python
Go
Kotlin
Java
בקשה להפעלת פונקציה
Python
Go
Node.js
קונכייה
Kotlin
Swift
Dart
Java
הגדרות יצירה
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
הגדרות הבטיחות
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
הוראות מערכת
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
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}
דוגמה לבקשה
טקסט
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
תמונה
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
אודיו
Python
Go
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
Go
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל זרם של מופעי 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 משמש לזיהוי כל תגובה.
ייצוג ב-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
)
פלט בלבד. רשימה של אופנים שונים של קלט שעברו עיבוד לבקשות לשימוש בכלים.
ייצוג ב-JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
מועמד
- ייצוג JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- אינטרנט
- 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
פלט בלבד. האינדקס של המועמד ברשימת המועמדים לתשובה.
ייצוג ב-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 |
יצירת הטוקנים הופסקה כי התמונות שנוצרו מכילות הפרות של כללי הבטיחות. |
UNEXPECTED_TOOL_CALL |
המודל יצר קריאה לכלי, אבל לא הופעלו כלים בבקשה. |
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
שאילתות לחיפוש באינטרנט לצורך המשך החיפוש באינטרנט.
searchEntryPoint
object (SearchEntryPoint
)
אופציונלי. הזנת חיפוש Google לחיפושים הבאים באינטרנט.
retrievalMetadata
object (RetrievalMetadata
)
מטא-נתונים שקשורים לאחזור בתהליך ההארקה.
ייצוג ב-JSON |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
נקודת כניסה לחיפוש Google.
renderedContent
string
אופציונלי. קטע קוד של תוכן אינטרנט שאפשר להטמיע בדף אינטרנט או בתצוגת אינטרנט של אפליקציה.
sdkBlob
string (bytes format)
אופציונלי. JSON מקודד ב-Base64 שמייצג מערך של טופל <מונח חיפוש, כתובת URL של חיפוש>.
מחרוזת בקידוד Base64.
ייצוג ב-JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
קטע מידע שמשמש כנקודת התייחסות.
chunk_type
Union type
chunk_type
יכול להיות רק אחד מהערכים הבאים:web
object (Web
)
חלק מהנתונים מהאינטרנט שמשמשים לעיגון.
ייצוג ב-JSON |
---|
{
// chunk_type
"web": {
object ( |
פיתוח אתרים
קטע מהאינטרנט.
uri
string
הפניה ל-URI של החלק.
title
string
השם של החלק.
ייצוג ב-JSON |
---|
{ "uri": string, "title": string } |
GroundingSupport
תמיכה בנקודת התייחסות.
groundingChunkIndices[]
integer
רשימה של אינדקסים (בתוך 'grounding_chunk') שמציינים את הציטוטים שמשויכים לתלונה. לדוגמה, [1,3,4] פירושו שהתוכן שאוחזר ושמשויך לטענה הוא grounding_chunk[1], grounding_chunk[3] ו-grounding_chunk[4].
confidenceScores[]
number
ציון המהימנות של ההפניות לתמיכה. הערך נע בין 0 ל-1. 1 הוא הדירוג הגבוה ביותר. הגודל של הרשימה הזו צריך להיות זהה לזה של groundingChunkIndices.
segment
object (Segment
)
פלח התוכן שאליו שייך התמיכה הזו.
ייצוג ב-JSON |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Segment
פלח של התוכן.
partIndex
integer
פלט בלבד. האינדקס של אובייקט Part בתוך אובייקט Content ההורה שלו.
startIndex
integer
פלט בלבד. אינדקס ההתחלה בחלק הנתון, נמדד בבייטים. ההיסט מתחילת החלק, כולל, החל מאפס.
endIndex
integer
פלט בלבד. אינדקס הסיום בחלק הנתון, נמדד בבייטים. ההיסט מתחילת החלק, לא כולל, מתחיל מאפס.
text
string
פלט בלבד. הטקסט שמתאים למקטע מהתשובה.
ייצוג ב-JSON |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
מטא-נתונים שקשורים לאחזור בתהליך ההארקה.
googleSearchDynamicRetrievalScore
number
אופציונלי. ציון שמציין את הסבירות לכך שמידע מחיפוש Google יעזור לענות על ההנחיה. הציון הוא בטווח [0, 1], כאשר 0 הוא הסביר ביותר ו-1 הוא הכי פחות סביר. הציון הזה מאוכלס רק כשמופעלת האפשרות 'התבססות על חיפוש Google' ואחזור דינמי. הערך הזה מושווה לסף כדי לקבוע אם להפעיל את חיפוש Google.
ייצוג ב-JSON |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
תוצאה של Logprobs
topCandidates[]
object (TopCandidates
)
אורך = מספר השלבים הכולל של הפענוח.
chosenCandidates[]
object (Candidate
)
אורך = מספר השלבים הכולל של הפענוח. יכול להיות שהמועמדים שנבחרו יופיעו ברשימת המועמדים המובילים, ויכול להיות שלא.
ייצוג ב-JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
מועמדים עם הסתברויות גבוהות ללוג בכל שלב של פענוח.
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 נכשל בגלל שגיאה. |
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
- 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
, אבל אם לא מציינים את responseSchema
, צריך לציין את responseMimeType
.
יכול להיות שתישלח סכימת JSON מלאה, אבל לא כל התכונות נתמכות. באופן ספציפי, יש תמיכה רק במאפיינים הבאים:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(למחרוזות ולמספרים)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
-
oneOf
(הפירוש זהה ל-anyOf
) properties
additionalProperties
required
אפשר גם להגדיר את המאפיין propertyOrdering
הלא סטנדרטי.
הפניות מעגליות מפורקות במידה מוגבלת, ולכן אפשר להשתמש בהן רק במאפיינים לא חובה. (מאפיינים שניתן להגדיר להם ערך Null לא מספיקים). אם המאפיין $ref
מוגדר בסכימת משנה, אי אפשר להגדיר מאפיינים אחרים, למעט מאפיינים שמתחילים ב-$
.
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 ודגימת גרעין. דגימת 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
.
enableEnhancedCivicAnswers
boolean
אופציונלי. הפעלה של תשובות משופרות בנושאים אזרחיים. יכול להיות שהאפשרות הזו לא תהיה זמינה בכל הדגמים.
speechConfig
object (SpeechConfig
)
אופציונלי. ההגדרה של יצירת הדיבור.
thinkingConfig
object (ThinkingConfig
)
אופציונלי. הגדרות לתכונות של יכולות חשיבה. אם השדה הזה מוגדר למודלים שלא תומכים בחשיבה, תוצג שגיאה.
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
אופציונלי. קוד השפה (בפורמט BCP 47, למשל en-US) לסינתזת דיבור.
הערכים האפשריים הם: 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
מספר הטוקנים של המחשבות שהמודל צריך ליצור.
ייצוג ב-JSON |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
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 – תוכן שאפשר להשתמש בו כדי לפגוע ביושרה האזרחית. |
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 |
משביתים את מסנן הבטיחות. |