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