הטמעות הן ייצוג מספרי של קלט טקסט, שמאפשר מספר תרחישי שימוש ייחודיים, כמו קיבוץ, מדידת דמיון ואחזור מידע. למידע נוסף, אפשר לעיין במדריך להטמעות.
שיטה: models.embedContent
הפונקציה יוצרת וקטור הטמעה של טקסט מהקלט Content
באמצעות מודל ההטמעה של Gemini שצוין.
נקודת קצה
פוסטhttps: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:embedContent
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
model
string
חובה. שם המשאב של הדגם. זהו מזהה לשימוש במודל.
השם הזה צריך להתאים לשם הדגם שהוחזר על ידי השיטה models.list
.
פורמט: models/{model}
הפורמט הוא models/{model}
.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
content
object (Content
)
חובה. התוכן להטמעה. רק השדות parts.text
ייכללו בספירה.
taskType
enum (TaskType
)
זה שינוי אופציונלי. סוג המשימה האופציונלי שבו נעשה שימוש בהטמעות. אפשר להגדיר את האפשרות הזו רק עבור models/embedding-001
.
title
string
זה שינוי אופציונלי. כותרת אופציונלית לטקסט. המאפיין רלוונטי רק כשהערך של TaskType הוא 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
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
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
זה שינוי אופציונלי. כותרת אופציונלית לטקסט. המאפיין רלוונטי רק כשהערך של TaskType הוא RETRIEVAL_DOCUMENT
.
הערה: ציון title
עבור RETRIEVAL_DOCUMENT
מספק הטמעות (embeddings) באיכות טובה יותר לאחזור.
outputDimensionality
integer
זה שינוי אופציונלי. מימד מופחת אופציונלי להטמעת הפלט. אם הוא מוגדר, ערכים מוגזמים בהטמעת הפלט נחתכים מהסוף. התכונה נתמכת בדגמים חדשים יותר מ-2024 בלבד. לא ניתן להגדיר את הערך הזה אם משתמשים במודל הקודם (models/embedding-001
).
ContentEmbedding
רשימה של מספרים שמייצגים הטמעה (embedding).
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 |
מציין שהטקסט הזה ישמש לאימות עובדות. |