方法:model.embedContent
透過指定輸入 Content
從模型產生嵌入。
端點
則貼文
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
。
路徑參數
model
string
必要欄位。模型的資源名稱。這可做為模型使用的 ID。
這個名稱應與 models.list
方法傳回的模型名稱相符。
格式:models/{model}
格式為 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
) 無法指定這個值。
要求範例
Python
Node.js
回應主體
對 EmbedContentRequest
的回應。
如果成功,回應主體即會包含具有以下結構的資料:
embedding
object (ContentEmbedding
)
僅供輸出。從輸入內容產生的嵌入。
JSON 表示法 |
---|
{
"embedding": {
object ( |
方法:model.batchEmbedContents
在同步呼叫中,透過特定模型產生多個嵌入。
端點
則貼文
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
。
路徑參數
model
string
必要欄位。模型的資源名稱。這可做為模型使用的 ID。
這個名稱應與 models.list
方法傳回的模型名稱相符。
格式:models/{model}
格式為 models/{model}
。
要求主體
要求主體的資料會採用以下結構:
requests[]
object (EmbedContentRequest
)
必要欄位。批次嵌入要求。這些要求中的模型必須符合指定的 BatchEmbedContentsRequest.model
。
要求範例
Python
Node.js
回應主體
對 BatchEmbedContentsRequest
的回應。
如果成功,回應主體即會包含具有以下結構的資料:
embeddings[]
object (ContentEmbedding
)
僅供輸出。每個要求的嵌入順序,與批次要求中提供的順序相同。
JSON 表示法 |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
包含用於嵌入模型的 Content
的要求。
JSON 表示法 |
---|
{ "model": string, "content": { object ( |
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
) 無法指定這個值。