הטמעות הן ייצוג מספרי של קלט טקסט שפותחים מספר תרחישים לדוגמה ייחודיים, כמו קיבוץ לאשכולות, מדידת דמיון ואחזור מידע. למבוא, מומלץ לעיין במדריך ההטמעה.
שיטה: models.embedContent
הפונקציה יוצרת וקטור הטמעה של טקסט מהקלט Content
באמצעות מודל ההטמעה של Gemini שצוין.
נקודת קצה
פרסום https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContentפרמטרים של נתיב
model
string
חובה. שם המשאב של המודל. זהו מזהה לשימוש במודל.
השם הזה צריך להיות תואם לשם הדגם שהוחזר על ידי השיטה models.list
.
פורמט: models/{model}
הפורמט הוא models/{model}
.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
content
object (Content
)
חובה. התוכן להטמעה. רק השדות parts.text
ייכללו בספירה.
taskType
enum (TaskType
)
זה שינוי אופציונלי. סוג המשימה האופציונלי שבו נעשה שימוש בהטמעות. אפשר להגדיר את האפשרות הזו רק עבור models/embedding-001
.
title
string
זה שינוי אופציונלי. כותרת אופציונלית לטקסט. רלוונטי רק כאשר סוג המשימה הוא RETRIEVAL_DOCUMENT
.
הערה: ציון title
עבור RETRIEVAL_DOCUMENT
מספק הטמעות (embeddings) באיכות טובה יותר לאחזור.
outputDimensionality
integer
זה שינוי אופציונלי. מימד מצומצם אופציונלי להטמעת הפלט. אם הערך מוגדר, ערכים מוגזמים בהטמעת הפלט יקוצצו מהסוף. האפשרות הזו נתמכת רק בדגמים חדשים משנת 2024. לא ניתן להגדיר את הערך הזה אם משתמשים במודל הקודם (models/embedding-001
).
דוגמה לבקשה
Python
Node.js
קונכייה
גוף התשובה
התשובה לEmbedContentRequest
.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
embedding
object (ContentEmbedding
)
פלט בלבד. הטמעת הקוד שנוצרה מתוכן הקלט.
ייצוג JSON |
---|
{
"embedding": {
object ( |
שיטה: models.batchEmbedContents
הפונקציה יוצרת כמה וקטורים של הטמעה מהקלט Content
, שמורכב מקבוצה של מחרוזות שמיוצגות כאובייקטים מסוג EmbedContentRequest
.
נקודת קצה
לשלוח https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContentsפרמטרים של נתיב
model
string
חובה. שם המשאב של המודל. זהו מזהה לשימוש במודל.
השם הזה צריך להיות תואם לשם הדגם שהוחזר על ידי השיטה models.list
.
פורמט: models/{model}
הפורמט הוא models/{model}
.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
requests[]
object (EmbedContentRequest
)
חובה. הטמעת בקשות באצווה. המודל בכל אחת מהבקשות חייב להתאים למודל שצוין BatchEmbedContentsRequest.model
.
דוגמה לבקשה
Python
Node.js
קונכייה
גוף התשובה
התשובה ל-BatchEmbedContentsRequest
.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
embeddings[]
object (ContentEmbedding
)
פלט בלבד. הטמעות (embeddings) של כל בקשה, באותו סדר שבו הן צוינו בבקשה האצווה.
ייצוג JSON |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
בקשה שמכילה את Content
של המודל להטמעה.
model
string
חובה. שם המשאב של המודל. זהו מזהה לשימוש במודל.
השם הזה צריך להתאים לשם הדגם שהוחזר על ידי השיטה models.list
.
פורמט: models/{model}
content
object (Content
)
חובה. התוכן להטמעה. רק השדות parts.text
ייכללו בספירה.
taskType
enum (TaskType
)
זה שינוי אופציונלי. סוג המשימה האופציונלי שבו נעשה שימוש בהטמעות. אפשר להגדיר את האפשרות הזו רק עבור models/embedding-001
.
title
string
זה שינוי אופציונלי. כותרת אופציונלית לטקסט. רלוונטי רק כאשר סוג המשימה הוא RETRIEVAL_DOCUMENT
.
הערה: ציון title
עבור RETRIEVAL_DOCUMENT
מספק הטמעות (embeddings) באיכות טובה יותר לאחזור.
outputDimensionality
integer
זה שינוי אופציונלי. מימד מופחת אופציונלי להטמעת הפלט. אם המדיניות מוגדרת, ערכים עודפים בהטמעת הפלט נחתכים מהסוף. האפשרות הזו נתמכת רק בדגמים חדשים משנת 2024. אי אפשר להגדיר את הערך הזה אם משתמשים במודל הקודם (models/embedding-001
).
ContentEmbedding
רשימה של מספרים שמייצגים הטמעה.
values[]
number
ערכי ההטמעה.
ייצוג ב-JSON |
---|
{ "values": [ number ] } |
TaskType
סוג המשימה שבה ישתמש הטמעת הקוד.
טיפוסים בני מנייה (enum) | |
---|---|
TASK_TYPE_UNSPECIFIED |
לא הוגדר ערך. הערך הזה יוגדר כברירת מחדל לאחד מערכי ה-enum האחרים. |
RETRIEVAL_QUERY |
מציין שהטקסט שצוין הוא שאילתה בהגדרת חיפוש/אחזור. |
RETRIEVAL_DOCUMENT |
מציין שהטקסט הנתון הוא מסמך מהקורפוס שבו מתבצע החיפוש. |
SEMANTIC_SIMILARITY |
מציינת שהטקסט הנתון ישמש ל-STS. |
CLASSIFICATION |
מציין שהטקסט הנתון יסווג. |
CLUSTERING |
מציין שהטמעות (embeddings) ישמשו ליצירת אשכולות. |
QUESTION_ANSWERING |
מציינת שהטקסט הנתון ישמש למענה על שאלות. |
FACT_VERIFICATION |
מציינת שהטקסט הנתון ישמש לאימות עובדות. |