Method: models.batchEmbedContents

以同步呼叫中的指定輸入文字，從模型產生多個嵌入。

HTTP 要求

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

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

路徑參數

參數
model

string

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

這個名稱應與 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

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

這個名稱應與 models.list 方法傳回的模型名稱相符。

格式︰models/{model}
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) 則無法指定這個值。