创建 Embedding

将输入内容转换为向量,用于检索或相似度计算。

POST https://token.moi.matrixorigin.cn/v1/embeddings

调用前准备

  1. 准备用于 Genesis 调用的个人访问令牌或服务账号 API Key。创建和权限配置参阅管理 Genesis 访问凭据

  2. 通过查询可调用模型选择支持 Embeddings 的模型。

请求体

将示例中的 $GENESIS_ACCESS_TOKEN$MODEL_ID 分别替换为访问凭据和所选模型的 ID。

curl -X POST \
  "https://token.moi.matrixorigin.cn/v1/embeddings" \
  -H "Authorization: Bearer $GENESIS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "'"$MODEL_ID"'",
  "input": [
    "database",
    "search"
  ],
  "encoding_format": "float"
}'

以下字段说明覆盖文本输入。图像、视频和多内容向量输出需要相应模型能力及输入配置。

参数

类型

是否必填

说明

model

string

所选模型的 ID,取自模型查询结果中的 data[].id

input

string 或 array of string 或 array of object

非空文本输入。对象形态的字段如下。

input[].content

string 或 array of object

对象输入中必填

对象输入中的文本或文本块。

input[].content[].type

string

文本块中必填

文本块填写 text

input[].content[].text

string

文本块中必填

非空文本内容。

encoding_format

string

向量编码格式。文本示例使用 floatbase64 需要模型及服务配置支持。

dimensions

integer

期望的向量维度,必须为正整数;仅在所选模型支持该维度时设置。

成功响应

成功时返回各条输入对应的向量和 Token 用量。

{
  "object": "list",
  "model": "MODEL_ID",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.018,
        -0.042,
        0.337
      ]
    },
    {
      "object": "embedding",
      "index": 1,
      "embedding": [
        0.032,
        0.011,
        0.296
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 2,
    "total_tokens": 2
  }
}

字段

类型

说明

object

string

对象类型 list

model

string

处理请求的模型。

data

array of object

输入文本对应的向量结果。

data[].object

string

结果类型 embedding

data[].index

integer

结果对应的输入位置,从 0 开始。

data[].embedding

array of number 或 string

向量值;float 编码返回数值数组。示例向量已缩短,实际长度由模型和维度设置决定。

usage

object

模型返回的 Token 用量。

usage.prompt_tokens

integer

输入 Token 数。

usage.total_tokens

integer

Token 总数。

错误响应

缺少必填模型 ID 时返回 HTTP 400。补充模型 ID 后重新提交。

{
  "error": {
    "message": "missing required parameter: model",
    "type": "invalid_request",
    "code": "invalid_request"
  }
}

字段

类型

说明

error

object

错误信息。

error.message

string

错误原因;示例表示缺少模型 ID。

error.type

string

错误类别,模型服务返回时可能省略。

error.code

string 或 null

错误代码,模型服务返回时可能省略。

最后更新于