抖音开放平台Logo
开发者文档
AI分身
控制台
  • 开场白
  • 流式对话
  • 知识库&记忆管理
  • 大模型调用
  • 向量化模型调用
  • 召回记忆
  • 代理外部能力请求
  • 卡片
  • 原子服务

    • 向量化模型调用
    收藏
    我的收藏

    接口说明

    本文介绍Doubao-embedding模型API的输入输出参数。
    Doubao-embedding 模型是一款字节跳动研发的语义向量化模型，主要面向向量检索场景，可以将文本转化为向量，以方便后续的语义分析。您可以调用服务向模型输入待向量化的文本，服务会将模型处理后的向量信息返回给您。

    基本信息

    HTTP URL
    http://ark-vg.dyc.ivolces.com/api/v3/embeddings
    HTTP Method
    POST
    Scope
    无
    权限要求
    无

    请求头

    参数
    描述
    content-type
    application/json
    ​

    请求参数

    请求体

    参数名称
    类型
    是否必填
    描述
    示例值
    默认值
    model
    String
    是
    您配置了向量化模型的推理接入点 的ID。
    ep-202406040*****-*****
    ​
    input
    String or Array of String
    是
    需要向量化的内容列表。输入字符需要满足：
      •不得超过模型的最大输入 token 数（对于 doubao-embdding 模型为 4096）。
      •不能为空列表，列表的每个成员不能为空字符串。
      •单条文本以 utf-8 编码，长度不超过 100,000 字节。
      •文本数量不超过 256 条。
    ["天很蓝", "海很深"]
    ​
    encoding_format
    String
    否
    embedding 返回的格式，当前仅支持 float。
    float
    float

    响应参数

    请求响应

    参数名称
    类型
    描述
    示例值
    id
    String
    本次请求的唯一标识
    021718049470528d92fcbe0865fdffdde********************
    model
    String
    本次请求实际使用的模型名称和版本
    doubao-embedding-text-240515
    created
    Integer
    本次请求创建时间的 Unix 时间戳（秒）
    1718049470
    object
    String
    固定为 list
    list
    data
    Array of Embedding
    本次请求的算法输出内容
    ​
    usage
    Usage
    本次请求的 tokens 用量
    ​

    数据结构

    Embedding

    参数名称
    类型
    描述
    示例值
    index
    Integer
    向量的序号，与请求参数 input 列表中的内容顺序对应
    0
    embedding
    Array of Float
    对应内容的向量化结果
    [0.01131823007017374, 0.009313009679317474, -0.03317729011178017, 0.00028884236235171556, -0.022333964705467224]
    object
    String
    固定为 embedding
    embedding

    Usage

    参数名称
    类型
    描述
    示例值
    prompt_tokens
    Integer
    输入的 prompt token 数量
    130
    total_tokens
    Integer
    本次请求消耗的总 token 数量（输入 + 输出）
    130

    请求示例

    curl http://ark-vg.dyc.ivolces.com/api/v3/embeddings \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ep-202406040*****-*****",
    "input": ["天很蓝", "海很深"]
}'
    ​

    响应示例

    {
    "id": "021718067849899d92fcbe0865fdffdde********************",
    "created": 171806****,
    "model": "doubao-embedding-text-240515",
    "data": [
        {
            "index": 0,
            "object": "embedding",
            "embedding": [[2.372908353805542,1.897201418876648,...,1.3692127466201782]
        }
    ],
    "usage": {
        "prompt_tokens": 7,
        "total_tokens": 7
    }
}