Method: models.embedContent

依據輸入的 Content，從模型產生嵌入。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
model

string

必要欄位。模型的資源名稱。也是當做模型使用的 ID。

這個名稱應與 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 時才能使用。

注意：為 RETRIEVAL_DOCUMENT 指定 title 可提供更好的嵌入品質，方便擷取。
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

詳情請參閱驗證總覽。