Method: models.embedContent

יוצר הטמעה מהמודל בהינתן קלט Content.

בקשת HTTP

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:embedContent

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
model

string

חובה. שם המשאב של המודל. המזהה משמש את המודל.

שם זה צריך להיות תואם לשם דגם שהוחזר על ידי השיטה models.list.

פורמט: models/{model}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
שדות
content

object (Content)

חובה. התוכן להטמעה. רק השדות של parts.text ייספרו.
taskType

enum (TaskType)

זה שינוי אופציונלי. סוג משימה אופציונלי שעבורו ייעשה שימוש בהטמעות. ניתן להגדיר רק עבור models/embedding-001.
title

string

זה שינוי אופציונלי. כותרת אופציונלית לטקסט. רלוונטי רק כאשר TaskType הוא RETRIEVAL_DOCUMENT.

הערה: ציון title עבור RETRIEVAL_DOCUMENT מספק הטמעות איכותיות יותר לאחזור.
outputDimensionality

integer

זה שינוי אופציונלי. מימד מופחת אופציונלי של הטמעת הפלט. אם המדיניות מוגדרת, ערכים מיותרים בהטמעת הפלט ייחתכו מהסוף. יש תמיכה בדגמים חדשים יותר מאז 2024, והמודל הקודם (models/embedding-001) לא יכול לציין את הערך הזה.

גוף התשובה

התשובה ל-EmbedContentRequest.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "embedding": {
    object (ContentEmbedding)
  }
}
שדות
embedding

object (ContentEmbedding)

פלט בלבד. ההטמעה שנוצרה מתוכן הקלט.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

מידע נוסף זמין בסקירה הכללית על אימות.