# Embeddings

向量化接口，适合检索、相似度匹配与 RAG 场景。

## 接口与鉴权

`POST https://api.tu-zi.com/v1/embeddings`

传输方式: json

使用模型调用 API Key。示例凭证为占位符，请从环境变量读取真实密钥。

```http
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## 请求体参数

| 字段 | 类型 | 必填 | 说明与约束 |
| --- | --- | --- | --- |
| model | string | 是 | 要调用的向量模型。 示例: text-embedding-3-small |
| input | string \| array | 是 | 待向量化的文本或文本数组。 示例: 退款申请通常会在三个工作日内原路退回。 |
| encoding_format | string | 否 | 向量编码方式，通常为 float 或 base64。 表单初始值（非上游默认值）: "float" 可选值: "float", "base64" 示例: float |
| dimensions | number | 否 | 输出向量维度，部分模型支持自定义。 定义范围: 1 ~ 8192 示例: 1536 |

## 最小请求示例

```json
{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}
```

## 运行前准备

将 https://api.tu-zi.com 替换为本站地址（不要重复追加 /v1），YOUR_MODEL 替换为模型广场中的完整模型名。Python 示例需要先安装 requests；JavaScript 示例使用 Node.js 20+ 并保存为 .mjs 文件。WebSocket 示例按代码注释安装专用依赖。

先在本站令牌页面创建模型调用密钥，并设置 API_KEY 环境变量；cURL 中的 YOUR_API_KEY 需要替换。上传示例中的 input.png/input.wav 是本地文件，必须提前准备。

首次运行使用最小请求；成功后对照下方响应字段读取结果。异步接口返回任务 ID 后仍需查询，任务提交成功不代表生成已完成。

## 代码示例

### curl

```bash
curl --request POST 'https://api.tu-zi.com/v1/embeddings' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}'
```

### python

```python
import json
import os
import requests

url = "https://api.tu-zi.com/v1/embeddings"
headers = json.loads("{\"Authorization\":\"Bearer YOUR_API_KEY\",\"Content-Type\":\"application/json\"}")
headers["Authorization"] = "Bearer " + os.environ["API_KEY"]
payload = json.loads("{\"model\":\"YOUR_MODEL\",\"input\":[\"Hello\"]}")
response = requests.request("POST", url, headers=headers, json=payload, timeout=120)
response.raise_for_status()
result = response.json()
if isinstance(result, dict) and (result.get("success") is False or result.get("error")):
    raise RuntimeError(json.dumps(result, ensure_ascii=False))
print(result)  # Also inspect protocol-specific status/code fields.
```

### javascript

```javascript
// Node.js 20+
const url = "https://api.tu-zi.com/v1/embeddings";
const headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
};
headers.Authorization = 'Bearer ' + process.env.API_KEY;
const response = await fetch(url, { method: "POST", headers, body: JSON.stringify({
  "model": "YOUR_MODEL",
  "input": [
    "Hello"
  ]
}) });
if (!response.ok) throw new Error(await response.text());
const result = await response.json();
if (result?.success === false || result?.error) throw new Error(JSON.stringify(result));
console.log(result); // Also inspect protocol-specific status/code fields.
```

## 响应字段

| 字段 | 类型 | 说明与约束 |
| --- | --- | --- |
| data[].embedding | number[] | 向量结果。 |
| data[].index | integer | 与输入对应的索引。 |
| usage | object | 输入用量。 |

以下为示例响应，部分接口仅展示主要字段；可选字段不保证出现。

```json
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.1,
        0.2
      ]
    }
  ],
  "model": "YOUR_MODEL",
  "usage": {
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}
```

## 错误处理与重试

检查 HTTP 状态与该协议的错误对象；不要将不同协议的错误字段混用。401/403 检查凭证与权限，429 退避等待，5xx 检查网关或上游状态。错误正文可能含 error/message/code 等字段，以实际协议为准。

查询可采用有上限的指数退避；创建任务、生成内容、创建或删除密钥等操作不要盲目重试，以免重复计费或重复执行。

## 适用限制

本页是协议基础结构。模型可用参数、枚举、上限和异步行为以该模型“快速上手”为准；示例中的 YOUR_MODEL 必须替换。表中表单初始值不代表上游默认值。

## 文档依据

定义版本: 1

审核日期: 2026-11-02

来源: https://api.tu-zi.com/docs/api/reference-relay-embeddings

关联协议说明: https://api.tu-zi.com/docs/api/retrieval

本文只包含接口文档和示例。真实密钥、账号数据及用户请求内容不包含在复制内容中。