Gemini API תומך ביצירת תוכן באמצעות תמונות, אודיו, קוד, כלים ועוד. כדי לקבל פרטים על כל אחת מהתכונות האלה, אפשר להמשיך לקרוא את המאמר ולעיין בקוד לדוגמה שמתמקד במשימות, או לקרוא את המדריכים המקיפים.
שיטה: models.generateContent
יצירת תשובה לפי מודל על סמך קלט GenerateContentRequest
. מידע מפורט על השימוש זמין במדריך ליצירת טקסט. יכולות הקלט משתנות בין המודלים, כולל מודלים מותאמים. פרטים נוספים זמינים במדריך למודלים ובמדריך לכוונון.
נקודת קצה
פוסטhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
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. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. מומלץ גם לעיין בהנחיות בנושא בטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-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
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
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. במדריך מפורט מידע על הגדרות הבטיחות הזמינות. מומלץ גם לעיין בהנחיות בנושא בטיחות כדי ללמוד איך לשלב שיקולי בטיחות באפליקציות ה-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
)
פלט בלבד. מטא-נתונים על השימוש באסימונים של בקשות היצירה.
modelVersion
string
פלט בלבד. גרסת המודל ששימשה ליצירת התשובה.
ייצוג ב-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
)
פלט בלבד. פרטי שיוך למקורות שתרמו לתשובה מבוססת.
השדה הזה מאוכלס בקריאות 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
Union type
source
יכול להיות רק אחת מהאפשרויות הבאות:groundingPassage
object (GroundingPassageId
)
מזהה של קטע טקסט בתוך שורה.
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
מזהה של Chunk
שאוחזר באמצעות Semantic Retriever.
ייצוג ב-JSON |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
מזהה של חלק בתוך GroundingPassage
.
passageId
string
פלט בלבד. המזהה של הקטע שתואם ל-GroundingPassage.id
של GenerateAnswerRequest
.
partIndex
integer
פלט בלבד. האינדקס של החלק ב-GroundingPassage.content
של GenerateAnswerRequest
.
ייצוג ב-JSON |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
המזהה של Chunk
שאוחזר באמצעות 'מאחזר סמנטי' שצוין ב-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 שמייצג מערך של צמדי ערכים <search term, search 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
פלט בלבד. האינדקס של אובייקט חלק בתוך אובייקט התוכן ההורה שלו.
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
ריק מציין שהמודל לא מחיל דגימה של top-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
אופציונלי. עונש על תדירות שחלה על logprobs של האסימון הבא, כפול מספר הפעמים שכל אסימון הופיע בתגובה עד כה.
עונש חיובי ימנע שימוש באסימונים שכבר השתמשו בהם, באופן יחסי למספר הפעמים שבהן השתמשו באסימון: ככל שמשתמשים יותר באסימון, כך קשה יותר למודל להשתמש שוב באסימון הזה ולהגדיל את אוצר המילים של התשובות.
שימו לב: אם תגדירו קנס שלילי, המודל יעודד שימוש חוזר בטוקנים באופן יחסי למספר הפעמים שבהן נעשה שימוש באסימון. ערכים שליליים קטנים יקטינו את אוצר המילים של התשובה. ערכים שליליים גדולים יותר יגרמו למודל להתחיל לחזור על אסימון נפוץ עד שהוא יגיע למגבלה maxOutputTokens
.
responseLogprobs
boolean
זה שינוי אופציונלי. אם הערך הוא True, תוצאות logprobs מיוצאות בתגובה.
logprobs
integer
זה שינוי אופציונלי. תקף רק אם responseLogprobs=True
. כך מגדירים את מספר הערכים המובילים של logprobs שיוחזר בכל שלב פענוח ב-Candidate.logprobs_result
.
enableEnhancedCivicAnswers
boolean
זה שינוי אופציונלי. הפעלה של תשובות משופרות בנושאים ציבוריים. יכול להיות שהתכונה הזו לא תהיה זמינה בכל הדגמים.
ייצוג ב-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 |
משביתים את מסנן הבטיחות. |