ZeroFA API

Embeddings

将文本转换为定维向量，用于语义检索、RAG 和聚类。兼容 OpenAI 协议，所有 ZeroFA 支持的 embedding 模型均使用这一接口。

POSThttps://zerofa.ai/v1/embeddings

请求参数

Header 参数
Authorizationstring必填
API Key，格式为 Bearer <key>。
示例：Bearer sk-zerofa-xxx
Content-Typestring必填
示例：application/json
Body 参数application/json
modelstring必填
Embedding 模型，可在下方查看可用模型。
示例：<embedding-model>
inputstring | string[]必填
单条字符串或字符串数组（批量）。
示例：["ZeroFA 是什么", "如何接入 ZeroFA"]
encoding_formatstring可选
可选 float（默认）或 base64。
示例：float
dimensionsinteger可选
指定降维后的输出维度，仅 text-embedding-3-* 支持。
示例：1024

使用建议

  • 批量调用：单次 input 数组最多 100 条，更多数据请自行分批。
  • Embedding 输出是确定性的；同一模型和输入可安全缓存。
  • RAG：将检索结果拼接到 Chat Completions 的 system message 中。

可用模型

Embedding 模型见 模型广场 （筛选 Embedding），或通过 GET /v1/models 获取。

请求与响应体

用下面的示例确认请求格式与返回结构。需要在线发起请求时，点击页面顶部“调试”拉起在线运行面板。

curl https://zerofa.ai/v1/embeddings \
  -H "Authorization: Bearer sk-zerofa-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "<embedding-model>",
    "input": ["ZeroFA 是什么", "如何接入 ZeroFA"]
  }'
响应 · 200
{
  "object": "list",
  "data": [
    {"object": "embedding", "index": 0, "embedding": [0.012, -0.034, ...]},
    {"object": "embedding", "index": 1, "embedding": [...]}
  ],
  "model": "<embedding-model>",
  "usage": { "prompt_tokens": 12, "total_tokens": 12 }
}