嵌入是文本输入的数字表示形式,开放了许多独特的应用场景,例如聚类、相似度测量和信息检索。有关介绍,请查看嵌入指南。
方法:models.embedContent
- 端点
- 路径参数
- 请求正文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 响应正文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 授权范围
- 示例请求
<ph type="x-smartling-placeholder">
- </ph>
- 基本版
使用指定的 Gemini Embedding 模型,根据输入 Content
生成文本嵌入向量。
端点
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 帖子
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:embedContent
路径参数
model
string
必需。模型的资源名称。这充当要使用的模型的 ID。
此名称应与 models.list
方法返回的模型名称一致。
格式:models/{model}
。其格式为 models/{model}
。
请求正文
请求正文中包含结构如下的数据:
<ph type="x-smartling-placeholder">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
Shell
响应正文
对 EmbedContentRequest
的响应。
如果成功,响应正文将包含结构如下的数据:
embedding
object (ContentEmbedding
)
仅限输出。从输入内容生成的嵌入。
JSON 表示法 |
---|
{
"embedding": {
object ( |
方法:models.batchEmbedContents
- 端点
- 路径参数
- 请求正文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 响应正文
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 授权范围
- 示例请求
<ph type="x-smartling-placeholder">
- </ph>
- 基本版
- EmbedContentRequest
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
根据输入 Content
生成多个嵌入向量,该向量由表示为 EmbedContentRequest
对象的一批字符串组成。
端点
<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 帖子
https://generativelanguage.googleapis.com/v1beta/{model=models/*}:batchEmbedContents
路径参数
model
string
必需。模型的资源名称。这充当要使用的模型的 ID。
此名称应与 models.list
方法返回的模型名称一致。
格式:models/{model}
。其格式为 models/{model}
。
请求正文
请求正文中包含结构如下的数据:
<ph type="x-smartling-placeholder">requests[]
object (EmbedContentRequest
)
必需。批次的嵌入请求。每个请求中的模型都必须与指定的 BatchEmbedContentsRequest.model
模型匹配。
示例请求
Python
Node.js
Shell
响应正文
对 BatchEmbedContentsRequest
的响应。
如果成功,响应正文将包含结构如下的数据:
embeddings[]
object (ContentEmbedding
)
仅限输出。每个请求的嵌入,顺序与批量请求中提供的顺序相同。
JSON 表示法 |
---|
{
"embeddings": [
{
object ( |
EmbedContentRequest
包含要嵌入模型的 Content
的请求。
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
),则无法设置此值。