Method: models.batchEmbedContents

在同步调用中指定输入文本，根据模型生成多个嵌入。

HTTP 请求

POST https://generativelanguage.googleapis.com/v1beta/{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) 不能指定此值。