Gemini API תומך ביצירת תוכן באמצעות תמונות, אודיו, קוד, כלים ועוד. כדי לקבל פרטים על כל אחת מהתכונות האלה, אפשר להמשיך לקרוא ולעיין בקוד לדוגמה שמתמקד במשימה, או לקרוא את המדריכים המקיפים.
שיטה: models.generateContent
יצירת תגובה של מודל על סמך קלט GenerateContentRequest
. מידע מפורט על השימוש זמין במדריך ליצירת טקסט. יכולות הקלט משתנות בין המודלים, כולל מודלים מותאמים. פרטים נוספים זמינים במדריך למודלים ובמדריך לכוונון.
נקודת קצה
פוסט https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateContentפרמטרים של נתיב
model
string
חובה. השם של Model
שישמש ליצירת ההשלמה.
פורמט: name=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
שצוינו בהגדרות הבטיחות. אם לא צוין SafetySetting
ל-SafetyCategory
מסוים ברשימה, ממשק ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל לקטגוריה הזו. יש תמיכה בקטגוריות הנזק HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT ו-HARM_CATEGORY_HARASSMENT. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. מומלץ גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-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
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
קונכייה
צ'אט
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
מטמון
Python
Node.js
מודל מותאם
Python
מצב JSON
Python
Node.js
Go
קונכייה
Kotlin
Swift
Dart
Java
ביצוע קוד
Python
Kotlin
Java
קריאה לפונקציה
Python
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
.
נקודת קצה
פרסום https://generativelanguage.googleapis.com/v1beta/{model=models/*}:streamGenerateContentפרמטרים של נתיב
model
string
חובה. השם של Model
שישמש ליצירת ההשלמה.
פורמט: name=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
שצוינו בהגדרות הבטיחות. אם לא צוין SafetySetting
ל-SafetyCategory
מסוים ברשימה, ממשק ה-API ישתמש בהגדרת הבטיחות שמוגדרת כברירת מחדל לקטגוריה הזו. יש תמיכה בקטגוריות הנזק HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT ו-HARM_CATEGORY_HARASSMENT. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. מומלץ גם לעיין בהנחיות הבטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-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
קונכייה
וידאו
Python
Node.js
Go
קונכייה
Python
קונכייה
צ'אט
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
)
פלט בלבד. מטא-נתונים על השימוש באסימונים של בקשות היצירה.
ייצוג ב-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 |
ההנחיה נחסמה בגלל תוכן אסור. |
UsageMetadata
מטא-נתונים על השימוש באסימון של בקשת היצירה.
promptTokenCount
integer
מספר האסימונים בהודעה. כשהערך של cachedContent
מוגדר, זה עדיין הגודל הכולל בפועל של ההנחיה, כלומר הוא כולל את מספר האסימונים בתוכן ששמור במטמון.
cachedContentTokenCount
integer
מספר הטוקנים בחלק של ההנחיה שנשמר במטמון (התוכן שנשמר במטמון)
candidatesTokenCount
integer
המספר הכולל של האסימונים בכל התשובות האפשריות שנוצרו.
totalTokenCount
integer
המספר הכולל של האסימונים בבקשה ליצירה (הנחיה + מועמדים לתגובה).
ייצוג JSON |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer } |
מועמד
- ייצוג ב-JSON
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- אינטרנט
- GroundingSupport
- פלח
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- מועמד
מועמדת לתשובה שנוצרה מהמודל.
content
object (Content
)
פלט בלבד. התוכן שנוצר שהמודל מחזיר.
finishReason
enum (FinishReason
)
זה שינוי אופציונלי. פלט בלבד. הסיבה לכך שהמודל הפסיק ליצור אסימונים.
אם השדה ריק, המודל לא הפסיק ליצור אסימונים.
safetyRatings[]
object (SafetyRating
)
רשימה של דירוגי הבטיחות של תשובות אפשריות.
אפשר להגדיר סיווג אחד לכל היותר לכל קטגוריה.
citationMetadata
object (CitationMetadata
)
פלט בלבד. ציטוטים ביבליוגרפיים של המועמדים שנוצרו על ידי המודל.
השדה הזה עשוי להיות מאוכלס במידע על קריאה של כל טקסט שכלול ב-content
. אלה פסקאות ש"מצוטטות" מתוך תוכן שמוגן בזכויות יוצרים בנתוני האימון הבסיסיים של ה-LLM.
tokenCount
integer
פלט בלבד. מספר האסימונים למועמד הזה.
groundingAttributions[]
object (GroundingAttribution
)
פלט בלבד. פרטי שיוך (Attribution) למקורות שתרמו לתשובה מבוססת.
השדה הזה מאוכלס בקריאות GenerateAnswer
.
groundingMetadata
object (GroundingMetadata
)
פלט בלבד. ביסוס מטא-נתונים עבור המועמד.
השדה הזה מאוכלס בקריאות GenerateContent
.
avgLogprobs
number
פלט בלבד.
logprobsResult
object (LogprobsResult
)
פלט בלבד. ציונים של לוג-סבירות לטוקני התגובה ולטוקנים המובילים
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 |
קריאת הפונקציה שנוצרה על ידי המודל לא חוקית. |
GroundingAttribution
שיוך למקור שתרם לתשובה.
sourceId
object (AttributionSourceId
)
פלט בלבד. המזהה של המקור שתרם לשיוך הזה.
content
object (Content
)
תוכן המקור שממנו נגזר השיוך הזה.
ייצוג ב-JSON |
---|
{ "sourceId": { object ( |
AttributionSourceId
המזהה של המקור שתרם לשיוך הזה.
שדה איחוד source
.
הערך של source
יכול להיות רק אחת מהאפשרויות הבאות:
groundingPassage
object (GroundingPassageId
)
מזהה של קטע טקסט בתוך שורה.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
מזהה של Chunk
שאוחזר באמצעות Semantic Retriever.
ייצוג ב-JSON |
---|
{ // Union field |
GroundingPassageId
מזהה של חלק בתוך GroundingPassage
.
passageId
string
פלט בלבד. המזהה של הקטע שתואם ל-GroundingPassage.id
של GenerateAnswerRequest
.
partIndex
integer
פלט בלבד. אינדקס החלק ב-GroundingPassage.content
של GenerateAnswerRequest
.
ייצוג ב-JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
המזהה של Chunk
שאוחזר באמצעות 'מאחזר סמנטי' שצוין ב-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
זה שינוי אופציונלי. קטע קוד של תוכן אתר שאפשר להטמיע בדף אינטרנט או ב-WebView של אפליקציה.
sdkBlob
string (bytes format)
זה שינוי אופציונלי. JSON מקודד ב-Base64 שמייצג מערך של צמדי ערכים <search term, search url>.
מחרוזת בקידוד Base64.
ייצוג ב-JSON |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
מקטע נקודת התייחסות.
chunk_type
. סוג הקטעים. הערך של chunk_type
יכול להיות רק אחת מהאפשרויות הבאות:
web
object (Web
)
קטע מידע מהאינטרנט שמספק תשתית.
ייצוג JSON |
---|
{ // Union field |
פיתוח אתרים
קטע מהאינטרנט.
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 ( |
פילוח
קטע מהתוכן.
partIndex
integer
פלט בלבד. האינדקס של אובייקט חלק בתוך אובייקט התוכן ההורה שלו.
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, ויכול להיות שלא.
ייצוג ב-JSON |
---|
{ "topCandidates": [ { object ( |
TopCandidates
מועמדים עם הסתברויות מובילות ביומן בכל שלב פענוח.
candidates[]
object (Candidate
)
העמודה ממוינת לפי ההסתברות ביומן בסדר יורד.
ייצוג ב-JSON |
---|
{
"candidates": [
{
object ( |
מועמד
מועמד לאסימון ולציון של logprobs.
token
string
ערך המחרוזת של האסימון של המועמד.
tokenId
integer
הערך של מזהה האסימון של המועמד.
logProbability
number
ההסתברות ביומן של המועמד.
ייצוג JSON |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
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
אפשרויות הגדרה ליצירת מודלים ולפלטים. לא כל הפרמטרים ניתנים להגדרה בכל מודל.
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.
candidateCount
integer
זה שינוי אופציונלי. מספר התשובות שייווצרו ויוחזרו.
נכון לעכשיו, אפשר להגדיר את הערך הזה רק כ-1. אם לא תגדירו את הערך, הערך שמוגדר כברירת מחדל הוא 1.
maxOutputTokens
integer
זה שינוי אופציונלי. המספר המקסימלי של אסימונים שאפשר לכלול במועמד לתשובה.
הערה: ערך ברירת המחדל משתנה בהתאם לדגם. אפשר לעיין במאפיין Model.output_token_limit
של Model
שמוחזר מהפונקציה getModel
.
temperature
number
זה שינוי אופציונלי. קובעת את מידת הרנדומיזציה של הפלט.
הערה: ערך ברירת המחדל משתנה בהתאם לדגם. אפשר לעיין במאפיין Model.temperature
של Model
שמוחזר מהפונקציה getModel
.
הערכים יכולים לנוע בין [0.0, 2.0].
topP
number
זה שינוי אופציונלי. ההסתברות המצטברת המקסימלית של אסימונים שצריך להביא בחשבון בזמן הדגימה.
המודל משתמש במדגם משולב של Top-k ו-Top-p (nucleus).
האסימונים ממוינים לפי ההסתברויות שהוקצו להם, כך שנלקחים בחשבון רק האסימונים שהכי סביר שיופיעו. הדגימה מסוג Top-k מגבילה באופן ישיר את המספר המקסימלי של האסימונים שצריך להביא בחשבון, בעוד שהדגימה מסוג Nucleus מגבילה את מספר האסימונים על סמך ההסתברות המצטברת.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model
ומצוין במאפיין Model.top_p
שמוחזר מהפונקציה getModel
. מאפיין topK
ריק מציין שהמודל לא מיישם דגימות מובילות של k ולא מאפשר להגדיר את topK
בבקשות.
topK
integer
זה שינוי אופציונלי. המספר המקסימלי של אסימונים שצריך לקחת בחשבון בזמן הדגימה.
במודלים של Gemini נעשה שימוש במדגם Top-p (nucleus) או בשילוב של מדגם Top-k ו-nucleus. הדגימה מסוג Top-k מתייחסת לקבוצה של topK
האסימונים עם ההסתברות הגבוהה ביותר. מודלים שפועלים עם דגימת nucleus לא מאפשרים הגדרת topK.
הערה: ערך ברירת המחדל משתנה בהתאם ל-Model
ומצוין על ידי המאפיין Model.top_p
שמוחזר מהפונקציה getModel
. מאפיין topK
ריק מציין שהמודל לא מחיל דגימה של top-k ולא מאפשר להגדיר את topK
בבקשות.
presencePenalty
number
זה שינוי אופציונלי. עונש נוכחות שהוחל על logprobs של האסימון הבא אם האסימון כבר נראה בתגובה.
העונש הזה הוא ביטוני (מופעל/מושבת) ולא תלוי במספר הפעמים שבהן נעשה שימוש באסימון (אחרי הפעם הראשונה). משתמשים ב-frequencyPenalty
כדי להגדיל את העונש בכל שימוש.
עונש חיובי ימנע שימוש באסימונים שכבר נעשה בהם שימוש בתשובה, ויגדיל את אוצר המילים.
עונש שלילי יעודד שימוש באסימונים שכבר נעשה בהם שימוש בתשובה, ויצמצם את אוצר המילים.
frequencyPenalty
number
זה שינוי אופציונלי. קנס על התדירות שחל על יומני ה-Logprob של האסימון הבא, כפול מספר הפעמים שכל אסימון נראה ב-respponse עד עכשיו.
עונש חיובי ימנע שימוש באסימונים שכבר השתמשו בהם, באופן יחסי למספר הפעמים שבהן השתמשו באסימון: ככל שמשתמשים יותר באסימון, כך קשה יותר למודל להשתמש בו שוב, וכך הלקסיקון של התשובות גדל.
שימו לב: אם תגדירו קנס שלילי, המודל יעודד שימוש חוזר בטוקנים באופן יחסי למספר הפעמים שבהן נעשה שימוש באסימון. ערכים שליליים קטנים יקטינו את אוצר המילים של התשובה. ערכים שליליים גדולים יותר יגרמו למודל להתחיל לחזור על אסימון משותף עד שהוא יגיע למגבלה של maxOutputTokens
: '...'.
responseLogprobs
boolean
זה שינוי אופציונלי. אם הערך הוא True, תוצאות logprobs מיוצאות בתגובה.
logprobs
integer
זה שינוי אופציונלי. תקף רק אם הוא responseLogprobs=True
. כך מגדירים את מספר הערכים המובילים של logprobs שיוחזר בכל שלב פענוח ב-Candidate.logprobs_result
.
ייצוג ב-JSON |
---|
{
"stopSequences": [
string
],
"responseMimeType": string,
"responseSchema": {
object ( |
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 – תוכן שעשוי לשמש כדי לפגוע בטוהר הבחירות. |
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 |
משביתים את מסנן הבטיחות. |