向量嵌入 — OpenAI 格式
POST
/v1/embeddings调用嵌入模型将文本转换为向量,兼容 OpenAI Embeddings API。
Bearer Token
模型介绍
嵌入模型将文本映射为高维向量,向量之间的余弦相似度可反映语义相似度,是检索增强生成(RAG)、语义搜索、聚类等场景的核心组件。
支持模型
当前仅以下两个嵌入模型在售(与基准 /v1/models 一致):
| 模型 | 模态 | 说明 |
|---|---|---|
doubao-embedding-text | 仅文本 | 豆包文本嵌入(轻量) |
doubao-embedding-large | 仅文本 | 豆包大维度文本嵌入 |
规划中(暂未开通)
以下旧清单模型当前未上架,为后续接入规划:
embedding-3/embedding-3-large/embedding-3-small(智谱 / OpenAI 系旧名)embedding-2BAAI/bge-m3、Pro/BAAI/bge-m3(硅基流动)
请求参数
请求参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| model | string | 是 | - | 模型名,当前在售:doubao-embedding-text、doubao-embedding-large |
| input | string | array | 是 | - | 要嵌入的文本,支持单条或批量 |
| dimensions | integer | 否 | - | 输出维度;是否支持及可选值以具体模型为准 |
| encoding_format | string | 否 | float | 编码格式,可选 float 或 base64 |
| user | string | 否 | - | 终端用户标识,用于监控与滥用检测 |
请求示例
bash
curl /v1/embeddings \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "doubao-embedding-text",
"input": "hello world"
}'python
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="/v1"
)
resp = client.embeddings.create(
model="doubao-embedding-text",
input="hello world",
)
print(resp.data[0].embedding[:5])javascript
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "YOUR_API_KEY",
baseURL: "/v1",
});
const resp = await client.embeddings.create({
model: "doubao-embedding-large",
input: "hello world",
});
console.log(resp.data[0].embedding.slice(0, 5));批量嵌入示例
python
texts = ["第一段文本", "第二段文本", "第三段文本"]
resp = client.embeddings.create(
model="doubao-embedding-text",
input=texts,
)
for i, item in enumerate(resp.data):
print(i, item.embedding[:3])响应示例
json
{
"object": "list",
"data": [
{
"object": "embedding",
"index": 0,
"embedding": [0.0123, -0.0456, 0.0789, ...]
}
],
"model": "doubao-embedding-text",
"usage": {
"prompt_tokens": 5,
"total_tokens": 5
}
}注意事项
- 批量请求最多 2048 条,超过会返回
400。 dimensions参数是否支持以具体模型为准(规划中模型如embedding-3-large支持降至 256/512/1024 等维度以节省存储)。- 中文检索场景当前可用
doubao-embedding-text/doubao-embedding-large;更多模型(bge-m3等)见上方「规划中」清单。 - 计费按输入 token 总数计算。
