跳转到主要内容
文本向量

OpenAI 兼容文本向量

OpenAI 兼容的文本向量接口

POST
/compatible-mode/v1/embeddings
import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),  # 如未配置环境变量,请用您的 API Key 替换此处。
  base_url="https://dashscope.aliyuncs.com/compatible-mode/v1"  
)

completion = client.embeddings.create(
  model="text-embedding-v4",
  input='The clothes are of good quality and look good, definitely worth the wait. I love them.',
  dimensions=1024,
  encoding_format="float"
)

print(completion.model_dump_json())
{
  "data": [
    {
      "embedding": [
        -0.0695386752486229,
        0.030681096017360687
      ],
      "index": 0,
      "object": "embedding"
    },
    {
      "embedding": [
        -0.06348952651023865,
        0.060446035116910934
      ],
      "index": 5,
      "object": "embedding"
    }
  ],
  "model": "text-embedding-v4",
  "object": "list",
  "usage": {
    "prompt_tokens": 184,
    "total_tokens": 184
  },
  "id": "73591b79-d194-9bca-8bb5-xxxxxxxxxxxx"
}
调用 API 前,请先获取 API Key将其设置为环境变量。如果使用 OpenAI SDK,请先安装 SDK

支持的模型

模型向量维度最大 Token 数批量大小语言支持价格(每百万 Token)免费额度
text-embedding-v42048、1536、1024(默认)、768、512、256、128、648,19210100+ 种主流语言0.5元100 万 Token(90 天)
text-embedding-v31024(默认)、768、5128,1921050+ 种语言0.5元100 万 Token(90 天)

服务地址

POST https://dashscope.aliyuncs.com/compatible-mode/v1/embeddings SDK 使用 base URL 时无需包含 /embeddings

鉴权

string
header
必填

千问云 API Key。详见获取 API Key

请求体

application/json
string
必填

调用的模型名称,支持 text-embedding-v4text-embedding-v3

text-embedding-v4
string
必填

待处理的输入文本。支持字符串、字符串数组或文件。单个字符串最多包含 8,192 个 token;字符串列表或文件最多包含 10 条(行),每条最多 8,192 个 token。

enum<integer>
默认值1024

向量维度。可选值:2048(仅 text-embedding-v4)、1536(仅 text-embedding-v4)、1024、768、512、256(仅 text-embedding-v4)、128(仅 text-embedding-v4)、64(仅 text-embedding-v4)。默认值:1024。

2048,1536,1024,768,512,256,128,64
enum<string>
默认值"float"

返回向量的格式,目前仅支持 float

float

响应

200-application/json
object[]

任务输出数据。

string
默认值"text-embedding-v4"

调用的模型名称。

string
默认值"list"

返回的数据类型,默认为 list

object
默认值"{\"prompt_tokens\":184,\"total_tokens\":184}"

Token 用量统计。

string
默认值"73591b79-d194-9bca-8bb5-xxxxxxxxxxxx"

请求的唯一标识符,可用于追踪和排查问题。