跳到主要内容

创建嵌入请求

本接口是融云提供的文本向量化服务接口,基于大型语言模型将输入文本转换为高维向量表示。 这些向量可用于语义相似度计算、信息检索、聚类分析、文本分类等多种下游任务,为企业级应用提供强大的语义理解能力。

请求方法

POST<ai-api-base-url>/llm/v1/embeddings

其中,<ai-api-base-url> 为您的 API Key 所属数据中心的域名。目前仅支持北京数据中心的域名:https://ai.rong-api.com

请求头参数

参数名类型必传默认值说明
Authorizationstring-身份认证令牌,格式为 Bearer <your API key>,需替换为实际 API Key,用于验证用户权限。

正文参数

参数名类型必传默认值说明
modelenum-指定生成嵌入向量的模型名称,仅支持融云官方发布模型,传入非平台模型将返回错误:“暂不支持此种模型”。平台将定期更新可用模型列表
inputstring/string[]-输入文本(支持单个字符串或字符串数组),用于生成嵌入向量。
注意
  1. 输入文本的 token 数不能超过模型限制(如 BAAI/bge-m3 为 8192 tokens,其他模型为 512 tokens);
  2. 禁止传入空字符串。
encoding_formatenumfloat嵌入向量的返回格式:
  • float:浮点数数组(默认);
  • base64:Base64 编码的二进制格式,适合减少传输体积。

请求示例

bash
   curl --request POST \
--url <ai-api-base-url>/llm/v1/embeddings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "Pro/BAAI/bge-m3",
"input": "北京云中融信网络科技有限公司(简称“融云”),是全球互联网通信云服务领创品牌。2014 年由创下亿级日活神话的“飞信”核心团队组建而成,依托沉淀近 20 年的领先技术基因,开创性地将通信技术封装为 SDK 提供给开发者和企业用户,大幅降低了行业对通信功能开发的难度和成本。",
"encoding_format": "float"
}'

响应参数

参数名类型是否必返说明
objectenum固定值为 list,标识返回结果为嵌入向量列表。
modelstring实际用于生成嵌入向量的模型名称(可能因平台模型调整与请求参数不一致)。
dataobject[]嵌入向量列表,每个元素包含:
  • object:固定值为 "embedding"
  • embedding:嵌入向量(格式由 encoding_format 决定);
  • index:输入文本在原始数组中的索引。
usageobject资源使用统计信息,包含:
  • prompt_tokens:输入文本的 token 数;
  • total_tokens:总 token 数(与 prompt_tokens 相等)。

返回结果示例

JSON
  {
"model": "<string>",
"data": [
{
"object": "embedding",
"embedding": [
123
],
"index": 123
}
],
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123
}
}