Method: models.batchEmbedContents

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

בקשת HTTP

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents

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

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

פרמטרים
model

string

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

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

פורמט: models/{model}

גוף הבקשה

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

ייצוג JSON 
{
  "requests": [
    {
      object (EmbedContentRequest)
    }
  ]
}
שדות
requests[]

object (EmbedContentRequest)

חובה. הטמעת בקשות לקבוצה. המודל בכל אחת מהבקשות האלו חייב להתאים למודל שצוין ב-BatchEmbedContentsRequest.model.

גוף התשובה

התשובה ל-BatchEmbedContentsRequest.

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

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

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

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

EmbedContentRequest

בקשה שמכילה את ה-Content שהמודל יטמיע.

ייצוג JSON 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer
}
שדות
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 מספק הטמעות איכותיות יותר לאחזור.
outputDimensionality

integer

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