首批通过分布式安全可靠测评,为关键业务系统打造
Create Embedding - OpenAI Embeddings
更新时间:2026-06-07 15:28:20
功能说明
本接口用于生成文本或多模态内容的向量表示(Embeddings)。适用于需要将自然语言或其他模态数据转换为数值向量以进行相似度计算、检索、分类等下游任务的场景。
调用说明
接口约束
- 调用者需要拥有 API Key,详情请参见 管理 AI API Key。
请求路径
POST {BASE_URL}/api/v1/embeddings
请求头
| 名称 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|
| Authorization | 是 | Bearer {token} | 鉴权信息 |
| Content-Type | 否 | application/json | 请求体格式 |
请求参数
Path 参数
无
Query 参数
无
Body 参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| model | string | 是 | text-embedding-3-small | 指定用于生成嵌入向量的模型名称 |
| input | unknown | 是 | “The quick brown fox jumps over the lazy dog” | 需要生成向量的输入内容,可以是字符串、字符串数组或其他格式 |
| encoding_format | string | 否 | float | 向量编码格式,例如 “float” 或 “base64” |
| dimensions | integer | 否 | 512 | 指定生成向量的维度 |
| parameters | object | 否 | {} | 模型特定的额外参数 |
返回结果
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | boolean | 请求是否成功 |
| code | string | 返回码 |
| message | string | 返回信息 |
| data | object | 业务返回数据 |
data 字段说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 资源唯一 ID |
| name | string | 资源名称 |
| status | string | 资源状态 |
| createTime | string | 创建时间 |
请求示例
curl --request POST '{BASE_URL}/api/v1/embeddings' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "text-embedding-3-small",
"input": "The quick brown fox jumps over the lazy dog",
"encoding_format": "float",
"dimensions": 512
}'
返回示例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "emb_abc123",
"name": "embedding-result",
"status": "COMPLETED",
"createTime": "2026-04-10T10:00:00Z"
}
}