火山方舟大模型服务平台
产品简介
快速入门-调用模型服务
快速入门-速览平台功能
模型介绍
模型列表
API 参考
获取 API Key 并配置
安装及升级 SDK
对话(Chat)-文本 API
POST
视频生成 API
图片生成 API
POST
向量化 API
文本向量化 API开发中
POSThttps://ark.cn-beijing.volces.com/api/v3/embeddings
创建时间: 2025-05-31 21:43
请求参数
Header 参数
参数名示例值是否必填参数类型描述说明
Content-Typeapplication/jsonstring-
AuthorizationBearer {{ARK_API_KEY}}string-
Body 参数application/json
数据结构
modelstring
必填
您需要调用的模型的 ID (Model ID),开通模型服务,并查询 Model ID 。 您也可通过 Endpoint ID 来调用模型,获得限流、计费类型(前付费/后付费)、运行状态查询、监控、安全等高级能力,可参考获取 Endpoint ID。
inputobject
必填
需要向量化的内容列表,支持中文、英文。输入内容需满足下面条件: 不得超过模型的最大输入 token 数。doubao-embdding 模型,每个列表元素(并非单次请求总数)最大输入token 数为 4096。 不能为空列表,列表的每个成员不能为空字符串。 单条文本以 utf-8 编码,长度不超过 100,000 字节。 为获得更好性能,建议文本数量总token不超过4096,或者文本条数不超过4。
typestring
可选
输入内容的类型,此处应为 text。
textstring
可选
输入给模型的文本内容,需要满足一下条件 单条文本以 utf-8 编码,长度不超过 100,000 字节。 单条文本不超过模型的最大输入 token 数为 8k。 为获得更好性能,建议文本数量总token不超过4096,或者文本条数不超过4。
encoding_formatstring
可选
取值范围: float、base64、null。 embedding 返回的格式。
示例数据
{
  "encoding_format": "float",
  "input": [ " 天很蓝", "海很深" ],
  "model": "doubao-embedding-text-240715"
}
响应示例
成功
HTTP状态码:200
内容格式:JSON
数据结构
idstring
可选
本次请求的唯一标识 。
modelstring
可选
本次请求实际使用的模型名称和版本。
createdinteger
可选
本次请求创建时间的 Unix 时间戳(秒)。
objectstring
可选
固定为 list。
dataobject
可选
本次请求的算法输出内容。
indexstring
可选
向量的序号,与请求参数 input 列表中的内容顺序对应。
embeddingarray<string>
可选
对应内容的向量化结果。
objectstring
可选
固定为 embedding。
usageobject
可选
本次请求的 token 用量。
prompt_tokensinteger
可选
输入内容 token 数量。
total_tokensstring
可选
本次请求消耗的总 token 数量(输入 + 输出)。
响应示例
{
    "created": 1743500074,
    "id": "021743500074720a0965b1ddc5dd75a6dc7a92b58e4552e39fb68",
    "data": [
        {
            "embedding": [
                -1.9609375,
                -0.197265625,
                -1.359375, ... ,
                1.984375
            ],
            "index": 0,
            "object": "embedding"
        },
        {
            "embedding": [
                -2.3125,
                -0.70703125,
                -0.82421875, ... ,
                0.259765625
            ],
            "index": 1,
            "object": "embedding"
        }
    ],
    "model": "doubao-embedding-text-240715",
    "object": "list",
    "usage": {
        "prompt_tokens": 8,
        "total_tokens": 8
    }
}
最后更新: 3 周前